Skip to content

LocationModel

Source code in docs_src/capo_gamelift/types/location_model.py
class LocationModel(TypedDict, closed=True):
    location_name: NotRequired[
        "capo_gamelift.types.location_string_model.LocationStringModel"
    ]
    """<p>The location's name.</p>"""
    location_arn: NotRequired["capo_gamelift.types.location_arn_model.LocationArnModel"]
    """<p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a custom location resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>"""
    ping_beacon: NotRequired["capo_gamelift.types.ping_beacon.PingBeacon"]
    """<p>Information about the UDP ping beacon for this location. Ping beacons are fixed endpoints that you can use to measure network latency between a player device and an Amazon GameLift Servers hosting location.</p>"""

location_arn instance-attribute

location_arn: NotRequired[LocationArnModel]

The Amazon Resource Name (ARN) that is assigned to a custom location resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

location_name instance-attribute

location_name: NotRequired[LocationStringModel]

The location's name.

ping_beacon instance-attribute

ping_beacon: NotRequired[PingBeacon]

Information about the UDP ping beacon for this location. Ping beacons are fixed endpoints that you can use to measure network latency between a player device and an Amazon GameLift Servers hosting location.