| 1 | |||
| 2 | package Paws::PersonalizeEvents::PutEvents; | ||
| 3 | use Moose; | ||
| 4 | has EventList => (is => 'ro', isa => 'ArrayRef[Paws::PersonalizeEvents::Event]', traits => ['NameInRequest'], request_name => 'eventList', required => 1); | ||
| 5 | has SessionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sessionId', required => 1); | ||
| 6 | has TrackingId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'trackingId', required => 1); | ||
| 7 | has UserId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'userId'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutEvents'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/events'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::PersonalizeEvents::PutEvents - Arguments for method PutEvents on L<Paws::PersonalizeEvents> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method PutEvents on the | ||
| 26 | L<Amazon Personalize Events|Paws::PersonalizeEvents> service. Use the attributes of this class | ||
| 27 | as arguments to method PutEvents. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutEvents. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $personalize-events = Paws->service('PersonalizeEvents'); | ||
| 34 | $personalize -events->PutEvents( | ||
| 35 | EventList => [ | ||
| 36 | { | ||
| 37 | EventType => 'MyStringType', # min: 1, max: 256 | ||
| 38 | SentAt => '1970-01-01T01:00:00', | ||
| 39 | EventId => 'MyStringType', # min: 1, max: 256 | ||
| 40 | EventValue => 1.0, # OPTIONAL | ||
| 41 | Impression => [ | ||
| 42 | 'MyItemId', ... # min: 1, max: 256 | ||
| 43 | ], # min: 1, max: 25; OPTIONAL | ||
| 44 | ItemId => 'MyItemId', # min: 1, max: 256 | ||
| 45 | Properties => 'MyEventPropertiesJSON', # min: 1, max: 1024; OPTIONAL | ||
| 46 | RecommendationId => 'MyRecommendationId', # min: 1, max: 40; OPTIONAL | ||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], | ||
| 50 | SessionId => 'MyStringType', | ||
| 51 | TrackingId => 'MyStringType', | ||
| 52 | UserId => 'MyUserId', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/personalize-events/PutEvents> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> EventList => ArrayRef[L<Paws::PersonalizeEvents::Event>] | ||
| 62 | |||
| 63 | A list of event data from the session. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> SessionId => Str | ||
| 68 | |||
| 69 | The session ID associated with the user's visit. Your application | ||
| 70 | generates the sessionId when a user first visits your website or uses | ||
| 71 | your application. Amazon Personalize uses the sessionId to associate | ||
| 72 | events with the user before they log in. For more information, see | ||
| 73 | Recording Events | ||
| 74 | (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html). | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> TrackingId => Str | ||
| 79 | |||
| 80 | The tracking ID for the event. The ID is generated by a call to the | ||
| 81 | CreateEventTracker | ||
| 82 | (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) | ||
| 83 | API. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 UserId => Str | ||
| 88 | |||
| 89 | The user associated with the event. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method PutEvents in L<Paws::PersonalizeEvents> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |