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

UpdateGameSessionQueue

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Queue-related operations include:

Request Syntax

Copy
{ "Destinations": [ { "DestinationArn": "string" } ], "Name": "string", "PlayerLatencyPolicies": [ { "MaximumIndividualPlayerLatencyMilliseconds": number, "PolicyDurationSeconds": number } ], "TimeoutInSeconds": number }

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.

Name

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Type: String

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

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

Required: Yes

Destinations

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.

Type: Array of GameSessionQueueDestination objects

Required: No

PlayerLatencyPolicies

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.

Type: Array of PlayerLatencyPolicy objects

Required: No

TimeoutInSeconds

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax

Copy
{ "GameSessionQueue": { "Destinations": [ { "DestinationArn": "string" } ], "GameSessionQueueArn": "string", "Name": "string", "PlayerLatencyPolicies": [ { "MaximumIndividualPlayerLatencyMilliseconds": number, "PolicyDurationSeconds": number } ], "TimeoutInSeconds": number } }

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.

GameSessionQueue

Object that describes the newly updated game session queue.

Type: GameSessionQueue object

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

NotFoundException

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

See Also

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