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.
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()
)
Character. The disk image format.
Character. The ID of the image.
Object. Information about the destination Amazon S3 bucket.
Character. Token to enable idempotency for export image requests.[optional]
Character. A description of the image being exported. The maximum length is 255 characters.[optional]
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
Character. The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket....[optional]
List. The tags to apply to the export image task during creation.[optional]
Logical. Whether to simplify the result and handle nextToken
in the response[optional]
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
Logical. Whether to show an error message when a network error occurs.
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.
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
Character. The region of the AWS service.
A list object or a character vector
The disk image format.
The ID of the image.
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.
Token to enable idempotency for export image requests.
A description of the image being exported. The maximum length is 255 characters.
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
.
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\'.
The tags to apply to the export image task during creation.