{-# 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.Athena.ListEngineVersions
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of engine versions that are available to choose from,
-- including the Auto option.
module Amazonka.Athena.ListEngineVersions
  ( -- * Creating a Request
    ListEngineVersions (..),
    newListEngineVersions,

    -- * Request Lenses
    listEngineVersions_maxResults,
    listEngineVersions_nextToken,

    -- * Destructuring the Response
    ListEngineVersionsResponse (..),
    newListEngineVersionsResponse,

    -- * Response Lenses
    listEngineVersionsResponse_engineVersions,
    listEngineVersionsResponse_nextToken,
    listEngineVersionsResponse_httpStatus,
  )
where

import Amazonka.Athena.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:/ 'newListEngineVersions' smart constructor.
data ListEngineVersions = ListEngineVersions'
  { -- | The maximum number of engine versions to return in this request.
    ListEngineVersions -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | A token generated by the Athena service that specifies where to continue
    -- pagination if a previous request was truncated. To obtain the next set
    -- of pages, pass in the @NextToken@ from the response object of the
    -- previous page call.
    ListEngineVersions -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListEngineVersions -> ListEngineVersions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListEngineVersions -> ListEngineVersions -> Bool
$c/= :: ListEngineVersions -> ListEngineVersions -> Bool
== :: ListEngineVersions -> ListEngineVersions -> Bool
$c== :: ListEngineVersions -> ListEngineVersions -> Bool
Prelude.Eq, ReadPrec [ListEngineVersions]
ReadPrec ListEngineVersions
Int -> ReadS ListEngineVersions
ReadS [ListEngineVersions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListEngineVersions]
$creadListPrec :: ReadPrec [ListEngineVersions]
readPrec :: ReadPrec ListEngineVersions
$creadPrec :: ReadPrec ListEngineVersions
readList :: ReadS [ListEngineVersions]
$creadList :: ReadS [ListEngineVersions]
readsPrec :: Int -> ReadS ListEngineVersions
$creadsPrec :: Int -> ReadS ListEngineVersions
Prelude.Read, Int -> ListEngineVersions -> ShowS
[ListEngineVersions] -> ShowS
ListEngineVersions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListEngineVersions] -> ShowS
$cshowList :: [ListEngineVersions] -> ShowS
show :: ListEngineVersions -> String
$cshow :: ListEngineVersions -> String
showsPrec :: Int -> ListEngineVersions -> ShowS
$cshowsPrec :: Int -> ListEngineVersions -> ShowS
Prelude.Show, forall x. Rep ListEngineVersions x -> ListEngineVersions
forall x. ListEngineVersions -> Rep ListEngineVersions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListEngineVersions x -> ListEngineVersions
$cfrom :: forall x. ListEngineVersions -> Rep ListEngineVersions x
Prelude.Generic)

-- |
-- Create a value of 'ListEngineVersions' 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', 'listEngineVersions_maxResults' - The maximum number of engine versions to return in this request.
--
-- 'nextToken', 'listEngineVersions_nextToken' - A token generated by the Athena service that specifies where to continue
-- pagination if a previous request was truncated. To obtain the next set
-- of pages, pass in the @NextToken@ from the response object of the
-- previous page call.
newListEngineVersions ::
  ListEngineVersions
newListEngineVersions :: ListEngineVersions
newListEngineVersions =
  ListEngineVersions'
    { $sel:maxResults:ListEngineVersions' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListEngineVersions' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of engine versions to return in this request.
listEngineVersions_maxResults :: Lens.Lens' ListEngineVersions (Prelude.Maybe Prelude.Natural)
listEngineVersions_maxResults :: Lens' ListEngineVersions (Maybe Natural)
listEngineVersions_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListEngineVersions' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListEngineVersions' :: ListEngineVersions -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListEngineVersions
s@ListEngineVersions' {} Maybe Natural
a -> ListEngineVersions
s {$sel:maxResults:ListEngineVersions' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListEngineVersions)

-- | A token generated by the Athena service that specifies where to continue
-- pagination if a previous request was truncated. To obtain the next set
-- of pages, pass in the @NextToken@ from the response object of the
-- previous page call.
listEngineVersions_nextToken :: Lens.Lens' ListEngineVersions (Prelude.Maybe Prelude.Text)
listEngineVersions_nextToken :: Lens' ListEngineVersions (Maybe Text)
listEngineVersions_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListEngineVersions' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListEngineVersions' :: ListEngineVersions -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListEngineVersions
s@ListEngineVersions' {} Maybe Text
a -> ListEngineVersions
s {$sel:nextToken:ListEngineVersions' :: Maybe Text
nextToken = Maybe Text
a} :: ListEngineVersions)

instance Core.AWSRequest ListEngineVersions where
  type
    AWSResponse ListEngineVersions =
      ListEngineVersionsResponse
  request :: (Service -> Service)
-> ListEngineVersions -> Request ListEngineVersions
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 ListEngineVersions
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ListEngineVersions)))
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 [EngineVersion]
-> Maybe Text -> Int -> ListEngineVersionsResponse
ListEngineVersionsResponse'
            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
"EngineVersions" 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 ListEngineVersions where
  hashWithSalt :: Int -> ListEngineVersions -> Int
hashWithSalt Int
_salt ListEngineVersions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListEngineVersions' :: ListEngineVersions -> Maybe Text
$sel:maxResults:ListEngineVersions' :: ListEngineVersions -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData ListEngineVersions where
  rnf :: ListEngineVersions -> ()
rnf ListEngineVersions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListEngineVersions' :: ListEngineVersions -> Maybe Text
$sel:maxResults:ListEngineVersions' :: ListEngineVersions -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders ListEngineVersions where
  toHeaders :: ListEngineVersions -> 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
"AmazonAthena.ListEngineVersions" ::
                          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 ListEngineVersions where
  toJSON :: ListEngineVersions -> Value
toJSON ListEngineVersions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListEngineVersions' :: ListEngineVersions -> Maybe Text
$sel:maxResults:ListEngineVersions' :: ListEngineVersions -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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 Natural
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 ListEngineVersions where
  toPath :: ListEngineVersions -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | /See:/ 'newListEngineVersionsResponse' smart constructor.
data ListEngineVersionsResponse = ListEngineVersionsResponse'
  { -- | A list of engine versions that are available to choose from.
    ListEngineVersionsResponse -> Maybe [EngineVersion]
engineVersions :: Prelude.Maybe [EngineVersion],
    -- | A token generated by the Athena service that specifies where to continue
    -- pagination if a previous request was truncated. To obtain the next set
    -- of pages, pass in the @NextToken@ from the response object of the
    -- previous page call.
    ListEngineVersionsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListEngineVersionsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListEngineVersionsResponse -> ListEngineVersionsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListEngineVersionsResponse -> ListEngineVersionsResponse -> Bool
$c/= :: ListEngineVersionsResponse -> ListEngineVersionsResponse -> Bool
== :: ListEngineVersionsResponse -> ListEngineVersionsResponse -> Bool
$c== :: ListEngineVersionsResponse -> ListEngineVersionsResponse -> Bool
Prelude.Eq, ReadPrec [ListEngineVersionsResponse]
ReadPrec ListEngineVersionsResponse
Int -> ReadS ListEngineVersionsResponse
ReadS [ListEngineVersionsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListEngineVersionsResponse]
$creadListPrec :: ReadPrec [ListEngineVersionsResponse]
readPrec :: ReadPrec ListEngineVersionsResponse
$creadPrec :: ReadPrec ListEngineVersionsResponse
readList :: ReadS [ListEngineVersionsResponse]
$creadList :: ReadS [ListEngineVersionsResponse]
readsPrec :: Int -> ReadS ListEngineVersionsResponse
$creadsPrec :: Int -> ReadS ListEngineVersionsResponse
Prelude.Read, Int -> ListEngineVersionsResponse -> ShowS
[ListEngineVersionsResponse] -> ShowS
ListEngineVersionsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListEngineVersionsResponse] -> ShowS
$cshowList :: [ListEngineVersionsResponse] -> ShowS
show :: ListEngineVersionsResponse -> String
$cshow :: ListEngineVersionsResponse -> String
showsPrec :: Int -> ListEngineVersionsResponse -> ShowS
$cshowsPrec :: Int -> ListEngineVersionsResponse -> ShowS
Prelude.Show, forall x.
Rep ListEngineVersionsResponse x -> ListEngineVersionsResponse
forall x.
ListEngineVersionsResponse -> Rep ListEngineVersionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListEngineVersionsResponse x -> ListEngineVersionsResponse
$cfrom :: forall x.
ListEngineVersionsResponse -> Rep ListEngineVersionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListEngineVersionsResponse' 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:
--
-- 'engineVersions', 'listEngineVersionsResponse_engineVersions' - A list of engine versions that are available to choose from.
--
-- 'nextToken', 'listEngineVersionsResponse_nextToken' - A token generated by the Athena service that specifies where to continue
-- pagination if a previous request was truncated. To obtain the next set
-- of pages, pass in the @NextToken@ from the response object of the
-- previous page call.
--
-- 'httpStatus', 'listEngineVersionsResponse_httpStatus' - The response's http status code.
newListEngineVersionsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListEngineVersionsResponse
newListEngineVersionsResponse :: Int -> ListEngineVersionsResponse
newListEngineVersionsResponse Int
pHttpStatus_ =
  ListEngineVersionsResponse'
    { $sel:engineVersions:ListEngineVersionsResponse' :: Maybe [EngineVersion]
engineVersions =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListEngineVersionsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListEngineVersionsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of engine versions that are available to choose from.
listEngineVersionsResponse_engineVersions :: Lens.Lens' ListEngineVersionsResponse (Prelude.Maybe [EngineVersion])
listEngineVersionsResponse_engineVersions :: Lens' ListEngineVersionsResponse (Maybe [EngineVersion])
listEngineVersionsResponse_engineVersions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListEngineVersionsResponse' {Maybe [EngineVersion]
engineVersions :: Maybe [EngineVersion]
$sel:engineVersions:ListEngineVersionsResponse' :: ListEngineVersionsResponse -> Maybe [EngineVersion]
engineVersions} -> Maybe [EngineVersion]
engineVersions) (\s :: ListEngineVersionsResponse
s@ListEngineVersionsResponse' {} Maybe [EngineVersion]
a -> ListEngineVersionsResponse
s {$sel:engineVersions:ListEngineVersionsResponse' :: Maybe [EngineVersion]
engineVersions = Maybe [EngineVersion]
a} :: ListEngineVersionsResponse) 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 generated by the Athena service that specifies where to continue
-- pagination if a previous request was truncated. To obtain the next set
-- of pages, pass in the @NextToken@ from the response object of the
-- previous page call.
listEngineVersionsResponse_nextToken :: Lens.Lens' ListEngineVersionsResponse (Prelude.Maybe Prelude.Text)
listEngineVersionsResponse_nextToken :: Lens' ListEngineVersionsResponse (Maybe Text)
listEngineVersionsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListEngineVersionsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListEngineVersionsResponse' :: ListEngineVersionsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListEngineVersionsResponse
s@ListEngineVersionsResponse' {} Maybe Text
a -> ListEngineVersionsResponse
s {$sel:nextToken:ListEngineVersionsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListEngineVersionsResponse)

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

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