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, Anywhere, Container
Retrieves properties for one or more player sessions.
This action can be used in the following ways:
To retrieve a specific player session, provide the player session ID only.
To retrieve all player sessions in a game session, provide the game session ID only.
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or
player ID. You can filter this request by player session status. If you provide a
specific PlayerSessionId or PlayerId, Amazon GameLift Servers ignores
the filter criteria. Use the pagination parameters to retrieve results as a set of
sequential pages.
If successful, a PlayerSession object is returned for each session that matches
the request.
Related actions
For .NET Core this operation is only available in asynchronous form. Please refer to DescribePlayerSessionsAsync.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public virtual DescribePlayerSessionsResponse DescribePlayerSessions( DescribePlayerSessionsRequest request )
Container for the necessary parameters to execute the DescribePlayerSessions service method.
| 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. |
| InvalidRequestException | One or more parameter values in the request are invalid. Correct the invalid parameter values 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. |
.NET Framework:
Supported in: 4.5 and newer, 3.5