Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
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 configure an Amazon
Simple Notification Service (SNS) topic to receive notifications from
FlexMatch or queues. Continuously polling game session status with
DescribeGameSessions
should only be used for games in development with
low game session usage.
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
orGameSessionArn
value. - gameSessionName -- Name assigned to a game session. 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.
- 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.
This operation returns paginated results.
Synopsis
- data SearchGameSessions = SearchGameSessions' {}
- newSearchGameSessions :: SearchGameSessions
- searchGameSessions_aliasId :: Lens' SearchGameSessions (Maybe Text)
- searchGameSessions_filterExpression :: Lens' SearchGameSessions (Maybe Text)
- searchGameSessions_fleetId :: Lens' SearchGameSessions (Maybe Text)
- searchGameSessions_limit :: Lens' SearchGameSessions (Maybe Natural)
- searchGameSessions_location :: Lens' SearchGameSessions (Maybe Text)
- searchGameSessions_nextToken :: Lens' SearchGameSessions (Maybe Text)
- searchGameSessions_sortExpression :: Lens' SearchGameSessions (Maybe Text)
- data SearchGameSessionsResponse = SearchGameSessionsResponse' {
- gameSessions :: Maybe [GameSession]
- nextToken :: Maybe Text
- httpStatus :: Int
- newSearchGameSessionsResponse :: Int -> SearchGameSessionsResponse
- searchGameSessionsResponse_gameSessions :: Lens' SearchGameSessionsResponse (Maybe [GameSession])
- searchGameSessionsResponse_nextToken :: Lens' SearchGameSessionsResponse (Maybe Text)
- searchGameSessionsResponse_httpStatus :: Lens' SearchGameSessionsResponse Int
Creating a Request
data SearchGameSessions Source #
See: newSearchGameSessions
smart constructor.
SearchGameSessions' | |
|
Instances
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:
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: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 ongameSessionName
: "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"
.
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.
$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.
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 Amazon Web Services Region
code format, such as us-west-2
.
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: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) andDESC
(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.
Request Lenses
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_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 ongameSessionName
: "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"
.
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.
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_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 Amazon Web Services Region
code format, such as us-west-2
.
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_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) andDESC
(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.
Destructuring the Response
data SearchGameSessionsResponse Source #
See: newSearchGameSessionsResponse
smart constructor.
SearchGameSessionsResponse' | |
|
Instances
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.
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.
searchGameSessionsResponse_httpStatus :: Lens' SearchGameSessionsResponse Int Source #
The response's http status code.