| 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.ListNetworkSites
Description
Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
This operation returns paginated results.
Synopsis
- data ListNetworkSites = ListNetworkSites' {
- filters :: Maybe (HashMap NetworkSiteFilterKeys [Text])
- maxResults :: Maybe Natural
- startToken :: Maybe Text
- networkArn :: Text
- newListNetworkSites :: Text -> ListNetworkSites
- listNetworkSites_filters :: Lens' ListNetworkSites (Maybe (HashMap NetworkSiteFilterKeys [Text]))
- listNetworkSites_maxResults :: Lens' ListNetworkSites (Maybe Natural)
- listNetworkSites_startToken :: Lens' ListNetworkSites (Maybe Text)
- listNetworkSites_networkArn :: Lens' ListNetworkSites Text
- data ListNetworkSitesResponse = ListNetworkSitesResponse' {
- networkSites :: Maybe [NetworkSite]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListNetworkSitesResponse :: Int -> ListNetworkSitesResponse
- listNetworkSitesResponse_networkSites :: Lens' ListNetworkSitesResponse (Maybe [NetworkSite])
- listNetworkSitesResponse_nextToken :: Lens' ListNetworkSitesResponse (Maybe Text)
- listNetworkSitesResponse_httpStatus :: Lens' ListNetworkSitesResponse Int
Creating a Request
data ListNetworkSites Source #
See: newListNetworkSites smart constructor.
Constructors
| ListNetworkSites' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListNetworkSites |
Create a value of ListNetworkSites 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:ListNetworkSites', listNetworkSites_filters - The filters. Add filters to your request to return a more specific list
of results. Use filters to match the status of the network sites.
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:ListNetworkSites', listNetworkSites_maxResults - The maximum number of results to return.
$sel:startToken:ListNetworkSites', listNetworkSites_startToken - The token for the next page of results.
ListNetworkSites, listNetworkSites_networkArn - The Amazon Resource Name (ARN) of the network.
Request Lenses
listNetworkSites_filters :: Lens' ListNetworkSites (Maybe (HashMap NetworkSiteFilterKeys [Text])) Source #
The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.
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.
listNetworkSites_maxResults :: Lens' ListNetworkSites (Maybe Natural) Source #
The maximum number of results to return.
listNetworkSites_startToken :: Lens' ListNetworkSites (Maybe Text) Source #
The token for the next page of results.
listNetworkSites_networkArn :: Lens' ListNetworkSites Text Source #
The Amazon Resource Name (ARN) of the network.
Destructuring the Response
data ListNetworkSitesResponse Source #
See: newListNetworkSitesResponse smart constructor.
Constructors
| ListNetworkSitesResponse' | |
Fields
| |
Instances
newListNetworkSitesResponse Source #
Create a value of ListNetworkSitesResponse 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:networkSites:ListNetworkSitesResponse', listNetworkSitesResponse_networkSites - Information about the network sites.
$sel:nextToken:ListNetworkSitesResponse', listNetworkSitesResponse_nextToken - The token for the next page of results.
$sel:httpStatus:ListNetworkSitesResponse', listNetworkSitesResponse_httpStatus - The response's http status code.
Response Lenses
listNetworkSitesResponse_networkSites :: Lens' ListNetworkSitesResponse (Maybe [NetworkSite]) Source #
Information about the network sites.
listNetworkSitesResponse_nextToken :: Lens' ListNetworkSitesResponse (Maybe Text) Source #
The token for the next page of results.
listNetworkSitesResponse_httpStatus :: Lens' ListNetworkSitesResponse Int Source #
The response's http status code.