get_generated_template¶
Operation¶
async
¶
get_generated_template(input: GetGeneratedTemplateInput, plugins: list[Plugin] | None = None) -> GetGeneratedTemplateOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetGeneratedTemplateInput
|
An instance of |
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 |
|---|---|
GetGeneratedTemplateOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetGeneratedTemplateInput structure.
Attributes¶
class-attribute
instance-attribute
¶
format: str | None = ...
The language to use to retrieve for the generated template. Supported values are:
-
JSON -
YAML
class-attribute
instance-attribute
¶
generated_template_name: str | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetGeneratedTemplateOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
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.
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.