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

CancelServiceSoftwareUpdate

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Request Syntax


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

{
   "DomainName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DomainName

Name of the OpenSearch Service domain that you want to cancel the service software update on.

Type: String

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

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ServiceSoftwareOptions": { 
      "AutomatedUpdateDate": number,
      "Cancellable": boolean,
      "CurrentVersion": "string",
      "Description": "string",
      "NewVersion": "string",
      "OptionalDeployment": boolean,
      "UpdateAvailable": boolean,
      "UpdateStatus": "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.

ServiceSoftwareOptions

Container for the state of your domain relative to the latest service software.

Type: ServiceSoftwareOptions object

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

InternalException

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

HTTP Status Code: 500

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