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 ListGameServers operation. This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

Amazon GameLift FleetIQ Guide

Inheritance Hierarchy

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

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

Syntax

C#
public class ListGameServersRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The ListGameServersRequest type exposes the following members

Constructors

NameDescription
Public Method ListGameServersRequest()

Properties

NameTypeDescription
Public Property GameServerGroupName System.String

Gets and sets the property GameServerGroupName.

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Public Property Limit System.Int32

Gets and sets the property Limit.

The 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.

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.

Public Property SortOrder Amazon.GameLift.SortOrder

Gets and sets the property SortOrder.

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

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