loader_job_status

Creates, updates, deletes, gets or lists a loader_job_status resource.

Overview

Name	loader_job_status
Type	Resource
Id	aws.neptunedata.loader_job_status

Fields

The following fields are returned by SELECT queries:

get_loader_job_status

Name	Datatype	Description
payload	object	Status information about the load job, in a layout that could look like this:
status	string	The HTTP response code for the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_loader_job_status	select	load_id, region	details, errors, page, errorsPerPage	Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job. See Neptune Loader Get-Status API for more information. 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:GetLoaderJobStatus 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
load_id	string	The load ID of the load job to get the status of.
region	string	AWS region (default: us-east-1)
details	boolean	Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).
errors	boolean	Flag indicating whether or not to include a list of errors encountered (TRUE or FALSE; the default is FALSE). The list of errors is paged. The page and errorsPerPage parameters allow you to page through all the errors.
errorsPerPage	integer	The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.
page	integer	The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.

SELECT examples

get_loader_job_status

Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job. See Neptune Loader Get-Status API for more information. 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:GetLoaderJobStatus IAM action in that cluster..

SELECT
payload,
status
FROM aws.neptunedata.loader_job_status
WHERE load_id = '{{ load_id }}' -- required
AND region = '{{ region }}' -- required
AND details = '{{ details }}'
AND errors = '{{ errors }}'
AND page = '{{ page }}'
AND errorsPerPage = '{{ errorsPerPage }}'
;