QuickSight / Paginator / ListBrands

ListBrands

class QuickSight.Paginator.ListBrands

paginator = client.get_paginator('list_brands')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• 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

{
    '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) –

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