Skip to content

CreateAnomalyDetectorRequest

Source code in docs_src/capo_amp/types/create_anomaly_detector_request.py
class CreateAnomalyDetectorRequest(TypedDict, closed=True):
    workspace_id: "capo_amp.types.workspace_id.WorkspaceId"
    """<p>The identifier of the workspace where the anomaly detector will be created.</p>"""
    alias: "capo_amp.types.anomaly_detector_alias.AnomalyDetectorAlias"
    """<p>A user-friendly name for the anomaly detector.</p>"""
    evaluation_interval_in_seconds: "capo_amp.types.anomaly_detector_evaluation_interval.AnomalyDetectorEvaluationInterval"
    """<p>The frequency, in seconds, at which the anomaly detector evaluates metrics. The default value is 60 seconds.</p>"""
    missing_data_action: NotRequired[
        "capo_amp.types.anomaly_detector_missing_data_action.AnomalyDetectorMissingDataAction"
    ]
    """<p>Specifies the action to take when data is missing during evaluation.</p>"""
    configuration: (
        "capo_amp.types.anomaly_detector_configuration.AnomalyDetectorConfiguration"
    )
    """<p>The algorithm configuration for the anomaly detector.</p>"""
    labels: NotRequired[
        "capo_amp.types.prometheus_metric_label_map.PrometheusMetricLabelMap"
    ]
    """<p>The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.</p>"""
    client_token: NotRequired["capo_amp.types.idempotency_token.IdempotencyToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    tags: NotRequired["capo_amp.types.tag_map.TagMap"]
    """<p>The metadata to apply to the anomaly detector to assist with categorization and organization.</p>"""

alias instance-attribute

A user-friendly name for the anomaly detector.

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

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

configuration instance-attribute

The algorithm configuration for the anomaly detector.

evaluation_interval_in_seconds instance-attribute

evaluation_interval_in_seconds: AnomalyDetectorEvaluationInterval

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

labels instance-attribute

labels: NotRequired[PrometheusMetricLabelMap]

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

missing_data_action instance-attribute

missing_data_action: NotRequired[AnomalyDetectorMissingDataAction]

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

tags instance-attribute

tags: NotRequired[TagMap]

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

workspace_id instance-attribute

workspace_id: WorkspaceId

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