/AWS1/CL_GML=>DESCRIBEFLEETCAPACITY()¶
About DescribeFleetCapacity¶
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.
With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.
This operation can be used in the following ways:
-
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity object is returned for each requested
fleet ID. Each FleetCapacity object includes a Location
property, which is set to the fleet's home Region. Capacity values are returned only for
fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Setting up Amazon GameLift fleets
Method Signature¶
IMPORTING¶
Optional arguments:¶
IT_FLEETIDS TYPE /AWS1/CL_GMLFLEETIDORARNLIST_W=>TT_FLEETIDORARNLIST TT_FLEETIDORARNLIST¶
A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
IV_LIMIT TYPE /AWS1/GMLPOSITIVEINTEGER /AWS1/GMLPOSITIVEINTEGER¶
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
IV_NEXTTOKEN TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING¶
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. This parameter is ignored when the request specifies one or a list of fleet IDs.