Struct aws_sdk_gamelift::client::fluent_builders::ListGameServers

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

Fluent builder constructing a request to ListGameServers.

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Implementations

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

pub async fn send(
    self
) -> Result<ListGameServersOutput, SdkError<ListGameServersError>> where
    R::Policy: SmithyRetryPolicy<ListGameServersInputOperationOutputAlias, ListGameServersOutput, ListGameServersError, ListGameServersInputOperationRetryAlias>, 

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

An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

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

An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

pub fn sort_order(self, inp: SortOrder) -> Self

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

pub fn set_sort_order(self, input: Option<SortOrder>) -> Self

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

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 ListGameServers<C, M, R>

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

Formats the value using the given formatter.