Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Lists gateways owned by an Amazon Web Services account in an Amazon Web Services 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
- data ListGateways = ListGateways' {}
- newListGateways :: ListGateways
- listGateways_limit :: Lens' ListGateways (Maybe Natural)
- listGateways_marker :: Lens' ListGateways (Maybe Text)
- data ListGatewaysResponse = ListGatewaysResponse' {
- gateways :: Maybe [GatewayInfo]
- marker :: Maybe Text
- httpStatus :: Int
- newListGatewaysResponse :: Int -> ListGatewaysResponse
- listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [GatewayInfo])
- listGatewaysResponse_marker :: Lens' ListGatewaysResponse (Maybe Text)
- listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int
Creating a Request
data ListGateways Source #
A JSON object containing zero or more of the following fields:
- ListGatewaysInput$Limit
- ListGatewaysInput$Marker
See: newListGateways
smart constructor.
Instances
newListGateways :: ListGateways Source #
Create a value of ListGateways
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limit:ListGateways'
, listGateways_limit
- Specifies that the list of gateways returned be limited to the specified
number of items.
ListGateways
, listGateways_marker
- An opaque string that indicates the position at which to begin the
returned list of gateways.
Request Lenses
listGateways_limit :: Lens' ListGateways (Maybe Natural) Source #
Specifies that the list of gateways returned be limited to the specified number of items.
listGateways_marker :: Lens' ListGateways (Maybe Text) Source #
An opaque string that indicates the position at which to begin the returned list of gateways.
Destructuring the Response
data ListGatewaysResponse Source #
See: newListGatewaysResponse
smart constructor.
ListGatewaysResponse' | |
|
Instances
newListGatewaysResponse Source #
Create a value of ListGatewaysResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gateways:ListGatewaysResponse'
, listGatewaysResponse_gateways
- An array of GatewayInfo objects.
ListGateways
, listGatewaysResponse_marker
- Use the marker in your next request to fetch the next set of gateways in
the list. If there are no more gateways to list, this field does not
appear in the response.
$sel:httpStatus:ListGatewaysResponse'
, listGatewaysResponse_httpStatus
- The response's http status code.
Response Lenses
listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [GatewayInfo]) Source #
An array of GatewayInfo objects.
listGatewaysResponse_marker :: Lens' ListGatewaysResponse (Maybe Text) Source #
Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.
listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int Source #
The response's http status code.