Operations
The Amazon EC2 API consists of web service operations for every task the service can perform. This
section describes each operation in detail.
RegisterImage
The RegisterImage operation registers an AMI with Amazon EC2. Images must be registered before
they can be launched.
Each AMI is associated with an unique ID which is provided by the EC2 service via the Registerimage
operation. As part of the registration process, Amazon EC2 will retrieve the specified image manifest
from Amazon S3 and verify that the image is owned by the user requesting image registration.
The image manifest is retrieved once and stored within the Amazon EC2 network. Any modifications to
an image in Amazon S3 invalidate this registration. If you do have to make changes and upload a new
image deregister the previous image and register the new image.
Request Parameters
The following table describes the request parameters for RegisterImage. Parameter names are case
sensitive.
Element Name Definition Re-
quired?
Type
imageLocation Full path to your AMI manifest in
Amazon S3 storage.
Yes xsd:string
Response Tags
The following table describes the default response tags included in RegisterImage responses.
Element Name Definition Type
imageId Unique ID of the newly registered machine
image.
xsd:string
Sample Request
<RegisterImage xmlns="http://ec2.amazonaws.com/doc/2006-06-26">
<imageLocation>/mybucket/myimage.manifest</imageLocation>
</RegisterImage>
Sample Response
<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2006-06-26">
<imageId>ami-61a54008</imageId>
</RegisterImageResponse>
Amazon EC2
Developer Guide
56
Related Operations
DescribeImages
DeregisterImage
DescribeImages
The DescribeImages operation returns information about AMIs available for use by the user making
the request. This includes both public AMIs (those available for any user to launch) and private images
(those available for launch by the image owner only).
An optional list of AMI IDs may be provided to request information for those AMIs only. If no AMI IDs
are provided, information of all relevant AMIs will be returned. If an image is specified that does not
exist a fault is returned. If an image is specified that exists but is not owned by the user making the
request, then that image will not be included in the returned results.
Deregistered images will be included in the returned results for an unspecified interval subsequent to
deregistration.
Request Parameters
The following table describes the request parameters for DescribeImages. Parameter names are case
sensitive.
Element Name Definition Re-
quired?
Type
imageSet AMI IDs to describe. Yes (but
may be
empty)
xsd:string[]
Response Tags
The following table describes the default response tags included in DescribeImages responses.
Element Name Definition
imagesSet A list of image descriptions
Sample Request
<DescribeImages xmlns="http://ec2.amazonaws.com/doc/2006-06-26">
<imagesSet>
<item>
<imageId>ami-61a54008</imageId>
</item>
</imagesSet>
</DescribeImages></SOAP-ENV:Body></SOAP-ENV:Envelope>
Sample Response
Amazon EC2
Developer Guide
57
Previous Page Next Page