

# ListLocations
<a name="API_ListLocations"></a>

 **This API works with the following fleet types:** EC2, Anywhere, Container

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.

The set of locations returned by this API depends on the Amazon Web Services Region you specify when calling this API (or your default Region if you don't specify one).

In China Regions, this API returns only Amazon Regions and ping beacon endpoints. Specifying the `CUSTOM` filter will return empty results because custom locations are not supported in China regions.

Avoid calling `ListLocations` before each latency measurement, as it's not designed for high-volume requests. The beacon endpoint information returned by this API are static and won't change as long as Amazon GameLift Servers supports game hosting in that location.

 **Learn more** 

 [Service locations](https://docs.amazonaws.cn/gamelift/latest/developerguide/gamelift-regions.html) 

 [UDP ping beacons](https://docs.amazonaws.cn/gamelift/latest/developerguide/reference-udp-ping-beacons.html) 

## Request Syntax
<a name="API_ListLocations_RequestSyntax"></a>

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

## Request Parameters
<a name="API_ListLocations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

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

 ** [Filters](#API_ListLocations_RequestSyntax) **   <a name="gameliftservers-ListLocations-request-Filters"></a>
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).  
In China Regions, specifying `CUSTOM` filter will return empty results because custom locations are not supported in China regions.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Valid Values: `AWS | CUSTOM`   
Required: No

 ** [Limit](#API_ListLocations_RequestSyntax) **   <a name="gameliftservers-ListLocations-request-Limit"></a>
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](#API_ListLocations_RequestSyntax) **   <a name="gameliftservers-ListLocations-request-NextToken"></a>
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
<a name="API_ListLocations_ResponseSyntax"></a>

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

## Response Elements
<a name="API_ListLocations_ResponseElements"></a>

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](#API_ListLocations_ResponseSyntax) **   <a name="gameliftservers-ListLocations-response-Locations"></a>
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](API_LocationModel.md) objects

 ** [NextToken](#API_ListLocations_ResponseSyntax) **   <a name="gameliftservers-ListLocations-response-NextToken"></a>
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
<a name="API_ListLocations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListLocations_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/gamelift-2015-10-01/ListLocations) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/gamelift-2015-10-01/ListLocations) 