:doc:`QuickSight <../../quicksight>` / Client / describe_template_definition

****************************
describe_template_definition
****************************



.. py:method:: QuickSight.Client.describe_template_definition(**kwargs)

  

  Provides a detailed description of the definition of a template.

   

  .. note::

    

    If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the `DescribeTemplate <https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html>`__ instead.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateDefinition>`_  


  **Request Syntax**
  ::

    response = client.describe_template_definition(
        AwsAccountId='string',
        TemplateId='string',
        VersionNumber=123,
        AliasName='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

    

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

    The ID of the template that you're describing.

    

  
  :type VersionNumber: integer
  :param VersionNumber: 

    The version number of the template.

    

  
  :type AliasName: string
  :param AliasName: 

    The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword ``$LATEST`` in the ``AliasName`` parameter. The keyword ``$PUBLISHED`` doesn't apply to templates.

    

  
  
  :rtype: dict
  :returns: 
    

    **Response Syntax**
    ::

        # This section is too large to render.
        # Please see the AWS API Documentation linked below.

    `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateDefinition>`_


    

    **Response Structure**
    ::

        # This section is too large to render.
        # Please see the AWS API Documentation linked below.

    `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateDefinition>`_


    
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceExistsException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.ConflictException`

  
  *   :py:class:`QuickSight.Client.exceptions.UnsupportedUserEditionException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  