| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.StorageGateway.ListGateways
Description
This operation 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.
See: AWS API Reference for ListGateways.
This operation returns paginated results.
- listGateways :: ListGateways
- data ListGateways
- lgMarker :: Lens' ListGateways (Maybe Text)
- lgLimit :: Lens' ListGateways (Maybe Natural)
- listGatewaysResponse :: Int -> ListGatewaysResponse
- data ListGatewaysResponse
- lgrsMarker :: Lens' ListGatewaysResponse (Maybe Text)
- lgrsGateways :: Lens' ListGatewaysResponse [GatewayInfo]
- lgrsResponseStatus :: Lens' ListGatewaysResponse Int
Creating a Request
listGateways :: ListGateways Source
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:
data ListGateways Source
A JSON object containing zero or more of the following fields:
- ListGatewaysInput$Limit
- ListGatewaysInput$Marker
See: listGateways smart constructor.
Instances
Request Lenses
lgMarker :: Lens' ListGateways (Maybe Text) Source
An opaque string that indicates the position at which to begin the returned list of gateways.
lgLimit :: Lens' ListGateways (Maybe Natural) Source
Specifies that the list of gateways returned be limited to the specified number of items.
Destructuring the Response
Arguments
| :: Int | |
| -> 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 Source
See: listGatewaysResponse smart constructor.
Response Lenses
lgrsMarker :: Lens' ListGatewaysResponse (Maybe Text) Source
Undocumented member.
lgrsGateways :: Lens' ListGatewaysResponse [GatewayInfo] Source
Undocumented member.
lgrsResponseStatus :: Lens' ListGatewaysResponse Int Source
The response status code.