[ aws . internetmonitor ]

get-monitor

Description

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

See also: AWS API Documentation

Synopsis

  get-monitor
--monitor-name <value>
[--linked-account-id <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.

--linked-account-id (string)

TBD

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

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

Output

MonitorName -> (string)

The name of the monitor.

MonitorArn -> (string)

The Amazon Resource Name (ARN) of the monitor.

Resources -> (list)

The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

(string)

Status -> (string)

The status of the monitor.

CreatedAt -> (timestamp)

The time when the monitor was created.

ModifiedAt -> (timestamp)

The last time that the monitor was modified.

ProcessingStatus -> (string)

The health of the data processing for the monitor.

ProcessingStatusInfo -> (string)

Additional information about the health of the data processing for the monitor.

Tags -> (map)

The tags that have been added to monitor.

key -> (string)

value -> (string)

MaxCityNetworksToMonitor -> (integer)

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide .

InternetMeasurementsLogDelivery -> (structure)

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

S3Config -> (structure)

The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED , depending on whether you choose to deliver internet measurements to S3 logs.

BucketName -> (string)

The Amazon S3 bucket name.

BucketPrefix -> (string)

The Amazon S3 bucket prefix.

LogDeliveryStatus -> (string)

The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

TrafficPercentageToMonitor -> (integer)

The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide .

HealthEventsConfig -> (structure)

The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there’s an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide .

AvailabilityScoreThreshold -> (double)

The health event threshold percentage set for availability scores.

PerformanceScoreThreshold -> (double)

The health event threshold percentage set for performance scores.

AvailabilityLocalHealthEventsConfig -> (structure)

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

Status -> (string)

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .

HealthScoreThreshold -> (double)

The health event threshold percentage set for a local health score.

MinTrafficImpact -> (double)

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don’t set a minimum traffic impact threshold, the default value is 0.1%.

PerformanceLocalHealthEventsConfig -> (structure)

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

Status -> (string)

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .

HealthScoreThreshold -> (double)

The health event threshold percentage set for a local health score.

MinTrafficImpact -> (double)

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don’t set a minimum traffic impact threshold, the default value is 0.1%.