2025/03/27 - Amazon GameLift - 9 updated api methods
Changes Amazon GameLift Servers add support for additional instance types.
{'EC2InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}
Response {'FleetAttributes': {'InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:
Managed EC2 fleet
An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a Compute.
To create an EC2 fleet, provide these required parameters:
Either BuildId or ScriptId
ComputeType set to EC2 (the default value)
EC2InboundPermissions
EC2InstanceType
FleetType
Name
RuntimeConfiguration with at least one ServerProcesses configuration
If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.
When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.
Anywhere fleet
An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.
To create an Anywhere fleet, provide these required parameters:
ComputeType set to ANYWHERE
Locations specifying a custom location
Name
If successful, this operation creates a new fleet resource and places it in ACTIVE status. You can register computes with a fleet in ACTIVE status.
Learn more
See also: AWS API Documentation
Request Syntax
client.create_fleet(
Name='string',
Description='string',
BuildId='string',
ScriptId='string',
ServerLaunchPath='string',
ServerLaunchParameters='string',
LogPaths=[
'string',
],
EC2InstanceType='t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
EC2InboundPermissions=[
{
'FromPort': 123,
'ToPort': 123,
'IpRange': 'string',
'Protocol': 'TCP'|'UDP'
},
],
NewGameSessionProtectionPolicy='NoProtection'|'FullProtection',
RuntimeConfiguration={
'ServerProcesses': [
{
'LaunchPath': 'string',
'Parameters': 'string',
'ConcurrentExecutions': 123
},
],
'MaxConcurrentGameSessionActivations': 123,
'GameSessionActivationTimeoutSeconds': 123
},
ResourceCreationLimitPolicy={
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
MetricGroups=[
'string',
],
PeerVpcAwsAccountId='string',
PeerVpcId='string',
FleetType='ON_DEMAND'|'SPOT',
InstanceRoleArn='string',
CertificateConfiguration={
'CertificateType': 'DISABLED'|'GENERATED'
},
Locations=[
{
'Location': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ComputeType='EC2'|'ANYWHERE',
AnywhereConfiguration={
'Cost': 'string'
},
InstanceRoleCredentialsProvider='SHARED_CREDENTIAL_FILE'
)
string
[REQUIRED]
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
string
A description for the fleet.
string
The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after the fleet is created.
string
The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type EC2. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.
string
This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
string
This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
list
This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
(string) --
string
The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
list
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Amazon GameLift Realtime fleets, Amazon GameLift automatically sets TCP and UDP ranges.
(dict) --
A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet. Processes are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges.
For Amazon GameLift Realtime fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
FromPort (integer) -- [REQUIRED]
A starting value for a range of allowed port numbers.
For fleets using Linux builds, only ports 22 and 1026-60000 are valid.
For fleets using Windows builds, only ports 1026-60000 are valid.
ToPort (integer) -- [REQUIRED]
An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
For fleets using Linux builds, only ports 22 and 1026-60000 are valid.
For fleets using Windows builds, only ports 1026-60000 are valid.
IpRange (string) -- [REQUIRED]
A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: " 000.000.000.000/[subnet mask]" or optionally the shortened version " 0.0.0.0/[subnet mask]".
Protocol (string) -- [REQUIRED]
The network communication protocol used by the fleet.
string
The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.
dict
Instructions for how to launch and run server processes on the fleet. Set runtime configuration for managed EC2 fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.
ServerProcesses (list) --
A collection of server process configurations that identify what server processes to run on fleet computes.
(dict) --
A set of instructions for launching server processes on fleet computes. Server processes run either an executable in a custom game build or a Amazon GameLift Realtime script. Server process configurations are part of a fleet's runtime configuration.
LaunchPath (string) -- [REQUIRED]
The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root:
Windows (custom game builds only): C:\game. Example: " C:\game\MyGame\server.exe"
Linux: /local/game. Examples: " /local/game/MyGame/server.exe" or " /local/game/MyRealtimeScript.js"
Parameters (string) --
An optional list of parameters to pass to the server executable or Realtime script on launch.
ConcurrentExecutions (integer) -- [REQUIRED]
The number of server processes using this configuration that run concurrently on each instance or compute.
MaxConcurrentGameSessionActivations (integer) --
The number of game sessions in status ACTIVATING to allow on an instance or compute. This setting limits the instance resources that can be used for new game activations at any one time.
GameSessionActivationTimeoutSeconds (integer) --
The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.
dict
A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
NewGameSessionsPerCreator (integer) --
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
PolicyPeriodInMinutes (integer) --
The time span used in evaluating the resource creation limit policy.
list
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
(string) --
string
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
string
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
string
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
string
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This fleet property can't be changed after the fleet is created.
dict
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED. You can't change this property after you create the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
CertificateType (string) -- [REQUIRED]
Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
list
A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in Amazon Web Services Regions that support multiple locations. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more Amazon Web Services Region codes, such as us-west-2, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.
(dict) --
A remote location where a multi-location fleet can deploy game servers for game hosting.
Location (string) -- [REQUIRED]
An Amazon Web Services Region code, such as us-west-2. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.
list
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
(dict) --
A label that you can assign to a Amazon GameLift resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
Key (string) -- [REQUIRED]
The key for a developer-defined key value pair for tagging an Amazon Web Services resource.
Value (string) -- [REQUIRED]
The value for a developer-defined key value pair for tagging an Amazon Web Services resource.
string
The type of compute resource used to host your game servers.
EC2 – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
ANYWHERE – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the AnywhereConfiguration parameter.
dict
Amazon GameLift Anywhere configuration options.
Cost (string) -- [REQUIRED]
The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see Setting up queues in the Amazon GameLift Developer Guide.
string
Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.
dict
Response Syntax
{
'FleetAttributes': {
'FleetId': 'string',
'FleetArn': 'string',
'FleetType': 'ON_DEMAND'|'SPOT',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'Description': 'string',
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED'|'NOT_FOUND',
'BuildId': 'string',
'BuildArn': 'string',
'ScriptId': 'string',
'ScriptArn': 'string',
'ServerLaunchPath': 'string',
'ServerLaunchParameters': 'string',
'LogPaths': [
'string',
],
'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
'ResourceCreationLimitPolicy': {
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
'MetricGroups': [
'string',
],
'StoppedActions': [
'AUTO_SCALING',
],
'InstanceRoleArn': 'string',
'CertificateConfiguration': {
'CertificateType': 'DISABLED'|'GENERATED'
},
'ComputeType': 'EC2'|'ANYWHERE',
'AnywhereConfiguration': {
'Cost': 'string'
},
'InstanceRoleCredentialsProvider': 'SHARED_CREDENTIAL_FILE'
},
'LocationStates': [
{
'Location': 'string',
'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED'|'NOT_FOUND'
},
]
}
Response Structure
(dict) --
FleetAttributes (dict) --
The properties for the new fleet, including the current status. All fleets are placed in NEW status on creation.
FleetId (string) --
A unique identifier for the fleet.
FleetArn (string) --
The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.
FleetType (string) --
Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
InstanceType (string) --
The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where ComputeType is EC2.
Description (string) --
A human-readable description of the fleet.
Name (string) --
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
CreationTime (datetime) --
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
ACTIVE -- The fleet is now ready to host game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
BuildId (string) --
A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".
BuildArn (string) --
The Amazon Resource Name ( ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. This attribute is used with fleets where ComputeType is "EC2".
ScriptId (string) --
A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".
ScriptArn (string) --
The Amazon Resource Name ( ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.
ServerLaunchPath (string) --
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration. Requests that use this parameter continue to be valid.
ServerLaunchParameters (string) --
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration. Requests that use this parameter continue to be valid.
LogPaths (list) --
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
(string) --
NewGameSessionProtectionPolicy (string) --
The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where ComputeType is EC2.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
OperatingSystem (string) --
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet. This attribute is used with fleets where ComputeType is EC2.
ResourceCreationLimitPolicy (dict) --
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
NewGameSessionsPerCreator (integer) --
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
PolicyPeriodInMinutes (integer) --
The time span used in evaluating the resource creation limit policy.
MetricGroups (list) --
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time. This attribute is used with fleets where ComputeType is EC2.
(string) --
StoppedActions (list) --
A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where ComputeType is EC2.
(string) --
InstanceRoleArn (string) --
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This attribute is used with fleets where ComputeType is EC2.
CertificateConfiguration (dict) --
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.
CertificateType (string) --
Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
ComputeType (string) --
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
AnywhereConfiguration (dict) --
A set of attributes that are specific to an Anywhere fleet.
Cost (string) --
The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see Setting up queues in the Amazon GameLift Developer Guide.
InstanceRoleCredentialsProvider (string) --
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is EC2.
LocationStates (list) --
The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to NEW. During fleet creation, Amazon GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.
(dict) --
A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.
NEW -- A new fleet location has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet location.
DELETING -- Hosts are responding to a delete fleet location request.
TERMINATED -- The fleet location no longer exists.
NOT_FOUND -- The fleet location was not found. This could be because the custom location was removed or not created.
Location (string) --
The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.
Status (string) --
The life-cycle status of a fleet location.
{'Compute': {'Type': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves properties for a specific compute resource in an Amazon GameLift fleet. You can list all computes in a fleet by calling ListCompute.
Request options
Provide the fleet ID and compute name. The compute name varies depending on the type of fleet.
For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute.
For a compute in a managed container fleet, provide a compute name. In a container fleet, each game server container group on a fleet instance is assigned a compute name.
For a compute in an Anywhere fleet, provide a registered compute name. Anywhere fleet computes are created when you register a hosting resource with the fleet.
Results
If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:
For a managed EC2 fleet, this operation returns information about the EC2 instance.
For an Anywhere fleet, this operation returns information about the registered compute.
See also: AWS API Documentation
Request Syntax
client.describe_compute(
FleetId='string',
ComputeName='string'
)
string
[REQUIRED]
A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN value.
string
[REQUIRED]
The unique identifier of the compute resource to retrieve properties for. For a managed container fleet or Anywhere fleet, use a compute name. For an EC2 fleet, use an instance ID. To retrieve a fleet's compute identifiers, call ListCompute.
dict
Response Syntax
{
'Compute': {
'FleetId': 'string',
'FleetArn': 'string',
'ComputeName': 'string',
'ComputeArn': 'string',
'IpAddress': 'string',
'DnsName': 'string',
'ComputeStatus': 'PENDING'|'ACTIVE'|'TERMINATING'|'IMPAIRED',
'Location': 'string',
'CreationTime': datetime(2015, 1, 1),
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'GameLiftServiceSdkEndpoint': 'string',
'GameLiftAgentEndpoint': 'string',
'InstanceId': 'string',
'ContainerAttributes': [
{
'ContainerName': 'string',
'ContainerRuntimeId': 'string'
},
],
'GameServerContainerGroupDefinitionArn': 'string'
}
}
Response Structure
(dict) --
Compute (dict) --
The set of properties for the requested compute resource.
FleetId (string) --
A unique identifier for the fleet that the compute belongs to.
FleetArn (string) --
The Amazon Resource Name (ARN) of the fleet that the compute belongs to.
ComputeName (string) --
A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId ID.
ComputeArn (string) --
The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a Compute ARN.
IpAddress (string) --
The IP address of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.
DnsName (string) --
The DNS name of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.
ComputeStatus (string) --
Current status of the compute. A compute must have an ACTIVE status to host game sessions.
Location (string) --
The name of the custom location you added to the fleet that this compute resource resides in.
CreationTime (datetime) --
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
OperatingSystem (string) --
The type of operating system on the compute resource.
Type (string) --
The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.
GameLiftServiceSdkEndpoint (string) --
The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift service.
GameLiftAgentEndpoint (string) --
The endpoint of the Amazon GameLift Agent.
InstanceId (string) --
The InstanceID of the EC2 instance that is hosting the compute.
ContainerAttributes (list) --
A set of attributes for each container in the compute.
(dict) --
A unique identifier for a container in a container fleet compute.
Returned by: DescribeCompute
ContainerName (string) --
The identifier for a container that's running in a compute.
ContainerRuntimeId (string) --
The runtime ID for the container that's running in a compute. This value is unique within the compute.
GameServerContainerGroupDefinitionArn (string) --
The game server container group definition for the compute.
{'EC2InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}
Response {'EC2InstanceLimits': {'EC2InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.
Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.
Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.
This operation can be used in the following ways:
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.
Learn more
See also: AWS API Documentation
Request Syntax
client.describe_ec2_instance_limits(
EC2InstanceType='t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
Location='string'
)
string
Name of an Amazon EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.
string
The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as us-west-2.
dict
Response Syntax
{
'EC2InstanceLimits': [
{
'EC2InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'CurrentInstances': 123,
'InstanceLimit': 123,
'Location': 'string'
},
]
}
Response Structure
(dict) --
EC2InstanceLimits (list) --
The maximum number of instances for the specified instance type.
(dict) --
The Amazon GameLift service limits for an Amazon EC2 instance type and current utilization. Amazon GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with Amazon GameLift. You can request an limit increase for your account by using the Service limits page in the Amazon GameLift console.
EC2InstanceType (string) --
The name of an Amazon EC2 instance type. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
CurrentInstances (integer) --
The number of instances for the specified type and location that are currently being used by the Amazon Web Services account.
InstanceLimit (integer) --
The number of instances that is allowed for the specified instance type and location.
Location (string) --
An Amazon Web Services Region code, such as us-west-2.
{'FleetAttributes': {'InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.
Learn more
See also: AWS API Documentation
Request Syntax
client.describe_fleet_attributes(
FleetIds=[
'string',
],
Limit=123,
NextToken='string'
)
list
A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
(string) --
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
string
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. This parameter is ignored when the request specifies one or a list of fleet IDs.
dict
Response Syntax
{
'FleetAttributes': [
{
'FleetId': 'string',
'FleetArn': 'string',
'FleetType': 'ON_DEMAND'|'SPOT',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'Description': 'string',
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED'|'NOT_FOUND',
'BuildId': 'string',
'BuildArn': 'string',
'ScriptId': 'string',
'ScriptArn': 'string',
'ServerLaunchPath': 'string',
'ServerLaunchParameters': 'string',
'LogPaths': [
'string',
],
'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
'ResourceCreationLimitPolicy': {
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
'MetricGroups': [
'string',
],
'StoppedActions': [
'AUTO_SCALING',
],
'InstanceRoleArn': 'string',
'CertificateConfiguration': {
'CertificateType': 'DISABLED'|'GENERATED'
},
'ComputeType': 'EC2'|'ANYWHERE',
'AnywhereConfiguration': {
'Cost': 'string'
},
'InstanceRoleCredentialsProvider': 'SHARED_CREDENTIAL_FILE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FleetAttributes (list) --
A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.
(dict) --
Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on the fleet's compute type, as follows:
EC2 fleet attributes identify a Build resource (for fleets with customer game server builds) or a Script resource (for Amazon GameLift Realtime fleets).
Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.
Returned by: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetAttributes
FleetId (string) --
A unique identifier for the fleet.
FleetArn (string) --
The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.
FleetType (string) --
Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
InstanceType (string) --
The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where ComputeType is EC2.
Description (string) --
A human-readable description of the fleet.
Name (string) --
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
CreationTime (datetime) --
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
ACTIVE -- The fleet is now ready to host game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
BuildId (string) --
A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".
BuildArn (string) --
The Amazon Resource Name ( ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. This attribute is used with fleets where ComputeType is "EC2".
ScriptId (string) --
A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".
ScriptArn (string) --
The Amazon Resource Name ( ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.
ServerLaunchPath (string) --
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration. Requests that use this parameter continue to be valid.
ServerLaunchParameters (string) --
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration. Requests that use this parameter continue to be valid.
LogPaths (list) --
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
(string) --
NewGameSessionProtectionPolicy (string) --
The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where ComputeType is EC2.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
OperatingSystem (string) --
The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet. This attribute is used with fleets where ComputeType is EC2.
ResourceCreationLimitPolicy (dict) --
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
NewGameSessionsPerCreator (integer) --
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
PolicyPeriodInMinutes (integer) --
The time span used in evaluating the resource creation limit policy.
MetricGroups (list) --
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time. This attribute is used with fleets where ComputeType is EC2.
(string) --
StoppedActions (list) --
A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where ComputeType is EC2.
(string) --
InstanceRoleArn (string) --
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This attribute is used with fleets where ComputeType is EC2.
CertificateConfiguration (dict) --
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.
CertificateType (string) --
Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
ComputeType (string) --
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
AnywhereConfiguration (dict) --
A set of attributes that are specific to an Anywhere fleet.
Cost (string) --
The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see Setting up queues in the Amazon GameLift Developer Guide.
InstanceRoleCredentialsProvider (string) --
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is EC2.
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.
{'FleetCapacity': {'InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for game server container groups.
With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html.
This operation can be used in the following ways:
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.
Learn more
See also: AWS API Documentation
Request Syntax
client.describe_fleet_capacity(
FleetIds=[
'string',
],
Limit=123,
NextToken='string'
)
list
A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
(string) --
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
string
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. This parameter is ignored when the request specifies one or a list of fleet IDs.
dict
Response Syntax
{
'FleetCapacity': [
{
'FleetId': 'string',
'FleetArn': 'string',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'InstanceCounts': {
'DESIRED': 123,
'MINIMUM': 123,
'MAXIMUM': 123,
'PENDING': 123,
'ACTIVE': 123,
'IDLE': 123,
'TERMINATING': 123
},
'Location': 'string',
'GameServerContainerGroupCounts': {
'PENDING': 123,
'ACTIVE': 123,
'IDLE': 123,
'TERMINATING': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FleetCapacity (list) --
A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist. Changes in desired instance value can take up to 1 minute to be reflected.
(dict) --
Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity, DescribeFleetLocationCapacity, UpdateFleetCapacity
FleetId (string) --
A unique identifier for the fleet associated with the location.
FleetArn (string) --
The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
InstanceType (string) --
The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
InstanceCounts (dict) --
The current number of instances in the fleet, listed by instance status. Counts for pending and terminating instances might be non-zero if the fleet is adjusting to a scaling event or if access to resources is temporarily affected.
DESIRED (integer) --
Requested number of active instances. Amazon GameLift takes action as needed to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances. A change in the desired instances value can take up to 1 minute to be reflected when viewing a fleet's capacity settings.
MINIMUM (integer) --
The minimum instance count value allowed.
MAXIMUM (integer) --
The maximum instance count value allowed.
PENDING (integer) --
Number of instances that are starting but not yet active.
ACTIVE (integer) --
Actual number of instances that are ready to host game sessions.
IDLE (integer) --
Number of active instances that are not currently hosting a game session.
TERMINATING (integer) --
Number of instances that are no longer active but haven't yet been terminated.
Location (string) --
The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as us-west-2.
GameServerContainerGroupCounts (dict) --
The number and status of game server container groups deployed in a container fleet.
PENDING (integer) --
The number of container groups that are starting up but haven't yet registered.
ACTIVE (integer) --
The number of container groups that have active game sessions.
IDLE (integer) --
The number of container groups that have no active game sessions.
TERMINATING (integer) --
The number of container groups that are in the process of shutting down.
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.
{'FleetCapacity': {'InstanceType': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a managed container fleet, this operation also returns counts for game server container groups.
Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
If successful, a FleetCapacity object is returned for the requested fleet location.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
See also: AWS API Documentation
Request Syntax
client.describe_fleet_location_capacity(
FleetId='string',
Location='string'
)
string
[REQUIRED]
A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.
string
[REQUIRED]
The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.
dict
Response Syntax
{
'FleetCapacity': {
'FleetId': 'string',
'FleetArn': 'string',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'InstanceCounts': {
'DESIRED': 123,
'MINIMUM': 123,
'MAXIMUM': 123,
'PENDING': 123,
'ACTIVE': 123,
'IDLE': 123,
'TERMINATING': 123
},
'Location': 'string',
'GameServerContainerGroupCounts': {
'PENDING': 123,
'ACTIVE': 123,
'IDLE': 123,
'TERMINATING': 123
}
}
}
Response Structure
(dict) --
FleetCapacity (dict) --
Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist. Changes in desired instance value can take up to 1 minute to be reflected.
FleetId (string) --
A unique identifier for the fleet associated with the location.
FleetArn (string) --
The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
InstanceType (string) --
The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
InstanceCounts (dict) --
The current number of instances in the fleet, listed by instance status. Counts for pending and terminating instances might be non-zero if the fleet is adjusting to a scaling event or if access to resources is temporarily affected.
DESIRED (integer) --
Requested number of active instances. Amazon GameLift takes action as needed to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances. A change in the desired instances value can take up to 1 minute to be reflected when viewing a fleet's capacity settings.
MINIMUM (integer) --
The minimum instance count value allowed.
MAXIMUM (integer) --
The maximum instance count value allowed.
PENDING (integer) --
Number of instances that are starting but not yet active.
ACTIVE (integer) --
Actual number of instances that are ready to host game sessions.
IDLE (integer) --
Number of active instances that are not currently hosting a game session.
TERMINATING (integer) --
Number of instances that are no longer active but haven't yet been terminated.
Location (string) --
The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as us-west-2.
GameServerContainerGroupCounts (dict) --
The number and status of game server container groups deployed in a container fleet.
PENDING (integer) --
The number of container groups that are starting up but haven't yet registered.
ACTIVE (integer) --
The number of container groups that have active game sessions.
IDLE (integer) --
The number of container groups that have no active game sessions.
TERMINATING (integer) --
The number of container groups that are in the process of shutting down.
{'Instances': {'Type': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute and https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.
You can call this operation in the following ways:
To get information on all instances in a fleet's home Region, specify the fleet ID.
To get information on all instances in a fleet's remote location, specify the fleet ID and location name.
To get information on a specific instance in a fleet, specify the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns Instance objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException.
Learn more
Related actions
See also: AWS API Documentation
Request Syntax
client.describe_instances(
FleetId='string',
InstanceId='string',
Limit=123,
NextToken='string',
Location='string'
)
string
[REQUIRED]
A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
string
A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
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.
string
The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
dict
Response Syntax
{
'Instances': [
{
'FleetId': 'string',
'FleetArn': 'string',
'InstanceId': 'string',
'IpAddress': 'string',
'DnsName': 'string',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'Status': 'PENDING'|'ACTIVE'|'TERMINATING',
'CreationTime': datetime(2015, 1, 1),
'Location': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Instances (list) --
A collection of objects containing properties for each instance returned.
(dict) --
Represents a virtual computing instance that runs game server processes and hosts game sessions. In Amazon GameLift, one or more instances make up a managed EC2 fleet.
FleetId (string) --
A unique identifier for the fleet that the instance belongs to.
FleetArn (string) --
The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
InstanceId (string) --
A unique identifier for the instance.
IpAddress (string) --
IP address that is assigned to the instance.
DnsName (string) --
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
OperatingSystem (string) --
Operating system that is running on this EC2 instance.
Type (string) --
EC2 instance type that defines the computing resources of this instance.
Status (string) --
Current status of the instance. Possible statuses include the following:
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
CreationTime (datetime) --
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Location (string) --
The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.
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.
{'ComputeList': {'Type': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Retrieves information on the compute resources in an Amazon GameLift fleet. Use the pagination parameters to retrieve results in a set of sequential pages.
Request options
Retrieve a list of all computes in a fleet. Specify a fleet ID.
Retrieve a list of all computes in a specific fleet location. Specify a fleet ID and location.
Results
If successful, this operation returns information on a set of computes. Depending on the type of fleet, the result includes the following information:
For a managed EC2 fleet (compute type EC2), this operation returns information about the EC2 instance. Compute names are EC2 instance IDs.
For an Anywhere fleet (compute type ANYWHERE), this operation returns compute names and details from when the compute was registered with RegisterCompute. This includes GameLiftServiceSdkEndpoint or GameLiftAgentEndpoint.
See also: AWS API Documentation
Request Syntax
client.list_compute(
FleetId='string',
Location='string',
ContainerGroupDefinitionName='string',
ComputeStatus='ACTIVE'|'IMPAIRED',
Limit=123,
NextToken='string'
)
string
[REQUIRED]
A unique identifier for the fleet to retrieve compute resources for.
string
The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a custom location. For a managed fleet, provide a Amazon Web Services Region or Local Zone code (for example: us-west-2 or us-west-2-lax-1).
string
For computes in a managed container fleet, the name of the deployed container group definition.
string
The status of computes in a managed container fleet, based on the success of the latest update deployment.
ACTIVE -- The compute is deployed with the correct container definitions. It is ready to process game servers and host game sessions.
IMPAIRED -- An update deployment to the compute failed, and the compute is deployed with incorrect container definitions.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
string
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.
dict
Response Syntax
{
'ComputeList': [
{
'FleetId': 'string',
'FleetArn': 'string',
'ComputeName': 'string',
'ComputeArn': 'string',
'IpAddress': 'string',
'DnsName': 'string',
'ComputeStatus': 'PENDING'|'ACTIVE'|'TERMINATING'|'IMPAIRED',
'Location': 'string',
'CreationTime': datetime(2015, 1, 1),
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'GameLiftServiceSdkEndpoint': 'string',
'GameLiftAgentEndpoint': 'string',
'InstanceId': 'string',
'ContainerAttributes': [
{
'ContainerName': 'string',
'ContainerRuntimeId': 'string'
},
],
'GameServerContainerGroupDefinitionArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComputeList (list) --
A list of compute resources in the specified fleet.
(dict) --
An Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift fleet differs depending on the fleet's compute type property as follows:
For managed EC2 fleets, a compute is an EC2 instance.
For Anywhere fleets, a compute is a computing resource that you provide and is registered to the fleet.
FleetId (string) --
A unique identifier for the fleet that the compute belongs to.
FleetArn (string) --
The Amazon Resource Name (ARN) of the fleet that the compute belongs to.
ComputeName (string) --
A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId ID.
ComputeArn (string) --
The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a Compute ARN.
IpAddress (string) --
The IP address of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.
DnsName (string) --
The DNS name of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.
ComputeStatus (string) --
Current status of the compute. A compute must have an ACTIVE status to host game sessions.
Location (string) --
The name of the custom location you added to the fleet that this compute resource resides in.
CreationTime (datetime) --
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
OperatingSystem (string) --
The type of operating system on the compute resource.
Type (string) --
The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.
GameLiftServiceSdkEndpoint (string) --
The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift service.
GameLiftAgentEndpoint (string) --
The endpoint of the Amazon GameLift Agent.
InstanceId (string) --
The InstanceID of the EC2 instance that is hosting the compute.
ContainerAttributes (list) --
A set of attributes for each container in the compute.
(dict) --
A unique identifier for a container in a container fleet compute.
Returned by: DescribeCompute
ContainerName (string) --
The identifier for a container that's running in a compute.
ContainerRuntimeId (string) --
The runtime ID for the container that's running in a compute. This value is unique within the compute.
GameServerContainerGroupDefinitionArn (string) --
The game server container group definition for the compute.
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.
{'Compute': {'Type': {'c5ad.12xlarge',
'c5ad.16xlarge',
'c5ad.24xlarge',
'c5ad.2xlarge',
'c5ad.4xlarge',
'c5ad.8xlarge',
'c5ad.large',
'c5ad.xlarge',
'c5n.18xlarge',
'c5n.2xlarge',
'c5n.4xlarge',
'c5n.9xlarge',
'c5n.large',
'c5n.xlarge',
'c6a.32xlarge',
'c6a.48xlarge',
'c6gd.12xlarge',
'c6gd.16xlarge',
'c6gd.2xlarge',
'c6gd.4xlarge',
'c6gd.8xlarge',
'c6gd.large',
'c6gd.medium',
'c6gd.xlarge',
'c6i.32xlarge',
'c6id.12xlarge',
'c6id.16xlarge',
'c6id.24xlarge',
'c6id.2xlarge',
'c6id.32xlarge',
'c6id.4xlarge',
'c6id.8xlarge',
'c6id.large',
'c6id.xlarge',
'c6in.12xlarge',
'c6in.16xlarge',
'c6in.24xlarge',
'c6in.2xlarge',
'c6in.32xlarge',
'c6in.4xlarge',
'c6in.8xlarge',
'c6in.large',
'c6in.xlarge',
'c7a.12xlarge',
'c7a.16xlarge',
'c7a.24xlarge',
'c7a.2xlarge',
'c7a.32xlarge',
'c7a.48xlarge',
'c7a.4xlarge',
'c7a.8xlarge',
'c7a.large',
'c7a.medium',
'c7a.xlarge',
'c7gd.12xlarge',
'c7gd.16xlarge',
'c7gd.2xlarge',
'c7gd.4xlarge',
'c7gd.8xlarge',
'c7gd.large',
'c7gd.medium',
'c7gd.xlarge',
'c7gn.12xlarge',
'c7gn.16xlarge',
'c7gn.2xlarge',
'c7gn.4xlarge',
'c7gn.8xlarge',
'c7gn.large',
'c7gn.medium',
'c7gn.xlarge',
'c7i.12xlarge',
'c7i.16xlarge',
'c7i.24xlarge',
'c7i.2xlarge',
'c7i.48xlarge',
'c7i.4xlarge',
'c7i.8xlarge',
'c7i.large',
'c7i.xlarge',
'c8g.12xlarge',
'c8g.16xlarge',
'c8g.24xlarge',
'c8g.2xlarge',
'c8g.48xlarge',
'c8g.4xlarge',
'c8g.8xlarge',
'c8g.large',
'c8g.medium',
'c8g.xlarge',
'm4.16xlarge',
'm5ad.12xlarge',
'm5ad.16xlarge',
'm5ad.24xlarge',
'm5ad.2xlarge',
'm5ad.4xlarge',
'm5ad.8xlarge',
'm5ad.large',
'm5ad.xlarge',
'm5d.12xlarge',
'm5d.16xlarge',
'm5d.24xlarge',
'm5d.2xlarge',
'm5d.4xlarge',
'm5d.8xlarge',
'm5d.large',
'm5d.xlarge',
'm5dn.12xlarge',
'm5dn.16xlarge',
'm5dn.24xlarge',
'm5dn.2xlarge',
'm5dn.4xlarge',
'm5dn.8xlarge',
'm5dn.large',
'm5dn.xlarge',
'm5n.12xlarge',
'm5n.16xlarge',
'm5n.24xlarge',
'm5n.2xlarge',
'm5n.4xlarge',
'm5n.8xlarge',
'm5n.large',
'm5n.xlarge',
'm6a.12xlarge',
'm6a.16xlarge',
'm6a.24xlarge',
'm6a.2xlarge',
'm6a.32xlarge',
'm6a.48xlarge',
'm6a.4xlarge',
'm6a.8xlarge',
'm6a.large',
'm6a.xlarge',
'm6gd.12xlarge',
'm6gd.16xlarge',
'm6gd.2xlarge',
'm6gd.4xlarge',
'm6gd.8xlarge',
'm6gd.large',
'm6gd.medium',
'm6gd.xlarge',
'm6i.12xlarge',
'm6i.16xlarge',
'm6i.24xlarge',
'm6i.2xlarge',
'm6i.32xlarge',
'm6i.4xlarge',
'm6i.8xlarge',
'm6i.large',
'm6i.xlarge',
'm6id.12xlarge',
'm6id.16xlarge',
'm6id.24xlarge',
'm6id.2xlarge',
'm6id.32xlarge',
'm6id.4xlarge',
'm6id.8xlarge',
'm6id.large',
'm6id.xlarge',
'm6idn.12xlarge',
'm6idn.16xlarge',
'm6idn.24xlarge',
'm6idn.2xlarge',
'm6idn.32xlarge',
'm6idn.4xlarge',
'm6idn.8xlarge',
'm6idn.large',
'm6idn.xlarge',
'm6in.12xlarge',
'm6in.16xlarge',
'm6in.24xlarge',
'm6in.2xlarge',
'm6in.32xlarge',
'm6in.4xlarge',
'm6in.8xlarge',
'm6in.large',
'm6in.xlarge',
'm7a.12xlarge',
'm7a.16xlarge',
'm7a.24xlarge',
'm7a.2xlarge',
'm7a.32xlarge',
'm7a.48xlarge',
'm7a.4xlarge',
'm7a.8xlarge',
'm7a.large',
'm7a.medium',
'm7a.xlarge',
'm7gd.12xlarge',
'm7gd.16xlarge',
'm7gd.2xlarge',
'm7gd.4xlarge',
'm7gd.8xlarge',
'm7gd.large',
'm7gd.medium',
'm7gd.xlarge',
'm7i.12xlarge',
'm7i.16xlarge',
'm7i.24xlarge',
'm7i.2xlarge',
'm7i.48xlarge',
'm7i.4xlarge',
'm7i.8xlarge',
'm7i.large',
'm7i.xlarge',
'm8g.12xlarge',
'm8g.16xlarge',
'm8g.24xlarge',
'm8g.2xlarge',
'm8g.48xlarge',
'm8g.4xlarge',
'm8g.8xlarge',
'm8g.large',
'm8g.medium',
'm8g.xlarge',
'r5ad.12xlarge',
'r5ad.16xlarge',
'r5ad.24xlarge',
'r5ad.2xlarge',
'r5ad.4xlarge',
'r5ad.8xlarge',
'r5ad.large',
'r5ad.xlarge',
'r5dn.12xlarge',
'r5dn.16xlarge',
'r5dn.24xlarge',
'r5dn.2xlarge',
'r5dn.4xlarge',
'r5dn.8xlarge',
'r5dn.large',
'r5dn.xlarge',
'r5n.12xlarge',
'r5n.16xlarge',
'r5n.24xlarge',
'r5n.2xlarge',
'r5n.4xlarge',
'r5n.8xlarge',
'r5n.large',
'r5n.xlarge',
'r6a.12xlarge',
'r6a.16xlarge',
'r6a.24xlarge',
'r6a.2xlarge',
'r6a.32xlarge',
'r6a.48xlarge',
'r6a.4xlarge',
'r6a.8xlarge',
'r6a.large',
'r6a.xlarge',
'r6gd.12xlarge',
'r6gd.16xlarge',
'r6gd.2xlarge',
'r6gd.4xlarge',
'r6gd.8xlarge',
'r6gd.large',
'r6gd.medium',
'r6gd.xlarge',
'r6i.12xlarge',
'r6i.16xlarge',
'r6i.24xlarge',
'r6i.2xlarge',
'r6i.32xlarge',
'r6i.4xlarge',
'r6i.8xlarge',
'r6i.large',
'r6i.xlarge',
'r6id.12xlarge',
'r6id.16xlarge',
'r6id.24xlarge',
'r6id.2xlarge',
'r6id.32xlarge',
'r6id.4xlarge',
'r6id.8xlarge',
'r6id.large',
'r6id.xlarge',
'r6idn.12xlarge',
'r6idn.16xlarge',
'r6idn.24xlarge',
'r6idn.2xlarge',
'r6idn.32xlarge',
'r6idn.4xlarge',
'r6idn.8xlarge',
'r6idn.large',
'r6idn.xlarge',
'r6in.12xlarge',
'r6in.16xlarge',
'r6in.24xlarge',
'r6in.2xlarge',
'r6in.32xlarge',
'r6in.4xlarge',
'r6in.8xlarge',
'r6in.large',
'r6in.xlarge',
'r7a.12xlarge',
'r7a.16xlarge',
'r7a.24xlarge',
'r7a.2xlarge',
'r7a.32xlarge',
'r7a.48xlarge',
'r7a.4xlarge',
'r7a.8xlarge',
'r7a.large',
'r7a.medium',
'r7a.xlarge',
'r7gd.12xlarge',
'r7gd.16xlarge',
'r7gd.2xlarge',
'r7gd.4xlarge',
'r7gd.8xlarge',
'r7gd.large',
'r7gd.medium',
'r7gd.xlarge',
'r7i.12xlarge',
'r7i.16xlarge',
'r7i.24xlarge',
'r7i.2xlarge',
'r7i.48xlarge',
'r7i.4xlarge',
'r7i.8xlarge',
'r7i.large',
'r7i.xlarge',
'r8g.12xlarge',
'r8g.16xlarge',
'r8g.24xlarge',
'r8g.2xlarge',
'r8g.48xlarge',
'r8g.4xlarge',
'r8g.8xlarge',
'r8g.large',
'r8g.medium',
'r8g.xlarge'}}}
Registers a compute resource in an Amazon GameLift Anywhere fleet.
For an Anywhere fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes.
To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource.
If successful, this operation returns compute details, including an Amazon GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to the Amazon GameLift server SDK action InitSDK().
To view compute details, call DescribeCompute with the compute name.
Learn more
Server SDK reference guides (for version 5.x)
See also: AWS API Documentation
Request Syntax
client.register_compute(
FleetId='string',
ComputeName='string',
CertificatePath='string',
DnsName='string',
IpAddress='string',
Location='string'
)
string
[REQUIRED]
A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.
string
[REQUIRED]
A descriptive label for the compute resource.
string
The path to a TLS certificate on your compute resource. Amazon GameLift doesn't validate the path and certificate.
string
The DNS name of the compute resource. Amazon GameLift requires either a DNS name or IP address.
string
The IP address of the compute resource. Amazon GameLift requires either a DNS name or IP address. When registering an Anywhere fleet, an IP address is required.
string
The name of a custom location to associate with the compute resource being registered. This parameter is required when registering a compute for an Anywhere fleet.
dict
Response Syntax
{
'Compute': {
'FleetId': 'string',
'FleetArn': 'string',
'ComputeName': 'string',
'ComputeArn': 'string',
'IpAddress': 'string',
'DnsName': 'string',
'ComputeStatus': 'PENDING'|'ACTIVE'|'TERMINATING'|'IMPAIRED',
'Location': 'string',
'CreationTime': datetime(2015, 1, 1),
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'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'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'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'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'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'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'m4.16xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6i.32xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge',
'GameLiftServiceSdkEndpoint': 'string',
'GameLiftAgentEndpoint': 'string',
'InstanceId': 'string',
'ContainerAttributes': [
{
'ContainerName': 'string',
'ContainerRuntimeId': 'string'
},
],
'GameServerContainerGroupDefinitionArn': 'string'
}
}
Response Structure
(dict) --
Compute (dict) --
The details of the compute resource you registered.
FleetId (string) --
A unique identifier for the fleet that the compute belongs to.
FleetArn (string) --
The Amazon Resource Name (ARN) of the fleet that the compute belongs to.
ComputeName (string) --
A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId ID.
ComputeArn (string) --
The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a Compute ARN.
IpAddress (string) --
The IP address of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.
DnsName (string) --
The DNS name of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.
ComputeStatus (string) --
Current status of the compute. A compute must have an ACTIVE status to host game sessions.
Location (string) --
The name of the custom location you added to the fleet that this compute resource resides in.
CreationTime (datetime) --
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
OperatingSystem (string) --
The type of operating system on the compute resource.
Type (string) --
The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.
GameLiftServiceSdkEndpoint (string) --
The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift service.
GameLiftAgentEndpoint (string) --
The endpoint of the Amazon GameLift Agent.
InstanceId (string) --
The InstanceID of the EC2 instance that is hosting the compute.
ContainerAttributes (list) --
A set of attributes for each container in the compute.
(dict) --
A unique identifier for a container in a container fleet compute.
Returned by: DescribeCompute
ContainerName (string) --
The identifier for a container that's running in a compute.
ContainerRuntimeId (string) --
The runtime ID for the container that's running in a compute. This value is unique within the compute.
GameServerContainerGroupDefinitionArn (string) --
The game server container group definition for the compute.