{ "$schema": "https://json-structure.org/meta/core/v0/#", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-describe-player-sessions-input-structure.json", "name": "DescribePlayerSessionsInput", "description": "DescribePlayerSessionsInput schema from Amazon GameLift API", "type": "object", "properties": { "GameSessionId": { "allOf": [ { "$ref": "#/components/schemas/ArnStringModel" }, { "description": "A unique identifier for the game session to retrieve player sessions for." } ] }, "PlayerId": { "allOf": [ { "$ref": "#/components/schemas/NonZeroAndMaxString" }, { "description": "A unique identifier for a player to retrieve player sessions for." } ] }, "PlayerSessionId": { "allOf": [ { "$ref": "#/components/schemas/PlayerSessionId" }, { "description": "A unique identifier for a player session to retrieve." } ] }, "PlayerSessionStatusFilter": { "allOf": [ { "$ref": "#/components/schemas/NonZeroAndMaxString" }, { "description": "

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:

" } ] }, "Limit": { "allOf": [ { "$ref": "#/components/schemas/PositiveInteger" }, { "description": "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": { "allOf": [ { "$ref": "#/components/schemas/NonZeroAndMaxString" }, { "description": "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." } ] } } }