Lists findings for your environment.
Request Syntax
POST /findings/list HTTP/1.1
Content-type: application/json
{
"filterCriteria": {
"awsAccountId": [
{
"comparison": "string",
"value": "string"
}
],
"codeVulnerabilityDetectorName": [
{
"comparison": "string",
"value": "string"
}
],
"codeVulnerabilityDetectorTags": [
{
"comparison": "string",
"value": "string"
}
],
"codeVulnerabilityFilePath": [
{
"comparison": "string",
"value": "string"
}
],
"componentId": [
{
"comparison": "string",
"value": "string"
}
],
"componentType": [
{
"comparison": "string",
"value": "string"
}
],
"ec2InstanceImageId": [
{
"comparison": "string",
"value": "string"
}
],
"ec2InstanceSubnetId": [
{
"comparison": "string",
"value": "string"
}
],
"ec2InstanceVpcId": [
{
"comparison": "string",
"value": "string"
}
],
"ecrImageArchitecture": [
{
"comparison": "string",
"value": "string"
}
],
"ecrImageHash": [
{
"comparison": "string",
"value": "string"
}
],
"ecrImagePushedAt": [
{
"endInclusive": number,
"startInclusive": number
}
],
"ecrImageRegistry": [
{
"comparison": "string",
"value": "string"
}
],
"ecrImageRepositoryName": [
{
"comparison": "string",
"value": "string"
}
],
"ecrImageTags": [
{
"comparison": "string",
"value": "string"
}
],
"epssScore": [
{
"lowerInclusive": number,
"upperInclusive": number
}
],
"exploitAvailable": [
{
"comparison": "string",
"value": "string"
}
],
"findingArn": [
{
"comparison": "string",
"value": "string"
}
],
"findingStatus": [
{
"comparison": "string",
"value": "string"
}
],
"findingType": [
{
"comparison": "string",
"value": "string"
}
],
"firstObservedAt": [
{
"endInclusive": number,
"startInclusive": number
}
],
"fixAvailable": [
{
"comparison": "string",
"value": "string"
}
],
"inspectorScore": [
{
"lowerInclusive": number,
"upperInclusive": number
}
],
"lambdaFunctionExecutionRoleArn": [
{
"comparison": "string",
"value": "string"
}
],
"lambdaFunctionLastModifiedAt": [
{
"endInclusive": number,
"startInclusive": number
}
],
"lambdaFunctionLayers": [
{
"comparison": "string",
"value": "string"
}
],
"lambdaFunctionName": [
{
"comparison": "string",
"value": "string"
}
],
"lambdaFunctionRuntime": [
{
"comparison": "string",
"value": "string"
}
],
"lastObservedAt": [
{
"endInclusive": number,
"startInclusive": number
}
],
"networkProtocol": [
{
"comparison": "string",
"value": "string"
}
],
"portRange": [
{
"beginInclusive": number,
"endInclusive": number
}
],
"relatedVulnerabilities": [
{
"comparison": "string",
"value": "string"
}
],
"resourceId": [
{
"comparison": "string",
"value": "string"
}
],
"resourceTags": [
{
"comparison": "string",
"key": "string",
"value": "string"
}
],
"resourceType": [
{
"comparison": "string",
"value": "string"
}
],
"severity": [
{
"comparison": "string",
"value": "string"
}
],
"title": [
{
"comparison": "string",
"value": "string"
}
],
"updatedAt": [
{
"endInclusive": number,
"startInclusive": number
}
],
"vendorSeverity": [
{
"comparison": "string",
"value": "string"
}
],
"vulnerabilityId": [
{
"comparison": "string",
"value": "string"
}
],
"vulnerabilitySource": [
{
"comparison": "string",
"value": "string"
}
],
"vulnerablePackages": [
{
"architecture": {
"comparison": "string",
"value": "string"
},
"epoch": {
"lowerInclusive": number,
"upperInclusive": number
},
"filePath": {
"comparison": "string",
"value": "string"
},
"name": {
"comparison": "string",
"value": "string"
},
"release": {
"comparison": "string",
"value": "string"
},
"sourceLambdaLayerArn": {
"comparison": "string",
"value": "string"
},
"sourceLayerHash": {
"comparison": "string",
"value": "string"
},
"version": {
"comparison": "string",
"value": "string"
}
}
]
},
"maxResults": number,
"nextToken": "string",
"sortCriteria": {
"field": "string",
"sortOrder": "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filterCriteria
-
Details on the filters to apply to your finding results.
Type: FilterCriteria object
Required: No
- maxResults
-
The maximum number of results the response can return. If your request would return more than the maximum the response will return a
nextTokenvalue, use this value when you call the action again to get the remaining results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the
maxResultsmaximum value it will also return anextTokenvalue. For subsequent calls, use thenextTokenvalue returned from the previous request to continue listing results after the first page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
- sortCriteria
-
Details on the sort criteria to apply to your finding results.
Type: SortCriteria object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"findings": [
{
"awsAccountId": "string",
"codeVulnerabilityDetails": {
"cwes": [ "string" ],
"detectorId": "string",
"detectorName": "string",
"detectorTags": [ "string" ],
"filePath": {
"endLine": number,
"fileName": "string",
"filePath": "string",
"startLine": number
},
"referenceUrls": [ "string" ],
"ruleId": "string",
"sourceLambdaLayerArn": "string"
},
"description": "string",
"epss": {
"score": number
},
"exploitabilityDetails": {
"lastKnownExploitAt": number
},
"exploitAvailable": "string",
"findingArn": "string",
"firstObservedAt": number,
"fixAvailable": "string",
"inspectorScore": number,
"inspectorScoreDetails": {
"adjustedCvss": {
"adjustments": [
{
"metric": "string",
"reason": "string"
}
],
"cvssSource": "string",
"score": number,
"scoreSource": "string",
"scoringVector": "string",
"version": "string"
}
},
"lastObservedAt": number,
"networkReachabilityDetails": {
"networkPath": {
"steps": [
{
"componentArn": "string",
"componentId": "string",
"componentType": "string"
}
]
},
"openPortRange": {
"begin": number,
"end": number
},
"protocol": "string"
},
"packageVulnerabilityDetails": {
"cvss": [
{
"baseScore": number,
"scoringVector": "string",
"source": "string",
"version": "string"
}
],
"referenceUrls": [ "string" ],
"relatedVulnerabilities": [ "string" ],
"source": "string",
"sourceUrl": "string",
"vendorCreatedAt": number,
"vendorSeverity": "string",
"vendorUpdatedAt": number,
"vulnerabilityId": "string",
"vulnerablePackages": [
{
"arch": "string",
"epoch": number,
"filePath": "string",
"fixedInVersion": "string",
"name": "string",
"packageManager": "string",
"release": "string",
"remediation": "string",
"sourceLambdaLayerArn": "string",
"sourceLayerHash": "string",
"version": "string"
}
]
},
"remediation": {
"recommendation": {
"text": "string",
"Url": "string"
}
},
"resources": [
{
"details": {
"awsEc2Instance": {
"iamInstanceProfileArn": "string",
"imageId": "string",
"ipV4Addresses": [ "string" ],
"ipV6Addresses": [ "string" ],
"keyName": "string",
"launchedAt": number,
"platform": "string",
"subnetId": "string",
"type": "string",
"vpcId": "string"
},
"awsEcrContainerImage": {
"architecture": "string",
"author": "string",
"imageHash": "string",
"imageTags": [ "string" ],
"platform": "string",
"pushedAt": number,
"registry": "string",
"repositoryName": "string"
},
"awsLambdaFunction": {
"architectures": [ "string" ],
"codeSha256": "string",
"executionRoleArn": "string",
"functionName": "string",
"lastModifiedAt": number,
"layers": [ "string" ],
"packageType": "string",
"runtime": "string",
"version": "string",
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ],
"vpcId": "string"
}
}
},
"id": "string",
"partition": "string",
"region": "string",
"tags": {
"string" : "string"
},
"type": "string"
}
],
"severity": "string",
"status": "string",
"title": "string",
"type": "string",
"updatedAt": number
}
],
"nextToken": "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.
- findings
-
Contains details on the findings in your environment.
Type: Array of Finding objects
Array Members: Minimum number of 0 items. Maximum number of 25 items.
- nextToken
-
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the
NextTokenvalue returned from the previous request to continue listing results after the first page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The request has failed due to an internal failure of the Amazon Inspector service.
HTTP Status Code: 500
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The request has failed validation due to missing required fields or having invalid inputs.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
