Menu
Amazon CloudWatch
API Reference (API Version 2010-08-01)

ListDashboards

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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 "_".

Type: String

Required: No

NextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

Response Elements

The following elements are returned by the service.

DashboardEntries.member.N

The list of matching dashboards.

Type: Array of DashboardEntry objects

NextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

Request processing has failed due to some unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParameterValue

The value of an input parameter is bad or out-of-range.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: