Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeEC2InstanceLimits

This API works with the following fleet types: EC2

Retrieves the instance 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 Amazon GameLift Servers fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift Servers 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. To learn more about how Amazon GameLift Servers handles locations, see Amazon GameLift Servers service locations. 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 of the fleets that reside in ap-northeast-1, for all instance types that are deployed in ap-northeast-1.
Request specifies the Region ap-northeast-1 with location us-west-2. The result is limits and usage data on all of the fleets that reside in ap-northeast-1, for all instance types that are deployed in us-west-2.
Request specifies the Region us-east-1 with location ap-northeast-1. The result is limits and usage data on all of the fleets that reside in us-east-1, for all instance types that are deployed in ap-northeast-1. These limits do not affect fleets in any other Regions that deploy instances to ap-northeast-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 Amazon GameLift Servers fleets

Request Syntax


{
   "EC2InstanceType": "string",
   "Location": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

EC2InstanceType

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

Type: String

Required: No

Location

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[A-Za-z0-9\-]+

Required: No

Response Syntax


{
   "EC2InstanceLimits": [ 
      { 
         "CurrentInstances": number,
         "EC2InstanceType": "string",
         "InstanceLimit": number,
         "Location": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EC2InstanceLimits

The maximum number of instances for the specified instance type.

Type: Array of EC2InstanceLimit objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

UnsupportedRegionException

The requested operation is not supported in the Region specified.

HTTP Status Code: 400

Examples

Request EC2 instance limits for home region (ap-northeast-1) with no location

In this example, we request the instance limits and current usage for the m5.large instance type. The API call is made to the AWS Region ap-northeast-1 with no Location specified, so the results show limits and usage for fleets that reside in ap-northeast-1, for instances deployed in ap-northeast-1. The response indicates that our account allows up to 200 m5.large instances and currently has 25 deployed.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request


{
    "EC2InstanceType": "m5.large"
}

Sample Response


{
    "EC2InstanceLimits": [
        {
            "EC2InstanceType": "m5.large",
            "CurrentInstances": 25,
            "InstanceLimit": 200,
            "Location": "ap-northeast-1"
        }
    ]
}

Request EC2 instance limits for home region (ap-northeast-1) with remote location (us-west-2)

In this example, we request the instance limits and current usage for the m5.large instance type at a remote location. The API call is made to the AWS Region ap-northeast-1 with Location set to us-west-2. The results show limits and usage for fleets that reside in ap-northeast-1, for instances deployed in us-west-2. The response indicates that our account allows up to 100 m5.large instances and currently has 10 deployed.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request


{
    "EC2InstanceType": "m5.large",
    "Location": "us-west-2"
}

Sample Response


{
    "EC2InstanceLimits": [
        {
            "EC2InstanceType": "m5.large",
            "CurrentInstances": 10,
            "InstanceLimit": 100,
            "Location": "us-west-2"
        }
    ]
}

Request EC2 instance limits for home region (us-east-1) with remote location (ap-northeast-1)

In this example, we request the instance limits and current usage for the m5.large instance type at a remote location. The API call is made to the AWS Region us-east-1 with Location set to ap-northeast-1. The results show limits and usage for fleets that reside in us-east-1, for instances deployed in ap-northeast-1. These limits do not affect fleets in other Regions that also deploy instances to ap-northeast-1. The response indicates that our account allows up to 150 m5.large instances and currently has none deployed.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request


{
    "EC2InstanceType": "m5.large",
    "Location": "ap-northeast-1"
}

Sample Response


{
    "EC2InstanceLimits": [
        {
            "EC2InstanceType": "m5.large",
            "CurrentInstances": 0,
            "InstanceLimit": 150,
            "Location": "ap-northeast-1"
        }
    ]
}