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.ListGateways

Contents

Description

Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

This operation returns paginated results.

Synopsis

Creating a Request

listGateways :: ListGateways #

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

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

  • lgMarker - An opaque string that indicates the position at which to begin the returned list of gateways.
  • lgLimit - Specifies that the list of gateways returned be limited to the specified number of items.

data ListGateways #

A JSON object containing zero or more of the following fields:

  • 'ListGatewaysInput$Limit'
  • 'ListGatewaysInput$Marker'

See: listGateways smart constructor.

Instances

Eq ListGateways # 
Data ListGateways # 

Methods

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

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

toConstr :: ListGateways -> Constr #

dataTypeOf :: ListGateways -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListGateways # 
Show ListGateways # 
Generic ListGateways # 

Associated Types

type Rep ListGateways :: * -> * #

Hashable ListGateways # 
ToJSON ListGateways # 
NFData ListGateways # 

Methods

rnf :: ListGateways -> () #

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

Request Lenses

lgMarker :: Lens' ListGateways (Maybe Text) #

An opaque string that indicates the position at which to begin the returned list of gateways.

lgLimit :: Lens' ListGateways (Maybe Natural) #

Specifies that the list of gateways returned be limited to the specified number of items.

Destructuring the Response

listGatewaysResponse #

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

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

data ListGatewaysResponse #

See: listGatewaysResponse smart constructor.

Instances

Eq ListGatewaysResponse # 
Data ListGatewaysResponse # 

Methods

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

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

toConstr :: ListGatewaysResponse -> Constr #

dataTypeOf :: ListGatewaysResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListGatewaysResponse # 
Show ListGatewaysResponse # 
Generic ListGatewaysResponse # 
NFData ListGatewaysResponse # 

Methods

rnf :: ListGatewaysResponse -> () #

type Rep ListGatewaysResponse # 
type Rep ListGatewaysResponse = D1 (MetaData "ListGatewaysResponse" "Network.AWS.StorageGateway.ListGateways" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" False) (C1 (MetaCons "ListGatewaysResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lgrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lgrsGateways") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GatewayInfo]))) (S1 (MetaSel (Just Symbol "_lgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lgrsMarker :: Lens' ListGatewaysResponse (Maybe Text) #

Undocumented member.

lgrsResponseStatus :: Lens' ListGatewaysResponse Int #

  • - | The response status code.