CreateRecommenderFilter
Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.
Request Syntax
POST /domains/DomainName/recommender-filters/RecommenderFilterName HTTP/1.1
Content-type: application/json
{
"Description": "string",
"RecommenderFilterExpression": "string",
"RecommenderSchemaName": "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
- RecommenderFilterName
-
The name of the recommender filter. The name must be unique within the domain.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- Description
-
A description of the recommender filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- RecommenderFilterExpression
-
The filter expression that defines which items to include or exclude from recommendations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2500.
Required: Yes
- RecommenderSchemaName
-
The name of the recommender schema to use for this recommender filter. If not specified, the default schema is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$Required: No
- 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
{
"RecommenderFilterArn": "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.
- RecommenderFilterArn
-
The Amazon Resource Name (ARN) of the recommender filter.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
