Struct aws_sdk_gamelift::client::fluent_builders::DescribeGameSessions

pub struct DescribeGameSessions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeGameSessions.

Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use DescribeGameSessionDetails.

This operation can be used in the following ways:

• To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.

• To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

• To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the AWS Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

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

Available in GameLift Local.

Learn more

Find a game session

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Implementations

impl<C, M, R> DescribeGameSessions<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeGameSessionsOutput, SdkError<DescribeGameSessionsError>> where
    R::Policy: SmithyRetryPolicy<DescribeGameSessionsInputOperationOutputAlias, DescribeGameSessionsOutput, DescribeGameSessionsError, DescribeGameSessionsInputOperationRetryAlias>, 

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 fleet_id(self, inp: impl Into<String>) -> Self

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

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

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

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

A unique identifier for the game session to retrieve.

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

A unique identifier for the game session to retrieve.

pub fn alias_id(self, inp: impl Into<String>) -> Self

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.

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

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.

pub fn location(self, inp: impl Into<String>) -> Self

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

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

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

pub fn status_filter(self, inp: impl Into<String>) -> Self

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.

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

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.

pub fn limit(self, inp: i32) -> Self

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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.

pub fn next_token(self, inp: 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.

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeGameSessions<C, M, R>

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

Formats the value using the given formatter.