CustomerProfiles / Client / get_recommender_filter

get_recommender_filter

CustomerProfiles.Client.get_recommender_filter(**kwargs)

Retrieves information about a specific recommender filter in a domain.

See also: AWS API Documentation

Request Syntax

response = client.get_recommender_filter(
    DomainName='string',
    RecommenderFilterName='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • RecommenderFilterName (string) –

    [REQUIRED]

    The name of the recommender filter to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'RecommenderFilterName': 'string',
    'RecommenderFilterExpression': 'string',
    'RecommenderSchemaName': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Status': 'ACTIVE'|'PENDING'|'IN_PROGRESS'|'FAILED'|'DELETING',
    'Description': 'string',
    'FailureReason': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • RecommenderFilterName (string) –

      The name of the recommender filter.

    • RecommenderFilterExpression (string) –

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

    • RecommenderSchemaName (string) –

      The name of the recommender schema associated with this recommender filter.

    • CreatedAt (datetime) –

      The timestamp of when the recommender filter was created.

    • Status (string) –

      The status of the recommender filter.

    • Description (string) –

      The description of the recommender filter.

    • FailureReason (string) –

      If the recommender filter failed, provides the reason for the failure.

    • Tags (dict) –

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

      • (string) –

        • (string) –

Exceptions