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.

See also: AWS API Documentation

Request Syntax

response = client.get_cis_scan_result_details(
    accountId='string',
    filterCriteria={
        'checkIdFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingArnFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'findingStatusFilters': [
            {
                'comparison': 'EQUALS',
                'value': 'PASSED'|'FAILED'|'SKIPPED'
            },
        ],
        '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'|'STATUS',
    sortOrder='ASC'|'DESC',
    targetResourceId='string'
)

Parameters:

• accountId (string) –

  [REQUIRED]

  The account ID.

• filterCriteria (dict) –

  The filter criteria.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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 CIS scan result details 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.

• targetResourceId (string) –

  [REQUIRED]

  The target resource ID.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • nextToken (string) –

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

  • scanResultDetails (list) –

    The scan result details.

    • (dict) –

      The CIS scan result details.

      • accountId (string) –

        The CIS scan result details’ account ID.

      • checkDescription (string) –

        The account ID that’s associated with the CIS scan result details.

      • checkId (string) –

        The CIS scan result details’ check ID.

      • findingArn (string) –

        The CIS scan result details’ finding ARN.

      • level (string) –

        The CIS scan result details’ level.

      • platform (string) –

        The CIS scan result details’ platform.

      • remediation (string) –

        The CIS scan result details’ remediation.

      • scanArn (string) –

        The CIS scan result details’ scan ARN.

      • status (string) –

        The CIS scan result details’ status.

      • statusReason (string) –

        The CIS scan result details’ status reason.

      • targetResourceId (string) –

        The CIS scan result details’ target resource ID.

      • title (string) –

        The CIS scan result details’ title.

Exceptions

• Inspector2.Client.exceptions.AccessDeniedException

• Inspector2.Client.exceptions.ValidationException

• Inspector2.Client.exceptions.ThrottlingException

• Inspector2.Client.exceptions.InternalServerException