| 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.EC2.GetVpnConnectionDeviceTypes
Description
Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
This operation returns paginated results.
Synopsis
- data GetVpnConnectionDeviceTypes = GetVpnConnectionDeviceTypes' {}
- newGetVpnConnectionDeviceTypes :: GetVpnConnectionDeviceTypes
- getVpnConnectionDeviceTypes_dryRun :: Lens' GetVpnConnectionDeviceTypes (Maybe Bool)
- getVpnConnectionDeviceTypes_maxResults :: Lens' GetVpnConnectionDeviceTypes (Maybe Natural)
- getVpnConnectionDeviceTypes_nextToken :: Lens' GetVpnConnectionDeviceTypes (Maybe Text)
- data GetVpnConnectionDeviceTypesResponse = GetVpnConnectionDeviceTypesResponse' {}
- newGetVpnConnectionDeviceTypesResponse :: Int -> GetVpnConnectionDeviceTypesResponse
- getVpnConnectionDeviceTypesResponse_nextToken :: Lens' GetVpnConnectionDeviceTypesResponse (Maybe Text)
- getVpnConnectionDeviceTypesResponse_vpnConnectionDeviceTypes :: Lens' GetVpnConnectionDeviceTypesResponse (Maybe [VpnConnectionDeviceType])
- getVpnConnectionDeviceTypesResponse_httpStatus :: Lens' GetVpnConnectionDeviceTypesResponse Int
Creating a Request
data GetVpnConnectionDeviceTypes Source #
See: newGetVpnConnectionDeviceTypes smart constructor.
Constructors
| GetVpnConnectionDeviceTypes' | |
Fields
| |
Instances
newGetVpnConnectionDeviceTypes :: GetVpnConnectionDeviceTypes Source #
Create a value of GetVpnConnectionDeviceTypes 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:dryRun:GetVpnConnectionDeviceTypes', getVpnConnectionDeviceTypes_dryRun - Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
$sel:maxResults:GetVpnConnectionDeviceTypes', getVpnConnectionDeviceTypes_maxResults - The maximum number of results returned by GetVpnConnectionDeviceTypes
in paginated output. When this parameter is used,
GetVpnConnectionDeviceTypes only returns MaxResults results in a
single page along with a NextToken response element. The remaining
results of the initial request can be seen by sending another
GetVpnConnectionDeviceTypes request with the returned NextToken
value. This value can be between 200 and 1000. If this parameter is not
used, then GetVpnConnectionDeviceTypes returns all results.
GetVpnConnectionDeviceTypes, getVpnConnectionDeviceTypes_nextToken - The NextToken value returned from a previous paginated
GetVpnConnectionDeviceTypes request where MaxResults was used and
the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the NextToken
value. This value is null when there are no more results to return.
Request Lenses
getVpnConnectionDeviceTypes_dryRun :: Lens' GetVpnConnectionDeviceTypes (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
getVpnConnectionDeviceTypes_maxResults :: Lens' GetVpnConnectionDeviceTypes (Maybe Natural) Source #
The maximum number of results returned by GetVpnConnectionDeviceTypes
in paginated output. When this parameter is used,
GetVpnConnectionDeviceTypes only returns MaxResults results in a
single page along with a NextToken response element. The remaining
results of the initial request can be seen by sending another
GetVpnConnectionDeviceTypes request with the returned NextToken
value. This value can be between 200 and 1000. If this parameter is not
used, then GetVpnConnectionDeviceTypes returns all results.
getVpnConnectionDeviceTypes_nextToken :: Lens' GetVpnConnectionDeviceTypes (Maybe Text) Source #
The NextToken value returned from a previous paginated
GetVpnConnectionDeviceTypes request where MaxResults was used and
the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the NextToken
value. This value is null when there are no more results to return.
Destructuring the Response
data GetVpnConnectionDeviceTypesResponse Source #
See: newGetVpnConnectionDeviceTypesResponse smart constructor.
Constructors
| GetVpnConnectionDeviceTypesResponse' | |
Fields
| |
Instances
newGetVpnConnectionDeviceTypesResponse Source #
Arguments
| :: Int | |
| -> GetVpnConnectionDeviceTypesResponse |
Create a value of GetVpnConnectionDeviceTypesResponse 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:
GetVpnConnectionDeviceTypes, getVpnConnectionDeviceTypesResponse_nextToken - The NextToken value to include in a future
GetVpnConnectionDeviceTypes request. When the results of a
GetVpnConnectionDeviceTypes request exceed MaxResults, this value
can be used to retrieve the next page of results. This value is null
when there are no more results to return.
$sel:vpnConnectionDeviceTypes:GetVpnConnectionDeviceTypesResponse', getVpnConnectionDeviceTypesResponse_vpnConnectionDeviceTypes - List of customer gateway devices that have a sample configuration file
available for use.
$sel:httpStatus:GetVpnConnectionDeviceTypesResponse', getVpnConnectionDeviceTypesResponse_httpStatus - The response's http status code.
Response Lenses
getVpnConnectionDeviceTypesResponse_nextToken :: Lens' GetVpnConnectionDeviceTypesResponse (Maybe Text) Source #
The NextToken value to include in a future
GetVpnConnectionDeviceTypes request. When the results of a
GetVpnConnectionDeviceTypes request exceed MaxResults, this value
can be used to retrieve the next page of results. This value is null
when there are no more results to return.
getVpnConnectionDeviceTypesResponse_vpnConnectionDeviceTypes :: Lens' GetVpnConnectionDeviceTypesResponse (Maybe [VpnConnectionDeviceType]) Source #
List of customer gateway devices that have a sample configuration file available for use.
getVpnConnectionDeviceTypesResponse_httpStatus :: Lens' GetVpnConnectionDeviceTypesResponse Int Source #
The response's http status code.