QuickSight / Paginator / ListTemplateAliases

ListTemplateAliases#

class QuickSight.Paginator.ListTemplateAliases#
paginator = client.get_paginator('list_template_aliases')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from QuickSight.Client.list_template_aliases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    TemplateId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateAliasList': [
        {
            'AliasName': 'string',
            'Arn': 'string',
            'TemplateVersionNumber': 123
        },
    ],
    'Status': 123,
    'RequestId': '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.