Struct aws_sdk_gamelift::client::fluent_builders::SearchGameSessions [−][src]
pub struct SearchGameSessions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to SearchGameSessions
.
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
orGameSessionArn
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
Implementations
impl<C, M, R> SearchGameSessions<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> SearchGameSessions<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<SearchGameSessionsOutput, SdkError<SearchGameSessionsError>> where
R::Policy: SmithyRetryPolicy<SearchGameSessionsInputOperationOutputAlias, SearchGameSessionsOutput, SearchGameSessionsError, SearchGameSessionsInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<SearchGameSessionsOutput, SdkError<SearchGameSessionsError>> where
R::Policy: SmithyRetryPolicy<SearchGameSessionsInputOperationOutputAlias, SearchGameSessionsOutput, SearchGameSessionsError, SearchGameSessionsInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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.
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.
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.
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.
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
.
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
.
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"
.
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"
.
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.
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.
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.
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.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for SearchGameSessions<C, M, R>
impl<C, M, R> Send for SearchGameSessions<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for SearchGameSessions<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for SearchGameSessions<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for SearchGameSessions<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more