gamelift/aws.sdk.kotlin.services.gamelift.model/DescribePlayerSessionsRequest/Builder

Builder

Properties

A unique identifier for the game session to retrieve player sessions for.

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

var nextToken: String?

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.

playerId

var playerId: String?

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

playerSessionId

var playerSessionId: String?

A unique identifier for a player session to retrieve.

playerSessionStatusFilter

var playerSessionStatusFilter: String?

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.