Menu
AWS CloudFormation
API Reference (API Version 2010-05-15)

ExecuteChangeSet

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

Request Parameters

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

ChangeSetName

The name or ARN of the change set that you want use to update the specified stack.

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

ClientRequestToken

A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.

Type: String

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

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

StackName

If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

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.

ChangeSetNotFound

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

HTTP Status Code: 404

InsufficientCapabilities

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

HTTP Status Code: 400

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 be UPDATE_IN_PROGRESS.

HTTP Status Code: 400

TokenAlreadyExists

A client request token already exists.

HTTP Status Code: 400

Example

ExecuteChangeSet

Sample Request


https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ExecuteChangeSet
 &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


<ExecuteChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ExecuteChangeSetResult/>
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-example</RequestId>
  </ResponseMetadata>
</ExecuteChangeSetResponse>
         

See Also

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