cloudwatch_list_dashboards: Returns a list of the dashboards for your account

Description Usage Arguments Value Request syntax

View source: R/cloudwatch_operations.R

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.

Usage

1
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  DashboardEntries = list(
    list(
      DashboardName = "string",
      DashboardArn = "string",
      LastModified = as.POSIXct(
        "2015-01-01"
      ),
      Size = 123
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
svc$list_dashboards(
  DashboardNamePrefix = "string",
  NextToken = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.