Container for the parameters to the ListFleets operation. This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
You can use operation in the following ways:
-
To get a list of all fleets in a Region, don't provide a build or script identifier.
-
To get a list of all fleets where a specific game build is deployed, provide the build ID.
-
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.
-
To get a list of all fleets with a specific container group definition, provide the
ContainerGroupDefinitionID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.
Fleet IDs are returned in no particular order.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.ListFleetsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class ListFleetsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The ListFleetsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListFleetsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BuildId | System.String |
Gets and sets the property BuildId. A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. |
|
|
ContainerGroupDefinitionName | System.String |
Gets and sets the property ContainerGroupDefinitionName. The container group definition name to request fleets for. Use this parameter to return only fleets that are deployed with the specified container group definition. |
|
|
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. |
|
|
ScriptId | System.String |
Gets and sets the property ScriptId. A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN 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