[ aws . gamelift ]

describe-ec2-instance-limits

Description

Retrieves the following information for the specified EC2 instance type:

• Maximum number of instances allowed per AWS account (service limit).

• Current usage for the AWS account.

To learn more about the capabilities of each instance type, see Amazon EC2 Instance Types . Note that the instance types offered may vary depending on the region.

Learn more

Setting up GameLift Fleets

Related operations

• CreateFleet

• ListFleets

• DeleteFleet

• DescribeFleetAttributes

• UpdateFleetAttributes

• StartFleetActions or StopFleetActions

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-ec2-instance-limits
[--ec2-instance-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--ec2-instance-type (string)

Name of an 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. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all 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

• 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

• 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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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 maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits .

EC2InstanceType -> (string)

Name of an 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. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

CurrentInstances -> (integer)

Number of instances of the specified type that are currently in use by this AWS account.

InstanceLimit -> (integer)

Number of instances allowed.