Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1450331268.9 KB

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

post/2015-01-01/es/upgradeDomain

Request body

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

TargetVersionstring required

The version of Elasticsearch that you intend to upgrade the domain to.

PerformCheckOnlyboolean

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

Response

Success

DomainNamestring

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

TargetVersionstring

The version of Elasticsearch that you intend to upgrade the domain to.

PerformCheckOnlyboolean

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.