Skip to content

stop_backup_job async

stop_backup_job(
    backup_job_id: string, *, config_overrides: Optional[AsyncBackupClientConfig] = None
) -> None

Attempts to cancel a job to create a one-time backup of a resource.

This action is not supported for the following services:

  • Amazon Aurora

  • Amazon DocumentDB (with MongoDB compatibility)

  • Amazon FSx for Lustre

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

  • Amazon Neptune

  • SAP HANA databases on Amazon EC2 instances

  • Amazon RDS

Parameters:

  • backup_job_id (string) –

    Uniquely identifies a request to Backup to back up a resource.

Raises:

Source code in docs_src/capo_backup/_services/async_backup.py
async def stop_backup_job(
    self,
    backup_job_id: "capo_backup.types.string.string",
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
) -> None:
    """<p>Attempts to cancel a job to create a one-time backup of a resource.</p> <p>This action is not supported for the following services:</p> <ul> <li> <p>Amazon Aurora</p> </li> <li> <p>Amazon DocumentDB (with MongoDB compatibility)</p> </li> <li> <p>Amazon FSx for Lustre</p> </li> <li> <p>Amazon FSx for NetApp ONTAP</p> </li> <li> <p>Amazon FSx for OpenZFS</p> </li> <li> <p>Amazon FSx for Windows File Server</p> </li> <li> <p>Amazon Neptune</p> </li> <li> <p>SAP HANA databases on Amazon EC2 instances</p> </li> <li> <p>Amazon RDS</p> </li> </ul>

    Args:
        backup_job_id: <p>Uniquely identifies a request to Backup to back up a resource.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backup.types.stop_backup_job_input.StopBackupJobInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_backup._operations.cryo_controller_user_manager.stop_backup_job

        (
            output,
            http_response,
        ) = await capo_backup._operations.cryo_controller_user_manager.stop_backup_job.async_stop_backup_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopBackupJob")
    )
    input_: capo_backup.types.stop_backup_job_input.StopBackupJobInput = {
        "backup_job_id": backup_job_id
    }

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