CustomerProfiles / Client / list_recommender_schemas

list_recommender_schemas

CustomerProfiles.Client.list_recommender_schemas(**kwargs)

Returns a list of recommender schemas in the specified domain.

See also: AWS API Documentation

Request Syntax

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

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • 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.

Exceptions