aws_sdk_ec2/client/
export_image.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ExportImage`](crate::operation::export_image::builders::ExportImageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_client_token):<br>required: **false**<br><p>Token to enable idempotency for export image requests.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_description):<br>required: **false**<br><p>A description of the image being exported. The maximum length is 255 characters.</p><br>
8    ///   - [`disk_image_format(DiskImageFormat)`](crate::operation::export_image::builders::ExportImageFluentBuilder::disk_image_format) / [`set_disk_image_format(Option<DiskImageFormat>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_disk_image_format):<br>required: **true**<br><p>The disk image format.</p><br>
9    ///   - [`dry_run(bool)`](crate::operation::export_image::builders::ExportImageFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_dry_run):<br>required: **false**<br><p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
10    ///   - [`image_id(impl Into<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::image_id) / [`set_image_id(Option<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_image_id):<br>required: **true**<br><p>The ID of the image.</p><br>
11    ///   - [`s3_export_location(ExportTaskS3LocationRequest)`](crate::operation::export_image::builders::ExportImageFluentBuilder::s3_export_location) / [`set_s3_export_location(Option<ExportTaskS3LocationRequest>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_s3_export_location):<br>required: **true**<br><p>The Amazon S3 bucket for the destination image. The destination bucket must exist.</p><br>
12    ///   - [`role_name(impl Into<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::role_name) / [`set_role_name(Option<String>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_role_name):<br>required: **false**<br><p>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'.</p><br>
13    ///   - [`tag_specifications(TagSpecification)`](crate::operation::export_image::builders::ExportImageFluentBuilder::tag_specifications) / [`set_tag_specifications(Option<Vec::<TagSpecification>>)`](crate::operation::export_image::builders::ExportImageFluentBuilder::set_tag_specifications):<br>required: **false**<br><p>The tags to apply to the export image task during creation.</p><br>
14    /// - On success, responds with [`ExportImageOutput`](crate::operation::export_image::ExportImageOutput) with field(s):
15    ///   - [`description(Option<String>)`](crate::operation::export_image::ExportImageOutput::description): <p>A description of the image being exported.</p>
16    ///   - [`disk_image_format(Option<DiskImageFormat>)`](crate::operation::export_image::ExportImageOutput::disk_image_format): <p>The disk image format for the exported image.</p>
17    ///   - [`export_image_task_id(Option<String>)`](crate::operation::export_image::ExportImageOutput::export_image_task_id): <p>The ID of the export image task.</p>
18    ///   - [`image_id(Option<String>)`](crate::operation::export_image::ExportImageOutput::image_id): <p>The ID of the image.</p>
19    ///   - [`role_name(Option<String>)`](crate::operation::export_image::ExportImageOutput::role_name): <p>The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.</p>
20    ///   - [`progress(Option<String>)`](crate::operation::export_image::ExportImageOutput::progress): <p>The percent complete of the export image task.</p>
21    ///   - [`s3_export_location(Option<ExportTaskS3Location>)`](crate::operation::export_image::ExportImageOutput::s3_export_location): <p>Information about the destination Amazon S3 bucket.</p>
22    ///   - [`status(Option<String>)`](crate::operation::export_image::ExportImageOutput::status): <p>The status of the export image task. The possible values are <code>active</code>, <code>completed</code>, <code>deleting</code>, and <code>deleted</code>.</p>
23    ///   - [`status_message(Option<String>)`](crate::operation::export_image::ExportImageOutput::status_message): <p>The status message for the export image task.</p>
24    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::export_image::ExportImageOutput::tags): <p>Any tags assigned to the export image task.</p>
25    /// - On failure, responds with [`SdkError<ExportImageError>`](crate::operation::export_image::ExportImageError)
26    pub fn export_image(&self) -> crate::operation::export_image::builders::ExportImageFluentBuilder {
27        crate::operation::export_image::builders::ExportImageFluentBuilder::new(self.handle.clone())
28    }
29}
aws_sdk_ec2/client/export_image.rs

aws_sdk_ec2/client/
export_image.rs
