Outposts / Client / start_connection

start_connection#

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 and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

See also: AWS API Documentation

Request Syntax

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

  • DeviceSerialNumber (string) – The serial number of the dongle.

  • AssetId (string) –

    [REQUIRED]

    The ID of the Outpost server.

  • ClientPublicKey (string) –

    [REQUIRED]

    The public key of the client.

  • NetworkInterfaceDeviceIndex (integer) –

    [REQUIRED]

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

Return type:

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

  • Outposts.Client.exceptions.AccessDeniedException

  • Outposts.Client.exceptions.ValidationException

  • Outposts.Client.exceptions.NotFoundException

  • Outposts.Client.exceptions.InternalServerException