Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

post/2021-01-01/opensearch/upgradeDomain

Request body

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.

TargetVersionstring required

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

PerformCheckOnlyboolean

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

AdvancedOptionsobject
<p>Exposes native OpenSearch configuration values from <code>opensearch.yml</code>. The following advanced options are available: </p> <ul> <li> <p>Allows references to indexes in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. Default is <code>true</code>.</p> </li> <li> <p>Specifies the percentage of heap space allocated to field data. Default is unbounded.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</p>

Response

Success

UpgradeIdstring

The unique identifier of the domain upgrade.

DomainNamestring

The name of the domain that was upgraded.

TargetVersionstring

OpenSearch or Elasticsearch version that the domain was upgraded to.

PerformCheckOnlyboolean

When true, indicates that an upgrade eligibility check was performed.

AdvancedOptionsobject

The advanced options configuration for the domain.