Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeGameSessionQueues

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

View Your Queues

Request Syntax


{
   "Limit": number,
   "Names": [ "string" ],
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

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.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9-]+|^arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


{
   "GameSessionQueues": [ 
      { 
         "CustomEventData": "string",
         "Destinations": [ 
            { 
               "DestinationArn": "string"
            }
         ],
         "FilterConfiguration": { 
            "AllowedLocations": [ "string" ]
         },
         "GameSessionQueueArn": "string",
         "Name": "string",
         "NotificationTarget": "string",
         "PlayerLatencyPolicies": [ 
            { 
               "MaximumIndividualPlayerLatencyMilliseconds": number,
               "PolicyDurationSeconds": number
            }
         ],
         "PriorityConfiguration": { 
            "LocationOrder": [ "string" ],
            "PriorityOrder": [ "string" ]
         },
         "TimeoutInSeconds": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GameSessionQueues

A collection of objects that describe the requested game session queues.

Type: Array of GameSessionQueue objects

NextToken

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400