UpdateAnomalySubscription
Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
Note
The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to
AnomalySubscription.
Request Syntax
{
"Frequency": "string",
"MonitorArnList": [ "string" ],
"Subscribers": [
{
"Address": "string",
"Status": "string",
"Type": "string"
}
],
"SubscriptionArn": "string",
"SubscriptionName": "string",
"Threshold": number,
"ThresholdExpression": {
"And": [
"Expression"
],
"CostCategories": {
"Key": "string",
"MatchOptions": [ "string" ],
"Values": [ "string" ]
},
"Dimensions": {
"Key": "string",
"MatchOptions": [ "string" ],
"Values": [ "string" ]
},
"Not": "Expression",
"Or": [
"Expression"
],
"Tags": {
"Key": "string",
"MatchOptions": [ "string" ],
"Values": [ "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.
- Frequency
-
The update to the frequency value that subscribers receive notifications.
Type: String
Valid Values:
DAILY | IMMEDIATE | WEEKLYRequired: No
- MonitorArnList
-
A list of cost anomaly monitor ARNs.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+Required: No
- Subscribers
-
The update to the subscriber list.
Type: Array of Subscriber objects
Required: No
- SubscriptionArn
-
A cost anomaly subscription Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*Required: Yes
- SubscriptionName
-
The new name of the subscription.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*Required: No
- Threshold
-
(deprecated)
The update to the threshold value for receiving notifications.
This field has been deprecated. To update a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
You can specify either Threshold or ThresholdExpression, but not both.
Type: Double
Valid Range: Minimum value of 0.0.
Required: No
- ThresholdExpression
-
The update to the Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are
ANOMALY_TOTAL_IMPACT_ABSOLUTEandANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types areANDandOR. The match optionGREATER_THAN_OR_EQUALis required. Values must be numbers between 0 and 10,000,000,000 in string format.You can specify either Threshold or ThresholdExpression, but not both.
The following are examples of valid ThresholdExpressions:
-
Absolute threshold:
{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } -
Percentage threshold:
{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } -
ANDtwo thresholds together:{ "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] } -
ORtwo thresholds together:{ "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
Type: Expression object
Required: No
-
Response Syntax
{
"SubscriptionArn": "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.
- SubscriptionArn
-
A cost anomaly subscription ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- LimitExceededException
-
You made too many calls in a short period of time. Try again later.
HTTP Status Code: 400
- UnknownMonitorException
-
The cost anomaly monitor does not exist for the account.
HTTP Status Code: 400
- UnknownSubscriptionException
-
The cost anomaly subscription does not exist for the account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
