Struct aws_sdk_gamelift::client::fluent_builders::DescribePlayerSessions

pub struct DescribePlayerSessions { /* private fields */ }

Fluent builder constructing a request to DescribePlayerSessions.

Retrieves properties for one or more player sessions.

This action can be used in the following ways:

• To retrieve a specific player session, provide the player session ID only.

• To retrieve all player sessions in a game session, provide the game session ID only.

• To retrieve all player sessions for a specific player, provide a player ID only.

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

Available in Amazon GameLift Local.

Related actions

CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task

Implementations

impl DescribePlayerSessions

pub async fn send(
    self
) -> Result<DescribePlayerSessionsOutput, SdkError<DescribePlayerSessionsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribePlayerSessionsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn game_session_id(self, input: impl Into<String>) -> Self

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

pub fn set_game_session_id(self, input: Option<String>) -> Self

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

pub fn player_id(self, input: impl Into<String>) -> Self

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

pub fn set_player_id(self, input: Option<String>) -> Self

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

pub fn player_session_id(self, input: impl Into<String>) -> Self

A unique identifier for a player session to retrieve.

pub fn set_player_session_id(self, input: Option<String>) -> Self

A unique identifier for a player session to retrieve.

pub fn player_session_status_filter(self, input: impl Into<String>) -> Self

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 set_player_session_status_filter(self, input: Option<String>) -> Self

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, input: i32) -> Self

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 set_limit(self, input: Option<i32>) -> Self

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, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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 DescribePlayerSessions

fn clone(&self) -> DescribePlayerSessions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribePlayerSessions

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

Formats the value using the given formatter.