/AWS1/CL_GML=>DESCRIBEGAMESESSIONDETAILS()
¶
About DescribeGameSessionDetails¶
Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
-
To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
-
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
-
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSessionDetail
object is returned for each game
session that matches the request.
Learn more
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_FLEETID
TYPE /AWS1/GMLFLEETIDORARN
/AWS1/GMLFLEETIDORARN
¶
A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
IV_GAMESESSIONID
TYPE /AWS1/GMLARNSTRINGMODEL
/AWS1/GMLARNSTRINGMODEL
¶
A unique identifier for the game session to retrieve.
IV_ALIASID
TYPE /AWS1/GMLALIASIDORARN
/AWS1/GMLALIASIDORARN
¶
A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
IV_LOCATION
TYPE /AWS1/GMLLOCATIONSTRINGMODEL
/AWS1/GMLLOCATIONSTRINGMODEL
¶
A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2
.
IV_STATUSFILTER
TYPE /AWS1/GMLNONZEROANDMAXSTRING
/AWS1/GMLNONZEROANDMAXSTRING
¶
Game session status to filter results on. Possible game session statuses include
ACTIVE
,TERMINATED
,ACTIVATING
andTERMINATING
(the last two are transitory).
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.
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.