:doc:`Outposts <../../outposts>` / Client / start_connection

****************
start_connection
****************



.. py:method:: Outposts.Client.start_connection(**kwargs)

  

  .. note::

    

    Amazon Web Services uses this action to install Outpost servers.

    

   

  Starts the connection required for Outpost server installation.

   

  Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see `Amazon Web Services managed policies for Amazon Web Services Outposts <https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html>`__ and `Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail <https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html>`__ in the *Amazon Web Services Outposts User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/StartConnection>`_  


  **Request Syntax**
  ::

    response = client.start_connection(
        DeviceSerialNumber='string',
        AssetId='string',
        ClientPublicKey='string',
        NetworkInterfaceDeviceIndex=123
    )
    
  :type DeviceSerialNumber: string
  :param DeviceSerialNumber: 

    The serial number of the dongle.

    

  
  :type AssetId: string
  :param AssetId: **[REQUIRED]** 

    The ID of the Outpost server.

    

  
  :type ClientPublicKey: string
  :param ClientPublicKey: **[REQUIRED]** 

    The public key of the client.

    

  
  :type NetworkInterfaceDeviceIndex: integer
  :param NetworkInterfaceDeviceIndex: **[REQUIRED]** 

    The device index of the network interface on the Outpost server.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ConnectionId': 'string',
          'UnderlayIpAddress': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ConnectionId** *(string) --* 

        The ID of the connection.

        
      

      - **UnderlayIpAddress** *(string) --* 

        The underlay IP address.

        
  
  **Exceptions**
  
  *   :py:class:`Outposts.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Outposts.Client.exceptions.ValidationException`

  
  *   :py:class:`Outposts.Client.exceptions.NotFoundException`

  
  *   :py:class:`Outposts.Client.exceptions.InternalServerException`

  