Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatch.PutAnomalyDetector

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.
metricMathAnomalyDetector :: Maybe MetricMathAnomalyDetector
The metric math anomaly detector to be created.
When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:
- ```
Dimensions
```
- ```
MetricName
```
- ```
Namespace
```
- ```
Stat
```
- the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.
metricName :: Maybe Text
The name of the metric to create the anomaly detection model for.
namespace :: Maybe Text
The namespace of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector :: Maybe SingleMetricAnomalyDetector
A single metric anomaly detector to be created.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:
- ```
Dimensions
```
- ```
MetricName
```
- ```
Namespace
```
- ```
Stat
```
- the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.
stat :: Maybe Text
The statistic to use for the metric and the anomaly detection model.

Instances

Instances details

ToHeaders PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods toHeaders :: PutAnomalyDetector -> [Header] #
ToPath PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods toPath :: PutAnomalyDetector -> ByteString #
ToQuery PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods toQuery :: PutAnomalyDetector -> QueryString #
AWSRequest PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Associated Types type AWSResponse PutAnomalyDetector # Methods request :: (Service -> Service) -> PutAnomalyDetector -> Request PutAnomalyDetector # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutAnomalyDetector -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutAnomalyDetector))) #
Generic PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Associated Types type Rep PutAnomalyDetector :: Type -> Type # Methods from :: PutAnomalyDetector -> Rep PutAnomalyDetector x # to :: Rep PutAnomalyDetector x -> PutAnomalyDetector #
Read PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods readsPrec :: Int -> ReadS PutAnomalyDetector # readList :: ReadS [PutAnomalyDetector] # readPrec :: ReadPrec PutAnomalyDetector # readListPrec :: ReadPrec [PutAnomalyDetector] #
Show PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods showsPrec :: Int -> PutAnomalyDetector -> ShowS # show :: PutAnomalyDetector -> String # showList :: [PutAnomalyDetector] -> ShowS #
NFData PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods rnf :: PutAnomalyDetector -> () #
Eq PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods (==) :: PutAnomalyDetector -> PutAnomalyDetector -> Bool # (/=) :: PutAnomalyDetector -> PutAnomalyDetector -> Bool #
Hashable PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods hashWithSalt :: Int -> PutAnomalyDetector -> Int # hash :: PutAnomalyDetector -> Int #
type AWSResponse PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector type AWSResponse PutAnomalyDetector = PutAnomalyDetectorResponse
type Rep PutAnomalyDetector Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector type Rep PutAnomalyDetector = D1 ('MetaData "PutAnomalyDetector" "Amazonka.CloudWatch.PutAnomalyDetector" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" '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 "metricMathAnomalyDetector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricMathAnomalyDetector)))) :: ((S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "singleMetricAnomalyDetector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SingleMetricAnomalyDetector)) :: S1 ('MetaSel ('Just "stat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newPutAnomalyDetector :: PutAnomalyDetector 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:

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.

PutAnomalyDetector, putAnomalyDetector_dimensions - The metric dimensions to create the anomaly detection model for.

PutAnomalyDetector, putAnomalyDetector_metricMathAnomalyDetector - The metric math anomaly detector to be created.

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

```
Dimensions
```
```
MetricName
```
```
Namespace
```
```
Stat
```
the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.

PutAnomalyDetector, putAnomalyDetector_metricName - The name of the metric to create the anomaly detection model for.

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

PutAnomalyDetector, putAnomalyDetector_singleMetricAnomalyDetector - A single metric anomaly detector to be created.

When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

```
Dimensions
```
```
MetricName
```
```
Namespace
```
```
Stat
```
the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.

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_metricMathAnomalyDetector :: Lens' PutAnomalyDetector (Maybe MetricMathAnomalyDetector) Source #

The metric math anomaly detector to be created.

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

```
Dimensions
```
```
MetricName
```
```
Namespace
```
```
Stat
```
the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.

putAnomalyDetector_metricName :: Lens' PutAnomalyDetector (Maybe Text) Source #

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

putAnomalyDetector_namespace :: Lens' PutAnomalyDetector (Maybe Text) Source #

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

putAnomalyDetector_singleMetricAnomalyDetector :: Lens' PutAnomalyDetector (Maybe SingleMetricAnomalyDetector) Source #

A single metric anomaly detector to be created.

When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

```
Dimensions
```
```
MetricName
```
```
Namespace
```
```
Stat
```
the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.

putAnomalyDetector_stat :: Lens' PutAnomalyDetector (Maybe 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 httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutAnomalyDetectorResponse Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Associated Types type Rep PutAnomalyDetectorResponse :: Type -> Type # Methods from :: PutAnomalyDetectorResponse -> Rep PutAnomalyDetectorResponse x # to :: Rep PutAnomalyDetectorResponse x -> PutAnomalyDetectorResponse #
Read PutAnomalyDetectorResponse Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods readsPrec :: Int -> ReadS PutAnomalyDetectorResponse # readList :: ReadS [PutAnomalyDetectorResponse] # readPrec :: ReadPrec PutAnomalyDetectorResponse # readListPrec :: ReadPrec [PutAnomalyDetectorResponse] #
Show PutAnomalyDetectorResponse Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods showsPrec :: Int -> PutAnomalyDetectorResponse -> ShowS # show :: PutAnomalyDetectorResponse -> String # showList :: [PutAnomalyDetectorResponse] -> ShowS #
NFData PutAnomalyDetectorResponse Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods rnf :: PutAnomalyDetectorResponse -> () #
Eq PutAnomalyDetectorResponse Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector Methods (==) :: PutAnomalyDetectorResponse -> PutAnomalyDetectorResponse -> Bool # (/=) :: PutAnomalyDetectorResponse -> PutAnomalyDetectorResponse -> Bool #
type Rep PutAnomalyDetectorResponse Source #
Instance details Defined in Amazonka.CloudWatch.PutAnomalyDetector type Rep PutAnomalyDetectorResponse = D1 ('MetaData "PutAnomalyDetectorResponse" "Amazonka.CloudWatch.PutAnomalyDetector" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "PutAnomalyDetectorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutAnomalyDetectorResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutAnomalyDetectorResponse'`
-> PutAnomalyDetectorResponse

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

putAnomalyDetectorResponse_httpStatus :: Lens' PutAnomalyDetectorResponse Int Source #

The response's http status code.