Skip to content

GetPlayerConnectionDetailsInput

Source code in docs_src/capo_gamelift/types/get_player_connection_details_input.py
class GetPlayerConnectionDetailsInput(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 for which to retrieve player connection details. 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 players. Connection details are returned for each player in this list.</p>"""

game_session_id instance-attribute

game_session_id: NotRequired[ArnStringModel]

An identifier for the game session that is unique across all regions for which to retrieve player connection details. 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_ids instance-attribute

player_ids: NotRequired[PlayerIdList]

List of unique identifiers for players. Connection details are returned for each player in this list.