ec2_cancel_import_task {aws.ecx}R Documentation

Cancel Import Task

Description

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

Usage

ec2_cancel_import_task(
  CancelReason = NULL,
  DryRun = NULL,
  ImportTaskId = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

CancelReason

Character. The reason for canceling the task.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

ImportTaskId

Character. The ID of the import image or import snapshot task to be canceled.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

CancelReason

The reason for canceling the task.

DryRun

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.

ImportTaskId

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


[Package aws.ecx version 1.0.5 Index]