{-# 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.OpenSearch.GetCompatibleVersions
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of upgrade-compatible versions of
-- OpenSearch\/Elasticsearch. You can optionally pass a @ DomainName @ to
-- get all upgrade-compatible versions of OpenSearch\/Elasticsearch for
-- that specific domain.
module Amazonka.OpenSearch.GetCompatibleVersions
  ( -- * Creating a Request
    GetCompatibleVersions (..),
    newGetCompatibleVersions,

    -- * Request Lenses
    getCompatibleVersions_domainName,

    -- * Destructuring the Response
    GetCompatibleVersionsResponse (..),
    newGetCompatibleVersionsResponse,

    -- * Response Lenses
    getCompatibleVersionsResponse_compatibleVersions,
    getCompatibleVersionsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import Amazonka.OpenSearch.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Container for the request parameters to @ GetCompatibleVersions @
-- operation.
--
-- /See:/ 'newGetCompatibleVersions' smart constructor.
data GetCompatibleVersions = GetCompatibleVersions'
  { GetCompatibleVersions -> Maybe Text
domainName :: Prelude.Maybe Prelude.Text
  }
  deriving (GetCompatibleVersions -> GetCompatibleVersions -> Bool
(GetCompatibleVersions -> GetCompatibleVersions -> Bool)
-> (GetCompatibleVersions -> GetCompatibleVersions -> Bool)
-> Eq GetCompatibleVersions
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetCompatibleVersions -> GetCompatibleVersions -> Bool
$c/= :: GetCompatibleVersions -> GetCompatibleVersions -> Bool
== :: GetCompatibleVersions -> GetCompatibleVersions -> Bool
$c== :: GetCompatibleVersions -> GetCompatibleVersions -> Bool
Prelude.Eq, ReadPrec [GetCompatibleVersions]
ReadPrec GetCompatibleVersions
Int -> ReadS GetCompatibleVersions
ReadS [GetCompatibleVersions]
(Int -> ReadS GetCompatibleVersions)
-> ReadS [GetCompatibleVersions]
-> ReadPrec GetCompatibleVersions
-> ReadPrec [GetCompatibleVersions]
-> Read GetCompatibleVersions
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetCompatibleVersions]
$creadListPrec :: ReadPrec [GetCompatibleVersions]
readPrec :: ReadPrec GetCompatibleVersions
$creadPrec :: ReadPrec GetCompatibleVersions
readList :: ReadS [GetCompatibleVersions]
$creadList :: ReadS [GetCompatibleVersions]
readsPrec :: Int -> ReadS GetCompatibleVersions
$creadsPrec :: Int -> ReadS GetCompatibleVersions
Prelude.Read, Int -> GetCompatibleVersions -> ShowS
[GetCompatibleVersions] -> ShowS
GetCompatibleVersions -> String
(Int -> GetCompatibleVersions -> ShowS)
-> (GetCompatibleVersions -> String)
-> ([GetCompatibleVersions] -> ShowS)
-> Show GetCompatibleVersions
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetCompatibleVersions] -> ShowS
$cshowList :: [GetCompatibleVersions] -> ShowS
show :: GetCompatibleVersions -> String
$cshow :: GetCompatibleVersions -> String
showsPrec :: Int -> GetCompatibleVersions -> ShowS
$cshowsPrec :: Int -> GetCompatibleVersions -> ShowS
Prelude.Show, (forall x. GetCompatibleVersions -> Rep GetCompatibleVersions x)
-> (forall x. Rep GetCompatibleVersions x -> GetCompatibleVersions)
-> Generic GetCompatibleVersions
forall x. Rep GetCompatibleVersions x -> GetCompatibleVersions
forall x. GetCompatibleVersions -> Rep GetCompatibleVersions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetCompatibleVersions x -> GetCompatibleVersions
$cfrom :: forall x. GetCompatibleVersions -> Rep GetCompatibleVersions x
Prelude.Generic)

-- |
-- Create a value of 'GetCompatibleVersions' 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:
--
-- 'domainName', 'getCompatibleVersions_domainName' - Undocumented member.
newGetCompatibleVersions ::
  GetCompatibleVersions
newGetCompatibleVersions :: GetCompatibleVersions
newGetCompatibleVersions =
  GetCompatibleVersions' :: Maybe Text -> GetCompatibleVersions
GetCompatibleVersions'
    { $sel:domainName:GetCompatibleVersions' :: Maybe Text
domainName =
        Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | Undocumented member.
getCompatibleVersions_domainName :: Lens.Lens' GetCompatibleVersions (Prelude.Maybe Prelude.Text)
getCompatibleVersions_domainName :: (Maybe Text -> f (Maybe Text))
-> GetCompatibleVersions -> f GetCompatibleVersions
getCompatibleVersions_domainName = (GetCompatibleVersions -> Maybe Text)
-> (GetCompatibleVersions -> Maybe Text -> GetCompatibleVersions)
-> Lens
     GetCompatibleVersions
     GetCompatibleVersions
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCompatibleVersions' {Maybe Text
domainName :: Maybe Text
$sel:domainName:GetCompatibleVersions' :: GetCompatibleVersions -> Maybe Text
domainName} -> Maybe Text
domainName) (\s :: GetCompatibleVersions
s@GetCompatibleVersions' {} Maybe Text
a -> GetCompatibleVersions
s {$sel:domainName:GetCompatibleVersions' :: Maybe Text
domainName = Maybe Text
a} :: GetCompatibleVersions)

instance Core.AWSRequest GetCompatibleVersions where
  type
    AWSResponse GetCompatibleVersions =
      GetCompatibleVersionsResponse
  request :: GetCompatibleVersions -> Request GetCompatibleVersions
request = Service -> GetCompatibleVersions -> Request GetCompatibleVersions
forall a. ToRequest a => Service -> a -> Request a
Request.get Service
defaultService
  response :: Logger
-> Service
-> Proxy GetCompatibleVersions
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetCompatibleVersions)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse GetCompatibleVersions))
-> Logger
-> Service
-> Proxy GetCompatibleVersions
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetCompatibleVersions)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [CompatibleVersionsMap]
-> Int -> GetCompatibleVersionsResponse
GetCompatibleVersionsResponse'
            (Maybe [CompatibleVersionsMap]
 -> Int -> GetCompatibleVersionsResponse)
-> Either String (Maybe [CompatibleVersionsMap])
-> Either String (Int -> GetCompatibleVersionsResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( Object
x Object
-> Text -> Either String (Maybe (Maybe [CompatibleVersionsMap]))
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"CompatibleVersions"
                            Either String (Maybe (Maybe [CompatibleVersionsMap]))
-> Maybe [CompatibleVersionsMap]
-> Either String (Maybe [CompatibleVersionsMap])
forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ Maybe [CompatibleVersionsMap]
forall a. Monoid a => a
Prelude.mempty
                        )
            Either String (Int -> GetCompatibleVersionsResponse)
-> Either String Int -> Either String GetCompatibleVersionsResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable GetCompatibleVersions

instance Prelude.NFData GetCompatibleVersions

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

instance Core.ToPath GetCompatibleVersions where
  toPath :: GetCompatibleVersions -> ByteString
toPath =
    ByteString -> GetCompatibleVersions -> ByteString
forall a b. a -> b -> a
Prelude.const
      ByteString
"/2021-01-01/opensearch/compatibleVersions"

instance Core.ToQuery GetCompatibleVersions where
  toQuery :: GetCompatibleVersions -> QueryString
toQuery GetCompatibleVersions' {Maybe Text
domainName :: Maybe Text
$sel:domainName:GetCompatibleVersions' :: GetCompatibleVersions -> Maybe Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat [ByteString
"domainName" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
domainName]

-- | Container for the response returned by the @ GetCompatibleVersions @
-- operation.
--
-- /See:/ 'newGetCompatibleVersionsResponse' smart constructor.
data GetCompatibleVersionsResponse = GetCompatibleVersionsResponse'
  { -- | A map of compatible OpenSearch versions returned as part of the
    -- @ GetCompatibleVersions @ operation.
    GetCompatibleVersionsResponse -> Maybe [CompatibleVersionsMap]
compatibleVersions :: Prelude.Maybe [CompatibleVersionsMap],
    -- | The response's http status code.
    GetCompatibleVersionsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetCompatibleVersionsResponse
-> GetCompatibleVersionsResponse -> Bool
(GetCompatibleVersionsResponse
 -> GetCompatibleVersionsResponse -> Bool)
-> (GetCompatibleVersionsResponse
    -> GetCompatibleVersionsResponse -> Bool)
-> Eq GetCompatibleVersionsResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetCompatibleVersionsResponse
-> GetCompatibleVersionsResponse -> Bool
$c/= :: GetCompatibleVersionsResponse
-> GetCompatibleVersionsResponse -> Bool
== :: GetCompatibleVersionsResponse
-> GetCompatibleVersionsResponse -> Bool
$c== :: GetCompatibleVersionsResponse
-> GetCompatibleVersionsResponse -> Bool
Prelude.Eq, ReadPrec [GetCompatibleVersionsResponse]
ReadPrec GetCompatibleVersionsResponse
Int -> ReadS GetCompatibleVersionsResponse
ReadS [GetCompatibleVersionsResponse]
(Int -> ReadS GetCompatibleVersionsResponse)
-> ReadS [GetCompatibleVersionsResponse]
-> ReadPrec GetCompatibleVersionsResponse
-> ReadPrec [GetCompatibleVersionsResponse]
-> Read GetCompatibleVersionsResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetCompatibleVersionsResponse]
$creadListPrec :: ReadPrec [GetCompatibleVersionsResponse]
readPrec :: ReadPrec GetCompatibleVersionsResponse
$creadPrec :: ReadPrec GetCompatibleVersionsResponse
readList :: ReadS [GetCompatibleVersionsResponse]
$creadList :: ReadS [GetCompatibleVersionsResponse]
readsPrec :: Int -> ReadS GetCompatibleVersionsResponse
$creadsPrec :: Int -> ReadS GetCompatibleVersionsResponse
Prelude.Read, Int -> GetCompatibleVersionsResponse -> ShowS
[GetCompatibleVersionsResponse] -> ShowS
GetCompatibleVersionsResponse -> String
(Int -> GetCompatibleVersionsResponse -> ShowS)
-> (GetCompatibleVersionsResponse -> String)
-> ([GetCompatibleVersionsResponse] -> ShowS)
-> Show GetCompatibleVersionsResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetCompatibleVersionsResponse] -> ShowS
$cshowList :: [GetCompatibleVersionsResponse] -> ShowS
show :: GetCompatibleVersionsResponse -> String
$cshow :: GetCompatibleVersionsResponse -> String
showsPrec :: Int -> GetCompatibleVersionsResponse -> ShowS
$cshowsPrec :: Int -> GetCompatibleVersionsResponse -> ShowS
Prelude.Show, (forall x.
 GetCompatibleVersionsResponse
 -> Rep GetCompatibleVersionsResponse x)
-> (forall x.
    Rep GetCompatibleVersionsResponse x
    -> GetCompatibleVersionsResponse)
-> Generic GetCompatibleVersionsResponse
forall x.
Rep GetCompatibleVersionsResponse x
-> GetCompatibleVersionsResponse
forall x.
GetCompatibleVersionsResponse
-> Rep GetCompatibleVersionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetCompatibleVersionsResponse x
-> GetCompatibleVersionsResponse
$cfrom :: forall x.
GetCompatibleVersionsResponse
-> Rep GetCompatibleVersionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetCompatibleVersionsResponse' 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:
--
-- 'compatibleVersions', 'getCompatibleVersionsResponse_compatibleVersions' - A map of compatible OpenSearch versions returned as part of the
-- @ GetCompatibleVersions @ operation.
--
-- 'httpStatus', 'getCompatibleVersionsResponse_httpStatus' - The response's http status code.
newGetCompatibleVersionsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetCompatibleVersionsResponse
newGetCompatibleVersionsResponse :: Int -> GetCompatibleVersionsResponse
newGetCompatibleVersionsResponse Int
pHttpStatus_ =
  GetCompatibleVersionsResponse' :: Maybe [CompatibleVersionsMap]
-> Int -> GetCompatibleVersionsResponse
GetCompatibleVersionsResponse'
    { $sel:compatibleVersions:GetCompatibleVersionsResponse' :: Maybe [CompatibleVersionsMap]
compatibleVersions =
        Maybe [CompatibleVersionsMap]
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetCompatibleVersionsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A map of compatible OpenSearch versions returned as part of the
-- @ GetCompatibleVersions @ operation.
getCompatibleVersionsResponse_compatibleVersions :: Lens.Lens' GetCompatibleVersionsResponse (Prelude.Maybe [CompatibleVersionsMap])
getCompatibleVersionsResponse_compatibleVersions :: (Maybe [CompatibleVersionsMap]
 -> f (Maybe [CompatibleVersionsMap]))
-> GetCompatibleVersionsResponse -> f GetCompatibleVersionsResponse
getCompatibleVersionsResponse_compatibleVersions = (GetCompatibleVersionsResponse -> Maybe [CompatibleVersionsMap])
-> (GetCompatibleVersionsResponse
    -> Maybe [CompatibleVersionsMap] -> GetCompatibleVersionsResponse)
-> Lens
     GetCompatibleVersionsResponse
     GetCompatibleVersionsResponse
     (Maybe [CompatibleVersionsMap])
     (Maybe [CompatibleVersionsMap])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCompatibleVersionsResponse' {Maybe [CompatibleVersionsMap]
compatibleVersions :: Maybe [CompatibleVersionsMap]
$sel:compatibleVersions:GetCompatibleVersionsResponse' :: GetCompatibleVersionsResponse -> Maybe [CompatibleVersionsMap]
compatibleVersions} -> Maybe [CompatibleVersionsMap]
compatibleVersions) (\s :: GetCompatibleVersionsResponse
s@GetCompatibleVersionsResponse' {} Maybe [CompatibleVersionsMap]
a -> GetCompatibleVersionsResponse
s {$sel:compatibleVersions:GetCompatibleVersionsResponse' :: Maybe [CompatibleVersionsMap]
compatibleVersions = Maybe [CompatibleVersionsMap]
a} :: GetCompatibleVersionsResponse) ((Maybe [CompatibleVersionsMap]
  -> f (Maybe [CompatibleVersionsMap]))
 -> GetCompatibleVersionsResponse
 -> f GetCompatibleVersionsResponse)
-> ((Maybe [CompatibleVersionsMap]
     -> f (Maybe [CompatibleVersionsMap]))
    -> Maybe [CompatibleVersionsMap]
    -> f (Maybe [CompatibleVersionsMap]))
-> (Maybe [CompatibleVersionsMap]
    -> f (Maybe [CompatibleVersionsMap]))
-> GetCompatibleVersionsResponse
-> f GetCompatibleVersionsResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso
  [CompatibleVersionsMap]
  [CompatibleVersionsMap]
  [CompatibleVersionsMap]
  [CompatibleVersionsMap]
-> Iso
     (Maybe [CompatibleVersionsMap])
     (Maybe [CompatibleVersionsMap])
     (Maybe [CompatibleVersionsMap])
     (Maybe [CompatibleVersionsMap])
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 AnIso
  [CompatibleVersionsMap]
  [CompatibleVersionsMap]
  [CompatibleVersionsMap]
  [CompatibleVersionsMap]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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

instance Prelude.NFData GetCompatibleVersionsResponse