GameLift / Client / describe_game_sessions

describe_game_sessions#

GameLift.Client.describe_game_sessions(**kwargs)#

Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet’s home Region and all remote locations.
To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet’s home Region or any remote location.
To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request.

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 DescribeGameSessions should only be used for games in development with low game session usage.

Available in Amazon GameLift Local.

Learn more

Find a game session

All APIs by task

Request Syntax

response = client.describe_game_sessions(
    FleetId='string',
    GameSessionId='string',
    AliasId='string',
    Location='string',
    StatusFilter='string',
    Limit=123,
    NextToken='string'
)

Parameters:

FleetId (string) – A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.
GameSessionId (string) – A unique identifier for the game session to retrieve.
AliasId (string) – A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.
Location (string) – A fleet location to get game sessions for. You can specify a fleet’s home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
StatusFilter (string) – Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.
Limit (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
NextToken (string) – A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type:

dict

Returns:

Response Syntax

{
    'GameSessions': [
        {
            'GameSessionId': 'string',
            'Name': 'string',
            'FleetId': 'string',
            'FleetArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'TerminationTime': datetime(2015, 1, 1),
            'CurrentPlayerSessionCount': 123,
            'MaximumPlayerSessionCount': 123,
            'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
            'StatusReason': 'INTERRUPTED',
            'GameProperties': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'IpAddress': 'string',
            'DnsName': 'string',
            'Port': 123,
            'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
            'CreatorId': 'string',
            'GameSessionData': 'string',
            'MatchmakerData': 'string',
            'Location': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- GameSessions (list) –
  
  A collection of properties for each game session that matches the request.
  - (dict) –
    
    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.
    
    Amazon GameLift retains a game session resource for 30 days after the game session ends. You can reuse idempotency token values after this time. Game session logs are retained for 14 days.
    
    All APIs by task
    - GameSessionId (string) –
      
      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>.
    - Name (string) –
      
      A descriptive label that is associated with a game session. Session names do not need to be unique.
    - FleetId (string) –
      
      A unique identifier for the fleet that the game session is running on.
    - FleetArn (string) –
      
      The Amazon Resource Name ( ARN) associated with the GameLift fleet that this game session is running on.
    - CreationTime (datetime) –
      
      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    - TerminationTime (datetime) –
      
      A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    - CurrentPlayerSessionCount (integer) –
      
      Number of players currently in the game session.
    - MaximumPlayerSessionCount (integer) –
      
      The maximum number of players that can be connected simultaneously to the game session.
    - Status (string) –
      
      Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    - StatusReason (string) –
      
      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.
    - GameProperties (list) –
      
      A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.
      - (dict) –
        
        This key-value pair can store custom data about a game session. For example, you might use a GameProperty to track a game session’s map, level of difficulty, or remaining time. The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"}.
        
        You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can’t delete game properties from a game session.
        
        For examples of working with game properties, see Create a game session with properties.
        
        Key (string) –
        
        The game property identifier.
        
        Value (string) –
        
        The game property value.
    - IpAddress (string) –
      
      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.
    - DnsName (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.
    - Port (integer) –
      
      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.
    - PlayerSessionCreationPolicy (string) –
      
      Indicates whether or not the game session is accepting new players.
    - CreatorId (string) –
      
      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.
    - GameSessionData (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.
    - MatchmakerData (string) –
      
      Information about the matchmaking process that resulted in the game session, if matchmaking was used. Data is in JSON syntax, formatted as a string. Information includes the matchmaker ID as well as player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
    - Location (string) –
      
      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 Amazon Web Services Region code such as us-west-2.
- NextToken (string) –
  
  A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.