organization_pipelines_api module

OrganizationPipelinesApi

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

Parameters

  • api_client=None

Methods

create_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.create_organization_pipeline(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody,
		**kwargs
)> edgeimpulse_api.models.create_pipeline_response.CreatePipelineResponse

Create pipeline

Create an organizational pipelines

Parameters

  • self

  • organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

  • organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody

  • **kwargs

Return

edgeimpulse_api.models.create_pipeline_response.CreatePipelineResponse

delete_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.delete_organization_pipeline(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete pipeline

Delete an organizational pipelines

Parameters

  • self

  • organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

  • pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

get_organization_pipeline

edgeimpulse_api.api.organization_pipelines_api.get_organization_pipeline(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.get_organization_pipelines_response.GetOrganizationPipelinesResponse

Get pipeline

Retrieve an organizational pipelines

Parameters

  • self

  • organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

  • pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.get_organization_pipelines_response.GetOrganizationPipelinesResponse

list_archived_organization_pipelines

edgeimpulse_api.api.organization_pipelines_api.list_archived_organization_pipelines(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None,