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

****************
ListWorkerBlocks
****************



.. py:class:: MTurk.Paginator.ListWorkerBlocks

  ::

    
    paginator = client.get_paginator('list_worker_blocks')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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,
            'WorkerBlocks': [
                {
                    'WorkerId': 'string',
                    'Reason': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

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

          
        

        - **WorkerBlocks** *(list) --* 

          The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.

          
          

          - *(dict) --* 

            The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the Reason for the block.

            
            

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

              The ID of the Worker who accepted the HIT.

              
            

            - **Reason** *(string) --* 

              A message explaining the reason the Worker was blocked.

              
        
      
    