storagegateway_list_tape_pools: Lists custom tape pools

Description Usage Arguments Value Request syntax

View source: R/storagegateway_operations.R

Description

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

Usage

1
storagegateway_list_tape_pools(PoolARNs, Marker, Limit)

Arguments

PoolARNs

The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.

Marker

A string that indicates the position at which to begin the returned list of tape pools.

Limit

An optional number limit for the tape pools in the list returned by this call.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  PoolInfos = list(
    list(
      PoolARN = "string",
      PoolName = "string",
      StorageClass = "DEEP_ARCHIVE"|"GLACIER",
      RetentionLockType = "COMPLIANCE"|"GOVERNANCE"|"NONE",
      RetentionLockTimeInDays = 123,
      PoolStatus = "ACTIVE"|"DELETED"
    )
  ),
  Marker = "string"
)

Request syntax

1
2
3
4
5
6
7
svc$list_tape_pools(
  PoolARNs = list(
    "string"
  ),
  Marker = "string",
  Limit = 123
)

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