ElasticsearchService / Client / get_upgrade_status

get_upgrade_status#

ElasticsearchService.Client.get_upgrade_status(**kwargs)#

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

See also: AWS API Documentation

Request Syntax

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

DomainName (string) –

[REQUIRED]

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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 response returned by GetUpgradeStatus operation.

    • UpgradeStep (string) –

      Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

      • PreUpgradeCheck

      • Snapshot

      • Upgrade

    • StepStatus (string) –

      One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

      • In Progress

      • Succeeded

      • Succeeded with Issues

      • Failed

    • UpgradeName (string) –

      A string that describes the update briefly

Exceptions