amazonka-personalize-runtime (empty) → 2.0
raw patch · 20 files changed
+1932/−0 lines, 20 filesdep +amazonka-coredep +amazonka-personalize-runtimedep +amazonka-test
Dependencies added: amazonka-core, amazonka-personalize-runtime, amazonka-test, base, bytestring, case-insensitive, tasty, tasty-hunit, text, time, unordered-containers
Files
- LICENSE +367/−0
- README.md +44/−0
- amazonka-personalize-runtime.cabal +87/−0
- fixture/GetPersonalizedRanking.yaml +10/−0
- fixture/GetPersonalizedRankingResponse.proto +0/−0
- fixture/GetRecommendations.yaml +10/−0
- fixture/GetRecommendationsResponse.proto +0/−0
- gen/Amazonka/PersonalizeRuntime.hs +87/−0
- gen/Amazonka/PersonalizeRuntime/GetPersonalizedRanking.hs +331/−0
- gen/Amazonka/PersonalizeRuntime/GetRecommendations.hs +389/−0
- gen/Amazonka/PersonalizeRuntime/Lens.hs +60/−0
- gen/Amazonka/PersonalizeRuntime/Types.hs +133/−0
- gen/Amazonka/PersonalizeRuntime/Types/PredictedItem.hs +104/−0
- gen/Amazonka/PersonalizeRuntime/Types/Promotion.hs +157/−0
- gen/Amazonka/PersonalizeRuntime/Waiters.hs +24/−0
- src/.gitkeep +0/−0
- test/Main.hs +23/−0
- test/Test/Amazonka/Gen/PersonalizeRuntime.hs +78/−0
- test/Test/Amazonka/PersonalizeRuntime.hs +20/−0
- test/Test/Amazonka/PersonalizeRuntime/Internal.hs +8/−0
+ LICENSE view
@@ -0,0 +1,367 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.
+ README.md view
@@ -0,0 +1,44 @@+# Amazon Personalize Runtime SDK++* [Version](#version)+* [Description](#description)+* [Contribute](#contribute)+* [Licence](#licence)+++## Version+ +`2.0` - Derived from API version @2018-05-22@ of the AWS service descriptions, licensed under Apache 2.0.++## Description++Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-personalize-runtime)+and the [AWS API Reference](https://aws.amazon.com/documentation/).++The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka),+which provides mechanisms for specifying AuthN/AuthZ information, sending requests,+and receiving responses.++Lenses are used for constructing and manipulating types,+due to the depth of nesting of AWS types and transparency regarding+de/serialisation into more palatable Haskell values.+The provided lenses should be compatible with any of the major lens libraries+[lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core).++See [Amazonka.PersonalizeRuntime](http://hackage.haskell.org/package/amazonka-personalize-runtime/docs/Amazonka-PersonalizeRuntime.html)+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.+++## Contribute++For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues).++> _Note:_ this library is an auto-generated Haskell package. Please see `amazonka-gen` for more information.+++## Licence++`amazonka-personalize-runtime` is released under the [Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/).++Parts of the code are derived from AWS service descriptions, licensed under Apache 2.0.+Source files subject to this contain an additional licensing clause in their header.
+ amazonka-personalize-runtime.cabal view
@@ -0,0 +1,87 @@+cabal-version: 2.2+name: amazonka-personalize-runtime+version: 2.0+synopsis: Amazon Personalize Runtime SDK.+homepage: https://github.com/brendanhay/amazonka+bug-reports: https://github.com/brendanhay/amazonka/issues+license: MPL-2.0+license-file: LICENSE+author: Brendan Hay+maintainer:+ Brendan Hay <brendan.g.hay+amazonka@gmail.com>, Jack Kelly <jack@jackkelly.name>++copyright: Copyright (c) 2013-2023 Brendan Hay+category: AWS+build-type: Simple+extra-source-files:+ fixture/*.proto+ fixture/*.yaml+ README.md+ src/.gitkeep++description:+ Derived from API version @2018-05-22@ of the AWS service descriptions, licensed under Apache 2.0.+ .+ The types from this library are intended to be used with <http://hackage.haskell.org/package/amazonka amazonka>,+ which provides mechanisms for specifying AuthN/AuthZ information, sending requests, and receiving responses.+ .+ It is recommended to use generic lenses or optics from packages such as <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify optional fields and deconstruct responses.+ .+ Generated lenses can be found in "Amazonka.PersonalizeRuntime.Lens" and are+ suitable for use with a lens package such as <http://hackage.haskell.org/package/lens lens> or <http://hackage.haskell.org/package/lens-family-core lens-family-core>.+ .+ See "Amazonka.PersonalizeRuntime" and the <https://aws.amazon.com/documentation/ AWS documentation> to get started.++source-repository head+ type: git+ location: git://github.com/brendanhay/amazonka.git+ subdir: amazonka-personalize-runtime++library+ default-language: Haskell2010+ hs-source-dirs: src gen+ ghc-options:+ -Wall -fwarn-incomplete-uni-patterns+ -fwarn-incomplete-record-updates -funbox-strict-fields++ exposed-modules:+ Amazonka.PersonalizeRuntime+ Amazonka.PersonalizeRuntime.GetPersonalizedRanking+ Amazonka.PersonalizeRuntime.GetRecommendations+ Amazonka.PersonalizeRuntime.Lens+ Amazonka.PersonalizeRuntime.Types+ Amazonka.PersonalizeRuntime.Types.PredictedItem+ Amazonka.PersonalizeRuntime.Types.Promotion+ Amazonka.PersonalizeRuntime.Waiters++ build-depends:+ , amazonka-core >=2.0 && <2.1+ , base >=4.12 && <5++test-suite amazonka-personalize-runtime-test+ type: exitcode-stdio-1.0+ default-language: Haskell2010+ hs-source-dirs: test+ main-is: Main.hs+ ghc-options: -Wall -threaded++ -- This section is encoded by the template and any modules added by+ -- hand outside these namespaces will not correctly be added to the+ -- distribution package.+ other-modules:+ Test.Amazonka.Gen.PersonalizeRuntime+ Test.Amazonka.PersonalizeRuntime+ Test.Amazonka.PersonalizeRuntime.Internal++ build-depends:+ , amazonka-core >=2.0 && <2.1+ , amazonka-personalize-runtime+ , amazonka-test >=2.0 && <2.1+ , base+ , bytestring+ , case-insensitive+ , tasty+ , tasty-hunit+ , text+ , time+ , unordered-containers
+ fixture/GetPersonalizedRanking.yaml view
@@ -0,0 +1,10 @@+---+method: POST+headers:+ Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/personalize-runtime/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=?+ Host: personalize-runtime.us-east-1.amazonaws.com+ Content-Type: application/x-www-form-urlencoded; charset=utf-8+ X-Amz-Content-SHA256: abcdef+ X-Amz-Date: 20091028T223200Z+body:+ ''
+ fixture/GetPersonalizedRankingResponse.proto view
+ fixture/GetRecommendations.yaml view
@@ -0,0 +1,10 @@+---+method: POST+headers:+ Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/personalize-runtime/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=?+ Host: personalize-runtime.us-east-1.amazonaws.com+ Content-Type: application/x-www-form-urlencoded; charset=utf-8+ X-Amz-Content-SHA256: abcdef+ X-Amz-Date: 20091028T223200Z+body:+ ''
+ fixture/GetRecommendationsResponse.proto view
+ gen/Amazonka/PersonalizeRuntime.hs view
@@ -0,0 +1,87 @@+{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}+{-# OPTIONS_GHC -fno-warn-unused-imports #-}++-- |+-- Module : Amazonka.PersonalizeRuntime+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+--+-- Derived from API version @2018-05-22@ of the AWS service descriptions, licensed under Apache 2.0.+module Amazonka.PersonalizeRuntime+ ( -- * Service Configuration+ defaultService,++ -- * Errors+ -- $errors++ -- ** InvalidInputException+ _InvalidInputException,++ -- ** ResourceNotFoundException+ _ResourceNotFoundException,++ -- * Waiters+ -- $waiters++ -- * Operations+ -- $operations++ -- ** GetPersonalizedRanking+ GetPersonalizedRanking (GetPersonalizedRanking'),+ newGetPersonalizedRanking,+ GetPersonalizedRankingResponse (GetPersonalizedRankingResponse'),+ newGetPersonalizedRankingResponse,++ -- ** GetRecommendations+ GetRecommendations (GetRecommendations'),+ newGetRecommendations,+ GetRecommendationsResponse (GetRecommendationsResponse'),+ newGetRecommendationsResponse,++ -- * Types++ -- ** PredictedItem+ PredictedItem (PredictedItem'),+ newPredictedItem,++ -- ** Promotion+ Promotion (Promotion'),+ newPromotion,+ )+where++import Amazonka.PersonalizeRuntime.GetPersonalizedRanking+import Amazonka.PersonalizeRuntime.GetRecommendations+import Amazonka.PersonalizeRuntime.Lens+import Amazonka.PersonalizeRuntime.Types+import Amazonka.PersonalizeRuntime.Waiters++-- $errors+-- Error matchers are designed for use with the functions provided by+-- <http://hackage.haskell.org/package/lens/docs/Control-Exception-Lens.html Control.Exception.Lens>.+-- This allows catching (and rethrowing) service specific errors returned+-- by 'PersonalizeRuntime'.++-- $operations+-- Some AWS operations return results that are incomplete and require subsequent+-- requests in order to obtain the entire result set. The process of sending+-- subsequent requests to continue where a previous request left off is called+-- pagination. For example, the 'ListObjects' operation of Amazon S3 returns up to+-- 1000 objects at a time, and you must send subsequent requests with the+-- appropriate Marker in order to retrieve the next page of results.+--+-- Operations that have an 'AWSPager' instance can transparently perform subsequent+-- requests, correctly setting Markers and other request facets to iterate through+-- the entire result set of a truncated API operation. Operations which support+-- this have an additional note in the documentation.+--+-- Many operations have the ability to filter results on the server side. See the+-- individual operation parameters for details.++-- $waiters+-- Waiters poll by repeatedly sending a request until some remote success condition+-- configured by the 'Wait' specification is fulfilled. The 'Wait' specification+-- determines how many attempts should be made, in addition to delay and retry strategies.
+ gen/Amazonka/PersonalizeRuntime/GetPersonalizedRanking.hs view
@@ -0,0 +1,331 @@+{-# 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.+ 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>.+ 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>.+ 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.+ 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.+ inputList :: [Prelude.Text],+ -- | The user for which you want the campaign to provide a personalized+ -- ranking.+ userId :: Prelude.Text+ }+ deriving (Prelude.Eq, Prelude.Show, 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 pCampaignArn_ pUserId_ =+ GetPersonalizedRanking'+ { context = Prelude.Nothing,+ filterArn = Prelude.Nothing,+ filterValues = Prelude.Nothing,+ campaignArn = pCampaignArn_,+ inputList = Prelude.mempty,+ userId = 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.lens (\GetPersonalizedRanking' {context} -> context) (\s@GetPersonalizedRanking' {} a -> s {context = a} :: GetPersonalizedRanking) Prelude.. Lens.mapping 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.lens (\GetPersonalizedRanking' {filterArn} -> filterArn) (\s@GetPersonalizedRanking' {} a -> s {filterArn = 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.lens (\GetPersonalizedRanking' {filterValues} -> filterValues) (\s@GetPersonalizedRanking' {} a -> s {filterValues = a} :: GetPersonalizedRanking) Prelude.. Lens.mapping 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.lens (\GetPersonalizedRanking' {campaignArn} -> campaignArn) (\s@GetPersonalizedRanking' {} a -> s {campaignArn = 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.lens (\GetPersonalizedRanking' {inputList} -> inputList) (\s@GetPersonalizedRanking' {} a -> s {inputList = a} :: GetPersonalizedRanking) Prelude.. 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.lens (\GetPersonalizedRanking' {userId} -> userId) (\s@GetPersonalizedRanking' {} a -> s {userId = a} :: GetPersonalizedRanking)++instance Core.AWSRequest GetPersonalizedRanking where+ type+ AWSResponse GetPersonalizedRanking =+ GetPersonalizedRankingResponse+ request overrides =+ Request.postJSON (overrides defaultService)+ response =+ Response.receiveJSON+ ( \s h x ->+ GetPersonalizedRankingResponse'+ Prelude.<$> ( x+ Data..?> "personalizedRanking"+ Core..!@ Prelude.mempty+ )+ Prelude.<*> (x Data..?> "recommendationId")+ Prelude.<*> (Prelude.pure (Prelude.fromEnum s))+ )++instance Prelude.Hashable GetPersonalizedRanking where+ hashWithSalt _salt GetPersonalizedRanking' {..} =+ _salt+ `Prelude.hashWithSalt` context+ `Prelude.hashWithSalt` filterArn+ `Prelude.hashWithSalt` filterValues+ `Prelude.hashWithSalt` campaignArn+ `Prelude.hashWithSalt` inputList+ `Prelude.hashWithSalt` userId++instance Prelude.NFData GetPersonalizedRanking where+ rnf GetPersonalizedRanking' {..} =+ Prelude.rnf context+ `Prelude.seq` Prelude.rnf filterArn+ `Prelude.seq` Prelude.rnf filterValues+ `Prelude.seq` Prelude.rnf campaignArn+ `Prelude.seq` Prelude.rnf inputList+ `Prelude.seq` Prelude.rnf userId++instance Data.ToHeaders GetPersonalizedRanking where+ toHeaders =+ Prelude.const+ ( Prelude.mconcat+ [ "Content-Type"+ Data.=# ( "application/x-amz-json-1.1" ::+ Prelude.ByteString+ )+ ]+ )++instance Data.ToJSON GetPersonalizedRanking where+ toJSON GetPersonalizedRanking' {..} =+ Data.object+ ( Prelude.catMaybes+ [ ("context" Data..=) Prelude.<$> context,+ ("filterArn" Data..=) Prelude.<$> filterArn,+ ("filterValues" Data..=) Prelude.<$> filterValues,+ Prelude.Just ("campaignArn" Data..= campaignArn),+ Prelude.Just ("inputList" Data..= inputList),+ Prelude.Just ("userId" Data..= userId)+ ]+ )++instance Data.ToPath GetPersonalizedRanking where+ toPath = Prelude.const "/personalize-ranking"++instance Data.ToQuery GetPersonalizedRanking where+ toQuery = Prelude.const 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.+ personalizedRanking :: Prelude.Maybe [PredictedItem],+ -- | The ID of the recommendation.+ recommendationId :: Prelude.Maybe Prelude.Text,+ -- | The response's http status code.+ httpStatus :: Prelude.Int+ }+ deriving (Prelude.Eq, Prelude.Read, Prelude.Show, 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 pHttpStatus_ =+ GetPersonalizedRankingResponse'+ { personalizedRanking =+ Prelude.Nothing,+ recommendationId = Prelude.Nothing,+ httpStatus = 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.lens (\GetPersonalizedRankingResponse' {personalizedRanking} -> personalizedRanking) (\s@GetPersonalizedRankingResponse' {} a -> s {personalizedRanking = a} :: GetPersonalizedRankingResponse) Prelude.. Lens.mapping Lens.coerced++-- | The ID of the recommendation.+getPersonalizedRankingResponse_recommendationId :: Lens.Lens' GetPersonalizedRankingResponse (Prelude.Maybe Prelude.Text)+getPersonalizedRankingResponse_recommendationId = Lens.lens (\GetPersonalizedRankingResponse' {recommendationId} -> recommendationId) (\s@GetPersonalizedRankingResponse' {} a -> s {recommendationId = a} :: GetPersonalizedRankingResponse)++-- | The response's http status code.+getPersonalizedRankingResponse_httpStatus :: Lens.Lens' GetPersonalizedRankingResponse Prelude.Int+getPersonalizedRankingResponse_httpStatus = Lens.lens (\GetPersonalizedRankingResponse' {httpStatus} -> httpStatus) (\s@GetPersonalizedRankingResponse' {} a -> s {httpStatus = a} :: GetPersonalizedRankingResponse)++instance+ Prelude.NFData+ GetPersonalizedRankingResponse+ where+ rnf GetPersonalizedRankingResponse' {..} =+ Prelude.rnf personalizedRanking+ `Prelude.seq` Prelude.rnf recommendationId+ `Prelude.seq` Prelude.rnf httpStatus
+ gen/Amazonka/PersonalizeRuntime/GetRecommendations.hs view
@@ -0,0 +1,389 @@+{-# 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.GetRecommendations+-- 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 recommended items. For campaigns, the campaign\'s+-- Amazon Resource Name (ARN) is required and the required user and item+-- input depends on the recipe type used to create the solution backing the+-- campaign as follows:+--+-- - USER_PERSONALIZATION - @userId@ required, @itemId@ not used+--+-- - RELATED_ITEMS - @itemId@ required, @userId@ not used+--+-- Campaigns that are backed by a solution created using a recipe of type+-- PERSONALIZED_RANKING use the API.+--+-- For recommenders, the recommender\'s ARN is required and the required+-- item and user input depends on the use case (domain-based recipe)+-- backing the recommender. For information on use case requirements see+-- <https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html Choosing recommender use cases>.+module Amazonka.PersonalizeRuntime.GetRecommendations+ ( -- * Creating a Request+ GetRecommendations (..),+ newGetRecommendations,++ -- * Request Lenses+ getRecommendations_campaignArn,+ getRecommendations_context,+ getRecommendations_filterArn,+ getRecommendations_filterValues,+ getRecommendations_itemId,+ getRecommendations_numResults,+ getRecommendations_promotions,+ getRecommendations_recommenderArn,+ getRecommendations_userId,++ -- * Destructuring the Response+ GetRecommendationsResponse (..),+ newGetRecommendationsResponse,++ -- * Response Lenses+ getRecommendationsResponse_itemList,+ getRecommendationsResponse_recommendationId,+ getRecommendationsResponse_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:/ 'newGetRecommendations' smart constructor.+data GetRecommendations = GetRecommendations'+ { -- | The Amazon Resource Name (ARN) of the campaign to use for getting+ -- recommendations.+ campaignArn :: Prelude.Maybe Prelude.Text,+ -- | 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.+ context :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Data.Sensitive Prelude.Text)),+ -- | The ARN of the filter to apply to the returned recommendations. For more+ -- information, see+ -- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.+ --+ -- When using this parameter, be sure the filter resource is @ACTIVE@.+ 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 and user segments>.+ filterValues :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Data.Sensitive Prelude.Text)),+ -- | The item ID to provide recommendations for.+ --+ -- Required for @RELATED_ITEMS@ recipe type.+ itemId :: Prelude.Maybe Prelude.Text,+ -- | The number of results to return. The default is 25. The maximum is 500.+ numResults :: Prelude.Maybe Prelude.Natural,+ -- | The promotions to apply to the recommendation request. A promotion+ -- defines additional business rules that apply to a configurable subset of+ -- recommended items.+ promotions :: Prelude.Maybe [Promotion],+ -- | The Amazon Resource Name (ARN) of the recommender to use to get+ -- recommendations. Provide a recommender ARN if you created a Domain+ -- dataset group with a recommender for a domain use case.+ recommenderArn :: Prelude.Maybe Prelude.Text,+ -- | The user ID to provide recommendations for.+ --+ -- Required for @USER_PERSONALIZATION@ recipe type.+ userId :: Prelude.Maybe Prelude.Text+ }+ deriving (Prelude.Eq, Prelude.Show, Prelude.Generic)++-- |+-- Create a value of 'GetRecommendations' 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:+--+-- 'campaignArn', 'getRecommendations_campaignArn' - The Amazon Resource Name (ARN) of the campaign to use for getting+-- recommendations.+--+-- 'context', 'getRecommendations_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', 'getRecommendations_filterArn' - The ARN of the filter to apply to the returned recommendations. For more+-- information, see+-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.+--+-- When using this parameter, be sure the filter resource is @ACTIVE@.+--+-- 'filterValues', 'getRecommendations_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 and user segments>.+--+-- 'itemId', 'getRecommendations_itemId' - The item ID to provide recommendations for.+--+-- Required for @RELATED_ITEMS@ recipe type.+--+-- 'numResults', 'getRecommendations_numResults' - The number of results to return. The default is 25. The maximum is 500.+--+-- 'promotions', 'getRecommendations_promotions' - The promotions to apply to the recommendation request. A promotion+-- defines additional business rules that apply to a configurable subset of+-- recommended items.+--+-- 'recommenderArn', 'getRecommendations_recommenderArn' - The Amazon Resource Name (ARN) of the recommender to use to get+-- recommendations. Provide a recommender ARN if you created a Domain+-- dataset group with a recommender for a domain use case.+--+-- 'userId', 'getRecommendations_userId' - The user ID to provide recommendations for.+--+-- Required for @USER_PERSONALIZATION@ recipe type.+newGetRecommendations ::+ GetRecommendations+newGetRecommendations =+ GetRecommendations'+ { campaignArn = Prelude.Nothing,+ context = Prelude.Nothing,+ filterArn = Prelude.Nothing,+ filterValues = Prelude.Nothing,+ itemId = Prelude.Nothing,+ numResults = Prelude.Nothing,+ promotions = Prelude.Nothing,+ recommenderArn = Prelude.Nothing,+ userId = Prelude.Nothing+ }++-- | The Amazon Resource Name (ARN) of the campaign to use for getting+-- recommendations.+getRecommendations_campaignArn :: Lens.Lens' GetRecommendations (Prelude.Maybe Prelude.Text)+getRecommendations_campaignArn = Lens.lens (\GetRecommendations' {campaignArn} -> campaignArn) (\s@GetRecommendations' {} a -> s {campaignArn = a} :: GetRecommendations)++-- | 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.+getRecommendations_context :: Lens.Lens' GetRecommendations (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))+getRecommendations_context = Lens.lens (\GetRecommendations' {context} -> context) (\s@GetRecommendations' {} a -> s {context = a} :: GetRecommendations) Prelude.. Lens.mapping Lens.coerced++-- | The ARN of the filter to apply to the returned recommendations. For more+-- information, see+-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering Recommendations>.+--+-- When using this parameter, be sure the filter resource is @ACTIVE@.+getRecommendations_filterArn :: Lens.Lens' GetRecommendations (Prelude.Maybe Prelude.Text)+getRecommendations_filterArn = Lens.lens (\GetRecommendations' {filterArn} -> filterArn) (\s@GetRecommendations' {} a -> s {filterArn = a} :: GetRecommendations)++-- | 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 and user segments>.+getRecommendations_filterValues :: Lens.Lens' GetRecommendations (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))+getRecommendations_filterValues = Lens.lens (\GetRecommendations' {filterValues} -> filterValues) (\s@GetRecommendations' {} a -> s {filterValues = a} :: GetRecommendations) Prelude.. Lens.mapping Lens.coerced++-- | The item ID to provide recommendations for.+--+-- Required for @RELATED_ITEMS@ recipe type.+getRecommendations_itemId :: Lens.Lens' GetRecommendations (Prelude.Maybe Prelude.Text)+getRecommendations_itemId = Lens.lens (\GetRecommendations' {itemId} -> itemId) (\s@GetRecommendations' {} a -> s {itemId = a} :: GetRecommendations)++-- | The number of results to return. The default is 25. The maximum is 500.+getRecommendations_numResults :: Lens.Lens' GetRecommendations (Prelude.Maybe Prelude.Natural)+getRecommendations_numResults = Lens.lens (\GetRecommendations' {numResults} -> numResults) (\s@GetRecommendations' {} a -> s {numResults = a} :: GetRecommendations)++-- | The promotions to apply to the recommendation request. A promotion+-- defines additional business rules that apply to a configurable subset of+-- recommended items.+getRecommendations_promotions :: Lens.Lens' GetRecommendations (Prelude.Maybe [Promotion])+getRecommendations_promotions = Lens.lens (\GetRecommendations' {promotions} -> promotions) (\s@GetRecommendations' {} a -> s {promotions = a} :: GetRecommendations) Prelude.. Lens.mapping Lens.coerced++-- | The Amazon Resource Name (ARN) of the recommender to use to get+-- recommendations. Provide a recommender ARN if you created a Domain+-- dataset group with a recommender for a domain use case.+getRecommendations_recommenderArn :: Lens.Lens' GetRecommendations (Prelude.Maybe Prelude.Text)+getRecommendations_recommenderArn = Lens.lens (\GetRecommendations' {recommenderArn} -> recommenderArn) (\s@GetRecommendations' {} a -> s {recommenderArn = a} :: GetRecommendations)++-- | The user ID to provide recommendations for.+--+-- Required for @USER_PERSONALIZATION@ recipe type.+getRecommendations_userId :: Lens.Lens' GetRecommendations (Prelude.Maybe Prelude.Text)+getRecommendations_userId = Lens.lens (\GetRecommendations' {userId} -> userId) (\s@GetRecommendations' {} a -> s {userId = a} :: GetRecommendations)++instance Core.AWSRequest GetRecommendations where+ type+ AWSResponse GetRecommendations =+ GetRecommendationsResponse+ request overrides =+ Request.postJSON (overrides defaultService)+ response =+ Response.receiveJSON+ ( \s h x ->+ GetRecommendationsResponse'+ Prelude.<$> (x Data..?> "itemList" Core..!@ Prelude.mempty)+ Prelude.<*> (x Data..?> "recommendationId")+ Prelude.<*> (Prelude.pure (Prelude.fromEnum s))+ )++instance Prelude.Hashable GetRecommendations where+ hashWithSalt _salt GetRecommendations' {..} =+ _salt+ `Prelude.hashWithSalt` campaignArn+ `Prelude.hashWithSalt` context+ `Prelude.hashWithSalt` filterArn+ `Prelude.hashWithSalt` filterValues+ `Prelude.hashWithSalt` itemId+ `Prelude.hashWithSalt` numResults+ `Prelude.hashWithSalt` promotions+ `Prelude.hashWithSalt` recommenderArn+ `Prelude.hashWithSalt` userId++instance Prelude.NFData GetRecommendations where+ rnf GetRecommendations' {..} =+ Prelude.rnf campaignArn+ `Prelude.seq` Prelude.rnf context+ `Prelude.seq` Prelude.rnf filterArn+ `Prelude.seq` Prelude.rnf filterValues+ `Prelude.seq` Prelude.rnf itemId+ `Prelude.seq` Prelude.rnf numResults+ `Prelude.seq` Prelude.rnf promotions+ `Prelude.seq` Prelude.rnf recommenderArn+ `Prelude.seq` Prelude.rnf userId++instance Data.ToHeaders GetRecommendations where+ toHeaders =+ Prelude.const+ ( Prelude.mconcat+ [ "Content-Type"+ Data.=# ( "application/x-amz-json-1.1" ::+ Prelude.ByteString+ )+ ]+ )++instance Data.ToJSON GetRecommendations where+ toJSON GetRecommendations' {..} =+ Data.object+ ( Prelude.catMaybes+ [ ("campaignArn" Data..=) Prelude.<$> campaignArn,+ ("context" Data..=) Prelude.<$> context,+ ("filterArn" Data..=) Prelude.<$> filterArn,+ ("filterValues" Data..=) Prelude.<$> filterValues,+ ("itemId" Data..=) Prelude.<$> itemId,+ ("numResults" Data..=) Prelude.<$> numResults,+ ("promotions" Data..=) Prelude.<$> promotions,+ ("recommenderArn" Data..=)+ Prelude.<$> recommenderArn,+ ("userId" Data..=) Prelude.<$> userId+ ]+ )++instance Data.ToPath GetRecommendations where+ toPath = Prelude.const "/recommendations"++instance Data.ToQuery GetRecommendations where+ toQuery = Prelude.const Prelude.mempty++-- | /See:/ 'newGetRecommendationsResponse' smart constructor.+data GetRecommendationsResponse = GetRecommendationsResponse'+ { -- | A list of recommendations sorted in descending order by prediction+ -- score. There can be a maximum of 500 items in the list.+ itemList :: Prelude.Maybe [PredictedItem],+ -- | The ID of the recommendation.+ recommendationId :: Prelude.Maybe Prelude.Text,+ -- | The response's http status code.+ httpStatus :: Prelude.Int+ }+ deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)++-- |+-- Create a value of 'GetRecommendationsResponse' 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:+--+-- 'itemList', 'getRecommendationsResponse_itemList' - A list of recommendations sorted in descending order by prediction+-- score. There can be a maximum of 500 items in the list.+--+-- 'recommendationId', 'getRecommendationsResponse_recommendationId' - The ID of the recommendation.+--+-- 'httpStatus', 'getRecommendationsResponse_httpStatus' - The response's http status code.+newGetRecommendationsResponse ::+ -- | 'httpStatus'+ Prelude.Int ->+ GetRecommendationsResponse+newGetRecommendationsResponse pHttpStatus_ =+ GetRecommendationsResponse'+ { itemList =+ Prelude.Nothing,+ recommendationId = Prelude.Nothing,+ httpStatus = pHttpStatus_+ }++-- | A list of recommendations sorted in descending order by prediction+-- score. There can be a maximum of 500 items in the list.+getRecommendationsResponse_itemList :: Lens.Lens' GetRecommendationsResponse (Prelude.Maybe [PredictedItem])+getRecommendationsResponse_itemList = Lens.lens (\GetRecommendationsResponse' {itemList} -> itemList) (\s@GetRecommendationsResponse' {} a -> s {itemList = a} :: GetRecommendationsResponse) Prelude.. Lens.mapping Lens.coerced++-- | The ID of the recommendation.+getRecommendationsResponse_recommendationId :: Lens.Lens' GetRecommendationsResponse (Prelude.Maybe Prelude.Text)+getRecommendationsResponse_recommendationId = Lens.lens (\GetRecommendationsResponse' {recommendationId} -> recommendationId) (\s@GetRecommendationsResponse' {} a -> s {recommendationId = a} :: GetRecommendationsResponse)++-- | The response's http status code.+getRecommendationsResponse_httpStatus :: Lens.Lens' GetRecommendationsResponse Prelude.Int+getRecommendationsResponse_httpStatus = Lens.lens (\GetRecommendationsResponse' {httpStatus} -> httpStatus) (\s@GetRecommendationsResponse' {} a -> s {httpStatus = a} :: GetRecommendationsResponse)++instance Prelude.NFData GetRecommendationsResponse where+ rnf GetRecommendationsResponse' {..} =+ Prelude.rnf itemList+ `Prelude.seq` Prelude.rnf recommendationId+ `Prelude.seq` Prelude.rnf httpStatus
+ gen/Amazonka/PersonalizeRuntime/Lens.hs view
@@ -0,0 +1,60 @@+{-# LANGUAGE NoImplicitPrelude #-}+{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}+{-# OPTIONS_GHC -fno-warn-unused-imports #-}++-- Derived from AWS service descriptions, licensed under Apache 2.0.++-- |+-- Module : Amazonka.PersonalizeRuntime.Lens+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Amazonka.PersonalizeRuntime.Lens+ ( -- * Operations++ -- ** GetPersonalizedRanking+ getPersonalizedRanking_context,+ getPersonalizedRanking_filterArn,+ getPersonalizedRanking_filterValues,+ getPersonalizedRanking_campaignArn,+ getPersonalizedRanking_inputList,+ getPersonalizedRanking_userId,+ getPersonalizedRankingResponse_personalizedRanking,+ getPersonalizedRankingResponse_recommendationId,+ getPersonalizedRankingResponse_httpStatus,++ -- ** GetRecommendations+ getRecommendations_campaignArn,+ getRecommendations_context,+ getRecommendations_filterArn,+ getRecommendations_filterValues,+ getRecommendations_itemId,+ getRecommendations_numResults,+ getRecommendations_promotions,+ getRecommendations_recommenderArn,+ getRecommendations_userId,+ getRecommendationsResponse_itemList,+ getRecommendationsResponse_recommendationId,+ getRecommendationsResponse_httpStatus,++ -- * Types++ -- ** PredictedItem+ predictedItem_itemId,+ predictedItem_promotionName,+ predictedItem_score,++ -- ** Promotion+ promotion_filterArn,+ promotion_filterValues,+ promotion_name,+ promotion_percentPromotedItems,+ )+where++import Amazonka.PersonalizeRuntime.GetPersonalizedRanking+import Amazonka.PersonalizeRuntime.GetRecommendations+import Amazonka.PersonalizeRuntime.Types.PredictedItem+import Amazonka.PersonalizeRuntime.Types.Promotion
+ gen/Amazonka/PersonalizeRuntime/Types.hs view
@@ -0,0 +1,133 @@+{-# LANGUAGE DisambiguateRecordFields #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE StrictData #-}+{-# LANGUAGE NoImplicitPrelude #-}+{-# OPTIONS_GHC -fno-warn-unused-matches #-}++-- Derived from AWS service descriptions, licensed under Apache 2.0.++-- |+-- Module : Amazonka.PersonalizeRuntime.Types+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Amazonka.PersonalizeRuntime.Types+ ( -- * Service Configuration+ defaultService,++ -- * Errors+ _InvalidInputException,+ _ResourceNotFoundException,++ -- * PredictedItem+ PredictedItem (..),+ newPredictedItem,+ predictedItem_itemId,+ predictedItem_promotionName,+ predictedItem_score,++ -- * Promotion+ Promotion (..),+ newPromotion,+ promotion_filterArn,+ promotion_filterValues,+ promotion_name,+ promotion_percentPromotedItems,+ )+where++import qualified Amazonka.Core as Core+import qualified Amazonka.Core.Lens.Internal as Lens+import Amazonka.PersonalizeRuntime.Types.PredictedItem+import Amazonka.PersonalizeRuntime.Types.Promotion+import qualified Amazonka.Prelude as Prelude+import qualified Amazonka.Sign.V4 as Sign++-- | API version @2018-05-22@ of the Amazon Personalize Runtime SDK configuration.+defaultService :: Core.Service+defaultService =+ Core.Service+ { Core.abbrev = "PersonalizeRuntime",+ Core.signer = Sign.v4,+ Core.endpointPrefix = "personalize-runtime",+ Core.signingName = "personalize",+ Core.version = "2018-05-22",+ Core.s3AddressingStyle = Core.S3AddressingStyleAuto,+ Core.endpoint = Core.defaultEndpoint defaultService,+ Core.timeout = Prelude.Just 70,+ Core.check = Core.statusSuccess,+ Core.error =+ Core.parseJSONError "PersonalizeRuntime",+ Core.retry = retry+ }+ where+ retry =+ Core.Exponential+ { Core.base = 5.0e-2,+ Core.growth = 2,+ Core.attempts = 5,+ Core.check = check+ }+ check e+ | Lens.has (Core.hasStatus 502) e =+ Prelude.Just "bad_gateway"+ | Lens.has (Core.hasStatus 504) e =+ Prelude.Just "gateway_timeout"+ | Lens.has (Core.hasStatus 500) e =+ Prelude.Just "general_server_error"+ | Lens.has (Core.hasStatus 509) e =+ Prelude.Just "limit_exceeded"+ | Lens.has+ ( Core.hasCode "RequestThrottledException"+ Prelude.. Core.hasStatus 400+ )+ e =+ Prelude.Just "request_throttled_exception"+ | Lens.has (Core.hasStatus 503) e =+ Prelude.Just "service_unavailable"+ | Lens.has+ ( Core.hasCode "ThrottledException"+ Prelude.. Core.hasStatus 400+ )+ e =+ Prelude.Just "throttled_exception"+ | Lens.has+ ( Core.hasCode "Throttling"+ Prelude.. Core.hasStatus 400+ )+ e =+ Prelude.Just "throttling"+ | Lens.has+ ( Core.hasCode "ThrottlingException"+ Prelude.. Core.hasStatus 400+ )+ e =+ Prelude.Just "throttling_exception"+ | Lens.has+ ( Core.hasCode+ "ProvisionedThroughputExceededException"+ Prelude.. Core.hasStatus 400+ )+ e =+ Prelude.Just "throughput_exceeded"+ | Lens.has (Core.hasStatus 429) e =+ Prelude.Just "too_many_requests"+ | Prelude.otherwise = Prelude.Nothing++-- | Provide a valid value for the field or parameter.+_InvalidInputException :: (Core.AsError a) => Lens.Fold a Core.ServiceError+_InvalidInputException =+ Core._MatchServiceError+ defaultService+ "InvalidInputException"+ Prelude.. Core.hasStatus 400++-- | The specified resource does not exist.+_ResourceNotFoundException :: (Core.AsError a) => Lens.Fold a Core.ServiceError+_ResourceNotFoundException =+ Core._MatchServiceError+ defaultService+ "ResourceNotFoundException"+ Prelude.. Core.hasStatus 404
+ gen/Amazonka/PersonalizeRuntime/Types/PredictedItem.hs view
@@ -0,0 +1,104 @@+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE StrictData #-}+{-# LANGUAGE NoImplicitPrelude #-}+{-# 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.Types.PredictedItem+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Amazonka.PersonalizeRuntime.Types.PredictedItem where++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++-- | An object that identifies an item.+--+-- The and APIs return a list of @PredictedItem@s.+--+-- /See:/ 'newPredictedItem' smart constructor.+data PredictedItem = PredictedItem'+ { -- | The recommended item ID.+ itemId :: Prelude.Maybe Prelude.Text,+ -- | The name of the promotion that included the predicted item.+ promotionName :: Prelude.Maybe Prelude.Text,+ -- | A numeric representation of the model\'s certainty that the item will be+ -- the next user selection. For more information on scoring logic, see+ -- how-scores-work.+ score :: Prelude.Maybe Prelude.Double+ }+ deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)++-- |+-- Create a value of 'PredictedItem' 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:+--+-- 'itemId', 'predictedItem_itemId' - The recommended item ID.+--+-- 'promotionName', 'predictedItem_promotionName' - The name of the promotion that included the predicted item.+--+-- 'score', 'predictedItem_score' - A numeric representation of the model\'s certainty that the item will be+-- the next user selection. For more information on scoring logic, see+-- how-scores-work.+newPredictedItem ::+ PredictedItem+newPredictedItem =+ PredictedItem'+ { itemId = Prelude.Nothing,+ promotionName = Prelude.Nothing,+ score = Prelude.Nothing+ }++-- | The recommended item ID.+predictedItem_itemId :: Lens.Lens' PredictedItem (Prelude.Maybe Prelude.Text)+predictedItem_itemId = Lens.lens (\PredictedItem' {itemId} -> itemId) (\s@PredictedItem' {} a -> s {itemId = a} :: PredictedItem)++-- | The name of the promotion that included the predicted item.+predictedItem_promotionName :: Lens.Lens' PredictedItem (Prelude.Maybe Prelude.Text)+predictedItem_promotionName = Lens.lens (\PredictedItem' {promotionName} -> promotionName) (\s@PredictedItem' {} a -> s {promotionName = a} :: PredictedItem)++-- | A numeric representation of the model\'s certainty that the item will be+-- the next user selection. For more information on scoring logic, see+-- how-scores-work.+predictedItem_score :: Lens.Lens' PredictedItem (Prelude.Maybe Prelude.Double)+predictedItem_score = Lens.lens (\PredictedItem' {score} -> score) (\s@PredictedItem' {} a -> s {score = a} :: PredictedItem)++instance Data.FromJSON PredictedItem where+ parseJSON =+ Data.withObject+ "PredictedItem"+ ( \x ->+ PredictedItem'+ Prelude.<$> (x Data..:? "itemId")+ Prelude.<*> (x Data..:? "promotionName")+ Prelude.<*> (x Data..:? "score")+ )++instance Prelude.Hashable PredictedItem where+ hashWithSalt _salt PredictedItem' {..} =+ _salt+ `Prelude.hashWithSalt` itemId+ `Prelude.hashWithSalt` promotionName+ `Prelude.hashWithSalt` score++instance Prelude.NFData PredictedItem where+ rnf PredictedItem' {..} =+ Prelude.rnf itemId+ `Prelude.seq` Prelude.rnf promotionName+ `Prelude.seq` Prelude.rnf score
+ gen/Amazonka/PersonalizeRuntime/Types/Promotion.hs view
@@ -0,0 +1,157 @@+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE StrictData #-}+{-# LANGUAGE NoImplicitPrelude #-}+{-# 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.Types.Promotion+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Amazonka.PersonalizeRuntime.Types.Promotion where++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++-- | Contains information on a promotion. A promotion defines additional+-- business rules that apply to a configurable subset of recommended items.+--+-- /See:/ 'newPromotion' smart constructor.+data Promotion = Promotion'+ { -- | The Amazon Resource Name (ARN) of the filter used by the promotion. This+ -- filter defines the criteria for promoted items. For more information,+ -- see+ -- <https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters Promotion filters>.+ filterArn :: Prelude.Maybe Prelude.Text,+ -- | The values to use when promoting items. For each placeholder parameter+ -- in your promotion\'s 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 on creating filters, see+ -- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering recommendations and user segments>.+ filterValues :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Data.Sensitive Prelude.Text)),+ -- | The name of the promotion.+ name :: Prelude.Maybe Prelude.Text,+ -- | The percentage of recommended items to apply the promotion to.+ percentPromotedItems :: Prelude.Maybe Prelude.Natural+ }+ deriving (Prelude.Eq, Prelude.Show, Prelude.Generic)++-- |+-- Create a value of 'Promotion' 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:+--+-- 'filterArn', 'promotion_filterArn' - The Amazon Resource Name (ARN) of the filter used by the promotion. This+-- filter defines the criteria for promoted items. For more information,+-- see+-- <https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters Promotion filters>.+--+-- 'filterValues', 'promotion_filterValues' - The values to use when promoting items. For each placeholder parameter+-- in your promotion\'s 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 on creating filters, see+-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering recommendations and user segments>.+--+-- 'name', 'promotion_name' - The name of the promotion.+--+-- 'percentPromotedItems', 'promotion_percentPromotedItems' - The percentage of recommended items to apply the promotion to.+newPromotion ::+ Promotion+newPromotion =+ Promotion'+ { filterArn = Prelude.Nothing,+ filterValues = Prelude.Nothing,+ name = Prelude.Nothing,+ percentPromotedItems = Prelude.Nothing+ }++-- | The Amazon Resource Name (ARN) of the filter used by the promotion. This+-- filter defines the criteria for promoted items. For more information,+-- see+-- <https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters Promotion filters>.+promotion_filterArn :: Lens.Lens' Promotion (Prelude.Maybe Prelude.Text)+promotion_filterArn = Lens.lens (\Promotion' {filterArn} -> filterArn) (\s@Promotion' {} a -> s {filterArn = a} :: Promotion)++-- | The values to use when promoting items. For each placeholder parameter+-- in your promotion\'s 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 on creating filters, see+-- <https://docs.aws.amazon.com/personalize/latest/dg/filter.html Filtering recommendations and user segments>.+promotion_filterValues :: Lens.Lens' Promotion (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))+promotion_filterValues = Lens.lens (\Promotion' {filterValues} -> filterValues) (\s@Promotion' {} a -> s {filterValues = a} :: Promotion) Prelude.. Lens.mapping Lens.coerced++-- | The name of the promotion.+promotion_name :: Lens.Lens' Promotion (Prelude.Maybe Prelude.Text)+promotion_name = Lens.lens (\Promotion' {name} -> name) (\s@Promotion' {} a -> s {name = a} :: Promotion)++-- | The percentage of recommended items to apply the promotion to.+promotion_percentPromotedItems :: Lens.Lens' Promotion (Prelude.Maybe Prelude.Natural)+promotion_percentPromotedItems = Lens.lens (\Promotion' {percentPromotedItems} -> percentPromotedItems) (\s@Promotion' {} a -> s {percentPromotedItems = a} :: Promotion)++instance Prelude.Hashable Promotion where+ hashWithSalt _salt Promotion' {..} =+ _salt+ `Prelude.hashWithSalt` filterArn+ `Prelude.hashWithSalt` filterValues+ `Prelude.hashWithSalt` name+ `Prelude.hashWithSalt` percentPromotedItems++instance Prelude.NFData Promotion where+ rnf Promotion' {..} =+ Prelude.rnf filterArn+ `Prelude.seq` Prelude.rnf filterValues+ `Prelude.seq` Prelude.rnf name+ `Prelude.seq` Prelude.rnf percentPromotedItems++instance Data.ToJSON Promotion where+ toJSON Promotion' {..} =+ Data.object+ ( Prelude.catMaybes+ [ ("filterArn" Data..=) Prelude.<$> filterArn,+ ("filterValues" Data..=) Prelude.<$> filterValues,+ ("name" Data..=) Prelude.<$> name,+ ("percentPromotedItems" Data..=)+ Prelude.<$> percentPromotedItems+ ]+ )
+ gen/Amazonka/PersonalizeRuntime/Waiters.hs view
@@ -0,0 +1,24 @@+{-# LANGUAGE DisambiguateRecordFields #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE StrictData #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE NoImplicitPrelude #-}+{-# OPTIONS_GHC -fno-warn-unused-imports #-}++-- Derived from AWS service descriptions, licensed under Apache 2.0.++-- |+-- Module : Amazonka.PersonalizeRuntime.Waiters+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Amazonka.PersonalizeRuntime.Waiters where++import qualified Amazonka.Core as Core+import qualified Amazonka.Core.Lens.Internal as Lens+import qualified Amazonka.Data as Data+import Amazonka.PersonalizeRuntime.Lens+import Amazonka.PersonalizeRuntime.Types+import qualified Amazonka.Prelude as Prelude
+ src/.gitkeep view
+ test/Main.hs view
@@ -0,0 +1,23 @@+{-# OPTIONS_GHC -fno-warn-unused-imports #-}++-- |+-- Module : Main+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Main (main) where++import Test.Amazonka.PersonalizeRuntime+import Test.Amazonka.PersonalizeRuntime.Internal+import Test.Tasty++main :: IO ()+main =+ defaultMain $+ testGroup+ "PersonalizeRuntime"+ [ testGroup "tests" tests,+ testGroup "fixtures" fixtures+ ]
+ test/Test/Amazonka/Gen/PersonalizeRuntime.hs view
@@ -0,0 +1,78 @@+{-# OPTIONS_GHC -fno-warn-orphans #-}+{-# OPTIONS_GHC -fno-warn-unused-imports #-}++-- Derived from AWS service descriptions, licensed under Apache 2.0.++-- |+-- Module : Test.Amazonka.Gen.PersonalizeRuntime+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Test.Amazonka.Gen.PersonalizeRuntime where++import Amazonka.PersonalizeRuntime+import qualified Data.Proxy as Proxy+import Test.Amazonka.Fixture+import Test.Amazonka.PersonalizeRuntime.Internal+import Test.Amazonka.Prelude+import Test.Tasty++-- Auto-generated: the actual test selection needs to be manually placed into+-- the top-level so that real test data can be incrementally added.+--+-- This commented snippet is what the entire set should look like:++-- fixtures :: TestTree+-- fixtures =+-- [ testGroup "request"+-- [ requestGetPersonalizedRanking $+-- newGetPersonalizedRanking+--+-- , requestGetRecommendations $+-- newGetRecommendations+--+-- ]++-- , testGroup "response"+-- [ responseGetPersonalizedRanking $+-- newGetPersonalizedRankingResponse+--+-- , responseGetRecommendations $+-- newGetRecommendationsResponse+--+-- ]+-- ]++-- Requests++requestGetPersonalizedRanking :: GetPersonalizedRanking -> TestTree+requestGetPersonalizedRanking =+ req+ "GetPersonalizedRanking"+ "fixture/GetPersonalizedRanking.yaml"++requestGetRecommendations :: GetRecommendations -> TestTree+requestGetRecommendations =+ req+ "GetRecommendations"+ "fixture/GetRecommendations.yaml"++-- Responses++responseGetPersonalizedRanking :: GetPersonalizedRankingResponse -> TestTree+responseGetPersonalizedRanking =+ res+ "GetPersonalizedRankingResponse"+ "fixture/GetPersonalizedRankingResponse.proto"+ defaultService+ (Proxy.Proxy :: Proxy.Proxy GetPersonalizedRanking)++responseGetRecommendations :: GetRecommendationsResponse -> TestTree+responseGetRecommendations =+ res+ "GetRecommendationsResponse"+ "fixture/GetRecommendationsResponse.proto"+ defaultService+ (Proxy.Proxy :: Proxy.Proxy GetRecommendations)
+ test/Test/Amazonka/PersonalizeRuntime.hs view
@@ -0,0 +1,20 @@+-- |+-- Module : Test.Amazonka.PersonalizeRuntime+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Test.Amazonka.PersonalizeRuntime+ ( tests,+ fixtures,+ )+where++import Test.Tasty (TestTree)++tests :: [TestTree]+tests = []++fixtures :: [TestTree]+fixtures = []
+ test/Test/Amazonka/PersonalizeRuntime/Internal.hs view
@@ -0,0 +1,8 @@+-- |+-- Module : Test.Amazonka.PersonalizeRuntime.Internal+-- Copyright : (c) 2013-2023 Brendan Hay+-- License : Mozilla Public License, v. 2.0.+-- Maintainer : Brendan Hay+-- Stability : auto-generated+-- Portability : non-portable (GHC extensions)+module Test.Amazonka.PersonalizeRuntime.Internal where