DeleteChangeSet
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If IncludeNestedStacks
specifies True
during the creation of the
nested change set, then DeleteChangeSet
will delete all change sets that belong
to the stacks hierarchy and will also delete all change sets for nested stacks with the status
of REVIEW_IN_PROGRESS
.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ChangeSetName
-
The name or Amazon Resource Name (ARN) of the change set that you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*
Required: Yes
- StackName
-
If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's associated with it.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidChangeSetStatus
-
The specified change set can't be used to update the stack. For example, the change set status might be
CREATE_IN_PROGRESS
, or the stack status might beUPDATE_IN_PROGRESS
.HTTP Status Code: 400
Examples
DeleteChangeSet
This example illustrates one usage of DeleteChangeSet.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DeleteChangeSet
&ChangeSetName=arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b
&Version=2010-05-15
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20160316T233349Z
&X-Amz-SignedHeaders=content-type;host
&X-Amz-Signature=[Signature]
Sample Response
<DeleteChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DeleteChangeSetResult/>
<ResponseMetadata>
<RequestId>5ccc7dcd-744c-11e5-be70-example</RequestId>
</ResponseMetadata>
</DeleteChangeSetResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: