CloudFormation / Client / get_template

get_template#

CloudFormation.Client.get_template(**kwargs)#

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

Note

If the template doesn’t exist, a ValidationError is returned.

See also: AWS API Documentation

Request Syntax

response = client.get_template(
    StackName='string',
    ChangeSetName='string',
    TemplateStage='Original'|'Processed'
)
Parameters:

  • StackName (string) –

    The name or the unique stack ID that’s 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.

  • ChangeSetName (string) – The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

  • TemplateStage (string) –

    For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

    If the template doesn’t include transforms, Original and Processed return the same template. By default, CloudFormation specifies Processed.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateBody': {},
    'StagesAvailable': [
        'Original'|'Processed',
    ]
}

Response Structure

  • (dict) –

    The output for GetTemplate action.

    • TemplateBody (dict) –

      Structure containing the template body.

      CloudFormation returns the same template that was used when the stack was created.

    • StagesAvailable (list) –

      The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

      • (string) –

Exceptions