| 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.Personalize.CreateRecommender
Description
Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
When you create a recommender, you can configure the recommender's
minimum recommendation requests per second. The minimum recommendation
requests per second (minRecommendationRequestsPerSecond) specifies the
baseline recommendation request throughput provisioned by Amazon
Personalize. The default minRecommendationRequestsPerSecond is 1. A
recommendation request is a single GetRecommendations operation.
Request throughput is measured in requests per second and Amazon
Personalize uses your requests per second to derive your requests per
hour and the price of your recommender usage.
If your requests per second increases beyond
minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the
provisioned capacity up and down, but never below
minRecommendationRequestsPerSecond. There's a short time delay while
the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based
on minRecommendationRequestsPerSecond) or the actual number of requests.
The actual request throughput used is calculated as the average
requests/second within a one-hour window. We recommend starting with
the default minRecommendationRequestsPerSecond, track your usage using
Amazon CloudWatch metrics, and then increase the
minRecommendationRequestsPerSecond as necessary.
Status
A recommender can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
- DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the
recommender for recommendations.
Related APIs
Synopsis
- data CreateRecommender = CreateRecommender' {
- recommenderConfig :: Maybe RecommenderConfig
- tags :: Maybe [Tag]
- name :: Text
- datasetGroupArn :: Text
- recipeArn :: Text
- newCreateRecommender :: Text -> Text -> Text -> CreateRecommender
- createRecommender_recommenderConfig :: Lens' CreateRecommender (Maybe RecommenderConfig)
- createRecommender_tags :: Lens' CreateRecommender (Maybe [Tag])
- createRecommender_name :: Lens' CreateRecommender Text
- createRecommender_datasetGroupArn :: Lens' CreateRecommender Text
- createRecommender_recipeArn :: Lens' CreateRecommender Text
- data CreateRecommenderResponse = CreateRecommenderResponse' {
- recommenderArn :: Maybe Text
- httpStatus :: Int
- newCreateRecommenderResponse :: Int -> CreateRecommenderResponse
- createRecommenderResponse_recommenderArn :: Lens' CreateRecommenderResponse (Maybe Text)
- createRecommenderResponse_httpStatus :: Lens' CreateRecommenderResponse Int
Creating a Request
data CreateRecommender Source #
See: newCreateRecommender smart constructor.
Constructors
| CreateRecommender' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateRecommender |
Create a value of CreateRecommender 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:
CreateRecommender, createRecommender_recommenderConfig - The configuration details of the recommender.
$sel:tags:CreateRecommender', createRecommender_tags - A list of
tags
to apply to the recommender.
CreateRecommender, createRecommender_name - The name of the recommender.
CreateRecommender, createRecommender_datasetGroupArn - The Amazon Resource Name (ARN) of the destination domain dataset group
for the recommender.
CreateRecommender, createRecommender_recipeArn - The Amazon Resource Name (ARN) of the recipe that the recommender will
use. For a recommender, a recipe is a Domain dataset group use case.
Only Domain dataset group use cases can be used to create a recommender.
For information about use cases see
Choosing recommender use cases.
Request Lenses
createRecommender_recommenderConfig :: Lens' CreateRecommender (Maybe RecommenderConfig) Source #
The configuration details of the recommender.
createRecommender_tags :: Lens' CreateRecommender (Maybe [Tag]) Source #
A list of tags to apply to the recommender.
createRecommender_name :: Lens' CreateRecommender Text Source #
The name of the recommender.
createRecommender_datasetGroupArn :: Lens' CreateRecommender Text Source #
The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
createRecommender_recipeArn :: Lens' CreateRecommender Text Source #
The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
Destructuring the Response
data CreateRecommenderResponse Source #
See: newCreateRecommenderResponse smart constructor.
Constructors
| CreateRecommenderResponse' | |
Fields
| |
Instances
newCreateRecommenderResponse Source #
Create a value of CreateRecommenderResponse 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:
CreateRecommenderResponse, createRecommenderResponse_recommenderArn - The Amazon Resource Name (ARN) of the recommender.
$sel:httpStatus:CreateRecommenderResponse', createRecommenderResponse_httpStatus - The response's http status code.
Response Lenses
createRecommenderResponse_recommenderArn :: Lens' CreateRecommenderResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the recommender.
createRecommenderResponse_httpStatus :: Lens' CreateRecommenderResponse Int Source #
The response's http status code.