Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1450331268.9 KB

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

get/2015-01-01/es/upgradeDomain/{DomainName}/status

Path parameters

DomainNamestring 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).

Response

Success

UpgradeStep'PRE_UPGRADE_CHECK' | 'SNAPSHOT' | 'UPGRADE'

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul>

StepStatus'IN_PROGRESS' | 'SUCCEEDED' | 'SUCCEEDED_WITH_ISSUES' | 'FAILED'

One of 4 statuses that a step can go through returned as part of the <code> <a>GetUpgradeStatusResponse</a> </code> object. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul>

UpgradeNamestring

A string that describes the update briefly