Returns a description of specified virtual tapes in the virtual tape shelf (VTS)¶

Description¶

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

Usage¶

storagegateway_describe_tape_archives(TapeARNs, Marker, Limit)

Arguments¶

TapeARNs

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
Marker

An opaque string that indicates the position at which to begin describing virtual tapes.
Limit

Specifies that the number of virtual tapes described be limited to the specified number.

Value¶

A list with the following syntax:

list(
  TapeArchives = list(
    list(
      TapeARN = "string",
      TapeBarcode = "string",
      TapeCreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      TapeSizeInBytes = 123,
      CompletionTime = as.POSIXct(
        "2015-01-01"
      ),
      RetrievedTo = "string",
      TapeStatus = "string",
      TapeUsedInBytes = 123,
      KMSKey = "string",
      PoolId = "string",
      Worm = TRUE|FALSE,
      RetentionStartDate = as.POSIXct(
        "2015-01-01"
      ),
      PoolEntryDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Marker = "string"
)

Request syntax¶

svc$describe_tape_archives(
  TapeARNs = list(
    "string"
  ),
  Marker = "string",
  Limit = 123
)

Examples¶

# Returns a description of specified virtual tapes in the virtual tape
# shelf (VTS).
svc$describe_tape_archives(
  Limit = 123L,
  Marker = "1",
  TapeARNs = list(
    "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD",
    "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  )
)