Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateRecommenderSchema

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Request Syntax


POST /domains/DomainName/recommender-schemas/RecommenderSchemaName HTTP/1.1
Content-type: application/json

{
   "Fields": { 
      "string" : [ 
         { 
            "ContentType": "string",
            "FeatureType": "string",
            "TargetFieldName": "string"
         }
      ]
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

RecommenderSchemaName

The name of the recommender schema. The name must be unique within the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Fields

A map of dataset type to column definitions that specifies which data columns to include in the schema. Currently only the _webAnalytics key is supported.

Type: String to array of RecommenderSchemaField objects map

Map Entries: Maximum number of 1 item.

Array Members: Minimum number of 1 item. Maximum number of 9 items.

Required: Yes

Tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Fields": { 
      "string" : [ 
         { 
            "ContentType": "string",
            "FeatureType": "string",
            "TargetFieldName": "string"
         }
      ]
   },
   "RecommenderSchemaArn": "string",
   "RecommenderSchemaName": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

The timestamp of when the recommender schema was created.

Type: Timestamp

Fields

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

Type: String to array of RecommenderSchemaField objects map

Map Entries: Maximum number of 1 item.

Array Members: Minimum number of 1 item. Maximum number of 9 items.

RecommenderSchemaArn

The Amazon Resource Name (ARN) of the recommender schema.

Type: String

Pattern: arn:([a-z\d-]+):profile:.*:.*:.+

RecommenderSchemaName

The name of the recommender schema.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Status

The status of the recommender schema.

Type: String

Valid Values: ACTIVE | DELETING

Tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429