Skip to content

DescribeAnomalyDetectorsInput

Source code in docs_src/capo_cloudwatch/types/describe_anomaly_detectors_input.py
class DescribeAnomalyDetectorsInput(TypedDict, closed=True):
    anomaly_detector_ids: NotRequired[
        "capo_cloudwatch.types.anomaly_detector_ids.AnomalyDetectorIds"
    ]
    """<p>Specifies the unique identifiers of the anomaly detectors to describe. You can specify up to 50 identifiers. If you specify this parameter, you cannot also specify the <code>Namespace</code>, <code>MetricName</code>, <code>Dimensions</code>, or <code>AnomalyDetectorTypes</code> metric filters.</p>"""
    next_token: NotRequired["capo_cloudwatch.types.next_token.NextToken"]
    """<p>Use the token returned by the previous operation to request the next page of results.</p>"""
    max_results: NotRequired[
        "capo_cloudwatch.types.max_returned_results_count.MaxReturnedResultsCount"
    ]
    """<p>The maximum number of results to return in one operation. The maximum value that you can specify is 100.</p> <p>To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </p>"""
    namespace: NotRequired["capo_cloudwatch.types.namespace.Namespace"]
    """<p>Limits the results to only the anomaly detection models that are associated with the specified namespace.</p>"""
    metric_name: NotRequired["capo_cloudwatch.types.metric_name.MetricName"]
    """<p>Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.</p>"""
    dimensions: NotRequired["capo_cloudwatch.types.dimensions.Dimensions"]
    """<p>Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.</p>"""
    anomaly_detector_types: NotRequired[
        "capo_cloudwatch.types.anomaly_detector_types.AnomalyDetectorTypes"
    ]
    """<p>The anomaly detector types to request when using <code>DescribeAnomalyDetectorsInput</code>. If empty, defaults to <code>SINGLE_METRIC</code>.</p>"""

anomaly_detector_ids instance-attribute

anomaly_detector_ids: NotRequired[AnomalyDetectorIds]

Specifies the unique identifiers of the anomaly detectors to describe. You can specify up to 50 identifiers. If you specify this parameter, you cannot also specify the Namespace, MetricName, Dimensions, or AnomalyDetectorTypes metric filters.

anomaly_detector_types instance-attribute

anomaly_detector_types: NotRequired[AnomalyDetectorTypes]

The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults to SINGLE_METRIC.

dimensions instance-attribute

dimensions: NotRequired[Dimensions]

Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.

max_results instance-attribute

max_results: NotRequired[MaxReturnedResultsCount]

The maximum number of results to return in one operation. The maximum value that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

metric_name instance-attribute

metric_name: NotRequired[MetricName]

Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.

namespace instance-attribute

namespace: NotRequired[Namespace]

Limits the results to only the anomaly detection models that are associated with the specified namespace.

next_token instance-attribute

next_token: NotRequired[NextToken]

Use the token returned by the previous operation to request the next page of results.