DescribeGeneratedTemplate - AWS CloudFormation

DescribeGeneratedTemplate

Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

GeneratedTemplateName

The name or Amazon Resource Name (ARN) of a generated template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Elements

The following elements are returned by the service.

CreationTime

The time the generated template was created.

Type: Timestamp

GeneratedTemplateId

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 .

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

GeneratedTemplateName

The name of the generated template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

LastUpdatedTime

The time the generated template was last updated.

Type: Timestamp

Progress

An object describing the progress of the template generation.

Type: TemplateProgress object

Resources.member.N

A list of objects describing the details of the resources in the template generation.

Type: Array of ResourceDetail objects

Array Members: Minimum number of 1 item. Maximum number of 500 items.

StackId

The stack ARN of the base stack if a base stack was provided when generating the template.

Type: String

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

StatusReason

The reason for the current template generation status. This will provide more details if a failure happened.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

TemplateConfiguration

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

Type: TemplateConfiguration object

TotalWarnings

The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

Type: Integer

Valid Range: Minimum value of 0.

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: