GameLift / Paginator / ListLocations

ListLocations¶

class GameLift.Paginator.ListLocations¶

paginator = client.get_paginator('list_locations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from GameLift.Client.list_locations().

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        'AWS'|'CUSTOM',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Filters (list) –
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) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.