Skip to content

DescribeGeneratedTemplateOutput

Source code in docs_src/capo_cloudformation/types/describe_generated_template_output.py
class DescribeGeneratedTemplateOutput(TypedDict, closed=True):
    generated_template_id: NotRequired[
        "capo_cloudformation.types.generated_template_id.GeneratedTemplateId"
    ]
    """<p>The Amazon Resource Name (ARN) of the generated template. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}</code>. For example, <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i> </code>.</p>"""
    generated_template_name: NotRequired[
        "capo_cloudformation.types.generated_template_name.GeneratedTemplateName"
    ]
    """<p>The name of the generated template.</p>"""
    resources: NotRequired["capo_cloudformation.types.resource_details.ResourceDetails"]
    """<p>A list of objects describing the details of the resources in the template generation.</p>"""
    status: NotRequired[
        "capo_cloudformation.types.generated_template_status.GeneratedTemplateStatus"
    ]
    """<p>The status of the template generation. Supported values are:</p> <ul> <li> <p> <code>CreatePending</code> - the creation of the template is pending.</p> </li> <li> <p> <code>CreateInProgress</code> - the creation of the template is in progress.</p> </li> <li> <p> <code>DeletePending</code> - the deletion of the template is pending.</p> </li> <li> <p> <code>DeleteInProgress</code> - the deletion of the template is in progress.</p> </li> <li> <p> <code>UpdatePending</code> - the update of the template is pending.</p> </li> <li> <p> <code>UpdateInProgress</code> - the update of the template is in progress.</p> </li> <li> <p> <code>Failed</code> - the template operation failed.</p> </li> <li> <p> <code>Complete</code> - the template operation is complete.</p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_cloudformation.types.template_status_reason.TemplateStatusReason"
    ]
    """<p>The reason for the current template generation status. This will provide more details if a failure happened.</p>"""
    creation_time: NotRequired["capo_cloudformation.types.creation_time.CreationTime"]
    """<p>The time the generated template was created.</p>"""
    last_updated_time: NotRequired[
        "capo_cloudformation.types.last_updated_time.LastUpdatedTime"
    ]
    """<p>The time the generated template was last updated.</p>"""
    progress: NotRequired[
        "capo_cloudformation.types.template_progress.TemplateProgress"
    ]
    """<p>An object describing the progress of the template generation.</p>"""
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The stack ARN of the base stack if a base stack was provided when generating the template.</p>"""
    template_configuration: NotRequired[
        "capo_cloudformation.types.template_configuration.TemplateConfiguration"
    ]
    """<p>The configuration details of the generated template, including the <code>DeletionPolicy</code> and <code>UpdateReplacePolicy</code>.</p>"""
    total_warnings: NotRequired[
        "capo_cloudformation.types.total_warnings.TotalWarnings"
    ]
    """<p>The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.</p>"""

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The time the generated template was created.

generated_template_id instance-attribute

generated_template_id: NotRequired[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 .

generated_template_name instance-attribute

generated_template_name: NotRequired[GeneratedTemplateName]

The name of the generated template.

last_updated_time instance-attribute

last_updated_time: NotRequired[LastUpdatedTime]

The time the generated template was last updated.

progress instance-attribute

progress: NotRequired[TemplateProgress]

An object describing the progress of the template generation.

resources instance-attribute

resources: NotRequired[ResourceDetails]

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

stack_id instance-attribute

stack_id: NotRequired[StackId]

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

status instance-attribute

status: NotRequired[GeneratedTemplateStatus]

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 instance-attribute

status_reason: NotRequired[TemplateStatusReason]

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

template_configuration instance-attribute

template_configuration: NotRequired[TemplateConfiguration]

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

total_warnings instance-attribute

total_warnings: NotRequired[TotalWarnings]

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