Skip to content

CreatePlayerSessionsInput

Source code in docs_src/capo_gamelift/types/create_player_sessions_input.py 
13
14
15
16
17
18
19
class CreatePlayerSessionsInput(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 players 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_ids: NotRequired["capo_gamelift.types.player_id_list.PlayerIdList"]
    """<p>List of unique identifiers for the players to be added.</p>"""
    player_data_map: NotRequired["capo_gamelift.types.player_data_map.PlayerDataMap"]
    """<p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored. </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 players 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_map instance-attribute 

player_data_map: NotRequired[PlayerDataMap]

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

player_ids instance-attribute 

player_ids: NotRequired[PlayerIdList]

List of unique identifiers for the players to be added.