CancelChangeSet - AWS Marketplace Catalog API

CancelChangeSet

Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.

Request Syntax

PATCH /CancelChangeSet?catalog=Catalog&changeSetId=ChangeSetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Catalog

Required. The catalog related to the request. Fixed value: AWSMarketplace.

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

Pattern: ^[a-zA-Z]+$

Required: Yes

ChangeSetId

Required. The unique identifier of the StartChangeSet request that you want to cancel.

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

Pattern: ^[\w\-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ChangeSetArn": "string", "ChangeSetId": "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.

ChangeSetArn

The ARN associated with the change set referenced in this request.

Type: String

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

Pattern: ^[a-zA-Z0-9:*/-]+$

ChangeSetId

The unique identifier for the change set referenced in this request.

Type: String

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

Pattern: ^[\w\-]+$

Errors

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

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServiceException

There was an internal service exception.

HTTP Status Code: 500

ResourceInUseException

The resource is currently in use.

HTTP Status Code: 423

ResourceNotFoundException

The specified resource wasn't found.

HTTP Status Code: 404

ThrottlingException

Too many requests.

HTTP Status Code: 429

ValidationException

An error occurred during validation.

HTTP Status Code: 422

See Also

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