/AWS1/CL_GML=>DESCRIBEFLEETATTRIBUTES()
¶
About DescribeFleetAttributes¶
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
-
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes
object is returned for each fleet
requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
Setting up Amazon GameLift fleets
Method Signature¶
IMPORTING¶
Optional arguments:¶
IT_FLEETIDS
TYPE /AWS1/CL_GMLFLEETIDORARNLIST_W=>TT_FLEETIDORARNLIST
TT_FLEETIDORARNLIST
¶
A list of unique fleet identifiers to retrieve attributes 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
NextToken
to 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.