Skip to content

CloudFormation  >  Operations  >  describe_change_set_hooks

describe_change_set_hooks

Operation

describe_change_set_hooks async

describe_change_set_hooks(request: DescribeChangeSetHooksInput | DescribeChangeSetHooksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeChangeSetHooksOutput
describe_change_set_hooks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeChangeSetHooksInputDict]) -> DescribeChangeSetHooksOutput

Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Parameters:

Name Type Description Default
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
DescribeChangeSetHooksOutput

An instance of DescribeChangeSetHooksOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeChangeSetHooksInput dataclass

Bases: _SerdeShape

Dataclass for DescribeChangeSetHooksInput structure.

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.

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

If specified, lists only the Hooks related to the specified LogicalResourceId.

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 stack ID (ARN) of the change set you want to describe.

Dictionaries

DescribeChangeSetHooksInputDict

Bases: TypedDict

Dictionary form of DescribeChangeSetHooksInput.

Attributes
change_set_name instance-attribute
change_set_name: Required[str]

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

logical_resource_id instance-attribute
logical_resource_id: str | None

If specified, lists only the Hooks related to the specified LogicalResourceId.

next_token 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 instance-attribute
stack_name: str | None

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

Output

DescribeChangeSetHooksOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeChangeSetHooksOutput structure.

Attributes

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

The change set identifier (stack ID).

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

The change set name.

hooks class-attribute instance-attribute
hooks: list[ChangeSetHook] | None = ...

List of Hook objects.

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

Pagination token, null or empty if no more results.

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.

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

The stack identifier (stack ID).

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

The stack name.

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

Provides the status of the change set Hook.