ApiGatewayManagementApi / Client / get_connection

get_connection#

ApiGatewayManagementApi.Client.get_connection(**kwargs)#

Get information about the connection with the provided id.

See also: AWS API Documentation

Request Syntax

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

ConnectionId (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'ConnectedAt': datetime(2015, 1, 1),
    'Identity': {
        'SourceIp': 'string',
        'UserAgent': 'string'
    },
    'LastActiveAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • ConnectedAt (datetime) –

      The time in ISO 8601 format for when the connection was established.

    • Identity (dict) –

      • SourceIp (string) –

        The source IP address of the TCP connection making the request to API Gateway.

      • UserAgent (string) –

        The User Agent of the API caller.

    • LastActiveAt (datetime) –

      The time in ISO 8601 format for when the connection was last active.

Exceptions

  • ApiGatewayManagementApi.Client.exceptions.GoneException

  • ApiGatewayManagementApi.Client.exceptions.LimitExceededException

  • ApiGatewayManagementApi.Client.exceptions.ForbiddenException