CloudFormation / Paginator / ListGeneratedTemplates

ListGeneratedTemplates

class CloudFormation.Paginator.ListGeneratedTemplates

paginator = client.get_paginator('list_generated_templates')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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.

• PageSize (integer) –

  The size of each page.

• 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': [
        {
            'GeneratedTemplateId': 'string',
            'GeneratedTemplateName': 'string',
            'Status': 'CREATE_PENDING'|'UPDATE_PENDING'|'DELETE_PENDING'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'FAILED'|'COMPLETE',
            'StatusReason': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'NumberOfResources': 123
        },
    ],

}

Response Structure

• (dict) –

  • Summaries (list) –

    A list of summaries of the generated templates.

    • (dict) –

      The summary of a generated template.

      • GeneratedTemplateId (string) –

        The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, ``arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc ``.

      • GeneratedTemplateName (string) –

        The name of the generated template.

      • Status (string) –

        The status of the template generation. Supported values are:

        • CreatePending - the creation of the template is pending.

        • CreateInProgress - the creation of the template is in progress.

        • DeletePending - the deletion of the template is pending.

        • DeleteInProgress - the deletion of the template is in progress.

        • UpdatePending - the update of the template is pending.

        • UpdateInProgress - the update of the template is in progress.

        • Failed - the template operation failed.

        • Complete - the template operation is complete.

      • StatusReason (string) –

        The reason for the current template generation status. This will provide more details if a failure happened.

      • CreationTime (datetime) –

        The time the generated template was created.

      • LastUpdatedTime (datetime) –

        The time the generated template was last updated.

      • NumberOfResources (integer) –

        The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.