GameLift / Client / update_alias

update_alias#

GameLift.Client.update_alias(**kwargs)#

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

Related actions

All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.update_alias(
    AliasId='string',
    Name='string',
    Description='string',
    RoutingStrategy={
        'Type': 'SIMPLE'|'TERMINAL',
        'FleetId': 'string',
        'Message': 'string'
    }
)
Parameters:

  • AliasId (string) –

    [REQUIRED]

    A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.

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

    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.

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 updated 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 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.NotFoundException

  • GameLift.Client.exceptions.InternalServiceException