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

Class: Aws::GameLift::Types::StartMatchBackfillInput

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

{
  ticket_id: "MatchmakingIdStringModel",
  configuration_name: "MatchmakingIdStringModel", # required
  game_session_arn: "ArnStringModel", # required
  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,
      },
    },
  ],
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_nameString

Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is "MM-4v4".) Use only the name for this parameter.

Returns:

  • (String)


5797
5798
5799
5800
5801
5802
5803
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5797

class StartMatchBackfillInput < Struct.new(
  :ticket_id,
  :configuration_name,
  :game_session_arn,
  :players)
  include Aws::Structure
end

#game_session_arnString

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

Returns:

  • (String)


5797
5798
5799
5800
5801
5802
5803
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5797

class StartMatchBackfillInput < Struct.new(
  :ticket_id,
  :configuration_name,
  :game_session_arn,
  :players)
  include Aws::Structure
end

#playersArray<Types::Player>

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.

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

Returns:



5797
5798
5799
5800
5801
5802
5803
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5797

class StartMatchBackfillInput < Struct.new(
  :ticket_id,
  :configuration_name,
  :game_session_arn,
  :players)
  include Aws::Structure
end

#ticket_idString

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.

Returns:

  • (String)


5797
5798
5799
5800
5801
5802
5803
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5797

class StartMatchBackfillInput < Struct.new(
  :ticket_id,
  :configuration_name,
  :game_session_arn,
  :players)
  include Aws::Structure
end