paws.compute (version 0.1.12)

ec2_delete_snapshot: Deletes the specified snapshot

Description

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

Usage

ec2_delete_snapshot(SnapshotId, DryRun)

Value

An empty list.

Arguments

SnapshotId

[required] The ID of the EBS snapshot.

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.

Request syntax

svc$delete_snapshot(
  SnapshotId = "string",
  DryRun = TRUE|FALSE
)

Examples

if (FALSE) {
# This example deletes a snapshot with the snapshot ID of
# `snap-1234567890abcdef0`. If the command succeeds, no output is
# returned.
svc$delete_snapshot(
  SnapshotId = "snap-1234567890abcdef0"
)
}