Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

DescribeMatchmaking

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

Matchmaking-related operations include:

Request Syntax

{
   "TicketIds": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

TicketIds

Unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-\.]+

Required: Yes

Response Syntax

{
   "TicketList": [ 
      { 
         "ConfigurationName": "string",
         "EndTime": number,
         "EstimatedWaitTime": number,
         "GameSessionConnectionInfo": { 
            "GameSessionArn": "string",
            "IpAddress": "string",
            "MatchedPlayerSessions": [ 
               { 
                  "PlayerId": "string",
                  "PlayerSessionId": "string"
               }
            ],
            "Port": number
         },
         "Players": [ 
            { 
               "LatencyInMs": { 
                  "string" : number 
               },
               "PlayerAttributes": { 
                  "string" : { 
                     "N": number,
                     "S": "string",
                     "SDM": { 
                        "string" : number 
                     },
                     "SL": [ "string" ]
                  }
               },
               "PlayerId": "string",
               "Team": "string"
            }
         ],
         "StartTime": number,
         "Status": "string",
         "StatusMessage": "string",
         "StatusReason": "string",
         "TicketId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TicketList

Collection of existing matchmaking ticket objects matching the request.

Type: Array of MatchmakingTicket objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

UnsupportedRegionException

The requested operation is not supported in the region specified.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: