/AWS1/CL_GML=>DESCRIBEFLEETUTILIZATION()¶
About DescribeFleetUtilization¶
Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
-
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get utilization 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 FleetUtilization object is returned for each requested fleet ID, unless the
fleet identifier is not found. Each fleet utilization object includes a
Location property, which is set to the fleet's home Region.
Some API operations may limit the number of fleet IDs 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 utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
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.