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

DescribePlayerSessionsRequest

class DescribePlayerSessionsRequest

Types

Builder

class Builder

Companion

object Companion

Properties

gameSessionId

val gameSessionId: String?

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: For Home Region game session - arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string>. For Remote Location game session - arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string>.

limit

val limit: Int?

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

val 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

val playerId: String?

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

playerSessionId

val playerSessionId: String?

A unique identifier for a player session to retrieve.

playerSessionStatusFilter

val 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.

Functions

copy

inline fun copy(block: DescribePlayerSessionsRequest.Builder.() -> Unit = {}): DescribePlayerSessionsRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String