list_loader_jobs ¶

list_loader_jobs(
    *,
    config_overrides: Optional[neptunedataClientConfig] = None,
    limit: Optional[PositiveInteger] = None,
    include_queued_loads: Optional[bool] = None,
) -> ListLoaderJobsOutput

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

Parameters:

limit (Optional[PositiveInteger], default: None ) –

The number of load IDs to list. Must be a positive integer greater than zero and not more than 100 (which is the default).
include_queued_loads (Optional[bool], default: None ) –

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.

Raises:

BadRequestException –

Raised when a request is submitted that cannot be processed.
BulkLoadIdNotFoundException –

Raised when a specified bulk-load job ID cannot be found.
ClientTimeoutException –

Raised when a request timed out in the client.
ConstraintViolationException –

Raised when a value in a request field did not satisfy required constraints.
IllegalArgumentException –

Raised when an argument in a request is not supported.
InternalFailureException –

Raised when the processing of the request failed unexpectedly.
InvalidArgumentException –

Raised when an argument in a request has an invalid value.
InvalidParameterException –

Raised when a parameter value is not valid.
LoadUrlAccessDeniedException –

Raised when access is denied to a specified load URL.
PreconditionsFailedException –

Raised when a precondition for processing a request is not satisfied.
TooManyRequestsException –

Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException –

Raised when a request attempts to initiate an operation that is not supported.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_neptunedata/_services/neptunedata.py

def list_loader_jobs(
    self,
    *,
    config_overrides: Optional[neptunedataClientConfig] = None,
    limit: Optional[
        "capo_neptunedata.types.positive_integer.PositiveInteger"
    ] = None,
    include_queued_loads: Optional[bool] = None,
) -> "capo_neptunedata.types.list_loader_jobs_output.ListLoaderJobsOutput":
    """<p>Retrieves a list of the <code>loadIds</code> for all active loader jobs.</p> <p>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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs">neptune-db:ListLoaderJobs</a> IAM action in that cluster..</p>

    Args:
        limit: <p>The number of load IDs to list. Must be a positive integer greater than zero and not more than <code>100</code> (which is the default).</p>
        include_queued_loads: <p>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 <code>FALSE</code>. The default value is <code>TRUE</code>.</p>

    Raises:
        capo_neptunedata.errors.bad_request_exception.BadRequestException: <p>Raised when a request is submitted that cannot be processed.</p>
        capo_neptunedata.errors.bulk_load_id_not_found_exception.BulkLoadIdNotFoundException: <p>Raised when a specified bulk-load job ID cannot be found.</p>
        capo_neptunedata.errors.client_timeout_exception.ClientTimeoutException: <p>Raised when a request timed out in the client.</p>
        capo_neptunedata.errors.constraint_violation_exception.ConstraintViolationException: <p>Raised when a value in a request field did not satisfy required constraints.</p>
        capo_neptunedata.errors.illegal_argument_exception.IllegalArgumentException: <p>Raised when an argument in a request is not supported.</p>
        capo_neptunedata.errors.internal_failure_exception.InternalFailureException: <p>Raised when the processing of the request failed unexpectedly.</p>
        capo_neptunedata.errors.invalid_argument_exception.InvalidArgumentException: <p>Raised when an argument in a request has an invalid value.</p>
        capo_neptunedata.errors.invalid_parameter_exception.InvalidParameterException: <p>Raised when a parameter value is not valid.</p>
        capo_neptunedata.errors.load_url_access_denied_exception.LoadUrlAccessDeniedException: <p>Raised when access is denied to a specified load URL.</p>
        capo_neptunedata.errors.preconditions_failed_exception.PreconditionsFailedException: <p>Raised when a precondition for processing a request is not satisfied.</p>
        capo_neptunedata.errors.too_many_requests_exception.TooManyRequestsException: <p>Raised when the number of requests being processed exceeds the limit.</p>
        capo_neptunedata.errors.unsupported_operation_exception.UnsupportedOperationException: <p>Raised when a request attempts to initiate an operation that is not supported.</p>
        capo_neptunedata.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptunedata.types.list_loader_jobs_input.ListLoaderJobsInput]",
    ) -> OperationResponse[
        "capo_neptunedata.types.list_loader_jobs_output.ListLoaderJobsOutput"
    ]:
        import capo_neptunedata._operations.amazon_neptune_dataplane.list_loader_jobs

        output, http_response = (
            capo_neptunedata._operations.amazon_neptune_dataplane.list_loader_jobs.list_loader_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLoaderJobs")
    )
    input_: capo_neptunedata.types.list_loader_jobs_input.ListLoaderJobsInput = {}
    if limit is not None:
        input_["limit"] = limit
    if include_queued_loads is not None:
        input_["include_queued_loads"] = include_queued_loads

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output