Module Values.DescribePlayerSessionsInputSource

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 All APIs by task

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

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

    *)
  2. playerId : PlayerId.t option;
    (*

    A unique identifier for a player to retrieve player sessions for.

    *)
  3. playerSessionId : PlayerSessionId.t option;
    (*

    A unique identifier for a player session to retrieve.

    *)
  4. playerSessionStatusFilter : NonZeroAndMaxString.t option;
    (*

    Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response. Possible player session statuses include the following: RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. ACTIVE -- The player has been validated by the server process and is currently connected. COMPLETED -- The player connection has been dropped. TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

    *)
  5. limit : PositiveInteger.t option;
    (*

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

    *)
  6. nextToken : NonZeroAndMaxString.t option;
    (*

    A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

    *)
}
Sourceval make : ?gameSessionId:??? -> ?playerId:??? -> ?playerSessionId:??? -> ?playerSessionStatusFilter:??? -> ?limit:??? -> ?nextToken:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of PositiveInteger.t | `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