ListFindingAggregations - Inspector

ListFindingAggregations

Lists aggregated finding data for your environment based on specific criteria.

Request Syntax

POST /findings/aggregation/list HTTP/1.1 Content-type: application/json { "accountIds": [ { "comparison": "string", "value": "string" } ], "aggregationRequest": { "accountAggregation": { "findingType": "string", "resourceType": "string", "sortBy": "string", "sortOrder": "string" }, "amiAggregation": { "amis": [ { "comparison": "string", "value": "string" } ], "sortBy": "string", "sortOrder": "string" }, "awsEcrContainerAggregation": { "architectures": [ { "comparison": "string", "value": "string" } ], "imageShas": [ { "comparison": "string", "value": "string" } ], "imageTags": [ { "comparison": "string", "value": "string" } ], "repositories": [ { "comparison": "string", "value": "string" } ], "resourceIds": [ { "comparison": "string", "value": "string" } ], "sortBy": "string", "sortOrder": "string" }, "ec2InstanceAggregation": { "amis": [ { "comparison": "string", "value": "string" } ], "instanceIds": [ { "comparison": "string", "value": "string" } ], "instanceTags": [ { "comparison": "string", "key": "string", "value": "string" } ], "operatingSystems": [ { "comparison": "string", "value": "string" } ], "sortBy": "string", "sortOrder": "string" }, "findingTypeAggregation": { "findingType": "string", "resourceType": "string", "sortBy": "string", "sortOrder": "string" }, "imageLayerAggregation": { "layerHashes": [ { "comparison": "string", "value": "string" } ], "repositories": [ { "comparison": "string", "value": "string" } ], "resourceIds": [ { "comparison": "string", "value": "string" } ], "sortBy": "string", "sortOrder": "string" }, "packageAggregation": { "packageNames": [ { "comparison": "string", "value": "string" } ], "sortBy": "string", "sortOrder": "string" }, "repositoryAggregation": { "repositories": [ { "comparison": "string", "value": "string" } ], "sortBy": "string", "sortOrder": "string" }, "titleAggregation": { "resourceType": "string", "sortBy": "string", "sortOrder": "string", "titles": [ { "comparison": "string", "value": "string" } ], "vulnerabilityIds": [ { "comparison": "string", "value": "string" } ] } }, "aggregationType": "string", "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountIds

The AWS account IDs to retrieve finding aggregation data for.

Type: Array of StringFilter objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

aggregationRequest

Details of the aggregation request that is used to filter your aggregation results.

Type: AggregationRequest object

Required: No

aggregationType

The type of the aggregation request.

Type: String

Valid Values: FINDING_TYPE | PACKAGE | TITLE | REPOSITORY | AMI | AWS_EC2_INSTANCE | AWS_ECR_CONTAINER | IMAGE_LAYER | ACCOUNT

Required: Yes

maxResults

The maximum number of results to return in the response.

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. For subsequent calls, use the NextToken value 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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "aggregationType": "string", "nextToken": "string", "responses": [ { "accountAggregation": { "accountId": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "amiAggregation": { "accountId": "string", "affectedInstances": number, "ami": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "awsEcrContainerAggregation": { "accountId": "string", "architecture": "string", "imageSha": "string", "imageTags": [ "string" ], "repository": "string", "resourceId": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "ec2InstanceAggregation": { "accountId": "string", "ami": "string", "instanceId": "string", "instanceTags": { "string" : "string" }, "networkFindings": number, "operatingSystem": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "findingTypeAggregation": { "accountId": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "imageLayerAggregation": { "accountId": "string", "layerHash": "string", "repository": "string", "resourceId": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "packageAggregation": { "accountId": "string", "packageName": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "repositoryAggregation": { "accountId": "string", "affectedImages": number, "repository": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number } }, "titleAggregation": { "accountId": "string", "severityCounts": { "all": number, "critical": number, "high": number, "medium": number }, "title": "string", "vulnerabilityId": "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.

aggregationType

The type of aggregation to perform.

Type: String

Valid Values: FINDING_TYPE | PACKAGE | TITLE | REPOSITORY | AMI | AWS_EC2_INSTANCE | AWS_ECR_CONTAINER | IMAGE_LAYER | ACCOUNT

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 NextToken value 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.

responses

Objects that contain the results of an aggregation operation.

Type: Array of AggregationResponse objects

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: