AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.
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
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeGameServerInstances and EndDescribeGameServerInstances.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public virtual Task<DescribeGameServerInstancesResponse> DescribeGameServerInstancesAsync( DescribeGameServerInstancesRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DescribeGameServerInstances service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServiceException | The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. |
| InvalidRequestException | One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying. |
| NotFoundException | The requested resources was not found. The resource was either not created yet or deleted. |
| UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer