Network.AWS.StorageGateway.ListTapes

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter 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 element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

Creating a Request

listTapes :: ListTapes

Creates a value of ListTapes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltMarker - A string that indicates the position at which to begin the returned list of tapes.
• ltLimit - An optional number limit for the tapes in the list returned by this call.
• ltTapeARNs - Undocumented member.

data ListTapes

A JSON object that contains one or more of the following fields:

• 'ListTapesInput$Limit'
• 'ListTapesInput$Marker'
• 'ListTapesInput$TapeARNs'

See: listTapes smart constructor.

Instances

Eq ListTapes

Methods

(==) :: ListTapes -> ListTapes -> Bool

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

Data ListTapes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTapes -> c ListTapes

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTapes

toConstr :: ListTapes -> Constr

dataTypeOf :: ListTapes -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTapes)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTapes)

gmapT :: (forall b. Data b => b -> b) -> ListTapes -> ListTapes

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTapes -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTapes -> r

gmapQ :: (forall d. Data d => d -> u) -> ListTapes -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTapes -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTapes -> m ListTapes

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTapes -> m ListTapes

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTapes -> m ListTapes

Read ListTapes

Methods

readsPrec :: Int -> ReadS ListTapes

readList :: ReadS [ListTapes]

readPrec :: ReadPrec ListTapes

readListPrec :: ReadPrec [ListTapes]

Show ListTapes

Methods

showsPrec :: Int -> ListTapes -> ShowS

show :: ListTapes -> String

showList :: [ListTapes] -> ShowS

Generic ListTapes

Associated Types

type Rep ListTapes :: * -> *

Methods

from :: ListTapes -> Rep ListTapes x

to :: Rep ListTapes x -> ListTapes

Hashable ListTapes

Methods

hashWithSalt :: Int -> ListTapes -> Int

hash :: ListTapes -> Int

ToJSON ListTapes

Methods

toJSON :: ListTapes -> Value

toEncoding :: ListTapes -> Encoding

toJSONList :: [ListTapes] -> Value

toEncodingList :: [ListTapes] -> Encoding

NFData ListTapes

Methods

rnf :: ListTapes -> ()

AWSRequest ListTapes

Associated Types

type Rs ListTapes :: *

Methods

request :: ListTapes -> Request ListTapes

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListTapes -> ClientResponse -> m (Response ListTapes)

ToHeaders ListTapes

Methods

toHeaders :: ListTapes -> [Header]

ToPath ListTapes

Methods

toPath :: ListTapes -> ByteString

ToQuery ListTapes

Methods

toQuery :: ListTapes -> QueryString

type Rep ListTapes

type Rep ListTapes = D1 * (MetaData "ListTapes" "Network.AWS.StorageGateway.ListTapes" "amazonka-storagegateway-1.6.0-4O2jykLIBNRAOy2n0S31Gg" False) (C1 * (MetaCons "ListTapes'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_ltTapeARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))))))

type Rs ListTapes

type Rs ListTapes = ListTapesResponse

Request Lenses

ltMarker :: Lens' ListTapes (Maybe Text)

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

ltLimit :: Lens' ListTapes (Maybe Natural)

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

ltTapeARNs :: Lens' ListTapes [Text]

Undocumented member.

Destructuring the Response

listTapesResponse

Arguments

:: Int

ltrsResponseStatus

-> ListTapesResponse

Creates a value of ListTapesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltrsMarker - A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.
• ltrsTapeInfos - Undocumented member.
• ltrsResponseStatus - -- | The response status code.

data ListTapesResponse

A JSON object containing the following fields:

• 'ListTapesOutput$Marker'
• 'ListTapesOutput$VolumeInfos'

See: listTapesResponse smart constructor.

Instances

Eq ListTapesResponse

Methods

(==) :: ListTapesResponse -> ListTapesResponse -> Bool

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

Data ListTapesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTapesResponse -> c ListTapesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTapesResponse

toConstr :: ListTapesResponse -> Constr

dataTypeOf :: ListTapesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTapesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTapesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListTapesResponse -> ListTapesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTapesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTapesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListTapesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTapesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTapesResponse -> m ListTapesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTapesResponse -> m ListTapesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTapesResponse -> m ListTapesResponse

Read ListTapesResponse

Methods

readsPrec :: Int -> ReadS ListTapesResponse

readList :: ReadS [ListTapesResponse]

readPrec :: ReadPrec ListTapesResponse

readListPrec :: ReadPrec [ListTapesResponse]

Show ListTapesResponse

Methods

showsPrec :: Int -> ListTapesResponse -> ShowS

show :: ListTapesResponse -> String

showList :: [ListTapesResponse] -> ShowS

Generic ListTapesResponse

Associated Types

type Rep ListTapesResponse :: * -> *

Methods

from :: ListTapesResponse -> Rep ListTapesResponse x

to :: Rep ListTapesResponse x -> ListTapesResponse

NFData ListTapesResponse

Methods

rnf :: ListTapesResponse -> ()

type Rep ListTapesResponse

type Rep ListTapesResponse = D1 * (MetaData "ListTapesResponse" "Network.AWS.StorageGateway.ListTapes" "amazonka-storagegateway-1.6.0-4O2jykLIBNRAOy2n0S31Gg" False) (C1 * (MetaCons "ListTapesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltrsTapeInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [TapeInfo]))) (S1 * (MetaSel (Just Symbol "_ltrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ltrsMarker :: Lens' ListTapesResponse (Maybe Text)

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

ltrsTapeInfos :: Lens' ListTapesResponse [TapeInfo]

Undocumented member.

ltrsResponseStatus :: Lens' ListTapesResponse Int

• - | The response status code.