Skip to content

CloudFormation  >  Operations  >  describe_generated_template

describe_generated_template

Operation

describe_generated_template async 

describe_generated_template(input: DescribeGeneratedTemplateInput, plugins: list[Plugin] | None = None) -> DescribeGeneratedTemplateOutput

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.

Parameters:

Name Type Description Default
input DescribeGeneratedTemplateInput

An instance of DescribeGeneratedTemplateInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeGeneratedTemplateOutput

An instance of DescribeGeneratedTemplateOutput.

Input

DescribeGeneratedTemplateInput dataclass

Bases: _SerdeShape

Dataclass for DescribeGeneratedTemplateInput structure.

Attributes

generated_template_name class-attribute instance-attribute 
generated_template_name: str | None = ...

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

Output

DescribeGeneratedTemplateOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeGeneratedTemplateOutput structure.

Attributes

creation_time class-attribute instance-attribute 
creation_time: datetime | None = ...

The time the generated template was created.

generated_template_id class-attribute instance-attribute 
generated_template_id: str | None = ...

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.

generated_template_name class-attribute instance-attribute 
generated_template_name: str | None = ...

The name of the generated template.

last_updated_time class-attribute instance-attribute 
last_updated_time: datetime | None = ...

The time the generated template was last updated.

progress class-attribute instance-attribute 
progress: TemplateProgress | None = ...

An object describing the progress of the template generation.

resources class-attribute instance-attribute 
resources: list[ResourceDetail] | None = ...

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stack_id class-attribute instance-attribute 
stack_id: str | None = ...

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

status class-attribute instance-attribute 
status: str | None = ...

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.

status_reason class-attribute instance-attribute 
status_reason: str | None = ...

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

template_configuration class-attribute instance-attribute 
template_configuration: TemplateConfiguration | None = ...

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

total_warnings class-attribute instance-attribute 
total_warnings: int | None = ...

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