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.CreateGameSessionQueue API' description:

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.

About Amazon GameLift solutions

Get more information on these Amazon GameLift solutions in the Amazon GameLift Developer Guide.

About this API Reference

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:

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.CreateGameSessionQueue' paths: /#X-Amz-Target=GameLift.CreateGameSessionQueue: 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: CreateGameSessionQueue description:

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateGameSessionQueueOutput' examples: CreateGameSessionQueue200Example: summary: Default CreateGameSessionQueue 200 response x-microcks-default: true value: GameSessionQueue: example-value '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: CreateGameSessionQueue480Example: summary: Default CreateGameSessionQueue 480 response x-microcks-default: true value: example-value '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: CreateGameSessionQueue481Example: summary: Default CreateGameSessionQueue 481 response x-microcks-default: true value: example-value '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: CreateGameSessionQueue482Example: summary: Default CreateGameSessionQueue 482 response x-microcks-default: true value: example-value '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateGameSessionQueue483Example: summary: Default CreateGameSessionQueue 483 response x-microcks-default: true value: example-value '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateGameSessionQueue484Example: summary: Default CreateGameSessionQueue 484 response x-microcks-default: true value: example-value '485': description: TaggingFailedException content: application/json: schema: $ref: '#/components/schemas/TaggingFailedException' examples: CreateGameSessionQueue485Example: summary: Default CreateGameSessionQueue 485 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateGameSessionQueueInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GameLift.CreateGameSessionQueue summary: Amazon GameLift Create Game Session Queue x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=GameLift.CreateGameSessionQueue' components: schemas: QueueSnsArnStringModel: type: string pattern: '[a-zA-Z0-9:_-]*(\.fifo)?' minLength: 0 maxLength: 300 CreateGameSessionQueueOutput: type: object properties: GameSessionQueue: allOf: - $ref: '#/components/schemas/GameSessionQueue' - description: An object that describes the newly created game session queue. GameSessionQueueArn: type: string pattern: ^arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+ minLength: 1 maxLength: 256 InternalServiceException: {} WholeNumber: type: integer minimum: 0 LocationList: type: array items: $ref: '#/components/schemas/LocationStringModel' minItems: 1 maxItems: 100 PriorityConfiguration: type: object properties: PriorityOrder: allOf: - $ref: '#/components/schemas/PriorityTypeList' - description:

The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

LocationOrder: allOf: - $ref: '#/components/schemas/LocationList' - description: 'The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by Amazon Web Services Region codes such as us-west-2. Each location can only be listed once. ' description:

Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:

Changing the priority order will affect how game sessions are placed.

QueueCustomEventData: type: string pattern: '[\s\S]*' minLength: 0 maxLength: 256 FilterConfiguration: type: object properties: AllowedLocations: allOf: - $ref: '#/components/schemas/LocationList' - description: ' A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as us-west-2. ' description: A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations. PlayerLatencyPolicy: type: object properties: MaximumIndividualPlayerLatencyMilliseconds: allOf: - $ref: '#/components/schemas/WholeNumber' - description: The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property. PolicyDurationSeconds: allOf: - $ref: '#/components/schemas/WholeNumber' - description: The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out. description: 'Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time. ' InvalidRequestException: {} NotFoundException: {} CreateGameSessionQueueInput: type: object required: - Name title: CreateGameSessionQueueInput properties: Name: allOf: - $ref: '#/components/schemas/GameSessionQueueName' - description: A descriptive label that is associated with game session queue. Queue names must be unique within each Region. TimeoutInSeconds: allOf: - $ref: '#/components/schemas/WholeNumber' - description: The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. PlayerLatencyPolicies: allOf: - $ref: '#/components/schemas/PlayerLatencyPolicyList' - description: A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. Destinations: allOf: - $ref: '#/components/schemas/GameSessionQueueDestinationList' - description: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. FilterConfiguration: allOf: - $ref: '#/components/schemas/FilterConfiguration' - description: 'A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. ' PriorityConfiguration: allOf: - $ref: '#/components/schemas/PriorityConfiguration' - description: 'Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. ' CustomEventData: allOf: - $ref: '#/components/schemas/QueueCustomEventData' - description: Information to be added to all events that are related to this game session queue. NotificationTarget: allOf: - $ref: '#/components/schemas/QueueSnsArnStringModel' - description: An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. TaggingFailedException: {} ArnStringModel: type: string pattern: '[a-zA-Z0-9:/-]+' minLength: 1 maxLength: 256 LimitExceededException: {} PlayerLatencyPolicyList: type: array items: $ref: '#/components/schemas/PlayerLatencyPolicy' UnauthorizedException: {} TagKey: type: string minLength: 1 maxLength: 128 GameSessionQueueDestinationList: type: array items: $ref: '#/components/schemas/GameSessionQueueDestination' GameSessionQueue: type: object properties: Name: allOf: - $ref: '#/components/schemas/GameSessionQueueName' - description: A descriptive label that is associated with game session queue. Queue names must be unique within each Region. GameSessionQueueArn: allOf: - $ref: '#/components/schemas/GameSessionQueueArn' - description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value. TimeoutInSeconds: allOf: - $ref: '#/components/schemas/WholeNumber' - description: The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. PlayerLatencyPolicies: allOf: - $ref: '#/components/schemas/PlayerLatencyPolicyList' - description: 'A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. ' Destinations: allOf: - $ref: '#/components/schemas/GameSessionQueueDestinationList' - description: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. FilterConfiguration: allOf: - $ref: '#/components/schemas/FilterConfiguration' - description: 'A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. ' PriorityConfiguration: allOf: - $ref: '#/components/schemas/PriorityConfiguration' - description: 'Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. ' CustomEventData: allOf: - $ref: '#/components/schemas/QueueCustomEventData' - description: ' Information that is added to all events that are related to this game session queue.' NotificationTarget: allOf: - $ref: '#/components/schemas/QueueSnsArnStringModel' - description: An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement. description: Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution. LocationStringModel: type: string pattern: ^[A-Za-z0-9\-]+ minLength: 1 maxLength: 64 PriorityTypeList: type: array items: $ref: '#/components/schemas/PriorityType' minItems: 1 maxItems: 4 TagValue: type: string minLength: 0 maxLength: 256 PriorityType: type: string enum: - LATENCY - COST - DESTINATION - LOCATION GameSessionQueueName: type: string pattern: '[a-zA-Z0-9-]+' minLength: 1 maxLength: 128 GameSessionQueueDestination: type: object properties: DestinationArn: allOf: - $ref: '#/components/schemas/ArnStringModel' - description: The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions. description: 'A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue''s destinations. ' Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: 'The key for a developer-defined key value pair for tagging an Amazon Web Services resource. ' Value: allOf: - $ref: '#/components/schemas/TagValue' - description: 'The value for a developer-defined key value pair for tagging an Amazon Web Services resource. ' description:

A label that you can assign to a Amazon GameLift resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

TagList: type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 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