ListLoaderJobs
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..
Request Syntax
GET /loader?includeQueuedLoads=includeQueuedLoads
&limit=limit
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- 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 isTRUE
. - 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).Valid Range: Minimum value of 1. Maximum value of 100.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"payload": {
"loadIds": [ "string" ]
},
"status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- payload
-
The requested list of job IDs.
Type: LoaderIdResult object
- status
-
Returns the status of the job list request.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
Raised when a request is submitted that cannot be processed.
HTTP Status Code: 400
- BulkLoadIdNotFoundException
-
Raised when a specified bulk-load job ID cannot be found.
HTTP Status Code: 404
- ClientTimeoutException
-
Raised when a request timed out in the client.
HTTP Status Code: 408
- ConstraintViolationException
-
Raised when a value in a request field did not satisfy required constraints.
HTTP Status Code: 400
- IllegalArgumentException
-
Raised when an argument in a request is not supported.
HTTP Status Code: 400
- InternalFailureException
-
Raised when the processing of the request failed unexpectedly.
HTTP Status Code: 500
- InvalidArgumentException
-
Raised when an argument in a request has an invalid value.
HTTP Status Code: 400
- InvalidParameterException
-
Raised when a parameter value is not valid.
HTTP Status Code: 400
- LoadUrlAccessDeniedException
-
Raised when access is denied to a specified load URL.
HTTP Status Code: 400
- PreconditionsFailedException
-
Raised when a precondition for processing a request is not satisfied.
HTTP Status Code: 400
- TooManyRequestsException
-
Raised when the number of requests being processed exceeds the limit.
HTTP Status Code: 429
- UnsupportedOperationException
-
Raised when a request attempts to initiate an operation that is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: