Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.DescribeEC2InstanceLimits

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data DescribeEC2InstanceLimits Source #

Represents the input for a request operation.

See: newDescribeEC2InstanceLimits smart constructor.

Constructors

DescribeEC2InstanceLimits'

Fields

location :: Maybe Text
The name of a remote location to request instance limits for, in the form of an AWS Region code such as us-west-2.
eC2InstanceType :: Maybe EC2InstanceType
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.

Instances

Instances details

Eq DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods (==) :: DescribeEC2InstanceLimits -> DescribeEC2InstanceLimits -> Bool # (/=) :: DescribeEC2InstanceLimits -> DescribeEC2InstanceLimits -> Bool #
Read DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods readsPrec :: Int -> ReadS DescribeEC2InstanceLimits # readList :: ReadS [DescribeEC2InstanceLimits] # readPrec :: ReadPrec DescribeEC2InstanceLimits # readListPrec :: ReadPrec [DescribeEC2InstanceLimits] #
Show DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods showsPrec :: Int -> DescribeEC2InstanceLimits -> ShowS # show :: DescribeEC2InstanceLimits -> String # showList :: [DescribeEC2InstanceLimits] -> ShowS #
Generic DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Associated Types type Rep DescribeEC2InstanceLimits :: Type -> Type # Methods from :: DescribeEC2InstanceLimits -> Rep DescribeEC2InstanceLimits x # to :: Rep DescribeEC2InstanceLimits x -> DescribeEC2InstanceLimits #
NFData DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods rnf :: DescribeEC2InstanceLimits -> () #
Hashable DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods hashWithSalt :: Int -> DescribeEC2InstanceLimits -> Int # hash :: DescribeEC2InstanceLimits -> Int #
ToJSON DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods toJSON :: DescribeEC2InstanceLimits -> Value # toEncoding :: DescribeEC2InstanceLimits -> Encoding # toJSONList :: [DescribeEC2InstanceLimits] -> Value # toEncodingList :: [DescribeEC2InstanceLimits] -> Encoding #
AWSRequest DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Associated Types type AWSResponse DescribeEC2InstanceLimits # Methods request :: DescribeEC2InstanceLimits -> Request DescribeEC2InstanceLimits # response :: MonadResource m => Logger -> Service -> Proxy DescribeEC2InstanceLimits -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEC2InstanceLimits))) #
ToHeaders DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods toHeaders :: DescribeEC2InstanceLimits -> [Header] #
ToPath DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods toPath :: DescribeEC2InstanceLimits -> ByteString #
ToQuery DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods toQuery :: DescribeEC2InstanceLimits -> QueryString #
type Rep DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits type Rep DescribeEC2InstanceLimits = D1 ('MetaData "DescribeEC2InstanceLimits" "Amazonka.GameLift.DescribeEC2InstanceLimits" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeEC2InstanceLimits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eC2InstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EC2InstanceType))))
type AWSResponse DescribeEC2InstanceLimits Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits type AWSResponse DescribeEC2InstanceLimits = DescribeEC2InstanceLimitsResponse

newDescribeEC2InstanceLimits :: DescribeEC2InstanceLimits Source #

Create a value of DescribeEC2InstanceLimits with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:location:DescribeEC2InstanceLimits', describeEC2InstanceLimits_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.

$sel:eC2InstanceType:DescribeEC2InstanceLimits', describeEC2InstanceLimits_eC2InstanceType - 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.

Request Lenses

describeEC2InstanceLimits_location :: Lens' DescribeEC2InstanceLimits (Maybe Text) Source #

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

describeEC2InstanceLimits_eC2InstanceType :: Lens' DescribeEC2InstanceLimits (Maybe EC2InstanceType) Source #

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.

Destructuring the Response

data DescribeEC2InstanceLimitsResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeEC2InstanceLimitsResponse smart constructor.

Constructors

DescribeEC2InstanceLimitsResponse'
Fields eC2InstanceLimits :: Maybe [EC2InstanceLimit] The maximum number of instances for the specified instance type. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeEC2InstanceLimitsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods (==) :: DescribeEC2InstanceLimitsResponse -> DescribeEC2InstanceLimitsResponse -> Bool # (/=) :: DescribeEC2InstanceLimitsResponse -> DescribeEC2InstanceLimitsResponse -> Bool #
Read DescribeEC2InstanceLimitsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods readsPrec :: Int -> ReadS DescribeEC2InstanceLimitsResponse # readList :: ReadS [DescribeEC2InstanceLimitsResponse] # readPrec :: ReadPrec DescribeEC2InstanceLimitsResponse # readListPrec :: ReadPrec [DescribeEC2InstanceLimitsResponse] #
Show DescribeEC2InstanceLimitsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods showsPrec :: Int -> DescribeEC2InstanceLimitsResponse -> ShowS # show :: DescribeEC2InstanceLimitsResponse -> String # showList :: [DescribeEC2InstanceLimitsResponse] -> ShowS #
Generic DescribeEC2InstanceLimitsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Associated Types type Rep DescribeEC2InstanceLimitsResponse :: Type -> Type # Methods from :: DescribeEC2InstanceLimitsResponse -> Rep DescribeEC2InstanceLimitsResponse x # to :: Rep DescribeEC2InstanceLimitsResponse x -> DescribeEC2InstanceLimitsResponse #
NFData DescribeEC2InstanceLimitsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits Methods rnf :: DescribeEC2InstanceLimitsResponse -> () #
type Rep DescribeEC2InstanceLimitsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeEC2InstanceLimits type Rep DescribeEC2InstanceLimitsResponse = D1 ('MetaData "DescribeEC2InstanceLimitsResponse" "Amazonka.GameLift.DescribeEC2InstanceLimits" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeEC2InstanceLimitsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eC2InstanceLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EC2InstanceLimit])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEC2InstanceLimitsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEC2InstanceLimitsResponse'`
-> DescribeEC2InstanceLimitsResponse

Create a value of DescribeEC2InstanceLimitsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eC2InstanceLimits:DescribeEC2InstanceLimitsResponse', describeEC2InstanceLimitsResponse_eC2InstanceLimits - The maximum number of instances for the specified instance type.

$sel:httpStatus:DescribeEC2InstanceLimitsResponse', describeEC2InstanceLimitsResponse_httpStatus - The response's http status code.

Response Lenses

describeEC2InstanceLimitsResponse_eC2InstanceLimits :: Lens' DescribeEC2InstanceLimitsResponse (Maybe [EC2InstanceLimit]) Source #

The maximum number of instances for the specified instance type.

describeEC2InstanceLimitsResponse_httpStatus :: Lens' DescribeEC2InstanceLimitsResponse Int Source #

The response's http status code.