Network.AWS.GameLift.DescribeFleetUtilization

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Fleet-related operations include:

• CreateFleet
• ListFleets
• Describe fleets:
• DescribeFleetAttributes
• DescribeFleetPortSettings
• DescribeFleetUtilization
• DescribeRuntimeConfiguration
• DescribeFleetEvents
• Update fleets:
• UpdateFleetAttributes
• UpdateFleetCapacity
• UpdateFleetPortSettings
• UpdateRuntimeConfiguration
• Manage fleet capacity:
• DescribeFleetCapacity
• UpdateFleetCapacity
• PutScalingPolicy (automatic scaling)
• DescribeScalingPolicies (automatic scaling)
• DeleteScalingPolicy (automatic scaling)
• DescribeEC2InstanceLimits
• DeleteFleet

Creating a Request

describeFleetUtilization :: DescribeFleetUtilization

Creates a value of DescribeFleetUtilization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dfuNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
• dfuLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
• dfuFleetIds - Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.

data DescribeFleetUtilization

Represents the input for a request action.

See: describeFleetUtilization smart constructor.

Instances

Eq DescribeFleetUtilization

Methods

(==) :: DescribeFleetUtilization -> DescribeFleetUtilization -> Bool

(/=) :: DescribeFleetUtilization -> DescribeFleetUtilization -> Bool

Data DescribeFleetUtilization

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFleetUtilization -> c DescribeFleetUtilization

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFleetUtilization

toConstr :: DescribeFleetUtilization -> Constr

dataTypeOf :: DescribeFleetUtilization -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFleetUtilization)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFleetUtilization)

gmapT :: (forall b. Data b => b -> b) -> DescribeFleetUtilization -> DescribeFleetUtilization

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetUtilization -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetUtilization -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeFleetUtilization -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFleetUtilization -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFleetUtilization -> m DescribeFleetUtilization

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetUtilization -> m DescribeFleetUtilization

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetUtilization -> m DescribeFleetUtilization

Read DescribeFleetUtilization

Methods

readsPrec :: Int -> ReadS DescribeFleetUtilization

readList :: ReadS [DescribeFleetUtilization]

readPrec :: ReadPrec DescribeFleetUtilization

readListPrec :: ReadPrec [DescribeFleetUtilization]

Show DescribeFleetUtilization

Methods

showsPrec :: Int -> DescribeFleetUtilization -> ShowS

show :: DescribeFleetUtilization -> String

showList :: [DescribeFleetUtilization] -> ShowS

Generic DescribeFleetUtilization

Associated Types

type Rep DescribeFleetUtilization :: * -> *

Methods

from :: DescribeFleetUtilization -> Rep DescribeFleetUtilization x

to :: Rep DescribeFleetUtilization x -> DescribeFleetUtilization

Hashable DescribeFleetUtilization

Methods

hashWithSalt :: Int -> DescribeFleetUtilization -> Int

hash :: DescribeFleetUtilization -> Int

ToJSON DescribeFleetUtilization

Methods

toJSON :: DescribeFleetUtilization -> Value

toEncoding :: DescribeFleetUtilization -> Encoding

toJSONList :: [DescribeFleetUtilization] -> Value

toEncodingList :: [DescribeFleetUtilization] -> Encoding

NFData DescribeFleetUtilization

Methods

rnf :: DescribeFleetUtilization -> ()

AWSRequest DescribeFleetUtilization

Associated Types

type Rs DescribeFleetUtilization :: *

Methods

request :: DescribeFleetUtilization -> Request DescribeFleetUtilization

response :: MonadResource m => Logger -> Service -> Proxy * DescribeFleetUtilization -> ClientResponse -> m (Response DescribeFleetUtilization)

ToQuery DescribeFleetUtilization

Methods

toQuery :: DescribeFleetUtilization -> QueryString

ToPath DescribeFleetUtilization

Methods

toPath :: DescribeFleetUtilization -> ByteString

ToHeaders DescribeFleetUtilization

Methods

toHeaders :: DescribeFleetUtilization -> [Header]

type Rep DescribeFleetUtilization

type Rep DescribeFleetUtilization = D1 (MetaData "DescribeFleetUtilization" "Network.AWS.GameLift.DescribeFleetUtilization" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "DescribeFleetUtilization'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfuNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dfuLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dfuFleetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))))))

type Rs DescribeFleetUtilization

type Rs DescribeFleetUtilization = DescribeFleetUtilizationResponse

Request Lenses

dfuNextToken :: Lens' DescribeFleetUtilization (Maybe Text)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

dfuLimit :: Lens' DescribeFleetUtilization (Maybe Natural)

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

dfuFleetIds :: Lens' DescribeFleetUtilization (Maybe (NonEmpty Text))

Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.

Destructuring the Response

describeFleetUtilizationResponse

Arguments

:: Int

dfursResponseStatus

-> DescribeFleetUtilizationResponse

Creates a value of DescribeFleetUtilizationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dfursNextToken - Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
• dfursFleetUtilization - Collection of objects containing utilization information for each requested fleet ID.
• dfursResponseStatus - -- | The response status code.

data DescribeFleetUtilizationResponse

Represents the returned data in response to a request action.

See: describeFleetUtilizationResponse smart constructor.

Instances

Eq DescribeFleetUtilizationResponse

Methods

(==) :: DescribeFleetUtilizationResponse -> DescribeFleetUtilizationResponse -> Bool

(/=) :: DescribeFleetUtilizationResponse -> DescribeFleetUtilizationResponse -> Bool

Data DescribeFleetUtilizationResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFleetUtilizationResponse -> c DescribeFleetUtilizationResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFleetUtilizationResponse

toConstr :: DescribeFleetUtilizationResponse -> Constr

dataTypeOf :: DescribeFleetUtilizationResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFleetUtilizationResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFleetUtilizationResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeFleetUtilizationResponse -> DescribeFleetUtilizationResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetUtilizationResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetUtilizationResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeFleetUtilizationResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFleetUtilizationResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFleetUtilizationResponse -> m DescribeFleetUtilizationResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetUtilizationResponse -> m DescribeFleetUtilizationResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetUtilizationResponse -> m DescribeFleetUtilizationResponse

Read DescribeFleetUtilizationResponse

Methods

readsPrec :: Int -> ReadS DescribeFleetUtilizationResponse

readList :: ReadS [DescribeFleetUtilizationResponse]

readPrec :: ReadPrec DescribeFleetUtilizationResponse

readListPrec :: ReadPrec [DescribeFleetUtilizationResponse]

Show DescribeFleetUtilizationResponse

Methods

showsPrec :: Int -> DescribeFleetUtilizationResponse -> ShowS

show :: DescribeFleetUtilizationResponse -> String

showList :: [DescribeFleetUtilizationResponse] -> ShowS

Generic DescribeFleetUtilizationResponse

Associated Types

type Rep DescribeFleetUtilizationResponse :: * -> *

Methods

from :: DescribeFleetUtilizationResponse -> Rep DescribeFleetUtilizationResponse x

to :: Rep DescribeFleetUtilizationResponse x -> DescribeFleetUtilizationResponse

NFData DescribeFleetUtilizationResponse

Methods

rnf :: DescribeFleetUtilizationResponse -> ()

type Rep DescribeFleetUtilizationResponse

type Rep DescribeFleetUtilizationResponse = D1 (MetaData "DescribeFleetUtilizationResponse" "Network.AWS.GameLift.DescribeFleetUtilization" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "DescribeFleetUtilizationResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfursNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dfursFleetUtilization") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FleetUtilization]))) (S1 (MetaSel (Just Symbol "_dfursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dfursNextToken :: Lens' DescribeFleetUtilizationResponse (Maybe Text)

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

dfursFleetUtilization :: Lens' DescribeFleetUtilizationResponse [FleetUtilization]

Collection of objects containing utilization information for each requested fleet ID.

dfursResponseStatus :: Lens' DescribeFleetUtilizationResponse Int

• - | The response status code.