QuickSight / Client / list_brands

list_brands#

QuickSight.Client.list_brands(**kwargs)#

Lists all brands in an Amazon QuickSight account.

See also: AWS API Documentation

Request Syntax

response = client.list_brands(
    AwsAccountId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that owns the brands that you want to list.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Brands': [
        {
            'Arn': 'string',
            'BrandId': 'string',
            'BrandName': 'string',
            'Description': 'string',
            'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • Brands (list) –

      A list of all brands in your Amazon Web Services account. This structure provides basic information about each brand.

      • (dict) –

        A summary of the brand.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the brand.

        • BrandId (string) –

          The ID of the Amazon QuickSight brand.

        • BrandName (string) –

          The name of the brand.

        • Description (string) –

          The description of the brand.

        • BrandStatus (string) –

          The status of the brand.

        • CreatedTime (datetime) –

          The time that the brand was created.

        • LastUpdatedTime (datetime) –

          The time when the brand was last updated.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidRequestException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InternalServerException