GetGeneratedTemplate
Retrieves a generated template. If the template is in an InProgress or
Pending status then the template returned will be the template when the
template was last in a Complete status. If the template has not yet been in a
Complete status then an empty template will be returned.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Format
-
The language to use to retrieve for the generated template. Supported values are:
-
JSON -
YAML
Type: String
Valid Values:
JSON | YAMLRequired: No
-
- GeneratedTemplateName
-
The name or 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Response Elements
The following elements are returned by the service.
- Status
-
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.
Type: String
Valid Values:
CREATE_PENDING | UPDATE_PENDING | DELETE_PENDING | CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | FAILED | COMPLETE -
- TemplateBody
-
The template body of the generated template, in the language specified by the
Languageparameter.Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- GeneratedTemplateNotFound
-
The generated template was not found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
