create-anomaly-detector¶

Description¶

Creates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis. The anomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns and behaviors.

Synopsis¶

  create-anomaly-detector
--workspace-id <value>
--alias <value>
[--evaluation-interval-in-seconds <value>]
[--missing-data-action <value>]
--configuration <value>
[--labels <value>]
[--client-token <value>]
[--tags <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¶

--workspace-id (string) [required]

The identifier of the workspace where the anomaly detector will be created.

Constraints:

min: 1

max: 64

pattern: .*[0-9A-Za-z][-.0-9A-Z_a-z]*.*

--alias (string) [required]

A user-friendly name for the anomaly detector.

Constraints:

min: 1

max: 64

pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*

--evaluation-interval-in-seconds (integer)

The frequency, in seconds, at which the anomaly detector evaluates metrics. The default value is 60 seconds.

Constraints:

min: 30

max: 86400

--missing-data-action (tagged union structure)

Specifies the action to take when data is missing during evaluation.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: markAsAnomaly, skip.

markAsAnomaly -> (boolean)

Marks missing data points as anomalies.

skip -> (boolean)

Skips evaluation when data is missing.

Shorthand Syntax:

markAsAnomaly=boolean,skip=boolean

JSON Syntax:

{
  "markAsAnomaly": true|false,
  "skip": true|false
}

--configuration (tagged union structure) [required]

The algorithm configuration for the anomaly detector.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: randomCutForest.

randomCutForest -> (structure)

The Random Cut Forest algorithm configuration for anomaly detection.

query -> (string) [required]

The Prometheus query used to retrieve the time-series data for anomaly detection.

Warning
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.

Supported PromQL aggregation operators : avg , count , group , max , min , quantile , stddev , stdvar , and sum .

Constraints:

min: 1

max: 8192

shingleSize -> (integer)

The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.

Constraints:

min: 2

max: 1024

sampleSize -> (integer)

The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.

Constraints:

min: 256

max: 1024

ignoreNearExpectedFromAbove -> (tagged union structure)

Configuration for ignoring values that are near expected values from above during anomaly detection.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: amount, ratio.

amount -> (double)

The absolute amount by which values can differ from expected values before being considered anomalous.

Constraints:

min: 0

ratio -> (double)

The ratio by which values can differ from expected values before being considered anomalous.

Constraints:

min: 0

ignoreNearExpectedFromBelow -> (tagged union structure)

Configuration for ignoring values that are near expected values from below during anomaly detection.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: amount, ratio.

amount -> (double)

The absolute amount by which values can differ from expected values before being considered anomalous.

Constraints:

min: 0

ratio -> (double)

The ratio by which values can differ from expected values before being considered anomalous.

Constraints:

min: 0

Shorthand Syntax:

randomCutForest={query=string,shingleSize=integer,sampleSize=integer,ignoreNearExpectedFromAbove={amount=double,ratio=double},ignoreNearExpectedFromBelow={amount=double,ratio=double}}

JSON Syntax:

{
  "randomCutForest": {
    "query": "string",
    "shingleSize": integer,
    "sampleSize": integer,
    "ignoreNearExpectedFromAbove": {
      "amount": double,
      "ratio": double
    },
    "ignoreNearExpectedFromBelow": {
      "amount": double,
      "ratio": double
    }
  }
}

--labels (map)

The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.

Constraints:

min: 0

max: 140

key -> (string)

Constraints:

min: 1

max: 7168

pattern: (?!__)[a-zA-Z_][a-zA-Z0-9_]*

value -> (string)

Constraints:

min: 1

max: 7168

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:

min: 1

max: 64

pattern: [!-~]+

--tags (map)

The metadata to apply to the anomaly detector to assist with categorization and organization.

Constraints:

min: 0

max: 50

key -> (string)

The key of the tag. Must not begin with aws: .

Constraints:

min: 1

max: 128

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

The value of the tag.

Constraints:

min: 0

max: 256

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

Output¶

anomalyDetectorId -> (string)

The unique identifier of the created anomaly detector.

Constraints:

min: 1

max: 64

pattern: ad-[0-9A-Za-z][-.0-9A-Z_a-z]*

arn -> (string)

The Amazon Resource Name (ARN) of the created anomaly detector.

Constraints:

pattern: arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:anomalydetector/ws-.+/ad-.+

status -> (structure)

The status information of the created anomaly detector.

statusCode -> (string) [required]

The status code of the anomaly detector.

Possible values:

CREATING

ACTIVE

UPDATING

DELETING

CREATION_FAILED

UPDATE_FAILED

DELETION_FAILED

statusReason -> (string)

A description of the current status of the anomaly detector.

tags -> (map)

The tags applied to the created anomaly detector.

Constraints:

min: 0

max: 50

key -> (string)

The key of the tag. Must not begin with aws: .

Constraints:

min: 1

max: 128

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

The value of the tag.

Constraints:

min: 0

max: 256

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Table of Contents

Feedback

User Guide

create-anomaly-detector¶

Description¶

Synopsis¶

Options¶

Note

Note

Warning

Note

Note

Global Options¶

Output¶