Skip to content

ClaimGameServerInput

Source code in docs_src/capo_gamelift/types/claim_game_server_input.py
class ClaimGameServerInput(TypedDict, closed=True):
    game_server_group_name: NotRequired[
        "capo_gamelift.types.game_server_group_name_or_arn.GameServerGroupNameOrArn"
    ]
    """<p>A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift Servers FleetIQ to look for an available game server to claim. </p>"""
    game_server_id: NotRequired["capo_gamelift.types.game_server_id.GameServerId"]
    """<p>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift Servers FleetIQ searches for an available game server in the specified game server group.</p>"""
    game_server_data: NotRequired["capo_gamelift.types.game_server_data.GameServerData"]
    """<p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>"""
    filter_option: NotRequired[
        "capo_gamelift.types.claim_filter_option.ClaimFilterOption"
    ]
    """<p>Object that restricts how a claimed game server is chosen.</p>"""

filter_option instance-attribute

filter_option: NotRequired[ClaimFilterOption]

Object that restricts how a claimed game server is chosen.

game_server_data instance-attribute

game_server_data: NotRequired[GameServerData]

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

game_server_group_name instance-attribute

game_server_group_name: NotRequired[GameServerGroupNameOrArn]

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift Servers FleetIQ to look for an available game server to claim.

game_server_id instance-attribute

game_server_id: NotRequired[GameServerId]

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift Servers FleetIQ searches for an available game server in the specified game server group.