:doc:`MTurk <../../mturk>` / Paginator / ListQualificationRequests

*************************
ListQualificationRequests
*************************



.. py:class:: MTurk.Paginator.ListQualificationRequests

  ::

    
    paginator = client.get_paginator('list_qualification_requests')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MTurk.Client.list_qualification_requests`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationRequests>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          QualificationTypeId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type QualificationTypeId: string
    :param QualificationTypeId: 

      The ID of the QualificationType.

      

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

      
      ::

        {
            'NumResults': 123,
            'QualificationRequests': [
                {
                    'QualificationRequestId': 'string',
                    'QualificationTypeId': 'string',
                    'WorkerId': 'string',
                    'Test': 'string',
                    'Answer': 'string',
                    'SubmitTime': datetime(2015, 1, 1)
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **NumResults** *(integer) --* 

          The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call.

          
        

        - **QualificationRequests** *(list) --* 

          The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.

          
          

          - *(dict) --* 

            The QualificationRequest data structure represents a request a Worker has made for a Qualification.

            
            

            - **QualificationRequestId** *(string) --* 

              The ID of the Qualification request, a unique identifier generated when the request was submitted.

              
            

            - **QualificationTypeId** *(string) --* 

              The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.

              
            

            - **WorkerId** *(string) --* 

              The ID of the Worker requesting the Qualification.

              
            

            - **Test** *(string) --* 

              The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification.

              
            

            - **Answer** *(string) --* 

              The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.

              
            

            - **SubmitTime** *(datetime) --* 

              The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test.

              
        
      
    