Class: Aws::GameLift::Types::CreatePlayerSessionsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::CreatePlayerSessionsInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-gamelift/types.rb
Overview
When making an API call, you may pass CreatePlayerSessionsInput data as a hash:
{
game_session_id: "ArnStringModel", # required
player_ids: ["NonZeroAndMaxString"], # required
player_data_map: {
"NonZeroAndMaxString" => "PlayerData",
},
}
Represents the input for a request action.
Instance Attribute Summary collapse
-
#game_session_id ⇒ String
Unique identifier for the game session to add players to.
-
#player_data_map ⇒ Hash<String,String>
Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player.
-
#player_ids ⇒ Array<String>
List of unique identifiers for the players to be added.
Instance Attribute Details
#game_session_id ⇒ String
Unique identifier for the game session to add players to.
1079 1080 1081 1082 1083 1084 |
# File 'lib/aws-sdk-gamelift/types.rb', line 1079 class CreatePlayerSessionsInput < Struct.new( :game_session_id, :player_ids, :player_data_map) include Aws::Structure end |
#player_data_map ⇒ Hash<String,String>
Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the ‘PlayerIds` parameter are ignored.
1079 1080 1081 1082 1083 1084 |
# File 'lib/aws-sdk-gamelift/types.rb', line 1079 class CreatePlayerSessionsInput < Struct.new( :game_session_id, :player_ids, :player_data_map) include Aws::Structure end |
#player_ids ⇒ Array<String>
List of unique identifiers for the players to be added.
1079 1080 1081 1082 1083 1084 |
# File 'lib/aws-sdk-gamelift/types.rb', line 1079 class CreatePlayerSessionsInput < Struct.new( :game_session_id, :player_ids, :player_data_map) include Aws::Structure end |