UpdateAnomalyDetector - Amazon Lookout for Metrics

UpdateAnomalyDetector

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

Request Syntax

POST /UpdateAnomalyDetector HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string", "AnomalyDetectorConfig": { "AnomalyDetectorFrequency": "string" }, "AnomalyDetectorDescription": "string", "KmsKeyArn": "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 update.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

AnomalyDetectorConfig

Contains information about the configuration to which the detector will be updated.

Type: AnomalyDetectorConfig object

Required: No

AnomalyDetectorDescription

The updated detector description.

Type: String

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

Pattern: .*\S.*

Required: No

KmsKeyArn

The Amazon Resource Name (ARN) of an AWS KMS encryption key.

Type: String

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

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AnomalyDetectorArn": "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 updated detector.

Type: String

Length Constraints: Maximum length of 256.

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

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: