get_upgrade_status

OpenSearchService.Client.get_upgrade_status(**kwargs)

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

response = client.get_upgrade_status(
    DomainName='string'
)

Parameters

DomainName (string) --

[REQUIRED]

The domain of the domain to get upgrade status information for.

Return type

dict

Returns

Response Syntax

{
    'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
    'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
    'UpgradeName': 'string'
}

Response Structure

• (dict) --

  Container for the response returned by the GetUpgradeStatus operation.

  • UpgradeStep (string) --

    One of three steps that an upgrade or upgrade eligibility check goes through.

  • StepStatus (string) --

    The status of the current step that an upgrade is on.

  • UpgradeName (string) --

    A string that describes the update.

Exceptions

• OpenSearchService.Client.exceptions.BaseException
• OpenSearchService.Client.exceptions.ResourceNotFoundException
• OpenSearchService.Client.exceptions.DisabledOperationException
• OpenSearchService.Client.exceptions.ValidationException
• OpenSearchService.Client.exceptions.InternalException