filters

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

Overview

Name	filters
Type	Resource
Id	aws.personalize.filters

Fields

The following fields are returned by SELECT queries:

describe_filter

Name	Datatype	Description
name	string	The name of the filter. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
creation_date_time	string (date-time)	The time at which the filter was created.
dataset_group_arn	string	The ARN of the dataset group to which the filter belongs. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
failure_reason	string	If the filter failed, the reason for its failure.
filter_arn	string	The ARN of the filter. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
filter_expression	string	Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
last_updated_date_time	string (date-time)	The time at which the filter was last updated.
status	string	The status of the filter.

list_filters

Name	Datatype	Description
name	string	The name of the filter. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
creation_date_time	string (date-time)	The time at which the filter was created.
dataset_group_arn	string	The ARN of the dataset group to which the filter belongs. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
failure_reason	string	If the filter failed, the reason for the failure.
filter_arn	string	The ARN of the filter. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
last_updated_date_time	string (date-time)	The time at which the filter was last updated.
status	string	The status of the filter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_filter	select	region		Describes a filter's properties.
list_filters	select	region		Lists all filters that belong to a given dataset group.
create_filter	insert	region, name, datasetGroupArn, filterExpression		Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
delete_filter	delete	region		Deletes a filter.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_filter

Describes a filter's properties.

SELECT
name,
creation_date_time,
dataset_group_arn,
failure_reason,
filter_arn,
filter_expression,
last_updated_date_time,
status
FROM aws.personalize.filters
WHERE region = '{{ region }}' -- required
;

list_filters

Lists all filters that belong to a given dataset group.

SELECT
name,
creation_date_time,
dataset_group_arn,
failure_reason,
filter_arn,
last_updated_date_time,
status
FROM aws.personalize.filters
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_filter

Creates a recommendation filter. For more information, see Filtering recommendations and user segments.

INSERT INTO aws.personalize.filters (
name,
datasetGroupArn,
filterExpression,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ datasetGroupArn }}' /* required */,
'{{ filterExpression }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
filter_arn
;

Manifest

# Description fields are for documentation purposes
- name: filters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the filters resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the filter to create.
  - name: datasetGroupArn
    value: "{{ datasetGroupArn }}"
    description: |
      The ARN of the dataset group that the filter will belong to.
  - name: filterExpression
    value: "{{ filterExpression }}"
    description: |
      The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
  - name: tags
    description: |
      A list of tags to apply to the filter.
    value:
      - tagKey: "{{ tagKey }}"
        tagValue: "{{ tagValue }}"

DELETE examples

delete_filter

Deletes a filter.

DELETE FROM aws.personalize.filters
WHERE region = '{{ region }}' --required
;