Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRecommender

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

Request Syntax


PATCH /domains/DomainName/recommenders/RecommenderName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "RecommenderConfig": { 
      "EventsConfig": { 
         "EventParametersList": [ 
            { 
               "EventType": "string",
               "EventValueThreshold": number
            }
         ]
      },
      "TrainingFrequency": number
   }
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

RecommenderName

The name of the recommender to update.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The new description to assign to the recommender.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

RecommenderConfig

The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior.

Type: RecommenderConfig object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RecommenderName": "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.

RecommenderName

The name of the recommender that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429