game_session_placements
Creates, updates, deletes, gets or lists a game_session_placements resource.
Overview
| Name | game_session_placements |
| Type | Resource |
| Id | aws.gamelift.game_session_placements |
Fields
The following fields are returned by SELECT queries:
- describe_game_session_placement
| Name | Datatype | Description |
|---|---|---|
dns_name | string | 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. |
end_time | string (date-time) | Time stamp indicating when this request was completed, canceled, or timed out. |
game_properties | array | A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. Avoid using periods (".") in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations. If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results. |
game_session_arn | string | An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string>. For Remote Location game session - arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string>. This value is the same as GameSessionId. This value isn't final until placement status is FULFILLED. |
game_session_data | string | A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session. |
game_session_id | string | An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string>. For Remote Location game session - arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string>. This value is the same as GameSessionArn. This value isn't final until placement status is FULFILLED. |
game_session_name | string | A descriptive label that is associated with a game session. Session names do not need to be unique. |
game_session_queue_name | string | A descriptive label that is associated with game session queue. Queue names must be unique within each Region. (pattern: <code>^[a-zA-Z0-9-]+$</code>) |
game_session_region | string | 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. |
ip_address | string | The IP address of the game session. To connect to a Amazon GameLift Servers game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED. (pattern: <code>^[0-9A-Fa-f:.]+$</code>) |
matchmaker_data | string | 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. |
maximum_player_session_count | integer | The maximum number of players that can be connected simultaneously to the game session. |
placed_player_sessions | array | A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID. |
placement_id | string | A unique identifier for a game session placement. (pattern: <code>^[a-zA-Z0-9-]+$</code>) |
player_gateway_status | string | The current status of player gateway for the game session placement. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations. Possible values include: ENABLED -- Player gateway is available for this game session placement. DISABLED -- Player gateway is not available for this game session placement. (DISABLED, ENABLED) |
player_latencies | array | A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to a fleet location (Amazon Web Services Regions or custom locations for Amazon GameLift Servers Anywhere fleets). |
port | integer | The port number for the game session. To connect to a Amazon GameLift Servers game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED. |
priority_configuration_override | object | An alternative priority list of locations that's included with a game session placement request. When provided, the list overrides a queue's location order list for this game session placement request only. The list might include Amazon Web Services Regions, local zones, and custom locations (for Anywhere fleets). The fallback strategy tells Amazon GameLift Servers what action to take (if any) in the event that it failed to place a new game session. |
start_time | string (date-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"). |
status | string | 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 Servers 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. (PENDING, FULFILLED, CANCELLED, TIMED_OUT, FAILED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_game_session_placement | select | region | This API works with the following fleet types: EC2, Anywhere, Container 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 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. For a reference implementation of event-based game session placement tracking, see Event-based game session placement guidance in the Amazon GameLift Toolkit. |
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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_game_session_placement
This API works with the following fleet types: EC2, Anywhere, Container 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 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. For a reference implementation of event-based game session placement tracking, see Event-based game session placement guidance in the Amazon GameLift Toolkit.
SELECT
dns_name,
end_time,
game_properties,
game_session_arn,
game_session_data,
game_session_id,
game_session_name,
game_session_queue_name,
game_session_region,
ip_address,
matchmaker_data,
maximum_player_session_count,
placed_player_sessions,
placement_id,
player_gateway_status,
player_latencies,
port,
priority_configuration_override,
start_time,
status
FROM aws.gamelift.game_session_placements
WHERE region = '{{ region }}' -- required
;