CreateRestoreImageTask
Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 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.
- Bucket
-
The name of the Amazon S3 bucket that contains the stored AMI object.
Type: String
Required: Yes
- 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
- Name
-
The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.
Type: String
Required: No
- ObjectKey
-
The name of the stored AMI object in the bucket.
Type: String
Required: Yes
- TagSpecification.N
-
The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.
-
To tag the AMI, the value for
ResourceTypemust beimage. -
To tag the snapshots, the value for
ResourceTypemust besnapshot. The same tag is applied to all of the snapshots that are created.
Type: Array of TagSpecification objects
Required: No
-
Response Elements
The following elements are returned by the service.
- imageId
-
The AMI ID.
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.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
