:doc:`EC2 <../../ec2>` / Client / get_vpn_connection_device_sample_configuration

**********************************************
get_vpn_connection_device_sample_configuration
**********************************************



.. py:method:: EC2.Client.get_vpn_connection_device_sample_configuration(**kwargs)

  

  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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration>`_  


  **Request Syntax**
  ::

    response = client.get_vpn_connection_device_sample_configuration(
        VpnConnectionId='string',
        VpnConnectionDeviceTypeId='string',
        InternetKeyExchangeVersion='string',
        SampleType='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 SampleType: string
  :param SampleType: 

    The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1).

    

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

        
  