CreateProbe
Create a probe within a monitor. Once you create a probe, and it begins monitoring your
network traffic, you'll incur billing charges for that probe. This action requires the
monitorName
parameter. Run ListMonitors
to get a list of
monitor names. Note the name of the monitorName
you want to create the
probe for.
Request Syntax
POST /monitors/monitorName
/probes HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"probe": {
"destination": "string
",
"destinationPort": number
,
"packetSize": number
,
"protocol": "string
",
"sourceArn": "string
",
"tags": {
"string
" : "string
"
}
},
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- monitorName
-
The name of the monitor to associated with the probe.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_-]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
Type: String
Required: No
- probe
-
Describes the details of an individual probe for a monitor.
Type: ProbeInput object
Required: Yes
-
The list of key-value pairs created and assigned to the probe.
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.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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"
}
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.
- addressFamily
-
Indicates whether the IP address is
IPV4
orIPV6
.Type: String
Valid Values:
IPV4 | IPV6
- createdAt
-
The time and date that the probe was created.
Type: Timestamp
- destination
-
The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- destinationPort
-
The port associated with the
destination
. This is required only if theprotocol
isTCP
and must be a number between1
and65536
.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65536.
- modifiedAt
-
The time and date when the probe was last modified.
Type: Timestamp
- packetSize
-
The size of the packets sent between the source and destination. This must be a number between
56
and8500
.Type: Integer
Valid Range: Minimum value of 56. Maximum value of 8500.
- probeArn
-
The ARN of the probe.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.*
- probeId
-
The ID of the probe for which details are returned.
Type: String
Pattern:
probe-[a-z0-9A-Z-]{21,64}
- protocol
-
The protocol used for the network traffic between the
source
anddestination
. This must be eitherTCP
orICMP
.Type: String
Valid Values:
TCP | ICMP
- sourceArn
-
The ARN of the probe.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.*
- state
-
The state of the probe.
Type: String
Valid Values:
PENDING | ACTIVE | INACTIVE | ERROR | DELETING | DELETED
-
The list of key-value pairs assigned to the probe.
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.
- vpcId
-
The ID of the source VPC or subnet.
Type: String
Pattern:
vpc-[a-zA-Z0-9]{8,32}
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
- ServiceQuotaExceededException
-
This request exceeds a service quota.
HTTP Status Code: 402
- 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: