{-# 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.PersonalizeRuntime.GetPersonalizedRanking
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Re-ranks a list of recommended items for the given user. The first item
-- in the list is deemed the most likely item to be of interest to the
-- user.
--
-- The solution backing the campaign must have been created using a recipe
-- of type PERSONALIZED_RANKING.
module Amazonka.PersonalizeRuntime.GetPersonalizedRanking
  ( -- * Creating a Request
    GetPersonalizedRanking (..),
    newGetPersonalizedRanking,

    -- * Request Lenses
    getPersonalizedRanking_context,
    getPersonalizedRanking_filterArn,
    getPersonalizedRanking_filterValues,
    getPersonalizedRanking_campaignArn,
    getPersonalizedRanking_inputList,
    getPersonalizedRanking_userId,

    -- * Destructuring the Response
    GetPersonalizedRankingResponse (..),
    newGetPersonalizedRankingResponse,

    -- * Response Lenses
    getPersonalizedRankingResponse_personalizedRanking,
    getPersonalizedRankingResponse_recommendationId,
    getPersonalizedRankingResponse_httpStatus,
  )
where

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

-- | /See:/ 'newGetPersonalizedRanking' smart constructor.
data GetPersonalizedRanking = GetPersonalizedRanking'
  { -- | The contextual metadata to use when getting recommendations. Contextual
    -- metadata includes any interaction information that might be relevant
    -- when getting a user\'s recommendations, such as the user\'s current
    -- location or device type.
    GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
context :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Data.Sensitive Prelude.Text)),
    -- | The Amazon Resource Name (ARN) of a filter you created to include items
    -- or exclude items from recommendations for a given user. For more
    -- information, see
    -- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.
    GetPersonalizedRanking -> Maybe Text
filterArn :: Prelude.Maybe Prelude.Text,
    -- | The values to use when filtering recommendations. For each placeholder
    -- parameter in your filter expression, provide the parameter name (in
    -- matching case) as a key and the filter value(s) as the corresponding
    -- value. Separate multiple values for one parameter with a comma.
    --
    -- For filter expressions that use an @INCLUDE@ element to include items,
    -- you must provide values for all parameters that are defined in the
    -- expression. For filters with expressions that use an @EXCLUDE@ element
    -- to exclude items, you can omit the @filter-values@.In this case, Amazon
    -- Personalize doesn\'t use that portion of the expression to filter
    -- recommendations.
    --
    -- For more information, see
    -- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.
    GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
filterValues :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Data.Sensitive Prelude.Text)),
    -- | The Amazon Resource Name (ARN) of the campaign to use for generating the
    -- personalized ranking.
    GetPersonalizedRanking -> Text
campaignArn :: Prelude.Text,
    -- | A list of items (by @itemId@) to rank. If an item was not included in
    -- the training dataset, the item is appended to the end of the reranked
    -- list. The maximum is 500.
    GetPersonalizedRanking -> [Text]
inputList :: [Prelude.Text],
    -- | The user for which you want the campaign to provide a personalized
    -- ranking.
    GetPersonalizedRanking -> Text
userId :: Prelude.Text
  }
  deriving (GetPersonalizedRanking -> GetPersonalizedRanking -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetPersonalizedRanking -> GetPersonalizedRanking -> Bool
$c/= :: GetPersonalizedRanking -> GetPersonalizedRanking -> Bool
== :: GetPersonalizedRanking -> GetPersonalizedRanking -> Bool
$c== :: GetPersonalizedRanking -> GetPersonalizedRanking -> Bool
Prelude.Eq, Int -> GetPersonalizedRanking -> ShowS
[GetPersonalizedRanking] -> ShowS
GetPersonalizedRanking -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetPersonalizedRanking] -> ShowS
$cshowList :: [GetPersonalizedRanking] -> ShowS
show :: GetPersonalizedRanking -> String
$cshow :: GetPersonalizedRanking -> String
showsPrec :: Int -> GetPersonalizedRanking -> ShowS
$cshowsPrec :: Int -> GetPersonalizedRanking -> ShowS
Prelude.Show, forall x. Rep GetPersonalizedRanking x -> GetPersonalizedRanking
forall x. GetPersonalizedRanking -> Rep GetPersonalizedRanking x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetPersonalizedRanking x -> GetPersonalizedRanking
$cfrom :: forall x. GetPersonalizedRanking -> Rep GetPersonalizedRanking x
Prelude.Generic)

-- |
-- Create a value of 'GetPersonalizedRanking' 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:
--
-- 'context', 'getPersonalizedRanking_context' - The contextual metadata to use when getting recommendations. Contextual
-- metadata includes any interaction information that might be relevant
-- when getting a user\'s recommendations, such as the user\'s current
-- location or device type.
--
-- 'filterArn', 'getPersonalizedRanking_filterArn' - The Amazon Resource Name (ARN) of a filter you created to include items
-- or exclude items from recommendations for a given user. For more
-- information, see
-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.
--
-- 'filterValues', 'getPersonalizedRanking_filterValues' - The values to use when filtering recommendations. For each placeholder
-- parameter in your filter expression, provide the parameter name (in
-- matching case) as a key and the filter value(s) as the corresponding
-- value. Separate multiple values for one parameter with a comma.
--
-- For filter expressions that use an @INCLUDE@ element to include items,
-- you must provide values for all parameters that are defined in the
-- expression. For filters with expressions that use an @EXCLUDE@ element
-- to exclude items, you can omit the @filter-values@.In this case, Amazon
-- Personalize doesn\'t use that portion of the expression to filter
-- recommendations.
--
-- For more information, see
-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.
--
-- 'campaignArn', 'getPersonalizedRanking_campaignArn' - The Amazon Resource Name (ARN) of the campaign to use for generating the
-- personalized ranking.
--
-- 'inputList', 'getPersonalizedRanking_inputList' - A list of items (by @itemId@) to rank. If an item was not included in
-- the training dataset, the item is appended to the end of the reranked
-- list. The maximum is 500.
--
-- 'userId', 'getPersonalizedRanking_userId' - The user for which you want the campaign to provide a personalized
-- ranking.
newGetPersonalizedRanking ::
  -- | 'campaignArn'
  Prelude.Text ->
  -- | 'userId'
  Prelude.Text ->
  GetPersonalizedRanking
newGetPersonalizedRanking :: Text -> Text -> GetPersonalizedRanking
newGetPersonalizedRanking Text
pCampaignArn_ Text
pUserId_ =
  GetPersonalizedRanking'
    { $sel:context:GetPersonalizedRanking' :: Maybe (HashMap Text (Sensitive Text))
context = forall a. Maybe a
Prelude.Nothing,
      $sel:filterArn:GetPersonalizedRanking' :: Maybe Text
filterArn = forall a. Maybe a
Prelude.Nothing,
      $sel:filterValues:GetPersonalizedRanking' :: Maybe (HashMap Text (Sensitive Text))
filterValues = forall a. Maybe a
Prelude.Nothing,
      $sel:campaignArn:GetPersonalizedRanking' :: Text
campaignArn = Text
pCampaignArn_,
      $sel:inputList:GetPersonalizedRanking' :: [Text]
inputList = forall a. Monoid a => a
Prelude.mempty,
      $sel:userId:GetPersonalizedRanking' :: Text
userId = Text
pUserId_
    }

-- | The contextual metadata to use when getting recommendations. Contextual
-- metadata includes any interaction information that might be relevant
-- when getting a user\'s recommendations, such as the user\'s current
-- location or device type.
getPersonalizedRanking_context :: Lens.Lens' GetPersonalizedRanking (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
getPersonalizedRanking_context :: Lens' GetPersonalizedRanking (Maybe (HashMap Text Text))
getPersonalizedRanking_context = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRanking' {Maybe (HashMap Text (Sensitive Text))
context :: Maybe (HashMap Text (Sensitive Text))
$sel:context:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
context} -> Maybe (HashMap Text (Sensitive Text))
context) (\s :: GetPersonalizedRanking
s@GetPersonalizedRanking' {} Maybe (HashMap Text (Sensitive Text))
a -> GetPersonalizedRanking
s {$sel:context:GetPersonalizedRanking' :: Maybe (HashMap Text (Sensitive Text))
context = Maybe (HashMap Text (Sensitive Text))
a} :: GetPersonalizedRanking) 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 Amazon Resource Name (ARN) of a filter you created to include items
-- or exclude items from recommendations for a given user. For more
-- information, see
-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.
getPersonalizedRanking_filterArn :: Lens.Lens' GetPersonalizedRanking (Prelude.Maybe Prelude.Text)
getPersonalizedRanking_filterArn :: Lens' GetPersonalizedRanking (Maybe Text)
getPersonalizedRanking_filterArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRanking' {Maybe Text
filterArn :: Maybe Text
$sel:filterArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe Text
filterArn} -> Maybe Text
filterArn) (\s :: GetPersonalizedRanking
s@GetPersonalizedRanking' {} Maybe Text
a -> GetPersonalizedRanking
s {$sel:filterArn:GetPersonalizedRanking' :: Maybe Text
filterArn = Maybe Text
a} :: GetPersonalizedRanking)

-- | The values to use when filtering recommendations. For each placeholder
-- parameter in your filter expression, provide the parameter name (in
-- matching case) as a key and the filter value(s) as the corresponding
-- value. Separate multiple values for one parameter with a comma.
--
-- For filter expressions that use an @INCLUDE@ element to include items,
-- you must provide values for all parameters that are defined in the
-- expression. For filters with expressions that use an @EXCLUDE@ element
-- to exclude items, you can omit the @filter-values@.In this case, Amazon
-- Personalize doesn\'t use that portion of the expression to filter
-- recommendations.
--
-- For more information, see
-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.
getPersonalizedRanking_filterValues :: Lens.Lens' GetPersonalizedRanking (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
getPersonalizedRanking_filterValues :: Lens' GetPersonalizedRanking (Maybe (HashMap Text Text))
getPersonalizedRanking_filterValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRanking' {Maybe (HashMap Text (Sensitive Text))
filterValues :: Maybe (HashMap Text (Sensitive Text))
$sel:filterValues:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
filterValues} -> Maybe (HashMap Text (Sensitive Text))
filterValues) (\s :: GetPersonalizedRanking
s@GetPersonalizedRanking' {} Maybe (HashMap Text (Sensitive Text))
a -> GetPersonalizedRanking
s {$sel:filterValues:GetPersonalizedRanking' :: Maybe (HashMap Text (Sensitive Text))
filterValues = Maybe (HashMap Text (Sensitive Text))
a} :: GetPersonalizedRanking) 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 Amazon Resource Name (ARN) of the campaign to use for generating the
-- personalized ranking.
getPersonalizedRanking_campaignArn :: Lens.Lens' GetPersonalizedRanking Prelude.Text
getPersonalizedRanking_campaignArn :: Lens' GetPersonalizedRanking Text
getPersonalizedRanking_campaignArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRanking' {Text
campaignArn :: Text
$sel:campaignArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
campaignArn} -> Text
campaignArn) (\s :: GetPersonalizedRanking
s@GetPersonalizedRanking' {} Text
a -> GetPersonalizedRanking
s {$sel:campaignArn:GetPersonalizedRanking' :: Text
campaignArn = Text
a} :: GetPersonalizedRanking)

-- | A list of items (by @itemId@) to rank. If an item was not included in
-- the training dataset, the item is appended to the end of the reranked
-- list. The maximum is 500.
getPersonalizedRanking_inputList :: Lens.Lens' GetPersonalizedRanking [Prelude.Text]
getPersonalizedRanking_inputList :: Lens' GetPersonalizedRanking [Text]
getPersonalizedRanking_inputList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRanking' {[Text]
inputList :: [Text]
$sel:inputList:GetPersonalizedRanking' :: GetPersonalizedRanking -> [Text]
inputList} -> [Text]
inputList) (\s :: GetPersonalizedRanking
s@GetPersonalizedRanking' {} [Text]
a -> GetPersonalizedRanking
s {$sel:inputList:GetPersonalizedRanking' :: [Text]
inputList = [Text]
a} :: GetPersonalizedRanking) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The user for which you want the campaign to provide a personalized
-- ranking.
getPersonalizedRanking_userId :: Lens.Lens' GetPersonalizedRanking Prelude.Text
getPersonalizedRanking_userId :: Lens' GetPersonalizedRanking Text
getPersonalizedRanking_userId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRanking' {Text
userId :: Text
$sel:userId:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
userId} -> Text
userId) (\s :: GetPersonalizedRanking
s@GetPersonalizedRanking' {} Text
a -> GetPersonalizedRanking
s {$sel:userId:GetPersonalizedRanking' :: Text
userId = Text
a} :: GetPersonalizedRanking)

instance Core.AWSRequest GetPersonalizedRanking where
  type
    AWSResponse GetPersonalizedRanking =
      GetPersonalizedRankingResponse
  request :: (Service -> Service)
-> GetPersonalizedRanking -> Request GetPersonalizedRanking
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 GetPersonalizedRanking
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetPersonalizedRanking)))
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 [PredictedItem]
-> Maybe Text -> Int -> GetPersonalizedRankingResponse
GetPersonalizedRankingResponse'
            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
"personalizedRanking"
                            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
"recommendationId")
            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 GetPersonalizedRanking where
  hashWithSalt :: Int -> GetPersonalizedRanking -> Int
hashWithSalt Int
_salt GetPersonalizedRanking' {[Text]
Maybe Text
Maybe (HashMap Text (Sensitive Text))
Text
userId :: Text
inputList :: [Text]
campaignArn :: Text
filterValues :: Maybe (HashMap Text (Sensitive Text))
filterArn :: Maybe Text
context :: Maybe (HashMap Text (Sensitive Text))
$sel:userId:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
$sel:inputList:GetPersonalizedRanking' :: GetPersonalizedRanking -> [Text]
$sel:campaignArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
$sel:filterValues:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
$sel:filterArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe Text
$sel:context:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text (Sensitive Text))
context
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
filterArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text (Sensitive Text))
filterValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
campaignArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Text]
inputList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
userId

instance Prelude.NFData GetPersonalizedRanking where
  rnf :: GetPersonalizedRanking -> ()
rnf GetPersonalizedRanking' {[Text]
Maybe Text
Maybe (HashMap Text (Sensitive Text))
Text
userId :: Text
inputList :: [Text]
campaignArn :: Text
filterValues :: Maybe (HashMap Text (Sensitive Text))
filterArn :: Maybe Text
context :: Maybe (HashMap Text (Sensitive Text))
$sel:userId:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
$sel:inputList:GetPersonalizedRanking' :: GetPersonalizedRanking -> [Text]
$sel:campaignArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
$sel:filterValues:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
$sel:filterArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe Text
$sel:context:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text (Sensitive Text))
context
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
filterArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text (Sensitive Text))
filterValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
campaignArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Text]
inputList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
userId

instance Data.ToHeaders GetPersonalizedRanking where
  toHeaders :: GetPersonalizedRanking -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON GetPersonalizedRanking where
  toJSON :: GetPersonalizedRanking -> Value
toJSON GetPersonalizedRanking' {[Text]
Maybe Text
Maybe (HashMap Text (Sensitive Text))
Text
userId :: Text
inputList :: [Text]
campaignArn :: Text
filterValues :: Maybe (HashMap Text (Sensitive Text))
filterArn :: Maybe Text
context :: Maybe (HashMap Text (Sensitive Text))
$sel:userId:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
$sel:inputList:GetPersonalizedRanking' :: GetPersonalizedRanking -> [Text]
$sel:campaignArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Text
$sel:filterValues:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
$sel:filterArn:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe Text
$sel:context:GetPersonalizedRanking' :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text))
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"context" 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 (HashMap Text (Sensitive Text))
context,
            (Key
"filterArn" 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
filterArn,
            (Key
"filterValues" 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 (HashMap Text (Sensitive Text))
filterValues,
            forall a. a -> Maybe a
Prelude.Just (Key
"campaignArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
campaignArn),
            forall a. a -> Maybe a
Prelude.Just (Key
"inputList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [Text]
inputList),
            forall a. a -> Maybe a
Prelude.Just (Key
"userId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
userId)
          ]
      )

instance Data.ToPath GetPersonalizedRanking where
  toPath :: GetPersonalizedRanking -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/personalize-ranking"

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

-- | /See:/ 'newGetPersonalizedRankingResponse' smart constructor.
data GetPersonalizedRankingResponse = GetPersonalizedRankingResponse'
  { -- | A list of items in order of most likely interest to the user. The
    -- maximum is 500.
    GetPersonalizedRankingResponse -> Maybe [PredictedItem]
personalizedRanking :: Prelude.Maybe [PredictedItem],
    -- | The ID of the recommendation.
    GetPersonalizedRankingResponse -> Maybe Text
recommendationId :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetPersonalizedRankingResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetPersonalizedRankingResponse
-> GetPersonalizedRankingResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetPersonalizedRankingResponse
-> GetPersonalizedRankingResponse -> Bool
$c/= :: GetPersonalizedRankingResponse
-> GetPersonalizedRankingResponse -> Bool
== :: GetPersonalizedRankingResponse
-> GetPersonalizedRankingResponse -> Bool
$c== :: GetPersonalizedRankingResponse
-> GetPersonalizedRankingResponse -> Bool
Prelude.Eq, ReadPrec [GetPersonalizedRankingResponse]
ReadPrec GetPersonalizedRankingResponse
Int -> ReadS GetPersonalizedRankingResponse
ReadS [GetPersonalizedRankingResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetPersonalizedRankingResponse]
$creadListPrec :: ReadPrec [GetPersonalizedRankingResponse]
readPrec :: ReadPrec GetPersonalizedRankingResponse
$creadPrec :: ReadPrec GetPersonalizedRankingResponse
readList :: ReadS [GetPersonalizedRankingResponse]
$creadList :: ReadS [GetPersonalizedRankingResponse]
readsPrec :: Int -> ReadS GetPersonalizedRankingResponse
$creadsPrec :: Int -> ReadS GetPersonalizedRankingResponse
Prelude.Read, Int -> GetPersonalizedRankingResponse -> ShowS
[GetPersonalizedRankingResponse] -> ShowS
GetPersonalizedRankingResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetPersonalizedRankingResponse] -> ShowS
$cshowList :: [GetPersonalizedRankingResponse] -> ShowS
show :: GetPersonalizedRankingResponse -> String
$cshow :: GetPersonalizedRankingResponse -> String
showsPrec :: Int -> GetPersonalizedRankingResponse -> ShowS
$cshowsPrec :: Int -> GetPersonalizedRankingResponse -> ShowS
Prelude.Show, forall x.
Rep GetPersonalizedRankingResponse x
-> GetPersonalizedRankingResponse
forall x.
GetPersonalizedRankingResponse
-> Rep GetPersonalizedRankingResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetPersonalizedRankingResponse x
-> GetPersonalizedRankingResponse
$cfrom :: forall x.
GetPersonalizedRankingResponse
-> Rep GetPersonalizedRankingResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetPersonalizedRankingResponse' 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:
--
-- 'personalizedRanking', 'getPersonalizedRankingResponse_personalizedRanking' - A list of items in order of most likely interest to the user. The
-- maximum is 500.
--
-- 'recommendationId', 'getPersonalizedRankingResponse_recommendationId' - The ID of the recommendation.
--
-- 'httpStatus', 'getPersonalizedRankingResponse_httpStatus' - The response's http status code.
newGetPersonalizedRankingResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetPersonalizedRankingResponse
newGetPersonalizedRankingResponse :: Int -> GetPersonalizedRankingResponse
newGetPersonalizedRankingResponse Int
pHttpStatus_ =
  GetPersonalizedRankingResponse'
    { $sel:personalizedRanking:GetPersonalizedRankingResponse' :: Maybe [PredictedItem]
personalizedRanking =
        forall a. Maybe a
Prelude.Nothing,
      $sel:recommendationId:GetPersonalizedRankingResponse' :: Maybe Text
recommendationId = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetPersonalizedRankingResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of items in order of most likely interest to the user. The
-- maximum is 500.
getPersonalizedRankingResponse_personalizedRanking :: Lens.Lens' GetPersonalizedRankingResponse (Prelude.Maybe [PredictedItem])
getPersonalizedRankingResponse_personalizedRanking :: Lens' GetPersonalizedRankingResponse (Maybe [PredictedItem])
getPersonalizedRankingResponse_personalizedRanking = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRankingResponse' {Maybe [PredictedItem]
personalizedRanking :: Maybe [PredictedItem]
$sel:personalizedRanking:GetPersonalizedRankingResponse' :: GetPersonalizedRankingResponse -> Maybe [PredictedItem]
personalizedRanking} -> Maybe [PredictedItem]
personalizedRanking) (\s :: GetPersonalizedRankingResponse
s@GetPersonalizedRankingResponse' {} Maybe [PredictedItem]
a -> GetPersonalizedRankingResponse
s {$sel:personalizedRanking:GetPersonalizedRankingResponse' :: Maybe [PredictedItem]
personalizedRanking = Maybe [PredictedItem]
a} :: GetPersonalizedRankingResponse) 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 ID of the recommendation.
getPersonalizedRankingResponse_recommendationId :: Lens.Lens' GetPersonalizedRankingResponse (Prelude.Maybe Prelude.Text)
getPersonalizedRankingResponse_recommendationId :: Lens' GetPersonalizedRankingResponse (Maybe Text)
getPersonalizedRankingResponse_recommendationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPersonalizedRankingResponse' {Maybe Text
recommendationId :: Maybe Text
$sel:recommendationId:GetPersonalizedRankingResponse' :: GetPersonalizedRankingResponse -> Maybe Text
recommendationId} -> Maybe Text
recommendationId) (\s :: GetPersonalizedRankingResponse
s@GetPersonalizedRankingResponse' {} Maybe Text
a -> GetPersonalizedRankingResponse
s {$sel:recommendationId:GetPersonalizedRankingResponse' :: Maybe Text
recommendationId = Maybe Text
a} :: GetPersonalizedRankingResponse)

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

instance
  Prelude.NFData
    GetPersonalizedRankingResponse
  where
  rnf :: GetPersonalizedRankingResponse -> ()
rnf GetPersonalizedRankingResponse' {Int
Maybe [PredictedItem]
Maybe Text
httpStatus :: Int
recommendationId :: Maybe Text
personalizedRanking :: Maybe [PredictedItem]
$sel:httpStatus:GetPersonalizedRankingResponse' :: GetPersonalizedRankingResponse -> Int
$sel:recommendationId:GetPersonalizedRankingResponse' :: GetPersonalizedRankingResponse -> Maybe Text
$sel:personalizedRanking:GetPersonalizedRankingResponse' :: GetPersonalizedRankingResponse -> Maybe [PredictedItem]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [PredictedItem]
personalizedRanking
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
recommendationId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus