Skip to content

List Monitors

forecastservice_list_monitors R Documentation

Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation

Description

Returns a list of monitors created with the create_monitor operation and create_auto_predictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the describe_monitor operation.

Usage

forecastservice_list_monitors(NextToken, MaxResults, Filters)

Arguments

NextToken

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

MaxResults

The maximum number of monitors to include in the response.

Filters

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT.

  • Key - The name of the parameter to filter on. The only valid value is Status.

  • Value - The value to match.

For example, to list all monitors who's status is ACTIVE, you would specify:

⁠"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]⁠

Value

A list with the following syntax: 

list(
  Monitors = list(
    list(
      MonitorArn = "string",
      MonitorName = "string",
      ResourceArn = "string",
      Status = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_monitors(
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Key = "string",
      Value = "string",
      Condition = "IS"|"IS_NOT"
    )
  )
)