{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.GameLift.DescribeFleetLocationUtilization
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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__
--
-- <https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html Setting up GameLift fleets>
--
-- <https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet GameLift metrics for fleets>
module Amazonka.GameLift.DescribeFleetLocationUtilization
  ( -- * Creating a Request
    DescribeFleetLocationUtilization (..),
    newDescribeFleetLocationUtilization,

    -- * Request Lenses
    describeFleetLocationUtilization_fleetId,
    describeFleetLocationUtilization_location,

    -- * Destructuring the Response
    DescribeFleetLocationUtilizationResponse (..),
    newDescribeFleetLocationUtilizationResponse,

    -- * Response Lenses
    describeFleetLocationUtilizationResponse_fleetUtilization,
    describeFleetLocationUtilizationResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.GameLift.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeFleetLocationUtilization' smart constructor.
data DescribeFleetLocationUtilization = DescribeFleetLocationUtilization'
  { -- | A unique identifier for the fleet to request location utilization for.
    -- You can use either the fleet ID or ARN value.
    DescribeFleetLocationUtilization -> Text
fleetId :: Prelude.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@.
    DescribeFleetLocationUtilization -> Text
location :: Prelude.Text
  }
  deriving (DescribeFleetLocationUtilization
-> DescribeFleetLocationUtilization -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFleetLocationUtilization
-> DescribeFleetLocationUtilization -> Bool
$c/= :: DescribeFleetLocationUtilization
-> DescribeFleetLocationUtilization -> Bool
== :: DescribeFleetLocationUtilization
-> DescribeFleetLocationUtilization -> Bool
$c== :: DescribeFleetLocationUtilization
-> DescribeFleetLocationUtilization -> Bool
Prelude.Eq, ReadPrec [DescribeFleetLocationUtilization]
ReadPrec DescribeFleetLocationUtilization
Int -> ReadS DescribeFleetLocationUtilization
ReadS [DescribeFleetLocationUtilization]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFleetLocationUtilization]
$creadListPrec :: ReadPrec [DescribeFleetLocationUtilization]
readPrec :: ReadPrec DescribeFleetLocationUtilization
$creadPrec :: ReadPrec DescribeFleetLocationUtilization
readList :: ReadS [DescribeFleetLocationUtilization]
$creadList :: ReadS [DescribeFleetLocationUtilization]
readsPrec :: Int -> ReadS DescribeFleetLocationUtilization
$creadsPrec :: Int -> ReadS DescribeFleetLocationUtilization
Prelude.Read, Int -> DescribeFleetLocationUtilization -> ShowS
[DescribeFleetLocationUtilization] -> ShowS
DescribeFleetLocationUtilization -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFleetLocationUtilization] -> ShowS
$cshowList :: [DescribeFleetLocationUtilization] -> ShowS
show :: DescribeFleetLocationUtilization -> String
$cshow :: DescribeFleetLocationUtilization -> String
showsPrec :: Int -> DescribeFleetLocationUtilization -> ShowS
$cshowsPrec :: Int -> DescribeFleetLocationUtilization -> ShowS
Prelude.Show, forall x.
Rep DescribeFleetLocationUtilization x
-> DescribeFleetLocationUtilization
forall x.
DescribeFleetLocationUtilization
-> Rep DescribeFleetLocationUtilization x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeFleetLocationUtilization x
-> DescribeFleetLocationUtilization
$cfrom :: forall x.
DescribeFleetLocationUtilization
-> Rep DescribeFleetLocationUtilization x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFleetLocationUtilization' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'fleetId', 'describeFleetLocationUtilization_fleetId' - A unique identifier for the fleet to request location utilization for.
-- You can use either the fleet ID or ARN value.
--
-- 'location', '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@.
newDescribeFleetLocationUtilization ::
  -- | 'fleetId'
  Prelude.Text ->
  -- | 'location'
  Prelude.Text ->
  DescribeFleetLocationUtilization
newDescribeFleetLocationUtilization :: Text -> Text -> DescribeFleetLocationUtilization
newDescribeFleetLocationUtilization
  Text
pFleetId_
  Text
pLocation_ =
    DescribeFleetLocationUtilization'
      { $sel:fleetId:DescribeFleetLocationUtilization' :: Text
fleetId =
          Text
pFleetId_,
        $sel:location:DescribeFleetLocationUtilization' :: Text
location = Text
pLocation_
      }

-- | A unique identifier for the fleet to request location utilization for.
-- You can use either the fleet ID or ARN value.
describeFleetLocationUtilization_fleetId :: Lens.Lens' DescribeFleetLocationUtilization Prelude.Text
describeFleetLocationUtilization_fleetId :: Lens' DescribeFleetLocationUtilization Text
describeFleetLocationUtilization_fleetId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleetLocationUtilization' {Text
fleetId :: Text
$sel:fleetId:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
fleetId} -> Text
fleetId) (\s :: DescribeFleetLocationUtilization
s@DescribeFleetLocationUtilization' {} Text
a -> DescribeFleetLocationUtilization
s {$sel:fleetId:DescribeFleetLocationUtilization' :: Text
fleetId = Text
a} :: DescribeFleetLocationUtilization)

-- | 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@.
describeFleetLocationUtilization_location :: Lens.Lens' DescribeFleetLocationUtilization Prelude.Text
describeFleetLocationUtilization_location :: Lens' DescribeFleetLocationUtilization Text
describeFleetLocationUtilization_location = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleetLocationUtilization' {Text
location :: Text
$sel:location:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
location} -> Text
location) (\s :: DescribeFleetLocationUtilization
s@DescribeFleetLocationUtilization' {} Text
a -> DescribeFleetLocationUtilization
s {$sel:location:DescribeFleetLocationUtilization' :: Text
location = Text
a} :: DescribeFleetLocationUtilization)

instance
  Core.AWSRequest
    DescribeFleetLocationUtilization
  where
  type
    AWSResponse DescribeFleetLocationUtilization =
      DescribeFleetLocationUtilizationResponse
  request :: (Service -> Service)
-> DescribeFleetLocationUtilization
-> Request DescribeFleetLocationUtilization
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeFleetLocationUtilization
-> ClientResponse ClientBody
-> m (Either
        Error
        (ClientResponse (AWSResponse DescribeFleetLocationUtilization)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe FleetUtilization
-> Int -> DescribeFleetLocationUtilizationResponse
DescribeFleetLocationUtilizationResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"FleetUtilization")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance
  Prelude.Hashable
    DescribeFleetLocationUtilization
  where
  hashWithSalt :: Int -> DescribeFleetLocationUtilization -> Int
hashWithSalt
    Int
_salt
    DescribeFleetLocationUtilization' {Text
location :: Text
fleetId :: Text
$sel:location:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
$sel:fleetId:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
fleetId
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
location

instance
  Prelude.NFData
    DescribeFleetLocationUtilization
  where
  rnf :: DescribeFleetLocationUtilization -> ()
rnf DescribeFleetLocationUtilization' {Text
location :: Text
fleetId :: Text
$sel:location:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
$sel:fleetId:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
fleetId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
location

instance
  Data.ToHeaders
    DescribeFleetLocationUtilization
  where
  toHeaders :: DescribeFleetLocationUtilization -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"GameLift.DescribeFleetLocationUtilization" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DescribeFleetLocationUtilization where
  toJSON :: DescribeFleetLocationUtilization -> Value
toJSON DescribeFleetLocationUtilization' {Text
location :: Text
fleetId :: Text
$sel:location:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
$sel:fleetId:DescribeFleetLocationUtilization' :: DescribeFleetLocationUtilization -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"FleetId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
fleetId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Location" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
location)
          ]
      )

instance Data.ToPath DescribeFleetLocationUtilization where
  toPath :: DescribeFleetLocationUtilization -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance
  Data.ToQuery
    DescribeFleetLocationUtilization
  where
  toQuery :: DescribeFleetLocationUtilization -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDescribeFleetLocationUtilizationResponse' smart constructor.
data DescribeFleetLocationUtilizationResponse = DescribeFleetLocationUtilizationResponse'
  { -- | Utilization information for the requested fleet location. Utilization
    -- objects are returned only for fleets and locations that currently exist.
    DescribeFleetLocationUtilizationResponse -> Maybe FleetUtilization
fleetUtilization :: Prelude.Maybe FleetUtilization,
    -- | The response's http status code.
    DescribeFleetLocationUtilizationResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeFleetLocationUtilizationResponse
-> DescribeFleetLocationUtilizationResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFleetLocationUtilizationResponse
-> DescribeFleetLocationUtilizationResponse -> Bool
$c/= :: DescribeFleetLocationUtilizationResponse
-> DescribeFleetLocationUtilizationResponse -> Bool
== :: DescribeFleetLocationUtilizationResponse
-> DescribeFleetLocationUtilizationResponse -> Bool
$c== :: DescribeFleetLocationUtilizationResponse
-> DescribeFleetLocationUtilizationResponse -> Bool
Prelude.Eq, ReadPrec [DescribeFleetLocationUtilizationResponse]
ReadPrec DescribeFleetLocationUtilizationResponse
Int -> ReadS DescribeFleetLocationUtilizationResponse
ReadS [DescribeFleetLocationUtilizationResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFleetLocationUtilizationResponse]
$creadListPrec :: ReadPrec [DescribeFleetLocationUtilizationResponse]
readPrec :: ReadPrec DescribeFleetLocationUtilizationResponse
$creadPrec :: ReadPrec DescribeFleetLocationUtilizationResponse
readList :: ReadS [DescribeFleetLocationUtilizationResponse]
$creadList :: ReadS [DescribeFleetLocationUtilizationResponse]
readsPrec :: Int -> ReadS DescribeFleetLocationUtilizationResponse
$creadsPrec :: Int -> ReadS DescribeFleetLocationUtilizationResponse
Prelude.Read, Int -> DescribeFleetLocationUtilizationResponse -> ShowS
[DescribeFleetLocationUtilizationResponse] -> ShowS
DescribeFleetLocationUtilizationResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFleetLocationUtilizationResponse] -> ShowS
$cshowList :: [DescribeFleetLocationUtilizationResponse] -> ShowS
show :: DescribeFleetLocationUtilizationResponse -> String
$cshow :: DescribeFleetLocationUtilizationResponse -> String
showsPrec :: Int -> DescribeFleetLocationUtilizationResponse -> ShowS
$cshowsPrec :: Int -> DescribeFleetLocationUtilizationResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeFleetLocationUtilizationResponse x
-> DescribeFleetLocationUtilizationResponse
forall x.
DescribeFleetLocationUtilizationResponse
-> Rep DescribeFleetLocationUtilizationResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeFleetLocationUtilizationResponse x
-> DescribeFleetLocationUtilizationResponse
$cfrom :: forall x.
DescribeFleetLocationUtilizationResponse
-> Rep DescribeFleetLocationUtilizationResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFleetLocationUtilizationResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'fleetUtilization', 'describeFleetLocationUtilizationResponse_fleetUtilization' - Utilization information for the requested fleet location. Utilization
-- objects are returned only for fleets and locations that currently exist.
--
-- 'httpStatus', 'describeFleetLocationUtilizationResponse_httpStatus' - The response's http status code.
newDescribeFleetLocationUtilizationResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeFleetLocationUtilizationResponse
newDescribeFleetLocationUtilizationResponse :: Int -> DescribeFleetLocationUtilizationResponse
newDescribeFleetLocationUtilizationResponse
  Int
pHttpStatus_ =
    DescribeFleetLocationUtilizationResponse'
      { $sel:fleetUtilization:DescribeFleetLocationUtilizationResponse' :: Maybe FleetUtilization
fleetUtilization =
          forall a. Maybe a
Prelude.Nothing,
        $sel:httpStatus:DescribeFleetLocationUtilizationResponse' :: Int
httpStatus = Int
pHttpStatus_
      }

-- | Utilization information for the requested fleet location. Utilization
-- objects are returned only for fleets and locations that currently exist.
describeFleetLocationUtilizationResponse_fleetUtilization :: Lens.Lens' DescribeFleetLocationUtilizationResponse (Prelude.Maybe FleetUtilization)
describeFleetLocationUtilizationResponse_fleetUtilization :: Lens'
  DescribeFleetLocationUtilizationResponse (Maybe FleetUtilization)
describeFleetLocationUtilizationResponse_fleetUtilization = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleetLocationUtilizationResponse' {Maybe FleetUtilization
fleetUtilization :: Maybe FleetUtilization
$sel:fleetUtilization:DescribeFleetLocationUtilizationResponse' :: DescribeFleetLocationUtilizationResponse -> Maybe FleetUtilization
fleetUtilization} -> Maybe FleetUtilization
fleetUtilization) (\s :: DescribeFleetLocationUtilizationResponse
s@DescribeFleetLocationUtilizationResponse' {} Maybe FleetUtilization
a -> DescribeFleetLocationUtilizationResponse
s {$sel:fleetUtilization:DescribeFleetLocationUtilizationResponse' :: Maybe FleetUtilization
fleetUtilization = Maybe FleetUtilization
a} :: DescribeFleetLocationUtilizationResponse)

-- | The response's http status code.
describeFleetLocationUtilizationResponse_httpStatus :: Lens.Lens' DescribeFleetLocationUtilizationResponse Prelude.Int
describeFleetLocationUtilizationResponse_httpStatus :: Lens' DescribeFleetLocationUtilizationResponse Int
describeFleetLocationUtilizationResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleetLocationUtilizationResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeFleetLocationUtilizationResponse' :: DescribeFleetLocationUtilizationResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeFleetLocationUtilizationResponse
s@DescribeFleetLocationUtilizationResponse' {} Int
a -> DescribeFleetLocationUtilizationResponse
s {$sel:httpStatus:DescribeFleetLocationUtilizationResponse' :: Int
httpStatus = Int
a} :: DescribeFleetLocationUtilizationResponse)

instance
  Prelude.NFData
    DescribeFleetLocationUtilizationResponse
  where
  rnf :: DescribeFleetLocationUtilizationResponse -> ()
rnf DescribeFleetLocationUtilizationResponse' {Int
Maybe FleetUtilization
httpStatus :: Int
fleetUtilization :: Maybe FleetUtilization
$sel:httpStatus:DescribeFleetLocationUtilizationResponse' :: DescribeFleetLocationUtilizationResponse -> Int
$sel:fleetUtilization:DescribeFleetLocationUtilizationResponse' :: DescribeFleetLocationUtilizationResponse -> Maybe FleetUtilization
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe FleetUtilization
fleetUtilization
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus