Struct aws_sdk_gamelift::client::fluent_builders::DescribeGameServer

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

Fluent builder constructing a request to DescribeGameServer.

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

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

GameLift FleetIQ Guide

Related actions

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

Implementations

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

pub async fn send(
    self
) -> Result<DescribeGameServerOutput, SdkError<DescribeGameServerError>> where
    R::Policy: SmithyRetryPolicy<DescribeGameServerInputOperationOutputAlias, DescribeGameServerOutput, DescribeGameServerError, DescribeGameServerInputOperationRetryAlias>, 

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

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

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

A custom string that uniquely identifies the game server information to be retrieved.

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

A custom string that uniquely identifies the game server information to be retrieved.

Trait Implementations

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

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

Formats the value using the given formatter.