CloudFormation / Client / cancel_update_stack

cancel_update_stack¶

CloudFormation.Client.cancel_update_stack(**kwargs)¶

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

Note

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Request Syntax

response = client.cancel_update_stack(
    StackName='string',
    ClientRequestToken='string'
)

Parameters:

StackName (string) –
[REQUIRED]

Note
If you don’t pass a parameter to StackName, the API returns a response that describes all resources in the account.

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

The name or the unique stack ID that’s associated with the stack.
ClientRequestToken (string) – A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

Returns:

None

Exceptions

CloudFormation.Client.exceptions.TokenAlreadyExistsException