ListMonitors
Returns a list of all of your monitors.
Request Syntax
GET /monitors?maxResults=maxResults
&nextToken=nextToken
&state=state
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.If
MaxResults
is given a value larger than 100, only 100 results are returned.Valid Range: Minimum value of 1. Maximum value of 25.
- nextToken
-
The token for the next page of results.
Length Constraints: Minimum length of 0. Maximum length of 4096.
- state
-
The list of all monitors and their states.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"monitors": [
{
"aggregationPeriod": number,
"monitorArn": "string",
"monitorName": "string",
"state": "string",
"tags": {
"string" : "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
-
Lists individual details about each of your monitors.
Type: Array of MonitorSummary objects
- nextToken
-
The token for the next page of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling
HTTP Status Code: 429
- ValidationException
-
One of the parameters for the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: