AmazonApiGatewayManagementApi

2019/08/30 - AmazonApiGatewayManagementApi - 2 new api methods

Changes  You can use getConnection to return information about the connection (when it is connected, IP address, etc) and deleteConnection to disconnect the given connection

DeleteConnection (new) Link ¶

Delete the connection with the provided id.

See also: AWS API Documentation

Request Syntax

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

string

param ConnectionId

[REQUIRED]

returns

None

GetConnection (new) Link ¶

Get information about the connection with the provided id.

See also: AWS API Documentation

Request Syntax

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

string

param ConnectionId

[REQUIRED]

rtype

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.