class Aws::GameLift::Types::DescribePlayerSessionsInput

Represents the input for a request operation.

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

data as a hash:

    {
      game_session_id: "ArnStringModel",
      player_id: "NonZeroAndMaxString",
      player_session_id: "PlayerSessionId",
      player_session_status_filter: "NonZeroAndMaxString",
      limit: 1,
      next_token: "NonZeroAndMaxString",
    }

@!attribute [rw] game_session_id

A unique identifier for the game session to retrieve player sessions
for.
@return [String]

@!attribute [rw] player_id

A unique identifier for a player to retrieve player sessions for.
@return [String]

@!attribute [rw] player_session_id

A unique identifier for a player session to retrieve.
@return [String]

@!attribute [rw] player_session_status_filter

Player session status to filter results on.

Possible player session statuses include the following:

* **RESERVED** -- The player session request has been received, but
  the player has not yet connected to the server process and/or been
  validated.

* **ACTIVE** -- The player has been validated by the server process
  and is currently connected.

* **COMPLETED** -- The player connection has been dropped.

* **TIMEDOUT** -- A player session request was received, but the
  player did not connect and/or was not validated within the timeout
  limit (60 seconds).
@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. If a player
session ID is specified, this parameter is ignored.
@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. If a player session ID is specified, this parameter
is ignored.
@return [String]

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

Constants

SENSITIVE