CloudTrail / Client / list_dashboards

list_dashboards#

CloudTrail.Client.list_dashboards(**kwargs)#

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

See also: AWS API Documentation

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