QuickSight / Paginator / ListThemes

ListThemes

class QuickSight.Paginator.ListThemes

paginator = client.get_paginator('list_themes')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    Type='QUICKSIGHT'|'CUSTOM'|'ALL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• Type (string) –

  The type of themes that you want to list. Valid options include the following:

  • ALL (default)- Display all existing themes.

  • CUSTOM - Display only the themes created by people using Amazon QuickSight.

  • QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

• 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

{
    'ThemeSummaryList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ThemeId': 'string',
            'LatestVersionNumber': 123,
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • ThemeSummaryList (list) –

    Information about the themes in the list.

    • (dict) –

      The theme summary.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • Name (string) –

        the display name for the theme.

      • ThemeId (string) –

        The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      • LatestVersionNumber (integer) –

        The latest version number for the theme.

      • CreatedTime (datetime) –

        The date and time that this theme was created.

      • LastUpdatedTime (datetime) –

        The last date and time that this theme was updated.

  • Status (integer) –

    The HTTP status of the request.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.