stop_pipeline `async` ¶

stop_pipeline(
    pipeline_name: PipelineName,
    *,
    config_overrides: Optional[AsyncOSISClientConfig] = None,
) -> StopPipelineResponse

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

Parameters:

pipeline_name (PipelineName) –

The name of the pipeline to stop.

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/async_osis.py

async def stop_pipeline(
    self,
    pipeline_name: "capo_osis.types.pipeline_name.PipelineName",
    *,
    config_overrides: Optional[AsyncOSISClientConfig] = None,
) -> "capo_osis.types.stop_pipeline_response.StopPipelineResponse":
    """<p>Stops an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--stop">Stopping an OpenSearch Ingestion pipeline</a>.</p>

    Args:
        pipeline_name: <p>The name of the pipeline to stop.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_osis.types.stop_pipeline_request.StopPipelineRequest]",
    ) -> AsyncOperationResponse[
        "capo_osis.types.stop_pipeline_response.StopPipelineResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.stop_pipeline

        (
            output,
            http_response,
        ) = await capo_osis._operations.amazon_open_search_ingestion_service.stop_pipeline.async_stop_pipeline(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopPipeline")
    )
    input_: capo_osis.types.stop_pipeline_request.StopPipelineRequest = {
        "pipeline_name": pipeline_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

stop_pipeline async ¶

stop_pipeline `async` ¶