Class: Aws::GameLift::Types::MatchmakingTicket

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::MatchmakingTicket

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration_arn ⇒ String

  The Amazon Resource Name ([ARN]) associated with the GameLift matchmaking configuration resource that is used with this ticket.

• #configuration_name ⇒ String

  Name of the matchmaking configuration that is used with this ticket.

• #end_time ⇒ Time

  Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation.

• #estimated_wait_time ⇒ Integer

  Average amount of time (in seconds) that players are currently waiting for a match.

• #game_session_connection_info ⇒ Types::GameSessionConnectionInfo

  Connection information for a new game session.

• #players ⇒ Array<Types::Player>

  A set of ‘Player` objects, each representing a player to find matches for.

• #start_time ⇒ Time

  Time stamp indicating when this matchmaking request was received.

• #status ⇒ String

  Current status of the matchmaking request.

• #status_message ⇒ String

  Additional information about the current status.

• #status_reason ⇒ String

  Code to explain the current status.

• #ticket_id ⇒ String

  A unique identifier for a matchmaking ticket.

Instance Attribute Details

#configuration_arn ⇒ String

The Amazon Resource Name ([ARN]) associated with the GameLift matchmaking configuration resource that is used with this ticket.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_name ⇒ String

Name of the matchmaking configuration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

• (Time)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_wait_time ⇒ Integer

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_connection_info ⇒ Types::GameSessionConnectionInfo

Connection information for a new game session. Once a match is made, the FlexMatch engine creates a new game session for it. This information is added to the matchmaking ticket, which you can be retrieve by calling [DescribeMatchmaking] .

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html

Returns:

• (Types::GameSessionConnectionInfo)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#players ⇒ Array<Types::Player>

A set of ‘Player` objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status `COMPLETED`, the `Player` objects include the team the players were assigned to in the resulting match.

Returns:

• (Array<Types::Player>)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

• (Time)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Current status of the matchmaking request.

• QUEUED – The matchmaking request has been received and is currently waiting to be processed.

• SEARCHING – The matchmaking request is currently being processed.

• REQUIRES_ACCEPTANCE – A match has been proposed and the players must accept the match. This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

• PLACING – The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

• COMPLETED – Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

• FAILED – The matchmaking request was not completed.

• CANCELLED – The matchmaking request was canceled. This may be the result of a ‘StopMatchmaking` operation or a proposed match that one or more players failed to accept.

• TIMED_OUT – The matchmaking request was not successful within the duration specified in the matchmaking configuration.

<note markdown=“1”> Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

Additional information about the current status.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

Code to explain the current status. For example, a status reason may indicate when a ticket has returned to ‘SEARCHING` status after a proposed match fails to receive player acceptances.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end

#ticket_id ⇒ String

A unique identifier for a matchmaking ticket.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8201

class MatchmakingTicket < Struct.new(
  :ticket_id,
  :configuration_name,
  :configuration_arn,
  :status,
  :status_reason,
  :status_message,
  :start_time,
  :end_time,
  :players,
  :game_session_connection_info,
  :estimated_wait_time)
  SENSITIVE = []
  include Aws::Structure
end