GameLift / Client / list_locations

list_locations

GameLift.Client.list_locations(**kwargs)

Lists all custom and Amazon Web Services locations.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Filters (list) –

  Filters the list for AWS or CUSTOM locations.

  • (string) –

• Limit (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

• NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Locations': [
        {
            'LocationName': 'string',
            'LocationArn': 'string'
        },
    ],
    'NextToken': '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 CreateLocation.

      • 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.

  • 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.

Exceptions

• GameLift.Client.exceptions.UnauthorizedException

• GameLift.Client.exceptions.InvalidRequestException

• GameLift.Client.exceptions.InternalServiceException