AWS Outposts

2022/06/13 - AWS Outposts - 2 new api methods

Changes  This release adds API operations AWS uses to install Outpost servers.

StartConnection (new) Link ¶

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

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

string

param DeviceSerialNumber

[REQUIRED]

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.

GetConnection (new) Link ¶

Note

Amazon Web Services uses this action to install Outpost servers.

Gets information about a specified connection.

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

client.get_connection(
    ConnectionId='string'
)
type ConnectionId

string

param ConnectionId

[REQUIRED]

The ID of the connection you request.

rtype

dict

returns

Response Syntax

{
    'ConnectionId': 'string',
    'ConnectionDetails': {
        'ClientPublicKey': 'string',
        'ServerPublicKey': 'string',
        'ServerEndpoint': 'string',
        'ClientTunnelAddress': 'string',
        'ServerTunnelAddress': 'string',
        'AllowedIps': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • ConnectionId (string) --

      The ID of the connection you receive.

    • ConnectionDetails (dict) --

      Information about a connection.

      • ClientPublicKey (string) --

        The public key of the client.

      • ServerPublicKey (string) --

        The public key of the server.

      • ServerEndpoint (string) --

        The endpoint for the server.

      • ClientTunnelAddress (string) --

        The client tunnel address.

      • ServerTunnelAddress (string) --

        The server tunnel address.

      • AllowedIps (list) --

        The allowed IP addresses.

        • (string) --