{-# 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.DescribeGameServerInstances
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- __This operation is used with the GameLift FleetIQ solution and game
-- server groups.__
--
-- Retrieves status information about the Amazon EC2 instances associated
-- with a GameLift FleetIQ game server group. Use this operation to detect
-- when instances are active or not available to host new game servers.
--
-- To request status for all instances in the game server group, provide a
-- game server group ID only. To request status for specific instances,
-- provide the game server group ID and one or more instance IDs. Use the
-- pagination parameters to retrieve results in sequential segments. If
-- successful, a collection of @GameServerInstance@ objects is returned.
--
-- This operation is not designed to be called with every game server claim
-- request; this practice can cause you to exceed your API limit, which
-- results in errors. Instead, as a best practice, cache the results and
-- refresh your cache no more than once every 10 seconds.
--
-- __Learn more__
--
-- <https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html GameLift FleetIQ Guide>
--
-- This operation returns paginated results.
module Amazonka.GameLift.DescribeGameServerInstances
  ( -- * Creating a Request
    DescribeGameServerInstances (..),
    newDescribeGameServerInstances,

    -- * Request Lenses
    describeGameServerInstances_instanceIds,
    describeGameServerInstances_limit,
    describeGameServerInstances_nextToken,
    describeGameServerInstances_gameServerGroupName,

    -- * Destructuring the Response
    DescribeGameServerInstancesResponse (..),
    newDescribeGameServerInstancesResponse,

    -- * Response Lenses
    describeGameServerInstancesResponse_gameServerInstances,
    describeGameServerInstancesResponse_nextToken,
    describeGameServerInstancesResponse_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:/ 'newDescribeGameServerInstances' smart constructor.
data DescribeGameServerInstances = DescribeGameServerInstances'
  { -- | The Amazon EC2 instance IDs that you want to retrieve status on. Amazon
    -- EC2 instance IDs use a 17-character format, for example:
    -- @i-1234567890abcdef0@. To retrieve all instances in the game server
    -- group, leave this parameter empty.
    DescribeGameServerInstances -> Maybe (NonEmpty Text)
instanceIds :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text),
    -- | The maximum number of results to return. Use this parameter with
    -- @NextToken@ to get results as a set of sequential pages.
    DescribeGameServerInstances -> Maybe Natural
limit :: Prelude.Maybe Prelude.Natural,
    -- | A token that indicates the start of the next sequential page of results.
    -- Use the token that is returned with a previous call to this operation.
    -- To start at the beginning of the result set, do not specify a value.
    DescribeGameServerInstances -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A unique identifier for the game server group. Use either the name or
    -- ARN value.
    DescribeGameServerInstances -> Text
gameServerGroupName :: Prelude.Text
  }
  deriving (DescribeGameServerInstances -> DescribeGameServerInstances -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeGameServerInstances -> DescribeGameServerInstances -> Bool
$c/= :: DescribeGameServerInstances -> DescribeGameServerInstances -> Bool
== :: DescribeGameServerInstances -> DescribeGameServerInstances -> Bool
$c== :: DescribeGameServerInstances -> DescribeGameServerInstances -> Bool
Prelude.Eq, ReadPrec [DescribeGameServerInstances]
ReadPrec DescribeGameServerInstances
Int -> ReadS DescribeGameServerInstances
ReadS [DescribeGameServerInstances]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeGameServerInstances]
$creadListPrec :: ReadPrec [DescribeGameServerInstances]
readPrec :: ReadPrec DescribeGameServerInstances
$creadPrec :: ReadPrec DescribeGameServerInstances
readList :: ReadS [DescribeGameServerInstances]
$creadList :: ReadS [DescribeGameServerInstances]
readsPrec :: Int -> ReadS DescribeGameServerInstances
$creadsPrec :: Int -> ReadS DescribeGameServerInstances
Prelude.Read, Int -> DescribeGameServerInstances -> ShowS
[DescribeGameServerInstances] -> ShowS
DescribeGameServerInstances -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeGameServerInstances] -> ShowS
$cshowList :: [DescribeGameServerInstances] -> ShowS
show :: DescribeGameServerInstances -> String
$cshow :: DescribeGameServerInstances -> String
showsPrec :: Int -> DescribeGameServerInstances -> ShowS
$cshowsPrec :: Int -> DescribeGameServerInstances -> ShowS
Prelude.Show, forall x.
Rep DescribeGameServerInstances x -> DescribeGameServerInstances
forall x.
DescribeGameServerInstances -> Rep DescribeGameServerInstances x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeGameServerInstances x -> DescribeGameServerInstances
$cfrom :: forall x.
DescribeGameServerInstances -> Rep DescribeGameServerInstances x
Prelude.Generic)

-- |
-- Create a value of 'DescribeGameServerInstances' 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:
--
-- 'instanceIds', 'describeGameServerInstances_instanceIds' - The Amazon EC2 instance IDs that you want to retrieve status on. Amazon
-- EC2 instance IDs use a 17-character format, for example:
-- @i-1234567890abcdef0@. To retrieve all instances in the game server
-- group, leave this parameter empty.
--
-- 'limit', 'describeGameServerInstances_limit' - The maximum number of results to return. Use this parameter with
-- @NextToken@ to get results as a set of sequential pages.
--
-- 'nextToken', 'describeGameServerInstances_nextToken' - A token that indicates the start of the next sequential page of results.
-- Use the token that is returned with a previous call to this operation.
-- To start at the beginning of the result set, do not specify a value.
--
-- 'gameServerGroupName', 'describeGameServerInstances_gameServerGroupName' - A unique identifier for the game server group. Use either the name or
-- ARN value.
newDescribeGameServerInstances ::
  -- | 'gameServerGroupName'
  Prelude.Text ->
  DescribeGameServerInstances
newDescribeGameServerInstances :: Text -> DescribeGameServerInstances
newDescribeGameServerInstances Text
pGameServerGroupName_ =
  DescribeGameServerInstances'
    { $sel:instanceIds:DescribeGameServerInstances' :: Maybe (NonEmpty Text)
instanceIds =
        forall a. Maybe a
Prelude.Nothing,
      $sel:limit:DescribeGameServerInstances' :: Maybe Natural
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeGameServerInstances' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:gameServerGroupName:DescribeGameServerInstances' :: Text
gameServerGroupName = Text
pGameServerGroupName_
    }

-- | The Amazon EC2 instance IDs that you want to retrieve status on. Amazon
-- EC2 instance IDs use a 17-character format, for example:
-- @i-1234567890abcdef0@. To retrieve all instances in the game server
-- group, leave this parameter empty.
describeGameServerInstances_instanceIds :: Lens.Lens' DescribeGameServerInstances (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
describeGameServerInstances_instanceIds :: Lens' DescribeGameServerInstances (Maybe (NonEmpty Text))
describeGameServerInstances_instanceIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeGameServerInstances' {Maybe (NonEmpty Text)
instanceIds :: Maybe (NonEmpty Text)
$sel:instanceIds:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe (NonEmpty Text)
instanceIds} -> Maybe (NonEmpty Text)
instanceIds) (\s :: DescribeGameServerInstances
s@DescribeGameServerInstances' {} Maybe (NonEmpty Text)
a -> DescribeGameServerInstances
s {$sel:instanceIds:DescribeGameServerInstances' :: Maybe (NonEmpty Text)
instanceIds = Maybe (NonEmpty Text)
a} :: DescribeGameServerInstances) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The maximum number of results to return. Use this parameter with
-- @NextToken@ to get results as a set of sequential pages.
describeGameServerInstances_limit :: Lens.Lens' DescribeGameServerInstances (Prelude.Maybe Prelude.Natural)
describeGameServerInstances_limit :: Lens' DescribeGameServerInstances (Maybe Natural)
describeGameServerInstances_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeGameServerInstances' {Maybe Natural
limit :: Maybe Natural
$sel:limit:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Natural
limit} -> Maybe Natural
limit) (\s :: DescribeGameServerInstances
s@DescribeGameServerInstances' {} Maybe Natural
a -> DescribeGameServerInstances
s {$sel:limit:DescribeGameServerInstances' :: Maybe Natural
limit = Maybe Natural
a} :: DescribeGameServerInstances)

-- | A token that indicates the start of the next sequential page of results.
-- Use the token that is returned with a previous call to this operation.
-- To start at the beginning of the result set, do not specify a value.
describeGameServerInstances_nextToken :: Lens.Lens' DescribeGameServerInstances (Prelude.Maybe Prelude.Text)
describeGameServerInstances_nextToken :: Lens' DescribeGameServerInstances (Maybe Text)
describeGameServerInstances_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeGameServerInstances' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeGameServerInstances
s@DescribeGameServerInstances' {} Maybe Text
a -> DescribeGameServerInstances
s {$sel:nextToken:DescribeGameServerInstances' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeGameServerInstances)

-- | A unique identifier for the game server group. Use either the name or
-- ARN value.
describeGameServerInstances_gameServerGroupName :: Lens.Lens' DescribeGameServerInstances Prelude.Text
describeGameServerInstances_gameServerGroupName :: Lens' DescribeGameServerInstances Text
describeGameServerInstances_gameServerGroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeGameServerInstances' {Text
gameServerGroupName :: Text
$sel:gameServerGroupName:DescribeGameServerInstances' :: DescribeGameServerInstances -> Text
gameServerGroupName} -> Text
gameServerGroupName) (\s :: DescribeGameServerInstances
s@DescribeGameServerInstances' {} Text
a -> DescribeGameServerInstances
s {$sel:gameServerGroupName:DescribeGameServerInstances' :: Text
gameServerGroupName = Text
a} :: DescribeGameServerInstances)

instance Core.AWSPager DescribeGameServerInstances where
  page :: DescribeGameServerInstances
-> AWSResponse DescribeGameServerInstances
-> Maybe DescribeGameServerInstances
page DescribeGameServerInstances
rq AWSResponse DescribeGameServerInstances
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeGameServerInstances
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeGameServerInstancesResponse (Maybe Text)
describeGameServerInstancesResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeGameServerInstances
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens'
  DescribeGameServerInstancesResponse (Maybe [GameServerInstance])
describeGameServerInstancesResponse_gameServerInstances
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ DescribeGameServerInstances
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeGameServerInstances (Maybe Text)
describeGameServerInstances_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeGameServerInstances
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeGameServerInstancesResponse (Maybe Text)
describeGameServerInstancesResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest DescribeGameServerInstances where
  type
    AWSResponse DescribeGameServerInstances =
      DescribeGameServerInstancesResponse
  request :: (Service -> Service)
-> DescribeGameServerInstances
-> Request DescribeGameServerInstances
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 DescribeGameServerInstances
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeGameServerInstances)))
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 [GameServerInstance]
-> Maybe Text -> Int -> DescribeGameServerInstancesResponse
DescribeGameServerInstancesResponse'
            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
"GameServerInstances"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NextToken")
            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 DescribeGameServerInstances where
  hashWithSalt :: Int -> DescribeGameServerInstances -> Int
hashWithSalt Int
_salt DescribeGameServerInstances' {Maybe Natural
Maybe (NonEmpty Text)
Maybe Text
Text
gameServerGroupName :: Text
nextToken :: Maybe Text
limit :: Maybe Natural
instanceIds :: Maybe (NonEmpty Text)
$sel:gameServerGroupName:DescribeGameServerInstances' :: DescribeGameServerInstances -> Text
$sel:nextToken:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Text
$sel:limit:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Natural
$sel:instanceIds:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe (NonEmpty Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
instanceIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
gameServerGroupName

instance Prelude.NFData DescribeGameServerInstances where
  rnf :: DescribeGameServerInstances -> ()
rnf DescribeGameServerInstances' {Maybe Natural
Maybe (NonEmpty Text)
Maybe Text
Text
gameServerGroupName :: Text
nextToken :: Maybe Text
limit :: Maybe Natural
instanceIds :: Maybe (NonEmpty Text)
$sel:gameServerGroupName:DescribeGameServerInstances' :: DescribeGameServerInstances -> Text
$sel:nextToken:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Text
$sel:limit:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Natural
$sel:instanceIds:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe (NonEmpty Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
instanceIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
limit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
gameServerGroupName

instance Data.ToHeaders DescribeGameServerInstances where
  toHeaders :: DescribeGameServerInstances -> 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.DescribeGameServerInstances" ::
                          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 DescribeGameServerInstances where
  toJSON :: DescribeGameServerInstances -> Value
toJSON DescribeGameServerInstances' {Maybe Natural
Maybe (NonEmpty Text)
Maybe Text
Text
gameServerGroupName :: Text
nextToken :: Maybe Text
limit :: Maybe Natural
instanceIds :: Maybe (NonEmpty Text)
$sel:gameServerGroupName:DescribeGameServerInstances' :: DescribeGameServerInstances -> Text
$sel:nextToken:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Text
$sel:limit:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe Natural
$sel:instanceIds:DescribeGameServerInstances' :: DescribeGameServerInstances -> Maybe (NonEmpty Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"InstanceIds" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
instanceIds,
            (Key
"Limit" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
limit,
            (Key
"NextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"GameServerGroupName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
gameServerGroupName)
          ]
      )

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

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

-- | /See:/ 'newDescribeGameServerInstancesResponse' smart constructor.
data DescribeGameServerInstancesResponse = DescribeGameServerInstancesResponse'
  { -- | The collection of requested game server instances.
    DescribeGameServerInstancesResponse -> Maybe [GameServerInstance]
gameServerInstances :: Prelude.Maybe [GameServerInstance],
    -- | A token that indicates where to resume retrieving results on the next
    -- call to this operation. If no token is returned, these results represent
    -- the end of the list.
    DescribeGameServerInstancesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeGameServerInstancesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeGameServerInstancesResponse
-> DescribeGameServerInstancesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeGameServerInstancesResponse
-> DescribeGameServerInstancesResponse -> Bool
$c/= :: DescribeGameServerInstancesResponse
-> DescribeGameServerInstancesResponse -> Bool
== :: DescribeGameServerInstancesResponse
-> DescribeGameServerInstancesResponse -> Bool
$c== :: DescribeGameServerInstancesResponse
-> DescribeGameServerInstancesResponse -> Bool
Prelude.Eq, ReadPrec [DescribeGameServerInstancesResponse]
ReadPrec DescribeGameServerInstancesResponse
Int -> ReadS DescribeGameServerInstancesResponse
ReadS [DescribeGameServerInstancesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeGameServerInstancesResponse]
$creadListPrec :: ReadPrec [DescribeGameServerInstancesResponse]
readPrec :: ReadPrec DescribeGameServerInstancesResponse
$creadPrec :: ReadPrec DescribeGameServerInstancesResponse
readList :: ReadS [DescribeGameServerInstancesResponse]
$creadList :: ReadS [DescribeGameServerInstancesResponse]
readsPrec :: Int -> ReadS DescribeGameServerInstancesResponse
$creadsPrec :: Int -> ReadS DescribeGameServerInstancesResponse
Prelude.Read, Int -> DescribeGameServerInstancesResponse -> ShowS
[DescribeGameServerInstancesResponse] -> ShowS
DescribeGameServerInstancesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeGameServerInstancesResponse] -> ShowS
$cshowList :: [DescribeGameServerInstancesResponse] -> ShowS
show :: DescribeGameServerInstancesResponse -> String
$cshow :: DescribeGameServerInstancesResponse -> String
showsPrec :: Int -> DescribeGameServerInstancesResponse -> ShowS
$cshowsPrec :: Int -> DescribeGameServerInstancesResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeGameServerInstancesResponse x
-> DescribeGameServerInstancesResponse
forall x.
DescribeGameServerInstancesResponse
-> Rep DescribeGameServerInstancesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeGameServerInstancesResponse x
-> DescribeGameServerInstancesResponse
$cfrom :: forall x.
DescribeGameServerInstancesResponse
-> Rep DescribeGameServerInstancesResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeGameServerInstancesResponse' 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:
--
-- 'gameServerInstances', 'describeGameServerInstancesResponse_gameServerInstances' - The collection of requested game server instances.
--
-- 'nextToken', 'describeGameServerInstancesResponse_nextToken' - A token that indicates where to resume retrieving results on the next
-- call to this operation. If no token is returned, these results represent
-- the end of the list.
--
-- 'httpStatus', 'describeGameServerInstancesResponse_httpStatus' - The response's http status code.
newDescribeGameServerInstancesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeGameServerInstancesResponse
newDescribeGameServerInstancesResponse :: Int -> DescribeGameServerInstancesResponse
newDescribeGameServerInstancesResponse Int
pHttpStatus_ =
  DescribeGameServerInstancesResponse'
    { $sel:gameServerInstances:DescribeGameServerInstancesResponse' :: Maybe [GameServerInstance]
gameServerInstances =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeGameServerInstancesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeGameServerInstancesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The collection of requested game server instances.
describeGameServerInstancesResponse_gameServerInstances :: Lens.Lens' DescribeGameServerInstancesResponse (Prelude.Maybe [GameServerInstance])
describeGameServerInstancesResponse_gameServerInstances :: Lens'
  DescribeGameServerInstancesResponse (Maybe [GameServerInstance])
describeGameServerInstancesResponse_gameServerInstances = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeGameServerInstancesResponse' {Maybe [GameServerInstance]
gameServerInstances :: Maybe [GameServerInstance]
$sel:gameServerInstances:DescribeGameServerInstancesResponse' :: DescribeGameServerInstancesResponse -> Maybe [GameServerInstance]
gameServerInstances} -> Maybe [GameServerInstance]
gameServerInstances) (\s :: DescribeGameServerInstancesResponse
s@DescribeGameServerInstancesResponse' {} Maybe [GameServerInstance]
a -> DescribeGameServerInstancesResponse
s {$sel:gameServerInstances:DescribeGameServerInstancesResponse' :: Maybe [GameServerInstance]
gameServerInstances = Maybe [GameServerInstance]
a} :: DescribeGameServerInstancesResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A token that indicates where to resume retrieving results on the next
-- call to this operation. If no token is returned, these results represent
-- the end of the list.
describeGameServerInstancesResponse_nextToken :: Lens.Lens' DescribeGameServerInstancesResponse (Prelude.Maybe Prelude.Text)
describeGameServerInstancesResponse_nextToken :: Lens' DescribeGameServerInstancesResponse (Maybe Text)
describeGameServerInstancesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeGameServerInstancesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeGameServerInstancesResponse' :: DescribeGameServerInstancesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeGameServerInstancesResponse
s@DescribeGameServerInstancesResponse' {} Maybe Text
a -> DescribeGameServerInstancesResponse
s {$sel:nextToken:DescribeGameServerInstancesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeGameServerInstancesResponse)

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

instance
  Prelude.NFData
    DescribeGameServerInstancesResponse
  where
  rnf :: DescribeGameServerInstancesResponse -> ()
rnf DescribeGameServerInstancesResponse' {Int
Maybe [GameServerInstance]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
gameServerInstances :: Maybe [GameServerInstance]
$sel:httpStatus:DescribeGameServerInstancesResponse' :: DescribeGameServerInstancesResponse -> Int
$sel:nextToken:DescribeGameServerInstancesResponse' :: DescribeGameServerInstancesResponse -> Maybe Text
$sel:gameServerInstances:DescribeGameServerInstancesResponse' :: DescribeGameServerInstancesResponse -> Maybe [GameServerInstance]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [GameServerInstance]
gameServerInstances
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus