Amazonka.StorageGateway.ListTapePools

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.

This operation returns paginated results.

Creating a Request

data ListTapePools

See: newListTapePools smart constructor.

Constructors

ListTapePools'

Fields

• limit :: Maybe Natural

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

• marker :: Maybe Text

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

• poolARNs :: Maybe [Text]

  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.

Instances

ToJSON ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

toJSON :: ListTapePools -> Value

toEncoding :: ListTapePools -> Encoding

toJSONList :: [ListTapePools] -> Value

toEncodingList :: [ListTapePools] -> Encoding

ToHeaders ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

toHeaders :: ListTapePools -> [Header]

ToPath ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

toPath :: ListTapePools -> ByteString

ToQuery ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

toQuery :: ListTapePools -> QueryString

AWSPager ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

page :: ListTapePools -> AWSResponse ListTapePools -> Maybe ListTapePools

AWSRequest ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Associated Types

type AWSResponse ListTapePools

Methods

request :: (Service -> Service) -> ListTapePools -> Request ListTapePools

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTapePools -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTapePools)))

Generic ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Associated Types

type Rep ListTapePools :: Type -> Type

Methods

from :: ListTapePools -> Rep ListTapePools x

to :: Rep ListTapePools x -> ListTapePools

Read ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

readsPrec :: Int -> ReadS ListTapePools

readList :: ReadS [ListTapePools]

readPrec :: ReadPrec ListTapePools

readListPrec :: ReadPrec [ListTapePools]

Show ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

showsPrec :: Int -> ListTapePools -> ShowS

show :: ListTapePools -> String

showList :: [ListTapePools] -> ShowS

NFData ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

rnf :: ListTapePools -> ()

Eq ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

(==) :: ListTapePools -> ListTapePools -> Bool

(/=) :: ListTapePools -> ListTapePools -> Bool

Hashable ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

Methods

hashWithSalt :: Int -> ListTapePools -> Int

hash :: ListTapePools -> Int

type AWSResponse ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

type AWSResponse ListTapePools = ListTapePoolsResponse

type Rep ListTapePools

Defined in Amazonka.StorageGateway.ListTapePools

type Rep ListTapePools = D1 ('MetaData "ListTapePools" "Amazonka.StorageGateway.ListTapePools" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "ListTapePools'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "poolARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newListTapePools :: ListTapePools

Create a value of ListTapePools with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListTapePools', listTapePools_limit - An optional number limit for the tape pools in the list returned by this call.

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

$sel:poolARNs:ListTapePools', listTapePools_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.

Request Lenses

listTapePools_limit :: Lens' ListTapePools (Maybe Natural)

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

listTapePools_marker :: Lens' ListTapePools (Maybe Text)

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

listTapePools_poolARNs :: Lens' ListTapePools (Maybe [Text])

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.

Destructuring the Response

data ListTapePoolsResponse

See: newListTapePoolsResponse smart constructor.

Constructors

ListTapePoolsResponse'

Fields

• marker :: Maybe Text

  A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.

• poolInfos :: Maybe [PoolInfo]

  An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListTapePoolsResponse

Defined in Amazonka.StorageGateway.ListTapePools

Associated Types

type Rep ListTapePoolsResponse :: Type -> Type

Methods

from :: ListTapePoolsResponse -> Rep ListTapePoolsResponse x

to :: Rep ListTapePoolsResponse x -> ListTapePoolsResponse

Read ListTapePoolsResponse

Defined in Amazonka.StorageGateway.ListTapePools

Methods

readsPrec :: Int -> ReadS ListTapePoolsResponse

readList :: ReadS [ListTapePoolsResponse]

readPrec :: ReadPrec ListTapePoolsResponse

readListPrec :: ReadPrec [ListTapePoolsResponse]

Show ListTapePoolsResponse

Defined in Amazonka.StorageGateway.ListTapePools

Methods

showsPrec :: Int -> ListTapePoolsResponse -> ShowS

show :: ListTapePoolsResponse -> String

showList :: [ListTapePoolsResponse] -> ShowS

NFData ListTapePoolsResponse

Defined in Amazonka.StorageGateway.ListTapePools

Methods

rnf :: ListTapePoolsResponse -> ()

Eq ListTapePoolsResponse

Defined in Amazonka.StorageGateway.ListTapePools

Methods

(==) :: ListTapePoolsResponse -> ListTapePoolsResponse -> Bool

(/=) :: ListTapePoolsResponse -> ListTapePoolsResponse -> Bool

type Rep ListTapePoolsResponse

Defined in Amazonka.StorageGateway.ListTapePools

type Rep ListTapePoolsResponse = D1 ('MetaData "ListTapePoolsResponse" "Amazonka.StorageGateway.ListTapePools" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "ListTapePoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "poolInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PoolInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTapePoolsResponse

Arguments

:: Int

$sel:httpStatus:ListTapePoolsResponse'

-> ListTapePoolsResponse

Create a value of ListTapePoolsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListTapePools, listTapePoolsResponse_marker - A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.

$sel:poolInfos:ListTapePoolsResponse', listTapePoolsResponse_poolInfos - An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

$sel:httpStatus:ListTapePoolsResponse', listTapePoolsResponse_httpStatus - The response's http status code.

Response Lenses

listTapePoolsResponse_marker :: Lens' ListTapePoolsResponse (Maybe Text)

A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.

listTapePoolsResponse_poolInfos :: Lens' ListTapePoolsResponse (Maybe [PoolInfo])

An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

listTapePoolsResponse_httpStatus :: Lens' ListTapePoolsResponse Int

The response's http status code.