Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

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

get/2021-01-01/opensearch/upgradeDomain/{DomainName}/status

Path parameters

DomainNamestring required

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

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

Response

Success

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

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

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

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

UpgradeNamestring

A string that describes the update.