class Aws::GameLift::Types::StartMatchBackfillInput

Represents the input for a request operation.

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

data as a hash:

    {
      ticket_id: "MatchmakingIdStringModel",
      configuration_name: "MatchmakingConfigurationName", # required
      game_session_arn: "ArnStringModel",
      players: [ # required
        {
          player_id: "NonZeroAndMaxString",
          player_attributes: {
            "NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
          },
          team: "NonZeroAndMaxString",
          latency_in_ms: {
            "NonEmptyString" => 1,
          },
        },
      ],
    }

@!attribute [rw] ticket_id

A unique identifier for a matchmaking ticket. If no ticket ID is
specified here, Amazon GameLift will generate one in the form of a
UUID. Use this identifier to track the match backfill ticket status
and retrieve match results.
@return [String]

@!attribute [rw] configuration_name

Name of the matchmaker to use for this request. You can use either
the configuration name or ARN value. The ARN of the matchmaker that
was used with the original game session is listed in the GameSession
object, `MatchmakerData` property.
@return [String]

@!attribute [rw] game_session_arn

A unique identifier for the game session. Use the game session ID.
When using FlexMatch as a standalone matchmaking solution, this
parameter is not needed.
@return [String]

@!attribute [rw] players

Match information on all players that are currently assigned to the
game session. This information is used by the matchmaker to find new
players and add them to the existing game.

* PlayerID, PlayerAttributes, Team -- This information is maintained
  in the GameSession object, `MatchmakerData` property, for all
  players who are currently assigned to the game session. The
  matchmaker data is in JSON syntax, formatted as a string. For more
  details, see [ Match Data][1].

* LatencyInMs -- If the matchmaker uses player latency, include a
  latency value, in milliseconds, for the Region that the game
  session is currently in. Do not include latency values for any
  other Region.

[1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
@return [Array<Types::Player>]

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

Constants

SENSITIVE