CloudFormation / Paginator / ListChangeSets

ListChangeSets

class CloudFormation.Paginator.ListChangeSets

paginator = client.get_paginator('list_change_sets')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• StackName (string) –

  [REQUIRED]

  The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

• 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

{
    'Summaries': [
        {
            'StackId': 'string',
            'StackName': 'string',
            'ChangeSetId': 'string',
            'ChangeSetName': 'string',
            'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'OBSOLETE',
            'Status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'FAILED',
            'StatusReason': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Description': 'string',
            'IncludeNestedStacks': True|False,
            'ParentChangeSetId': 'string',
            'RootChangeSetId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  The output for the ListChangeSets action.

  • Summaries (list) –

    A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

    • (dict) –

      The ChangeSetSummary structure describes a change set, its status, and the stack with which it’s associated.

      • StackId (string) –

        The ID of the stack with which the change set is associated.

      • StackName (string) –

        The name of the stack with which the change set is associated.

      • ChangeSetId (string) –

        The ID of the change set.

      • ChangeSetName (string) –

        The name of the change set.

      • ExecutionStatus (string) –

        If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

      • Status (string) –

        The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

      • StatusReason (string) –

        A description of the change set’s status. For example, if your change set is in the FAILED state, CloudFormation shows the error message.

      • CreationTime (datetime) –

        The start time when the change set was created, in UTC.

      • Description (string) –

        Descriptive information about the change set.

      • IncludeNestedStacks (boolean) –

        Specifies the current setting of IncludeNestedStacks for the change set.

      • ParentChangeSetId (string) –

        The parent change set ID.

      • RootChangeSetId (string) –

        The root change set ID.