DescribePlayerSessionsInput
import type { DescribePlayerSessionsInput } from "https://aws-api.deno.dev/v0.3/services/gamelift.ts?docs=full";Represents the input for a request operation.
interface DescribePlayerSessionsInput {
GameSessionId?: string | null;
Limit?: number | null;
NextToken?: string | null;
PlayerId?: string | null;
PlayerSessionId?: string | null;
PlayerSessionStatusFilter?: string | null;
}§Properties
§
GameSessionId?: string | null
[src]A unique identifier for the game session to retrieve player sessions for.
§
Limit?: number | null
[src]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.
§
NextToken?: string | null
[src]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.
§
PlayerSessionStatusFilter?: string | null
[src]Player session status to filter results on.
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).