cancel_job_execution async ¶

async def cancel_job_execution(
    self,
    job_id: "capo_iot.types.job_id.JobId",
    thing_name: "capo_iot.types.thing_name.ThingName",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    force: Optional["capo_iot.types.force_flag.ForceFlag"] = None,
    expected_version: Optional[
        "capo_iot.types.expected_version.ExpectedVersion"
    ] = None,
    status_details: Optional["capo_iot.types.details_map.DetailsMap"] = None,
) -> None:
    """<p>Cancels the execution of a job for a given thing.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelJobExecution</a> action.</p>

    Args:
        job_id: <p>The ID of the job to be canceled.</p>
        thing_name: <p>The name of the thing whose execution of the job will be canceled.</p>
        force: <p>(Optional) If <code>true</code> the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set <code>force</code> to <code>true</code>, then an <code>InvalidStateTransitionException</code> will be thrown. The default is <code>false</code>.</p> <p>Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.</p>
        expected_version: <p>(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)</p>
        status_details: <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.</p>

    Raises:
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.invalid_state_transition_exception.InvalidStateTransitionException: <p>An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the <code>force</code> parameter.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.version_conflict_exception.VersionConflictException: <p>An exception thrown when the version of an entity specified with the <code>expectedVersion</code> parameter does not match the latest version in the system.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.cancel_job_execution_request.CancelJobExecutionRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_iot._operations.aws_iot_service.cancel_job_execution

        (
            output,
            http_response,
        ) = await capo_iot._operations.aws_iot_service.cancel_job_execution.async_cancel_job_execution(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelJobExecution")
    )
    input_: capo_iot.types.cancel_job_execution_request.CancelJobExecutionRequest = {
        "job_id": job_id,
        "thing_name": thing_name,
    }
    if force is not None:
        input_["force"] = force
    if expected_version is not None:
        input_["expected_version"] = expected_version
    if status_details is not None:
        input_["status_details"] = status_details

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