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/{DomainName}/status

      The Amazon Elasticsearch Service multi-region endpoint
      The Amazon Elasticsearch Service multi-region endpoint
      GET
      /2015-01-01/es/upgradeDomain/{DomainName}/status
      Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/upgradeDomain//status'
      Response Response Example
      200 - Example 1
      {
  "UpgradeStep": "PRE_UPGRADE_CHECK",
  "StepStatus": "IN_PROGRESS",
  "UpgradeName": "string"
}

      Request

      Path Params
      DomainName
      string 
      required

      Responses

      🟢200Success
      application/json
      Body
      Container for response returned by <code> <a>GetUpgradeStatus</a> </code> operation.
      UpgradeStep
      enum<string> 
      optional
      Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
      • PreUpgradeCheck
      • Snapshot
      • Upgrade
      Allowed values:
      PRE_UPGRADE_CHECKSNAPSHOTUPGRADE
      StepStatus
      enum<string> 
      optional
      One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:
      • In Progress
      • Succeeded
      • Succeeded with Issues
      • Failed
      Allowed values:
      IN_PROGRESSSUCCEEDEDSUCCEEDED_WITH_ISSUESFAILED
      UpgradeName
      string 
      optional
      A string that describes the update briefly
      🟠480BaseException
      🟠481ResourceNotFoundException
      🟠482DisabledOperationException
      🟠483ValidationException
      🟠484InternalException
      Modified at 2023-08-15 04:15:53
      Previous
      /2015-01-01/es/upgradeDomain/{DomainName}/history
      Next
      /2015-01-01/domain
      Built with