CloudTrail / Client / list_dashboards

list_dashboards¶

CloudTrail.Client.list_dashboards(**kwargs)¶

Warning

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

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

Request Syntax

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

Parameters:

NamePrefix (string) – Specify a name prefix to filter on.
Type (string) – Specify a dashboard type to filter on: CUSTOM or MANAGED.
NextToken (string) – A token you can use to get the next page of dashboard results.
MaxResults (integer) – The maximum number of dashboards to display on a single page.

Return type:

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

CloudTrail.Client.exceptions.UnsupportedOperationException