LookoutMetrics / Client / describe_anomaly_detector

describe_anomaly_detector

LookoutMetrics.Client.describe_anomaly_detector(**kwargs)

Describes a detector.

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.describe_anomaly_detector(
    AnomalyDetectorArn='string'
)

Parameters:

AnomalyDetectorArn (string) –

[REQUIRED]

The ARN of the detector to describe.

Return type:

dict

Returns:

Response Syntax

{
    'AnomalyDetectorArn': 'string',
    'AnomalyDetectorName': 'string',
    'AnomalyDetectorDescription': 'string',
    'AnomalyDetectorConfig': {
        'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
    },
    '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',
    'FailureReason': 'string',
    'KmsKeyArn': 'string',
    'FailureType': 'ACTIVATION_FAILURE'|'BACK_TEST_ACTIVATION_FAILURE'|'DELETION_FAILURE'|'DEACTIVATION_FAILURE'
}

Response Structure

• (dict) –

  • AnomalyDetectorArn (string) –

    The ARN of the detector.

  • AnomalyDetectorName (string) –

    The name of the detector.

  • AnomalyDetectorDescription (string) –

    A description of the detector.

  • AnomalyDetectorConfig (dict) –

    Contains information about the detector’s configuration.

    • AnomalyDetectorFrequency (string) –

      The interval at which the detector analyzes its source data.

  • 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 the detector.

  • FailureReason (string) –

    The reason that the detector failed.

  • KmsKeyArn (string) –

    The ARN of the KMS key to use to encrypt your data.

  • FailureType (string) –

    The process that caused the detector to fail.

Exceptions

• LookoutMetrics.Client.exceptions.ResourceNotFoundException

• LookoutMetrics.Client.exceptions.ValidationException

• LookoutMetrics.Client.exceptions.AccessDeniedException

• LookoutMetrics.Client.exceptions.InternalServerException

• LookoutMetrics.Client.exceptions.TooManyRequestsException