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

SearchOrganizationInsights

Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Request Syntax


POST /organization/insights/search HTTP/1.1
Content-type: application/json

{
   "AccountIds": [ "string" ],
   "Filters": { 
      "ResourceCollection": { 
         "CloudFormation": { 
            "StackNames": [ "string" ]
         },
         "Tags": [ 
            { 
               "AppBoundaryKey": "string",
               "TagValues": [ "string" ]
            }
         ]
      },
      "ServiceCollection": { 
         "ServiceNames": [ "string" ]
      },
      "Severities": [ "string" ],
      "Statuses": [ "string" ]
   },
   "MaxResults": number,
   "NextToken": "string",
   "StartTimeRange": { 
      "FromTime": number,
      "ToTime": number
   },
   "Type": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountIds

The ID of the AWS account.

Type: Array of strings

Array Members: Fixed number of 1 item.

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: Yes

Filters

A SearchOrganizationInsightsFilters object that is used to set the severity and status filters on your insight search.

Type: SearchOrganizationInsightsFilters 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 nextToken value.

Type: Integer

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

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 behavior of an insight or anomaly started.

Type: StartTimeRange object

Required: Yes

Type

The type of insights you are searching for (REACTIVE or PROACTIVE).

Type: String

Valid Values: REACTIVE | PROACTIVE

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ProactiveInsights": [ 
      { 
         "AssociatedResourceArns": [ "string" ],
         "Id": "string",
         "InsightTimeRange": { 
            "EndTime": number,
            "StartTime": number
         },
         "Name": "string",
         "PredictionTimeRange": { 
            "EndTime": number,
            "StartTime": number
         },
         "ResourceCollection": { 
            "CloudFormation": { 
               "StackNames": [ "string" ]
            },
            "Tags": [ 
               { 
                  "AppBoundaryKey": "string",
                  "TagValues": [ "string" ]
               }
            ]
         },
         "ServiceCollection": { 
            "ServiceNames": [ "string" ]
         },
         "Severity": "string",
         "Status": "string"
      }
   ],
   "ReactiveInsights": [ 
      { 
         "AssociatedResourceArns": [ "string" ],
         "Id": "string",
         "InsightTimeRange": { 
            "EndTime": number,
            "StartTime": number
         },
         "Name": "string",
         "ResourceCollection": { 
            "CloudFormation": { 
               "StackNames": [ "string" ]
            },
            "Tags": [ 
               { 
                  "AppBoundaryKey": "string",
                  "TagValues": [ "string" ]
               }
            ]
         },
         "ServiceCollection": { 
            "ServiceNames": [ "string" ]
         },
         "Severity": "string",
         "Status": "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}$

ProactiveInsights

An integer that specifies the number of open proactive insights in your AWS account.

Type: Array of ProactiveInsightSummary objects

ReactiveInsights

An integer that specifies the number of open reactive insights in your AWS account.

Type: Array of ReactiveInsightSummary 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

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