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

Class: Aws::GameLift::Types::StartMatchmakingInput

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

{
  ticket_id: "MatchmakingIdStringModel",
  configuration_name: "MatchmakingIdStringModel", # required
  players: [ # required
    {
      player_id: "PlayerIdStringModel",
      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 matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Returns:

  • (String)


5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5680

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

#playersArray<Types::Player>

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

Returns:



5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5680

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

#ticket_idString

Unique identifier for a matchmaking ticket. Use this identifier to track the matchmaking ticket status and retrieve match results.

Returns:

  • (String)


5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5680

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