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

Class: Aws::GameLift::Types::CreatePlayerSessionInput

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 CreatePlayerSessionInput data as a hash:

{
  game_session_id: "ArnStringModel", # required
  player_id: "NonZeroAndMaxString", # required
  player_data: "PlayerData",
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#game_session_idString

Unique identifier for the game session to add a player to.

Returns:

  • (String)


988
989
990
991
992
993
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 988

class CreatePlayerSessionInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_data)
  include Aws::Structure
end

#player_dataString

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

Returns:

  • (String)


988
989
990
991
992
993
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 988

class CreatePlayerSessionInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_data)
  include Aws::Structure
end

#player_idString

Unique identifier for a player. Player IDs are developer-defined.

Returns:

  • (String)


988
989
990
991
992
993
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 988

class CreatePlayerSessionInput < Struct.new(
  :game_session_id,
  :player_id,
  :player_data)
  include Aws::Structure
end