libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.SearchGameSessions

Description

Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.

When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.

This operation can be used in the following ways:

  • To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.
  • To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.

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. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions.

You can search or sort by the following game session attributes:

  • gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.
  • gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.
  • gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl". All custom data values are searched as strings.
  • maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.
  • creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.
  • playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.
  • hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

Related actions

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

This operation returns paginated results.

Synopsis

Creating a Request

data SearchGameSessions Source #

Represents the input for a request operation.

See: newSearchGameSessions smart constructor.

Constructors

SearchGameSessions' 

Fields

  • filterExpression :: Maybe Text

    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:

    1. =, <>, <, >, <=, >=
    2. Parentheses
    3. NOT
    4. AND
    5. 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".

  • location :: Maybe Text

    A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

  • sortExpression :: Maybe Text

    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.

  • aliasId :: Maybe Text

    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.

  • nextToken :: Maybe Text

    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.

  • limit :: Maybe Natural

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

  • fleetId :: Maybe Text

    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.

Instances

Instances details
Eq SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Read SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Show SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Generic SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Associated Types

type Rep SearchGameSessions :: Type -> Type #

NFData SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Methods

rnf :: SearchGameSessions -> () #

Hashable SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

ToJSON SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

AWSPager SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

AWSRequest SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Associated Types

type AWSResponse SearchGameSessions #

ToHeaders SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

ToPath SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

ToQuery SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

type Rep SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

type Rep SearchGameSessions = D1 ('MetaData "SearchGameSessions" "Amazonka.GameLift.SearchGameSessions" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "SearchGameSessions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "aliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse SearchGameSessions Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

newSearchGameSessions :: SearchGameSessions Source #

Create a value of SearchGameSessions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filterExpression:SearchGameSessions', searchGameSessions_filterExpression - 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:

  1. =, <>, <, >, <=, >=
  2. Parentheses
  3. NOT
  4. AND
  5. 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".

$sel:location:SearchGameSessions', searchGameSessions_location - A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

$sel:sortExpression:SearchGameSessions', searchGameSessions_sortExpression - 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.

$sel:aliasId:SearchGameSessions', searchGameSessions_aliasId - 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.

$sel:nextToken:SearchGameSessions', searchGameSessions_nextToken - 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.

$sel:limit:SearchGameSessions', searchGameSessions_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

$sel:fleetId:SearchGameSessions', searchGameSessions_fleetId - 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.

Request Lenses

searchGameSessions_filterExpression :: Lens' SearchGameSessions (Maybe Text) Source #

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:

  1. =, <>, <, >, <=, >=
  2. Parentheses
  3. NOT
  4. AND
  5. 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".

searchGameSessions_location :: Lens' SearchGameSessions (Maybe Text) Source #

A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

searchGameSessions_sortExpression :: Lens' SearchGameSessions (Maybe Text) Source #

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.

searchGameSessions_aliasId :: Lens' SearchGameSessions (Maybe Text) Source #

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.

searchGameSessions_nextToken :: Lens' SearchGameSessions (Maybe Text) Source #

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.

searchGameSessions_limit :: Lens' SearchGameSessions (Maybe Natural) Source #

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

searchGameSessions_fleetId :: Lens' SearchGameSessions (Maybe Text) Source #

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.

Destructuring the Response

data SearchGameSessionsResponse Source #

Represents the returned data in response to a request operation.

See: newSearchGameSessionsResponse smart constructor.

Constructors

SearchGameSessionsResponse' 

Fields

  • gameSessions :: Maybe [GameSession]

    A collection of objects containing game session properties for each session that matches the request.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq SearchGameSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Read SearchGameSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Show SearchGameSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Generic SearchGameSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

Associated Types

type Rep SearchGameSessionsResponse :: Type -> Type #

NFData SearchGameSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

type Rep SearchGameSessionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.SearchGameSessions

type Rep SearchGameSessionsResponse = D1 ('MetaData "SearchGameSessionsResponse" "Amazonka.GameLift.SearchGameSessions" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "SearchGameSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameSession])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchGameSessionsResponse Source #

Create a value of SearchGameSessionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:gameSessions:SearchGameSessionsResponse', searchGameSessionsResponse_gameSessions - A collection of objects containing game session properties for each session that matches the request.

$sel:nextToken:SearchGameSessions', searchGameSessionsResponse_nextToken - 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.

$sel:httpStatus:SearchGameSessionsResponse', searchGameSessionsResponse_httpStatus - The response's http status code.

Response Lenses

searchGameSessionsResponse_gameSessions :: Lens' SearchGameSessionsResponse (Maybe [GameSession]) Source #

A collection of objects containing game session properties for each session that matches the request.

searchGameSessionsResponse_nextToken :: Lens' SearchGameSessionsResponse (Maybe Text) Source #

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.