Request Parameters Response Elements Errors See Also

DescribeEvents

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ChangeSetName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*

Required: No

Filters

Filters to apply when retrieving events.

Type: EventFilter object

Required: No

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

OperationId

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

Type: String

Required: No

StackName

The name or unique stack ID for which you want to retrieve events.

Type: String

Length Constraints: Minimum length of 1.

Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)

Required: No

Response Elements

The following elements are returned by the service.

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

OperationEvents.member.N

A list of operation events that match the specified criteria.

Type: Array of OperationEvent objects

Errors

For information about the errors that are common to all actions, see Common Errors.