ListMonitors
List all monitors in an account. Optionally, you can list only monitors that have a specific status, by
using the STATUS parameter.
Request Syntax
GET /monitors?maxResults=maxResults&monitorStatus=monitorStatus&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The number of query results that you want to return with this call.
Valid Range: Minimum value of 1. Maximum value of 25.
- monitorStatus
-
The status of a monitor. The status can be one of the following
-
PENDING: The monitor is in the process of being created. -
ACTIVE: The monitor is active. -
INACTIVE: The monitor is inactive. -
ERROR: Monitor creation failed due to an error. -
DELETING: The monitor is in the process of being deleted.
Valid Values:
PENDING | ACTIVE | INACTIVE | ERROR | DELETING -
- 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",
"monitorStatus": "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
-
The monitors that are in an account.
Type: Array of MonitorSummary 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
