GameLift / Paginator / SearchGameSessions

SearchGameSessions#

class GameLift.Paginator.SearchGameSessions#
paginator = client.get_paginator('search_game_sessions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GameLift.Client.search_game_sessions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FleetId='string',
    AliasId='string',
    Location='string',
    FilterExpression='string',
    SortExpression='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • FleetId (string) – A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

  • AliasId (string) – A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

  • Location (string) – A fleet location to search for game sessions. 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.

  • FilterExpression (string) –

    String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

    A filter expression can contain one or multiple conditions. Each condition consists of the following:

    • Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

    • Comparator – Valid comparators are: =, <>, <, >, <=, >=.

    • Value – Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: “ FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".

    To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

    Session search evaluates conditions from left to right using the following precedence rules:

    • =, <>, <, >, <=, >=

    • Parentheses

    • NOT

    • AND

    • OR

    For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

  • SortExpression (string) –

    Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

    • Operand – Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

    • Order – Valid sort orders are ASC (ascending) and DESC (descending).

    For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

Response Structure

  • (dict) –

    • GameSessions (list) –

      A collection of objects containing game session properties for each 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.