amazonka-storagegateway-1.6.1: Amazon Storage Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway.ListTapes

Contents

Description

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.

Synopsis

Creating a Request

listTapes :: ListTapes Source #

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 Source #

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 Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Data ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.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 Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Show ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Generic ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Associated Types

type Rep ListTapes :: Type -> Type #

Hashable ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

ToJSON ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

AWSRequest ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Associated Types

type Rs ListTapes :: Type #

ToHeaders ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Methods

toHeaders :: ListTapes -> [Header] #

ToPath ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

ToQuery ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

NFData ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Methods

rnf :: ListTapes -> () #

type Rep ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

type Rep ListTapes = D1 (MetaData "ListTapes" "Network.AWS.StorageGateway.ListTapes" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "ListTapes'" PrefixI True) (S1 (MetaSel (Just "_ltMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ltLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_ltTapeARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))
type Rs ListTapes Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Request Lenses

ltMarker :: Lens' ListTapes (Maybe Text) Source #

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

ltLimit :: Lens' ListTapes (Maybe Natural) Source #

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

ltTapeARNs :: Lens' ListTapes [Text] Source #

Undocumented member.

Destructuring the Response

listTapesResponse Source #

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 Source #

A JSON object containing the following fields:

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

See: listTapesResponse smart constructor.

Instances
Eq ListTapesResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Data ListTapesResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

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 Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Show ListTapesResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Generic ListTapesResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Associated Types

type Rep ListTapesResponse :: Type -> Type #

NFData ListTapesResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

Methods

rnf :: ListTapesResponse -> () #

type Rep ListTapesResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.ListTapes

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

Response Lenses

ltrsMarker :: Lens' ListTapesResponse (Maybe Text) Source #

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.

ltrsResponseStatus :: Lens' ListTapesResponse Int Source #

  • - | The response status code.