Inspector2 / Client / get_cis_scan_result_details

get_cis_scan_result_details¶

Inspector2.Client.get_cis_scan_result_details(**kwargs)¶

Retrieves CIS scan result details.

Request Syntax

response = client.get_cis_scan_result_details(
    scanArn='string',
    targetResourceId='string',
    accountId='string',
    filterCriteria={
        'findingStatusFilters': [
            {
                'comparison': 'EQUALS',
                'value': 'PASSED'|'FAILED'|'SKIPPED'
            },
        ],
        'checkIdFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'titleFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'securityLevelFilters': [
            {
                'comparison': 'EQUALS',
                'value': 'LEVEL_1'|'LEVEL_2'
            },
        ],
        'findingArnFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ]
    },
    sortBy='CHECK_ID'|'STATUS',
    sortOrder='ASC'|'DESC',
    nextToken='string',
    maxResults=123
)

Parameters:

scanArn (string) –
[REQUIRED]

The scan ARN.
targetResourceId (string) –
[REQUIRED]

The target resource ID.
accountId (string) –
[REQUIRED]

The account ID.
filterCriteria (dict) –
The filter criteria.
- findingStatusFilters (list) –
  
  The criteria’s finding status filters.
  - (dict) –
    
    The CIS finding status filter.
    - comparison (string) – [REQUIRED]
      
      The comparison value of the CIS finding status filter.
    - value (string) – [REQUIRED]
      
      The value of the CIS finding status 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.
- 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.
- securityLevelFilters (list) –
  
  The criteria’s security level filters. . Security level refers to the Benchmark levels that CIS assigns to a profile.
  - (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.
- findingArnFilters (list) –
  
  The criteria’s finding ARN 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.
sortBy (string) – The sort by order.
sortOrder (string) – The sort order.
nextToken (string) – The pagination token from a previous request that’s used to retrieve the next page of results.
maxResults (integer) – The maximum number of CIS scan result details to be returned in a single page of results.

Return type:

dict

Returns:

Response Syntax

{
    'scanResultDetails': [
        {
            'scanArn': 'string',
            'accountId': 'string',
            'targetResourceId': 'string',
            'platform': 'string',
            'status': 'PASSED'|'FAILED'|'SKIPPED',
            'statusReason': 'string',
            'checkId': 'string',
            'title': 'string',
            'checkDescription': 'string',
            'remediation': 'string',
            'level': 'LEVEL_1'|'LEVEL_2',
            'findingArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- scanResultDetails (list) –
  
  The scan result details.
  - (dict) –
    
    The CIS scan result details.
    - scanArn (string) –
      
      The CIS scan result details’ scan ARN.
    - accountId (string) –
      
      The CIS scan result details’ account ID.
    - targetResourceId (string) –
      
      The CIS scan result details’ target resource ID.
    - platform (string) –
      
      The CIS scan result details’ platform.
    - status (string) –
      
      The CIS scan result details’ status.
    - statusReason (string) –
      
      The CIS scan result details’ status reason.
    - checkId (string) –
      
      The CIS scan result details’ check ID.
    - title (string) –
      
      The CIS scan result details’ title.
    - checkDescription (string) –
      
      The account ID that’s associated with the CIS scan result details.
    - remediation (string) –
      
      The CIS scan result details’ remediation.
    - level (string) –
      
      The CIS scan result details’ level.
    - findingArn (string) –
      
      The CIS scan result details’ finding ARN.
- nextToken (string) –
  
  The pagination token from a previous request that’s used to retrieve the next page of results.

get_cis_scan_result_details¶

Request Syntax

Response Syntax

Response Structure

Exceptions