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

DescribeGameSessionsRequest

class DescribeGameSessionsRequest

Types

Builder

class Builder

Companion

object Companion

Properties

aliasId

val aliasId: String?

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

fleetId

val fleetId: String?

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

gameSessionId

val gameSessionId: String?

An identifier for the game session that is unique across all regions to retrieve. 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.

location

val location: String?

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

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.

statusFilter

val statusFilter: String?

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String