GameLift / Client / resolve_alias

resolve_alias#

GameLift.Client.resolve_alias(**kwargs)#

Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier.

If the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID. If the alias has a TERMINAL routing strategy, the result is a TerminalRoutingStrategyException.

Related actions

All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.resolve_alias(
    AliasId='string'
)
Parameters:

AliasId (string) –

[REQUIRED]

The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.

Return type:

dict

Returns:

Response Syntax

{
    'FleetId': 'string',
    'FleetArn': 'string'
}

Response Structure

  • (dict) –

    • FleetId (string) –

      The fleet identifier that the alias is pointing to.

    • FleetArn (string) –

      The Amazon Resource Name ( ARN) associated with the GameLift fleet resource that this alias points to.

Exceptions

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.TerminalRoutingStrategyException

  • GameLift.Client.exceptions.InternalServiceException