Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListDashboardsCommand

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.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

example

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchClient, ListDashboardsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
// const { CloudWatchClient, ListDashboardsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
const client = new CloudWatchClient(config);
const command = new ListDashboardsCommand(input);
const response = await client.send(command);
see

ListDashboardsCommandInput for command's input shape.

see

ListDashboardsCommandOutput for command's response shape.

see

config for CloudWatchClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: ListDashboardsCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<ListDashboardsCommandInput, ListDashboardsCommandOutput>