reset_job_bookmark ¶

reset_job_bookmark(
    job_name: JobName,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    run_id: Optional[RunId] = None,
) -> ResetJobBookmarkResponse

Resets a bookmark entry.

For more information about enabling and using job bookmarks, see:

Parameters:

job_name (JobName) –

The name of the job in question.
run_id (Optional[RunId], default: None ) –

The unique run identifier associated with this job run.

Raises:

EntityNotFoundException –

A specified entity does not exist
InternalServiceException –

An internal service error occurred.
InvalidInputException –

The input provided was not valid.
OperationTimeoutException –

The operation timed out.
UnknownServiceError –

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

Source code in docs_src/capo_glue/_services/glue.py

def reset_job_bookmark(
    self,
    job_name: "capo_glue.types.job_name.JobName",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    run_id: Optional["capo_glue.types.run_id.RunId"] = None,
) -> "capo_glue.types.reset_job_bookmark_response.ResetJobBookmarkResponse":
    """<p>Resets a bookmark entry.</p> <p>For more information about enabling and using job bookmarks, see:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html">Tracking processed data using job bookmarks</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Job parameters used by Glue</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job">Job structure</a> </p> </li> </ul>

    Args:
        job_name: <p>The name of the job in question.</p>
        run_id: <p>The unique run identifier associated with this job run.</p>

    Raises:
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.reset_job_bookmark_request.ResetJobBookmarkRequest]",
    ) -> OperationResponse[
        "capo_glue.types.reset_job_bookmark_response.ResetJobBookmarkResponse"
    ]:
        import capo_glue._operations.aws_glue.reset_job_bookmark

        output, http_response = (
            capo_glue._operations.aws_glue.reset_job_bookmark.reset_job_bookmark(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ResetJobBookmark")
    )
    input_: capo_glue.types.reset_job_bookmark_request.ResetJobBookmarkRequest = {
        "job_name": job_name
    }
    if run_id is not None:
        input_["run_id"] = run_id

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