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.
- (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'
        },
    ],

}

Response Structure

(dict) –
- Locations (list) –
  
  A collection of locations.
  - (dict) –
    
    Properties of a custom location for use in an Amazon GameLift Anywhere fleet. This data type is returned in response to a call to https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html.
    - LocationName (string) –
      
      The location’s name.
    - LocationArn (string) –
      
      The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift 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.