Skip to content

CloudFormation  >  Operations  >  describe_events

describe_events

Operation

describe_events async

describe_events(request: DescribeEventsInput | DescribeEventsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeEventsOutput
describe_events(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeEventsInputDict]) -> DescribeEventsOutput

Returns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment.

An operation is any action performed on a stack, including stack lifecycle actions (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and represents a discrete change attempt on the stack.

Returns different types of events including:

  • Progress events - Status updates during stack operation execution.

  • Validation errors - Failures from CloudFormation Early Validations.

  • Provisioning errors - Resource creation and update failures.

  • Hook invocation errors - Failures from CloudFormation Hook during stack operations.

Note

One of ChangeSetName, OperationId or StackName must be specified as input.

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
DescribeEventsOutput

An instance of DescribeEventsOutput.

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

DescribeEventsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeEventsInput 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 for which you want to retrieve events.

filters class-attribute instance-attribute
filters: EventFilter | None = ...

Filters to apply when retrieving events.

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.)

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

The unique identifier of the operation for which you want to retrieve events.

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

The name or unique stack ID for which you want to retrieve events. If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

Dictionaries

DescribeEventsInputDict

Bases: TypedDict

Dictionary form of DescribeEventsInput.

Attributes
change_set_name instance-attribute
change_set_name: str | None

The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.

filters instance-attribute
filters: EventFilter | EventFilterDict | None

Filters to apply when retrieving events.

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.)

operation_id instance-attribute
operation_id: str | None

The unique identifier of the operation for which you want to retrieve events.

stack_name instance-attribute
stack_name: str | None

The name or unique stack ID for which you want to retrieve events. 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

DescribeEventsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeEventsOutput structure.

Attributes

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeEvents again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

operation_events class-attribute instance-attribute
operation_events: list[OperationEvent] | None = ...

A list of operation events that match the specified criteria.

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.