Container for the parameters to the DescribeGameServerInstances operation. 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
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.DescribeGameServerInstancesRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class DescribeGameServerInstancesRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The DescribeGameServerInstancesRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeGameServerInstancesRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
GameServerGroupName | System.String |
Gets and sets the property GameServerGroupName. A unique identifier for the game server group. Use either the name or ARN value. |
|
|
InstanceIds | System.Collections.Generic.List<System.String> |
Gets and sets the property InstanceIds.
The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance
IDs use a 17-character format, for example: |
|
|
Limit | System.Int32 |
Gets and sets the property Limit.
The maximum number of results to return. Use this parameter with |
|
|
NextToken | System.String |
Gets and sets the property NextToken. 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. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5