| 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.PrivateNetworks.ListNetworks
Description
Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
This operation returns paginated results.
Synopsis
- data ListNetworks = ListNetworks' {
- filters :: Maybe (HashMap NetworkFilterKeys [Text])
- maxResults :: Maybe Natural
- startToken :: Maybe Text
- newListNetworks :: ListNetworks
- listNetworks_filters :: Lens' ListNetworks (Maybe (HashMap NetworkFilterKeys [Text]))
- listNetworks_maxResults :: Lens' ListNetworks (Maybe Natural)
- listNetworks_startToken :: Lens' ListNetworks (Maybe Text)
- data ListNetworksResponse = ListNetworksResponse' {}
- newListNetworksResponse :: Int -> ListNetworksResponse
- listNetworksResponse_networks :: Lens' ListNetworksResponse (Maybe [Network])
- listNetworksResponse_nextToken :: Lens' ListNetworksResponse (Maybe Text)
- listNetworksResponse_httpStatus :: Lens' ListNetworksResponse Int
Creating a Request
data ListNetworks Source #
See: newListNetworks smart constructor.
Constructors
| ListNetworks' | |
Fields
| |
Instances
newListNetworks :: ListNetworks Source #
Create a value of ListNetworks 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:filters:ListNetworks', listNetworks_filters - The filters.
STATUS- The status (AVAILABLE|CREATED|DELETED|DEPROVISIONING|PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a
filter, the values are joined with an OR, and the request returns all
results that match any of the specified values.
$sel:maxResults:ListNetworks', listNetworks_maxResults - The maximum number of results to return.
$sel:startToken:ListNetworks', listNetworks_startToken - The token for the next page of results.
Request Lenses
listNetworks_filters :: Lens' ListNetworks (Maybe (HashMap NetworkFilterKeys [Text])) Source #
The filters.
STATUS- The status (AVAILABLE|CREATED|DELETED|DEPROVISIONING|PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a
filter, the values are joined with an OR, and the request returns all
results that match any of the specified values.
listNetworks_maxResults :: Lens' ListNetworks (Maybe Natural) Source #
The maximum number of results to return.
listNetworks_startToken :: Lens' ListNetworks (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data ListNetworksResponse Source #
See: newListNetworksResponse smart constructor.
Constructors
| ListNetworksResponse' | |
Instances
newListNetworksResponse Source #
Arguments
| :: Int | |
| -> ListNetworksResponse |
Create a value of ListNetworksResponse 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:networks:ListNetworksResponse', listNetworksResponse_networks - The networks.
$sel:nextToken:ListNetworksResponse', listNetworksResponse_nextToken - The token for the next page of results.
$sel:httpStatus:ListNetworksResponse', listNetworksResponse_httpStatus - The response's http status code.
Response Lenses
listNetworksResponse_networks :: Lens' ListNetworksResponse (Maybe [Network]) Source #
The networks.
listNetworksResponse_nextToken :: Lens' ListNetworksResponse (Maybe Text) Source #
The token for the next page of results.
listNetworksResponse_httpStatus :: Lens' ListNetworksResponse Int Source #
The response's http status code.