Skip to content
AWS for Query.Farm

aws.gamelift.describe_alias

Example SQL Queries

SELECT * FROM
aws.gamelift.describe_alias
WHERE
"alias_id" = 'VALUE';

Description

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

Related actions

All APIs by task

Table Definition

Column NameColumn Data Type
alias_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
alias

The requested alias resource.

STRUCT(
    "alias_id" VARCHAR,
    "name" VARCHAR,
    "alias_arn" VARCHAR,
    "description" VARCHAR,
    "routing_strategy" STRUCT(
        "type" VARCHAR,
        "fleet_id" VARCHAR,
        "message" VARCHAR
    ),
    "creation_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S
)
Show child fields
alias.alias_arn

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.

alias.alias_id

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

alias.creation_time

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

alias.description

A human-readable description of an alias.

alias.last_updated_time

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

alias.name

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

alias.routing_strategy

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

Show child fields
alias.routing_strategy.fleet_id

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

alias.routing_strategy.message

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

alias.routing_strategy.type

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.