| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PersonalizeEvents::Event; | ||
| 3 | use Moose; | ||
| 4 | has EventId => (is => 'ro', isa => 'Str', request_name => 'eventId', traits => ['NameInRequest']); | ||
| 5 | has EventType => (is => 'ro', isa => 'Str', request_name => 'eventType', traits => ['NameInRequest'], required => 1); | ||
| 6 | has EventValue => (is => 'ro', isa => 'Num', request_name => 'eventValue', traits => ['NameInRequest']); | ||
| 7 | has Impression => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'impression', traits => ['NameInRequest']); | ||
| 8 | has ItemId => (is => 'ro', isa => 'Str', request_name => 'itemId', traits => ['NameInRequest']); | ||
| 9 | has Properties => (is => 'ro', isa => 'Str', request_name => 'properties', traits => ['NameInRequest']); | ||
| 10 | has RecommendationId => (is => 'ro', isa => 'Str', request_name => 'recommendationId', traits => ['NameInRequest']); | ||
| 11 | has SentAt => (is => 'ro', isa => 'Str', request_name => 'sentAt', traits => ['NameInRequest'], required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::PersonalizeEvents::Event | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::PersonalizeEvents::Event object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { EventId => $value, ..., SentAt => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::PersonalizeEvents::Event object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->EventId | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Represents user interaction event information sent using the | ||
| 44 | C<PutEvents> API. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 EventId => Str | ||
| 50 | |||
| 51 | An ID associated with the event. If an event ID is not provided, Amazon | ||
| 52 | Personalize generates a unique ID for the event. An event ID is not | ||
| 53 | used as an input to the model. Amazon Personalize uses the event ID to | ||
| 54 | distinquish unique events. Any subsequent events after the first with | ||
| 55 | the same event ID are not used in model training. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> EventType => Str | ||
| 59 | |||
| 60 | The type of event, such as click or download. This property corresponds | ||
| 61 | to the C<EVENT_TYPE> field of your Interactions schema and depends on | ||
| 62 | the types of events you are tracking. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 EventValue => Num | ||
| 66 | |||
| 67 | The event value that corresponds to the C<EVENT_VALUE> field of the | ||
| 68 | Interactions schema. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Impression => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | A list of item IDs that represents the sequence of items you have shown | ||
| 74 | the user. For example, C<["itemId1", "itemId2", "itemId3"]>. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 ItemId => Str | ||
| 78 | |||
| 79 | The item ID key that corresponds to the C<ITEM_ID> field of the | ||
| 80 | Interactions schema. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Properties => Str | ||
| 84 | |||
| 85 | A string map of event-specific data that you might choose to record. | ||
| 86 | For example, if a user rates a movie on your site, other than movie ID | ||
| 87 | (C<itemId>) and rating (C<eventValue>) , you might also send the number | ||
| 88 | of movie ratings made by the user. | ||
| 89 | |||
| 90 | Each item in the map consists of a key-value pair. For example, | ||
| 91 | |||
| 92 | C<{"numberOfRatings": "12"}> | ||
| 93 | |||
| 94 | The keys use camel case names that match the fields in the Interactions | ||
| 95 | schema. In the above example, the C<numberOfRatings> would match the | ||
| 96 | 'NUMBER_OF_RATINGS' field defined in the Interactions schema. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 RecommendationId => Str | ||
| 100 | |||
| 101 | The ID of the recommendation. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> SentAt => Str | ||
| 105 | |||
| 106 | The timestamp (in Unix time) on the client side when the event | ||
| 107 | occurred. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, describing an object used in L<Paws::PersonalizeEvents> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |