CreateRecommenderConfiguration class
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Constructors
-
CreateRecommenderConfiguration({required String recommendationProviderRoleArn, required String recommendationProviderUri, Map<
String, String> ? attributes, String? description, String? name, String? recommendationProviderIdType, String? recommendationTransformerUri, String? recommendationsDisplayName, int? recommendationsPerMessage})
Properties
-
attributes
→ Map<
String, String> ? -
A map of key-value pairs that defines 1-10 custom endpoint or user
attributes, depending on the value for the RecommendationProviderIdType
property. Each of these attributes temporarily stores a recommended item
that's retrieved from the recommender model and sent to an AWS Lambda
function for additional processing. Each attribute can be used as a message
variable in a message template.
final
- description → String?
-
A custom description of the configuration for the recommender model. The
description can contain up to 128 characters. The characters can be letters,
numbers, spaces, or the following symbols: _ ; () , ‐.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String?
-
A custom name of the configuration for the recommender model. The name must
start with a letter or number and it can contain up to 128 characters. The
characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
final
- recommendationProviderIdType → String?
-
The type of Amazon Pinpoint ID to associate with unique user IDs in the
recommender model. This value enables the model to use attribute and event
data that’s specific to a particular endpoint or user in an Amazon Pinpoint
application. Valid values are:
final
- recommendationProviderRoleArn → String
-
The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
from the recommender model.
final
- recommendationProviderUri → String
-
The Amazon Resource Name (ARN) of the recommender model to retrieve
recommendation data from. This value must match the ARN of an Amazon
Personalize campaign.
final
- recommendationsDisplayName → String?
-
A custom display name for the standard endpoint or user attribute
(RecommendationItems) that temporarily stores recommended items for each
endpoint or user, depending on the value for the
RecommendationProviderIdType property. This value is required if the
configuration doesn't invoke an AWS Lambda function
(RecommendationTransformerUri) to perform additional processing of
recommendation data.
final
- recommendationsPerMessage → int?
-
The number of recommended items to retrieve from the model for each endpoint
or user, depending on the value for the RecommendationProviderIdType
property. This number determines how many recommended items are available
for use in message variables. The minimum value is 1. The maximum value is
5. The default value is 5.
final
- recommendationTransformerUri → String?
-
The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke
for additional processing of recommendation data that's retrieved from the
recommender model.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited