AWS CloudFormation

{'Metadata': 'string',
 'Parameters': {'ParameterConstraints': {'AllowedValues': ['string']}}}

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

Request Syntax

client.get_template_summary(
    TemplateBody='string',
    TemplateURL='string',
    StackName='string'
)

type TemplateBody

string

param TemplateBody

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

type TemplateURL

string

param TemplateURL

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

type StackName

string

param StackName

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

rtype

dict

returns

Response Syntax

{
    'Parameters': [
        {
            'ParameterKey': 'string',
            'DefaultValue': 'string',
            'ParameterType': 'string',
            'NoEcho': True|False,
            'Description': 'string',
            'ParameterConstraints': {
                'AllowedValues': [
                    'string',
                ]
            }
        },
    ],
    'Description': 'string',
    'Capabilities': [
        'CAPABILITY_IAM',
    ],
    'CapabilitiesReason': 'string',
    'Version': 'string',
    'Metadata': 'string'
}

Response Structure

• (dict) --

  The output for the GetTemplateSummary action.

  • Parameters (list) --

    A list of parameter declarations that describe various properties for each parameter.

    • (dict) --

      The ParameterDeclaration data type.

      • ParameterKey (string) --

        The name that is associated with the parameter.

      • DefaultValue (string) --

        The default value of the parameter.

      • ParameterType (string) --

        The type of parameter.

      • NoEcho (boolean) --

        Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

      • Description (string) --

        The description that is associate with the parameter.

      • ParameterConstraints (dict) --

        The criteria that AWS CloudFormation uses to validate parameter values.

        • AllowedValues (list) --

          A list of values that are permitted for a parameter.

          • (string) --

  • Description (string) --

    The value that is defined in the Description property of the template.

  • Capabilities (list) --

    The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

    • (string) --

  • CapabilitiesReason (string) --

    The list of resources that generated the values in the Capabilities response element.

  • Version (string) --

    The AWS template format version, which identifies the capabilities of the template.

  • Metadata (string) --

    The value that is defined for the Metadata property of the template.