Retrieves the summaries of all insights in the specified group matching the provided filter values.
Request Syntax
POST /InsightSummaries HTTP/1.1
Content-type: application/json
{
"EndTime": number,
"GroupARN": "string",
"GroupName": "string",
"MaxResults": number,
"NextToken": "string",
"StartTime": number,
"States": [ "string" ]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- EndTime
-
The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
Type: Timestamp
Required: Yes
- GroupARN
-
The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 400.
Required: No
- GroupName
-
The name of the group. Required if the GroupARN isn't provided.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: No
- MaxResults
-
The maximum number of results to display.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: No
- StartTime
-
The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
Type: Timestamp
Required: Yes
- States
-
The list of insight states.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Valid Values:
ACTIVE | CLOSEDRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"InsightSummaries": [
{
"Categories": [ "string" ],
"ClientRequestImpactStatistics": {
"FaultCount": number,
"OkCount": number,
"TotalCount": number
},
"EndTime": number,
"GroupARN": "string",
"GroupName": "string",
"InsightId": "string",
"LastUpdateTime": number,
"RootCauseServiceId": {
"AccountId": "string",
"Name": "string",
"Names": [ "string" ],
"Type": "string"
},
"RootCauseServiceRequestImpactStatistics": {
"FaultCount": number,
"OkCount": number,
"TotalCount": number
},
"StartTime": number,
"State": "string",
"Summary": "string",
"TopAnomalousServices": [
{
"ServiceId": {
"AccountId": "string",
"Name": "string",
"Names": [ "string" ],
"Type": "string"
}
}
]
}
],
"NextToken": "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.
- InsightSummaries
-
The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.
Type: Array of InsightSummary objects
- NextToken
-
Pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidRequestException
-
The request is missing required parameters or has invalid parameters.
HTTP Status Code: 400
- ThrottledException
-
The request exceeds the maximum number of requests per second.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
