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¶

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

Setting up Amazon GameLift fleets

Synopsis¶

  describe-ec2-instance-limits
[--ec2-instance-type <value>]
[--location <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--ec2-instance-type (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.

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

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

--location (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 .

--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.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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 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 .

Table Of Contents

Feedback

User Guide