cancel-backup¶

Description¶

Cancels a currently running backup operation. The operation must be in a STARTED or IN_PROGRESS state. Pending sub-operations will be ignored and marked as cancelled. The operation does not wait for the currently running sub-operation(s) to complete.

Synopsis¶

  cancel-backup
--backup-id <value>
[--force | --no-force]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--backup-id (string)

Backup-id that identifies the backup to be cancelled.

--force | --no-force (boolean)

Will mark all unfinished operations as cancelled without waiting for their result and mark backup operation as finished (cancelled, successful or failed) immediately.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

result -> (string)

Result of the cancel backup request. It can contain a description of the current process state or guidelines to a customer on the next steps.

Form Factors¶

public