Skip to content

Describe Events

cloudformation_describe_events R Documentation

Returns CloudFormation events based on flexible query criteria

Description

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.

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

Usage

cloudformation_describe_events(StackName, ChangeSetName, OperationId,
  Filters, NextToken)

Arguments

StackName

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

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

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

Filters to apply when retrieving events.
NextToken

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

Value

A list with the following syntax:

list(
  OperationEvents = list(
    list(
      EventId = "string",
      StackId = "string",
      OperationId = "string",
      OperationType = "CREATE_STACK"|"UPDATE_STACK"|"DELETE_STACK"|"CONTINUE_ROLLBACK"|"ROLLBACK"|"CREATE_CHANGESET",
      OperationStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED",
      EventType = "STACK_EVENT"|"PROGRESS_EVENT"|"VALIDATION_ERROR"|"PROVISIONING_ERROR"|"HOOK_INVOCATION_ERROR",
      LogicalResourceId = "string",
      PhysicalResourceId = "string",
      ResourceType = "string",
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      ResourceStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"DELETE_SKIPPED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_COMPLETE"|"IMPORT_FAILED"|"IMPORT_COMPLETE"|"IMPORT_IN_PROGRESS"|"IMPORT_ROLLBACK_IN_PROGRESS"|"IMPORT_ROLLBACK_FAILED"|"IMPORT_ROLLBACK_COMPLETE"|"EXPORT_FAILED"|"EXPORT_COMPLETE"|"EXPORT_IN_PROGRESS"|"EXPORT_ROLLBACK_IN_PROGRESS"|"EXPORT_ROLLBACK_FAILED"|"EXPORT_ROLLBACK_COMPLETE"|"UPDATE_ROLLBACK_IN_PROGRESS"|"UPDATE_ROLLBACK_COMPLETE"|"UPDATE_ROLLBACK_FAILED"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_COMPLETE"|"ROLLBACK_FAILED",
      ResourceStatusReason = "string",
      ResourceProperties = "string",
      ClientRequestToken = "string",
      HookType = "string",
      HookStatus = "HOOK_IN_PROGRESS"|"HOOK_COMPLETE_SUCCEEDED"|"HOOK_COMPLETE_FAILED"|"HOOK_FAILED",
      HookStatusReason = "string",
      HookInvocationPoint = "PRE_PROVISION",
      HookFailureMode = "FAIL"|"WARN",
      DetailedStatus = "CONFIGURATION_COMPLETE"|"VALIDATION_FAILED",
      ValidationFailureMode = "FAIL"|"WARN",
      ValidationName = "string",
      ValidationStatus = "FAILED"|"SKIPPED",
      ValidationStatusReason = "string",
      ValidationPath = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_events(
  StackName = "string",
  ChangeSetName = "string",
  OperationId = "string",
  Filters = list(
    FailedEvents = TRUE|FALSE
  ),
  NextToken = "string"
)