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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

PlayerLatencyPolicy

Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

Contents

Note

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

MaximumIndividualPlayerLatencyMilliseconds

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

PolicyDurationSeconds

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

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

On this page: