CreateImage
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can
take snapshots of the attached volumes while data is at rest, in order to ensure a consistent
state. You can set the NoReboot
parameter to true
in the API request,
or use the --no-reboot
option in the AWS CLI to prevent Amazon EC2 from shutting down and
rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot
parameter to true
in the API request, or by using the --no-reboot
option
in the AWS CLI, we can't guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- BlockDeviceMapping.N
-
The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
Type: Array of BlockDeviceMapping objects
Required: No
- Description
-
A description for the new image.
Type: String
Required: No
- 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 isUnauthorizedOperation
.Type: Boolean
Required: No
- InstanceId
-
The ID of the instance.
Type: String
Required: Yes
- Name
-
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
Type: String
Required: Yes
- NoReboot
-
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the
NoReboot
parameter totrue
in the API request, or use the--no-reboot
option in the AWS CLI to prevent Amazon EC2 from shutting down and rebooting the instance.Important If you choose to bypass the shutdown and reboot process by setting the
NoReboot
parameter totrue
in the API request, or by using the--no-reboot
option in the AWS CLI, we can't guarantee the file system integrity of the created image.Default:
false
(follow standard reboot process)Type: Boolean
Required: No
- TagSpecification.N
-
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
-
To tag the AMI, the value for
ResourceType
must beimage
. -
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. The same tag is applied to all of the snapshots that are created.
If you specify other values for
ResourceType
, the request fails.To tag an AMI or snapshot after it has been created, see CreateTags.
Type: Array of TagSpecification objects
Required: No
-
Response Elements
The following elements are returned by the service.
- imageId
-
The ID of the new AMI.
Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example 1
This example request creates an AMI from the specified instance.
Sample Request
https://ec2.amazonaws.com/?Action=CreateImage
&Description=Standard+Web+Server+v1.0
&InstanceId=i-1234567890abcdef0
&Name=standard-web-server-v1.0
&AUTHPARAMS
Sample Response
<CreateImageResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<imageId>ami-4fa54026</imageId>
</CreateImageResponse>
Example 2
This example request creates an AMI from the specified instance, and sets the NoReboot parameter to true (the instance is not rebooted before the image is created).
Sample Request
https://ec2.amazonaws.com/?Action=CreateImage
&Description=Standard+Web+Server+v1.0
&InstanceId=i-1234567890abcdef0
&Name=standard-web-server-v1.0
&NoReboot=true
&AUTHPARAMS
Sample Response
<CreateImageResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<imageId>ami-4fa54026</imageId>
</CreateImageResponse>
Example 3
This example request creates an AMI from the specified instance, and tags on creation
the AMI and the snapshots that are created of the root volume and of other Amazon EBS volumes
that are attached to the instance. In this example, the tag that is applied to the AMI and
the snapshots is the same, with a key of purpose
and a value of
test
.
Sample Request
https://ec2.amazonaws.com/?Action=CreateImage
&InstanceId=i-1234567890abcdef0
&TagSpecification.1.ResourceType=image
&TagSpecification.1.Tag.1.Key=purpose
&TagSpecification.1.Tag.1.Value=test
&TagSpecification.2.ResourceType=snapshot
&TagSpecification.2.Tag.1.Key=purpose
&TagSpecification.2.Tag.1.Value=test
&AUTHPARAMS
Sample Response
<CreateImageResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<imageId>ami-4fa54026</imageId>
</CreateImageResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: