Amazon Elastic Compute Cloud

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

See also: AWS API Documentation

Request Syntax

client.get_vpn_connection_device_sample_configuration(
    VpnConnectionId='string',
    VpnConnectionDeviceTypeId='string',
    InternetKeyExchangeVersion='string',
    DryRun=True|False
)

type VpnConnectionId:

string

param VpnConnectionId:

[REQUIRED]

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.

type VpnConnectionDeviceTypeId:

string

param VpnConnectionDeviceTypeId:

[REQUIRED]

Device identifier provided by the GetVpnConnectionDeviceTypes API.

type InternetKeyExchangeVersion:

string

param InternetKeyExchangeVersion:

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

type DryRun:

boolean

param 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.

rtype:

dict

returns:

Response Syntax

{
    'VpnConnectionDeviceSampleConfiguration': 'string'
}

Response Structure

• (dict) --

  • VpnConnectionDeviceSampleConfiguration (string) --

    Sample configuration file for the specified customer gateway device.

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.

See also: AWS API Documentation

Request Syntax

client.get_vpn_connection_device_types(
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type MaxResults:

integer

param 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.

type NextToken:

string

param 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.

type DryRun:

boolean

param 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.

rtype:

dict

returns:

Response Syntax

{
    'VpnConnectionDeviceTypes': [
        {
            'VpnConnectionDeviceTypeId': 'string',
            'Vendor': 'string',
            'Platform': 'string',
            'Software': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • VpnConnectionDeviceTypes (list) --

    List of customer gateway devices that have a sample configuration file available for use.

    • (dict) --

      List of customer gateway devices that have a sample configuration file available for use. 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.

      • VpnConnectionDeviceTypeId (string) --

        Customer gateway device identifier.

      • Vendor (string) --

        Customer gateway device vendor.

      • Platform (string) --

        Customer gateway device platform.

      • Software (string) --

        Customer gateway device software version.

  • NextToken (string) --

    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.