{-# 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.FraudDetector.GetExternalModels
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets the details for one or more Amazon SageMaker models that have been
-- imported into the service. This is a paginated API. If you provide a
-- null @maxResults@, this actions retrieves a maximum of 10 records per
-- page. If you provide a @maxResults@, the value must be between 5 and 10.
-- To get the next page results, provide the pagination token from the
-- @GetExternalModelsResult@ as part of your request. A null pagination
-- token fetches the records from the beginning.
module Amazonka.FraudDetector.GetExternalModels
  ( -- * Creating a Request
    GetExternalModels (..),
    newGetExternalModels,

    -- * Request Lenses
    getExternalModels_maxResults,
    getExternalModels_modelEndpoint,
    getExternalModels_nextToken,

    -- * Destructuring the Response
    GetExternalModelsResponse (..),
    newGetExternalModelsResponse,

    -- * Response Lenses
    getExternalModelsResponse_externalModels,
    getExternalModelsResponse_nextToken,
    getExternalModelsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newGetExternalModels' smart constructor.
data GetExternalModels = GetExternalModels'
  { -- | The maximum number of objects to return for the request.
    GetExternalModels -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The Amazon SageMaker model endpoint.
    GetExternalModels -> Maybe Text
modelEndpoint :: Prelude.Maybe Prelude.Text,
    -- | The next page token for the request.
    GetExternalModels -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (GetExternalModels -> GetExternalModels -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetExternalModels -> GetExternalModels -> Bool
$c/= :: GetExternalModels -> GetExternalModels -> Bool
== :: GetExternalModels -> GetExternalModels -> Bool
$c== :: GetExternalModels -> GetExternalModels -> Bool
Prelude.Eq, ReadPrec [GetExternalModels]
ReadPrec GetExternalModels
Int -> ReadS GetExternalModels
ReadS [GetExternalModels]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetExternalModels]
$creadListPrec :: ReadPrec [GetExternalModels]
readPrec :: ReadPrec GetExternalModels
$creadPrec :: ReadPrec GetExternalModels
readList :: ReadS [GetExternalModels]
$creadList :: ReadS [GetExternalModels]
readsPrec :: Int -> ReadS GetExternalModels
$creadsPrec :: Int -> ReadS GetExternalModels
Prelude.Read, Int -> GetExternalModels -> ShowS
[GetExternalModels] -> ShowS
GetExternalModels -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetExternalModels] -> ShowS
$cshowList :: [GetExternalModels] -> ShowS
show :: GetExternalModels -> String
$cshow :: GetExternalModels -> String
showsPrec :: Int -> GetExternalModels -> ShowS
$cshowsPrec :: Int -> GetExternalModels -> ShowS
Prelude.Show, forall x. Rep GetExternalModels x -> GetExternalModels
forall x. GetExternalModels -> Rep GetExternalModels x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetExternalModels x -> GetExternalModels
$cfrom :: forall x. GetExternalModels -> Rep GetExternalModels x
Prelude.Generic)

-- |
-- Create a value of 'GetExternalModels' 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', 'getExternalModels_maxResults' - The maximum number of objects to return for the request.
--
-- 'modelEndpoint', 'getExternalModels_modelEndpoint' - The Amazon SageMaker model endpoint.
--
-- 'nextToken', 'getExternalModels_nextToken' - The next page token for the request.
newGetExternalModels ::
  GetExternalModels
newGetExternalModels :: GetExternalModels
newGetExternalModels =
  GetExternalModels'
    { $sel:maxResults:GetExternalModels' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:modelEndpoint:GetExternalModels' :: Maybe Text
modelEndpoint = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetExternalModels' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of objects to return for the request.
getExternalModels_maxResults :: Lens.Lens' GetExternalModels (Prelude.Maybe Prelude.Natural)
getExternalModels_maxResults :: Lens' GetExternalModels (Maybe Natural)
getExternalModels_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetExternalModels' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:GetExternalModels' :: GetExternalModels -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: GetExternalModels
s@GetExternalModels' {} Maybe Natural
a -> GetExternalModels
s {$sel:maxResults:GetExternalModels' :: Maybe Natural
maxResults = Maybe Natural
a} :: GetExternalModels)

-- | The Amazon SageMaker model endpoint.
getExternalModels_modelEndpoint :: Lens.Lens' GetExternalModels (Prelude.Maybe Prelude.Text)
getExternalModels_modelEndpoint :: Lens' GetExternalModels (Maybe Text)
getExternalModels_modelEndpoint = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetExternalModels' {Maybe Text
modelEndpoint :: Maybe Text
$sel:modelEndpoint:GetExternalModels' :: GetExternalModels -> Maybe Text
modelEndpoint} -> Maybe Text
modelEndpoint) (\s :: GetExternalModels
s@GetExternalModels' {} Maybe Text
a -> GetExternalModels
s {$sel:modelEndpoint:GetExternalModels' :: Maybe Text
modelEndpoint = Maybe Text
a} :: GetExternalModels)

-- | The next page token for the request.
getExternalModels_nextToken :: Lens.Lens' GetExternalModels (Prelude.Maybe Prelude.Text)
getExternalModels_nextToken :: Lens' GetExternalModels (Maybe Text)
getExternalModels_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetExternalModels' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetExternalModels' :: GetExternalModels -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetExternalModels
s@GetExternalModels' {} Maybe Text
a -> GetExternalModels
s {$sel:nextToken:GetExternalModels' :: Maybe Text
nextToken = Maybe Text
a} :: GetExternalModels)

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

instance Prelude.NFData GetExternalModels where
  rnf :: GetExternalModels -> ()
rnf GetExternalModels' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
modelEndpoint :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:GetExternalModels' :: GetExternalModels -> Maybe Text
$sel:modelEndpoint:GetExternalModels' :: GetExternalModels -> Maybe Text
$sel:maxResults:GetExternalModels' :: GetExternalModels -> 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
modelEndpoint
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders GetExternalModels where
  toHeaders :: GetExternalModels -> 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
"AWSHawksNestServiceFacade.GetExternalModels" ::
                          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 GetExternalModels where
  toJSON :: GetExternalModels -> Value
toJSON GetExternalModels' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
modelEndpoint :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:GetExternalModels' :: GetExternalModels -> Maybe Text
$sel:modelEndpoint:GetExternalModels' :: GetExternalModels -> Maybe Text
$sel:maxResults:GetExternalModels' :: GetExternalModels -> 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
"modelEndpoint" 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
modelEndpoint,
            (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 GetExternalModels where
  toPath :: GetExternalModels -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | /See:/ 'newGetExternalModelsResponse' smart constructor.
data GetExternalModelsResponse = GetExternalModelsResponse'
  { -- | Gets the Amazon SageMaker models.
    GetExternalModelsResponse -> Maybe [ExternalModel]
externalModels :: Prelude.Maybe [ExternalModel],
    -- | The next page token to be used in subsequent requests.
    GetExternalModelsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetExternalModelsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetExternalModelsResponse -> GetExternalModelsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetExternalModelsResponse -> GetExternalModelsResponse -> Bool
$c/= :: GetExternalModelsResponse -> GetExternalModelsResponse -> Bool
== :: GetExternalModelsResponse -> GetExternalModelsResponse -> Bool
$c== :: GetExternalModelsResponse -> GetExternalModelsResponse -> Bool
Prelude.Eq, ReadPrec [GetExternalModelsResponse]
ReadPrec GetExternalModelsResponse
Int -> ReadS GetExternalModelsResponse
ReadS [GetExternalModelsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetExternalModelsResponse]
$creadListPrec :: ReadPrec [GetExternalModelsResponse]
readPrec :: ReadPrec GetExternalModelsResponse
$creadPrec :: ReadPrec GetExternalModelsResponse
readList :: ReadS [GetExternalModelsResponse]
$creadList :: ReadS [GetExternalModelsResponse]
readsPrec :: Int -> ReadS GetExternalModelsResponse
$creadsPrec :: Int -> ReadS GetExternalModelsResponse
Prelude.Read, Int -> GetExternalModelsResponse -> ShowS
[GetExternalModelsResponse] -> ShowS
GetExternalModelsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetExternalModelsResponse] -> ShowS
$cshowList :: [GetExternalModelsResponse] -> ShowS
show :: GetExternalModelsResponse -> String
$cshow :: GetExternalModelsResponse -> String
showsPrec :: Int -> GetExternalModelsResponse -> ShowS
$cshowsPrec :: Int -> GetExternalModelsResponse -> ShowS
Prelude.Show, forall x.
Rep GetExternalModelsResponse x -> GetExternalModelsResponse
forall x.
GetExternalModelsResponse -> Rep GetExternalModelsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetExternalModelsResponse x -> GetExternalModelsResponse
$cfrom :: forall x.
GetExternalModelsResponse -> Rep GetExternalModelsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetExternalModelsResponse' 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:
--
-- 'externalModels', 'getExternalModelsResponse_externalModels' - Gets the Amazon SageMaker models.
--
-- 'nextToken', 'getExternalModelsResponse_nextToken' - The next page token to be used in subsequent requests.
--
-- 'httpStatus', 'getExternalModelsResponse_httpStatus' - The response's http status code.
newGetExternalModelsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetExternalModelsResponse
newGetExternalModelsResponse :: Int -> GetExternalModelsResponse
newGetExternalModelsResponse Int
pHttpStatus_ =
  GetExternalModelsResponse'
    { $sel:externalModels:GetExternalModelsResponse' :: Maybe [ExternalModel]
externalModels =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetExternalModelsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetExternalModelsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Gets the Amazon SageMaker models.
getExternalModelsResponse_externalModels :: Lens.Lens' GetExternalModelsResponse (Prelude.Maybe [ExternalModel])
getExternalModelsResponse_externalModels :: Lens' GetExternalModelsResponse (Maybe [ExternalModel])
getExternalModelsResponse_externalModels = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetExternalModelsResponse' {Maybe [ExternalModel]
externalModels :: Maybe [ExternalModel]
$sel:externalModels:GetExternalModelsResponse' :: GetExternalModelsResponse -> Maybe [ExternalModel]
externalModels} -> Maybe [ExternalModel]
externalModels) (\s :: GetExternalModelsResponse
s@GetExternalModelsResponse' {} Maybe [ExternalModel]
a -> GetExternalModelsResponse
s {$sel:externalModels:GetExternalModelsResponse' :: Maybe [ExternalModel]
externalModels = Maybe [ExternalModel]
a} :: GetExternalModelsResponse) 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 next page token to be used in subsequent requests.
getExternalModelsResponse_nextToken :: Lens.Lens' GetExternalModelsResponse (Prelude.Maybe Prelude.Text)
getExternalModelsResponse_nextToken :: Lens' GetExternalModelsResponse (Maybe Text)
getExternalModelsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetExternalModelsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetExternalModelsResponse' :: GetExternalModelsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetExternalModelsResponse
s@GetExternalModelsResponse' {} Maybe Text
a -> GetExternalModelsResponse
s {$sel:nextToken:GetExternalModelsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: GetExternalModelsResponse)

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

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