Amazon GameLift

2025/06/24 - Amazon GameLift - 2 updated api methods

Changes  Add support for UDP ping beacons to ListLocations API, including new PingBeacon and UDPEndpoint data types within its Locations return value. Use UDP ping beacon endpoints to help measure real-time network latency for multiplayer games.

CreateLocation (updated) Link ¶
Changes (response) 
{'Location': {'PingBeacon': {'UDPEndpoint': {'Domain': 'string',
                                             'Port': 'integer'}}}}

Creates a custom location for use in an Anywhere fleet.

See also: AWS API Documentation

Request Syntax

client.create_location(
    LocationName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type LocationName:

string

param LocationName:

[REQUIRED]

A descriptive name for the custom location.

type Tags:

list

param Tags:

A list of labels to assign to the new resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Rareference.

  • (dict) --

    A label that you can assign to a Amazon GameLift Servers resource.

    Learn more

    Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

    Amazon Web Services Tagging Strategies

    Related actions

    All APIs by task

    • Key (string) -- [REQUIRED]

      The key for a developer-defined key value pair for tagging an Amazon Web Services resource.

    • Value (string) -- [REQUIRED]

      The value for a developer-defined key value pair for tagging an Amazon Web Services resource.

rtype:

dict

returns:

Response Syntax

{
    'Location': {
        'LocationName': 'string',
        'LocationArn': 'string',
        'PingBeacon': {
            'UDPEndpoint': {
                'Domain': 'string',
                'Port': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • Location (dict) --

      The details of the custom location you created.

      • LocationName (string) --

        The location's name.

      • LocationArn (string) --

        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:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      • PingBeacon (dict) --

        Information about the UDP ping beacon for this location.

        • UDPEndpoint (dict) --

          The domain name and port of the UDP ping beacon.

          • Domain (string) --

            The domain name of the UDP endpoint.

          • Port (integer) --

            The port number of the UDP endpoint.

ListLocations (updated) Link ¶
Changes (response) 
{'Locations': {'PingBeacon': {'UDPEndpoint': {'Domain': 'string',
                                              'Port': 'integer'}}}}

Lists all custom and Amazon Web Services locations where Amazon GameLift Servers can host game servers.

Note that if you call this API using a location that doesn't have a service endpoint, such as one that can only be a remote location in a multi-location fleet, the API returns an error.

Consult the table of supported locations in Amazon GameLift Servers service locations to identify home Regions that support single and multi-location fleets.

Learn more

Service locations

See also: AWS API Documentation

Request Syntax

client.list_locations(
    Filters=[
        'AWS'|'CUSTOM',
    ],
    Limit=123,
    NextToken='string'
)
type Filters:

list

param Filters:

Filters the list for AWS or CUSTOM locations. Use this parameter to narrow down results to only Amazon Web Services-managed locations (Amazon EC2 or container) or only your custom locations (such as an Amazon GameLift Servers Anywhere fleet).

  • (string) --

type Limit:

integer

param Limit:

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

type NextToken:

string

param NextToken:

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

rtype:

dict

returns:

Response Syntax

{
    'Locations': [
        {
            'LocationName': 'string',
            'LocationArn': 'string',
            'PingBeacon': {
                'UDPEndpoint': {
                    'Domain': 'string',
                    'Port': 123
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Locations (list) --

      A collection of locations, including both Amazon Web Services and custom locations. Each location includes a name and ping beacon information that can be used to measure network latency between player devices and the location.

      • (dict) --

        Properties of a location, which can include its name, ARN (for custom locations), and ping beacon information.

        • LocationName (string) --

          The location's name.

        • LocationArn (string) --

          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:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • PingBeacon (dict) --

          Information about the UDP ping beacon for this location.

          • UDPEndpoint (dict) --

            The domain name and port of the UDP ping beacon.

            • Domain (string) --

              The domain name of the UDP endpoint.

            • Port (integer) --

              The port number of the UDP endpoint.

    • NextToken (string) --

      A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.