Skip to content

get_pipeline_change_progress async

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

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

For more information, see Tracking the status of pipeline creation.

Parameters:

  • pipeline_name (PipelineName) –

    The name of the pipeline.

Raises:

Source code in docs_src/capo_osis/_services/async_osis.py
async def get_pipeline_change_progress(
    self,
    pipeline_name: "capo_osis.types.pipeline_name.PipelineName",
    *,
    config_overrides: Optional[AsyncOSISClientConfig] = None,
) -> "capo_osis.types.get_pipeline_change_progress_response.GetPipelineChangeProgressResponse":
    """<p>Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress">Tracking the status of pipeline creation</a>.</p>

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

    Raises:
        capo_osis.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to access the resource.</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.get_pipeline_change_progress_request.GetPipelineChangeProgressRequest]",
    ) -> AsyncOperationResponse[
        "capo_osis.types.get_pipeline_change_progress_response.GetPipelineChangeProgressResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.get_pipeline_change_progress

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPipelineChangeProgress")
    )
    input_: capo_osis.types.get_pipeline_change_progress_request.GetPipelineChangeProgressRequest = {
        "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