recommender_filters

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

Overview

Name	recommender_filters
Type	Resource
Id	aws.customer_profiles.recommender_filters

Fields

The following fields are returned by SELECT queries:

get_recommender_filter

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the recommender filter was created.
description	string	The description of the recommender filter.
failure_reason	string	If the recommender filter failed, provides the reason for the failure.
recommender_filter_expression	string	The filter expression that defines which items to include or exclude from recommendations.
recommender_filter_name	string	The name of the recommender filter. (pattern: <code>[a-zA-Z0-9_-]+</code>)
recommender_schema_name	string	The name of the recommender schema associated with this recommender filter. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
status	string	The status of the recommender filter. (ACTIVE, PENDING, IN_PROGRESS, FAILED, DELETING)
tags	object	The tags used to organize, track, or control access for this resource.

list_recommender_filters

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the recommender filter was created.
description	string	A description of the recommender filter's purpose and characteristics.
failure_reason	string	If the recommender filter is in a failed state, provides the reason for the failure.
recommender_filter_expression	string	The filter expression that defines which items to include or exclude from recommendations.
recommender_filter_name	string	The name of the recommender filter. (pattern: <code>[a-zA-Z0-9_-]+</code>)
recommender_schema_name	string	The name of the recommender schema associated with this recommender filter. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
status	string	The current operational status of the recommender filter. (ACTIVE, PENDING, IN_PROGRESS, FAILED, 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_filter	select	domain_name, recommender_filter_name, region		Retrieves information about a specific recommender filter in a domain.
list_recommender_filters	select	domain_name, region	max-results, next-token	Returns a list of recommender filters in the specified domain.
create_recommender_filter	insert	domain_name, recommender_filter_name, region, RecommenderFilterExpression		Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.
delete_recommender_filter	delete	domain_name, recommender_filter_name, region		Deletes a recommender filter from a domain.

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_filter_name	string	The name of the recommender filter to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of recommender filters to return in the response. The default value is 100.
next-token	string	A token received from a previous ListRecommenderFilters call to retrieve the next page of results.

SELECT examples

get_recommender_filter

Retrieves information about a specific recommender filter in a domain.

SELECT
created_at,
description,
failure_reason,
recommender_filter_expression,
recommender_filter_name,
recommender_schema_name,
status,
tags
FROM aws.customer_profiles.recommender_filters
WHERE domain_name = '{{ domain_name }}' -- required
AND recommender_filter_name = '{{ recommender_filter_name }}' -- required
AND region = '{{ region }}' -- required
;

list_recommender_filters

Returns a list of recommender filters in the specified domain.

SELECT
created_at,
description,
failure_reason,
recommender_filter_expression,
recommender_filter_name,
recommender_schema_name,
status,
tags
FROM aws.customer_profiles.recommender_filters
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_recommender_filter

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

INSERT INTO aws.customer_profiles.recommender_filters (
RecommenderFilterExpression,
RecommenderSchemaName,
Description,
Tags,
domain_name,
recommender_filter_name,
region
)
SELECT 
'{{ RecommenderFilterExpression }}' /* required */,
'{{ RecommenderSchemaName }}',
'{{ Description }}',
'{{ Tags }}',
'{{ domain_name }}',
'{{ recommender_filter_name }}',
'{{ region }}'
RETURNING
recommender_filter_arn,
tags
;

Manifest

# Description fields are for documentation purposes
- name: recommender_filters
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the recommender_filters resource.
  - name: recommender_filter_name
    value: "{{ recommender_filter_name }}"
    description: Required parameter for the recommender_filters resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recommender_filters resource.
  - name: RecommenderFilterExpression
    value: "{{ RecommenderFilterExpression }}"
  - name: RecommenderSchemaName
    value: "{{ RecommenderSchemaName }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_recommender_filter

Deletes a recommender filter from a domain.

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