start_pipeline ¶

start_pipeline(
    pipeline_name: PipelineName, *, config_overrides: Optional[OSISClientConfig] = None
) -> StartPipelineResponse

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

Parameters:

pipeline_name (PipelineName) –

The name of the pipeline to start.

Raises:

AccessDeniedException –

You don't have permissions to access the resource.
ConflictException –

The client attempted to remove a resource that is currently in use.
DisabledOperationException –

Exception is thrown when an operation has been disabled.
InternalException –

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
ResourceNotFoundException –

You attempted to access or delete a resource that does not exist.
ValidationException –

An exception for missing or invalid input fields.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_osis/_services/osis.py

def start_pipeline(
    self,
    pipeline_name: "capo_osis.types.pipeline_name.PipelineName",
    *,
    config_overrides: Optional[OSISClientConfig] = None,
) -> "capo_osis.types.start_pipeline_response.StartPipelineResponse":
    """<p>Starts an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--start">Starting an OpenSearch Ingestion pipeline</a>.</p>

    Args:
        pipeline_name: <p>The name of the pipeline to start.</p>

    Raises:
        capo_osis.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to access the resource.</p>
        capo_osis.errors.conflict_exception.ConflictException: <p>The client attempted to remove a resource that is currently in use.</p>
        capo_osis.errors.disabled_operation_exception.DisabledOperationException: <p>Exception is thrown when an operation has been disabled.</p>
        capo_osis.errors.internal_exception.InternalException: <p>The request failed because of an unknown error, exception, or failure (the failure is internal to the service).</p>
        capo_osis.errors.resource_not_found_exception.ResourceNotFoundException: <p>You attempted to access or delete a resource that does not exist.</p>
        capo_osis.errors.validation_exception.ValidationException: <p>An exception for missing or invalid input fields.</p>
        capo_osis.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_osis.types.start_pipeline_request.StartPipelineRequest]",
    ) -> OperationResponse[
        "capo_osis.types.start_pipeline_response.StartPipelineResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.start_pipeline

        output, http_response = (
            capo_osis._operations.amazon_open_search_ingestion_service.start_pipeline.start_pipeline(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartPipeline")
    )
    input_: capo_osis.types.start_pipeline_request.StartPipelineRequest = {
        "pipeline_name": pipeline_name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output