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
show all
Defined in:
(unknown)

Overview

Note:

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 action.

Instance Attribute Summary collapse

Instance Attribute Details

#game_session_idString

Unique identifier for the game session to retrieve player sessions for.

Returns:

  • (String)

    Unique identifier for the game session to retrieve player sessions for.

#limitInteger

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.

Returns:

  • (Integer)

    Maximum number of results to return.

#next_tokenString

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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.

Returns:

  • (String)

    Token that indicates the start of the next sequential page of results.

#player_idString

Unique identifier for a player to retrieve player sessions for.

Returns:

  • (String)

    Unique identifier for a player to retrieve player sessions for.

#player_session_idString

Unique identifier for a player session to retrieve.

Returns:

  • (String)

    Unique identifier for a player session to retrieve.

#player_session_status_filterString

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).

Returns:

  • (String)

    Player session status to filter results on.