Skip to content

UpdateGameServerInput

Source code in docs_src/capo_gamelift/types/update_game_server_input.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class UpdateGameServerInput(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.</p>"""
    game_server_id: NotRequired["capo_gamelift.types.game_server_id.GameServerId"]
    """<p>A custom string that uniquely identifies the game server to update.</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>"""
    utilization_status: NotRequired[
        "capo_gamelift.types.game_server_utilization_status.GameServerUtilizationStatus"
    ]
    """<p>Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from <code>AVAILABLE</code> to <code>UTILIZED</code>, but you can't change the status from <code>UTILIZED</code> to <code>AVAILABLE</code>.</p>"""
    health_check: NotRequired[
        "capo_gamelift.types.game_server_health_check.GameServerHealthCheck"
    ]
    """<p>Indicates health status of the game server. A request that includes this parameter updates the game server's <i>LastHealthCheckTime</i> timestamp. </p>"""

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.

game_server_id instance-attribute 

game_server_id: NotRequired[GameServerId]

A custom string that uniquely identifies the game server to update.

health_check instance-attribute 

health_check: NotRequired[GameServerHealthCheck]

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

utilization_status instance-attribute 

utilization_status: NotRequired[GameServerUtilizationStatus]

Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change the status from UTILIZED to AVAILABLE.