AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
This API works with the following fleet types: EC2 (server SDK 5.x or later), Container
Retrieves connection details for game clients to connect to game sessions.
Player gateway benefits: DDoS protection with negligible impact to latency.
To enable player gateway on your fleet, set PlayerGatewayMode to ENABLED
or REQUIRED when calling CreateFleet
or CreateContainerFleet.
How to use: After creating a game session and adding players, call this operation with the game session ID and player IDs. When player gateway is enabled, the response includes connection endpoints and player gateway tokens that your game clients can use to connect to the game session through player gateway. To learn more about player gateway integration, see DDoS protection with Amazon GameLift Servers player gateway.
When player gateway is disabled or in locations where player gateway is not supported, this operation returns game server connection information without player gateway tokens, so that your game clients directly connect to the game server endpoint.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetPlayerConnectionDetails and EndGetPlayerConnectionDetails.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public virtual Task<GetPlayerConnectionDetailsResponse> GetPlayerConnectionDetailsAsync( GetPlayerConnectionDetailsRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetPlayerConnectionDetails service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServiceException | The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. |
| InvalidGameSessionStatusException | The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying. |
| InvalidRequestException | One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying. |
| LimitExceededException | The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying. |
| NotFoundException | The requested resources was not found. The resource was either not created yet or deleted. |
| UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
| UnsupportedRegionException | The requested operation is not supported in the Region specified. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer