class Aws::GameLift::Types::MatchmakingTicket

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 with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.

@!attribute [rw] ticket_id

A unique identifier for a matchmaking ticket.
@return [String]

@!attribute [rw] configuration_name

Name of the MatchmakingConfiguration 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.
@return [String]

@!attribute [rw] configuration_arn

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

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

@!attribute [rw] status

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 (see AcceptMatch). 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 call to StopMatchmaking 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>
@return [String]

@!attribute [rw] status_reason

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.
@return [String]

@!attribute [rw] status_message

Additional information about the current status.
@return [String]

@!attribute [rw] start_time

Time stamp indicating when this matchmaking request was received.
Format is a number expressed in Unix time as milliseconds (for
example `"1469498468.057"`).
@return [Time]

@!attribute [rw] end_time

Time stamp indicating when this matchmaking request stopped being
processed due to success, failure, or cancellation. Format is a
number expressed in Unix time as milliseconds (for example
`"1469498468.057"`).
@return [Time]

@!attribute [rw] players

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.
@return [Array<Types::Player>]

@!attribute [rw] game_session_connection_info

Identifier and connection information of the game session created
for the match. This information is added to the ticket only after
the matchmaking request has been successfully completed. This
parameter is not set when FlexMatch is being used without GameLift
hosting.
@return [Types::GameSessionConnectionInfo]

@!attribute [rw] estimated_wait_time

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.
@return [Integer]

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

Constants

SENSITIVE