Skip to content

PlayerConnectionDetail

Source code in docs_src/capo_gamelift/types/player_connection_detail.py 
14
15
16
17
18
19
20
21
22
23
24
class PlayerConnectionDetail(TypedDict, closed=True):
    player_id: NotRequired["capo_gamelift.types.player_id.PlayerId"]
    """<p>A unique identifier for a player associated with this connection.</p>"""
    endpoints: NotRequired[
        "capo_gamelift.types.player_connection_endpoint_list.PlayerConnectionEndpointList"
    ]
    """<p>List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session.</p> <p>When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint.</p>"""
    player_gateway_token: NotRequired["capo_gamelift.types.max_string.MaxString"]
    """<p>Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token.</p> <p>This value is empty when player gateway is disabled.</p>"""
    expiration: NotRequired["capo_gamelift.types.timestamp.Timestamp"]
    """<p>When player gateway is enabled, this is the timestamp indicating when player gateway token expires. Your game backend should call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetPlayerConnectionDetails.html">GetPlayerConnectionDetails</a> to retrieve fresh connection information for your game clients before this time. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>). </p> <p>This value is empty when player gateway is disabled.</p>"""

endpoints instance-attribute 

endpoints: NotRequired[PlayerConnectionEndpointList]

List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session.

When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint.

expiration instance-attribute 

expiration: NotRequired[Timestamp]

When player gateway is enabled, this is the timestamp indicating when player gateway token expires. Your game backend should call GetPlayerConnectionDetails to retrieve fresh connection information for your game clients before this time. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

This value is empty when player gateway is disabled.

player_gateway_token instance-attribute 

player_gateway_token: NotRequired[MaxString]

Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token.

This value is empty when player gateway is disabled.

player_id instance-attribute 

player_id: NotRequired[PlayerId]

A unique identifier for a player associated with this connection.