Module Smaws_Client_GameLift.DescribePlayerSessions

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 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

All APIs by task

val error_to_string : [ Smaws_Lib.Protocols.AwsJson.error | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `NotFoundException of Types.not_found_exception | `UnauthorizedException of Types.unauthorized_exception ] -> string
val request : 'http_type Smaws_Lib.Context.t -> Types.describe_player_sessions_input -> (Types.describe_player_sessions_output, [> Smaws_Lib.Protocols.AwsJson.error | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `NotFoundException of Types.not_found_exception | `UnauthorizedException of Types.unauthorized_exception ]) Stdlib.result