« blib/lib/Paws/Pinpoint/PutEventStreamResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/PutEventsResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::PutEvents; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has EventsRequest => (is => 'ro', isa => 'Paws::Pinpoint::EventsRequest', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'EventsRequest'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutEvents'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/events'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::PutEventsResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Pinpoint::PutEvents - Arguments for method PutEvents on L<Paws::Pinpoint> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PutEvents on the | ||
| 24 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 25 | as arguments to method PutEvents. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutEvents. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 32 | my $PutEventsResponse = $pinpoint->PutEvents( | ||
| 33 | ApplicationId => 'My__string', | ||
| 34 | EventsRequest => { | ||
| 35 | BatchItem => { | ||
| 36 | 'My__string' => { | ||
| 37 | Endpoint => { | ||
| 38 | Address => 'My__string', | ||
| 39 | Attributes => { 'My__string' => [ 'My__string', ... ], } | ||
| 40 | , # OPTIONAL | ||
| 41 | ChannelType => 'PUSH' | ||
| 42 | , # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM; OPTIONAL | ||
| 43 | Demographic => { | ||
| 44 | AppVersion => 'My__string', | ||
| 45 | Locale => 'My__string', | ||
| 46 | Make => 'My__string', | ||
| 47 | Model => 'My__string', | ||
| 48 | ModelVersion => 'My__string', | ||
| 49 | Platform => 'My__string', | ||
| 50 | PlatformVersion => 'My__string', | ||
| 51 | Timezone => 'My__string', | ||
| 52 | }, # OPTIONAL | ||
| 53 | EffectiveDate => 'My__string', | ||
| 54 | EndpointStatus => 'My__string', | ||
| 55 | Location => { | ||
| 56 | City => 'My__string', | ||
| 57 | Country => 'My__string', | ||
| 58 | Latitude => 1, # OPTIONAL | ||
| 59 | Longitude => 1, # OPTIONAL | ||
| 60 | PostalCode => 'My__string', | ||
| 61 | Region => 'My__string', | ||
| 62 | }, # OPTIONAL | ||
| 63 | Metrics => { | ||
| 64 | 'My__string' => 1, # , value: OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | OptOut => 'My__string', | ||
| 67 | RequestId => 'My__string', | ||
| 68 | User => { | ||
| 69 | UserAttributes => { 'My__string' => [ 'My__string', ... ], } | ||
| 70 | , # OPTIONAL | ||
| 71 | UserId => 'My__string', | ||
| 72 | }, # OPTIONAL | ||
| 73 | }, | ||
| 74 | Events => { | ||
| 75 | 'My__string' => { | ||
| 76 | EventType => 'My__string', | ||
| 77 | Timestamp => 'My__string', | ||
| 78 | AppPackageName => 'My__string', | ||
| 79 | AppTitle => 'My__string', | ||
| 80 | AppVersionCode => 'My__string', | ||
| 81 | Attributes => { 'My__string' => 'My__string', }, # OPTIONAL | ||
| 82 | ClientSdkVersion => 'My__string', | ||
| 83 | Metrics => { | ||
| 84 | 'My__string' => 1, # , value: OPTIONAL | ||
| 85 | }, # OPTIONAL | ||
| 86 | SdkName => 'My__string', | ||
| 87 | Session => { | ||
| 88 | Id => 'My__string', | ||
| 89 | StartTimestamp => 'My__string', | ||
| 90 | Duration => 1, # OPTIONAL | ||
| 91 | StopTimestamp => 'My__string', | ||
| 92 | }, # OPTIONAL | ||
| 93 | }, | ||
| 94 | }, | ||
| 95 | |||
| 96 | }, | ||
| 97 | }, | ||
| 98 | |||
| 99 | }, | ||
| 100 | |||
| 101 | ); | ||
| 102 | |||
| 103 | # Results: | ||
| 104 | my $EventsResponse = $PutEventsResponse->EventsResponse; | ||
| 105 | |||
| 106 | # Returns a L<Paws::Pinpoint::PutEventsResponse> object. | ||
| 107 | |||
| 108 | 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. | ||
| 109 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/PutEvents> | ||
| 110 | |||
| 111 | =head1 ATTRIBUTES | ||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 115 | |||
| 116 | The unique identifier for the application. This identifier is displayed | ||
| 117 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> EventsRequest => L<Paws::Pinpoint::EventsRequest> | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method PutEvents in L<Paws::Pinpoint> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |