Skip to content

LocationState

Source code in docs_src/capo_gamelift/types/location_state.py 
13
14
15
16
17
18
19
20
21
22
23
class LocationState(TypedDict, closed=True):
    location: NotRequired[
        "capo_gamelift.types.location_string_model.LocationStringModel"
    ]
    """<p>The fleet location, expressed as an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"""
    status: NotRequired["capo_gamelift.types.fleet_status.FleetStatus"]
    """<p>The life-cycle status of a fleet location. </p>"""
    player_gateway_status: NotRequired[
        "capo_gamelift.types.player_gateway_status.PlayerGatewayStatus"
    ]
    """<p>The current status of player gateway in this location for this fleet. Note, even if a fleet has PlayerGatewayMode configured as <code>ENABLED</code>, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/gamelift-regions.html">Amazon GameLift Servers service locations</a>.</p> <p>Possible values include:</p> <ul> <li> <p> <code>ENABLED</code> -- Player gateway is available for this fleet location.</p> </li> <li> <p> <code>DISABLED</code> -- Player gateway is not available for this fleet location.</p> </li> </ul>"""

location instance-attribute 

location: NotRequired[LocationStringModel]

The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.

player_gateway_status instance-attribute 

player_gateway_status: NotRequired[PlayerGatewayStatus]

The current status of player gateway in this location for this fleet. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations.

Possible values include:

  • ENABLED -- Player gateway is available for this fleet location.

  • DISABLED -- Player gateway is not available for this fleet location.

status instance-attribute 

status: NotRequired[FleetStatus]

The life-cycle status of a fleet location.