Module Values.GetPlayerConnectionDetailsOutputSource

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.

Sourcetype nonrec t = {
  1. gameSessionId : ArnStringModel.t option;
    (*

    An identifier for the game session that is unique across all regions for which the player connection details were retrieved. The value is always a full ARN in the following format: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string>.

    *)
  2. playerConnectionDetails : PlayerConnectionDetailList.t option;
    (*

    A collection of player connection detail objects, one for each requested player.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceException of InternalServiceException.t
  2. | `InvalidGameSessionStatusException of InvalidGameSessionStatusException.t
  3. | `InvalidRequestException of InvalidRequestException.t
  4. | `LimitExceededException of LimitExceededException.t
  5. | `NotFoundException of NotFoundException.t
  6. | `UnauthorizedException of UnauthorizedException.t
  7. | `UnsupportedRegionException of UnsupportedRegionException.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?gameSessionId:??? -> ?playerConnectionDetails:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidGameSessionStatusException of InvalidGameSessionStatusException.t | `InvalidRequestException of InvalidRequestException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidGameSessionStatusException of InvalidGameSessionStatusException.t | `InvalidRequestException of InvalidRequestException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Integer of PortNumber.t | `String of IpAddress.t ]) list ] list | `String of PlayerId.t | `Timestamp of Timestamp.t ]) list ] list | `String of ArnStringModel.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t