:doc:`NeptuneData <../../neptunedata>` / Client / list_loader_jobs

****************
list_loader_jobs
****************



.. py:method:: NeptuneData.Client.list_loader_jobs(**kwargs)

  

  Retrieves a list of the ``loadIds`` for all active loader jobs.

   

  When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the `neptune-db\:ListLoaderJobs <https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs>`__ IAM action in that cluster..

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListLoaderJobs>`_  


  **Request Syntax**
  ::

    response = client.list_loader_jobs(
        limit=123,
        includeQueuedLoads=True|False
    )
    
  :type limit: integer
  :param limit: 

    The number of load IDs to list. Must be a positive integer greater than zero and not more than ``100`` (which is the default).

    

  
  :type includeQueuedLoads: boolean
  :param includeQueuedLoads: 

    An optional parameter that can be used to exclude the load IDs of queued load requests when requesting a list of load IDs by setting the parameter to ``FALSE``. The default value is ``TRUE``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'status': 'string',
          'payload': {
              'loadIds': [
                  'string',
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **status** *(string) --* 

        Returns the status of the job list request.

        
      

      - **payload** *(dict) --* 

        The requested list of job IDs.

        
        

        - **loadIds** *(list) --* 

          A list of load IDs.

          
          

          - *(string) --* 
      
    
  
  **Exceptions**
  
  *   :py:class:`NeptuneData.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.BadRequestException`

  
  *   :py:class:`NeptuneData.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`NeptuneData.Client.exceptions.BulkLoadIdNotFoundException`

  
  *   :py:class:`NeptuneData.Client.exceptions.InternalFailureException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ClientTimeoutException`

  
  *   :py:class:`NeptuneData.Client.exceptions.PreconditionsFailedException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ConstraintViolationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`NeptuneData.Client.exceptions.LoadUrlAccessDeniedException`

  
  *   :py:class:`NeptuneData.Client.exceptions.IllegalArgumentException`

  
  *   :py:class:`NeptuneData.Client.exceptions.TooManyRequestsException`

  