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

CreateAlert

Creates an alert for an anomaly detector.

Request Syntax


POST /CreateAlert HTTP/1.1
Content-type: application/json

{
   "Action": { 
      "LambdaConfiguration": { 
         "LambdaArn": "string",
         "RoleArn": "string"
      },
      "SNSConfiguration": { 
         "RoleArn": "string",
         "SnsFormat": "string",
         "SnsTopicArn": "string"
      }
   },
   "AlertDescription": "string",
   "AlertFilters": { 
      "DimensionFilterList": [ 
         { 
            "DimensionName": "string",
            "DimensionValueList": [ "string" ]
         }
      ],
      "MetricList": [ "string" ]
   },
   "AlertName": "string",
   "AlertSensitivityThreshold": number,
   "AnomalyDetectorArn": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Action

Action that will be triggered when there is an alert.

Type: Action object

Required: Yes

AlertDescription

A description of the alert.

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*\S.*

Required: No

AlertFilters

The configuration of the alert filters, containing MetricList and DimensionFilterList.

Type: AlertFilters object

Required: No

AlertName

The name of the alert.

Type: String

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

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

Required: Yes

AlertSensitivityThreshold

An integer from 0 to 100 specifying the alert sensitivity threshold.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

AnomalyDetectorArn

The ARN of the detector to which the alert is attached.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Tags

A list of tags to apply to the alert.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AlertArn": "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.

AlertArn

The ARN of the alert.

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

ConflictException

There was a conflict processing the request. Try your request again.

ResourceId: The ID of the resource.
ResourceType: The type of the resource.

HTTP Status Code: 409

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.

ResourceId: The ID of the resource.
ResourceType: The type of the resource.

HTTP Status Code: 400

ServiceQuotaExceededException

The request exceeded the service's quotas. Check the service quotas and try again.

QuotaCode: The quota code.
ResourceId: The ID of the resource.
ResourceType: The type of the resource.
ServiceCode: The service code.

HTTP Status Code: 402

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.

Fields: Fields that failed validation.
Reason: The reason that validation failed.

HTTP Status Code: 400