list_anomaly_detectors

LookoutMetrics.Client.list_anomaly_detectors(**kwargs)

Lists the detectors in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_detectors(
    MaxResults=123,
    NextToken='string'
)

Parameters

• MaxResults (integer) -- The maximum number of results to return.
• NextToken (string) -- If the result of the previous request was truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Return type

dict

Returns

Response Syntax

{
    'AnomalyDetectorSummaryList': [
        {
            'AnomalyDetectorArn': 'string',
            'AnomalyDetectorName': 'string',
            'AnomalyDetectorDescription': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1),
            'Status': 'ACTIVE'|'ACTIVATING'|'DELETING'|'FAILED'|'INACTIVE'|'LEARNING'|'BACK_TEST_ACTIVATING'|'BACK_TEST_ACTIVE'|'BACK_TEST_COMPLETE'|'DEACTIVATED'|'DEACTIVATING',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • AnomalyDetectorSummaryList (list) --

    A list of anomaly detectors in the account in the current region.

    • (dict) --

      Contains information about an an anomaly detector.

      • AnomalyDetectorArn (string) --

        The ARN of the detector.

      • AnomalyDetectorName (string) --

        The name of the detector.

      • AnomalyDetectorDescription (string) --

        A description of the detector.

      • CreationTime (datetime) --

        The time at which the detector was created.

      • LastModificationTime (datetime) --

        The time at which the detector was last modified.

      • Status (string) --

        The status of detector.

      • Tags (dict) --

        The detector's tags.

        • (string) --
          • (string) --

  • NextToken (string) --

    If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.

Exceptions

• LookoutMetrics.Client.exceptions.ResourceNotFoundException
• LookoutMetrics.Client.exceptions.ValidationException
• LookoutMetrics.Client.exceptions.AccessDeniedException
• LookoutMetrics.Client.exceptions.TooManyRequestsException
• LookoutMetrics.Client.exceptions.InternalServerException