SecurityHub / Client / get_insight_results

get_insight_results#

SecurityHub.Client.get_insight_results(**kwargs)#

Lists the results of the Security Hub insight specified by the insight ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_insight_results(
    InsightArn='string'
)
Parameters:

InsightArn (string) –

[REQUIRED]

The ARN of the insight for which to return results.

Return type:

dict

Returns:

Response Syntax

{
    'InsightResults': {
        'InsightArn': 'string',
        'GroupByAttribute': 'string',
        'ResultValues': [
            {
                'GroupByAttributeValue': 'string',
                'Count': 123
            },
        ]
    }
}

Response Structure

  • (dict) –

    • InsightResults (dict) –

      The insight results returned by the operation.

      • InsightArn (string) –

        The ARN of the insight whose results are returned by the GetInsightResults operation.

      • GroupByAttribute (string) –

        The attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.

      • ResultValues (list) –

        The list of insight result values returned by the GetInsightResults operation.

        • (dict) –

          The insight result values returned by the GetInsightResults operation.

          • GroupByAttributeValue (string) –

            The value of the attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.

          • Count (integer) –

            The number of findings returned for each GroupByAttributeValue.

Exceptions

  • SecurityHub.Client.exceptions.InternalException

  • SecurityHub.Client.exceptions.InvalidInputException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.LimitExceededException

  • SecurityHub.Client.exceptions.ResourceNotFoundException