CustomerProfiles / Paginator / ListRecommenderSchemas

ListRecommenderSchemas

class CustomerProfiles.Paginator.ListRecommenderSchemas

paginator = client.get_paginator('list_recommender_schemas')

paginate(**kwargs)

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

See also: AWS API Documentation

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

{
    'RecommenderSchemas': [
        {
            'RecommenderSchemaName': 'string',
            'Fields': {
                'string': [
                    {
                        'TargetFieldName': 'string',
                        'ContentType': 'STRING'|'NUMBER',
                        'FeatureType': 'TEXTUAL'|'CATEGORICAL'
                    },
                ]
            },
            'CreatedAt': datetime(2015, 1, 1),
            'Status': 'ACTIVE'|'DELETING'
        },
    ]
}

Response Structure

• (dict) –

  • RecommenderSchemas (list) –

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

    • (dict) –

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

      • RecommenderSchemaName (string) –

        The name of the recommender schema.

      • Fields (dict) –

        A map of dataset type to column definitions included in the schema.

        • (string) –

          • (list) –

            • (dict) –

              Defines a column in a recommender schema, including the target field name and optional feature and content type settings for training.

              • TargetFieldName (string) –

                The name of the target field in the dataset, such as Location.City or Attributes.MealTime.

              • ContentType (string) –

                The data type of the column value. Valid values are String and Number. The default value is String.

              • FeatureType (string) –

                How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL.

      • CreatedAt (datetime) –

        The timestamp when the recommender schema was created.

      • Status (string) –

        The current operational status of the recommender schema.