Network.AWS.StorageGateway.ListGateways

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.

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

Defined in Network.AWS.StorageGateway.ListGateways

Methods

(==) :: ListGateways -> ListGateways -> Bool

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

Data ListGateways

Defined in Network.AWS.StorageGateway.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

Defined in Network.AWS.StorageGateway.ListGateways

Methods

readsPrec :: Int -> ReadS ListGateways

readList :: ReadS [ListGateways]

readPrec :: ReadPrec ListGateways

readListPrec :: ReadPrec [ListGateways]

Show ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

showsPrec :: Int -> ListGateways -> ShowS

show :: ListGateways -> String

showList :: [ListGateways] -> ShowS

Generic ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Associated Types

type Rep ListGateways :: Type -> Type

Methods

from :: ListGateways -> Rep ListGateways x

to :: Rep ListGateways x -> ListGateways

Hashable ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

hashWithSalt :: Int -> ListGateways -> Int

hash :: ListGateways -> Int

ToJSON ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

toJSON :: ListGateways -> Value

toEncoding :: ListGateways -> Encoding

toJSONList :: [ListGateways] -> Value

toEncodingList :: [ListGateways] -> Encoding

AWSPager ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

page :: ListGateways -> Rs ListGateways -> Maybe ListGateways

AWSRequest ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Associated Types

type Rs ListGateways :: Type

Methods

request :: ListGateways -> Request ListGateways

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

ToHeaders ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

toHeaders :: ListGateways -> [Header]

ToPath ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

toPath :: ListGateways -> ByteString

ToQuery ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

toQuery :: ListGateways -> QueryString

NFData ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

Methods

rnf :: ListGateways -> ()

type Rep ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

type Rep ListGateways = D1 (MetaData "ListGateways" "Network.AWS.StorageGateway.ListGateways" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "ListGateways'" PrefixI True) (S1 (MetaSel (Just "_lgMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lgLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))

type Rs ListGateways

Defined in Network.AWS.StorageGateway.ListGateways

type Rs ListGateways = ListGatewaysResponse

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

Arguments

:: Int

lgrsResponseStatus

-> 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:

• lgrsMarker - Undocumented member.
• lgrsGateways - Undocumented member.
• lgrsResponseStatus - -- | The response status code.

data ListGatewaysResponse

See: listGatewaysResponse smart constructor.

Instances

Eq ListGatewaysResponse

Defined in Network.AWS.StorageGateway.ListGateways

Methods

(==) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool

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

Data ListGatewaysResponse

Defined in Network.AWS.StorageGateway.ListGateways

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

Defined in Network.AWS.StorageGateway.ListGateways

Methods

readsPrec :: Int -> ReadS ListGatewaysResponse

readList :: ReadS [ListGatewaysResponse]

readPrec :: ReadPrec ListGatewaysResponse

readListPrec :: ReadPrec [ListGatewaysResponse]

Show ListGatewaysResponse

Defined in Network.AWS.StorageGateway.ListGateways

Methods

showsPrec :: Int -> ListGatewaysResponse -> ShowS

show :: ListGatewaysResponse -> String

showList :: [ListGatewaysResponse] -> ShowS

Generic ListGatewaysResponse

Defined in Network.AWS.StorageGateway.ListGateways

Associated Types

type Rep ListGatewaysResponse :: Type -> Type

Methods

from :: ListGatewaysResponse -> Rep ListGatewaysResponse x

to :: Rep ListGatewaysResponse x -> ListGatewaysResponse

NFData ListGatewaysResponse

Defined in Network.AWS.StorageGateway.ListGateways

Methods

rnf :: ListGatewaysResponse -> ()

type Rep ListGatewaysResponse

Defined in Network.AWS.StorageGateway.ListGateways

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

Response Lenses

lgrsMarker :: Lens' ListGatewaysResponse (Maybe Text)

Undocumented member.

lgrsGateways :: Lens' ListGatewaysResponse [GatewayInfo]

Undocumented member.

lgrsResponseStatus :: Lens' ListGatewaysResponse Int

• - | The response status code.