GameLift / Client / list_aliases

list_aliases#

GameLift.Client.list_aliases(**kwargs)#

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Note

Returned aliases are not listed in any particular order.

Related actions

All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.list_aliases(
    RoutingStrategyType='SIMPLE'|'TERMINAL',
    Name='string',
    Limit=123,
    NextToken='string'
)
Parameters:

  • RoutingStrategyType (string) –

    The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.

    Possible routing types include the following:

    • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

    • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

  • Name (string) – A descriptive label that is associated with an alias. Alias names do not need to be unique.

  • 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

{
    'Aliases': [
        {
            'AliasId': 'string',
            'Name': 'string',
            'AliasArn': 'string',
            'Description': 'string',
            'RoutingStrategy': {
                'Type': 'SIMPLE'|'TERMINAL',
                'FleetId': 'string',
                'Message': 'string'
            },
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Aliases (list) –

      A collection of alias resources that match the request parameters.

      • (dict) –

        Properties that describe an alias resource.

        Related actions

        All APIs by task

        • AliasId (string) –

          A unique identifier for the alias. Alias IDs are unique within a Region.

        • Name (string) –

          A descriptive label that is associated with an alias. Alias names do not need to be unique.

        • AliasArn (string) –

          The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

        • Description (string) –

          A human-readable description of an alias.

        • RoutingStrategy (dict) –

          The routing configuration, including routing type and fleet target, for the alias.

          • Type (string) –

            The type of routing strategy for the alias.

            Possible routing types include the following:

            • SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.

            • TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.

          • FleetId (string) –

            A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

          • Message (string) –

            The message text to be used with a terminal routing strategy.

        • CreationTime (datetime) –

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime (datetime) –

          The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

    • 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