Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDashboards

Returns a list of all dashboards in your account.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

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

The request accepts the following data in JSON format.

maxResults

The maximum number of results to return in a single call. The default value is 20.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The token for the next page of results. Use the value returned in the previous response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "dashboards": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "name": "string",
         "type": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

dashboards

An array of dashboard references, containing basic information about each dashboard.

Type: Array of DashboardReference objects

nextToken

The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: [\S\s]*

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.

HTTP Status Code: 400

InternalServerException

An internal error occurred while processing the request. Retry your request. If the problem persists, contact AWS Support.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.

HTTP Status Code: 400

ValidationException

The input parameters do not satisfy the requirements. Check the error message for specific validation details.

HTTP Status Code: 400