QuickSight / Client / list_themes

list_themes#

QuickSight.Client.list_themes(**kwargs)#

Lists all the themes in the current Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_themes(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Type='QUICKSIGHT'|'CUSTOM'|'ALL'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

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

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

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)
        },
    ],
    'NextToken': 'string',
    '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.

    • NextToken (string) –

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

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.InvalidNextTokenException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException