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.

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..

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 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.

  • page (integer) – The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.

  • 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.

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