describe_template_alias

QuickSight.Client.describe_template_alias(**kwargs)

Describes the template alias for a template.

See also: AWS API Documentation

Request Syntax

response = client.describe_template_alias(
    AwsAccountId='string',
    TemplateId='string',
    AliasName='string'
)

Parameters

• AwsAccountId (string) --

  [REQUIRED]

  The ID of the Amazon Web Services account that contains the template alias that you're describing.

• TemplateId (string) --

  [REQUIRED]

  The ID for the template.

• AliasName (string) --

  [REQUIRED]

  The name of the template alias 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

{
    'TemplateAlias': {
        'AliasName': 'string',
        'Arn': 'string',
        'TemplateVersionNumber': 123
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) --

  • TemplateAlias (dict) --

    Information about the template alias.

    • AliasName (string) --

      The display name of the template alias.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the template alias.

    • TemplateVersionNumber (integer) --

      The version number of the template alias.

  • Status (integer) --

    The HTTP status of the request.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.InternalFailureException