CustomerProfiles / Paginator / ListRecommenderFilters

ListRecommenderFilters¶

class CustomerProfiles.Paginator.ListRecommenderFilters¶

paginator = client.get_paginator('list_recommender_filters')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CustomerProfiles.Client.list_recommender_filters().

Request Syntax

response_iterator = paginator.paginate(
    DomainName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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) –
- 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) –