Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1461972964.4 KB

Lists and describes insights for the specified insight ARNs.

post/insights/get

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Request body

InsightArnsNonEmptyString[]

The ARNs of the insights to describe. If you do not provide any insight ARNs, then <code>GetInsights</code> returns all of your custom insights. It does not return any managed insights.

NextTokenstring
<p>The token that is required for pagination. On your first call to the <code>GetInsights</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
MaxResultsinteger

The maximum number of items to return in the response.

Response

Success

NextTokenstring

The pagination token to use to request the next page of results.

Example response

{
  "Insights": [
    {
      "Filters": {
        "ResourceType": [
          {
            "Comparison": "EQUALS",
            "Value": "AwsIamRole"
          }
        ],
        "SeverityLabel": [
          {
            "Comparison": "EQUALS",
            "Value": "CRITICAL"
          }
        ]
      },
      "GroupByAttribute": "ResourceId",
      "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
      "Name": "Critical role findings"
    }
  ]
}