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