Skip to content

AnomalyDetector

Source code in docs_src/capo_cloudwatch/types/anomaly_detector.py
class AnomalyDetector(TypedDict, closed=True):
    anomaly_detector_id: NotRequired[
        "capo_cloudwatch.types.anomaly_detector_id.AnomalyDetectorId"
    ]
    """<p>The unique identifier of the anomaly detector.</p> <note> <p>The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.</p> </note>"""
    namespace: NotRequired["capo_cloudwatch.types.namespace.Namespace"]
    """<p>The namespace of the metric associated with the anomaly detection model.</p>"""
    metric_name: NotRequired["capo_cloudwatch.types.metric_name.MetricName"]
    """<p>The name of the metric associated with the anomaly detection model.</p>"""
    dimensions: NotRequired["capo_cloudwatch.types.dimensions.Dimensions"]
    """<p>The metric dimensions associated with the anomaly detection model.</p>"""
    stat: NotRequired[
        "capo_cloudwatch.types.anomaly_detector_metric_stat.AnomalyDetectorMetricStat"
    ]
    """<p>The statistic associated with the anomaly detection model.</p>"""
    configuration: NotRequired[
        "capo_cloudwatch.types.anomaly_detector_configuration.AnomalyDetectorConfiguration"
    ]
    """<p>The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.</p>"""
    state_value: NotRequired[
        "capo_cloudwatch.types.anomaly_detector_state_value.AnomalyDetectorStateValue"
    ]
    """<p>The current status of the anomaly detector's training.</p>"""
    metric_characteristics: NotRequired[
        "capo_cloudwatch.types.metric_characteristics.MetricCharacteristics"
    ]
    """<p>This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>"""
    single_metric_anomaly_detector: NotRequired[
        "capo_cloudwatch.types.single_metric_anomaly_detector.SingleMetricAnomalyDetector"
    ]
    """<p>The CloudWatch metric and statistic for this anomaly detector.</p>"""
    metric_math_anomaly_detector: NotRequired[
        "capo_cloudwatch.types.metric_math_anomaly_detector.MetricMathAnomalyDetector"
    ]
    """<p>The CloudWatch metric math expression for this anomaly detector.</p>"""

anomaly_detector_id instance-attribute

anomaly_detector_id: NotRequired[AnomalyDetectorId]

The unique identifier of the anomaly detector.

The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.

configuration instance-attribute

configuration: NotRequired[AnomalyDetectorConfiguration]

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.

dimensions instance-attribute

dimensions: NotRequired[Dimensions]

The metric dimensions associated with the anomaly detection model.

metric_characteristics instance-attribute

metric_characteristics: NotRequired[MetricCharacteristics]

This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

metric_math_anomaly_detector instance-attribute

metric_math_anomaly_detector: NotRequired[MetricMathAnomalyDetector]

The CloudWatch metric math expression for this anomaly detector.

metric_name instance-attribute

metric_name: NotRequired[MetricName]

The name of the metric associated with the anomaly detection model.

namespace instance-attribute

namespace: NotRequired[Namespace]

The namespace of the metric associated with the anomaly detection model.

single_metric_anomaly_detector instance-attribute

single_metric_anomaly_detector: NotRequired[SingleMetricAnomalyDetector]

The CloudWatch metric and statistic for this anomaly detector.

stat instance-attribute

stat: NotRequired[AnomalyDetectorMetricStat]

The statistic associated with the anomaly detection model.

state_value instance-attribute

state_value: NotRequired[AnomalyDetectorStateValue]

The current status of the anomaly detector's training.