cancel-import-task¶

Description¶

Cancels an in-process import virtual machine or import snapshot task.

Synopsis¶

  cancel-import-task
[--cancel-reason <value>]
[--dry-run | --no-dry-run]
[--import-task-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cancel-reason (string)

The reason for canceling the task.

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--import-task-id (string)

The ID of the import image or import snapshot task to be canceled.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To cancel an import task

The following cancel-import-task example cancels the specified import image task.

aws ec2 cancel-import-task \
    --import-task-id import-ami-1234567890abcdef0

Output:

{
    "ImportTaskId": "import-ami-1234567890abcdef0",
    "PreviousState": "active",
    "State": "deleting"
}

Output¶

ImportTaskId -> (string)

The ID of the task being canceled.

PreviousState -> (string)

The current state of the task being canceled.

State -> (string)