Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GameSession

import type { GameSession } from "https://aws-api.deno.dev/v0.3/services/gamelift.ts?docs=full";

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

Related actions

"CreateGameSession" | "DescribeGameSessions" | "DescribeGameSessionDetails" | "SearchGameSessions" | "UpdateGameSession" | "GetGameSessionLogUrl" | "StartGameSessionPlacement" | "DescribeGameSessionPlacement" | "StopGameSessionPlacement" | All APIs by task

interface GameSession {

CreationTime?: Date | number | null;

CreatorId?: string | null;

CurrentPlayerSessionCount?: number | null;

DnsName?: string | null;

FleetArn?: string | null;

FleetId?: string | null;

GameProperties?: GameProperty[] | null;

GameSessionData?: string | null;

GameSessionId?: string | null;

IpAddress?: string | null;

Location?: string | null;

MatchmakerData?: string | null;

MaximumPlayerSessionCount?: number | null;

Name?: string | null;

PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy | null;

Port?: number | null;

Status?: GameSessionStatus | null;

StatusReason?: GameSessionStatusReason | null;

TerminationTime?: Date | number | null;

}

§Properties

CreationTime?: Date | number | null

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

CreatorId?: string | null

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

CurrentPlayerSessionCount?: number | null

Number of players currently in the game session.

DnsName?: string | null

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.

FleetArn?: string | null

The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

FleetId?: string | null

A unique identifier for the fleet that the game session is running on.

GameProperties?: GameProperty[] | null

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the "GameSession" object with a request to start a new game session. You can search for active game sessions based on this custom data with "SearchGameSessions".

GameSessionData?: string | null

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.

GameSessionId?: string | null

A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

IpAddress?: string | null

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Location?: string | null

The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

MatchmakerData?: string | null

Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see "StartMatchBackfill").

MaximumPlayerSessionCount?: number | null

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

Name?: string | null

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

PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy | null

Indicates whether or not the game session is accepting new players.

Port?: number | null

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Status?: GameSessionStatus | null

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

StatusReason?: GameSessionStatusReason | null

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

TerminationTime?: Date | number | null

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