aws.ecx: ec2_cancel_export_task – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

ec2_cancel_export_task

Cancel Export Task

Description

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

Usage

ec2_cancel_export_task(
  ExportTaskId,
  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

`ExportTaskId`	Character. The ID of the export task. This is the ID returned by `CreateInstanceExportTask`.
`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

ExportTaskId

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

aws.ecx

Communicating with AWS EC2 and ECS using AWS REST APIs

v1.0.4

GPL-3

Authors

Jiefei Wang [aut, cre]

Initial release