:doc:`BillingandCostManagementDashboards <../../bcm-dashboards>` / Client / list_dashboards

***************
list_dashboards
***************



.. py:method:: BillingandCostManagementDashboards.Client.list_dashboards(**kwargs)

  

  Returns a list of all dashboards in your account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bcm-dashboards-2025-08-18/ListDashboards>`_  


  **Request Syntax**
  ::

    response = client.list_dashboards(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in a single call. The default value is 20.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next page of results. Use the value returned in the previous response.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'dashboards': [
              {
                  'arn': 'string',
                  'name': 'string',
                  'description': 'string',
                  'type': 'CUSTOM',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedAt': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **dashboards** *(list) --* 

        An array of dashboard references, containing basic information about each dashboard.

        
        

        - *(dict) --* 

          Contains basic information about a dashboard, including its ARN, name, type, and timestamps.

          
          

          - **arn** *(string) --* 

            The ARN of the referenced dashboard.

            
          

          - **name** *(string) --* 

            The name of the referenced dashboard.

            
          

          - **description** *(string) --* 

            The description of the referenced dashboard.

            
          

          - **type** *(string) --* 

            The dashboard type.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp when the dashboard was created.

            
          

          - **updatedAt** *(datetime) --* 

            The timestamp when the dashboard was last modified.

            
      
    
      

      - **nextToken** *(string) --* 

        The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.

        
  
  **Exceptions**
  
  *   :py:class:`BillingandCostManagementDashboards.Client.exceptions.ThrottlingException`

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

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

  
  *   :py:class:`BillingandCostManagementDashboards.Client.exceptions.ValidationException`

  