:doc:`Inspector2 <../../inspector2>` / Paginator / ListCisScanConfigurations

*************************
ListCisScanConfigurations
*************************



.. py:class:: Inspector2.Paginator.ListCisScanConfigurations

  ::

    
    paginator = client.get_paginator('list_cis_scan_configurations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Inspector2.Client.list_cis_scan_configurations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/ListCisScanConfigurations>`_    


    **Request Syntax**
    ::

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

      The CIS scan configuration filter criteria.

      

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

            

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

            

          
        
    
    
    :type sortBy: string
    :param sortBy: 

      The CIS scan configuration sort by order.

      

    
    :type sortOrder: string
    :param sortOrder: 

      The CIS scan configuration sort order order.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

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

      

      - *(dict) --* 
        

        - **scanConfigurations** *(list) --* 

          The CIS scan configuration scan configurations.

          
          

          - *(dict) --* 

            The CIS scan configuration.

            
            

            - **scanConfigurationArn** *(string) --* 

              The CIS scan configuration's scan configuration ARN.

              
            

            - **ownerId** *(string) --* 

              The CIS scan configuration's owner ID.

              
            

            - **scanName** *(string) --* 

              The name of the CIS scan configuration.

              
            

            - **securityLevel** *(string) --* 

              The CIS scan configuration's security level.

              
            

            - **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: ``oneTime``, ``daily``, ``weekly``, ``monthly``.     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'}


            
              

              - **oneTime** *(dict) --* 

                The schedule's one time.

                
            
              

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

                    
              
            
              

              - **weekly** *(dict) --* 

                The schedule's weekly.

                
                

                - **startTime** *(dict) --* 

                  The weekly schedule's start time.

                  
                  

                  - **timeOfDay** *(string) --* 

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

                    
                  

                  - **timezone** *(string) --* 

                    The timezone.

                    
              
                

                - **days** *(list) --* 

                  The weekly schedule's days.

                  
                  

                  - *(string) --* 
              
            
              

              - **monthly** *(dict) --* 

                The schedule's monthly.

                
                

                - **startTime** *(dict) --* 

                  The monthly schedule's start time.

                  
                  

                  - **timeOfDay** *(string) --* 

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

                    
                  

                  - **timezone** *(string) --* 

                    The timezone.

                    
              
                

                - **day** *(string) --* 

                  The monthly schedule's day.

                  
            
          
            

            - **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) --* 
                
            
          
          
            

            - **tags** *(dict) --* 

              The CIS scan configuration's tags.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    