QuickSight / Client / list_template_aliases

list_template_aliases#

QuickSight.Client.list_template_aliases(**kwargs)#

Lists all the aliases of a template.

See also: AWS API Documentation

Request Syntax

response = client.list_template_aliases(
    AwsAccountId='string',
    TemplateId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the template aliases that you’re listing.

  • TemplateId (string) –

    [REQUIRED]

    The ID for the template.

  • NextToken (string) – The token for the next set of results, or null if there are no more results.

  • MaxResults (integer) – The maximum number of results to be returned per request.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateAliasList': [
        {
            'AliasName': 'string',
            'Arn': 'string',
            'TemplateVersionNumber': 123
        },
    ],
    'Status': 123,
    'RequestId': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TemplateAliasList (list) –

      A structure containing the list of the template’s aliases.

      • (dict) –

        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.

    • NextToken (string) –

      The token for the next set of results, or null if there are no more results.

Exceptions

  • QuickSight.Client.exceptions.InvalidNextTokenException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException