{-# 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.ElasticSearch.DescribePackages
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes all packages available to Amazon ES. Includes options for
-- filtering, limiting the number of results, and pagination.
module Amazonka.ElasticSearch.DescribePackages
  ( -- * Creating a Request
    DescribePackages (..),
    newDescribePackages,

    -- * Request Lenses
    describePackages_filters,
    describePackages_maxResults,
    describePackages_nextToken,

    -- * Destructuring the Response
    DescribePackagesResponse (..),
    newDescribePackagesResponse,

    -- * Response Lenses
    describePackagesResponse_nextToken,
    describePackagesResponse_packageDetailsList,
    describePackagesResponse_httpStatus,
  )
where

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

-- | Container for request parameters to @ @@DescribePackage@@ @ operation.
--
-- /See:/ 'newDescribePackages' smart constructor.
data DescribePackages = DescribePackages'
  { -- | Only returns packages that match the @DescribePackagesFilterList@
    -- values.
    DescribePackages -> Maybe [DescribePackagesFilter]
filters :: Prelude.Maybe [DescribePackagesFilter],
    -- | Limits results to a maximum number of packages.
    DescribePackages -> Maybe Int
maxResults :: Prelude.Maybe Prelude.Int,
    -- | Used for pagination. Only necessary if a previous API call includes a
    -- non-null NextToken value. If provided, returns results for the next
    -- page.
    DescribePackages -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribePackages -> DescribePackages -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribePackages -> DescribePackages -> Bool
$c/= :: DescribePackages -> DescribePackages -> Bool
== :: DescribePackages -> DescribePackages -> Bool
$c== :: DescribePackages -> DescribePackages -> Bool
Prelude.Eq, ReadPrec [DescribePackages]
ReadPrec DescribePackages
Int -> ReadS DescribePackages
ReadS [DescribePackages]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribePackages]
$creadListPrec :: ReadPrec [DescribePackages]
readPrec :: ReadPrec DescribePackages
$creadPrec :: ReadPrec DescribePackages
readList :: ReadS [DescribePackages]
$creadList :: ReadS [DescribePackages]
readsPrec :: Int -> ReadS DescribePackages
$creadsPrec :: Int -> ReadS DescribePackages
Prelude.Read, Int -> DescribePackages -> ShowS
[DescribePackages] -> ShowS
DescribePackages -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribePackages] -> ShowS
$cshowList :: [DescribePackages] -> ShowS
show :: DescribePackages -> String
$cshow :: DescribePackages -> String
showsPrec :: Int -> DescribePackages -> ShowS
$cshowsPrec :: Int -> DescribePackages -> ShowS
Prelude.Show, forall x. Rep DescribePackages x -> DescribePackages
forall x. DescribePackages -> Rep DescribePackages x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribePackages x -> DescribePackages
$cfrom :: forall x. DescribePackages -> Rep DescribePackages x
Prelude.Generic)

-- |
-- Create a value of 'DescribePackages' 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:
--
-- 'filters', 'describePackages_filters' - Only returns packages that match the @DescribePackagesFilterList@
-- values.
--
-- 'maxResults', 'describePackages_maxResults' - Limits results to a maximum number of packages.
--
-- 'nextToken', 'describePackages_nextToken' - Used for pagination. Only necessary if a previous API call includes a
-- non-null NextToken value. If provided, returns results for the next
-- page.
newDescribePackages ::
  DescribePackages
newDescribePackages :: DescribePackages
newDescribePackages =
  DescribePackages'
    { $sel:filters:DescribePackages' :: Maybe [DescribePackagesFilter]
filters = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribePackages' :: Maybe Int
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribePackages' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | Only returns packages that match the @DescribePackagesFilterList@
-- values.
describePackages_filters :: Lens.Lens' DescribePackages (Prelude.Maybe [DescribePackagesFilter])
describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter])
describePackages_filters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePackages' {Maybe [DescribePackagesFilter]
filters :: Maybe [DescribePackagesFilter]
$sel:filters:DescribePackages' :: DescribePackages -> Maybe [DescribePackagesFilter]
filters} -> Maybe [DescribePackagesFilter]
filters) (\s :: DescribePackages
s@DescribePackages' {} Maybe [DescribePackagesFilter]
a -> DescribePackages
s {$sel:filters:DescribePackages' :: Maybe [DescribePackagesFilter]
filters = Maybe [DescribePackagesFilter]
a} :: DescribePackages) 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

-- | Limits results to a maximum number of packages.
describePackages_maxResults :: Lens.Lens' DescribePackages (Prelude.Maybe Prelude.Int)
describePackages_maxResults :: Lens' DescribePackages (Maybe Int)
describePackages_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePackages' {Maybe Int
maxResults :: Maybe Int
$sel:maxResults:DescribePackages' :: DescribePackages -> Maybe Int
maxResults} -> Maybe Int
maxResults) (\s :: DescribePackages
s@DescribePackages' {} Maybe Int
a -> DescribePackages
s {$sel:maxResults:DescribePackages' :: Maybe Int
maxResults = Maybe Int
a} :: DescribePackages)

-- | Used for pagination. Only necessary if a previous API call includes a
-- non-null NextToken value. If provided, returns results for the next
-- page.
describePackages_nextToken :: Lens.Lens' DescribePackages (Prelude.Maybe Prelude.Text)
describePackages_nextToken :: Lens' DescribePackages (Maybe Text)
describePackages_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePackages' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribePackages' :: DescribePackages -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribePackages
s@DescribePackages' {} Maybe Text
a -> DescribePackages
s {$sel:nextToken:DescribePackages' :: Maybe Text
nextToken = Maybe Text
a} :: DescribePackages)

instance Core.AWSRequest DescribePackages where
  type
    AWSResponse DescribePackages =
      DescribePackagesResponse
  request :: (Service -> Service)
-> DescribePackages -> Request DescribePackages
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 DescribePackages
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribePackages)))
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 Text
-> Maybe [PackageDetails] -> Int -> DescribePackagesResponse
DescribePackagesResponse'
            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
"NextToken")
            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
"PackageDetailsList"
                            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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribePackages where
  hashWithSalt :: Int -> DescribePackages -> Int
hashWithSalt Int
_salt DescribePackages' {Maybe Int
Maybe [DescribePackagesFilter]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
filters :: Maybe [DescribePackagesFilter]
$sel:nextToken:DescribePackages' :: DescribePackages -> Maybe Text
$sel:maxResults:DescribePackages' :: DescribePackages -> Maybe Int
$sel:filters:DescribePackages' :: DescribePackages -> Maybe [DescribePackagesFilter]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [DescribePackagesFilter]
filters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData DescribePackages where
  rnf :: DescribePackages -> ()
rnf DescribePackages' {Maybe Int
Maybe [DescribePackagesFilter]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
filters :: Maybe [DescribePackagesFilter]
$sel:nextToken:DescribePackages' :: DescribePackages -> Maybe Text
$sel:maxResults:DescribePackages' :: DescribePackages -> Maybe Int
$sel:filters:DescribePackages' :: DescribePackages -> Maybe [DescribePackagesFilter]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [DescribePackagesFilter]
filters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders DescribePackages where
  toHeaders :: DescribePackages -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToJSON DescribePackages where
  toJSON :: DescribePackages -> Value
toJSON DescribePackages' {Maybe Int
Maybe [DescribePackagesFilter]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
filters :: Maybe [DescribePackagesFilter]
$sel:nextToken:DescribePackages' :: DescribePackages -> Maybe Text
$sel:maxResults:DescribePackages' :: DescribePackages -> Maybe Int
$sel:filters:DescribePackages' :: DescribePackages -> Maybe [DescribePackagesFilter]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Filters" 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 [DescribePackagesFilter]
filters,
            (Key
"MaxResults" 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 Int
maxResults,
            (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 DescribePackages where
  toPath :: DescribePackages -> ByteString
toPath =
    forall a b. a -> b -> a
Prelude.const ByteString
"/2015-01-01/packages/describe"

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

-- | Container for response returned by @ @@DescribePackages@@ @ operation.
--
-- /See:/ 'newDescribePackagesResponse' smart constructor.
data DescribePackagesResponse = DescribePackagesResponse'
  { DescribePackagesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | List of @PackageDetails@ objects.
    DescribePackagesResponse -> Maybe [PackageDetails]
packageDetailsList :: Prelude.Maybe [PackageDetails],
    -- | The response's http status code.
    DescribePackagesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribePackagesResponse -> DescribePackagesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribePackagesResponse -> DescribePackagesResponse -> Bool
$c/= :: DescribePackagesResponse -> DescribePackagesResponse -> Bool
== :: DescribePackagesResponse -> DescribePackagesResponse -> Bool
$c== :: DescribePackagesResponse -> DescribePackagesResponse -> Bool
Prelude.Eq, ReadPrec [DescribePackagesResponse]
ReadPrec DescribePackagesResponse
Int -> ReadS DescribePackagesResponse
ReadS [DescribePackagesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribePackagesResponse]
$creadListPrec :: ReadPrec [DescribePackagesResponse]
readPrec :: ReadPrec DescribePackagesResponse
$creadPrec :: ReadPrec DescribePackagesResponse
readList :: ReadS [DescribePackagesResponse]
$creadList :: ReadS [DescribePackagesResponse]
readsPrec :: Int -> ReadS DescribePackagesResponse
$creadsPrec :: Int -> ReadS DescribePackagesResponse
Prelude.Read, Int -> DescribePackagesResponse -> ShowS
[DescribePackagesResponse] -> ShowS
DescribePackagesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribePackagesResponse] -> ShowS
$cshowList :: [DescribePackagesResponse] -> ShowS
show :: DescribePackagesResponse -> String
$cshow :: DescribePackagesResponse -> String
showsPrec :: Int -> DescribePackagesResponse -> ShowS
$cshowsPrec :: Int -> DescribePackagesResponse -> ShowS
Prelude.Show, forall x.
Rep DescribePackagesResponse x -> DescribePackagesResponse
forall x.
DescribePackagesResponse -> Rep DescribePackagesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribePackagesResponse x -> DescribePackagesResponse
$cfrom :: forall x.
DescribePackagesResponse -> Rep DescribePackagesResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribePackagesResponse' 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:
--
-- 'nextToken', 'describePackagesResponse_nextToken' - Undocumented member.
--
-- 'packageDetailsList', 'describePackagesResponse_packageDetailsList' - List of @PackageDetails@ objects.
--
-- 'httpStatus', 'describePackagesResponse_httpStatus' - The response's http status code.
newDescribePackagesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribePackagesResponse
newDescribePackagesResponse :: Int -> DescribePackagesResponse
newDescribePackagesResponse Int
pHttpStatus_ =
  DescribePackagesResponse'
    { $sel:nextToken:DescribePackagesResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:packageDetailsList:DescribePackagesResponse' :: Maybe [PackageDetails]
packageDetailsList = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribePackagesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Undocumented member.
describePackagesResponse_nextToken :: Lens.Lens' DescribePackagesResponse (Prelude.Maybe Prelude.Text)
describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (Maybe Text)
describePackagesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePackagesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribePackagesResponse' :: DescribePackagesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribePackagesResponse
s@DescribePackagesResponse' {} Maybe Text
a -> DescribePackagesResponse
s {$sel:nextToken:DescribePackagesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribePackagesResponse)

-- | List of @PackageDetails@ objects.
describePackagesResponse_packageDetailsList :: Lens.Lens' DescribePackagesResponse (Prelude.Maybe [PackageDetails])
describePackagesResponse_packageDetailsList :: Lens' DescribePackagesResponse (Maybe [PackageDetails])
describePackagesResponse_packageDetailsList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePackagesResponse' {Maybe [PackageDetails]
packageDetailsList :: Maybe [PackageDetails]
$sel:packageDetailsList:DescribePackagesResponse' :: DescribePackagesResponse -> Maybe [PackageDetails]
packageDetailsList} -> Maybe [PackageDetails]
packageDetailsList) (\s :: DescribePackagesResponse
s@DescribePackagesResponse' {} Maybe [PackageDetails]
a -> DescribePackagesResponse
s {$sel:packageDetailsList:DescribePackagesResponse' :: Maybe [PackageDetails]
packageDetailsList = Maybe [PackageDetails]
a} :: DescribePackagesResponse) 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 response's http status code.
describePackagesResponse_httpStatus :: Lens.Lens' DescribePackagesResponse Prelude.Int
describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int
describePackagesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePackagesResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribePackagesResponse' :: DescribePackagesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribePackagesResponse
s@DescribePackagesResponse' {} Int
a -> DescribePackagesResponse
s {$sel:httpStatus:DescribePackagesResponse' :: Int
httpStatus = Int
a} :: DescribePackagesResponse)

instance Prelude.NFData DescribePackagesResponse where
  rnf :: DescribePackagesResponse -> ()
rnf DescribePackagesResponse' {Int
Maybe [PackageDetails]
Maybe Text
httpStatus :: Int
packageDetailsList :: Maybe [PackageDetails]
nextToken :: Maybe Text
$sel:httpStatus:DescribePackagesResponse' :: DescribePackagesResponse -> Int
$sel:packageDetailsList:DescribePackagesResponse' :: DescribePackagesResponse -> Maybe [PackageDetails]
$sel:nextToken:DescribePackagesResponse' :: DescribePackagesResponse -> Maybe Text
..} =
    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 Maybe [PackageDetails]
packageDetailsList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus