Skip to content
AWS for Query.Farm

aws.gamelift.describe_game_session_placement

Example SQL Queries

SELECT * FROM
aws.gamelift.describe_game_session_placement
WHERE
"placement_id" = 'VALUE';

Description

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

Table Definition

Column NameColumn Data Type
placement_id Required Input Column

A unique identifier for a game session placement to retrieve.

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
game_session_placement

Object that describes the requested game session placement.

STRUCT(
    "placement_id" VARCHAR,
    "game_session_queue_name" VARCHAR,
    "status" VARCHAR,
    "game_properties" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "maximum_player_session_count" BIGINT,
    "game_session_name" VARCHAR,
    "game_session_id" VARCHAR,
    "game_session_arn" VARCHAR,
    "game_session_region" VARCHAR,
    "player_latencies" STRUCT(
        "player_id" VARCHAR,
        "region_identifier" VARCHAR,
        "latency_in_milliseconds" DOUBLE
    )[],
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "ip_address" VARCHAR,
    "dns_name" VARCHAR,
    "port" BIGINT,
    "placed_player_sessions" STRUCT(
        "player_id" VARCHAR,
        "player_session_id" VARCHAR
    )[],
    "game_session_data" VARCHAR,
    "matchmaker_data" VARCHAR
)
Show child fields
game_session_placement.dns_name

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

game_session_placement.end_time

Time stamp indicating when this request was completed, canceled, or timed out.

game_session_placement.game_properties[]
Show child fields
game_session_placement.game_properties[].key

The game property identifier.

game_session_placement.game_properties[].value

The game property value.

game_session_placement.game_session_arn

Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status is FULFILLED.

game_session_placement.game_session_data

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

game_session_placement.game_session_id

A unique identifier for the game session. This value isn't final until placement status is FULFILLED.

game_session_placement.game_session_name

A descriptive label that is associated with a game session. Session names do not need to be unique.

game_session_placement.game_session_queue_name

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

game_session_placement.game_session_region

Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is FULFILLED.

game_session_placement.ip_address

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED.

game_session_placement.matchmaker_data

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

game_session_placement.maximum_player_session_count

The maximum number of players that can be connected simultaneously to the game session.

game_session_placement.placed_player_sessions[]
Show child fields
game_session_placement.placed_player_sessions[].player_id

A unique identifier for a player that is associated with this player session.

game_session_placement.placed_player_sessions[].player_session_id

A unique identifier for a player session.

game_session_placement.placement_id

A unique identifier for a game session placement.

game_session_placement.player_latencies[]
Show child fields
game_session_placement.player_latencies[].latency_in_milliseconds

Amount of time that represents the time lag experienced by the player when connected to the specified Region.

game_session_placement.player_latencies[].player_id

A unique identifier for a player associated with the latency data.

game_session_placement.player_latencies[].region_identifier

Name of the Region that is associated with the latency value.

game_session_placement.port

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED.

game_session_placement.start_time

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

game_session_placement.status

Current status of the game session placement request.

  • PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.

  • FULFILLED -- A new game session has been successfully placed. Game session properties are now final.

  • CANCELLED -- The placement request was canceled.

  • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

  • FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.