Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListLocations

Lists all custom and Amazon locations where Amazon GameLift Servers can host game servers. This operation also returns UDP ping beacon information for locations, which you can use to measure network latency between player devices and potential hosting locations.

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.

Note

This API isn't available in China.

Learn more

Service locations

Request Syntax


{
   "Filters": [ "string" ],
   "Limit": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Filters

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Valid Values: AWS | CUSTOM

Required: No

Limit

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 200.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


{
   "Locations": [ 
      { 
         "LocationArn": "string",
         "LocationName": "string",
         "PingBeacon": { 
            "UDPEndpoint": { 
               "Domain": "string",
               "Port": number
            }
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Locations

A collection of locations, including both Amazon 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.

Type: Array of LocationModel objects

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400