Skip to content

Describe Snapshot Tier Status

ec2_describe_snapshot_tier_status R Documentation

Describes the storage tier status of one or more Amazon EBS snapshots

Description

Describes the storage tier status of one or more Amazon EBS snapshots.

Usage

ec2_describe_snapshot_tier_status(Filters, DryRun, NextToken,
  MaxResults)

Arguments

Filters

The filters.

  • snapshot-id - The snapshot ID.

  • volume-id - The ID of the volume the snapshot is for.

  • last-tiering-operation - The state of the last archive or restore action. (⁠archival-in-progress⁠ | archival-completed | archival-failed | ⁠permanent-restore-in-progress⁠ | permanent-restore-completed | permanent-restore-failed | ⁠temporary-restore-in-progress⁠ | temporary-restore-completed | temporary-restore-failed)

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.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Value

A list with the following syntax: 

list(
  SnapshotTierStatuses = list(
    list(
      SnapshotId = "string",
      VolumeId = "string",
      Status = "pending"|"completed"|"error"|"recoverable"|"recovering",
      OwnerId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      StorageTier = "archive"|"standard",
      LastTieringStartTime = as.POSIXct(
        "2015-01-01"
      ),
      LastTieringProgress = 123,
      LastTieringOperationStatus = "archival-in-progress"|"archival-completed"|"archival-failed"|"temporary-restore-in-progress"|"temporary-restore-completed"|"temporary-restore-failed"|"permanent-restore-in-progress"|"permanent-restore-completed"|"permanent-restore-failed",
      LastTieringOperationStatusDetail = "string",
      ArchivalCompleteTime = as.POSIXct(
        "2015-01-01"
      ),
      RestoreExpiryTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_snapshot_tier_status(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)