Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
Synopsis
- data ExportImage = ExportImage' {}
- newExportImage :: DiskImageFormat -> Text -> ExportTaskS3LocationRequest -> ExportImage
- exportImage_clientToken :: Lens' ExportImage (Maybe Text)
- exportImage_description :: Lens' ExportImage (Maybe Text)
- exportImage_dryRun :: Lens' ExportImage (Maybe Bool)
- exportImage_roleName :: Lens' ExportImage (Maybe Text)
- exportImage_tagSpecifications :: Lens' ExportImage (Maybe [TagSpecification])
- exportImage_diskImageFormat :: Lens' ExportImage DiskImageFormat
- exportImage_imageId :: Lens' ExportImage Text
- exportImage_s3ExportLocation :: Lens' ExportImage ExportTaskS3LocationRequest
- data ExportImageResponse = ExportImageResponse' {}
- newExportImageResponse :: Int -> ExportImageResponse
- exportImageResponse_description :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_diskImageFormat :: Lens' ExportImageResponse (Maybe DiskImageFormat)
- exportImageResponse_exportImageTaskId :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_imageId :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_progress :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_roleName :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_s3ExportLocation :: Lens' ExportImageResponse (Maybe ExportTaskS3Location)
- exportImageResponse_status :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_statusMessage :: Lens' ExportImageResponse (Maybe Text)
- exportImageResponse_tags :: Lens' ExportImageResponse (Maybe [Tag])
- exportImageResponse_httpStatus :: Lens' ExportImageResponse Int
Creating a Request
data ExportImage Source #
See: newExportImage
smart constructor.
ExportImage' | |
|
Instances
Create a value of ExportImage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExportImage
, exportImage_clientToken
- Token to enable idempotency for export image requests.
ExportImage
, exportImage_description
- A description of the image being exported. The maximum length is 255
characters.
$sel:dryRun:ExportImage'
, exportImage_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
.
ExportImage
, exportImage_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'.
ExportImage
, exportImage_tagSpecifications
- The tags to apply to the export image task during creation.
ExportImage
, exportImage_diskImageFormat
- The disk image format.
ExportImage
, exportImage_imageId
- The ID of the image.
ExportImage
, exportImage_s3ExportLocation
- The Amazon S3 bucket for the destination image. The destination bucket
must exist.
Request Lenses
exportImage_clientToken :: Lens' ExportImage (Maybe Text) Source #
Token to enable idempotency for export image requests.
exportImage_description :: Lens' ExportImage (Maybe Text) Source #
A description of the image being exported. The maximum length is 255 characters.
exportImage_dryRun :: Lens' ExportImage (Maybe Bool) Source #
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
.
exportImage_roleName :: Lens' ExportImage (Maybe Text) Source #
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'.
exportImage_tagSpecifications :: Lens' ExportImage (Maybe [TagSpecification]) Source #
The tags to apply to the export image task during creation.
exportImage_diskImageFormat :: Lens' ExportImage DiskImageFormat Source #
The disk image format.
exportImage_imageId :: Lens' ExportImage Text Source #
The ID of the image.
exportImage_s3ExportLocation :: Lens' ExportImage ExportTaskS3LocationRequest Source #
The Amazon S3 bucket for the destination image. The destination bucket must exist.
Destructuring the Response
data ExportImageResponse Source #
See: newExportImageResponse
smart constructor.
ExportImageResponse' | |
|
Instances
newExportImageResponse Source #
Create a value of ExportImageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExportImage
, exportImageResponse_description
- A description of the image being exported.
ExportImage
, exportImageResponse_diskImageFormat
- The disk image format for the exported image.
ExportImageResponse
, exportImageResponse_exportImageTaskId
- The ID of the export image task.
ExportImage
, exportImageResponse_imageId
- The ID of the image.
ExportImageResponse
, exportImageResponse_progress
- The percent complete of the export image task.
ExportImage
, exportImageResponse_roleName
- The name of the role that grants VM Import/Export permission to export
images to your Amazon S3 bucket.
ExportImage
, exportImageResponse_s3ExportLocation
- Information about the destination Amazon S3 bucket.
ExportImageResponse
, exportImageResponse_status
- The status of the export image task. The possible values are active
,
completed
, deleting
, and deleted
.
ExportImageResponse
, exportImageResponse_statusMessage
- The status message for the export image task.
ExportImageResponse
, exportImageResponse_tags
- Any tags assigned to the export image task.
$sel:httpStatus:ExportImageResponse'
, exportImageResponse_httpStatus
- The response's http status code.
Response Lenses
exportImageResponse_description :: Lens' ExportImageResponse (Maybe Text) Source #
A description of the image being exported.
exportImageResponse_diskImageFormat :: Lens' ExportImageResponse (Maybe DiskImageFormat) Source #
The disk image format for the exported image.
exportImageResponse_exportImageTaskId :: Lens' ExportImageResponse (Maybe Text) Source #
The ID of the export image task.
exportImageResponse_imageId :: Lens' ExportImageResponse (Maybe Text) Source #
The ID of the image.
exportImageResponse_progress :: Lens' ExportImageResponse (Maybe Text) Source #
The percent complete of the export image task.
exportImageResponse_roleName :: Lens' ExportImageResponse (Maybe Text) Source #
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
exportImageResponse_s3ExportLocation :: Lens' ExportImageResponse (Maybe ExportTaskS3Location) Source #
Information about the destination Amazon S3 bucket.
exportImageResponse_status :: Lens' ExportImageResponse (Maybe Text) Source #
The status of the export image task. The possible values are active
,
completed
, deleting
, and deleted
.
exportImageResponse_statusMessage :: Lens' ExportImageResponse (Maybe Text) Source #
The status message for the export image task.
exportImageResponse_tags :: Lens' ExportImageResponse (Maybe [Tag]) Source #
Any tags assigned to the export image task.
exportImageResponse_httpStatus :: Lens' ExportImageResponse Int Source #
The response's http status code.