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

CreateRecommender

Creates a recommender

Request Syntax


POST /domains/DomainName/recommenders/RecommenderName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "RecommenderConfig": { 
      "EventsConfig": { 
         "EventParametersList": [ 
            { 
               "EventType": "string",
               "EventValueThreshold": number
            }
         ]
      },
      "TrainingFrequency": number
   },
   "RecommenderRecipeName": "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

RecommenderName

The name of the recommender.

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.

Description

The description of the domain object type.

Type: String

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

Required: No

RecommenderConfig

The recommender configuration.

Type: RecommenderConfig object

Required: No

RecommenderRecipeName

The name of the recommeder recipe.

Type: String

Valid Values: recommended-for-you | similar-items | frequently-paired-items | popular-items | trending-now

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

{
   "RecommenderArn": "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.

RecommenderArn

The ARN of the recommender

Type: String

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

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