OpenSearchService / Client / describe_domain_change_progress

describe_domain_change_progress

OpenSearchService.Client.describe_domain_change_progress(**kwargs)

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_change_progress(
    DomainName='string',
    ChangeId='string'
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The name of the domain to get progress information for.

• ChangeId (string) – The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

Return type:

dict

Returns:

Response Syntax

{
    'ChangeProgressStatus': {
        'ChangeId': 'string',
        'StartTime': datetime(2015, 1, 1),
        'Status': 'PENDING'|'PROCESSING'|'COMPLETED'|'FAILED',
        'PendingProperties': [
            'string',
        ],
        'CompletedProperties': [
            'string',
        ],
        'TotalNumberOfStages': 123,
        'ChangeProgressStages': [
            {
                'Name': 'string',
                'Status': 'string',
                'Description': 'string',
                'LastUpdated': datetime(2015, 1, 1)
            },
        ],
        'LastUpdatedTime': datetime(2015, 1, 1),
        'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled',
        'InitiatedBy': 'CUSTOMER'|'SERVICE'
    }
}

Response Structure

• (dict) –

  The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

  • ChangeProgressStatus (dict) –

    Container for information about the stages of a configuration change happening on a domain.

    • ChangeId (string) –

      The unique change identifier associated with a specific domain configuration change.

    • StartTime (datetime) –

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

    • Status (string) –

      The overall status of the domain configuration change.

    • PendingProperties (list) –

      The list of properties in the domain configuration change that are still pending.

      • (string) –

    • CompletedProperties (list) –

      The list of properties in the domain configuration change that have completed.

      • (string) –

    • TotalNumberOfStages (integer) –

      The total number of stages required for the configuration change.

    • ChangeProgressStages (list) –

      The specific stages that the domain is going through to perform the configuration change.

      • (dict) –

        Progress details for each stage of a domain update.

        • Name (string) –

          The name of the stage.

        • Status (string) –

          The status of the stage.

        • Description (string) –

          The description of the stage.

        • LastUpdated (datetime) –

          The most recent updated timestamp of the stage.

    • LastUpdatedTime (datetime) –

      The last time that the status of the configuration change was updated.

    • ConfigChangeStatus (string) –

      The current status of the configuration change.

    • InitiatedBy (string) –

      The IAM principal who initiated the configuration change.

Exceptions

• OpenSearchService.Client.exceptions.BaseException

• OpenSearchService.Client.exceptions.InternalException

• OpenSearchService.Client.exceptions.ResourceNotFoundException

• OpenSearchService.Client.exceptions.ValidationException