Skip to content

CloudFormation  >  Operations  >  delete_change_set

delete_change_set

Operation

delete_change_set async 

delete_change_set(input: DeleteChangeSetInput, plugins: list[Plugin] | None = None) -> DeleteChangeSetOutput

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.

Parameters:

Name Type Description Default
input DeleteChangeSetInput

An instance of DeleteChangeSetInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteChangeSetOutput

An instance of DeleteChangeSetOutput.

Input

DeleteChangeSetInput dataclass

Bases: _SerdeShape

The input for the DeleteChangeSet action.

Attributes

change_set_name class-attribute instance-attribute 
change_set_name: str | None = ...

The name or Amazon Resource Name (ARN) of the change set that you want to delete.

stack_name class-attribute instance-attribute 
stack_name: str | None = ...

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.

Output

DeleteChangeSetOutput dataclass

Bases: _SerdeShape

The output for the DeleteChangeSet action.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.