:doc:`LakeFormation <../../lakeformation>` / Paginator / GetWorkUnits

************
GetWorkUnits
************



.. py:class:: LakeFormation.Paginator.GetWorkUnits

  ::

    
    paginator = client.get_paginator('get_work_units')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`LakeFormation.Client.get_work_units`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GetWorkUnits>`_    


    **Request Syntax**
    ::

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

      The ID of the plan query operation.

      

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

      
      ::

        {
            'QueryId': 'string',
            'WorkUnitRanges': [
                {
                    'WorkUnitIdMax': 123,
                    'WorkUnitIdMin': 123,
                    'WorkUnitToken': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 

        A structure for the output.

        
        

        - **QueryId** *(string) --* 

          The ID of the plan query operation.

          
        

        - **WorkUnitRanges** *(list) --* 

          A ``WorkUnitRangeList`` object that specifies the valid range of work unit IDs for querying the execution service.

          
          

          - *(dict) --* 

            Defines the valid range of work unit IDs for querying the execution service.

            
            

            - **WorkUnitIdMax** *(integer) --* 

              Defines the maximum work unit ID in the range. The maximum value is inclusive.

              
            

            - **WorkUnitIdMin** *(integer) --* 

              Defines the minimum work unit ID in the range.

              
            

            - **WorkUnitToken** *(string) --* 

              A work token used to query the execution service.

              
        
      
    