:doc:`SsmSap <../../ssm-sap>` / Paginator / ListSubCheckRuleResults

***********************
ListSubCheckRuleResults
***********************



.. py:class:: SsmSap.Paginator.ListSubCheckRuleResults

  ::

    
    paginator = client.get_paginator('list_sub_check_rule_results')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SsmSap.Client.list_sub_check_rule_results`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/ListSubCheckRuleResults>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SubCheckResultId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SubCheckResultId: string
    :param SubCheckResultId: **[REQUIRED]** 

      The ID of the sub check result.

      

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

      
      ::

        {
            'RuleResults': [
                {
                    'Id': 'string',
                    'Description': 'string',
                    'Status': 'PASSED'|'FAILED'|'WARNING'|'INFO'|'UNKNOWN',
                    'Message': 'string',
                    'Metadata': {
                        'string': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **RuleResults** *(list) --* 

          The rule results of a sub-check belonging to a configuration check operation.

          
          

          - *(dict) --* 

            Represents the result of a single rule within a configuration check.

            
            

            - **Id** *(string) --* 

              The unique identifier of the rule result.

              
            

            - **Description** *(string) --* 

              A description of what the rule validates.

              
            

            - **Status** *(string) --* 

              The status of the rule result.

              
            

            - **Message** *(string) --* 

              A message providing details about the rule result.

              
            

            - **Metadata** *(dict) --* 

              Additional metadata associated with the rule result.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
    