AWS CLI Command Reference

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

update-monitor

Description

Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide .

See also: AWS API Documentation

Synopsis

  update-monitor
--monitor-name <value>
[--resources-to-add <value>]
[--resources-to-remove <value>]
[--status <value>]
[--client-token <value>]
[--max-city-networks-to-monitor <value>]
[--internet-measurements-log-delivery <value>]
[--traffic-percentage-to-monitor <value>]
[--health-events-config <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.

--resources-to-add (list)

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

Note

If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

(string)

Syntax:

"string" "string" ...

--resources-to-remove (list)

The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

(string)

Syntax:

"string" "string" ...

--status (string)

The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE . The following values are not accepted: PENDING , and ERROR .

Possible values:

  • PENDING
  • ACTIVE
  • INACTIVE
  • ERROR

--client-token (string)

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.

--max-city-networks-to-monitor (integer)

The maximum number of city-networks to monitor for your application. 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. Setting this limit can help control billing costs.

--internet-measurements-log-delivery (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.

Shorthand Syntax:

S3Config={BucketName=string,BucketPrefix=string,LogDeliveryStatus=string}

JSON Syntax:

{
  "S3Config": {
    "BucketName": "string",
    "BucketPrefix": "string",
    "LogDeliveryStatus": "ENABLED"|"DISABLED"
  }
}

--traffic-percentage-to-monitor (integer)

The percentage of the internet-facing traffic for your application that you want 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 .

--health-events-config (structure)

The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines 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%.

Shorthand Syntax:

AvailabilityScoreThreshold=double,PerformanceScoreThreshold=double,AvailabilityLocalHealthEventsConfig={Status=string,HealthScoreThreshold=double,MinTrafficImpact=double},PerformanceLocalHealthEventsConfig={Status=string,HealthScoreThreshold=double,MinTrafficImpact=double}

JSON Syntax:

{
  "AvailabilityScoreThreshold": double,
  "PerformanceScoreThreshold": double,
  "AvailabilityLocalHealthEventsConfig": {
    "Status": "ENABLED"|"DISABLED",
    "HealthScoreThreshold": double,
    "MinTrafficImpact": double
  },
  "PerformanceLocalHealthEventsConfig": {
    "Status": "ENABLED"|"DISABLED",
    "HealthScoreThreshold": double,
    "MinTrafficImpact": double
  }
}

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

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

Output

MonitorArn -> (string)

The Amazon Resource Name (ARN) of the monitor.

Status -> (string)

The status of a monitor.