openapi: 3.0.0
info:
version: 2015-10-01
x-release: v4
title: 'Amazon GameLift #X Amz Target=GameLift.AcceptMatch #X Amz Target=GameLift.AcceptMatch #X Amz Target=GameLift.DescribeMatchmaking API'
description: <p>Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand. </p> <p> <b>About Amazon GameLift solutions</b> </p> <p>Get more information on these Amazon GameLift solutions in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/">Amazon GameLift Developer Guide</a>.</p> <ul> <li> <p>Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.</p> </li> <li> <p>Managed hosting with Realtime Servers -- With Amazon GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core Amazon GameLift infrastructure already built in. Then use the full range of Amazon GameLift managed hosting features, including FlexMatch, for your game.</p> </li> <li> <p>Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. Amazon GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services.</p> </li> <li> <p>Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.</p> </li> </ul> <p> <b>About this API Reference</b> </p> <p>This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html">Amazon GameLift API operations listed by tasks</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html"> Amazon GameLift tools and resources</a> </p> </li> </ul>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: gamelift
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/gamelift-2015-10-01.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://gamelift.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon GameLift multi-region endpoint
- url: https://gamelift.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon GameLift multi-region endpoint
- url: http://gamelift.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia)
- url: https://gamelift.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=GameLift.DescribeMatchmaking'
paths:
/#X-Amz-Target=GameLift.DescribeMatchmaking:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeMatchmaking
description: <p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. </p> <p>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.</p> <p>This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.</p> <p/> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event notification</a> </p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeMatchmakingOutput'
examples:
DescribeMatchmaking200Example:
summary: Default DescribeMatchmaking 200 response
x-microcks-default: true
value:
TicketList: example-value
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
examples:
DescribeMatchmaking480Example:
summary: Default DescribeMatchmaking 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DescribeMatchmaking481Example:
summary: Default DescribeMatchmaking 481 response
x-microcks-default: true
value: example-value
'482':
description: UnsupportedRegionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedRegionException'
examples:
DescribeMatchmaking482Example:
summary: Default DescribeMatchmaking 482 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeMatchmakingInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- GameLift.DescribeMatchmaking
summary: Amazon GameLift Describe Matchmaking
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=GameLift.DescribeMatchmaking'
components:
schemas:
PlayerList:
type: array
items:
$ref: '#/components/schemas/Player'
DescribeMatchmakingOutput:
type: object
properties:
TicketList:
allOf:
- $ref: '#/components/schemas/MatchmakingTicketList'
- description: A collection of existing matchmaking ticket objects matching the request.
NonZeroAndMaxString:
type: string
minLength: 1
maxLength: 1024
InternalServiceException: {}
WholeNumber:
type: integer
minimum: 0
MatchmakingConfigurationArn:
type: string
pattern: ^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]*
description: Data type used for Matchmaking Configuration ARN.
LatencyMap:
type: object
additionalProperties:
$ref: '#/components/schemas/PositiveInteger'
IpAddress:
type: string
pattern: ^[0-9A-Fa-f\:\.]+
minLength: 1
maxLength: 128
MatchmakingTicket:
type: object
properties:
TicketId:
allOf:
- $ref: '#/components/schemas/MatchmakingIdStringModel'
- description: A unique identifier for a matchmaking ticket.
ConfigurationName:
allOf:
- $ref: '#/components/schemas/MatchmakingIdStringModel'
- description: 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.
ConfigurationArn:
allOf:
- $ref: '#/components/schemas/MatchmakingConfigurationArn'
- description: The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the GameLift matchmaking configuration resource that is used with this ticket.
Status:
allOf:
- $ref: '#/components/schemas/MatchmakingConfigurationStatus'
- description: <p>Current status of the matchmaking request.</p> <ul> <li> <p> <b>QUEUED</b> -- The matchmaking request has been received and is currently waiting to be processed.</p> </li> <li> <p> <b>SEARCHING</b> -- The matchmaking request is currently being processed. </p> </li> <li> <p> <b>REQUIRES_ACCEPTANCE</b> -- 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.</p> </li> <li> <p> <b>PLACING</b> -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.</p> </li> <li> <p> <b>COMPLETED</b> -- 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.</p> </li> <li> <p> <b>FAILED</b> -- The matchmaking request was not completed.</p> </li> <li> <p> <b>CANCELLED</b> -- The matchmaking request was canceled. This may be the result of a <code>StopMatchmaking</code> operation or a proposed match that one or more players failed to accept.</p> </li> <li> <p> <b>TIMED_OUT</b> -- The matchmaking request was not successful within the duration specified in the matchmaking configuration. </p> </li> </ul> <note> <p>Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.</p> </note>
StatusReason:
allOf:
- $ref: '#/components/schemas/StringModel'
- description: Code to explain the current status. For example, a status reason may indicate when a ticket has returned to <code>SEARCHING</code> status after a proposed match fails to receive player acceptances.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StringModel'
- description: Additional information about the current status.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>).
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 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 <code>"1469498468.057"</code>).
Players:
allOf:
- $ref: '#/components/schemas/PlayerList'
- description: A set of <code>Player</code> 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 <code>COMPLETED</code>, the <code>Player</code> objects include the team the players were assigned to in the resulting match.
GameSessionConnectionInfo:
allOf:
- $ref: '#/components/schemas/GameSessionConnectionInfo'
- description: 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 <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html">DescribeMatchmaking</a> .
EstimatedWaitTime:
allOf:
- $ref: '#/components/schemas/WholeNumber'
- description: 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.
description: 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.
MatchmakingTicketList:
type: array
items:
$ref: '#/components/schemas/MatchmakingTicket'
PlayerAttributeString:
type: string
minLength: 1
maxLength: 100
GameSessionConnectionInfo:
type: object
properties:
GameSessionArn:
allOf:
- $ref: '#/components/schemas/ArnStringModel'
- description: A unique identifier for the game session. Use the game session ID.
IpAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
DnsName:
allOf:
- $ref: '#/components/schemas/DnsName'
- description: '<p>The DNS identifier assigned to the instance that is running the game session. Values have the following format:</p> <ul> <li> <p>TLS-enabled fleets: <code><unique identifier>.<region identifier>.amazongamelift.com</code>.</p> </li> <li> <p>Non-TLS-enabled fleets: <code>ec2-<unique identifier>.compute.amazonaws.com</code>. (See <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p> </li> </ul> <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>'
Port:
allOf:
- $ref: '#/components/schemas/PositiveInteger'
- description: The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
MatchedPlayerSessions:
allOf:
- $ref: '#/components/schemas/MatchedPlayerSessionList'
- description: 'A collection of player session IDs, one for each player ID that was included in the original matchmaking request. '
description: Connection information for a new game session that is created in response to a start matchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the matchmaking ticket.
MatchedPlayerSessionList:
type: array
items:
$ref: '#/components/schemas/MatchedPlayerSession'
DoubleObject:
type: number
format: double
PlayerAttributeStringList:
type: array
items:
$ref: '#/components/schemas/PlayerAttributeString'
InvalidRequestException: {}
DnsName:
type: string
DescribeMatchmakingInput:
type: object
required:
- TicketIds
title: DescribeMatchmakingInput
properties:
TicketIds:
allOf:
- $ref: '#/components/schemas/MatchmakingIdList'
- description: 'A unique identifier for a matchmaking ticket. You can include up to 10 ID values. '
ArnStringModel:
type: string
pattern: '[a-zA-Z0-9:/-]+'
minLength: 1
maxLength: 256
StringModel:
type: string
Timestamp:
type: string
format: date-time
Player:
type: object
properties:
PlayerId:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A unique identifier for a player
PlayerAttributes:
allOf:
- $ref: '#/components/schemas/PlayerAttributeMap'
- description: '<p>A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the <i>playerAttributes</i> used in a matchmaking rule set. Example: <code>"PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}</code>.</p> <p>You can provide up to 10 <code>PlayerAttributes</code>.</p>'
Team:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
LatencyInMs:
allOf:
- $ref: '#/components/schemas/LatencyMap'
- description: <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported. </p> <p>If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable. </p>
description: Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.
AttributeValue:
type: object
properties:
S:
allOf:
- $ref: '#/components/schemas/PlayerAttributeString'
- description: For single string values. Maximum string length is 100 characters.
N:
allOf:
- $ref: '#/components/schemas/DoubleObject'
- description: For number values, expressed as double.
SL:
allOf:
- $ref: '#/components/schemas/PlayerAttributeStringList'
- description: For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
SDM:
allOf:
- $ref: '#/components/schemas/PlayerAttributeStringDoubleMap'
- description: 'For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters. '
description: 'Values for use in player attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each <code>AttributeValue</code> object can use only one of the available properties.'
MatchmakingConfigurationStatus:
type: string
enum:
- CANCELLED
- COMPLETED
- FAILED
- PLACING
- QUEUED
- REQUIRES_ACCEPTANCE
- SEARCHING
- TIMED_OUT
PositiveInteger:
type: integer
minimum: 1
PlayerAttributeStringDoubleMap:
type: object
additionalProperties:
$ref: '#/components/schemas/DoubleObject'
MatchedPlayerSession:
type: object
properties:
PlayerId:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: 'A unique identifier for a player '
PlayerSessionId:
allOf:
- $ref: '#/components/schemas/PlayerSessionId'
- description: A unique identifier for a player session
description: <p>Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request. </p> <p>When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.</p>
MatchmakingIdList:
type: array
items:
$ref: '#/components/schemas/MatchmakingIdStringModel'
PlayerSessionId:
type: string
pattern: ^psess-\S+
UnsupportedRegionException: {}
MatchmakingIdStringModel:
type: string
pattern: '[a-zA-Z0-9-\.]*'
maxLength: 128
PlayerAttributeMap:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/gamelift/
x-hasEquivalentPaths: true