Network.AWS.EC2.RegisterImage

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

Creating a Request

registerImage

Arguments

:: Text

riName

-> RegisterImage

Creates a value of RegisterImage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• riVirtualizationType
• riImageLocation
• riEnaSupport
• riRAMDiskId
• riKernelId
• riRootDeviceName
• riSRIOVNetSupport
• riArchitecture
• riDescription
• riBlockDeviceMappings
• riDryRun
• riName

data RegisterImage

Contains the parameters for RegisterImage.

See: registerImage smart constructor.

Instances

Eq RegisterImage

Methods

(==) :: RegisterImage -> RegisterImage -> Bool

(/=) :: RegisterImage -> RegisterImage -> Bool

Data RegisterImage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterImage -> c RegisterImage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterImage

toConstr :: RegisterImage -> Constr

dataTypeOf :: RegisterImage -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterImage)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterImage)

gmapT :: (forall b. Data b => b -> b) -> RegisterImage -> RegisterImage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterImage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterImage -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterImage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterImage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterImage -> m RegisterImage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterImage -> m RegisterImage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterImage -> m RegisterImage

Read RegisterImage

Methods

readsPrec :: Int -> ReadS RegisterImage

readList :: ReadS [RegisterImage]

readPrec :: ReadPrec RegisterImage

readListPrec :: ReadPrec [RegisterImage]

Show RegisterImage

Methods

showsPrec :: Int -> RegisterImage -> ShowS

show :: RegisterImage -> String

showList :: [RegisterImage] -> ShowS

Generic RegisterImage

Associated Types

type Rep RegisterImage :: * -> *

Methods

from :: RegisterImage -> Rep RegisterImage x

to :: Rep RegisterImage x -> RegisterImage

Hashable RegisterImage

Methods

hashWithSalt :: Int -> RegisterImage -> Int

hash :: RegisterImage -> Int

NFData RegisterImage

Methods

rnf :: RegisterImage -> ()

AWSRequest RegisterImage

Associated Types

type Rs RegisterImage :: *

Methods

request :: RegisterImage -> Request RegisterImage

response :: MonadResource m => Logger -> Service -> Proxy * RegisterImage -> ClientResponse -> m (Response RegisterImage)

ToPath RegisterImage

Methods

toPath :: RegisterImage -> ByteString

ToHeaders RegisterImage

Methods

toHeaders :: RegisterImage -> [Header]

ToQuery RegisterImage

Methods

toQuery :: RegisterImage -> QueryString

type Rep RegisterImage

type Rep RegisterImage = D1 (MetaData "RegisterImage" "Network.AWS.EC2.RegisterImage" "amazonka-ec2-1.4.4-4aYNmHv73MpJXVQjlVKYjQ" False) (C1 (MetaCons "RegisterImage'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_riVirtualizationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_riImageLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_riEnaSupport") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) (S1 (MetaSel (Just Symbol "_riRAMDiskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_riKernelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_riRootDeviceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_riSRIOVNetSupport") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_riArchitecture") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ArchitectureValues))) (S1 (MetaSel (Just Symbol "_riDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_riBlockDeviceMappings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [BlockDeviceMapping]))) ((:*:) (S1 (MetaSel (Just Symbol "_riDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_riName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs RegisterImage

type Rs RegisterImage = RegisterImageResponse

Request Lenses

riVirtualizationType :: Lens' RegisterImage (Maybe Text)

The type of virtualization.

Default: paravirtual

riImageLocation :: Lens' RegisterImage (Maybe Text)

The full path to your AMI manifest in Amazon S3 storage.

riEnaSupport :: Lens' RegisterImage (Maybe Bool)

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

riRAMDiskId :: Lens' RegisterImage (Maybe Text)

The ID of the RAM disk.

riKernelId :: Lens' RegisterImage (Maybe Text)

The ID of the kernel.

riRootDeviceName :: Lens' RegisterImage (Maybe Text)

The name of the root device (for example, '\/dev\/sda1', or '\/dev\/xvda').

riSRIOVNetSupport :: Lens' RegisterImage (Maybe Text)

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

riArchitecture :: Lens' RegisterImage (Maybe ArchitectureValues)

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

riDescription :: Lens' RegisterImage (Maybe Text)

A description for your AMI.

riBlockDeviceMappings :: Lens' RegisterImage [BlockDeviceMapping]

One or more block device mapping entries.

riDryRun :: Lens' RegisterImage (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.

riName :: Lens' RegisterImage Text

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs ('), or underscores(_)

Destructuring the Response

registerImageResponse

Arguments

:: Int

rirsResponseStatus

-> RegisterImageResponse

Creates a value of RegisterImageResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rirsImageId
• rirsResponseStatus

data RegisterImageResponse

Contains the output of RegisterImage.

See: registerImageResponse smart constructor.

Instances

Eq RegisterImageResponse

Methods

(==) :: RegisterImageResponse -> RegisterImageResponse -> Bool

(/=) :: RegisterImageResponse -> RegisterImageResponse -> Bool

Data RegisterImageResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterImageResponse -> c RegisterImageResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterImageResponse

toConstr :: RegisterImageResponse -> Constr

dataTypeOf :: RegisterImageResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterImageResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterImageResponse)

gmapT :: (forall b. Data b => b -> b) -> RegisterImageResponse -> RegisterImageResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterImageResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterImageResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterImageResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterImageResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterImageResponse -> m RegisterImageResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterImageResponse -> m RegisterImageResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterImageResponse -> m RegisterImageResponse

Read RegisterImageResponse

Methods

readsPrec :: Int -> ReadS RegisterImageResponse

readList :: ReadS [RegisterImageResponse]

readPrec :: ReadPrec RegisterImageResponse

readListPrec :: ReadPrec [RegisterImageResponse]

Show RegisterImageResponse

Methods

showsPrec :: Int -> RegisterImageResponse -> ShowS

show :: RegisterImageResponse -> String

showList :: [RegisterImageResponse] -> ShowS

Generic RegisterImageResponse

Associated Types

type Rep RegisterImageResponse :: * -> *

Methods

from :: RegisterImageResponse -> Rep RegisterImageResponse x

to :: Rep RegisterImageResponse x -> RegisterImageResponse

NFData RegisterImageResponse

Methods

rnf :: RegisterImageResponse -> ()

type Rep RegisterImageResponse

type Rep RegisterImageResponse = D1 (MetaData "RegisterImageResponse" "Network.AWS.EC2.RegisterImage" "amazonka-ec2-1.4.4-4aYNmHv73MpJXVQjlVKYjQ" False) (C1 (MetaCons "RegisterImageResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rirsImageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

rirsImageId :: Lens' RegisterImageResponse (Maybe Text)

The ID of the newly registered AMI.

rirsResponseStatus :: Lens' RegisterImageResponse Int

The response status code.