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. This step is required if you're creating an instance store-backed Linux or Windows AMI. For more information, see Creating an Instance Store-Backed Linux AMI and Creating an Instance Store-Backed Windows AMI 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 AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Backup in the Amazon Elastic Compute Cloud User Guide. Note that although you can create a Windows AMI from a snapshot, you can't launch an instance from the AMI - use the CreateImage command instead.

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.

See: AWS API Reference for RegisterImage.

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
• riRAMDiskId
• riKernelId
• riRootDeviceName
• riSRIOVNetSupport
• riArchitecture
• riBlockDeviceMappings
• riDryRun
• riDescription
• riName

data RegisterImage

See: registerImage smart constructor.

Instances

Eq RegisterImage

Data RegisterImage

Read RegisterImage

Show RegisterImage

Generic RegisterImage

AWSRequest RegisterImage

ToPath RegisterImage

ToHeaders RegisterImage

ToQuery RegisterImage

type Rep RegisterImage

type Sv RegisterImage = EC2

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.

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 for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking 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.

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.

riDescription :: Lens' RegisterImage (Maybe Text)

A description for your AMI.

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

rirsStatus

-> 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
• rirsStatus

data RegisterImageResponse

See: registerImageResponse smart constructor.

Instances

Eq RegisterImageResponse

Data RegisterImageResponse

Read RegisterImageResponse

Show RegisterImageResponse

Generic RegisterImageResponse

type Rep RegisterImageResponse

Response Lenses

rirsImageId :: Lens' RegisterImageResponse (Maybe Text)

The ID of the newly registered AMI.

rirsStatus :: Lens' RegisterImageResponse Int

The response status code.