Skip to content

CloudFormation  >  Operations  >  describe_change_set

describe_change_set

Operation

describe_change_set async 

describe_change_set(input: DescribeChangeSetInput, plugins: list[Plugin] | None = None) -> DescribeChangeSetOutput

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.

Parameters:

Name Type Description Default
input DescribeChangeSetInput

An instance of DescribeChangeSetInput.

 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
DescribeChangeSetOutput

An instance of DescribeChangeSetOutput.

Input

DescribeChangeSetInput dataclass

Bases: _SerdeShape

The input for the DescribeChangeSet 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 describe.

include_property_values class-attribute instance-attribute 
include_property_values: bool | None = ...

If true, the returned changes include detailed changes in the property values.

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

The token for the next set of items to return. (You received this token from a previous call.)

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

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

Output

DescribeChangeSetOutput dataclass

Bases: _SerdeShape

The output for the DescribeChangeSet action.

Attributes

capabilities class-attribute instance-attribute 
capabilities: list[str] | None = ...

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

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

The Amazon Resource Name (ARN) of the change set.

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

The name of the change set.

changes class-attribute instance-attribute 
changes: list[Change] | None = ...

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

creation_time class-attribute instance-attribute 
creation_time: datetime | None = ...

The start time when the change set was created, in UTC.

deployment_config class-attribute instance-attribute 
deployment_config: DeploymentConfig | None = ...

The deployment configuration specified when the change set was created.

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

The deployment mode specified when the change set was created. Valid value is REVERT_DRIFT. Only present for drift-aware change sets.

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

Information about the change set.

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

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

import_existing_resources class-attribute instance-attribute 
import_existing_resources: bool | None = ...

Indicates if the change set imports resources that already exist.

Note

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

include_nested_stacks class-attribute instance-attribute 
include_nested_stacks: bool | None = ...

Verifies if IncludeNestedStacks is set to True.

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

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

notification_ar_ns class-attribute instance-attribute 
notification_ar_ns: list[str] | None = ...

The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.

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

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

parameters class-attribute instance-attribute 
parameters: list[Parameter] | None = ...

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

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

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

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.

rollback_configuration class-attribute instance-attribute 
rollback_configuration: RollbackConfiguration | None = ...

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

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

Specifies the change set ID of the root change set in the current nested change set hierarchy.

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

The drift status of the stack when the change set was created. Valid values:

  • DRIFTED -- The stack has drifted from its last deployment.

  • IN_SYNC -- The stack is in sync with its last deployment.

  • NOT_CHECKED -- CloudFormation doesn't currently return this value.

  • UNKNOWN -- The drift status could not be determined.

Only present for drift-aware change sets.

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

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

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

The name of the stack that's associated with the change set.

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

The current status of the change set, such as CREATE_PENDING, CREATE_COMPLETE, or FAILED.

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

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

If you execute the change set, the tags that will be associated with the stack.