GameLift / Client / describe_game_server_group
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.
To get attributes for a game server group, provide a group name or ARN value. If successful, a
GameServerGroupobject is returned.
See also: AWS API Documentation
response = client.describe_game_server_group( GameServerGroupName='string' )
GameServerGroupName (string) –
A unique identifier for the game server group. Use either the name or ARN value.
- Return type:
GameServerGroup (dict) –
An object with the property settings for the requested game server group resource.
GameServerGroupName (string) –
A developer-defined identifier for the game server group. The name is unique for each Region in each Amazon Web Services account.
GameServerGroupArn (string) –
A generated unique ID for the game server group.
RoleArn (string) –
The Amazon Resource Name ( ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
InstanceDefinitions (list) –
The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. Amazon GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.
InstanceType (string) –
An Amazon EC2 instance type designation.
WeightedCapacity (string) –
Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift FleetIQ to calculate the instance type’s cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is “1”.
BalancingStrategy (string) –
Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:
SPOT_ONLY- Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.
SPOT_PREFERRED- (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.
ON_DEMAND_ONLY- Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
GameServerProtectionPolicy (string) –
A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status.
AutoScalingGroupArn (string) –
A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this game server group.
Status (string) –
The current status of the game server group. Possible statuses include:
NEW- Amazon GameLift FleetIQ has validated the
ACTIVATING- Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.
ACTIVE- The game server group has been successfully created.
DELETE_SCHEDULED- A request to delete the game server group has been received.
DELETING- Amazon GameLift FleetIQ has received a valid
DeleteGameServerGroup()request and is processing it. Amazon GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.
DELETED- The game server group has been successfully deleted.
ERROR- The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.
StatusReason (string) –
Additional information about the current game server group status. This information might provide additional insight on groups that are in
SuspendedActions (list) –
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
CreationTime (datetime) –
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example
LastUpdatedTime (datetime) –
A timestamp that indicates when this game server group was last updated.