[ aws . ec2 ]

restore-image-from-recycle-bin

Description

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  restore-image-from-recycle-bin
--image-id <value>
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--image-id (string)

The ID of the AMI to restore.

--dry-run | --no-dry-run (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To restore an image from the Recycle Bin

The following restore-image-from-recycle-bin example restores AMI ami-0111222333444abcd from the Recycle Bin.

aws ec2 restore-image-from-recycle-bin \
    --image-id ami-0111222333444abcd

Output:

{
    "Return": true
}

For more information, see Recover AMIs from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

Output

Return -> (boolean)

Returns true if the request succeeds; otherwise, it returns an error.