edgeimpulse_api.api.organization_pipelines_api

Classes

OrganizationPipelinesApi

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi(
	api_client=None
)

Parameters
`api_client=None`

METHODS

create_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.create_organization_pipeline(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody,
	**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

Create pipeline Create an organizational pipelines

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`organization_update_pipeline_body`	`edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody`
`**kwargs`

Returns
`edgeimpulse_api.models.entity_created_response.EntityCreatedResponse`

delete_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.delete_organization_pipeline(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	pipeline_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')],
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete pipeline Delete an organizational pipelines

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`pipeline_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')]`
`**kwargs`

Returns
`edgeimpulse_api.models.generic_api_response.GenericApiResponse`

get_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.get_organization_pipeline(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	pipeline_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')],
	**kwargs
) ‑> edgeimpulse_api.models.get_organization_pipelines_response.GetOrganizationPipelinesResponse

Get pipeline Retrieve an organizational pipelines

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`pipeline_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')]`
`**kwargs`

Returns
`edgeimpulse_api.models.get_organization_pipelines_response.GetOrganizationPipelinesResponse`

list_archived_organization_pipelines

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.list_archived_organization_pipelines(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	project_id: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, filters on pipelines which are attached to this project.')] = None,
	**kwargs
) ‑> edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse

List archived pipelines Retrieve all archived organizational pipelines

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`project_id`	`Annotated[Annotated[int, Strict(strict=True)] \| None, FieldInfo(annotation=NoneType, required=True, description='If set, filters on pipelines which are attached to this project.')] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse`

list_organization_pipelines

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.list_organization_pipelines(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	project_id: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, filters on pipelines which are attached to this project.')] = None,
	**kwargs
) ‑> edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse

List pipelines Retrieve all organizational pipelines

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`project_id`	`Annotated[Annotated[int, Strict(strict=True)] \| None, FieldInfo(annotation=NoneType, required=True, description='If set, filters on pipelines which are attached to this project.')] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse`

run_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.run_organization_pipeline(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	pipeline_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')],
	ignore_last_successful_run: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set then `EI_LAST_SUCCESSFUL_RUN` is not set. You can use this to re-run a pipeline from scratch.')] = None,
	**kwargs
) ‑> edgeimpulse_api.models.run_organization_pipeline_response.RunOrganizationPipelineResponse

Run pipeline Run an organizational pipeline

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`pipeline_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')]`
`ignore_last_successful_run`	`Annotated[Annotated[bool, Strict(strict=True)] \| None, FieldInfo(annotation=NoneType, required=True, description='If set then` EI_LAST_SUCCESSFUL_RUN `is not set. You can use this to re-run a pipeline from scratch.')] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.run_organization_pipeline_response.RunOrganizationPipelineResponse`

stop_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.stop_organization_pipeline(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	pipeline_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')],
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Stop a running pipeline Stops the pipeline, and marks it as failed.

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`pipeline_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')]`
`**kwargs`

Returns
`edgeimpulse_api.models.generic_api_response.GenericApiResponse`

update_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi.update_organization_pipeline(
	self,
	organization_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')],
	pipeline_id: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')],
	organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody,
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update pipeline Update an organizational pipelines

Parameters
`self`
`organization_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Organization ID')]`
`pipeline_id`	`Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Pipeline ID')]`
`organization_update_pipeline_body`	`edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody`
`**kwargs`

Returns
`edgeimpulse_api.models.generic_api_response.GenericApiResponse`

OVERVIEW

CLIs

LIBRARIES

SPECIFICATIONS

PROTOCOLS

edgeimpulse_api.api.organization_pipelines_api

Classes

OrganizationPipelinesApi

create_organization_pipeline

delete_organization_pipeline

get_organization_pipeline

list_archived_organization_pipelines

list_organization_pipelines

run_organization_pipeline

stop_organization_pipeline

update_organization_pipeline

​Classes

​OrganizationPipelinesApi

​create_organization_pipeline

​delete_organization_pipeline

​get_organization_pipeline

​list_archived_organization_pipelines

​list_organization_pipelines

​run_organization_pipeline

​stop_organization_pipeline

​update_organization_pipeline

Classes

OrganizationPipelinesApi

create_organization_pipeline

delete_organization_pipeline

get_organization_pipeline

list_archived_organization_pipelines

list_organization_pipelines

run_organization_pipeline

stop_organization_pipeline

update_organization_pipeline