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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::DescribePlayerSessionsInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:player_id]

Instance Attribute Summary

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

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4705

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

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 4705

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

#next_token ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4705

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

#player_id ⇒ String

A unique identifier for a player to retrieve player sessions for.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4705

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

#player_session_id ⇒ String

A unique identifier for a player session to retrieve.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4705

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

#player_session_status_filter ⇒ String

Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.

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)

# File 'lib/aws-sdk-gamelift/types.rb', line 4705

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