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

Class: Aws::GameLift::Types::CreatePlayerSessionsInput

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

Instance Attribute Details

#game_session_idString

Unique identifier for the game session to add players to.

Returns:

  • (String)


1079
1080
1081
1082
1083
1084
# File 'gems/aws-sdk-gamelift/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_mapHash<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.

Returns:

  • (Hash<String,String>)


1079
1080
1081
1082
1083
1084
# File 'gems/aws-sdk-gamelift/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_idsArray<String>

List of unique identifiers for the players to be added.

Returns:

  • (Array<String>)


1079
1080
1081
1082
1083
1084
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1079

class CreatePlayerSessionsInput < Struct.new(
  :game_session_id,
  :player_ids,
  :player_data_map)
  include Aws::Structure
end