Skip to content

Deregister Image

ec2_deregister_image R Documentation

Deregisters the specified AMI

Description

Deregisters the specified AMI. A deregistered AMI can't be used to launch new instances.

If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin in the Amazon EBS User Guide.

When deregistering an EBS-backed AMI, you can optionally delete its associated snapshots at the same time. However, if a snapshot is associated with multiple AMIs, it won't be deleted even if specified for deletion, although the AMI will still be deregistered.

Deregistering an AMI does not delete the following:

  • Instances already launched from the AMI. You'll continue to incur usage costs for the instances until you terminate them.

  • For EBS-backed AMIs: Snapshots that are associated with multiple AMIs. You'll continue to incur snapshot storage costs.

  • For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll continue to incur S3 storage costs.

For more information, see Deregister an Amazon EC2 AMI in the Amazon EC2 User Guide.

Usage

ec2_deregister_image(ImageId, DeleteAssociatedSnapshots, DryRun)

Arguments

ImageId

[required] The ID of the AMI.
DeleteAssociatedSnapshots

Specifies whether to delete the snapshots associated with the AMI during deregistration.

If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting.

Default: The snapshots are not deleted.
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 is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE,
  DeleteSnapshotResults = list(
    list(
      SnapshotId = "string",
      ReturnCode = "success"|"skipped"|"missing-permissions"|"internal-error"|"client-error"
    )
  )
)

Request syntax

svc$deregister_image(
  ImageId = "string",
  DeleteAssociatedSnapshots = TRUE|FALSE,
  DryRun = TRUE|FALSE
)