get_loader_job_status ¶

def get_loader_job_status(
    self,
    load_id: str,
    *,
    config_overrides: Optional[neptunedataClientConfig] = None,
    details: Optional[bool] = None,
    errors: Optional[bool] = None,
    page: Optional[
        "capo_neptunedata.types.positive_integer.PositiveInteger"
    ] = None,
    errors_per_page: Optional[
        "capo_neptunedata.types.positive_integer.PositiveInteger"
    ] = None,
) -> "capo_neptunedata.types.get_loader_job_status_output.GetLoaderJobStatusOutput":
    """<p>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.</p> <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune Loader Get-Status API</a> for more information.</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#getloaderjobstatus">neptune-db:GetLoaderJobStatus</a> IAM action in that cluster..</p>

    Args:
        load_id: <p>The load ID of the load job to get the status of.</p>
        details: <p>Flag indicating whether or not to include details beyond the overall status (<code>TRUE</code> or <code>FALSE</code>; the default is <code>FALSE</code>).</p>
        errors: <p>Flag indicating whether or not to include a list of errors encountered (<code>TRUE</code> or <code>FALSE</code>; the default is <code>FALSE</code>).</p> <p>The list of errors is paged. The <code>page</code> and <code>errorsPerPage</code> parameters allow you to page through all the errors.</p>
        page: <p>The error page number (a positive integer; the default is <code>1</code>). Only valid when the <code>errors</code> parameter is set to <code>TRUE</code>.</p>
        errors_per_page: <p>The number of errors returned in each page (a positive integer; the default is <code>10</code>). Only valid when the <code>errors</code> parameter set to <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.missing_parameter_exception.MissingParameterException: <p>Raised when a required parameter is missing.</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.get_loader_job_status_input.GetLoaderJobStatusInput]",
    ) -> OperationResponse[
        "capo_neptunedata.types.get_loader_job_status_output.GetLoaderJobStatusOutput"
    ]:
        import capo_neptunedata._operations.amazon_neptune_dataplane.get_loader_job_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLoaderJobStatus")
    )
    input_: capo_neptunedata.types.get_loader_job_status_input.GetLoaderJobStatusInput = {
        "load_id": load_id
    }
    if details is not None:
        input_["details"] = details
    if errors is not None:
        input_["errors"] = errors
    if page is not None:
        input_["page"] = page
    if errors_per_page is not None:
        input_["errors_per_page"] = errors_per_page

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