loader_jobs
Creates, updates, deletes, gets or lists a loader_jobs resource.
Overview
| Name | loader_jobs |
| Type | Resource |
| Id | aws.neptunedata.loader_jobs |
Fields
The following fields are returned by SELECT queries:
- list_loader_jobs
| Name | Datatype | Description |
|---|---|---|
payload | object | The requested list of job IDs. |
status | string | Returns the status of the job list request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_loader_jobs | select | region | limit, includeQueuedLoads | 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.. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
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 is TRUE. |
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). |
SELECT examples
- list_loader_jobs
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..
SELECT
payload,
status
FROM aws.neptunedata.loader_jobs
WHERE region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND includeQueuedLoads = '{{ includeQueuedLoads }}'
;