ListAnomaliesForInsight
Returns a list of the anomalies that belong to an insight that you specify using its ID.
Request Syntax
POST /anomalies/insight/InsightId HTTP/1.1
Content-type: application/json
{
"AccountId": "string",
"Filters": {
"ServiceCollection": {
"ServiceNames": [ "string" ]
}
},
"MaxResults": number,
"NextToken": "string",
"StartTimeRange": {
"FromTime": number,
"ToTime": number
}
}URI Request Parameters
The request uses the following URI parameters.
- InsightId
-
The ID of the insight. The returned anomalies belong to this insight.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[\w-]*$Required: Yes
Request Body
The request accepts the following data in JSON format.
- AccountId
-
The ID of the AWS account.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^\d{12}$Required: No
- Filters
-
Specifies one or more service names that are used to list anomalies.
Type: ListAnomaliesForInsightFilters object
Required: No
- MaxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextTokenvalue.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: No
- StartTimeRange
-
A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.
Type: StartTimeRange object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"ProactiveAnomalies": [
{
"AnomalyReportedTimeRange": {
"CloseTime": number,
"OpenTime": number
},
"AnomalyResources": [
{
"Name": "string",
"Type": "string"
}
],
"AnomalyTimeRange": {
"EndTime": number,
"StartTime": number
},
"AssociatedInsightId": "string",
"Description": "string",
"Id": "string",
"Limit": number,
"PredictionTimeRange": {
"EndTime": number,
"StartTime": number
},
"ResourceCollection": {
"CloudFormation": {
"StackNames": [ "string" ]
},
"Tags": [
{
"AppBoundaryKey": "string",
"TagValues": [ "string" ]
}
]
},
"Severity": "string",
"SourceDetails": {
"CloudWatchMetrics": [
{
"Dimensions": [
{
"Name": "string",
"Value": "string"
}
],
"MetricDataSummary": {
"StatusCode": "string",
"TimestampMetricValuePairList": [
{
"MetricValue": number,
"Timestamp": number
}
]
},
"MetricName": "string",
"Namespace": "string",
"Period": number,
"Stat": "string",
"Unit": "string"
}
],
"PerformanceInsightsMetrics": [
{
"MetricDisplayName": "string",
"MetricQuery": {
"Filter": {
"string" : "string"
},
"GroupBy": {
"Dimensions": [ "string" ],
"Group": "string",
"Limit": number
},
"Metric": "string"
},
"ReferenceData": [
{
"ComparisonValues": {
"ReferenceMetric": {
"MetricQuery": {
"Filter": {
"string" : "string"
},
"GroupBy": {
"Dimensions": [ "string" ],
"Group": "string",
"Limit": number
},
"Metric": "string"
}
},
"ReferenceScalar": {
"Value": number
}
},
"Name": "string"
}
],
"StatsAtAnomaly": [
{
"Type": "string",
"Value": number
}
],
"StatsAtBaseline": [
{
"Type": "string",
"Value": number
}
],
"Unit": "string"
}
]
},
"SourceMetadata": {
"Source": "string",
"SourceResourceName": "string",
"SourceResourceType": "string"
},
"Status": "string",
"UpdateTime": number
}
],
"ReactiveAnomalies": [
{
"AnomalyReportedTimeRange": {
"CloseTime": number,
"OpenTime": number
},
"AnomalyResources": [
{
"Name": "string",
"Type": "string"
}
],
"AnomalyTimeRange": {
"EndTime": number,
"StartTime": number
},
"AssociatedInsightId": "string",
"CausalAnomalyId": "string",
"Description": "string",
"Id": "string",
"Name": "string",
"ResourceCollection": {
"CloudFormation": {
"StackNames": [ "string" ]
},
"Tags": [
{
"AppBoundaryKey": "string",
"TagValues": [ "string" ]
}
]
},
"Severity": "string",
"SourceDetails": {
"CloudWatchMetrics": [
{
"Dimensions": [
{
"Name": "string",
"Value": "string"
}
],
"MetricDataSummary": {
"StatusCode": "string",
"TimestampMetricValuePairList": [
{
"MetricValue": number,
"Timestamp": number
}
]
},
"MetricName": "string",
"Namespace": "string",
"Period": number,
"Stat": "string",
"Unit": "string"
}
],
"PerformanceInsightsMetrics": [
{
"MetricDisplayName": "string",
"MetricQuery": {
"Filter": {
"string" : "string"
},
"GroupBy": {
"Dimensions": [ "string" ],
"Group": "string",
"Limit": number
},
"Metric": "string"
},
"ReferenceData": [
{
"ComparisonValues": {
"ReferenceMetric": {
"MetricQuery": {
"Filter": {
"string" : "string"
},
"GroupBy": {
"Dimensions": [ "string" ],
"Group": "string",
"Limit": number
},
"Metric": "string"
}
},
"ReferenceScalar": {
"Value": number
}
},
"Name": "string"
}
],
"StatsAtAnomaly": [
{
"Type": "string",
"Value": number
}
],
"StatsAtBaseline": [
{
"Type": "string",
"Value": number
}
],
"Unit": "string"
}
]
},
"Status": "string",
"Type": "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.
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - ProactiveAnomalies
-
An array of
ProactiveAnomalySummaryobjects that represent the requested anomaliesType: Array of ProactiveAnomalySummary objects
- ReactiveAnomalies
-
An array of
ReactiveAnomalySummaryobjects that represent the requested anomaliesType: Array of ReactiveAnomalySummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403
- InternalServerException
-
An internal failure in an Amazon service occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource could not be found
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to a request throttling.
HTTP Status Code: 429
- ValidationException
-
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
