Returns a list of the dashboards for your account¶

Description¶

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.

list_dashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call list_dashboards 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, list_dashboards 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 list_dashboards in any other enabled Region, or retry after propagation completes.

Usage¶

cloudwatch_list_dashboards(DashboardNamePrefix, NextToken)

Arguments¶

• DashboardNamePrefix

  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

  The token returned by a previous call to indicate that there is more data available.

Value¶

A list with the following syntax:

list(
  DashboardEntries = list(
    list(
      DashboardName = "string",
      DashboardArn = "string",
      LastModified = as.POSIXct(
        "2015-01-01"
      ),
      Size = 123
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_dashboards(
  DashboardNamePrefix = "string",
  NextToken = "string"
)