2020/08/27 - Amazon GameLift - 1 new 7 updated api methods
Changes GameLift FleetIQ as a standalone feature is now generally available. FleetIQ makes low-cost Spot instances viable for game hosting. Use GameLift FleetIQ with your EC2 Auto Scaling groups.
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties.
To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.
This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.describe_game_server_instances(
GameServerGroupName='string',
InstanceIds=[
'string',
],
Limit=123,
NextToken='string'
)
string
[REQUIRED]
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
list
The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0 . To retrieve all instances in the game server group, leave this parameter empty.
(string) --
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.
string
A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.
dict
Response Syntax
{
'GameServerInstances': [
{
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'InstanceId': 'string',
'InstanceStatus': 'ACTIVE'|'DRAINING'|'SPOT_TERMINATING'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GameServerInstances (list) --
The collection of requested game server instances.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.
Retrieve game server instances for a game server group by calling DescribeGameServerInstances .
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
GameServerGroupName (string) --
A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each AWS account.
GameServerGroupArn (string) --
A generated unique identifier for the game server group that includes the game server instance.
InstanceId (string) --
The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0 .
InstanceStatus (string) --
Current status of the game server instance.
ACTIVE -- The instance is viable for hosting game servers.
DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.
SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.
NextToken (string) --
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.
{'BalancingStrategy': {'ON_DEMAND_ONLY'}}
Response {'GameServerGroup': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon EC2 User Guide .
An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide .
To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.create_game_server_group(
GameServerGroupName='string',
RoleArn='string',
MinSize=123,
MaxSize=123,
LaunchTemplate={
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
InstanceDefinitions=[
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
AutoScalingPolicy={
'EstimatedInstanceWarmup': 123,
'TargetTrackingConfiguration': {
'TargetValue': 123.0
}
},
BalancingStrategy='SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
GameServerProtectionPolicy='NO_PROTECTION'|'FULL_PROTECTION',
VpcSubnets=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.
string
[REQUIRED]
The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
integer
[REQUIRED]
The minimum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
integer
[REQUIRED]
The maximum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
dict
[REQUIRED]
The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
LaunchTemplateId (string) --
A unique identifier for an existing EC2 launch template.
LaunchTemplateName (string) --
A readable identifier for an existing EC2 launch template.
Version (string) --
The version of the EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created.
list
[REQUIRED]
The EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide . You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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) -- [REQUIRED]
An 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 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 EC2 Auto Scaling User Guide . Default value is "1".
dict
Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
EstimatedInstanceWarmup (integer) --
Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.
TargetTrackingConfiguration (dict) -- [REQUIRED]
Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
TargetValue (float) -- [REQUIRED]
Desired value to use with a game server group target-based scaling policy.
string
Indicates how 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.
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 AWS regardless of protection status. This property is set to NO_PROTECTION by default.
list
A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly
(string) --
list
A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
(dict) --
A label that can be assigned to a GameLift resource.
Learn more
Tagging AWS Resources in the AWS General Reference
Related operations
TagResource
UntagResource
ListTagsForResource
Key (string) -- [REQUIRED]
The key for a developer-defined key:value pair for tagging an AWS resource.
Value (string) -- [REQUIRED]
The value for a developer-defined key:value pair for tagging an AWS resource.
dict
Response Syntax
{
'GameServerGroup': {
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
GameServerGroup (dict) --
The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE .
GameServerGroupName (string) --
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.
{'GameServerGroup': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
The game server group
The corresponding Auto Scaling group
All game servers that are currently running in the group
To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.
If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED , which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.
GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.delete_game_server_group(
GameServerGroupName='string',
DeleteOption='SAFE_DELETE'|'FORCE_DELETE'|'RETAIN'
)
string
[REQUIRED]
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
string
The type of delete to perform. Options include the following:
SAFE_DELETE – Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.
FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.
RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.
dict
Response Syntax
{
'GameServerGroup': {
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
GameServerGroup (dict) --
An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED .
GameServerGroupName (string) --
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.
{'GameServerGroup': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
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 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 GameServerGroup object is returned.
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.describe_game_server_group(
GameServerGroupName='string'
)
string
[REQUIRED]
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
dict
Response Syntax
{
'GameServerGroup': {
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
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 AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.
{'GameServerGroups': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers groups that exist in the current AWS account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.list_game_server_groups(
Limit=123,
NextToken='string'
)
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.
string
A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.
dict
Response Syntax
{
'GameServerGroups': [
{
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GameServerGroups (list) --
A collection of game server group objects that match the request.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding EC2 Auto Scaling group.
A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup . Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup , respectively.
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
GameServerGroupName (string) --
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.
NextToken (string) --
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.
{'GameServerGroup': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.
To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions .
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.resume_game_server_group(
GameServerGroupName='string',
ResumeActions=[
'REPLACE_INSTANCE_TYPES',
]
)
string
[REQUIRED]
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
list
[REQUIRED]
The activity to resume for this game server group.
(string) --
dict
Response Syntax
{
'GameServerGroup': {
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
GameServerGroup (dict) --
An object that describes the game server group resource, with the SuspendedActions property updated to reflect the resumed activity.
GameServerGroupName (string) --
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.
{'GameServerGroup': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions .
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.suspend_game_server_group(
GameServerGroupName='string',
SuspendActions=[
'REPLACE_INSTANCE_TYPES',
]
)
string
[REQUIRED]
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
list
[REQUIRED]
The activity to suspend for this game server group.
(string) --
dict
Response Syntax
{
'GameServerGroup': {
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
GameServerGroup (dict) --
An object that describes the game server group resource, with the SuspendedActions property updated to reflect the suspended activity.
GameServerGroupName (string) --
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.
{'BalancingStrategy': {'ON_DEMAND_ONLY'}}
Response {'GameServerGroup': {'BalancingStrategy': {'ON_DEMAND_ONLY'}}}
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.
To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.
Learn more
Related operations
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
See also: AWS API Documentation
Request Syntax
client.update_game_server_group(
GameServerGroupName='string',
RoleArn='string',
InstanceDefinitions=[
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
GameServerProtectionPolicy='NO_PROTECTION'|'FULL_PROTECTION',
BalancingStrategy='SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY'
)
string
[REQUIRED]
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
string
The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
list
An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide . You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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) -- [REQUIRED]
An 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 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 EC2 Auto Scaling User Guide . Default value is "1".
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 AWS regardless of protection status. This property is set to NO_PROTECTION by default.
string
Indicates how 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.
dict
Response Syntax
{
'GameServerGroup': {
'GameServerGroupName': 'string',
'GameServerGroupArn': 'string',
'RoleArn': 'string',
'InstanceDefinitions': [
{
'InstanceType': 'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge',
'WeightedCapacity': 'string'
},
],
'BalancingStrategy': 'SPOT_ONLY'|'SPOT_PREFERRED'|'ON_DEMAND_ONLY',
'GameServerProtectionPolicy': 'NO_PROTECTION'|'FULL_PROTECTION',
'AutoScalingGroupArn': 'string',
'Status': 'NEW'|'ACTIVATING'|'ACTIVE'|'DELETE_SCHEDULED'|'DELETING'|'DELETED'|'ERROR',
'StatusReason': 'string',
'SuspendedActions': [
'REPLACE_INSTANCE_TYPES',
],
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
GameServerGroup (dict) --
An object that describes the game server group resource with updated properties.
GameServerGroupName (string) --
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS 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 EC2 Auto Scaling groups.
InstanceDefinitions (list) --
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
(dict) --
This data type is used with the Amazon GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. 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 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 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 EC2 Auto Scaling User Guide . Default value is "1".
BalancingStrategy (string) --
Indicates how 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 AWS regardless of protection status.
AutoScalingGroupArn (string) --
A generated unique ID for the 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 - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. 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 ERROR status.
SuspendedActions (list) --
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
(string) --
CreationTime (datetime) --
A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
LastUpdatedTime (datetime) --
A timestamp that indicates when this game server group was last updated.