CustomerProfiles / Client / list_recommender_filters

list_recommender_filters

CustomerProfiles.Client.list_recommender_filters(**kwargs)

Returns a list of recommender filters in the specified domain.

See also: AWS API Documentation

Request Syntax

response = client.list_recommender_filters(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • MaxResults (integer) – The maximum number of recommender filters to return in the response. The default value is 100.

  • NextToken (string) – A token received from a previous ListRecommenderFilters call to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      A token to retrieve the next page of results. Null if there are no more results to retrieve.

    • RecommenderFilters (list) –

      A list of recommender filters and their properties in the specified domain.

      • (dict) –

        Provides a summary of a recommender filter’s configuration and current state.

        • RecommenderFilterName (string) –

          The name of the recommender filter.

        • RecommenderSchemaName (string) –

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

        • RecommenderFilterExpression (string) –

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

        • CreatedAt (datetime) –

          The timestamp when the recommender filter was created.

        • Description (string) –

          A description of the recommender filter’s purpose and characteristics.

        • Status (string) –

          The current operational status of the recommender filter.

        • FailureReason (string) –

          If the recommender filter is in a failed state, provides the reason for the failure.

        • Tags (dict) –

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

          • (string) –

            • (string) –

Exceptions