GameLift / Client / create_alias

create_alias#

GameLift.Client.create_alias(**kwargs)#

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.

Related actions

All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.create_alias(
    Name='string',
    Description='string',
    RoutingStrategy={
        'Type': 'SIMPLE'|'TERMINAL',
        'FleetId': 'string',
        'Message': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

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

  • Description (string) – A human-readable description of the alias.

  • RoutingStrategy (dict) –

    [REQUIRED]

    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.

  • Tags (list) –

    A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    • (dict) –

      A label that you can assign to a Amazon GameLift resource.

      Learn more

      Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

      Amazon Web Services Tagging Strategies

      Related actions

      All APIs by task

      • Key (string) – [REQUIRED]

        The key for a developer-defined key value pair for tagging an Amazon Web Services resource.

      • Value (string) – [REQUIRED]

        The value for a developer-defined key value pair for tagging an Amazon Web Services resource.

Return type:

dict

Returns:

Response Syntax

{
    'Alias': {
        '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)
    }
}

Response Structure

  • (dict) –

    • Alias (dict) –

      The newly created alias resource.

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

Exceptions

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.ConflictException

  • GameLift.Client.exceptions.InternalServiceException

  • GameLift.Client.exceptions.LimitExceededException

  • GameLift.Client.exceptions.TaggingFailedException