View a markdown version of this page

AWS::Personalize::Filter - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Personalize::Filter

Contains information on a recommendation filter, including its ARN, status, and filter expression.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Personalize::Filter",
  "Properties" : {
      "DatasetGroupArn" : String,
      "FilterExpression" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Personalize::Filter
Properties:
  DatasetGroupArn: String
  FilterExpression: String
  Name: String
  Tags: 
    - Tag

Properties

DatasetGroupArn

The ARN of the dataset group to which the filter belongs.

Required: Yes

Type: String

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Maximum: 256

Update requires: Replacement

FilterExpression

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 2500

Update requires: Replacement

Name

The name of the filter.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*$

Minimum: 1

Maximum: 63

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreationDateTime

The time at which the filter was created.

FilterArn

The ARN of the filter.

LastUpdatedDateTime

The time at which the filter was last updated.

Status

The status of the filter.