storagegateway_describe_tapes: Returns a description of the specified Amazon Resource Name...

Description Usage Arguments Value Request syntax Examples

View source: R/storagegateway_operations.R

Description

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 associated with the specified gateway. This operation is only supported in the tape gateway type.

Usage

1
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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

1
2
3
4
5
6
7
8
svc$describe_tapes(
  GatewayARN = "string",
  TapeARNs = list(
    "string"
  ),
  Marker = "string",
  Limit = 123
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## 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)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.