Struct aws_sdk_gamelift::client::fluent_builders::DescribeGameServerInstances [−][src]
pub struct DescribeGameServerInstances<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to DescribeGameServerInstances
.
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties.
To request status for all instances in the game server group, provide a game server
group ID only. To request status for specific instances, provide the game server group
ID and one or more instance IDs. Use the pagination parameters to retrieve results in
sequential segments. If successful, a collection of GameServerInstance
objects is returned.
This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
Implementations
impl<C, M, R> DescribeGameServerInstances<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> DescribeGameServerInstances<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<DescribeGameServerInstancesOutput, SdkError<DescribeGameServerInstancesError>> where
R::Policy: SmithyRetryPolicy<DescribeGameServerInstancesInputOperationOutputAlias, DescribeGameServerInstancesOutput, DescribeGameServerInstancesError, DescribeGameServerInstancesInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<DescribeGameServerInstancesOutput, SdkError<DescribeGameServerInstancesError>> where
R::Policy: SmithyRetryPolicy<DescribeGameServerInstancesInputOperationOutputAlias, DescribeGameServerInstancesOutput, DescribeGameServerInstancesError, DescribeGameServerInstancesInputOperationRetryAlias>,
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. Use either the GameServerGroup name or ARN value.
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
Appends an item to InstanceIds
.
To override the contents of this collection use set_instance_ids
.
The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a
17-character format, for example: i-1234567890abcdef0
. To retrieve all
instances in the game server group, leave this parameter empty.
The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a
17-character format, for example: i-1234567890abcdef0
. To retrieve all
instances in the game server group, leave this parameter empty.
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
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.
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
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for DescribeGameServerInstances<C, M, R>
impl<C, M, R> Send for DescribeGameServerInstances<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for DescribeGameServerInstances<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for DescribeGameServerInstances<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for DescribeGameServerInstances<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