GetAnomalies
Retrieves all of the cost anomalies detected on your account during the time period that's
specified by the DateInterval
object. Anomalies are available for up to 90
days.
Request Syntax
{
"DateInterval": {
"EndDate": "string
",
"StartDate": "string
"
},
"Feedback": "string
",
"MaxResults": number
,
"MonitorArn": "string
",
"NextPageToken": "string
",
"TotalImpact": {
"EndValue": number
,
"NumericOperator": "string
",
"StartValue": number
}
}
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.
- DateInterval
-
Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an
AnomalyEndDate
in the specified time range.Type: AnomalyDateInterval object
Required: Yes
- Feedback
-
Filters anomaly results by the feedback field on the anomaly object.
Type: String
Valid Values:
YES | NO | PLANNED_ACTIVITY
Required: No
- MaxResults
-
The number of entries a paginated response contains.
Type: Integer
Required: No
- MonitorArn
-
Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- NextPageToken
-
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
[\S\s]*
Required: No
- TotalImpact
-
Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies
GREATER_THAN 200.00
to retrieve anomalies, with an estimated dollar impact greater than 200.Type: TotalImpactFilter object
Required: No
Response Syntax
{
"Anomalies": [
{
"AnomalyEndDate": "string",
"AnomalyId": "string",
"AnomalyScore": {
"CurrentScore": number,
"MaxScore": number
},
"AnomalyStartDate": "string",
"DimensionValue": "string",
"Feedback": "string",
"Impact": {
"MaxImpact": number,
"TotalActualSpend": number,
"TotalExpectedSpend": number,
"TotalImpact": number,
"TotalImpactPercentage": number
},
"MonitorArn": "string",
"RootCauses": [
{
"LinkedAccount": "string",
"LinkedAccountName": "string",
"Region": "string",
"Service": "string",
"UsageType": "string"
}
]
}
],
"NextPageToken": "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.
- Anomalies
-
A list of cost anomalies.
Type: Array of Anomaly objects
- NextPageToken
-
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
[\S\s]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The pagination token is invalid. Try again without a pagination token.
HTTP Status Code: 400
- LimitExceededException
-
You made too many calls in a short period of time. Try again later.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: