Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpgradeDomain

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

Request Syntax


POST /2021-01-01/opensearch/upgradeDomain HTTP/1.1
Content-type: application/json

{
   "AdvancedOptions": { 
      "string" : "string" 
   },
   "DomainName": "string",
   "PerformCheckOnly": boolean,
   "TargetVersion": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AdvancedOptions

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

Type: String to string map

Required: No

DomainName

Name of the OpenSearch Service domain that you want to upgrade.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

PerformCheckOnly

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

Type: Boolean

Required: No

TargetVersion

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

Type: String

Length Constraints: Minimum length of 14. Maximum length of 18.

Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AdvancedOptions": { 
      "string" : "string" 
   },
   "ChangeProgressDetails": { 
      "ChangeId": "string",
      "ConfigChangeStatus": "string",
      "InitiatedBy": "string",
      "LastUpdatedTime": number,
      "Message": "string",
      "StartTime": number
   },
   "DomainName": "string",
   "PerformCheckOnly": boolean,
   "TargetVersion": "string",
   "UpgradeId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AdvancedOptions

The advanced options configuration for the domain.

Type: String to string map

ChangeProgressDetails

Container for information about a configuration change happening on a domain.

Type: ChangeProgressDetails object

DomainName

The name of the domain that was upgraded.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

PerformCheckOnly

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

Type: Boolean

TargetVersion

OpenSearch or Elasticsearch version that the domain was upgraded to.

Type: String

Length Constraints: Minimum length of 14. Maximum length of 18.

Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

UpgradeId

The unique identifier of the domain upgrade.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceAlreadyExistsException

An exception for creating a resource that already exists.

HTTP Status Code: 409

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400