describeGameSessionQueues method
This API works with the following fleet types: EC2, Anywhere, Container
Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
May throw InternalServiceException.
May throw InvalidRequestException.
May throw NotFoundException.
May throw UnauthorizedException.
Parameter limit :
The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages. You
can request up to 50 results.
Parameter names :
A list of queue names to retrieve information for. You can use either the
queue ID or ARN value. To request settings for all queues, leave this
parameter empty.
Parameter nextToken :
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.
Implementation
Future<DescribeGameSessionQueuesOutput> describeGameSessionQueues({
int? limit,
List<String>? names,
String? nextToken,
}) async {
_s.validateNumRange(
'limit',
limit,
1,
1152921504606846976,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'GameLift.DescribeGameSessionQueues'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
if (limit != null) 'Limit': limit,
if (names != null) 'Names': names,
if (nextToken != null) 'NextToken': nextToken,
},
);
return DescribeGameSessionQueuesOutput.fromJson(jsonResponse.body);
}