Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutAnomalyDetector

When you call PutAnomalyDetector, the operation creates a new anomaly detector if one doesn't exist, or updates an existing one. Each call to this operation triggers a complete retraining of the detector, which includes querying the minimum required samples and backfilling the detector with historical data. This process occurs regardless of whether you're making a minor change like updating the evaluation interval or making more substantial modifications. The operation serves as the single method for creating, updating, and retraining anomaly detectors.

Request Syntax


PUT /workspaces/workspaceId/anomalydetectors/anomalyDetectorId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "evaluationIntervalInSeconds": number,
   "labels": { 
      "string" : "string" 
   },
   "missingDataAction": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

anomalyDetectorId

The identifier of the anomaly detector to update.

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

Pattern: ad-[0-9A-Za-z][-.0-9A-Z_a-z]*

Required: Yes

workspaceId

The identifier of the workspace containing the anomaly detector to update.

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

Pattern: .*[0-9A-Za-z][-.0-9A-Z_a-z]*.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

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

Pattern: [!-~]+

Required: No

configuration

The algorithm configuration for the anomaly detector.

Type: AnomalyDetectorConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

evaluationIntervalInSeconds

The frequency, in seconds, at which the anomaly detector evaluates metrics.

Type: Integer

Valid Range: Minimum value of 30. Maximum value of 86400.

Required: No

labels

The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 7168.

Key Pattern: (?!__)[a-zA-Z_][a-zA-Z0-9_]*

Value Length Constraints: Minimum length of 1. Maximum length of 7168.

Required: No

missingDataAction

Specifies the action to take when data is missing during evaluation.

Type: AnomalyDetectorMissingDataAction object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "anomalyDetectorId": "string",
   "arn": "string",
   "status": { 
      "statusCode": "string",
      "statusReason": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

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

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

anomalyDetectorId

The unique identifier of the updated anomaly detector.

Type: String

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

Pattern: ad-[0-9A-Za-z][-.0-9A-Z_a-z]*

arn

The Amazon Resource Name (ARN) of the updated anomaly detector.

Type: String

Pattern: arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:anomalydetector/ws-.+/ad-.+

status

The status information of the updated anomaly detector.

Type: AnomalyDetectorStatus object

tags

The tags applied to the updated anomaly detector.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

message: Description of the error.

HTTP Status Code: 403

ConflictException

The request would cause an inconsistent state.

message: Description of the error.
resourceId: Identifier of the resource affected.
resourceType: Type of the resource affected.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request.

message: Description of the error.
retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ServiceQuotaExceededException

Completing the request would cause a service quota to be exceeded.

message: Description of the error.
quotaCode: Service quotas code of the originating quota.
resourceId: Identifier of the resource affected.
resourceType: Type of the resource affected.
serviceCode: Service quotas code for the originating service.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

message: Description of the error.
quotaCode: Service quotas code for the originating quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: Service quotas code for the originating service.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
message: Description of the error.
reason: Reason the request failed validation.

HTTP Status Code: 400