amazonka-storagegateway-1.4.5: Amazon Storage Gateway SDK.

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

Network.AWS.StorageGateway.DescribeTapeArchives

Contents

Description

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

This operation returns paginated results.

Synopsis

Creating a Request

describeTapeArchives :: DescribeTapeArchives #

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

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

  • dtaMarker - An opaque string that indicates the position at which to begin describing virtual tapes.
  • dtaLimit - Specifies that the number of virtual tapes descried be limited to the specified number.
  • dtaTapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

data DescribeTapeArchives #

DescribeTapeArchivesInput

See: describeTapeArchives smart constructor.

Instances

Eq DescribeTapeArchives # 
Data DescribeTapeArchives # 

Methods

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

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

toConstr :: DescribeTapeArchives -> Constr #

dataTypeOf :: DescribeTapeArchives -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeTapeArchives -> DescribeTapeArchives #

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

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

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

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

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

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

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

Read DescribeTapeArchives # 
Show DescribeTapeArchives # 
Generic DescribeTapeArchives # 
Hashable DescribeTapeArchives # 
ToJSON DescribeTapeArchives # 
NFData DescribeTapeArchives # 

Methods

rnf :: DescribeTapeArchives -> () #

AWSPager DescribeTapeArchives # 
AWSRequest DescribeTapeArchives # 
ToQuery DescribeTapeArchives # 
ToPath DescribeTapeArchives # 
ToHeaders DescribeTapeArchives # 
type Rep DescribeTapeArchives # 
type Rep DescribeTapeArchives = D1 (MetaData "DescribeTapeArchives" "Network.AWS.StorageGateway.DescribeTapeArchives" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" False) (C1 (MetaCons "DescribeTapeArchives'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtaMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dtaLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dtaTapeARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))))
type Rs DescribeTapeArchives # 

Request Lenses

dtaMarker :: Lens' DescribeTapeArchives (Maybe Text) #

An opaque string that indicates the position at which to begin describing virtual tapes.

dtaLimit :: Lens' DescribeTapeArchives (Maybe Natural) #

Specifies that the number of virtual tapes descried be limited to the specified number.

dtaTapeARNs :: Lens' DescribeTapeArchives [Text] #

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Destructuring the Response

describeTapeArchivesResponse #

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

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

  • dtarsTapeArchives - An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
  • dtarsMarker - An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
  • dtarsResponseStatus - -- | The response status code.

data DescribeTapeArchivesResponse #

DescribeTapeArchivesOutput

See: describeTapeArchivesResponse smart constructor.

Instances

Eq DescribeTapeArchivesResponse # 
Data DescribeTapeArchivesResponse # 

Methods

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

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

toConstr :: DescribeTapeArchivesResponse -> Constr #

dataTypeOf :: DescribeTapeArchivesResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeTapeArchivesResponse -> DescribeTapeArchivesResponse #

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

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

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

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

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

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

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

Read DescribeTapeArchivesResponse # 
Show DescribeTapeArchivesResponse # 
Generic DescribeTapeArchivesResponse # 
NFData DescribeTapeArchivesResponse # 
type Rep DescribeTapeArchivesResponse # 
type Rep DescribeTapeArchivesResponse = D1 (MetaData "DescribeTapeArchivesResponse" "Network.AWS.StorageGateway.DescribeTapeArchives" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" False) (C1 (MetaCons "DescribeTapeArchivesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtarsTapeArchives") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [TapeArchive]))) ((:*:) (S1 (MetaSel (Just Symbol "_dtarsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dtarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dtarsTapeArchives :: Lens' DescribeTapeArchivesResponse [TapeArchive] #

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

dtarsMarker :: Lens' DescribeTapeArchivesResponse (Maybe Text) #

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.