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

ListCisScanResultsAggregatedByChecks

Lists scan results aggregated by checks.

Request Syntax


POST /cis/scan-result/check/list HTTP/1.1
Content-type: application/json

{
   "filterCriteria": { 
      "accountIdFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "checkIdFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "failedResourcesFilters": [ 
         { 
            "lowerInclusive": number,
            "upperInclusive": number
         }
      ],
      "platformFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "securityLevelFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "titleFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ]
   },
   "maxResults": number,
   "nextToken": "string",
   "scanArn": "string",
   "sortBy": "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

The filter criteria.

Type: CisScanResultsAggregatedByChecksFilterCriteria object

Required: No

maxResults

The maximum number of scan results aggregated by checks to be returned in a single page of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token from a previous request that's used to retrieve the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000000.

Required: No

scanArn

The scan ARN.

Type: String

Pattern: arn:aws(-us-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/cis-scan/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

sortBy

The sort by order.

Type: String

Valid Values: CHECK_ID | TITLE | PLATFORM | FAILED_COUNTS | SECURITY_LEVEL

Required: No

sortOrder

The sort order.

Type: String

Valid Values: ASC | DESC

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "checkAggregations": [ 
      { 
         "accountId": "string",
         "checkDescription": "string",
         "checkId": "string",
         "level": "string",
         "platform": "string",
         "scanArn": "string",
         "statusCounts": { 
            "failed": number,
            "passed": number,
            "skipped": number
         },
         "title": "string"
      }
   ],
   "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.

checkAggregations

The check aggregations.

Type: Array of CisCheckAggregation objects

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

nextToken

The pagination token from a previous request that's used to retrieve the next page of results.

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.

AccessDeniedException

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported AWS Region.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400