get_job ¶

get_job(
    job_id: JobId, *, config_overrides: Optional[EndUserMessagingClientConfig] = None
) -> Job

Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.

Parameters:

job_id (JobId) –

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

An unexpected error occurred during the processing of the request.
ResourceNotFoundException –

The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
ThrottlingException –

The request was denied because it exceeded the allowed request rate.
ValidationException –

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
UnknownServiceError –

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

Examples:

Get an async job

>>> client.get_job(job_id='job-abc12345678901234')

Source code in docs_src/capo_endusermessaging/_services/end_user_messaging.py

def get_job(
    self,
    job_id: "capo_endusermessaging.types.job_id.JobId",
    *,
    config_overrides: Optional[EndUserMessagingClientConfig] = None,
) -> "capo_endusermessaging.types.job.Job":
    """<p>Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.</p>

    Args:
        job_id: <p>The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.</p>

    Raises:
        capo_endusermessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_endusermessaging.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_endusermessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
        capo_endusermessaging.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed request rate.</p>
        capo_endusermessaging.errors.validation_exception.ValidationException: A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
        capo_endusermessaging.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get an async job

        >>> client.get_job(job_id='job-abc12345678901234')
    """

    def _handler(
        req: "OperationRequest[capo_endusermessaging.types.get_job_input.GetJobInput]",
    ) -> OperationResponse["capo_endusermessaging.types.job.Job"]:
        import capo_endusermessaging._operations.end_user_messaging.get_job

        output, http_response = (
            capo_endusermessaging._operations.end_user_messaging.get_job.get_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetJob")
    )
    input_: capo_endusermessaging.types.get_job_input.GetJobInput = {
        "job_id": job_id
    }

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