Skip to content

List Monitors

cloudwatchinternetmonitor_list_monitors R Documentation

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

Description

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.

Usage

cloudwatchinternetmonitor_list_monitors(NextToken, MaxResults,
  MonitorStatus, IncludeLinkedAccounts)

Arguments

NextToken

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

MaxResults

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

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.

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.

Value

A list with the following syntax: 

list(
  Monitors = list(
    list(
      MonitorName = "string",
      MonitorArn = "string",
      Status = "PENDING"|"ACTIVE"|"INACTIVE"|"ERROR",
      ProcessingStatus = "OK"|"INACTIVE"|"COLLECTING_DATA"|"INSUFFICIENT_DATA"|"FAULT_SERVICE"|"FAULT_ACCESS_CLOUDWATCH"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_monitors(
  NextToken = "string",
  MaxResults = 123,
  MonitorStatus = "string",
  IncludeLinkedAccounts = TRUE|FALSE
)