DescribeStackEvents¶

class CloudFormation.Paginator.DescribeStackEvents¶

paginator = client.get_paginator('describe_stack_events')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudFormation.Client.describe_stack_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StackName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

StackName (string) --
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'StackEvents': [
        {
            'StackId': 'string',
            'EventId': 'string',
            'StackName': 'string',
            'LogicalResourceId': 'string',
            'PhysicalResourceId': 'string',
            'ResourceType': 'string',
            'Timestamp': datetime(2015, 1, 1),
            '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'|'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'
        },
    ],

}

Response Structure

(dict) --

The output for a DescribeStackEvents action.
- StackEvents (list) --
  
  A list of StackEvents structures.
  - (dict) --
    
    The StackEvent data type.
    - StackId (string) --
      
      The unique ID name of the instance of the stack.
    - EventId (string) --
      
      The unique ID of this event.
    - StackName (string) --
      
      The name associated with a stack.
    - LogicalResourceId (string) --
      
      The logical name of the resource specified in the template.
    - PhysicalResourceId (string) --
      
      The name or unique identifier associated with the physical instance of the resource.
    - ResourceType (string) --
      
      Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
    - Timestamp (datetime) --
      
      Time the status was updated.
    - ResourceStatus (string) --
      
      Current status of the resource.
    - ResourceStatusReason (string) --
      
      Success/failure message associated with the resource.
    - ResourceProperties (string) --
      
      BLOB of the properties used to create the resource.
    - ClientRequestToken (string) --
      
      The token passed to the operation that generated this event.
      
      All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1 , then all the StackEvents generated by that operation will have ClientRequestToken set as token1 .
      
      In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID , which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 .
    - HookType (string) --
      
      The name of the hook.
    - HookStatus (string) --
      
      Provides the status of the change set hook.
    - HookStatusReason (string) --
      
      Provides the reason for the hook status.
    - HookInvocationPoint (string) --
      
      Invocation points are points in provisioning logic where hooks are initiated.
    - HookFailureMode (string) --
      
      Specify the hook failure mode for non-compliant resources in the followings ways.
      - FAIL Stops provisioning resources.
      - WARN Allows provisioning to continue with a warning message.

Table Of Contents

DescribeStackEvents¶