CloudFormation / Paginator / ListStackResources

ListStackResources

class CloudFormation.Paginator.ListStackResources

paginator = client.get_paginator('list_stack_resources')

paginate(**kwargs)

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

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 unique stack ID that is 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

{
    'StackResourceSummaries': [
        {
            'LogicalResourceId': 'string',
            'PhysicalResourceId': 'string',
            'ResourceType': 'string',
            'LastUpdatedTimestamp': 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',
            'DriftInformation': {
                'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
                'LastCheckTimestamp': datetime(2015, 1, 1)
            },
            'ModuleInfo': {
                'TypeHierarchy': 'string',
                'LogicalIdHierarchy': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  The output for a ListStackResources action.

  • StackResourceSummaries (list) –

    A list of StackResourceSummary structures.

    • (dict) –

      Contains high-level information about the specified stack resource.

      • LogicalResourceId (string) –

        The logical name of the resource specified in the template.

      • PhysicalResourceId (string) –

        The name or unique identifier that corresponds to a physical instance ID of the resource.

      • ResourceType (string) –

        Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

      • LastUpdatedTimestamp (datetime) –

        Time the status was updated.

      • ResourceStatus (string) –

        Current status of the resource.

      • ResourceStatusReason (string) –

        Success/failure message associated with the resource.

      • DriftInformation (dict) –

        Information about whether the resource’s actual configuration differs, or has drifted , from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

        • StackResourceDriftStatus (string) –

          Status of the resource’s actual configuration compared to its expected configuration.

          • DELETED : The resource differs from its expected configuration in that it has been deleted.

          • MODIFIED : The resource differs from its expected configuration.

          • NOT_CHECKED : CloudFormation hasn’t checked if the resource differs from its expected configuration. Any resources that don’t currently support drift detection have a status of NOT_CHECKED . For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED . For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.

          • IN_SYNC : The resource’s actual configuration matches its expected configuration.

        • LastCheckTimestamp (datetime) –

          When CloudFormation last checked if the resource had drifted from its expected configuration.

      • ModuleInfo (dict) –

        Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

        • TypeHierarchy (string) –

          A concatenated list of the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by / .

          In the following example, the resource was created from a module of type AWS::First::Example::MODULE , that’s nested inside a parent module of type AWS::Second::Example::MODULE .

          AWS::First::Example::MODULE/AWS::Second::Example::MODULE

        • LogicalIdHierarchy (string) –

          A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by / .

          In the following example, the resource was created from a module, moduleA , that’s nested inside a parent module, moduleB .

          moduleA/moduleB

          For more information, see Referencing resources in a module in the CloudFormation User Guide .