ListAppMonitorsCommand

Suggest an Edit

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

Example Syntax

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

import { RUMClient, ListAppMonitorsCommand } from "@aws-sdk/client-rum"; // ES Modules import
// const { RUMClient, ListAppMonitorsCommand } = require("@aws-sdk/client-rum"); // CommonJS import
const client = new RUMClient(config);
const input = { // ListAppMonitorsRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListAppMonitorsCommand(input);
const response = await client.send(command);
// { // ListAppMonitorsResponse
//   NextToken: "STRING_VALUE",
//   AppMonitorSummaries: [ // AppMonitorSummaryList
//     { // AppMonitorSummary
//       Name: "STRING_VALUE",
//       Id: "STRING_VALUE",
//       Created: "STRING_VALUE",
//       LastModified: "STRING_VALUE",
//       State: "STRING_VALUE",
//     },
//   ],
// };

ListAppMonitorsCommand Input

See ListAppMonitorsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

NextToken
string | undefined

Use the token returned by the previous operation to request the next page of results.

ListAppMonitorsCommand Output

See ListAppMonitorsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AppMonitorSummaries
AppMonitorSummary[] | undefined

An array of structures that contain information about the returned app monitors.

NextToken
string | undefined

A token that you can use in a subsequent operation to retrieve the next set of results.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient permissions to perform this action.

InternalServerException
server

Internal service exception.

ThrottlingException
client

The request was throttled because of quota limits.

ValidationException
client

One of the arguments for the request is not valid.

RUMServiceException
Base exception class for all service exceptions from RUM service.