CustomerProfiles / Client / update_recommender

update_recommender

CustomerProfiles.Client.update_recommender(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_recommender(
    DomainName='string',
    RecommenderName='string',
    Description='string',
    RecommenderConfig={
        'EventsConfig': {
            'EventParametersList': [
                {
                    'EventType': 'string',
                    'EventValueThreshold': 123.0
                },
            ]
        },
        'TrainingFrequency': 123
    }
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• RecommenderName (string) –

  [REQUIRED]

  The name of the recommender to update.

• Description (string) – The new description to assign to the recommender.

• RecommenderConfig (dict) –

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

  • EventsConfig (dict) – [REQUIRED]

    Configuration settings for how the recommender processes and uses events.

    • EventParametersList (list) – [REQUIRED]

      A list of event parameters configurations that specify how different event types should be handled.

      • (dict) –

        Configuration parameters for events in the personalization system.

        • EventType (string) – [REQUIRED]

          The type of event being tracked (e.g., ‘click’, ‘purchase’, ‘view’).

        • EventValueThreshold (float) –

          The minimum value threshold that an event must meet to be considered valid.

  • TrainingFrequency (integer) –

    How often the recommender should retrain its model with new data.

Return type:

dict

Returns:

Response Syntax

{
    'RecommenderName': 'string'
}

Response Structure

• (dict) –

  • RecommenderName (string) –

    The name of the recommender that was updated.

Exceptions

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.InternalServerException

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.AccessDeniedException