:doc:`QuickSight <../../quicksight>` / Client / list_brands

***********
list_brands
***********



.. py:method:: QuickSight.Client.list_brands(**kwargs)

  

  Lists all brands in an Quick Sight account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListBrands>`_  


  **Request Syntax**
  ::

    response = client.list_brands(
        AwsAccountId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to be returned in a single request.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: 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 Quick Suite 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**
  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalServerException`

  