Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMonitors

Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

Request Syntax


GET /v20210603/Monitors?IncludeLinkedAccounts=IncludeLinkedAccounts&MaxResults=MaxResults&MonitorStatus=MonitorStatus&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

IncludeLinkedAccounts

A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

MaxResults

The number of monitor objects that you want to return with this call.

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

MonitorStatus

The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.

For information about the statuses for a monitor, see Monitor.

NextToken

The token for the next set of results. You receive this token from a previous call.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Monitors": [ 
      { 
         "MonitorArn": "string",
         "MonitorName": "string",
         "ProcessingStatus": "string",
         "Status": "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.

Monitors

A list of monitors.

Type: Array of Monitor objects

NextToken

The token for the next set of results. You receive this token from a previous call.

Type: String

Errors

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

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

Invalid request.

HTTP Status Code: 400