cancel_job `async` ¶

cancel_job(
    job_id: Id, *, config_overrides: Optional[AsyncDataExchangeClientConfig] = None
) -> None

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

Parameters:

job_id (Id) –

The unique identifier for a job.

Raises:

ConflictException –

The request couldn't be completed because it conflicted with the current state of the resource.
InternalServerException –

An exception occurred with the service.
ResourceNotFoundException –

The resource couldn't be found.
ThrottlingException –

The limit on the number of requests per second was exceeded.
ValidationException –

The request was invalid.
UnknownServiceError –

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

Source code in docs_src/capo_dataexchange/_services/async_data_exchange.py

async def cancel_job(
    self,
    job_id: "capo_dataexchange.types.id.Id",
    *,
    config_overrides: Optional[AsyncDataExchangeClientConfig] = None,
) -> None:
    """<p>This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.</p>

    Args:
        job_id: <p>The unique identifier for a job.</p>

    Raises:
        capo_dataexchange.errors.conflict_exception.ConflictException: <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
        capo_dataexchange.errors.internal_server_exception.InternalServerException: <p>An exception occurred with the service.</p>
        capo_dataexchange.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found.</p>
        capo_dataexchange.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_dataexchange.errors.validation_exception.ValidationException: <p>The request was invalid.</p>
        capo_dataexchange.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dataexchange.types.cancel_job_request.CancelJobRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_dataexchange._operations.data_exchange.cancel_job

        (
            output,
            http_response,
        ) = await capo_dataexchange._operations.data_exchange.cancel_job.async_cancel_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelJob")
    )
    input_: capo_dataexchange.types.cancel_job_request.CancelJobRequest = {
        "job_id": job_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

cancel_job async ¶

cancel_job `async` ¶