Struct aws_gamelift_server_sdk_rs::entity::DescribePlayerSessionsRequest

pub struct DescribePlayerSessionsRequest {
    pub game_session_id: Option<GameSessionId>,
    pub player_id: Option<PlayerId>,
    pub player_session_id: Option<PlayerSessionId>,
    pub player_session_status_filter: Option<String>,
    pub next_token: Option<NextToken>,
    pub limit: i32,
}

This data type is used to specify which player session(s) to retrieve. It can be used in several ways: (1) provide a PlayerSessionId to request a specific player session; (2) provide a GameSessionId to request all player sessions in the specified game session; or (3) provide a PlayerId to request all player sessions for the specified player. For large collections of player sessions, use the pagination parameters to retrieve results as sequential pages.

Fields

game_session_id: Option<GameSessionId>

Unique game session identifier. Use this parameter to request all player sessions for the specified game session. Game session ID format is as follows: arn:aws:gamelift:::gamesession/fleet-/. The value of is either a custom ID string (if one was specified when the game session was created) a generated string.

player_id: Option<PlayerId>

Unique identifier for a player. Player IDs are defined by the developer. See Generate Player IDs.

player_session_id: Option<PlayerSessionId>

Unique identifier for a player session.

player_session_status_filter: Option<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 time-out limit (60 seconds).

next_token: Option<NextToken>

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

limit: i32

Maximum number of results to return. Use this parameter with next_token to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Trait Implementations

impl Clone for DescribePlayerSessionsRequest

fn clone(&self) -> DescribePlayerSessionsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribePlayerSessionsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribePlayerSessionsRequest

fn default() -> DescribePlayerSessionsRequest

Returns the “default value” for a type.