Describe Tapes

storagegateway_describe_tapes

R Documentation

Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs)

Description

Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.

The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of tapes.

Usage

storagegateway_describe_tapes(GatewayARN, TapeARNs, Marker, Limit)

Arguments

GatewayARN

[required]

TapeARNs

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Marker

A marker value, obtained in a previous call to describe_tapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Limit

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

Amazon Web Services may impose its own limit, if this field is not set.

Value

A list with the following syntax:

list(
  Tapes = list(
    list(
      TapeARN = "string",
      TapeBarcode = "string",
      TapeCreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      TapeSizeInBytes = 123,
      TapeStatus = "string",
      VTLDevice = "string",
      Progress = 123.0,
      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_tapes(
  GatewayARN = "string",
  TapeARNs = list(
    "string"
  ),
  Marker = "string",
  Limit = 123
)

Examples

## Not run: 
# Returns a description of the specified Amazon Resource Name (ARN) of
# virtual tapes. If a TapeARN is not specified, returns a description of
# all virtual tapes.
svc$describe_tapes(
  GatewayARN = "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  Limit = 2L,
  Marker = "1",
  TapeARNs = list(
    "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
    "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0"
  )
)

## End(Not run)