GetTemplateSummary
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
or
stack set.
You can use the GetTemplateSummary
action when you submit a template, or
you can get template information for a stack set, or 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 Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- 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
,StackSetName
,TemplateBody
, orTemplateURL
.Type: String
Length Constraints: Minimum length of 1.
Pattern:
([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
Required: No
- StackSetName
-
The name or unique ID of the stack set from which the stack was created.
Conditional: You must specify only one of the following parameters:
StackName
,StackSetName
,TemplateBody
, orTemplateURL
.Type: String
Pattern:
[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?
Required: No
- 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
,StackSetName
,TemplateBody
, orTemplateURL
.Type: String
Length Constraints: Minimum length of 1.
Required: No
- TemplateURL
-
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is 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
,StackSetName
,TemplateBody
, orTemplateURL
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response Elements
The following elements are returned by the service.
- Capabilities.member.N
-
The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Type: Array of strings
Valid Values:
CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND
- CapabilitiesReason
-
The list of resources that generated the values in the
Capabilities
response element.Type: String
- DeclaredTransforms.member.N
-
A list of the transforms that are declared in the template.
Type: Array of strings
- Description
-
The value that is defined in the
Description
property of the template.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- Metadata
-
The value that is defined for the
Metadata
property of the template.Type: String
- Parameters.member.N
-
A list of parameter declarations that describe various properties for each parameter.
Type: Array of ParameterDeclaration objects
- ResourceIdentifierSummaries.member.N
-
A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example,
BucketName
is a possible identifier property for anAWS::S3::Bucket
resource.Type: Array of ResourceIdentifierSummary objects
- ResourceTypes.member.N
-
A list of all the template resource types that are defined in the template, such as
AWS::EC2::Instance
,AWS::Dynamo::Table
, andCustom::MyCustomInstance
.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 256.
- Version
-
The AWS template format version, which identifies the capabilities of the template.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- StackSetNotFound
-
The specified stack set doesn't exist.
HTTP Status Code: 404
Examples
GetTemplateSummary
This example illustrates one usage of GetTemplateSummary.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=GetTemplateSummary
&TemplateURL=https%3A%2F%2Fs3-us-east-1.amazonaws.com%2Fsamplebucketname%2Fsampletemplate.template
&Version=2010-05-15
&SignatureVersion=2
&Timestamp=2010-07-27T22%3A26%3A28.000Z
&AWSAccessKeyId=[AWS Access KeyID]
&Signature=[Signature]
Sample Response
<GetTemplateSummaryResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<GetTemplateSummaryResult>
<Description>A sample template description.</Description>
<Parameters>
<member>
<NoEcho>false</NoEcho>
<ParameterKey>KeyName</ParameterKey>
<Description>Name of an existing EC2 KeyPair to enable SSH access to the instance</Description>
<ParameterType>AWS::EC2::KeyPair::KeyName</ParameterType>
</member>
</Parameters>
<Metadata>{"Instances":{"SampleDescription":"Information about the instances"}}</Metadata>
<Version>2010-09-09</Version>
</GetTemplateSummaryResult>
<ResponseMetadata>
<RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
</ResponseMetadata>
</GetTemplateSummaryResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: