:doc:`CloudFormation <../../cloudformation>` / Client / get_generated_template

**********************
get_generated_template
**********************



.. py:method:: CloudFormation.Client.get_generated_template(**kwargs)

  

  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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetGeneratedTemplate>`_  


  **Request Syntax**
  ::

    response = client.get_generated_template(
        Format='JSON'|'YAML',
        GeneratedTemplateName='string'
    )
    
  :type Format: string
  :param Format: 

    The language to use to retrieve for the generated template. Supported values are:

     

    
    * ``JSON``
     
    * ``YAML``
    

    

  
  :type GeneratedTemplateName: string
  :param GeneratedTemplateName: **[REQUIRED]** 

    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 ``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Status': 'CREATE_PENDING'|'UPDATE_PENDING'|'DELETE_PENDING'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'FAILED'|'COMPLETE',
          'TemplateBody': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Status** *(string) --* 

        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.
        

        
      

      - **TemplateBody** *(string) --* 

        The template body of the generated template, in the language specified by the ``Language`` parameter.

        
  
  **Exceptions**
  
  *   :py:class:`CloudFormation.Client.exceptions.GeneratedTemplateNotFoundException`

  