CustomerProfiles / Client / create_recommender_filter

create_recommender_filter

CustomerProfiles.Client.create_recommender_filter(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_recommender_filter(
    DomainName='string',
    RecommenderFilterName='string',
    RecommenderFilterExpression='string',
    RecommenderSchemaName='string',
    Description='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • RecommenderFilterName (string) –

    [REQUIRED]

    The name of the recommender filter. The name must be unique within the domain.

  • RecommenderFilterExpression (string) –

    [REQUIRED]

    The filter expression that defines which items to include or exclude from recommendations.

  • RecommenderSchemaName (string) – The name of the recommender schema to use for this recommender filter. If not specified, the default schema is used.

  • Description (string) – A description of the recommender filter.

  • Tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RecommenderFilterArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • RecommenderFilterArn (string) –

      The Amazon Resource Name (ARN) of the recommender filter.

    • Tags (dict) –

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

      • (string) –

        • (string) –

Exceptions