| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.PersonalizeRuntime
Description
Derived from API version 2018-05-22 of the AWS service descriptions, licensed under Apache 2.0.
Synopsis
- defaultService :: Service
- _InvalidInputException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data GetPersonalizedRanking = GetPersonalizedRanking' (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) Text [Text] Text
- newGetPersonalizedRanking :: Text -> Text -> GetPersonalizedRanking
- data GetPersonalizedRankingResponse = GetPersonalizedRankingResponse' (Maybe [PredictedItem]) (Maybe Text) Int
- newGetPersonalizedRankingResponse :: Int -> GetPersonalizedRankingResponse
- data GetRecommendations = GetRecommendations' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe Natural) (Maybe [Promotion]) (Maybe Text) (Maybe Text)
- newGetRecommendations :: GetRecommendations
- data GetRecommendationsResponse = GetRecommendationsResponse' (Maybe [PredictedItem]) (Maybe Text) Int
- newGetRecommendationsResponse :: Int -> GetRecommendationsResponse
- data PredictedItem = PredictedItem' (Maybe Text) (Maybe Text) (Maybe Double)
- newPredictedItem :: PredictedItem
- data Promotion = Promotion' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe Natural)
- newPromotion :: Promotion
Service Configuration
defaultService :: Service Source #
API version 2018-05-22 of the Amazon Personalize Runtime SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by PersonalizeRuntime.
InvalidInputException
_InvalidInputException :: AsError a => Fold a ServiceError Source #
Provide a valid value for the field or parameter.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
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.
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.
GetPersonalizedRanking
data GetPersonalizedRanking Source #
See: newGetPersonalizedRanking smart constructor.
Constructors
| GetPersonalizedRanking' (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) Text [Text] Text |
Instances
newGetPersonalizedRanking Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetPersonalizedRanking |
Create a value of GetPersonalizedRanking with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:context:GetPersonalizedRanking', 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.
GetPersonalizedRanking, 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
Filtering Recommendations.
GetPersonalizedRanking, 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 Filtering Recommendations.
$sel:campaignArn:GetPersonalizedRanking', getPersonalizedRanking_campaignArn - The Amazon Resource Name (ARN) of the campaign to use for generating the
personalized ranking.
$sel:inputList:GetPersonalizedRanking', 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.
$sel:userId:GetPersonalizedRanking', getPersonalizedRanking_userId - The user for which you want the campaign to provide a personalized
ranking.
data GetPersonalizedRankingResponse Source #
See: newGetPersonalizedRankingResponse smart constructor.
Constructors
| GetPersonalizedRankingResponse' (Maybe [PredictedItem]) (Maybe Text) Int |
Instances
newGetPersonalizedRankingResponse Source #
Create a value of GetPersonalizedRankingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:personalizedRanking:GetPersonalizedRankingResponse', getPersonalizedRankingResponse_personalizedRanking - A list of items in order of most likely interest to the user. The
maximum is 500.
$sel:recommendationId:GetPersonalizedRankingResponse', getPersonalizedRankingResponse_recommendationId - The ID of the recommendation.
$sel:httpStatus:GetPersonalizedRankingResponse', getPersonalizedRankingResponse_httpStatus - The response's http status code.
GetRecommendations
data GetRecommendations Source #
See: newGetRecommendations smart constructor.
Constructors
| GetRecommendations' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe Natural) (Maybe [Promotion]) (Maybe Text) (Maybe Text) |
Instances
newGetRecommendations :: GetRecommendations Source #
Create a value of GetRecommendations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignArn:GetRecommendations', getRecommendations_campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting
recommendations.
$sel:context:GetRecommendations', 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.
GetRecommendations, getRecommendations_filterArn - The ARN of the filter to apply to the returned recommendations. For more
information, see
Filtering Recommendations.
When using this parameter, be sure the filter resource is ACTIVE.
GetRecommendations, 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 Filtering recommendations and user segments.
GetRecommendations, getRecommendations_itemId - The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
$sel:numResults:GetRecommendations', getRecommendations_numResults - The number of results to return. The default is 25. The maximum is 500.
$sel:promotions:GetRecommendations', 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.
$sel:recommenderArn:GetRecommendations', 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.
$sel:userId:GetRecommendations', getRecommendations_userId - The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
data GetRecommendationsResponse Source #
See: newGetRecommendationsResponse smart constructor.
Constructors
| GetRecommendationsResponse' (Maybe [PredictedItem]) (Maybe Text) Int |
Instances
newGetRecommendationsResponse Source #
Create a value of GetRecommendationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemList:GetRecommendationsResponse', getRecommendationsResponse_itemList - A list of recommendations sorted in descending order by prediction
score. There can be a maximum of 500 items in the list.
$sel:recommendationId:GetRecommendationsResponse', getRecommendationsResponse_recommendationId - The ID of the recommendation.
$sel:httpStatus:GetRecommendationsResponse', getRecommendationsResponse_httpStatus - The response's http status code.
Types
PredictedItem
data PredictedItem Source #
An object that identifies an item.
The and APIs return a list of PredictedItems.
See: newPredictedItem smart constructor.
Instances
newPredictedItem :: PredictedItem Source #
Create a value of PredictedItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemId:PredictedItem', predictedItem_itemId - The recommended item ID.
$sel:promotionName:PredictedItem', predictedItem_promotionName - The name of the promotion that included the predicted item.
$sel:score:PredictedItem', 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.
Promotion
Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.
See: newPromotion smart constructor.
Constructors
| Promotion' (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe Natural) |
Instances
newPromotion :: Promotion Source #
Create a value of Promotion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterArn:Promotion', 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
Promotion filters.
$sel:filterValues:Promotion', 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 Filtering recommendations and user segments.
$sel:name:Promotion', promotion_name - The name of the promotion.
$sel:percentPromotedItems:Promotion', promotion_percentPromotedItems - The percentage of recommended items to apply the promotion to.