DescribeAnomalyDetector - Amazon Lookout for Metrics

DescribeAnomalyDetector

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.

Request Syntax

POST /DescribeAnomalyDetector HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AnomalyDetectorArn

The ARN of the detector to describe.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AnomalyDetectorArn": "string", "AnomalyDetectorConfig": { "AnomalyDetectorFrequency": "string" }, "AnomalyDetectorDescription": "string", "AnomalyDetectorName": "string", "CreationTime": number, "FailureReason": "string", "KmsKeyArn": "string", "LastModificationTime": number, "Status": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AnomalyDetectorArn

The ARN of the detector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

AnomalyDetectorConfig

Contains information about the detector's configuration.

Type: AnomalyDetectorConfigSummary object

AnomalyDetectorDescription

A description of the detector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

AnomalyDetectorName

The name of the detector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

CreationTime

The time at which the detector was created.

Type: Timestamp

FailureReason

The reason that the detector failed, if any.

Type: String

Length Constraints: Maximum length of 256.

KmsKeyArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.*

LastModificationTime

The time at which the detector was last modified.

Type: Timestamp

Status

The status of the detector.

Type: String

Valid Values: ACTIVE | ACTIVATING | DELETING | FAILED | INACTIVE | BACK_TEST_ACTIVATING | BACK_TEST_ACTIVE | BACK_TEST_COMPLETE

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ARN of the resource and try again.

HTTP Status Code: 400

TooManyRequestsException

The request was denied due to too many requests being submitted at the same time.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: