Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.DescribeFleetLocationUtilization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

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

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Synopsis

Creating a Request

data DescribeFleetLocationUtilization Source #

See: newDescribeFleetLocationUtilization smart constructor.

Constructors

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

Instances

Instances details

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

newDescribeFleetLocationUtilization Source #

Arguments

:: Text	`DescribeFleetLocationUtilization`
-> Text	`DescribeFleetLocationUtilization`
-> DescribeFleetLocationUtilization

Create a value of DescribeFleetLocationUtilization 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:

DescribeFleetLocationUtilization, describeFleetLocationUtilization_fleetId - A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.

DescribeFleetLocationUtilization, describeFleetLocationUtilization_location - The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Request Lenses

describeFleetLocationUtilization_fleetId :: Lens' DescribeFleetLocationUtilization Text Source #

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

describeFleetLocationUtilization_location :: Lens' DescribeFleetLocationUtilization Text Source #

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

Destructuring the Response

data DescribeFleetLocationUtilizationResponse Source #

See: newDescribeFleetLocationUtilizationResponse smart constructor.

Constructors

DescribeFleetLocationUtilizationResponse'
Fields fleetUtilization :: Maybe FleetUtilization Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeFleetLocationUtilizationResponse Source #

Arguments

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

Create a value of DescribeFleetLocationUtilizationResponse 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:fleetUtilization:DescribeFleetLocationUtilizationResponse', describeFleetLocationUtilizationResponse_fleetUtilization - Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.

$sel:httpStatus:DescribeFleetLocationUtilizationResponse', describeFleetLocationUtilizationResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetLocationUtilizationResponse_fleetUtilization :: Lens' DescribeFleetLocationUtilizationResponse (Maybe FleetUtilization) Source #

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

describeFleetLocationUtilizationResponse_httpStatus :: Lens' DescribeFleetLocationUtilizationResponse Int Source #

The response's http status code.