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.
Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.
You can call this operation in the following ways:
To get information on all instances in a fleet's home Region, specify the fleet ID.
To get information on all instances in a fleet's remote location, specify the fleet ID and location name.
To get information on a specific instance in a fleet, specify the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns Instance objects for each requested instance,
listed in no particular order. If you call this operation for an Anywhere fleet, you
receive an InvalidRequestException.
Learn more
Remotely connect to fleet instances
Related actions
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeInstancesAsync.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public virtual DescribeInstancesResponse DescribeInstances( DescribeInstancesRequest request )
Container for the necessary parameters to execute the DescribeInstances service method.
| 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. |
| UnsupportedRegionException | The requested operation is not supported in the Region specified. |
.NET Framework:
Supported in: 4.5 and newer, 3.5