Skip to content

Gets status information about a specified load job

Description

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

Usage

neptunedata_get_loader_job_status(loadId, details, errors, page,
  errorsPerPage)

Arguments

  • loadId

    [required] The load ID of the load job to get the status of.

  • details

    Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).

  • errors

    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

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

  • errorsPerPage

    The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.

Value

A list with the following syntax:

list(
  status = "string",
  payload = list()
)

Request syntax

svc$get_loader_job_status(
  loadId = "string",
  details = TRUE|FALSE,
  errors = TRUE|FALSE,
  page = 123,
  errorsPerPage = 123
)