ListCoverageStatistics - Inspector

ListCoverageStatistics

Lists Amazon Inspector coverage statistics for your environment.

Request Syntax

POST /coverage/statistics/list HTTP/1.1 Content-type: application/json { "filterCriteria": { "accountId": [ { "comparison": "string", "value": "string" } ], "ec2InstanceTags": [ { "comparison": "string", "key": "string", "value": "string" } ], "ecrImageTags": [ { "comparison": "string", "value": "string" } ], "ecrRepositoryName": [ { "comparison": "string", "value": "string" } ], "resourceId": [ { "comparison": "string", "value": "string" } ], "resourceType": [ { "comparison": "string", "value": "string" } ], "scanStatusCode": [ { "comparison": "string", "value": "string" } ], "scanStatusReason": [ { "comparison": "string", "value": "string" } ], "scanType": [ { "comparison": "string", "value": "string" } ] }, "groupBy": "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.

filterCriteria

An object that contains details on the filters to apply to the coverage data for your environment.

Type: CoverageFilterCriteria object

Required: No

groupBy

The value to group the results by.

Type: String

Valid Values: SCAN_STATUS_CODE | SCAN_STATUS_REASON | ACCOUNT_ID | RESOURCE_TYPE | ECR_REPOSITORY_NAME

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 { "countsByGroup": [ { "count": number, "groupKey": "string" } ], "nextToken": "string", "totalCounts": number }

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.

countsByGroup

An array with the number for each group.

Type: Array of Counts objects

Array Members: Minimum number of 1 item. Maximum number of 5 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 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.

totalCounts

The total number for all groups.

Type: Long

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: