DescribePlayerSessionsInput

public struct DescribePlayerSessionsInput : AWSShape
extension GameLift.DescribePlayerSessionsInput: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let gameSessionId: String?

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

    Declaration

    Swift

    public let limit: Int?

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

    Declaration

    Swift

    public let nextToken: String?

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

    Declaration

    Swift

    public let playerId: String?

  • A unique identifier for a player session to retrieve.

    Declaration

    Swift

    public let playerSessionId: String?

  • 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).

    Declaration

    Swift

    public let playerSessionStatusFilter: String?

  • Undocumented

    Declaration

    Swift

    public init(gameSessionId: String? = nil, limit: Int? = nil, nextToken: String? = nil, playerId: String? = nil, playerSessionId: String? = nil, playerSessionStatusFilter: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws

Paginators