Restore Snapshot Tier

ec2_restore_snapshot_tier

R Documentation

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored

Description

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon EBS User Guide.

Usage

ec2_restore_snapshot_tier(SnapshotId, TemporaryRestoreDays,
  PermanentRestore, DryRun)

Arguments

SnapshotId

[required] The ID of the snapshot to restore.

TemporaryRestoreDays

Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.

PermanentRestore

Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.

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(
  SnapshotId = "string",
  RestoreStartTime = as.POSIXct(
    "2015-01-01"
  ),
  RestoreDuration = 123,
  IsPermanentRestore = TRUE|FALSE
)

Request syntax

svc$restore_snapshot_tier(
  SnapshotId = "string",
  TemporaryRestoreDays = 123,
  PermanentRestore = TRUE|FALSE,
  DryRun = TRUE|FALSE
)