ec2_export_image {aws.ecx}

Export Image

Description

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM Directory from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.

Usage

ec2_export_image(
  DiskImageFormat,
  ImageId,
  S3ExportLocation,
  ClientToken = NULL,
  Description = NULL,
  DryRun = NULL,
  RoleName = NULL,
  TagSpecification = 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

DiskImageFormat

Character. The disk image format.

ImageId

Character. The ID of the image.

S3ExportLocation

Object. Information about the destination Amazon S3 bucket.

ClientToken

Character. Token to enable idempotency for export image requests.[optional]

Description

Character. A description of the image being exported. The maximum length is 255 characters.[optional]

DryRun

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

RoleName

Character. The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket....[optional]

TagSpecification

List. The tags to apply to the export image task during creation.[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

DiskImageFormat

The disk image format.

ImageId

The ID of the image.

S3ExportLocation

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export\@amazon.com.

ClientToken

Token to enable idempotency for export image requests.

Description

A description of the image being exported. The maximum length is 255 characters.

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.

RoleName

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named \'vmimport\'.

TagSpecification

The tags to apply to the export image task during creation.