Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securityhub ]

get-insight-results

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-insight-results
--insight-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--insight-arn (string)

The ARN of the insight for which to return results.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve the results for an insight

The following get-insight-results example returns the list of insight results for the insight with the specified ARN.

aws securityhub get-insight-results \
    --insight-arn "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"

Output:

{
    "InsightResults": {
        "GroupByAttribute": "ResourceId",
        "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "ResultValues": [
            {
                "Count": 10,
                "GroupByAttributeValue": "AWS::::Account:123456789111"
            },
            {
                "Count": 3,
                "GroupByAttributeValue": "AWS::::Account:123456789222"
            }
        ]
    }
}

For more information, see Viewing and taking action on insight results and findings in the AWS Security Hub User Guide.

Output

InsightResults -> (structure)

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.

(structure)

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 .