Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDashboards

Important

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Returns information about all dashboards in the account, in the current Region.

Request Syntax


{
   "MaxResults": number,
   "NamePrefix": "string",
   "NextToken": "string",
   "Type": "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 dashboards to display on a single page.

Type: Integer

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

Required: No

NamePrefix

Specify a name prefix to filter on.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-]+$

Required: No

NextToken

A token you can use to get the next page of dashboard results.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1000.

Pattern: .*

Required: No

Type

Specify a dashboard type to filter on: CUSTOM or MANAGED.

Type: String

Valid Values: MANAGED | CUSTOM

Required: No

Response Syntax


{
   "Dashboards": [ 
      { 
         "DashboardArn": "string",
         "Type": "string"
      }
   ],
   "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

Contains information about dashboards in the account, in the current Region that match the applied filters.

Type: Array of DashboardDetail objects

NextToken

A token you can use to get the next page of dashboard results.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1000.

Pattern: .*

Errors

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

UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

HTTP Status Code: 400