AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the DescribeInstances operation. Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.DescribeInstancesRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeInstancesRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The DescribeInstancesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeInstancesRequest()

Properties

NameTypeDescription
Public Property FleetId System.String

Gets and sets the property FleetId.

Unique identifier for a fleet to retrieve instance information for.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

Unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Public Property Limit System.Int32

Gets and sets the property Limit.

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Public Property NextToken System.String

Gets and sets the property NextToken.

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms