Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . networkmonitor ]

get-probe¶

Description¶

Returns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

Synopsis¶

  get-probe
--monitor-name <value>
--probe-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--monitor-name (string)

The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.

--probe-id (string)

The ID of the probe to get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view probe details

The following get-probe example returns details about a probe with the probeID probe-12345 that's associated with a monitor named Example_NetworkMonitor.

aws networkmonitor get-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Output:

{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "ACTIVE",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:42:28.610000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

For more information, see How Amazon CloudWatch Network Monitor Works in the Amazon CloudWatch User Guide.

Output¶

probeId -> (string)

The ID of the probe for which details are returned.

probeArn -> (string)

The ARN of the probe.

sourceArn -> (string)

The ARN of the probe.

destination -> (string)

The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

destinationPort -> (integer)

The port associated with the destination . This is required only if the protocol is TCP and must be a number between 1 and 65536 .

protocol -> (string)

The protocol used for the network traffic between the source and destination . This must be either TCP or ICMP .

packetSize -> (integer)

The size of the packets sent between the source and destination. This must be a number between 56 and 8500 .

addressFamily -> (string)

Indicates whether the IP address is IPV4 or IPV6 .

vpcId -> (string)

The ID of the source VPC or subnet.

state -> (string)

The state of the probe.

createdAt -> (timestamp)

The time and date that the probe was created.

modifiedAt -> (timestamp)

The time and date that the probe was last modified.

tags -> (map)

The list of key-value pairs assigned to the probe.

key -> (string)

value -> (string)

Table Of Contents

Feedback

User Guide