| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AlexaBusiness.ListGateways
Description
Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
Synopsis
- data ListGateways = ListGateways' {}
- newListGateways :: ListGateways
- listGateways_nextToken :: Lens' ListGateways (Maybe Text)
- listGateways_gatewayGroupArn :: Lens' ListGateways (Maybe Text)
- listGateways_maxResults :: Lens' ListGateways (Maybe Natural)
- data ListGatewaysResponse = ListGatewaysResponse' {
- nextToken :: Maybe Text
- gateways :: Maybe [GatewaySummary]
- httpStatus :: Int
- newListGatewaysResponse :: Int -> ListGatewaysResponse
- listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text)
- listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [GatewaySummary])
- listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int
Creating a Request
data ListGateways Source #
See: newListGateways smart constructor.
Constructors
| ListGateways' | |
Fields
| |
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:nextToken:ListGateways', listGateways_nextToken - The token used to paginate though multiple pages of gateway summaries.
$sel:gatewayGroupArn:ListGateways', listGateways_gatewayGroupArn - The gateway group ARN for which to list gateways.
$sel:maxResults:ListGateways', listGateways_maxResults - The maximum number of gateway summaries to return. The default is 50.
Request Lenses
listGateways_nextToken :: Lens' ListGateways (Maybe Text) Source #
The token used to paginate though multiple pages of gateway summaries.
listGateways_gatewayGroupArn :: Lens' ListGateways (Maybe Text) Source #
The gateway group ARN for which to list gateways.
listGateways_maxResults :: Lens' ListGateways (Maybe Natural) Source #
The maximum number of gateway summaries to return. The default is 50.
Destructuring the Response
data ListGatewaysResponse Source #
See: newListGatewaysResponse smart constructor.
Constructors
| ListGatewaysResponse' | |
Fields
| |
Instances
newListGatewaysResponse Source #
Arguments
| :: Int | |
| -> ListGatewaysResponse |
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:nextToken:ListGateways', listGatewaysResponse_nextToken - The token used to paginate though multiple pages of gateway summaries.
$sel:gateways:ListGatewaysResponse', listGatewaysResponse_gateways - The gateways in the list.
$sel:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.
Response Lenses
listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text) Source #
The token used to paginate though multiple pages of gateway summaries.
listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [GatewaySummary]) Source #
The gateways in the list.
listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int Source #
The response's http status code.