List Loader Jobs

neptunedata_list_loader_jobs

R Documentation

Retrieves a list of the loadIds for all active loader jobs¶

Description¶

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

Usage¶

neptunedata_list_loader_jobs(limit, includeQueuedLoads)

Arguments¶

limit

The number of load IDs to list. Must be a positive integer greater than zero and not more than 100 (which is the default).

includeQueuedLoads

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.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$list_loader_jobs(
  limit = 123,
  includeQueuedLoads = TRUE|FALSE
)