Skip to main content

aliases

Creates, updates, deletes, gets or lists an aliases resource.

Overview

Namealiases
TypeResource
Idaws.gamelift.aliases

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
alias_arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers 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. (pattern: <code>^arn:.*:alias/alias-\S+$</code>)
alias_idstringA unique identifier for the alias. Alias IDs are unique within a Region. (pattern: <code>^alias-\S+$</code>)
creation_timestring (date-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").
descriptionstringA human-readable description of an alias.
last_updated_timestring (date-time)The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
namestringA descriptive label that is associated with an alias. Alias names do not need to be unique. (pattern: <code>^.\S.$</code>)
routing_strategyobjectThe routing configuration, including routing type and fleet target, for the alias.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_aliasesselectregionThis API works with the following fleet types: EC2, Anywhere, Container 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. Returned aliases are not listed in any particular order. Related actions All APIs by task

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

This API works with the following fleet types: EC2, Anywhere, Container 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. Returned aliases are not listed in any particular order. Related actions All APIs by task

SELECT
alias_arn,
alias_id,
creation_time,
description,
last_updated_time,
name,
routing_strategy
FROM aws.gamelift.aliases
WHERE region = '{{ region }}' -- required
;