describe_template_definition

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

See also: AWS API Documentation

Request Syntax

response = client.describe_template_definition(
    AwsAccountId='string',
    TemplateId='string',
    VersionNumber=123,
    AliasName='string'
)

Parameters

• AwsAccountId (string) --

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

• TemplateId (string) --

  [REQUIRED]

  The ID of the template that you're describing.

• VersionNumber (integer) -- The version number of the template.
• AliasName (string) -- 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.

Return type

dict

Returns

Response Syntax

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

AWS API Documentation

Response Structure

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

AWS API Documentation

Exceptions

• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.ResourceExistsException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.ConflictException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.InternalFailureException