aws-sdk-perl/auto-lib/Paws/PersonalizeEvents/Event.pm at 49d764e17f5c9aa1f0d27bce347f6000678d7f07 · pplu/aws-sdk-perl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
package Paws::PersonalizeEvents::Event;
  use Moose;
  has EventId => (is => 'ro', isa => 'Str', request_name => 'eventId', traits => ['NameInRequest']);
  has EventType => (is => 'ro', isa => 'Str', request_name => 'eventType', traits => ['NameInRequest'], required => 1);
  has Properties => (is => 'ro', isa => 'Str', request_name => 'properties', traits => ['NameInRequest'], required => 1);
  has SentAt => (is => 'ro', isa => 'Int', request_name => 'sentAt', traits => ['NameInRequest'], required => 1);
1;

### main pod documentation begin ###

=head1 NAME

Paws::PersonalizeEvents::Event

=head1 USAGE

This class represents one of two things:

=head3 Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::PersonalizeEvents::Event object:

  $service_obj->Method(Att1 => { EventId => $value, ..., SentAt => $value  });

=head3 Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::PersonalizeEvents::Event object:

  $result = $service_obj->Method(...);
  $result->Att1->EventId

=head1 DESCRIPTION

Represents user interaction event information sent using the
C<PutEvents> API.

=head1 ATTRIBUTES


=head2 EventId => Str

  An ID associated with the event. If an event ID is not provided, Amazon
Personalize generates a unique ID for the event. An event ID is not
used as an input to the model. Amazon Personalize uses the event ID to
distinquish unique events. Any subsequent events after the first with
the same event ID are not used in model training.


=head2 B<REQUIRED> EventType => Str

  The type of event. This property corresponds to the C<EVENT_TYPE> field
of the Interactions schema.


=head2 B<REQUIRED> Properties => Str

  A string map of event-specific data that you might choose to record.
For example, if a user rates a movie on your site, you might send the
movie ID and rating, and the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

C<{"itemId": "movie1"}>

C<{"itemId": "movie2", "eventValue": "4.5"}>

C<{"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}>

The keys use camel case names that match the fields in the Interactions
schema. The C<itemId> and C<eventValue> keys correspond to the
C<ITEM_ID> and C<EVENT_VALUE> fields. In the above example, the
C<eventType> might be 'MovieRating' with C<eventValue> being the
rating. The C<numberOfRatings> would match the 'NUMBER_OF_RATINGS'
field defined in the Interactions schema.


=head2 B<REQUIRED> SentAt => Str

  The timestamp on the client side when the event occurred.


=head1 SEE ALSO

This class forms part of L<Paws>, describing an object used in L<Paws::PersonalizeEvents>

=head1 BUGS and CONTRIBUTIONS

The source code is located here: L<https://github.com/pplu/aws-sdk-perl>

Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>

=cut