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

************************************
ListCisScanResultsAggregatedByChecks
************************************



.. py:class:: Inspector2.Paginator.ListCisScanResultsAggregatedByChecks

  ::

    
    paginator = client.get_paginator('list_cis_scan_results_aggregated_by_checks')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          scanArn='string',
          filterCriteria={
              'accountIdFilters': [
                  {
                      'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                      'value': 'string'
                  },
              ],
              'checkIdFilters': [
                  {
                      'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                      'value': 'string'
                  },
              ],
              'titleFilters': [
                  {
                      'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                      'value': 'string'
                  },
              ],
              'platformFilters': [
                  {
                      'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                      'value': 'string'
                  },
              ],
              'failedResourcesFilters': [
                  {
                      'upperInclusive': 123,
                      'lowerInclusive': 123
                  },
              ],
              'securityLevelFilters': [
                  {
                      'comparison': 'EQUALS',
                      'value': 'LEVEL_1'|'LEVEL_2'
                  },
              ]
          },
          sortBy='CHECK_ID'|'TITLE'|'PLATFORM'|'FAILED_COUNTS'|'SECURITY_LEVEL',
          sortOrder='ASC'|'DESC',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type scanArn: string
    :param scanArn: **[REQUIRED]** 

      The scan ARN.

      

    
    :type filterCriteria: dict
    :param filterCriteria: 

      The filter criteria.

      

    
      - **accountIdFilters** *(list) --* 

        The criteria's 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.

            

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

            

          
        
    
      - **platformFilters** *(list) --* 

        The criteria's platform 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.

            

          
        
    
      - **failedResourcesFilters** *(list) --* 

        The criteria's failed resources filters.

        

      
        - *(dict) --* 

          The CIS number filter.

          

        
          - **upperInclusive** *(integer) --* 

            The CIS number filter's upper inclusive.

            

          
          - **lowerInclusive** *(integer) --* 

            The CIS number filter's lower inclusive.

            

          
        
    
      - **securityLevelFilters** *(list) --* 

        The criteria's security level filters.

        

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

            

          
        
    
    
    :type sortBy: string
    :param sortBy: 

      The sort by order.

      

    
    :type sortOrder: string
    :param sortOrder: 

      The sort 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**

      
      ::

        {
            'checkAggregations': [
                {
                    'scanArn': 'string',
                    'checkId': 'string',
                    'title': 'string',
                    'checkDescription': 'string',
                    'level': 'LEVEL_1'|'LEVEL_2',
                    'accountId': 'string',
                    'statusCounts': {
                        'failed': 123,
                        'skipped': 123,
                        'passed': 123
                    },
                    'platform': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **checkAggregations** *(list) --* 

          The check aggregations.

          
          

          - *(dict) --* 

            A CIS check.

            
            

            - **scanArn** *(string) --* 

              The scan ARN for the CIS check scan ARN.

              
            

            - **checkId** *(string) --* 

              The check ID for the CIS check.

              
            

            - **title** *(string) --* 

              The CIS check title.

              
            

            - **checkDescription** *(string) --* 

              The description for the CIS check.

              
            

            - **level** *(string) --* 

              The CIS check level.

              
            

            - **accountId** *(string) --* 

              The account ID for the CIS check.

              
            

            - **statusCounts** *(dict) --* 

              The CIS check status counts.

              
              

              - **failed** *(integer) --* 

                The number of checks that failed.

                
              

              - **skipped** *(integer) --* 

                The number of checks that were skipped.

                
              

              - **passed** *(integer) --* 

                The number of checks that passed.

                
          
            

            - **platform** *(string) --* 

              The CIS check platform.

              
        
      
        

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

          A token to resume pagination.

          
    