{-# 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.AppStream.DescribeFleets
-- 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 a list that describes one or more specified fleets, if the
-- fleet names are provided. Otherwise, all fleets in the account are
-- described.
--
-- This operation returns paginated results.
module Amazonka.AppStream.DescribeFleets
  ( -- * Creating a Request
    DescribeFleets (..),
    newDescribeFleets,

    -- * Request Lenses
    describeFleets_names,
    describeFleets_nextToken,

    -- * Destructuring the Response
    DescribeFleetsResponse (..),
    newDescribeFleetsResponse,

    -- * Response Lenses
    describeFleetsResponse_fleets,
    describeFleetsResponse_nextToken,
    describeFleetsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeFleets' smart constructor.
data DescribeFleets = DescribeFleets'
  { -- | The names of the fleets to describe.
    DescribeFleets -> Maybe [Text]
names :: Prelude.Maybe [Prelude.Text],
    -- | The pagination token to use to retrieve the next page of results for
    -- this operation. If this value is null, it retrieves the first page.
    DescribeFleets -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeFleets -> DescribeFleets -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFleets -> DescribeFleets -> Bool
$c/= :: DescribeFleets -> DescribeFleets -> Bool
== :: DescribeFleets -> DescribeFleets -> Bool
$c== :: DescribeFleets -> DescribeFleets -> Bool
Prelude.Eq, ReadPrec [DescribeFleets]
ReadPrec DescribeFleets
Int -> ReadS DescribeFleets
ReadS [DescribeFleets]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFleets]
$creadListPrec :: ReadPrec [DescribeFleets]
readPrec :: ReadPrec DescribeFleets
$creadPrec :: ReadPrec DescribeFleets
readList :: ReadS [DescribeFleets]
$creadList :: ReadS [DescribeFleets]
readsPrec :: Int -> ReadS DescribeFleets
$creadsPrec :: Int -> ReadS DescribeFleets
Prelude.Read, Int -> DescribeFleets -> ShowS
[DescribeFleets] -> ShowS
DescribeFleets -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFleets] -> ShowS
$cshowList :: [DescribeFleets] -> ShowS
show :: DescribeFleets -> String
$cshow :: DescribeFleets -> String
showsPrec :: Int -> DescribeFleets -> ShowS
$cshowsPrec :: Int -> DescribeFleets -> ShowS
Prelude.Show, forall x. Rep DescribeFleets x -> DescribeFleets
forall x. DescribeFleets -> Rep DescribeFleets x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFleets x -> DescribeFleets
$cfrom :: forall x. DescribeFleets -> Rep DescribeFleets x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFleets' 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:
--
-- 'names', 'describeFleets_names' - The names of the fleets to describe.
--
-- 'nextToken', 'describeFleets_nextToken' - The pagination token to use to retrieve the next page of results for
-- this operation. If this value is null, it retrieves the first page.
newDescribeFleets ::
  DescribeFleets
newDescribeFleets :: DescribeFleets
newDescribeFleets =
  DescribeFleets'
    { $sel:names:DescribeFleets' :: Maybe [Text]
names = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeFleets' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The names of the fleets to describe.
describeFleets_names :: Lens.Lens' DescribeFleets (Prelude.Maybe [Prelude.Text])
describeFleets_names :: Lens' DescribeFleets (Maybe [Text])
describeFleets_names = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleets' {Maybe [Text]
names :: Maybe [Text]
$sel:names:DescribeFleets' :: DescribeFleets -> Maybe [Text]
names} -> Maybe [Text]
names) (\s :: DescribeFleets
s@DescribeFleets' {} Maybe [Text]
a -> DescribeFleets
s {$sel:names:DescribeFleets' :: Maybe [Text]
names = Maybe [Text]
a} :: DescribeFleets) 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 pagination token to use to retrieve the next page of results for
-- this operation. If this value is null, it retrieves the first page.
describeFleets_nextToken :: Lens.Lens' DescribeFleets (Prelude.Maybe Prelude.Text)
describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text)
describeFleets_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleets' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeFleets' :: DescribeFleets -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeFleets
s@DescribeFleets' {} Maybe Text
a -> DescribeFleets
s {$sel:nextToken:DescribeFleets' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeFleets)

instance Core.AWSPager DescribeFleets where
  page :: DescribeFleets
-> AWSResponse DescribeFleets -> Maybe DescribeFleets
page DescribeFleets
rq AWSResponse DescribeFleets
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeFleets
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeFleetsResponse (Maybe Text)
describeFleetsResponse_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 DescribeFleets
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeFleetsResponse (Maybe [Fleet])
describeFleetsResponse_fleets
            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.$ DescribeFleets
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeFleets (Maybe Text)
describeFleets_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeFleets
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeFleetsResponse (Maybe Text)
describeFleetsResponse_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 DescribeFleets where
  type
    AWSResponse DescribeFleets =
      DescribeFleetsResponse
  request :: (Service -> Service) -> DescribeFleets -> Request DescribeFleets
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 DescribeFleets
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeFleets)))
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 [Fleet] -> Maybe Text -> Int -> DescribeFleetsResponse
DescribeFleetsResponse'
            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
"Fleets" 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 DescribeFleets where
  hashWithSalt :: Int -> DescribeFleets -> Int
hashWithSalt Int
_salt DescribeFleets' {Maybe [Text]
Maybe Text
nextToken :: Maybe Text
names :: Maybe [Text]
$sel:nextToken:DescribeFleets' :: DescribeFleets -> Maybe Text
$sel:names:DescribeFleets' :: DescribeFleets -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
names
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData DescribeFleets where
  rnf :: DescribeFleets -> ()
rnf DescribeFleets' {Maybe [Text]
Maybe Text
nextToken :: Maybe Text
names :: Maybe [Text]
$sel:nextToken:DescribeFleets' :: DescribeFleets -> Maybe Text
$sel:names:DescribeFleets' :: DescribeFleets -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
names
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders DescribeFleets where
  toHeaders :: DescribeFleets -> 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
"PhotonAdminProxyService.DescribeFleets" ::
                          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 DescribeFleets where
  toJSON :: DescribeFleets -> Value
toJSON DescribeFleets' {Maybe [Text]
Maybe Text
nextToken :: Maybe Text
names :: Maybe [Text]
$sel:nextToken:DescribeFleets' :: DescribeFleets -> Maybe Text
$sel:names:DescribeFleets' :: DescribeFleets -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Names" 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]
names,
            (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
          ]
      )

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

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

-- | /See:/ 'newDescribeFleetsResponse' smart constructor.
data DescribeFleetsResponse = DescribeFleetsResponse'
  { -- | Information about the fleets.
    DescribeFleetsResponse -> Maybe [Fleet]
fleets :: Prelude.Maybe [Fleet],
    -- | The pagination token to use to retrieve the next page of results for
    -- this operation. If there are no more pages, this value is null.
    DescribeFleetsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeFleetsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeFleetsResponse -> DescribeFleetsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFleetsResponse -> DescribeFleetsResponse -> Bool
$c/= :: DescribeFleetsResponse -> DescribeFleetsResponse -> Bool
== :: DescribeFleetsResponse -> DescribeFleetsResponse -> Bool
$c== :: DescribeFleetsResponse -> DescribeFleetsResponse -> Bool
Prelude.Eq, ReadPrec [DescribeFleetsResponse]
ReadPrec DescribeFleetsResponse
Int -> ReadS DescribeFleetsResponse
ReadS [DescribeFleetsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFleetsResponse]
$creadListPrec :: ReadPrec [DescribeFleetsResponse]
readPrec :: ReadPrec DescribeFleetsResponse
$creadPrec :: ReadPrec DescribeFleetsResponse
readList :: ReadS [DescribeFleetsResponse]
$creadList :: ReadS [DescribeFleetsResponse]
readsPrec :: Int -> ReadS DescribeFleetsResponse
$creadsPrec :: Int -> ReadS DescribeFleetsResponse
Prelude.Read, Int -> DescribeFleetsResponse -> ShowS
[DescribeFleetsResponse] -> ShowS
DescribeFleetsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFleetsResponse] -> ShowS
$cshowList :: [DescribeFleetsResponse] -> ShowS
show :: DescribeFleetsResponse -> String
$cshow :: DescribeFleetsResponse -> String
showsPrec :: Int -> DescribeFleetsResponse -> ShowS
$cshowsPrec :: Int -> DescribeFleetsResponse -> ShowS
Prelude.Show, forall x. Rep DescribeFleetsResponse x -> DescribeFleetsResponse
forall x. DescribeFleetsResponse -> Rep DescribeFleetsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFleetsResponse x -> DescribeFleetsResponse
$cfrom :: forall x. DescribeFleetsResponse -> Rep DescribeFleetsResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFleetsResponse' 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:
--
-- 'fleets', 'describeFleetsResponse_fleets' - Information about the fleets.
--
-- 'nextToken', 'describeFleetsResponse_nextToken' - The pagination token to use to retrieve the next page of results for
-- this operation. If there are no more pages, this value is null.
--
-- 'httpStatus', 'describeFleetsResponse_httpStatus' - The response's http status code.
newDescribeFleetsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeFleetsResponse
newDescribeFleetsResponse :: Int -> DescribeFleetsResponse
newDescribeFleetsResponse Int
pHttpStatus_ =
  DescribeFleetsResponse'
    { $sel:fleets:DescribeFleetsResponse' :: Maybe [Fleet]
fleets = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeFleetsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeFleetsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Information about the fleets.
describeFleetsResponse_fleets :: Lens.Lens' DescribeFleetsResponse (Prelude.Maybe [Fleet])
describeFleetsResponse_fleets :: Lens' DescribeFleetsResponse (Maybe [Fleet])
describeFleetsResponse_fleets = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleetsResponse' {Maybe [Fleet]
fleets :: Maybe [Fleet]
$sel:fleets:DescribeFleetsResponse' :: DescribeFleetsResponse -> Maybe [Fleet]
fleets} -> Maybe [Fleet]
fleets) (\s :: DescribeFleetsResponse
s@DescribeFleetsResponse' {} Maybe [Fleet]
a -> DescribeFleetsResponse
s {$sel:fleets:DescribeFleetsResponse' :: Maybe [Fleet]
fleets = Maybe [Fleet]
a} :: DescribeFleetsResponse) 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 pagination token to use to retrieve the next page of results for
-- this operation. If there are no more pages, this value is null.
describeFleetsResponse_nextToken :: Lens.Lens' DescribeFleetsResponse (Prelude.Maybe Prelude.Text)
describeFleetsResponse_nextToken :: Lens' DescribeFleetsResponse (Maybe Text)
describeFleetsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFleetsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeFleetsResponse' :: DescribeFleetsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeFleetsResponse
s@DescribeFleetsResponse' {} Maybe Text
a -> DescribeFleetsResponse
s {$sel:nextToken:DescribeFleetsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeFleetsResponse)

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

instance Prelude.NFData DescribeFleetsResponse where
  rnf :: DescribeFleetsResponse -> ()
rnf DescribeFleetsResponse' {Int
Maybe [Fleet]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
fleets :: Maybe [Fleet]
$sel:httpStatus:DescribeFleetsResponse' :: DescribeFleetsResponse -> Int
$sel:nextToken:DescribeFleetsResponse' :: DescribeFleetsResponse -> Maybe Text
$sel:fleets:DescribeFleetsResponse' :: DescribeFleetsResponse -> Maybe [Fleet]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Fleet]
fleets
      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