NeptuneData / Client / get_loader_job_status
get_loader_job_status#
- NeptuneData.Client.get_loader_job_status(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.get_loader_job_status( loadId='string', details=True|False, errors=True|False, page=123, errorsPerPage=123 )
- Parameters:
loadId (string) –
[REQUIRED]
The load ID of the load job to get the status of.
details (boolean) – Flag indicating whether or not to include details beyond the overall status (
TRUE
orFALSE
; the default isFALSE
).errors (boolean) –
Flag indicating whether or not to include a list of errors encountered (
TRUE
orFALSE
; the default isFALSE
).The list of errors is paged. The
page
anderrorsPerPage
parameters allow you to page through all the errors.page (integer) – The error page number (a positive integer; the default is
1
). Only valid when theerrors
parameter is set toTRUE
.errorsPerPage (integer) – The number of errors returned in each page (a positive integer; the default is
10
). Only valid when theerrors
parameter set toTRUE
.
- Return type:
dict
- Returns:
Response Syntax
{ 'status': 'string', 'payload': {...}|[...]|123|123.4|'string'|True|None }
Response Structure
(dict) –
status (string) –
The HTTP response code for the request.
payload (document) –
Status information about the load job, in a layout that could look like this:
Exceptions
NeptuneData.Client.exceptions.BadRequestException
NeptuneData.Client.exceptions.InvalidParameterException
NeptuneData.Client.exceptions.BulkLoadIdNotFoundException
NeptuneData.Client.exceptions.ClientTimeoutException
NeptuneData.Client.exceptions.LoadUrlAccessDeniedException
NeptuneData.Client.exceptions.IllegalArgumentException
NeptuneData.Client.exceptions.TooManyRequestsException
NeptuneData.Client.exceptions.UnsupportedOperationException
NeptuneData.Client.exceptions.InternalFailureException
NeptuneData.Client.exceptions.PreconditionsFailedException
NeptuneData.Client.exceptions.ConstraintViolationException
NeptuneData.Client.exceptions.InvalidArgumentException
NeptuneData.Client.exceptions.MissingParameterException