{-# 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.ListVersions
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists all versions of OpenSearch and Elasticsearch that Amazon
-- OpenSearch Service supports.
module Amazonka.OpenSearch.ListVersions
  ( -- * Creating a Request
    ListVersions (..),
    newListVersions,

    -- * Request Lenses
    listVersions_maxResults,
    listVersions_nextToken,

    -- * Destructuring the Response
    ListVersionsResponse (..),
    newListVersionsResponse,

    -- * Response Lenses
    listVersionsResponse_nextToken,
    listVersionsResponse_versions,
    listVersionsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
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 the @ListVersions@ operation.
--
-- /See:/ 'newListVersions' smart constructor.
data ListVersions = ListVersions'
  { -- | An optional parameter that specifies the maximum number of results to
    -- return. You can use @nextToken@ to get the next page of results.
    ListVersions -> Maybe Int
maxResults :: Prelude.Maybe Prelude.Int,
    -- | If your initial @ListVersions@ operation returns a @nextToken@, you can
    -- include the returned @nextToken@ in subsequent @ListVersions@
    -- operations, which returns results in the next page.
    ListVersions -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListVersions -> ListVersions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListVersions -> ListVersions -> Bool
$c/= :: ListVersions -> ListVersions -> Bool
== :: ListVersions -> ListVersions -> Bool
$c== :: ListVersions -> ListVersions -> Bool
Prelude.Eq, ReadPrec [ListVersions]
ReadPrec ListVersions
Int -> ReadS ListVersions
ReadS [ListVersions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListVersions]
$creadListPrec :: ReadPrec [ListVersions]
readPrec :: ReadPrec ListVersions
$creadPrec :: ReadPrec ListVersions
readList :: ReadS [ListVersions]
$creadList :: ReadS [ListVersions]
readsPrec :: Int -> ReadS ListVersions
$creadsPrec :: Int -> ReadS ListVersions
Prelude.Read, Int -> ListVersions -> ShowS
[ListVersions] -> ShowS
ListVersions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListVersions] -> ShowS
$cshowList :: [ListVersions] -> ShowS
show :: ListVersions -> String
$cshow :: ListVersions -> String
showsPrec :: Int -> ListVersions -> ShowS
$cshowsPrec :: Int -> ListVersions -> ShowS
Prelude.Show, forall x. Rep ListVersions x -> ListVersions
forall x. ListVersions -> Rep ListVersions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListVersions x -> ListVersions
$cfrom :: forall x. ListVersions -> Rep ListVersions x
Prelude.Generic)

-- |
-- Create a value of 'ListVersions' 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:
--
-- 'maxResults', 'listVersions_maxResults' - An optional parameter that specifies the maximum number of results to
-- return. You can use @nextToken@ to get the next page of results.
--
-- 'nextToken', 'listVersions_nextToken' - If your initial @ListVersions@ operation returns a @nextToken@, you can
-- include the returned @nextToken@ in subsequent @ListVersions@
-- operations, which returns results in the next page.
newListVersions ::
  ListVersions
newListVersions :: ListVersions
newListVersions =
  ListVersions'
    { $sel:maxResults:ListVersions' :: Maybe Int
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListVersions' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | An optional parameter that specifies the maximum number of results to
-- return. You can use @nextToken@ to get the next page of results.
listVersions_maxResults :: Lens.Lens' ListVersions (Prelude.Maybe Prelude.Int)
listVersions_maxResults :: Lens' ListVersions (Maybe Int)
listVersions_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListVersions' {Maybe Int
maxResults :: Maybe Int
$sel:maxResults:ListVersions' :: ListVersions -> Maybe Int
maxResults} -> Maybe Int
maxResults) (\s :: ListVersions
s@ListVersions' {} Maybe Int
a -> ListVersions
s {$sel:maxResults:ListVersions' :: Maybe Int
maxResults = Maybe Int
a} :: ListVersions)

-- | If your initial @ListVersions@ operation returns a @nextToken@, you can
-- include the returned @nextToken@ in subsequent @ListVersions@
-- operations, which returns results in the next page.
listVersions_nextToken :: Lens.Lens' ListVersions (Prelude.Maybe Prelude.Text)
listVersions_nextToken :: Lens' ListVersions (Maybe Text)
listVersions_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListVersions' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListVersions' :: ListVersions -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListVersions
s@ListVersions' {} Maybe Text
a -> ListVersions
s {$sel:nextToken:ListVersions' :: Maybe Text
nextToken = Maybe Text
a} :: ListVersions)

instance Core.AWSRequest ListVersions where
  type AWSResponse ListVersions = ListVersionsResponse
  request :: (Service -> Service) -> ListVersions -> Request ListVersions
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListVersions
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListVersions)))
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 [Text] -> Int -> ListVersionsResponse
ListVersionsResponse'
            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
"Versions" 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 ListVersions where
  hashWithSalt :: Int -> ListVersions -> Int
hashWithSalt Int
_salt ListVersions' {Maybe Int
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
$sel:nextToken:ListVersions' :: ListVersions -> Maybe Text
$sel:maxResults:ListVersions' :: ListVersions -> Maybe Int
..} =
    Int
_salt
      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 ListVersions where
  rnf :: ListVersions -> ()
rnf ListVersions' {Maybe Int
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
$sel:nextToken:ListVersions' :: ListVersions -> Maybe Text
$sel:maxResults:ListVersions' :: ListVersions -> Maybe Int
..} =
    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 ListVersions where
  toHeaders :: ListVersions -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToPath ListVersions where
  toPath :: ListVersions -> ByteString
toPath =
    forall a b. a -> b -> a
Prelude.const ByteString
"/2021-01-01/opensearch/versions"

instance Data.ToQuery ListVersions where
  toQuery :: ListVersions -> QueryString
toQuery ListVersions' {Maybe Int
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
$sel:nextToken:ListVersions' :: ListVersions -> Maybe Text
$sel:maxResults:ListVersions' :: ListVersions -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"maxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Int
maxResults,
        ByteString
"nextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | Container for the parameters for response received from the
-- @ListVersions@ operation.
--
-- /See:/ 'newListVersionsResponse' smart constructor.
data ListVersionsResponse = ListVersionsResponse'
  { -- | When @nextToken@ is returned, there are more results available. The
    -- value of @nextToken@ is a unique pagination token for each page. Make
    -- the call again using the returned token to retrieve the next page.
    ListVersionsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A list of all versions of OpenSearch and Elasticsearch that Amazon
    -- OpenSearch Service supports.
    ListVersionsResponse -> Maybe [Text]
versions :: Prelude.Maybe [Prelude.Text],
    -- | The response's http status code.
    ListVersionsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListVersionsResponse -> ListVersionsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListVersionsResponse -> ListVersionsResponse -> Bool
$c/= :: ListVersionsResponse -> ListVersionsResponse -> Bool
== :: ListVersionsResponse -> ListVersionsResponse -> Bool
$c== :: ListVersionsResponse -> ListVersionsResponse -> Bool
Prelude.Eq, ReadPrec [ListVersionsResponse]
ReadPrec ListVersionsResponse
Int -> ReadS ListVersionsResponse
ReadS [ListVersionsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListVersionsResponse]
$creadListPrec :: ReadPrec [ListVersionsResponse]
readPrec :: ReadPrec ListVersionsResponse
$creadPrec :: ReadPrec ListVersionsResponse
readList :: ReadS [ListVersionsResponse]
$creadList :: ReadS [ListVersionsResponse]
readsPrec :: Int -> ReadS ListVersionsResponse
$creadsPrec :: Int -> ReadS ListVersionsResponse
Prelude.Read, Int -> ListVersionsResponse -> ShowS
[ListVersionsResponse] -> ShowS
ListVersionsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListVersionsResponse] -> ShowS
$cshowList :: [ListVersionsResponse] -> ShowS
show :: ListVersionsResponse -> String
$cshow :: ListVersionsResponse -> String
showsPrec :: Int -> ListVersionsResponse -> ShowS
$cshowsPrec :: Int -> ListVersionsResponse -> ShowS
Prelude.Show, forall x. Rep ListVersionsResponse x -> ListVersionsResponse
forall x. ListVersionsResponse -> Rep ListVersionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListVersionsResponse x -> ListVersionsResponse
$cfrom :: forall x. ListVersionsResponse -> Rep ListVersionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListVersionsResponse' 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', 'listVersionsResponse_nextToken' - When @nextToken@ is returned, there are more results available. The
-- value of @nextToken@ is a unique pagination token for each page. Make
-- the call again using the returned token to retrieve the next page.
--
-- 'versions', 'listVersionsResponse_versions' - A list of all versions of OpenSearch and Elasticsearch that Amazon
-- OpenSearch Service supports.
--
-- 'httpStatus', 'listVersionsResponse_httpStatus' - The response's http status code.
newListVersionsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListVersionsResponse
newListVersionsResponse :: Int -> ListVersionsResponse
newListVersionsResponse Int
pHttpStatus_ =
  ListVersionsResponse'
    { $sel:nextToken:ListVersionsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:versions:ListVersionsResponse' :: Maybe [Text]
versions = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListVersionsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | When @nextToken@ is returned, there are more results available. The
-- value of @nextToken@ is a unique pagination token for each page. Make
-- the call again using the returned token to retrieve the next page.
listVersionsResponse_nextToken :: Lens.Lens' ListVersionsResponse (Prelude.Maybe Prelude.Text)
listVersionsResponse_nextToken :: Lens' ListVersionsResponse (Maybe Text)
listVersionsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListVersionsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListVersionsResponse' :: ListVersionsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListVersionsResponse
s@ListVersionsResponse' {} Maybe Text
a -> ListVersionsResponse
s {$sel:nextToken:ListVersionsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListVersionsResponse)

-- | A list of all versions of OpenSearch and Elasticsearch that Amazon
-- OpenSearch Service supports.
listVersionsResponse_versions :: Lens.Lens' ListVersionsResponse (Prelude.Maybe [Prelude.Text])
listVersionsResponse_versions :: Lens' ListVersionsResponse (Maybe [Text])
listVersionsResponse_versions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListVersionsResponse' {Maybe [Text]
versions :: Maybe [Text]
$sel:versions:ListVersionsResponse' :: ListVersionsResponse -> Maybe [Text]
versions} -> Maybe [Text]
versions) (\s :: ListVersionsResponse
s@ListVersionsResponse' {} Maybe [Text]
a -> ListVersionsResponse
s {$sel:versions:ListVersionsResponse' :: Maybe [Text]
versions = Maybe [Text]
a} :: ListVersionsResponse) 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.
listVersionsResponse_httpStatus :: Lens.Lens' ListVersionsResponse Prelude.Int
listVersionsResponse_httpStatus :: Lens' ListVersionsResponse Int
listVersionsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListVersionsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListVersionsResponse' :: ListVersionsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListVersionsResponse
s@ListVersionsResponse' {} Int
a -> ListVersionsResponse
s {$sel:httpStatus:ListVersionsResponse' :: Int
httpStatus = Int
a} :: ListVersionsResponse)

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