class Aws::GameLift::Types::StartGameSessionPlacementInput

Represents the input for a request operation.

@note When making an API call, you may pass StartGameSessionPlacementInput

data as a hash:

    {
      placement_id: "IdStringModel", # required
      game_session_queue_name: "GameSessionQueueNameOrArn", # required
      game_properties: [
        {
          key: "GamePropertyKey", # required
          value: "GamePropertyValue", # required
        },
      ],
      maximum_player_session_count: 1, # required
      game_session_name: "NonZeroAndMaxString",
      player_latencies: [
        {
          player_id: "NonZeroAndMaxString",
          region_identifier: "NonZeroAndMaxString",
          latency_in_milliseconds: 1.0,
        },
      ],
      desired_player_sessions: [
        {
          player_id: "NonZeroAndMaxString",
          player_data: "PlayerData",
        },
      ],
      game_session_data: "LargeGameSessionData",
    }

@!attribute [rw] placement_id

A unique identifier to assign to the new game session placement.
This value is developer-defined. The value must be unique across all
Regions and cannot be reused unless you are resubmitting a canceled
or timed-out placement request.
@return [String]

@!attribute [rw] game_session_queue_name

Name of the queue to use to place the new game session. You can use
either the queue name or ARN value.
@return [String]

@!attribute [rw] game_properties

A set of custom properties for a game session, formatted as
key:value pairs. These properties are passed to a game server
process in the GameSession object with a request to start a new game
session (see [Start a Game Session][1]).

[1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
@return [Array<Types::GameProperty>]

@!attribute [rw] maximum_player_session_count

The maximum number of players that can be connected simultaneously
to the game session.
@return [Integer]

@!attribute [rw] game_session_name

A descriptive label that is associated with a game session. Session
names do not need to be unique.
@return [String]

@!attribute [rw] player_latencies

A set of values, expressed in milliseconds, that indicates the
amount of latency that a player experiences when connected to AWS
Regions. This information is used to try to place the new game
session where it can offer the best possible gameplay experience for
the players.
@return [Array<Types::PlayerLatency>]

@!attribute [rw] desired_player_sessions

Set of information on each player to create a player session for.
@return [Array<Types::DesiredPlayerSession>]

@!attribute [rw] game_session_data

A set of custom game session properties, formatted as a single
string value. This data is passed to a game server process in the
GameSession object with a request to start a new game session (see
[Start a Game Session][1]).

[1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacementInput AWS API Documentation

Constants

SENSITIVE