AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the PutAnomalyDetector operation. 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.

If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account. You can specify the account ID in the object you specify in the SingleMetricAnomalyDetector parameter.

For more information, see CloudWatch Anomaly Detection.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatch.AmazonCloudWatchRequest
      Amazon.CloudWatch.Model.PutAnomalyDetectorRequest

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public class PutAnomalyDetectorRequest : AmazonCloudWatchRequest
         IAmazonWebServiceRequest

The PutAnomalyDetectorRequest type exposes the following members

Constructors

NameDescription
Public Method PutAnomalyDetectorRequest()

Properties

NameTypeDescription
Public Property Configuration Amazon.CloudWatch.Model.AnomalyDetectorConfiguration

Gets and sets the property 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.

Public Property Dimensions System.Collections.Generic.List<Amazon.CloudWatch.Model.Dimension>

Gets and sets the property Dimensions.

The metric dimensions to create the anomaly detection model for.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property MetricCharacteristics Amazon.CloudWatch.Model.MetricCharacteristics

Gets and sets the property MetricCharacteristics.

Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

Public Property MetricMathAnomalyDetector Amazon.CloudWatch.Model.MetricMathAnomalyDetector

Gets and sets the property 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.

Public Property MetricName System.String

Gets and sets the property MetricName.

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

Public Property Namespace System.String

Gets and sets the property Namespace.

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

Public Property SingleMetricAnomalyDetector Amazon.CloudWatch.Model.SingleMetricAnomalyDetector

Gets and sets the property 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 MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput

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

Public Property Stat System.String

Gets and sets the property Stat.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer