CustomerProfiles / Client / create_recommender

create_recommender

CustomerProfiles.Client.create_recommender(**kwargs)

Creates a recommender

See also: AWS API Documentation

Request Syntax

response = client.create_recommender(
    DomainName='string',
    RecommenderName='string',
    RecommenderRecipeName='recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now'|'personalized-ranking',
    RecommenderConfig={
        'EventsConfig': {
            'EventParametersList': [
                {
                    'EventType': 'string',
                    'EventValueThreshold': 123.0,
                    'EventWeight': 123.0
                },
            ]
        },
        'TrainingFrequency': 123,
        'InferenceConfig': {
            'MinProvisionedTPS': 123
        }
    },
    Description='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • RecommenderName (string) –

    [REQUIRED]

    The name of the recommender.

  • RecommenderRecipeName (string) –

    [REQUIRED]

    The name of the recommeder recipe.

  • RecommenderConfig (dict) –

    The recommender configuration.

    • EventsConfig (dict) –

      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.

          • EventWeight (float) –

            The weight of the event type. A higher weight means higher importance of the event type for the created solution.

    • TrainingFrequency (integer) –

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

    • InferenceConfig (dict) –

      Configuration settings for how the recommender handles inference requests.

      • MinProvisionedTPS (integer) –

        The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

  • Description (string) – The description of the domain object type.

  • Tags (dict) –

    The tags used to organize, track, or control access for this resource.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RecommenderArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • RecommenderArn (string) –

      The ARN of the recommender

    • Tags (dict) –

      The tags used to organize, track, or control access for this resource.

      • (string) –

        • (string) –

Exceptions