Container for the parameters to the ListContainerFleets operation. Retrieves a collection of container fleet resources in an Amazon Web Services Region. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
Request options
-
Get a list of all fleets. Call this operation without specifying a container group definition.
-
Get a list of fleets filtered by container group definition. Provide the container group definition name or ARN value.
-
To get a list of all Amazon GameLift Servers Realtime fleets with a specific configuration script, provide the script ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns a collection of container fleets 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.ListContainerFleetsRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class ListContainerFleetsRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The ListContainerFleetsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListContainerFleetsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ContainerGroupDefinitionName | System.String |
Gets and sets the property ContainerGroupDefinitionName. The container group definition to filter the list on. Use this parameter to retrieve only those fleets that use the specified container group definition. You can specify the container group definition's name to get fleets with the latest versions. Alternatively, provide an ARN value to get fleets with a specific version number. |
|
|
Limit | System.Nullable<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.7.2 and newer