CloudWatch / Client / list_dashboards

list_dashboards

CloudWatch.Client.list_dashboards(**kwargs)

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

You might have recently enabled an opt-in Region (Region that is disabled by default) for your account. In that Region, ListDashboards can return an access denied error for up to 24 hours after you enable the Region. This delay occurs while dashboard data propagates. The error does not indicate a problem with your permissions. Because dashboards are global, you can call ListDashboards in any other enabled Region, or retry after propagation completes.

See also: AWS API Documentation

Request Syntax

response = client.list_dashboards(
    DashboardNamePrefix='string',
    NextToken='string'
)
Parameters:

  • DashboardNamePrefix (string) – If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, “.”, “-”, and “_”.

  • NextToken (string) – The token returned by a previous call to indicate that there is more data available.

Return type:

dict

Returns:

Response Syntax

{
    'DashboardEntries': [
        {
            'DashboardName': 'string',
            'DashboardArn': 'string',
            'LastModified': datetime(2015, 1, 1),
            'Size': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DashboardEntries (list) –

      The list of matching dashboards.

      • (dict) –

        Represents a specific dashboard.

        • DashboardName (string) –

          The name of the dashboard.

        • DashboardArn (string) –

          The Amazon Resource Name (ARN) of the dashboard.

        • LastModified (datetime) –

          The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

        • Size (integer) –

          The size of the dashboard, in bytes.

    • NextToken (string) –

      The token that marks the start of the next batch of returned results.

Exceptions