| 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 |
Amazonka.BackupGateway.ListGateways
Description
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
This operation returns paginated results.
Synopsis
- data ListGateways = ListGateways' {}
- newListGateways :: ListGateways
- listGateways_maxResults :: Lens' ListGateways (Maybe Natural)
- listGateways_nextToken :: Lens' ListGateways (Maybe Text)
- data ListGatewaysResponse = ListGatewaysResponse' {}
- newListGatewaysResponse :: Int -> ListGatewaysResponse
- listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [Gateway])
- listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text)
- 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:maxResults:ListGateways', listGateways_maxResults - The maximum number of gateways to list.
ListGateways, listGateways_nextToken - The next item following a partial list of returned resources. For
example, if a request is made to return MaxResults number of
resources, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Request Lenses
listGateways_maxResults :: Lens' ListGateways (Maybe Natural) Source #
The maximum number of gateways to list.
listGateways_nextToken :: Lens' ListGateways (Maybe Text) Source #
The next item following a partial list of returned resources. For
example, if a request is made to return MaxResults number of
resources, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
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:gateways:ListGatewaysResponse', listGatewaysResponse_gateways - A list of your gateways.
ListGateways, listGatewaysResponse_nextToken - The next item following a partial list of returned resources. For
example, if a request is made to return maxResults number of
resources, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
$sel:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.
Response Lenses
listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [Gateway]) Source #
A list of your gateways.
listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text) Source #
The next item following a partial list of returned resources. For
example, if a request is made to return maxResults number of
resources, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int Source #
The response's http status code.