get_connection

get_connection(**kwargs)

Note

Amazon Web Services uses this action to install Outpost servers.

Gets information about the 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

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

Parameters

ConnectionId (string) --

[REQUIRED]

The ID of the connection.

Return type

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.

  • ConnectionDetails (dict) --

    Information about the 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) --

Exceptions

• Outposts.Client.exceptions.AccessDeniedException
• Outposts.Client.exceptions.ValidationException
• Outposts.Client.exceptions.NotFoundException
• Outposts.Client.exceptions.InternalServerException