Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListGameServerGroups

Lists a game server groups.

Request Syntax


{
   "Limit": number,
   "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 game server groups' limit.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

Type: String

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

Required: No

Response Syntax


{
   "GameServerGroups": [ 
      { 
         "AutoScalingGroupArn": "string",
         "BalancingStrategy": "string",
         "CreationTime": number,
         "GameServerGroupArn": "string",
         "GameServerGroupName": "string",
         "GameServerProtectionPolicy": "string",
         "InstanceDefinitions": [ 
            { 
               "InstanceType": "string",
               "WeightedCapacity": "string"
            }
         ],
         "LastUpdatedTime": number,
         "RoleArn": "string",
         "Status": "string",
         "StatusReason": "string",
         "SuspendedActions": [ "string" ]
      }
   ],
   "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.

GameServerGroups

The game server groups' game server groups.

Type: Array of GameServerGroup objects

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

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

UnauthorizedException

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

HTTP Status Code: 400