v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-171,1822,9897.4 MB

Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.

get/#Action=GetVpnConnectionDeviceSampleConfiguration

Query parameters

VpnConnectionIdstring required

The <code>VpnConnectionId</code> specifies the Site-to-Site VPN connection used for the sample configuration.

VpnConnectionDeviceTypeIdstring required

Device identifier provided by the <code>GetVpnConnectionDeviceTypes</code> API.

InternetKeyExchangeVersionstring

The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: <code>ikev1</code> or <code>ikev2</code>.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Action'GetVpnConnectionDeviceSampleConfiguration' required
Version'2016-11-15' required

Response

Success