UpdateRecommender
Updates the recommender to modify the recommender configuration.
If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of
the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender
uses the previous configuration until the update completes.
To track the status of this update,
use the latestRecommenderUpdate returned in the DescribeRecommender
operation.
Request Syntax
{
"recommenderArn": "string",
"recommenderConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"minRecommendationRequestsPerSecond": number,
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
}
}
}
}Request Parameters
The request accepts the following data in JSON format.
- recommenderArn
-
The Amazon Resource Name (ARN) of the recommender to modify.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+Required: Yes
- recommenderConfig
-
The configuration details of the recommender.
Type: RecommenderConfig object
Required: Yes
Response Syntax
{
"recommenderArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- recommenderArn
-
The same recommender Amazon Resource Name (ARN) as given in the request.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Errors
- InvalidInputException
-
Provide a valid value for the field or parameter.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is in use.
HTTP Status Code: 400
- ResourceNotFoundException
-
Could not find the specified resource.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
