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

Amazonka.EC2.ExportImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- clientToken :: Maybe Text
- description :: Maybe Text
- dryRun :: Maybe Bool
- roleName :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
- diskImageFormat :: DiskImageFormat
- imageId :: Text
- s3ExportLocation :: ExportTaskS3LocationRequest
}
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' {
- description :: Maybe Text
- diskImageFormat :: Maybe DiskImageFormat
- exportImageTaskId :: Maybe Text
- imageId :: Maybe Text
- progress :: Maybe Text
- roleName :: Maybe Text
- s3ExportLocation :: Maybe ExportTaskS3Location
- status :: Maybe Text
- statusMessage :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
}
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.

Constructors

ExportImage'

Fields

clientToken :: Maybe Text
Token to enable idempotency for export image requests.
description :: Maybe Text
A description of the image being exported. The maximum length is 255 characters.
dryRun :: Maybe Bool
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 :: Maybe Text
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'.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the export image task during creation.
diskImageFormat :: DiskImageFormat
The disk image format.
imageId :: Text
The ID of the image.
s3ExportLocation :: ExportTaskS3LocationRequest
The Amazon S3 bucket for the destination image. The destination bucket must exist.

Instances

Instances details

ToHeaders ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods toHeaders :: ExportImage -> [Header] #
ToPath ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods toPath :: ExportImage -> ByteString #
ToQuery ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods toQuery :: ExportImage -> QueryString #
AWSRequest ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Associated Types type AWSResponse ExportImage # Methods request :: (Service -> Service) -> ExportImage -> Request ExportImage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExportImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExportImage))) #
Generic ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Associated Types type Rep ExportImage :: Type -> Type # Methods from :: ExportImage -> Rep ExportImage x # to :: Rep ExportImage x -> ExportImage #
Read ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods readsPrec :: Int -> ReadS ExportImage # readList :: ReadS [ExportImage] # readPrec :: ReadPrec ExportImage # readListPrec :: ReadPrec [ExportImage] #
Show ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods showsPrec :: Int -> ExportImage -> ShowS # show :: ExportImage -> String # showList :: [ExportImage] -> ShowS #
NFData ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods rnf :: ExportImage -> () #
Eq ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods (==) :: ExportImage -> ExportImage -> Bool # (/=) :: ExportImage -> ExportImage -> Bool #
Hashable ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods hashWithSalt :: Int -> ExportImage -> Int # hash :: ExportImage -> Int #
type AWSResponse ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage type AWSResponse ExportImage = ExportImageResponse
type Rep ExportImage Source #
Instance details Defined in Amazonka.EC2.ExportImage type Rep ExportImage = D1 ('MetaData "ExportImage" "Amazonka.EC2.ExportImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ExportImage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :: S1 ('MetaSel ('Just "diskImageFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DiskImageFormat)) :: (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3ExportLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExportTaskS3LocationRequest)))))

newExportImage Source #

Arguments

:: DiskImageFormat	`ExportImage`
-> Text	`ExportImage`
-> ExportTaskS3LocationRequest	`ExportImage`
-> ExportImage

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.

Constructors

ExportImageResponse'

Fields

description :: Maybe Text
A description of the image being exported.
diskImageFormat :: Maybe DiskImageFormat
The disk image format for the exported image.
exportImageTaskId :: Maybe Text
The ID of the export image task.
imageId :: Maybe Text
The ID of the image.
progress :: Maybe Text
The percent complete of the export image task.
roleName :: Maybe Text
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
s3ExportLocation :: Maybe ExportTaskS3Location
Information about the destination Amazon S3 bucket.
status :: Maybe Text
The status of the export image task. The possible values are active, completed, deleting, and deleted.
statusMessage :: Maybe Text
The status message for the export image task.
tags :: Maybe [Tag]
Any tags assigned to the export image task.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ExportImageResponse Source #
Instance details Defined in Amazonka.EC2.ExportImage Associated Types type Rep ExportImageResponse :: Type -> Type # Methods from :: ExportImageResponse -> Rep ExportImageResponse x # to :: Rep ExportImageResponse x -> ExportImageResponse #
Read ExportImageResponse Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods readsPrec :: Int -> ReadS ExportImageResponse # readList :: ReadS [ExportImageResponse] # readPrec :: ReadPrec ExportImageResponse # readListPrec :: ReadPrec [ExportImageResponse] #
Show ExportImageResponse Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods showsPrec :: Int -> ExportImageResponse -> ShowS # show :: ExportImageResponse -> String # showList :: [ExportImageResponse] -> ShowS #
NFData ExportImageResponse Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods rnf :: ExportImageResponse -> () #
Eq ExportImageResponse Source #
Instance details Defined in Amazonka.EC2.ExportImage Methods (==) :: ExportImageResponse -> ExportImageResponse -> Bool # (/=) :: ExportImageResponse -> ExportImageResponse -> Bool #
type Rep ExportImageResponse Source #
Instance details Defined in Amazonka.EC2.ExportImage type Rep ExportImageResponse = D1 ('MetaData "ExportImageResponse" "Amazonka.EC2.ExportImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ExportImageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "diskImageFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiskImageFormat))) :: (S1 ('MetaSel ('Just "exportImageTaskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "progress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3ExportLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportTaskS3Location)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newExportImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:ExportImageResponse'`
-> ExportImageResponse

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 #