Struct aws_sdk_gamelift::input::DescribePlayerSessionsInput

#[non_exhaustive]
pub struct DescribePlayerSessionsInput {
    pub game_session_id: Option<String>,
    pub player_id: Option<String>,
    pub player_session_id: Option<String>,
    pub player_session_status_filter: Option<String>,
    pub limit: Option<i32>,
    pub next_token: Option<String>,
}

Represents the input for a request operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

game_session_id: Option<String>

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

player_id: Option<String>

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

player_session_id: Option<String>

A unique identifier for a player session to retrieve.

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 timeout limit (60 seconds).

limit: Option<i32>

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.

next_token: Option<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.

Implementations

impl DescribePlayerSessionsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribePlayerSessions, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribePlayerSessions>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribePlayerSessionsInput

impl DescribePlayerSessionsInput

pub fn game_session_id(&self) -> Option<&str>

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

pub fn player_id(&self) -> Option<&str>

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

pub fn player_session_id(&self) -> Option<&str>

A unique identifier for a player session to retrieve.

pub fn player_session_status_filter(&self) -> Option<&str>

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

pub fn limit(&self) -> Option<i32>

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.

pub fn next_token(&self) -> Option<&str>

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.

Trait Implementations

impl Clone for DescribePlayerSessionsInput

fn clone(&self) -> DescribePlayerSessionsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribePlayerSessionsInput

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

Formats the value using the given formatter.

impl PartialEq<DescribePlayerSessionsInput> for DescribePlayerSessionsInput

fn eq(&self, other: &DescribePlayerSessionsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribePlayerSessionsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribePlayerSessionsInput