- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
RestoreImageFromRecycleBinCommand
Restores an AMI from the Recycle Bin. For more information, see Recover deleted Amazon EBS snapshots and EBS-back AMIs with Recycle Bin in the Amazon EC2 User Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, RestoreImageFromRecycleBinCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, RestoreImageFromRecycleBinCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // RestoreImageFromRecycleBinRequest
ImageId: "STRING_VALUE", // required
DryRun: true || false,
};
const command = new RestoreImageFromRecycleBinCommand(input);
const response = await client.send(command);
// { // RestoreImageFromRecycleBinResult
// Return: true || false,
// };
RestoreImageFromRecycleBinCommand Input
See RestoreImageFromRecycleBinCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ImageIdRequired | string | undefined | The ID of the AMI to restore. |
DryRun | boolean | undefined | 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 |
RestoreImageFromRecycleBinCommand Output
See RestoreImageFromRecycleBinCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Return | boolean | undefined | Returns |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| EC2ServiceException | Base exception class for all service exceptions from EC2 service. |