libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatch.PutAnomalyDetector

Description

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

Synopsis

Creating a Request

data PutAnomalyDetector Source #

See: newPutAnomalyDetector smart constructor.

Constructors

PutAnomalyDetector' 

Fields

  • configuration :: Maybe AnomalyDetectorConfiguration

    The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.

    The configuration can also include the time zone to use for the metric.

  • dimensions :: Maybe [Dimension]

    The metric dimensions to create the anomaly detection model for.

  • namespace :: Text

    The namespace of the metric to create the anomaly detection model for.

  • metricName :: Text

    The name of the metric to create the anomaly detection model for.

  • stat :: Text

    The statistic to use for the metric and the anomaly detection model.

Instances

Instances details
Eq PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Read PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Show PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Generic PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Associated Types

type Rep PutAnomalyDetector :: Type -> Type #

NFData PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Methods

rnf :: PutAnomalyDetector -> () #

Hashable PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

AWSRequest PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Associated Types

type AWSResponse PutAnomalyDetector #

ToHeaders PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

ToPath PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

ToQuery PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

type Rep PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

type Rep PutAnomalyDetector = D1 ('MetaData "PutAnomalyDetector" "Amazonka.CloudWatch.PutAnomalyDetector" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "PutAnomalyDetector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnomalyDetectorConfiguration)) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Dimension]))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutAnomalyDetector Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

newPutAnomalyDetector Source #

Create a value of PutAnomalyDetector with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configuration:PutAnomalyDetector', putAnomalyDetector_configuration - The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.

The configuration can also include the time zone to use for the metric.

$sel:dimensions:PutAnomalyDetector', putAnomalyDetector_dimensions - The metric dimensions to create the anomaly detection model for.

$sel:namespace:PutAnomalyDetector', putAnomalyDetector_namespace - The namespace of the metric to create the anomaly detection model for.

$sel:metricName:PutAnomalyDetector', putAnomalyDetector_metricName - The name of the metric to create the anomaly detection model for.

$sel:stat:PutAnomalyDetector', putAnomalyDetector_stat - The statistic to use for the metric and the anomaly detection model.

Request Lenses

putAnomalyDetector_configuration :: Lens' PutAnomalyDetector (Maybe AnomalyDetectorConfiguration) Source #

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.

The configuration can also include the time zone to use for the metric.

putAnomalyDetector_dimensions :: Lens' PutAnomalyDetector (Maybe [Dimension]) Source #

The metric dimensions to create the anomaly detection model for.

putAnomalyDetector_namespace :: Lens' PutAnomalyDetector Text Source #

The namespace of the metric to create the anomaly detection model for.

putAnomalyDetector_metricName :: Lens' PutAnomalyDetector Text Source #

The name of the metric to create the anomaly detection model for.

putAnomalyDetector_stat :: Lens' PutAnomalyDetector Text Source #

The statistic to use for the metric and the anomaly detection model.

Destructuring the Response

data PutAnomalyDetectorResponse Source #

See: newPutAnomalyDetectorResponse smart constructor.

Constructors

PutAnomalyDetectorResponse' 

Fields

Instances

Instances details
Eq PutAnomalyDetectorResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Read PutAnomalyDetectorResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Show PutAnomalyDetectorResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Generic PutAnomalyDetectorResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

Associated Types

type Rep PutAnomalyDetectorResponse :: Type -> Type #

NFData PutAnomalyDetectorResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

type Rep PutAnomalyDetectorResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutAnomalyDetector

type Rep PutAnomalyDetectorResponse = D1 ('MetaData "PutAnomalyDetectorResponse" "Amazonka.CloudWatch.PutAnomalyDetector" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "PutAnomalyDetectorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutAnomalyDetectorResponse Source #

Create a value of PutAnomalyDetectorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:PutAnomalyDetectorResponse', putAnomalyDetectorResponse_httpStatus - The response's http status code.

Response Lenses