Inspector2 / Client / list_cis_scan_results_aggregated_by_checks
list_cis_scan_results_aggregated_by_checks#
- Inspector2.Client.list_cis_scan_results_aggregated_by_checks(**kwargs)#
Lists scan results aggregated by checks.
See also: AWS API Documentation
Request Syntax
response = client.list_cis_scan_results_aggregated_by_checks( filterCriteria={ 'accountIdFilters': [ { 'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS', 'value': 'string' }, ], 'checkIdFilters': [ { 'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS', 'value': 'string' }, ], 'failedResourcesFilters': [ { 'lowerInclusive': 123, 'upperInclusive': 123 }, ], 'platformFilters': [ { 'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS', 'value': 'string' }, ], 'securityLevelFilters': [ { 'comparison': 'EQUALS', 'value': 'LEVEL_1'|'LEVEL_2' }, ], 'titleFilters': [ { 'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS', 'value': 'string' }, ] }, maxResults=123, nextToken='string', scanArn='string', sortBy='CHECK_ID'|'TITLE'|'PLATFORM'|'FAILED_COUNTS'|'SECURITY_LEVEL', sortOrder='ASC'|'DESC' )
- Parameters:
filterCriteria (dict) –
The filter criteria.
accountIdFilters (list) –
The criteria’s account ID filters.
(dict) –
The CIS string filter.
comparison (string) – [REQUIRED]
The comparison value of the CIS string filter.
value (string) – [REQUIRED]
The value of the CIS string filter.
checkIdFilters (list) –
The criteria’s check ID filters.
(dict) –
The CIS string filter.
comparison (string) – [REQUIRED]
The comparison value of the CIS string filter.
value (string) – [REQUIRED]
The value of the CIS string filter.
failedResourcesFilters (list) –
The criteria’s failed resources filters.
(dict) –
The CIS number filter.
lowerInclusive (integer) –
The CIS number filter’s lower inclusive.
upperInclusive (integer) –
The CIS number filter’s upper inclusive.
platformFilters (list) –
The criteria’s platform filters.
(dict) –
The CIS string filter.
comparison (string) – [REQUIRED]
The comparison value of the CIS string filter.
value (string) – [REQUIRED]
The value of the CIS string filter.
securityLevelFilters (list) –
The criteria’s security level filters.
(dict) –
The CIS security level filter. Security level refers to the Benchmark levels that CIS assigns to a profile.
comparison (string) – [REQUIRED]
The CIS security filter comparison value.
value (string) – [REQUIRED]
The CIS security filter value.
titleFilters (list) –
The criteria’s title filters.
(dict) –
The CIS string filter.
comparison (string) – [REQUIRED]
The comparison value of the CIS string filter.
value (string) – [REQUIRED]
The value of the CIS string filter.
maxResults (integer) – The maximum number of scan results aggregated by checks to be returned in a single page of results.
nextToken (string) – The pagination token from a previous request that’s used to retrieve the next page of results.
scanArn (string) –
[REQUIRED]
The scan ARN.
sortBy (string) – The sort by order.
sortOrder (string) – The sort order.
- Return type:
dict
- Returns:
Response Syntax
{ 'checkAggregations': [ { 'accountId': 'string', 'checkDescription': 'string', 'checkId': 'string', 'level': 'LEVEL_1'|'LEVEL_2', 'platform': 'string', 'scanArn': 'string', 'statusCounts': { 'failed': 123, 'passed': 123, 'skipped': 123 }, 'title': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
checkAggregations (list) –
The check aggregations.
(dict) –
A CIS check.
accountId (string) –
The account ID for the CIS check.
checkDescription (string) –
The description for the CIS check.
checkId (string) –
The check ID for the CIS check.
level (string) –
The CIS check level.
platform (string) –
The CIS check platform.
scanArn (string) –
The scan ARN for the CIS check scan ARN.
statusCounts (dict) –
The CIS check status counts.
failed (integer) –
The number of checks that failed.
passed (integer) –
The number of checks that passed.
skipped (integer) –
The number of checks that were skipped.
title (string) –
The CIS check title.
nextToken (string) –
The pagination token from a previous request that’s used to retrieve the next page of results.
Exceptions
Inspector2.Client.exceptions.AccessDeniedException
Inspector2.Client.exceptions.ValidationException
Inspector2.Client.exceptions.ThrottlingException
Inspector2.Client.exceptions.InternalServerException