[ aws . lookoutmetrics ]

update-anomaly-detector

Description

Updates a detector. After activation, you can only change a detector’s ingestion delay and description.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-anomaly-detector
--anomaly-detector-arn <value>
[--kms-key-arn <value>]
[--anomaly-detector-description <value>]
[--anomaly-detector-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--anomaly-detector-arn (string)

The ARN of the detector to update.

--kms-key-arn (string)

The Amazon Resource Name (ARN) of an AWS KMS encryption key.

--anomaly-detector-description (string)

The updated detector description.

--anomaly-detector-config (structure)

Contains information about the configuration to which the detector will be updated.

AnomalyDetectorFrequency -> (string)

The frequency at which the detector analyzes its source data.

Shorthand Syntax:

AnomalyDetectorFrequency=string

JSON Syntax:

{
  "AnomalyDetectorFrequency": "P1D"|"PT1H"|"PT10M"|"PT5M"
}

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

See ‘aws help’ for descriptions of global parameters.

Output

AnomalyDetectorArn -> (string)

The ARN of the updated detector.