Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListImageScanFindingAggregations

Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.

To streamline results, you can use the following filters in your request:

accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId

Request Syntax


POST /ListImageScanFindingAggregations HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "name": "string",
      "values": [ "string" ]
   },
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filter

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Type: Filter object

Required: No

nextToken

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "aggregationType": "string",
   "nextToken": "string",
   "requestId": "string",
   "responses": [ 
      { 
         "accountAggregation": { 
            "accountId": "string",
            "severityCounts": { 
               "all": number,
               "critical": number,
               "high": number,
               "medium": number
            }
         },
         "imageAggregation": { 
            "imageBuildVersionArn": "string",
            "severityCounts": { 
               "all": number,
               "critical": number,
               "high": number,
               "medium": number
            }
         },
         "imagePipelineAggregation": { 
            "imagePipelineArn": "string",
            "severityCounts": { 
               "all": number,
               "critical": number,
               "high": number,
               "medium": number
            }
         },
         "vulnerabilityIdAggregation": { 
            "severityCounts": { 
               "all": number,
               "critical": number,
               "high": number,
               "medium": number
            },
            "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 aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn't specify a filter in the request, the type defaults to accountId.

Aggregation types

accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId

Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

nextToken

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

requestId

The request ID that uniquely identifies this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

responses

An array of image scan finding aggregations that match the filter criteria.

Type: Array of ImageScanFindingAggregation objects

Errors

For information about the errors that are common to all actions, see Common Errors.

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

InvalidPaginationTokenException

You have provided an invalid pagination token in your request.

HTTP Status Code: 400

InvalidRequestException

You have requested an action that that the service doesn't support.

HTTP Status Code: 400

ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503