OpenSearchIngestion / Client / get_pipeline_change_progress

get_pipeline_change_progress#

OpenSearchIngestion.Client.get_pipeline_change_progress(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_pipeline_change_progress(
    PipelineName='string'
)
Parameters:

PipelineName (string) –

[REQUIRED]

The name of the pipeline.

Return type:

dict

Returns:

Response Syntax

{
    'ChangeProgressStatuses': [
        {
            'StartTime': datetime(2015, 1, 1),
            'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'TotalNumberOfStages': 123,
            'ChangeProgressStages': [
                {
                    'Name': 'string',
                    'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
                    'Description': 'string',
                    'LastUpdatedAt': datetime(2015, 1, 1)
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • ChangeProgressStatuses (list) –

      The current status of the change happening on the pipeline.

      • (dict) –

        The progress details of a pipeline configuration change.

        • StartTime (datetime) –

          The time at which the configuration change is made on the pipeline.

        • Status (string) –

          The overall status of the pipeline configuration change.

        • TotalNumberOfStages (integer) –

          The total number of stages required for the pipeline configuration change.

        • ChangeProgressStages (list) –

          Information about the stages that the pipeline is going through to perform the configuration change.

          • (dict) –

            Progress details for a specific stage of a pipeline configuration change.

            • Name (string) –

              The name of the stage.

            • Status (string) –

              The current status of the stage that the change is in.

            • Description (string) –

              A description of the stage.

            • LastUpdatedAt (datetime) –

              The most recent updated timestamp of the stage.

Exceptions

  • OpenSearchIngestion.Client.exceptions.DisabledOperationException

  • OpenSearchIngestion.Client.exceptions.ValidationException

  • OpenSearchIngestion.Client.exceptions.InternalException

  • OpenSearchIngestion.Client.exceptions.AccessDeniedException

  • OpenSearchIngestion.Client.exceptions.ResourceNotFoundException