:doc:`CloudTrail <../../cloudtrail>` / Client / list_dashboards

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



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

  

  Returns information about all dashboards in the account, in the current Region.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListDashboards>`_  


  **Request Syntax**
  ::

    response = client.list_dashboards(
        NamePrefix='string',
        Type='MANAGED'|'CUSTOM',
        NextToken='string',
        MaxResults=123
    )
    
  :type NamePrefix: string
  :param NamePrefix: 

    Specify a name prefix to filter on.

    

  
  :type Type: string
  :param Type: 

    Specify a dashboard type to filter on: ``CUSTOM`` or ``MANAGED``.

    

  
  :type NextToken: string
  :param NextToken: 

    A token you can use to get the next page of dashboard results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of dashboards to display on a single page.

    

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

    
    ::

      {
          'Dashboards': [
              {
                  'DashboardArn': 'string',
                  'Type': 'MANAGED'|'CUSTOM'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Dashboards** *(list) --* 

        Contains information about dashboards in the account, in the current Region that match the applied filters.

        
        

        - *(dict) --* 

          Provides information about a CloudTrail Lake dashboard.

          
          

          - **DashboardArn** *(string) --* 

            The ARN for the dashboard.

            
          

          - **Type** *(string) --* 

            The type of dashboard.

            
      
    
      

      - **NextToken** *(string) --* 

        A token you can use to get the next page of dashboard results.

        
  
  **Exceptions**
  
  *   :py:class:`CloudTrail.Client.exceptions.UnsupportedOperationException`

  