ListMonitors
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor 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 DescribeMonitor operation.
Request Syntax
{
"Filters": [
{
"Condition": "string
",
"Key": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- Filters
-
An array of filters. For each filter, provide a condition and a match statement. The condition is either
IS
orIS_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 areIS
andIS_NOT
. -
Key
- The name of the parameter to filter on. The only valid value isStatus
. -
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" } ]
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The maximum number of monitors to include in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.+
Required: No
Response Syntax
{
"Monitors": [
{
"CreationTime": number,
"LastModificationTime": number,
"MonitorArn": "string",
"MonitorName": "string",
"ResourceArn": "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
-
An array of objects that summarize each monitor's properties.
Type: Array of MonitorSummary objects
- NextToken
-
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.+
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- InvalidNextTokenException
-
The token is not valid. Tokens expire after 24 hours.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: