NeptuneData / Client / list_loader_jobs
list_loader_jobs#
- 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 IAM action in that cluster..
See also: AWS API Documentation
Request Syntax
response = client.list_loader_jobs( limit=123, includeQueuedLoads=True|False )
- Parameters:
limit (integer) – The number of load IDs to list. Must be a positive integer greater than zero and not more than
100
(which is the default).includeQueuedLoads (boolean) – 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 isTRUE
.
- Return type:
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
NeptuneData.Client.exceptions.UnsupportedOperationException
NeptuneData.Client.exceptions.BadRequestException
NeptuneData.Client.exceptions.InvalidParameterException
NeptuneData.Client.exceptions.BulkLoadIdNotFoundException
NeptuneData.Client.exceptions.InternalFailureException
NeptuneData.Client.exceptions.ClientTimeoutException
NeptuneData.Client.exceptions.PreconditionsFailedException
NeptuneData.Client.exceptions.ConstraintViolationException
NeptuneData.Client.exceptions.InvalidArgumentException
NeptuneData.Client.exceptions.LoadUrlAccessDeniedException
NeptuneData.Client.exceptions.IllegalArgumentException
NeptuneData.Client.exceptions.TooManyRequestsException