Struct aws_sdk_gamelift::client::fluent_builders::UpdateGameServer [−][src]
pub struct UpdateGameServer<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to UpdateGameServer
.
This operation is used with the GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
-
To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.
-
To report health status, identify the game server and game server group and set health check to
HEALTHY
. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. -
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
Implementations
impl<C, M, R> UpdateGameServer<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> UpdateGameServer<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<UpdateGameServerOutput, SdkError<UpdateGameServerError>> where
R::Policy: SmithyRetryPolicy<UpdateGameServerInputOperationOutputAlias, UpdateGameServerOutput, UpdateGameServerError, UpdateGameServerInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<UpdateGameServerOutput, SdkError<UpdateGameServerError>> where
R::Policy: SmithyRetryPolicy<UpdateGameServerInputOperationOutputAlias, UpdateGameServerOutput, UpdateGameServerError, UpdateGameServerInputOperationRetryAlias>,
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.
A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
A custom string that uniquely identifies the game server to update.
A custom string that uniquely identifies the game server to update.
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.
Indicates whether the game server is available or is currently hosting gameplay.
Indicates whether the game server is available or is currently hosting gameplay.
Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.
Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for UpdateGameServer<C, M, R>
impl<C, M, R> Send for UpdateGameServer<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for UpdateGameServer<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for UpdateGameServer<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for UpdateGameServer<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more