Skip to content

describe_generated_template

describe_generated_template(
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    generated_template_name: Optional[GeneratedTemplateName] = 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:

Raises:

Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
def describe_generated_template(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    generated_template_name: Optional[
        "capo_cloudformation.types.generated_template_name.GeneratedTemplateName"
    ] = None,
) -> "capo_cloudformation.types.describe_generated_template_output.DescribeGeneratedTemplateOutput":
    """<p>Describes a generated template. The output includes details about the progress of the creation of a generated template started by a <code>CreateGeneratedTemplate</code> API action or the update of a generated template started with an <code>UpdateGeneratedTemplate</code> API action.</p>

    Args:
        generated_template_name: <p>The name or Amazon Resource Name (ARN) of a generated template.</p>

    Raises:
        capo_cloudformation.errors.generated_template_not_found_exception.GeneratedTemplateNotFoundException: <p>The generated template was not found.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.describe_generated_template_input.DescribeGeneratedTemplateInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_generated_template_output.DescribeGeneratedTemplateOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_generated_template

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.describe_generated_template.describe_generated_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeGeneratedTemplate")
    )
    input_: capo_cloudformation.types.describe_generated_template_input.DescribeGeneratedTemplateInput = {}
    if generated_template_name is not None:
        input_["generated_template_name"] = generated_template_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output