Inspector2 / Paginator / ListCisScanConfigurations

ListCisScanConfigurations

class Inspector2.Paginator.ListCisScanConfigurations

paginator = client.get_paginator('list_cis_scan_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Inspector2.Client.list_cis_scan_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filterCriteria={
        'scanConfigurationArnFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanNameFilters': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'targetResourceTagFilters': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ]
    },
    sortBy='SCAN_NAME'|'SCAN_CONFIGURATION_ARN',
    sortOrder='ASC'|'DESC',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filterCriteria (dict) –

  The CIS scan configuration filter criteria.

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

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

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

• sortOrder (string) – The CIS scan configuration sort order order.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'scanConfigurations': [
        {
            'ownerId': 'string',
            'scanConfigurationArn': 'string',
            'scanName': 'string',
            'schedule': {
                'daily': {
                    'startTime': {
                        'timeOfDay': 'string',
                        'timezone': 'string'
                    }
                },
                'monthly': {
                    'day': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
                    'startTime': {
                        'timeOfDay': 'string',
                        'timezone': 'string'
                    }
                },
                'oneTime': {},
                'weekly': {
                    'days': [
                        'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
                    ],
                    'startTime': {
                        'timeOfDay': 'string',
                        'timezone': 'string'
                    }
                }
            },
            'securityLevel': 'LEVEL_1'|'LEVEL_2',
            'tags': {
                'string': 'string'
            },
            'targets': {
                'accountIds': [
                    'string',
                ],
                'targetResourceTags': {
                    'string': [
                        'string',
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • scanConfigurations (list) –

    The CIS scan configuration scan configurations.

    • (dict) –

      The CIS scan configuration.

      • ownerId (string) –

        The CIS scan configuration’s owner ID.

      • scanConfigurationArn (string) –

        The CIS scan configuration’s scan configuration ARN.

      • scanName (string) –

        The name of the CIS scan configuration.

      • schedule (dict) –

        The CIS scan configuration’s schedule.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: daily, monthly, oneTime, weekly. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • daily (dict) –

          The schedule’s daily.

          • startTime (dict) –

            The schedule start time.

            • timeOfDay (string) –

              The time of day in 24-hour format (00:00).

            • timezone (string) –

              The timezone.

        • monthly (dict) –

          The schedule’s monthly.

          • day (string) –

            The monthly schedule’s day.

          • startTime (dict) –

            The monthly schedule’s start time.

            • timeOfDay (string) –

              The time of day in 24-hour format (00:00).

            • timezone (string) –

              The timezone.

        • oneTime (dict) –

          The schedule’s one time.

        • weekly (dict) –

          The schedule’s weekly.

          • days (list) –

            The weekly schedule’s days.

            • (string) –

          • startTime (dict) –

            The weekly schedule’s start time.

            • timeOfDay (string) –

              The time of day in 24-hour format (00:00).

            • timezone (string) –

              The timezone.

      • securityLevel (string) –

        The CIS scan configuration’s security level.

      • tags (dict) –

        The CIS scan configuration’s tags.

        • (string) –

          • (string) –

      • targets (dict) –

        The CIS scan configuration’s targets.

        • accountIds (list) –

          The CIS target account ids.

          • (string) –

        • targetResourceTags (dict) –

          The CIS target resource tags.

          • (string) –

            • (list) –

              • (string) –

  • NextToken (string) –

    A token to resume pagination.