Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetLogAnomalyDetector

Retrieves information about the log anomaly detector that you specify.

Request Syntax


{
   "anomalyDetectorArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

anomalyDetectorArn

The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\w#+=/:,.@-]*

Required: Yes

Response Syntax


{
   "anomalyDetectorStatus": "string",
   "anomalyVisibilityTime": number,
   "creationTimeStamp": number,
   "detectorName": "string",
   "evaluationFrequency": "string",
   "filterPattern": "string",
   "kmsKeyId": "string",
   "lastModifiedTimeStamp": number,
   "logGroupArnList": [ "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.

anomalyDetectorStatus

Specifies whether the anomaly detector is currently active. To change its status, use the enabled parameter in the UpdateLogAnomalyDetector operation.

Type: String

anomalyVisibilityTime

The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

Type: Long

Valid Range: Minimum value of 7. Maximum value of 90.

creationTimeStamp

The date and time when this anomaly detector was created.

Type: Long

Valid Range: Minimum value of 0.

detectorName

The name of the log anomaly detector

Type: String

Length Constraints: Minimum length of 1.

evaluationFrequency

Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.

Type: String

filterPattern

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

kmsKeyId

The ID of the Amazon KMS key assigned to this anomaly detector, if any.

Type: String

Length Constraints: Maximum length of 256.

lastModifiedTimeStamp

The date and time when this anomaly detector was most recently modified.

Type: Long

Valid Range: Minimum value of 0.

logGroupArnList

An array of structures, where each structure contains the ARN of a log group associated with this anomaly detector.

Type: Array of strings

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

Pattern: [\w#+=/:,.@-]*

Errors

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

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

OperationAbortedException

Multiple concurrent requests to update the same resource were in conflict.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ServiceUnavailableException

The service cannot complete the request.

HTTP Status Code: 500