| 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.IoTSecureTunneling.ListTunnels
Description
List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.
Requires permission to access the ListTunnels action.
Synopsis
- data ListTunnels = ListTunnels' {}
- newListTunnels :: ListTunnels
- listTunnels_maxResults :: Lens' ListTunnels (Maybe Natural)
- listTunnels_nextToken :: Lens' ListTunnels (Maybe Text)
- listTunnels_thingName :: Lens' ListTunnels (Maybe Text)
- data ListTunnelsResponse = ListTunnelsResponse' {
- nextToken :: Maybe Text
- tunnelSummaries :: Maybe [TunnelSummary]
- httpStatus :: Int
- newListTunnelsResponse :: Int -> ListTunnelsResponse
- listTunnelsResponse_nextToken :: Lens' ListTunnelsResponse (Maybe Text)
- listTunnelsResponse_tunnelSummaries :: Lens' ListTunnelsResponse (Maybe [TunnelSummary])
- listTunnelsResponse_httpStatus :: Lens' ListTunnelsResponse Int
Creating a Request
data ListTunnels Source #
See: newListTunnels smart constructor.
Constructors
| ListTunnels' | |
Fields
| |
Instances
newListTunnels :: ListTunnels Source #
Create a value of ListTunnels 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:ListTunnels', listTunnels_maxResults - The maximum number of results to return at once.
ListTunnels, listTunnels_nextToken - To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
ListTunnels, listTunnels_thingName - The name of the IoT thing associated with the destination device.
Request Lenses
listTunnels_maxResults :: Lens' ListTunnels (Maybe Natural) Source #
The maximum number of results to return at once.
listTunnels_nextToken :: Lens' ListTunnels (Maybe Text) Source #
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
listTunnels_thingName :: Lens' ListTunnels (Maybe Text) Source #
The name of the IoT thing associated with the destination device.
Destructuring the Response
data ListTunnelsResponse Source #
See: newListTunnelsResponse smart constructor.
Constructors
| ListTunnelsResponse' | |
Fields
| |
Instances
newListTunnelsResponse Source #
Arguments
| :: Int | |
| -> ListTunnelsResponse |
Create a value of ListTunnelsResponse 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:
ListTunnels, listTunnelsResponse_nextToken - The token to use to get the next set of results, or null if there are no
additional results.
$sel:tunnelSummaries:ListTunnelsResponse', listTunnelsResponse_tunnelSummaries - A short description of the tunnels in an Amazon Web Services account.
$sel:httpStatus:ListTunnelsResponse', listTunnelsResponse_httpStatus - The response's http status code.
Response Lenses
listTunnelsResponse_nextToken :: Lens' ListTunnelsResponse (Maybe Text) Source #
The token to use to get the next set of results, or null if there are no additional results.
listTunnelsResponse_tunnelSummaries :: Lens' ListTunnelsResponse (Maybe [TunnelSummary]) Source #
A short description of the tunnels in an Amazon Web Services account.
listTunnelsResponse_httpStatus :: Lens' ListTunnelsResponse Int Source #
The response's http status code.