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/serviceSoftwareUpdate/start

      The Amazon Elasticsearch Service multi-region endpoint
      The Amazon Elasticsearch Service multi-region endpoint
      POST
      /2015-01-01/es/serviceSoftwareUpdate/start
      Schedules a service software update for an Amazon ES domain.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/serviceSoftwareUpdate/start' \
--header 'Content-Type: application/json' \
--data-raw ''
      Response Response Example
      200 - Example 1
      {
  "ServiceSoftwareOptions": {
    "CurrentVersion": "string",
    "NewVersion": "string",
    "UpdateAvailable": true,
    "Cancellable": true,
    "UpdateStatus": "PENDING_UPDATE",
    "Description": "string",
    "AutomatedUpdateDate": "string",
    "OptionalDeployment": true
  }
}

      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\-]+
      Examples

      Responses

      🟢200Success
      application/json
      Body
      The result of a <code>StartElasticsearchServiceSoftwareUpdate</code> operation. Contains the status of the update.
      ServiceSoftwareOptions
      object 
      optional
      The current status of the Elasticsearch service software update.
      CurrentVersion
      string 
      optional
      The current service software version that is present on the domain.
      NewVersion
      string 
      optional
      The new service software version if one is available.
      UpdateAvailable
      boolean 
      optional
      True if you are able to update you service software version. False if you are not able to update your service software version.
      Cancellable
      boolean 
      optional
      True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
      UpdateStatus
      enum<string> 
      optional
      The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
      Allowed values:
      PENDING_UPDATEIN_PROGRESSCOMPLETEDNOT_ELIGIBLEELIGIBLE
      Description
      string 
      optional
      The description of the UpdateStatus.
      AutomatedUpdateDate
      string <date-time>
      optional
      Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
      OptionalDeployment
      boolean 
      optional
      True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
      🟠480BaseException
      🟠481InternalException
      🟠482ResourceNotFoundException
      🟠483ValidationException
      Modified at 2023-08-15 04:15:53
      Previous
      /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      Next
      /2015-01-01/packages/update
      Built with