/AWS1/CL_GML=>DESCRIBEFLEETLOCATIONATTRS()¶
About DescribeFleetLocationAttributes¶
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
-
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
-
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a LocationAttributes object is returned for each requested
location. If the fleet does not have a requested location, no information is returned.
This operation does not return the home Region. To get information on a fleet's home
Region, call DescribeFleetAttributes.
Learn more
Setting up Amazon GameLift fleets
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN /AWS1/GMLFLEETIDORARN¶
A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.
Optional arguments:¶
IT_LOCATIONS TYPE /AWS1/CL_GMLLOCATIONLIST_W=>TT_LOCATIONLIST TT_LOCATIONLIST¶
A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as
us-west-2.
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 limit is not currently enforced.
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.