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: 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.entity_created_response.EntityCreatedResponse
Create pipeline
Create an organizational pipelines
Parameters
self
organization_id: 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.entity_created_response.EntityCreatedResponse
delete_organization_pipeline
edgeimpulse_api.api.organization_pipelines_api.delete_organization_pipeline(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
pipeline_id: 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
pipeline_id: 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: 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: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
project_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None,
**kwargs
) ‑> edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse
List archived pipelines
Retrieve all archived organizational pipelines
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse
list_organization_pipelines
edgeimpulse_api.api.organization_pipelines_api.list_organization_pipelines(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
project_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None,
**kwargs
) ‑> edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse
List pipelines
Retrieve all organizational pipelines
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse
run_organization_pipeline
edgeimpulse_api.api.organization_pipelines_api.run_organization_pipeline(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
pipeline_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})],
ignore_last_successful_run: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='If set then `EI_LAST_SUCCESSFUL_RUN` is not set. You can use this to re-run a pipeline from scratch.', extra={})] = None,
**kwargs
) ‑> edgeimpulse_api.models.run_organization_pipeline_response.RunOrganizationPipelineResponse
Run pipeline
Run an organizational pipeline
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
ignore_last_successful_run: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='If set then
EI_LAST_SUCCESSFUL_RUN
is not set. You can use this to re-run a pipeline from scratch.', extra={})] = None**kwargs
Return
edgeimpulse_api.models.run_organization_pipeline_response.RunOrganizationPipelineResponse
stop_organization_pipeline
edgeimpulse_api.api.organization_pipelines_api.stop_organization_pipeline(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
pipeline_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})],
**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[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
update_organization_pipeline
edgeimpulse_api.api.organization_pipelines_api.update_organization_pipeline(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
pipeline_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})],
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[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Last updated
Was this helpful?