Skip to content

cancel_job

cancel_job(
    id: __string, *, config_overrides: Optional[MediaConvertClientConfig] = None
) -> CancelJobResponse

Permanently cancel a job. Once you have canceled a job, you can't start it again.

Parameters:

  • id (__string) –

    The Job ID of the job to be cancelled.

Raises:

  • BadRequestException –

    The service can't process your request because of a problem in the request. Please check your request form and syntax.

  • ConflictException –

    The service couldn't complete your request because there is a conflict with the current state of the resource.

  • ForbiddenException –

    You don't have permissions for this action with the credentials you sent.

  • InternalServerErrorException –

    The service encountered an unexpected condition and can't fulfill your request.

  • NotFoundException –

    The resource you requested doesn't exist.

  • ServiceQuotaExceededException –

    You attempted to create more resources than the service allows based on service quotas.

  • TooManyRequestsException –

    Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

  • UnknownServiceError –

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

Source code in docs_src/capo_mediaconvert/_services/media_convert.py
def cancel_job(
    self,
    id: "capo_mediaconvert.types.__string.__string",
    *,
    config_overrides: Optional[MediaConvertClientConfig] = None,
) -> "capo_mediaconvert.types.cancel_job_response.CancelJobResponse":
    """Permanently cancel a job. Once you have canceled a job, you can't start it again.

    Args:
        id: The Job ID of the job to be cancelled.

    Raises:
        capo_mediaconvert.errors.bad_request_exception.BadRequestException: The service can't process your request because of a problem in the request. Please check your request form and syntax.
        capo_mediaconvert.errors.conflict_exception.ConflictException: The service couldn't complete your request because there is a conflict with the current state of the resource.
        capo_mediaconvert.errors.forbidden_exception.ForbiddenException: You don't have permissions for this action with the credentials you sent.
        capo_mediaconvert.errors.internal_server_error_exception.InternalServerErrorException: The service encountered an unexpected condition and can't fulfill your request.
        capo_mediaconvert.errors.not_found_exception.NotFoundException: The resource you requested doesn't exist.
        capo_mediaconvert.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: You attempted to create more resources than the service allows based on service quotas.
        capo_mediaconvert.errors.too_many_requests_exception.TooManyRequestsException: Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.
        capo_mediaconvert.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mediaconvert.types.cancel_job_request.CancelJobRequest]",
    ) -> OperationResponse[
        "capo_mediaconvert.types.cancel_job_response.CancelJobResponse"
    ]:
        import capo_mediaconvert._operations.media_convert.cancel_job

        output, http_response = (
            capo_mediaconvert._operations.media_convert.cancel_job.cancel_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

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