amazonka-storagegateway-1.5.0: Amazon Storage Gateway SDK.

Copyright(c) 2013-2017 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.DescribeTapes

Contents

Description

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway architecture.

This operation returns paginated results.

Synopsis

Creating a Request

describeTapes Source #

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

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

  • dtMarker - A marker value, obtained in a previous call to DescribeTapes . This marker indicates which page of results to retrieve. If not specified, the first page of results is retrieved.
  • dtLimit - Specifies that the number of virtual tapes described be limited to the specified number.
  • dtTapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
  • dtGatewayARN - Undocumented member.

data DescribeTapes Source #

DescribeTapesInput

See: describeTapes smart constructor.

Instances

Eq DescribeTapes Source # 
Data DescribeTapes Source # 

Methods

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

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

toConstr :: DescribeTapes -> Constr #

dataTypeOf :: DescribeTapes -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeTapes Source # 
Show DescribeTapes Source # 
Generic DescribeTapes Source # 

Associated Types

type Rep DescribeTapes :: * -> * #

Hashable DescribeTapes Source # 
ToJSON DescribeTapes Source # 
NFData DescribeTapes Source # 

Methods

rnf :: DescribeTapes -> () #

AWSPager DescribeTapes Source # 
AWSRequest DescribeTapes Source # 
ToQuery DescribeTapes Source # 
ToPath DescribeTapes Source # 
ToHeaders DescribeTapes Source # 
type Rep DescribeTapes Source # 
type Rep DescribeTapes = D1 (MetaData "DescribeTapes" "Network.AWS.StorageGateway.DescribeTapes" "amazonka-storagegateway-1.5.0-Dl0pEQb6pvFBwTkfuWFwCu" False) (C1 (MetaCons "DescribeTapes'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dtMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dtLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_dtTapeARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dtGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeTapes Source # 

Request Lenses

dtMarker :: Lens' DescribeTapes (Maybe Text) Source #

A marker value, obtained in a previous call to DescribeTapes . This marker indicates which page of results to retrieve. If not specified, the first page of results is retrieved.

dtLimit :: Lens' DescribeTapes (Maybe Natural) Source #

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

dtTapeARNs :: Lens' DescribeTapes [Text] Source #

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

dtGatewayARN :: Lens' DescribeTapes Text Source #

Undocumented member.

Destructuring the Response

describeTapesResponse Source #

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

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

  • dtsrsMarker - An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results. If a response does not contain a marker, then there are no more results to be retrieved.
  • dtsrsTapes - An array of virtual tape descriptions.
  • dtsrsResponseStatus - -- | The response status code.

data DescribeTapesResponse Source #

DescribeTapesOutput

See: describeTapesResponse smart constructor.

Instances

Eq DescribeTapesResponse Source # 
Data DescribeTapesResponse Source # 

Methods

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

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

toConstr :: DescribeTapesResponse -> Constr #

dataTypeOf :: DescribeTapesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeTapesResponse Source # 
Show DescribeTapesResponse Source # 
Generic DescribeTapesResponse Source # 
NFData DescribeTapesResponse Source # 

Methods

rnf :: DescribeTapesResponse -> () #

type Rep DescribeTapesResponse Source # 
type Rep DescribeTapesResponse = D1 (MetaData "DescribeTapesResponse" "Network.AWS.StorageGateway.DescribeTapes" "amazonka-storagegateway-1.5.0-Dl0pEQb6pvFBwTkfuWFwCu" False) (C1 (MetaCons "DescribeTapesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dtsrsTapes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tape]))) (S1 (MetaSel (Just Symbol "_dtsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dtsrsMarker :: Lens' DescribeTapesResponse (Maybe Text) Source #

An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results. If a response does not contain a marker, then there are no more results to be retrieved.

dtsrsTapes :: Lens' DescribeTapesResponse [Tape] Source #

An array of virtual tape descriptions.

dtsrsResponseStatus :: Lens' DescribeTapesResponse Int Source #

  • - | The response status code.