« blib/lib/Paws/Pinpoint/UpdateRecommenderConfiguration.pm
↑ Summary
blib/lib/Paws/Pinpoint/UpdateRecommenderConfigurationResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::UpdateRecommenderConfigurationObj; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str'); | ||
| 7 | has RecommendationProviderIdType => (is => 'ro', isa => 'Str'); | ||
| 8 | has RecommendationProviderRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has RecommendationProviderUri => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has RecommendationsDisplayName => (is => 'ro', isa => 'Str'); | ||
| 11 | has RecommendationsPerMessage => (is => 'ro', isa => 'Int'); | ||
| 12 | has RecommendationTransformerUri => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::UpdateRecommenderConfigurationObj | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Pinpoint::UpdateRecommenderConfigurationObj object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Attributes => $value, ..., RecommendationTransformerUri => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::UpdateRecommenderConfigurationObj object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Attributes | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Specifies Amazon Pinpoint configuration settings for retrieving and | ||
| 45 | processing recommendation data from a recommender model. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Attributes => L<Paws::Pinpoint::MapOf__string> | ||
| 51 | |||
| 52 | A map of key-value pairs that defines 1-10 custom endpoint or user | ||
| 53 | attributes, depending on the value for the RecommendationProviderIdType | ||
| 54 | property. Each of these attributes temporarily stores a recommended | ||
| 55 | item that's retrieved from the recommender model and sent to an AWS | ||
| 56 | Lambda function for additional processing. Each attribute can be used | ||
| 57 | as a message variable in a message template. | ||
| 58 | |||
| 59 | In the map, the key is the name of a custom attribute and the value is | ||
| 60 | a custom display name for that attribute. The display name appears in | ||
| 61 | the B<Attribute finder> of the template editor on the Amazon Pinpoint | ||
| 62 | console. The following restrictions apply to these names: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | An attribute name must start with a letter or number and it can contain | ||
| 69 | up to 50 characters. The characters can be letters, numbers, | ||
| 70 | underscores (_), or hyphens (-). Attribute names are case sensitive and | ||
| 71 | must be unique. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | An attribute display name must start with a letter or number and it can | ||
| 76 | contain up to 25 characters. The characters can be letters, numbers, | ||
| 77 | spaces, underscores (_), or hyphens (-). | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | This object is required if the configuration invokes an AWS Lambda | ||
| 82 | function (RecommendationTransformerUri) to process recommendation data. | ||
| 83 | Otherwise, don't include this object in your request. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 Description => Str | ||
| 87 | |||
| 88 | A custom description of the configuration for the recommender model. | ||
| 89 | The description can contain up to 128 characters. The characters can be | ||
| 90 | letters, numbers, spaces, or the following symbols: _ ; () , . | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Name => Str | ||
| 94 | |||
| 95 | A custom name of the configuration for the recommender model. The name | ||
| 96 | must start with a letter or number and it can contain up to 128 | ||
| 97 | characters. The characters can be letters, numbers, spaces, underscores | ||
| 98 | (_), or hyphens (-). | ||
| 99 | |||
| 100 | |||
| 101 | =head2 RecommendationProviderIdType => Str | ||
| 102 | |||
| 103 | The type of Amazon Pinpoint ID to associate with unique user IDs in the | ||
| 104 | recommender model. This value enables the model to use attribute and | ||
| 105 | event data thatE<rsquo>s specific to a particular endpoint or user in | ||
| 106 | an Amazon Pinpoint application. Valid values are: | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | PINPOINT_ENDPOINT_ID - Associate each user in the model with a | ||
| 113 | particular endpoint in Amazon Pinpoint. The data is correlated based on | ||
| 114 | endpoint IDs in Amazon Pinpoint. This is the default value. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | PINPOINT_USER_ID - Associate each user in the model with a particular | ||
| 119 | user and endpoint in Amazon Pinpoint. The data is correlated based on | ||
| 120 | user IDs in Amazon Pinpoint. If you specify this value, an endpoint | ||
| 121 | definition in Amazon Pinpoint has to specify both a user ID (UserId) | ||
| 122 | and an endpoint ID. Otherwise, messages wonE<rsquo>t be sent to the | ||
| 123 | user's endpoint. | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> RecommendationProviderRoleArn => Str | ||
| 130 | |||
| 131 | The Amazon Resource Name (ARN) of the AWS Identity and Access | ||
| 132 | Management (IAM) role that authorizes Amazon Pinpoint to retrieve | ||
| 133 | recommendation data from the recommender model. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> RecommendationProviderUri => Str | ||
| 137 | |||
| 138 | The Amazon Resource Name (ARN) of the recommender model to retrieve | ||
| 139 | recommendation data from. This value must match the ARN of an Amazon | ||
| 140 | Personalize campaign. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 RecommendationsDisplayName => Str | ||
| 144 | |||
| 145 | A custom display name for the standard endpoint or user attribute | ||
| 146 | (RecommendationItems) that temporarily stores recommended items for | ||
| 147 | each endpoint or user, depending on the value for the | ||
| 148 | RecommendationProviderIdType property. This value is required if the | ||
| 149 | configuration doesn't invoke an AWS Lambda function | ||
| 150 | (RecommendationTransformerUri) to perform additional processing of | ||
| 151 | recommendation data. | ||
| 152 | |||
| 153 | This name appears in the B<Attribute finder> of the template editor on | ||
| 154 | the Amazon Pinpoint console. The name can contain up to 25 characters. | ||
| 155 | The characters can be letters, numbers, spaces, underscores (_), or | ||
| 156 | hyphens (-). These restrictions don't apply to attribute values. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 RecommendationsPerMessage => Int | ||
| 160 | |||
| 161 | The number of recommended items to retrieve from the model for each | ||
| 162 | endpoint or user, depending on the value for the | ||
| 163 | RecommendationProviderIdType property. This number determines how many | ||
| 164 | recommended items are available for use in message variables. The | ||
| 165 | minimum value is 1. The maximum value is 5. The default value is 5. | ||
| 166 | |||
| 167 | To use multiple recommended items and custom attributes with message | ||
| 168 | variables, you have to use an AWS Lambda function | ||
| 169 | (RecommendationTransformerUri) to perform additional processing of | ||
| 170 | recommendation data. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 RecommendationTransformerUri => Str | ||
| 174 | |||
| 175 | The name or Amazon Resource Name (ARN) of the AWS Lambda function to | ||
| 176 | invoke for additional processing of recommendation data that's | ||
| 177 | retrieved from the recommender model. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head1 SEE ALSO | ||
| 182 | |||
| 183 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 184 | |||
| 185 | =head1 BUGS and CONTRIBUTIONS | ||
| 186 | |||
| 187 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 188 | |||
| 189 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 190 | |||
| 191 | =cut | ||
| 192 |