GetVpnConnectionDeviceTypes
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 AWS Site-to-Site VPN User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- MaxResults
-
The maximum number of results returned by
GetVpnConnectionDeviceTypesin paginated output. When this parameter is used,GetVpnConnectionDeviceTypesonly returnsMaxResultsresults in a single page along with aNextTokenresponse element. The remaining results of the initial request can be seen by sending anotherGetVpnConnectionDeviceTypesrequest with the returnedNextTokenvalue. This value can be between 200 and 1000. If this parameter is not used, thenGetVpnConnectionDeviceTypesreturns all results.Type: Integer
Valid Range: Minimum value of 200. Maximum value of 1000.
Required: No
- NextToken
-
The
NextTokenvalue returned from a previous paginatedGetVpnConnectionDeviceTypesrequest whereMaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextTokenvalue. This value is null when there are no more results to return.Type: String
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
The
NextTokenvalue to include in a futureGetVpnConnectionDeviceTypesrequest. When the results of aGetVpnConnectionDeviceTypesrequest exceedMaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
- vpnConnectionDeviceTypeSet
-
List of customer gateway devices that have a sample configuration file available for use.
Type: Array of VpnConnectionDeviceType objects
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
