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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Related actions

Creating a Request

data DescribeFleetLocationCapacity Source #

Represents the input for a request operation.

See: newDescribeFleetLocationCapacity smart constructor.

Constructors

DescribeFleetLocationCapacity'
Fields fleetId :: Text A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value. location :: Text The fleet location to retrieve capacity information for. Specify a location in the form of an AWS Region code, such as `us-west-2`.

Instances

Instances details

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

newDescribeFleetLocationCapacity Source #

Arguments

:: Text	`$sel:fleetId:DescribeFleetLocationCapacity'`
-> Text	`$sel:location:DescribeFleetLocationCapacity'`
-> DescribeFleetLocationCapacity

Create a value of DescribeFleetLocationCapacity 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:fleetId:DescribeFleetLocationCapacity', describeFleetLocationCapacity_fleetId - A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

$sel:location:DescribeFleetLocationCapacity', describeFleetLocationCapacity_location - The fleet location to retrieve capacity information for. Specify a location in the form of an AWS Region code, such as us-west-2.

Request Lenses

describeFleetLocationCapacity_fleetId :: Lens' DescribeFleetLocationCapacity Text Source #

A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

describeFleetLocationCapacity_location :: Lens' DescribeFleetLocationCapacity Text Source #

The fleet location to retrieve capacity information for. Specify a location in the form of an AWS Region code, such as us-west-2.

Destructuring the Response

data DescribeFleetLocationCapacityResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeFleetLocationCapacityResponse smart constructor.

Constructors

DescribeFleetLocationCapacityResponse'
Fields fleetCapacity :: Maybe FleetCapacity Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeFleetLocationCapacityResponse Source #

Arguments

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

Create a value of DescribeFleetLocationCapacityResponse 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:fleetCapacity:DescribeFleetLocationCapacityResponse', describeFleetLocationCapacityResponse_fleetCapacity - Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.

$sel:httpStatus:DescribeFleetLocationCapacityResponse', describeFleetLocationCapacityResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetLocationCapacityResponse_fleetCapacity :: Lens' DescribeFleetLocationCapacityResponse (Maybe FleetCapacity) Source #

Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.

describeFleetLocationCapacityResponse_httpStatus :: Lens' DescribeFleetLocationCapacityResponse Int Source #

The response's http status code.