Returns details about a specific monitor.
This action requires the monitorName parameter. Run
ListMonitors to get a list of monitor names.
Request Syntax
GET /monitors/monitorName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- monitorName
-
The name of the monitor that details are returned for.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"aggregationPeriod": number,
"createdAt": number,
"modifiedAt": number,
"monitorArn": "string",
"monitorName": "string",
"probes": [
{
"addressFamily": "string",
"createdAt": number,
"destination": "string",
"destinationPort": number,
"modifiedAt": number,
"packetSize": number,
"probeArn": "string",
"probeId": "string",
"protocol": "string",
"sourceArn": "string",
"state": "string",
"tags": {
"string" : "string"
},
"vpcId": "string"
}
],
"state": "string",
"tags": {
"string" : "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.
- aggregationPeriod
-
The aggregation period for the specified monitor.
Type: Long
Valid Range: Minimum value of 30.
- createdAt
-
The time and date when the monitor was created.
Type: Timestamp
- modifiedAt
-
The time and date when the monitor was last modified.
Type: Timestamp
- monitorArn
-
The ARN of the selected monitor.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 512.
Pattern:
arn:.* - monitorName
-
The name of the monitor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9_-]+ - probes
-
The details about each probe associated with that monitor.
Type: Array of Probe objects
- state
-
Lists the status of the
stateof each monitor.Type: String
Valid Values:
PENDING | ACTIVE | INACTIVE | ERROR | DELETING -
The list of key-value pairs assigned to the monitor.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
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
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- 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:
