Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . gamelift ]

describe-ec2-instance-limits

Description

The GameLift service limits and current utilization for an AWS Region or location. Instance limits control the number of instances, per instance type, per location, that your AWS 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 GameLift fleets. You can request a limit increase for your account by using the Service limits page in the 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 AWS 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 AWS 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 AWS Region: Provide both the AWS 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

Setting up GameLift fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-ec2-instance-limits
[--ec2-instance-type <value>]
[--location <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ec2-instance-type (string)

Name of an EC2 instance type that is supported in 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.

Possible values:

  • 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

--location (string)

The name of a remote location to request instance limits for, in the form of an AWS Region code such as us-west-2 .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve service limits for an EC2 instance type

The following describe-ec2-instance-limits example displays the maximum allowed instances and current instances in use for the specified EC2 instance type in the current Region. The result indicates that only five of the allowed twenty instances are being used.

aws gamelift describe-ec2-instance-limits \
    --ec2-instance-type m5.large

Output:

{
    "EC2InstanceLimits": [
        {
            "EC2InstanceType": ""m5.large",
            "CurrentInstances": 5,
            "InstanceLimit": 20
        }
    ]
}

For more information, see Choose Computing Resources in the Amazon GameLift Developer Guide.

Output

EC2InstanceLimits -> (list)

The maximum number of instances for the specified instance type.

(structure)

The GameLift service limits for an EC2 instance type and current utilization. GameLift allows AWS accounts a maximum number of instances, per instance type, per AWS Region or location, for use with GameLift. You can request an limit increase for your account by using the Service limits page in the GameLift console.

Related actions

DescribeEC2InstanceLimits

EC2InstanceType -> (string)

The name of an EC2 instance type. See Amazon EC2 Instance Types for detailed descriptions.

CurrentInstances -> (integer)

The number of instances for the specified type and location that are currently being used by the AWS account.

InstanceLimit -> (integer)

The number of instances that is allowed for the specified instance type and location.

Location -> (string)

An AWS Region code, such as us-west-2 .