CloudFormation / Client / list_generated_templates

list_generated_templates#

CloudFormation.Client.list_generated_templates(**kwargs)#

Lists your generated templates in this Region.

See also: AWS API Documentation

Request Syntax

response = client.list_generated_templates(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A string that identifies the next page of resource scan results.

  • MaxResults (integer) – If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.

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
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.