CancelResourceRequest - AWS Cloud Control API

CancelResourceRequest

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the AWS Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can be canceled.

Request Syntax

{ "RequestToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

RequestToken

The RequestToken of the ProgressEvent object returned by the resource operation request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-A-Za-z0-9+/=]+

Required: Yes

Response Syntax

{ "ProgressEvent": { "ErrorCode": "string", "EventTime": number, "HooksRequestToken": "string", "Identifier": "string", "Operation": "string", "OperationStatus": "string", "RequestToken": "string", "ResourceModel": "string", "RetryAfter": number, "StatusMessage": "string", "TypeName": "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.

ProgressEvent

Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the AWS Cloud Control API User Guide.

Type: ProgressEvent object

Errors

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

ConcurrentModificationException

The resource is currently being modified by another operation.

HTTP Status Code: 500

RequestTokenNotFoundException

A resource operation with the specified request token can't be found.

HTTP Status Code: 400

See Also

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