Amazon Elasticsearch Service
    Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST

      /2015-01-01/es/upgradeDomain

      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      POST
      /2015-01-01/es/upgradeDomain
      Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/upgradeDomain' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DomainName": "string",
    "TargetVersion": "string",
    "PerformCheckOnly": true
}'
      Response Response Example
      200 - Example 1
      {
  "DomainName": "string",
  "TargetVersion": "string",
  "PerformCheckOnly": true,
  "ChangeProgressDetails": {
    "ChangeId": "string",
    "Message": "string"
  }
}

      Request

      Body Params application/json
      DomainName
      string 
      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).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      TargetVersion
      string 
      required
      The version of Elasticsearch that you intend to upgrade the domain to.
      Match pattern:
      ^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$
      PerformCheckOnly
      boolean 
      optional
      This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
      Examples

      Responses

      🟢200Success
      application/json
      Body
      Container for response returned by <code> <a>UpgradeElasticsearchDomain</a> </code> operation.
      DomainName
      string 
      optional
      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).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      TargetVersion
      string 
      optional
      The version of Elasticsearch that you intend to upgrade the domain to.
      Match pattern:
      ^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$
      PerformCheckOnly
      boolean 
      optional
      This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
      ChangeProgressDetails
      object (ChangeProgressDetails) 
      optional
      Specifies change details of the domain configuration change.
      ChangeId
      string 
      optional
      The unique change identifier associated with a specific domain configuration change.
      Match pattern:
      \p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}
      Message
      string 
      optional
      Contains an optional message associated with the domain configuration change.
      >= 0 characters<= 1024 characters
      🟠480BaseException
      🟠481ResourceNotFoundException
      🟠482ResourceAlreadyExistsException
      🟠483DisabledOperationException
      🟠484ValidationException
      🟠485InternalException
      Previous
      /2015-01-01/es/vpcEndpoints/update
      Built with