CustomerProfiles / Client / get_recommender_schema

get_recommender_schema¶

CustomerProfiles.Client.get_recommender_schema(**kwargs)¶

Retrieves information about a specific recommender schema in a domain.

Request Syntax

response = client.get_recommender_schema(
    DomainName='string',
    RecommenderSchemaName='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
RecommenderSchemaName (string) –
[REQUIRED]

The name of the recommender schema to retrieve.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- 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 of when the recommender schema was created.
- Status (string) –
  
  The status of the recommender schema.

Exceptions

CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.InternalServerException
CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.AccessDeniedException