class Aws::GameLift::Types::SearchGameSessionsInput

Represents the input for a request operation.

@note When making an API call, you may pass SearchGameSessionsInput

data as a hash:

    {
      fleet_id: "FleetIdOrArn",
      alias_id: "AliasIdOrArn",
      location: "LocationStringModel",
      filter_expression: "NonZeroAndMaxString",
      sort_expression: "NonZeroAndMaxString",
      limit: 1,
      next_token: "NonZeroAndMaxString",
    }

@!attribute [rw] fleet_id

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.
@return [String]

@!attribute [rw] alias_id

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.
@return [String]

@!attribute [rw] 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`.
@return [String]

@!attribute [rw] filter_expression

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"`.
@return [String]

@!attribute [rw] sort_expression

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.
@return [String]

@!attribute [rw] 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.
@return [Integer]

@!attribute [rw] next_token

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 [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SearchGameSessionsInput AWS API Documentation

Constants

SENSITIVE