You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::GameLift::Types::DescribePlayerSessionsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::DescribePlayerSessionsInput
- Defined in:
- (unknown)
Overview
When passing DescribePlayerSessionsInput as input to an Aws::Client method, you can use a vanilla Hash:
{
game_session_id: "ArnStringModel",
player_id: "NonZeroAndMaxString",
player_session_id: "PlayerSessionId",
player_session_status_filter: "NonZeroAndMaxString",
limit: 1,
next_token: "NonZeroAndMaxString",
}
Represents the input for a request operation.
Instance Attribute Summary collapse
-
#game_session_id ⇒ String
A unique identifier for the game session to retrieve player sessions for.
-
#limit ⇒ Integer
The maximum number of results to return.
-
#next_token ⇒ String
Token that indicates the start of the next sequential page of results.
-
#player_id ⇒ String
A unique identifier for a player to retrieve player sessions for.
-
#player_session_id ⇒ String
A unique identifier for a player session to retrieve.
-
#player_session_status_filter ⇒ String
Player session status to filter results on.
Instance Attribute Details
#game_session_id ⇒ String
A unique identifier for the game session to retrieve player sessions for.
#limit ⇒ Integer
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.
#next_token ⇒ String
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.
#player_id ⇒ String
A unique identifier for a player to retrieve player sessions for.
#player_session_id ⇒ String
A unique identifier for a player session to retrieve.
#player_session_status_filter ⇒ String
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).