You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::DescribePlayerSessionsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

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",
}

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)


2310
2311
2312
2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2310

class DescribePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_session_id,
  :player_session_status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

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


2310
2311
2312
2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2310

class DescribePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_session_id,
  :player_session_status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

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


2310
2311
2312
2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2310

class DescribePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_session_id,
  :player_session_status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

#player_idString

Unique identifier for a player to retrieve player sessions for.

Returns:

  • (String)


2310
2311
2312
2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2310

class DescribePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_session_id,
  :player_session_status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

#player_session_idString

Unique identifier for a player session to retrieve.

Returns:

  • (String)


2310
2311
2312
2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2310

class DescribePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_session_id,
  :player_session_status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

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


2310
2311
2312
2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2310

class DescribePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_session_id,
  :player_session_status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end