AWS CLI Command Reference

[ aws . networkmonitor ]

get-monitor

Description

Returns details about a specific monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

See also: AWS API Documentation

Synopsis

  get-monitor
--monitor-name <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--monitor-name (string)

The name of the monitor that details are returned for.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

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 get monitor information

The following get-monitor example gets information about a monitor named Example_NetworkMonitor.

aws networkmonitor get-monitor \
    --monitor-name Example_NetworkMonitor

Output:

{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "ACTIVE",
    "aggregationPeriod": 60,
    "tags": {},
    "probes": [],
    "createdAt": "2024-04-01T17:58:07.211000-04:00",
    "modifiedAt": "2024-04-01T17:58:07.211000-04:00"
}

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

Output

monitorArn -> (string)

The ARN of the selected monitor.

monitorName -> (string)

The name of the monitor.

state -> (string)

Lists the status of the state of each monitor.

aggregationPeriod -> (long)

The aggregation period for the specified monitor.

tags -> (map)

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

key -> (string)

value -> (string)

probes -> (list)

The details about each probe associated with that monitor.

(structure)

Describes information about a network monitor probe.

probeId -> (string)

The ID of the probe.

probeArn -> (string)

The ARN of the probe.

sourceArn -> (string)

The ARN of the probe source subnet.

destination -> (string)

The destination for the probe. This should be either an IPV4 or IPV6 .

destinationPort -> (integer)

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

protocol -> (string)

The network protocol for the destination. This can be either TCP or ICMP . If the protocol is TCP , then port is also required.

packetSize -> (integer)

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

addressFamily -> (string)

The IPv4 or IPv6 address for the probe.

vpcId -> (string)

The ID of the source VPC subnet.

state -> (string)

The state of the probe.

createdAt -> (timestamp)

The time and date the probe was created.

modifiedAt -> (timestamp)

The time and date that the probe was last modified.

tags -> (map)

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

key -> (string)

value -> (string)

createdAt -> (timestamp)

The time and date when the monitor was created.

modifiedAt -> (timestamp)

The time and date when the monitor was last modified.
© Copyright 2018, Amazon Web Services. Created using Sphinx.