recommenders

Creates, updates, deletes, gets or lists a recommenders resource.

Overview

Name	recommenders
Type	Resource
Id	aws.customer_profiles.recommenders

Fields

The following fields are returned by SELECT queries:

get_recommender

Name	Datatype	Description
active_recommender_version_name	string	The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set. (pattern: <code>[a-zA-Z0-9_-]+/\d{4}-\d{2}-\d{2}T\d{2}-\d{2}-\d{2}Z</code>)
created_at	string (date-time)	The timestamp of when the recommender was created.
description	string	A detailed description of the recommender providing information about its purpose and functionality.
failure_reason	string	If the recommender fails, provides the reason for the failure.
last_updated_at	string (date-time)	The timestamp of when the recommender was edited.
latest_recommender_update	object	Information about the most recent update performed on the recommender, including status and timestamp.
recommender_config	object	Configuration settings that define the behavior and parameters of a recommender.
recommender_name	string	The name of the recommender. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
recommender_recipe_name	string	The name of the recipe used by the recommender to generate recommendations. (recommended-for-you, similar-items, frequently-paired-items, popular-items, trending-now, personalized-ranking)
recommender_schema_name	string	The name of the recommender schema associated with this recommender. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
status	string	The current status of the recommender, indicating whether it is active, creating, updating, or in another state. (PENDING, IN_PROGRESS, ACTIVE, FAILED, STOPPING, INACTIVE, STARTING, DELETING)
tags	object	The tags used to organize, track, or control access for this resource.
training_metrics	array	A set of metrics that provide information about the recommender's training performance and accuracy.

list_recommenders

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the recommender was created.
description	string	A description of the recommender's purpose and characteristics.
failure_reason	string	If the recommender is in a failed state, provides the reason for the failure.
last_updated_at	string (date-time)	The timestamp of when the recommender was edited.
latest_recommender_update	object	Information about the most recent update performed on the recommender, including its status and timing.
recipe_name	string	The name of the recipe used by this recommender. (recommended-for-you, similar-items, frequently-paired-items, popular-items, trending-now, personalized-ranking)
recommender_config	object	Configuration settings that define the behavior and parameters of a recommender.
recommender_name	string	The name of the recommender. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
recommender_schema_name	string	The name of the recommender schema associated with this recommender. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
status	string	The current operational status of the recommender. (PENDING, IN_PROGRESS, ACTIVE, FAILED, STOPPING, INACTIVE, STARTING, DELETING)
tags	object	The tags used to organize, track, or control access for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recommender	select	domain_name, recommender_name, region	training-metrics-count	Retrieves a recommender.
list_recommenders	select	domain_name, region	max-results, next-token	Returns a list of recommenders in the specified domain.
create_recommender	insert	domain_name, recommender_name, region, RecommenderRecipeName		Creates a recommender
update_recommender	update	domain_name, recommender_name, region		Updates the properties of an existing recommender, allowing you to modify its configuration and description.
delete_recommender	delete	domain_name, recommender_name, region		Deletes a recommender.
start_recommender	exec	domain_name, recommender_name, region		Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.
stop_recommender	exec	domain_name, recommender_name, region		Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The unique name of the domain.
recommender_name	string	The name of the recommender to stop.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of recommenders to return in the response. The default value is 100.
next-token	string	A token received from a previous ListRecommenders call to retrieve the next page of results.
training-metrics-count	integer	The number of training metrics to retrieve for the recommender.

SELECT examples

get_recommender

Retrieves a recommender.

SELECT
active_recommender_version_name,
created_at,
description,
failure_reason,
last_updated_at,
latest_recommender_update,
recommender_config,
recommender_name,
recommender_recipe_name,
recommender_schema_name,
status,
tags,
training_metrics
FROM aws.customer_profiles.recommenders
WHERE domain_name = '{{ domain_name }}' -- required
AND recommender_name = '{{ recommender_name }}' -- required
AND region = '{{ region }}' -- required
AND `training-metrics-count` = '{{ training-metrics-count }}'
;

list_recommenders

Returns a list of recommenders in the specified domain.

SELECT
created_at,
description,
failure_reason,
last_updated_at,
latest_recommender_update,
recipe_name,
recommender_config,
recommender_name,
recommender_schema_name,
status,
tags
FROM aws.customer_profiles.recommenders
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_recommender

Creates a recommender

INSERT INTO aws.customer_profiles.recommenders (
RecommenderRecipeName,
RecommenderConfig,
Description,
RecommenderSchemaName,
Tags,
domain_name,
recommender_name,
region
)
SELECT 
'{{ RecommenderRecipeName }}' /* required */,
'{{ RecommenderConfig }}',
'{{ Description }}',
'{{ RecommenderSchemaName }}',
'{{ Tags }}',
'{{ domain_name }}',
'{{ recommender_name }}',
'{{ region }}'
RETURNING
recommender_arn,
tags
;

Manifest

# Description fields are for documentation purposes
- name: recommenders
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the recommenders resource.
  - name: recommender_name
    value: "{{ recommender_name }}"
    description: Required parameter for the recommenders resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recommenders resource.
  - name: RecommenderRecipeName
    value: "{{ RecommenderRecipeName }}"
    valid_values: ['recommended-for-you', 'similar-items', 'frequently-paired-items', 'popular-items', 'trending-now', 'personalized-ranking']
  - name: RecommenderConfig
    description: |
      Configuration settings that define the behavior and parameters of a recommender.
    value:
      EventsConfig:
        EventParametersList:
          - EventType: "{{ EventType }}"
            EventValueThreshold: {{ EventValueThreshold }}
            EventWeight: {{ EventWeight }}
      TrainingFrequency: {{ TrainingFrequency }}
      InferenceConfig:
        MinProvisionedTPS: {{ MinProvisionedTPS }}
      IncludedColumns: "{{ IncludedColumns }}"
      ExcludedColumns: "{{ ExcludedColumns }}"
      DiversityConfig:
        DiversityColumns:
          - Name: "{{ Name }}"
            CapType: "{{ CapType }}"
            Target: "{{ Target }}"
  - name: Description
    value: "{{ Description }}"
  - name: RecommenderSchemaName
    value: "{{ RecommenderSchemaName }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_recommender

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

UPDATE aws.customer_profiles.recommenders
SET 
Description = '{{ Description }}',
RecommenderConfig = '{{ RecommenderConfig }}',
RecommenderVersionName = '{{ RecommenderVersionName }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND recommender_name = '{{ recommender_name }}' --required
AND region = '{{ region }}' --required
RETURNING
recommender_name;

DELETE examples

delete_recommender

Deletes a recommender.

DELETE FROM aws.customer_profiles.recommenders
WHERE domain_name = '{{ domain_name }}' --required
AND recommender_name = '{{ recommender_name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_recommender

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

EXEC aws.customer_profiles.recommenders.start_recommender 
@domain_name='{{ domain_name }}' --required, 
@recommender_name='{{ recommender_name }}' --required, 
@region='{{ region }}' --required
;

stop_recommender

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

EXEC aws.customer_profiles.recommenders.stop_recommender 
@domain_name='{{ domain_name }}' --required, 
@recommender_name='{{ recommender_name }}' --required, 
@region='{{ region }}' --required
;