

# GetInsights
<a name="API_GetInsights"></a>

Lists and describes insights for the specified insight ARNs.

## Request Syntax
<a name="API_GetInsights_RequestSyntax"></a>

```
POST /insights/get HTTP/1.1
Content-type: application/json

{
   "InsightArns": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetInsights_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetInsights_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InsightArns](#API_GetInsights_RequestSyntax) **   <a name="securityhub-GetInsights-request-InsightArns"></a>
The ARNs of the insights to describe. If you don't provide any insight ARNs, then `GetInsights` returns all of your custom insights. It does not return any managed insights.  
Type: Array of strings  
Pattern: `.*\S.*`   
Required: No

 ** [MaxResults](#API_GetInsights_RequestSyntax) **   <a name="securityhub-GetInsights-request-MaxResults"></a>
The maximum number of items to return in the response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_GetInsights_RequestSyntax) **   <a name="securityhub-GetInsights-request-NextToken"></a>
The token that is required for pagination. On your first call to the `GetInsights` operation, set the value of this parameter to `NULL`.  
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.  
Type: String  
Required: No

## Response Syntax
<a name="API_GetInsights_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Insights": [ 
      { 
         "Filters": { 
            "AwsAccountId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "AwsAccountName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "CompanyName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ComplianceAssociatedStandardsId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ComplianceSecurityControlId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ComplianceSecurityControlParametersName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ComplianceSecurityControlParametersValue": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ComplianceStatus": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Confidence": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "CreatedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "Criticality": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "Description": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "FindingProviderFieldsConfidence": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "FindingProviderFieldsCriticality": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "FindingProviderFieldsRelatedFindingsId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "FindingProviderFieldsRelatedFindingsProductArn": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "FindingProviderFieldsSeverityLabel": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "FindingProviderFieldsSeverityOriginal": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "FindingProviderFieldsTypes": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "FirstObservedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "GeneratorId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Id": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Keyword": [ 
               { 
                  "Value": "string"
               }
            ],
            "LastObservedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "MalwareName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "MalwarePath": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "MalwareState": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "MalwareType": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NetworkDestinationDomain": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NetworkDestinationIpV4": [ 
               { 
                  "Cidr": "string"
               }
            ],
            "NetworkDestinationIpV6": [ 
               { 
                  "Cidr": "string"
               }
            ],
            "NetworkDestinationPort": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "NetworkDirection": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NetworkProtocol": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NetworkSourceDomain": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NetworkSourceIpV4": [ 
               { 
                  "Cidr": "string"
               }
            ],
            "NetworkSourceIpV6": [ 
               { 
                  "Cidr": "string"
               }
            ],
            "NetworkSourceMac": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NetworkSourcePort": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "NoteText": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "NoteUpdatedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "NoteUpdatedBy": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ProcessLaunchedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "ProcessName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ProcessParentPid": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "ProcessPath": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ProcessPid": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "ProcessTerminatedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "ProductArn": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ProductFields": [ 
               { 
                  "Comparison": "string",
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "ProductName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "RecommendationText": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "RecordState": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Region": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "RelatedFindingsId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "RelatedFindingsProductArn": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceApplicationArn": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceApplicationName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsEc2InstanceIamInstanceProfileArn": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsEc2InstanceImageId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsEc2InstanceIpV4Addresses": [ 
               { 
                  "Cidr": "string"
               }
            ],
            "ResourceAwsEc2InstanceIpV6Addresses": [ 
               { 
                  "Cidr": "string"
               }
            ],
            "ResourceAwsEc2InstanceKeyName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsEc2InstanceLaunchedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "ResourceAwsEc2InstanceSubnetId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsEc2InstanceType": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsEc2InstanceVpcId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsIamAccessKeyCreatedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "ResourceAwsIamAccessKeyPrincipalName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsIamAccessKeyStatus": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsIamAccessKeyUserName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsIamUserUserName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsS3BucketOwnerId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceAwsS3BucketOwnerName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceContainerImageId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceContainerImageName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceContainerLaunchedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "ResourceContainerName": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceDetailsOther": [ 
               { 
                  "Comparison": "string",
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "ResourceId": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourcePartition": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceRegion": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ResourceTags": [ 
               { 
                  "Comparison": "string",
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "ResourceType": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Sample": [ 
               { 
                  "Value": boolean
               }
            ],
            "SeverityLabel": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "SeverityNormalized": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "SeverityProduct": [ 
               { 
                  "Eq": number,
                  "Gt": number,
                  "Gte": number,
                  "Lt": number,
                  "Lte": number
               }
            ],
            "SourceUrl": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ThreatIntelIndicatorCategory": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ThreatIntelIndicatorLastObservedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "ThreatIntelIndicatorSource": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ThreatIntelIndicatorSourceUrl": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ThreatIntelIndicatorType": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "ThreatIntelIndicatorValue": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Title": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "Type": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "UpdatedAt": [ 
               { 
                  "DateRange": { 
                     "Unit": "string",
                     "Value": number
                  },
                  "End": "string",
                  "Start": "string"
               }
            ],
            "UserDefinedFields": [ 
               { 
                  "Comparison": "string",
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "VerificationState": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "VulnerabilitiesExploitAvailable": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "VulnerabilitiesFixAvailable": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "WorkflowState": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ],
            "WorkflowStatus": [ 
               { 
                  "Comparison": "string",
                  "Value": "string"
               }
            ]
         },
         "GroupByAttribute": "string",
         "InsightArn": "string",
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetInsights_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Insights](#API_GetInsights_ResponseSyntax) **   <a name="securityhub-GetInsights-response-Insights"></a>
The insights returned by the operation.  
Type: Array of [Insight](API_Insight.md) objects

 ** [NextToken](#API_GetInsights_ResponseSyntax) **   <a name="securityhub-GetInsights-response-NextToken"></a>
The pagination token to use to request the next page of results.  
Type: String

## Errors
<a name="API_GetInsights_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
Internal server error.  
HTTP Status Code: 500

 ** InvalidAccessException **   
The account doesn't have permission to perform this action.  
HTTP Status Code: 401

 ** InvalidInputException **   
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.  
HTTP Status Code: 400

 ** LimitExceededException **   
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.  
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The request was rejected because we can't find the specified resource.  
HTTP Status Code: 404

## See Also
<a name="API_GetInsights_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetInsights) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetInsights) 