Skip to content

CreatePlayerSessionInput

Source code in docs_src/capo_gamelift/types/create_player_session_input.py 
13
14
15
16
17
18
19
class CreatePlayerSessionInput(TypedDict, closed=True):
    game_session_id: NotRequired["capo_gamelift.types.arn_string_model.ArnStringModel"]
    """<p>An identifier for the game session that is unique across all regions to add a player to. The value is always a full ARN in the following format: For Home Region game session - <code>arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string></code>. For Remote Location game session - <code>arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string></code>.</p>"""
    player_id: NotRequired["capo_gamelift.types.player_id.PlayerId"]
    """<p>A unique identifier for a player. Player IDs are developer-defined.</p>"""
    player_data: NotRequired["capo_gamelift.types.player_data.PlayerData"]
    """<p>Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game.</p>"""

game_session_id instance-attribute 

game_session_id: NotRequired[ArnStringModel]

An identifier for the game session that is unique across all regions to add a player to. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:::gamesession//. For Remote Location game session - arn:aws:gamelift:::gamesession///.

player_data instance-attribute 

player_data: NotRequired[PlayerData]

Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game.

player_id instance-attribute 

player_id: NotRequired[PlayerId]

A unique identifier for a player. Player IDs are developer-defined.