CancelDomainConfigChange - Amazon OpenSearch Service


Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Request Syntax

POST /2021-01-01/opensearch/domain/DomainName/config/cancel HTTP/1.1 Content-type: application/json { "DryRun": boolean }

URI Request Parameters

The request uses the following URI parameters.


The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.


When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CancelledChangeIds": [ "string" ], "CancelledChangeProperties": [ { "ActiveValue": "string", "CancelledValue": "string", "PropertyName": "string" } ], "DryRun": boolean }

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.


The unique identifiers of the changes that were cancelled.

Type: Array of strings

Length Constraints: Fixed length of 36.

Pattern: \p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}


The domain change properties that were cancelled.

Type: Array of CancelledChangeProperty objects


Whether or not the request was a dry run. If True, the changes were not actually cancelled.

Type: Boolean


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


An error occurred while processing the request.

HTTP Status Code: 400


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

HTTP Status Code: 409


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

HTTP Status Code: 500


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

HTTP Status Code: 409


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: