Inspector2 / Client / list_cis_scans

list_cis_scans

Inspector2.Client.list_cis_scans(**kwargs)

Returns a CIS scan list.

See also: AWS API Documentation

Request Syntax

response = client.list_cis_scans(
    detailLevel='ORGANIZATION'|'MEMBER',
    filterCriteria={
        'failedChecksFilters': [
            {
                'lowerInclusive': 123,
                'upperInclusive': 123
            },
        ],
        'scanArnFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanAtFilters': [
            {
                'earliestScanStartTime': datetime(2015, 1, 1),
                'latestScanStartTime': datetime(2015, 1, 1)
            },
        ],
        'scanConfigurationArnFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanNameFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusFilters': [
            {
                'comparison': 'EQUALS',
                'value': 'FAILED'|'COMPLETED'|'CANCELLED'|'IN_PROGRESS'
            },
        ],
        'scheduledByFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'targetAccountIdFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'targetResourceIdFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'targetResourceTagFilters': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ]
    },
    maxResults=123,
    nextToken='string',
    sortBy='STATUS'|'SCHEDULED_BY'|'SCAN_START_DATE'|'FAILED_CHECKS',
    sortOrder='ASC'|'DESC'
)

Parameters:

• detailLevel (string) – The detail applied to the CIS scan.

• filterCriteria (dict) –

  The CIS scan filter criteria.

  • failedChecksFilters (list) –

    The list of failed checks filters.

    • (dict) –

      The CIS number filter.

      • lowerInclusive (integer) –

        The CIS number filter’s lower inclusive.

      • upperInclusive (integer) –

        The CIS number filter’s upper inclusive.

  • scanArnFilters (list) –

    The list of scan 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.

  • scanAtFilters (list) –

    The list of scan at filters.

    • (dict) –

      The CIS date filter.

      • earliestScanStartTime (datetime) –

        The CIS date filter’s earliest scan start time.

      • latestScanStartTime (datetime) –

        The CIS date filter’s latest scan start time.

  • scanConfigurationArnFilters (list) –

    The list of scan configuration 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.

  • scanNameFilters (list) –

    The list of scan name 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.

  • scanStatusFilters (list) –

    The list of scan status filters.

    • (dict) –

      The CIS scan status filter.

      • comparison (string) – [REQUIRED]

        The filter comparison value.

      • value (string) – [REQUIRED]

        The filter value.

  • scheduledByFilters (list) –

    The list of scheduled by 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.

  • targetAccountIdFilters (list) –

    The list of target 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.

  • targetResourceIdFilters (list) –

    The list of target resource 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.

  • targetResourceTagFilters (list) –

    The list of target resource tag filters.

    • (dict) –

      The tag filter.

      • comparison (string) – [REQUIRED]

        The tag filter comparison value.

      • key (string) – [REQUIRED]

        The tag filter key.

      • value (string) – [REQUIRED]

        The tag filter value.

• maxResults (integer) – The maximum number of results to be returned.

• nextToken (string) – The pagination token from a previous request that’s used to retrieve the next page of results.

• sortBy (string) – The CIS scans sort by order.

• sortOrder (string) – The CIS scans sort order.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'scans': [
        {
            'failedChecks': 123,
            'scanArn': 'string',
            'scanConfigurationArn': 'string',
            'scanDate': datetime(2015, 1, 1),
            'scanName': 'string',
            'scheduledBy': 'string',
            'securityLevel': 'LEVEL_1'|'LEVEL_2',
            'status': 'FAILED'|'COMPLETED'|'CANCELLED'|'IN_PROGRESS',
            'targets': {
                'accountIds': [
                    'string',
                ],
                'targetResourceTags': {
                    'string': [
                        'string',
                    ]
                }
            },
            'totalChecks': 123
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

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

  • scans (list) –

    The CIS scans.

    • (dict) –

      The CIS scan.

      • failedChecks (integer) –

        The CIS scan’s failed checks.

      • scanArn (string) –

        The CIS scan’s ARN.

      • scanConfigurationArn (string) –

        The CIS scan’s configuration ARN.

      • scanDate (datetime) –

        The CIS scan’s date.

      • scanName (string) –

        The the name of the scan configuration that’s associated with this scan.

      • scheduledBy (string) –

        The account or organization that schedules the CIS scan.

      • securityLevel (string) –

        The security level for the CIS scan. Security level refers to the Benchmark levels that CIS assigns to a profile.

      • status (string) –

        The CIS scan’s status.

      • targets (dict) –

        The CIS scan’s targets.

        • accountIds (list) –

          The CIS target account ids.

          • (string) –

        • targetResourceTags (dict) –

          The CIS target resource tags.

          • (string) –

            • (list) –

              • (string) –

      • totalChecks (integer) –

        The CIS scan’s total checks.

Exceptions

• Inspector2.Client.exceptions.AccessDeniedException

• Inspector2.Client.exceptions.ValidationException

• Inspector2.Client.exceptions.ThrottlingException

• Inspector2.Client.exceptions.InternalServerException