aws-sdk-pinpoint 1.0.0.rc6 → 1.0.0.rc7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +692 -6
- data/lib/aws-sdk-pinpoint/client_api.rb +443 -2
- data/lib/aws-sdk-pinpoint/types.rb +1647 -91
- metadata +4 -4
@@ -15,6 +15,7 @@ module Aws::Pinpoint
|
|
15
15
|
#
|
16
16
|
# {
|
17
17
|
# certificate: "__string",
|
18
|
+
# enabled: false,
|
18
19
|
# private_key: "__string",
|
19
20
|
# }
|
20
21
|
#
|
@@ -22,12 +23,17 @@ module Aws::Pinpoint
|
|
22
23
|
# The distribution certificate from Apple.
|
23
24
|
# @return [String]
|
24
25
|
#
|
26
|
+
# @!attribute [rw] enabled
|
27
|
+
# If the channel is enabled for sending messages.
|
28
|
+
# @return [Boolean]
|
29
|
+
#
|
25
30
|
# @!attribute [rw] private_key
|
26
31
|
# The certificate private key.
|
27
32
|
# @return [String]
|
28
33
|
#
|
29
34
|
class APNSChannelRequest < Struct.new(
|
30
35
|
:certificate,
|
36
|
+
:enabled,
|
31
37
|
:private_key)
|
32
38
|
include Aws::Structure
|
33
39
|
end
|
@@ -42,8 +48,12 @@ module Aws::Pinpoint
|
|
42
48
|
# When was this segment created
|
43
49
|
# @return [String]
|
44
50
|
#
|
51
|
+
# @!attribute [rw] enabled
|
52
|
+
# If the channel is enabled for sending messages.
|
53
|
+
# @return [Boolean]
|
54
|
+
#
|
45
55
|
# @!attribute [rw] id
|
46
|
-
#
|
56
|
+
# Channel ID. Not used, only for backwards compatibility.
|
47
57
|
# @return [String]
|
48
58
|
#
|
49
59
|
# @!attribute [rw] is_archived
|
@@ -69,6 +79,205 @@ module Aws::Pinpoint
|
|
69
79
|
class APNSChannelResponse < Struct.new(
|
70
80
|
:application_id,
|
71
81
|
:creation_date,
|
82
|
+
:enabled,
|
83
|
+
:id,
|
84
|
+
:is_archived,
|
85
|
+
:last_modified_by,
|
86
|
+
:last_modified_date,
|
87
|
+
:platform,
|
88
|
+
:version)
|
89
|
+
include Aws::Structure
|
90
|
+
end
|
91
|
+
|
92
|
+
# APNS Message.
|
93
|
+
#
|
94
|
+
# @note When making an API call, you may pass APNSMessage
|
95
|
+
# data as a hash:
|
96
|
+
#
|
97
|
+
# {
|
98
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
99
|
+
# badge: 1,
|
100
|
+
# body: "__string",
|
101
|
+
# category: "__string",
|
102
|
+
# data: {
|
103
|
+
# "__string" => "__string",
|
104
|
+
# },
|
105
|
+
# media_url: "__string",
|
106
|
+
# raw_content: "__string",
|
107
|
+
# silent_push: false,
|
108
|
+
# sound: "__string",
|
109
|
+
# substitutions: {
|
110
|
+
# "__string" => ["__string"],
|
111
|
+
# },
|
112
|
+
# thread_id: "__string",
|
113
|
+
# title: "__string",
|
114
|
+
# url: "__string",
|
115
|
+
# }
|
116
|
+
#
|
117
|
+
# @!attribute [rw] action
|
118
|
+
# The action that occurs if the user taps a push notification
|
119
|
+
# delivered by the campaign: OPEN\_APP - Your app launches, or it
|
120
|
+
# becomes the foreground app if it has been sent to the background.
|
121
|
+
# This is the default action. DEEP\_LINK - Uses deep linking features
|
122
|
+
# in iOS and Android to open your app and display a designated user
|
123
|
+
# interface within the app. URL - The default mobile browser on the
|
124
|
+
# user's device launches and opens a web page at the URL you specify.
|
125
|
+
# Possible values include: OPEN\_APP \| DEEP\_LINK \| URL
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] badge
|
129
|
+
# Include this key when you want the system to modify the badge of
|
130
|
+
# your app icon. If this key is not included in the dictionary, the
|
131
|
+
# badge is not changed. To remove the badge, set the value of this key
|
132
|
+
# to 0.
|
133
|
+
# @return [Integer]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] body
|
136
|
+
# The message body of the notification, the email body or the text
|
137
|
+
# message.
|
138
|
+
# @return [String]
|
139
|
+
#
|
140
|
+
# @!attribute [rw] category
|
141
|
+
# Provide this key with a string value that represents the
|
142
|
+
# notification's type. This value corresponds to the value in the
|
143
|
+
# identifier property of one of your app's registered categories.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] data
|
147
|
+
# @return [Hash<String,String>]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] media_url
|
150
|
+
# The URL that points to a video used in the push notification.
|
151
|
+
# @return [String]
|
152
|
+
#
|
153
|
+
# @!attribute [rw] raw_content
|
154
|
+
# The Raw JSON formatted string to be used as the payload. This value
|
155
|
+
# overrides the message.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] silent_push
|
159
|
+
# Indicates if the message should display on the users device. Silent
|
160
|
+
# pushes can be used for Remote Configuration and Phone Home use
|
161
|
+
# cases.
|
162
|
+
# @return [Boolean]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] sound
|
165
|
+
# Include this key when you want the system to play a sound. The value
|
166
|
+
# of this key is the name of a sound file in your app's main bundle
|
167
|
+
# or in the Library/Sounds folder of your app's data container. If
|
168
|
+
# the sound file cannot be found, or if you specify defaultfor the
|
169
|
+
# value, the system plays the default alert sound.
|
170
|
+
# @return [String]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] substitutions
|
173
|
+
# @return [Hash<String,Array<String>>]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] thread_id
|
176
|
+
# Provide this key with a string value that represents the
|
177
|
+
# app-specific identifier for grouping notifications. If you provide a
|
178
|
+
# Notification Content app extension, you can use this value to group
|
179
|
+
# your notifications together.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] title
|
183
|
+
# The message title that displays above the message on the user's
|
184
|
+
# device.
|
185
|
+
# @return [String]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] url
|
188
|
+
# The URL to open in the user's mobile browser. Used if the value for
|
189
|
+
# Action is URL.
|
190
|
+
# @return [String]
|
191
|
+
#
|
192
|
+
class APNSMessage < Struct.new(
|
193
|
+
:action,
|
194
|
+
:badge,
|
195
|
+
:body,
|
196
|
+
:category,
|
197
|
+
:data,
|
198
|
+
:media_url,
|
199
|
+
:raw_content,
|
200
|
+
:silent_push,
|
201
|
+
:sound,
|
202
|
+
:substitutions,
|
203
|
+
:thread_id,
|
204
|
+
:title,
|
205
|
+
:url)
|
206
|
+
include Aws::Structure
|
207
|
+
end
|
208
|
+
|
209
|
+
# Apple Development Push Notification Service channel definition.
|
210
|
+
#
|
211
|
+
# @note When making an API call, you may pass APNSSandboxChannelRequest
|
212
|
+
# data as a hash:
|
213
|
+
#
|
214
|
+
# {
|
215
|
+
# certificate: "__string",
|
216
|
+
# enabled: false,
|
217
|
+
# private_key: "__string",
|
218
|
+
# }
|
219
|
+
#
|
220
|
+
# @!attribute [rw] certificate
|
221
|
+
# The distribution certificate from Apple.
|
222
|
+
# @return [String]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] enabled
|
225
|
+
# If the channel is enabled for sending messages.
|
226
|
+
# @return [Boolean]
|
227
|
+
#
|
228
|
+
# @!attribute [rw] private_key
|
229
|
+
# The certificate private key.
|
230
|
+
# @return [String]
|
231
|
+
#
|
232
|
+
class APNSSandboxChannelRequest < Struct.new(
|
233
|
+
:certificate,
|
234
|
+
:enabled,
|
235
|
+
:private_key)
|
236
|
+
include Aws::Structure
|
237
|
+
end
|
238
|
+
|
239
|
+
# Apple Development Push Notification Service channel definition.
|
240
|
+
#
|
241
|
+
# @!attribute [rw] application_id
|
242
|
+
# Application id
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] creation_date
|
246
|
+
# When was this segment created
|
247
|
+
# @return [String]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] enabled
|
250
|
+
# If the channel is enabled for sending messages.
|
251
|
+
# @return [Boolean]
|
252
|
+
#
|
253
|
+
# @!attribute [rw] id
|
254
|
+
# Channel ID. Not used, only for backwards compatibility.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @!attribute [rw] is_archived
|
258
|
+
# Is this channel archived
|
259
|
+
# @return [Boolean]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] last_modified_by
|
262
|
+
# Who last updated this entry
|
263
|
+
# @return [String]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] last_modified_date
|
266
|
+
# Last date this was updated
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] platform
|
270
|
+
# The platform type. Will be APNS.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] version
|
274
|
+
# Version of channel
|
275
|
+
# @return [Integer]
|
276
|
+
#
|
277
|
+
class APNSSandboxChannelResponse < Struct.new(
|
278
|
+
:application_id,
|
279
|
+
:creation_date,
|
280
|
+
:enabled,
|
72
281
|
:id,
|
73
282
|
:is_archived,
|
74
283
|
:last_modified_by,
|
@@ -165,6 +374,58 @@ module Aws::Pinpoint
|
|
165
374
|
include Aws::Structure
|
166
375
|
end
|
167
376
|
|
377
|
+
# Address configuration.
|
378
|
+
#
|
379
|
+
# @note When making an API call, you may pass AddressConfiguration
|
380
|
+
# data as a hash:
|
381
|
+
#
|
382
|
+
# {
|
383
|
+
# body_override: "__string",
|
384
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
385
|
+
# context: {
|
386
|
+
# "__string" => "__string",
|
387
|
+
# },
|
388
|
+
# raw_content: "__string",
|
389
|
+
# substitutions: {
|
390
|
+
# "__string" => ["__string"],
|
391
|
+
# },
|
392
|
+
# title_override: "__string",
|
393
|
+
# }
|
394
|
+
#
|
395
|
+
# @!attribute [rw] body_override
|
396
|
+
# Body override. If specified will override default body.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] channel_type
|
400
|
+
# Type of channel of this address
|
401
|
+
# @return [String]
|
402
|
+
#
|
403
|
+
# @!attribute [rw] context
|
404
|
+
# @return [Hash<String,String>]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] raw_content
|
407
|
+
# The Raw JSON formatted string to be used as the payload. This value
|
408
|
+
# overrides the message.
|
409
|
+
# @return [String]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] substitutions
|
412
|
+
# @return [Hash<String,Array<String>>]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] title_override
|
415
|
+
# Title override. If specified will override default title if
|
416
|
+
# applicable.
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
class AddressConfiguration < Struct.new(
|
420
|
+
:body_override,
|
421
|
+
:channel_type,
|
422
|
+
:context,
|
423
|
+
:raw_content,
|
424
|
+
:substitutions,
|
425
|
+
:title_override)
|
426
|
+
include Aws::Structure
|
427
|
+
end
|
428
|
+
|
168
429
|
# Application settings.
|
169
430
|
#
|
170
431
|
# @!attribute [rw] application_id
|
@@ -206,8 +467,8 @@ module Aws::Pinpoint
|
|
206
467
|
# }
|
207
468
|
#
|
208
469
|
# @!attribute [rw] attribute_type
|
209
|
-
# The type of dimension: INCLUSIVE
|
210
|
-
# are included in the segment. EXCLUSIVE
|
470
|
+
# The type of dimension: INCLUSIVE - Endpoints that match the criteria
|
471
|
+
# are included in the segment. EXCLUSIVE - Endpoints that match the
|
211
472
|
# criteria are excluded from the segment.
|
212
473
|
# @return [String]
|
213
474
|
#
|
@@ -220,6 +481,36 @@ module Aws::Pinpoint
|
|
220
481
|
include Aws::Structure
|
221
482
|
end
|
222
483
|
|
484
|
+
# The email message configuration.
|
485
|
+
#
|
486
|
+
# @note When making an API call, you may pass CampaignEmailMessage
|
487
|
+
# data as a hash:
|
488
|
+
#
|
489
|
+
# {
|
490
|
+
# body: "__string",
|
491
|
+
# html_body: "__string",
|
492
|
+
# title: "__string",
|
493
|
+
# }
|
494
|
+
#
|
495
|
+
# @!attribute [rw] body
|
496
|
+
# The email text body.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] html_body
|
500
|
+
# The email html body.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] title
|
504
|
+
# The email title (Or subject).
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
class CampaignEmailMessage < Struct.new(
|
508
|
+
:body,
|
509
|
+
:html_body,
|
510
|
+
:title)
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
223
514
|
# Campaign Limits are used to limit the number of messages that can be
|
224
515
|
# sent to a user.
|
225
516
|
#
|
@@ -350,6 +641,37 @@ module Aws::Pinpoint
|
|
350
641
|
include Aws::Structure
|
351
642
|
end
|
352
643
|
|
644
|
+
# SMS message configuration.
|
645
|
+
#
|
646
|
+
# @note When making an API call, you may pass CampaignSmsMessage
|
647
|
+
# data as a hash:
|
648
|
+
#
|
649
|
+
# {
|
650
|
+
# body: "__string",
|
651
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
652
|
+
# sender_id: "__string",
|
653
|
+
# }
|
654
|
+
#
|
655
|
+
# @!attribute [rw] body
|
656
|
+
# The SMS text body.
|
657
|
+
# @return [String]
|
658
|
+
#
|
659
|
+
# @!attribute [rw] message_type
|
660
|
+
# Is this is a transactional SMS message, otherwise a promotional
|
661
|
+
# message.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] sender_id
|
665
|
+
# Sender ID of sent message.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
class CampaignSmsMessage < Struct.new(
|
669
|
+
:body,
|
670
|
+
:message_type,
|
671
|
+
:sender_id)
|
672
|
+
include Aws::Structure
|
673
|
+
end
|
674
|
+
|
353
675
|
# State of the Campaign
|
354
676
|
#
|
355
677
|
# @!attribute [rw] campaign_status
|
@@ -393,6 +715,7 @@ module Aws::Pinpoint
|
|
393
715
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
394
716
|
# body: "__string",
|
395
717
|
# image_icon_url: "__string",
|
718
|
+
# image_small_icon_url: "__string",
|
396
719
|
# image_url: "__string",
|
397
720
|
# json_body: "__string",
|
398
721
|
# media_url: "__string",
|
@@ -404,6 +727,7 @@ module Aws::Pinpoint
|
|
404
727
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
405
728
|
# body: "__string",
|
406
729
|
# image_icon_url: "__string",
|
730
|
+
# image_small_icon_url: "__string",
|
407
731
|
# image_url: "__string",
|
408
732
|
# json_body: "__string",
|
409
733
|
# media_url: "__string",
|
@@ -411,10 +735,16 @@ module Aws::Pinpoint
|
|
411
735
|
# title: "__string",
|
412
736
|
# url: "__string",
|
413
737
|
# },
|
738
|
+
# email_message: {
|
739
|
+
# body: "__string",
|
740
|
+
# html_body: "__string",
|
741
|
+
# title: "__string",
|
742
|
+
# },
|
414
743
|
# gcm_message: {
|
415
744
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
416
745
|
# body: "__string",
|
417
746
|
# image_icon_url: "__string",
|
747
|
+
# image_small_icon_url: "__string",
|
418
748
|
# image_url: "__string",
|
419
749
|
# json_body: "__string",
|
420
750
|
# media_url: "__string",
|
@@ -422,6 +752,11 @@ module Aws::Pinpoint
|
|
422
752
|
# title: "__string",
|
423
753
|
# url: "__string",
|
424
754
|
# },
|
755
|
+
# sms_message: {
|
756
|
+
# body: "__string",
|
757
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
758
|
+
# sender_id: "__string",
|
759
|
+
# },
|
425
760
|
# },
|
426
761
|
# schedule: {
|
427
762
|
# end_time: "__string",
|
@@ -451,6 +786,7 @@ module Aws::Pinpoint
|
|
451
786
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
452
787
|
# body: "__string",
|
453
788
|
# image_icon_url: "__string",
|
789
|
+
# image_small_icon_url: "__string",
|
454
790
|
# image_url: "__string",
|
455
791
|
# json_body: "__string",
|
456
792
|
# media_url: "__string",
|
@@ -462,6 +798,7 @@ module Aws::Pinpoint
|
|
462
798
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
463
799
|
# body: "__string",
|
464
800
|
# image_icon_url: "__string",
|
801
|
+
# image_small_icon_url: "__string",
|
465
802
|
# image_url: "__string",
|
466
803
|
# json_body: "__string",
|
467
804
|
# media_url: "__string",
|
@@ -469,10 +806,16 @@ module Aws::Pinpoint
|
|
469
806
|
# title: "__string",
|
470
807
|
# url: "__string",
|
471
808
|
# },
|
809
|
+
# email_message: {
|
810
|
+
# body: "__string",
|
811
|
+
# html_body: "__string",
|
812
|
+
# title: "__string",
|
813
|
+
# },
|
472
814
|
# gcm_message: {
|
473
815
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
474
816
|
# body: "__string",
|
475
817
|
# image_icon_url: "__string",
|
818
|
+
# image_small_icon_url: "__string",
|
476
819
|
# image_url: "__string",
|
477
820
|
# json_body: "__string",
|
478
821
|
# media_url: "__string",
|
@@ -480,6 +823,11 @@ module Aws::Pinpoint
|
|
480
823
|
# title: "__string",
|
481
824
|
# url: "__string",
|
482
825
|
# },
|
826
|
+
# sms_message: {
|
827
|
+
# body: "__string",
|
828
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
829
|
+
# sender_id: "__string",
|
830
|
+
# },
|
483
831
|
# },
|
484
832
|
# name: "__string",
|
485
833
|
# schedule: {
|
@@ -583,6 +931,10 @@ module Aws::Pinpoint
|
|
583
931
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
584
932
|
# values: ["__string"],
|
585
933
|
# },
|
934
|
+
# channel: {
|
935
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
936
|
+
# values: ["__string"],
|
937
|
+
# },
|
586
938
|
# device_type: {
|
587
939
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
588
940
|
# values: ["__string"],
|
@@ -639,6 +991,100 @@ module Aws::Pinpoint
|
|
639
991
|
include Aws::Structure
|
640
992
|
end
|
641
993
|
|
994
|
+
# Default Message across push notification, email, and sms.
|
995
|
+
#
|
996
|
+
# @note When making an API call, you may pass DefaultMessage
|
997
|
+
# data as a hash:
|
998
|
+
#
|
999
|
+
# {
|
1000
|
+
# body: "__string",
|
1001
|
+
# substitutions: {
|
1002
|
+
# "__string" => ["__string"],
|
1003
|
+
# },
|
1004
|
+
# }
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] body
|
1007
|
+
# The message body of the notification, the email body or the text
|
1008
|
+
# message.
|
1009
|
+
# @return [String]
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] substitutions
|
1012
|
+
# @return [Hash<String,Array<String>>]
|
1013
|
+
#
|
1014
|
+
class DefaultMessage < Struct.new(
|
1015
|
+
:body,
|
1016
|
+
:substitutions)
|
1017
|
+
include Aws::Structure
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
# Default Push Notification Message.
|
1021
|
+
#
|
1022
|
+
# @note When making an API call, you may pass DefaultPushNotificationMessage
|
1023
|
+
# data as a hash:
|
1024
|
+
#
|
1025
|
+
# {
|
1026
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1027
|
+
# body: "__string",
|
1028
|
+
# data: {
|
1029
|
+
# "__string" => "__string",
|
1030
|
+
# },
|
1031
|
+
# silent_push: false,
|
1032
|
+
# substitutions: {
|
1033
|
+
# "__string" => ["__string"],
|
1034
|
+
# },
|
1035
|
+
# title: "__string",
|
1036
|
+
# url: "__string",
|
1037
|
+
# }
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] action
|
1040
|
+
# The action that occurs if the user taps a push notification
|
1041
|
+
# delivered by the campaign: OPEN\_APP - Your app launches, or it
|
1042
|
+
# becomes the foreground app if it has been sent to the background.
|
1043
|
+
# This is the default action. DEEP\_LINK - Uses deep linking features
|
1044
|
+
# in iOS and Android to open your app and display a designated user
|
1045
|
+
# interface within the app. URL - The default mobile browser on the
|
1046
|
+
# user's device launches and opens a web page at the URL you specify.
|
1047
|
+
# Possible values include: OPEN\_APP \| DEEP\_LINK \| URL
|
1048
|
+
# @return [String]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] body
|
1051
|
+
# The message body of the notification, the email body or the text
|
1052
|
+
# message.
|
1053
|
+
# @return [String]
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] data
|
1056
|
+
# @return [Hash<String,String>]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] silent_push
|
1059
|
+
# Indicates if the message should display on the users device. Silent
|
1060
|
+
# pushes can be used for Remote Configuration and Phone Home use
|
1061
|
+
# cases.
|
1062
|
+
# @return [Boolean]
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] substitutions
|
1065
|
+
# @return [Hash<String,Array<String>>]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] title
|
1068
|
+
# The message title that displays above the message on the user's
|
1069
|
+
# device.
|
1070
|
+
# @return [String]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] url
|
1073
|
+
# The URL to open in the user's mobile browser. Used if the value for
|
1074
|
+
# Action is URL.
|
1075
|
+
# @return [String]
|
1076
|
+
#
|
1077
|
+
class DefaultPushNotificationMessage < Struct.new(
|
1078
|
+
:action,
|
1079
|
+
:body,
|
1080
|
+
:data,
|
1081
|
+
:silent_push,
|
1082
|
+
:substitutions,
|
1083
|
+
:title,
|
1084
|
+
:url)
|
1085
|
+
include Aws::Structure
|
1086
|
+
end
|
1087
|
+
|
642
1088
|
# @note When making an API call, you may pass DeleteApnsChannelRequest
|
643
1089
|
# data as a hash:
|
644
1090
|
#
|
@@ -654,12 +1100,36 @@ module Aws::Pinpoint
|
|
654
1100
|
include Aws::Structure
|
655
1101
|
end
|
656
1102
|
|
657
|
-
# @!attribute [rw] apns_channel_response
|
658
|
-
# Apple Distribution Push Notification Service channel definition.
|
659
|
-
# @return [Types::APNSChannelResponse]
|
1103
|
+
# @!attribute [rw] apns_channel_response
|
1104
|
+
# Apple Distribution Push Notification Service channel definition.
|
1105
|
+
# @return [Types::APNSChannelResponse]
|
1106
|
+
#
|
1107
|
+
class DeleteApnsChannelResponse < Struct.new(
|
1108
|
+
:apns_channel_response)
|
1109
|
+
include Aws::Structure
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
# @note When making an API call, you may pass DeleteApnsSandboxChannelRequest
|
1113
|
+
# data as a hash:
|
1114
|
+
#
|
1115
|
+
# {
|
1116
|
+
# application_id: "__string", # required
|
1117
|
+
# }
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] application_id
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
class DeleteApnsSandboxChannelRequest < Struct.new(
|
1123
|
+
:application_id)
|
1124
|
+
include Aws::Structure
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# @!attribute [rw] apns_sandbox_channel_response
|
1128
|
+
# Apple Development Push Notification Service channel definition.
|
1129
|
+
# @return [Types::APNSSandboxChannelResponse]
|
660
1130
|
#
|
661
|
-
class
|
662
|
-
:
|
1131
|
+
class DeleteApnsSandboxChannelResponse < Struct.new(
|
1132
|
+
:apns_sandbox_channel_response)
|
663
1133
|
include Aws::Structure
|
664
1134
|
end
|
665
1135
|
|
@@ -692,6 +1162,30 @@ module Aws::Pinpoint
|
|
692
1162
|
include Aws::Structure
|
693
1163
|
end
|
694
1164
|
|
1165
|
+
# @note When making an API call, you may pass DeleteEmailChannelRequest
|
1166
|
+
# data as a hash:
|
1167
|
+
#
|
1168
|
+
# {
|
1169
|
+
# application_id: "__string", # required
|
1170
|
+
# }
|
1171
|
+
#
|
1172
|
+
# @!attribute [rw] application_id
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
class DeleteEmailChannelRequest < Struct.new(
|
1176
|
+
:application_id)
|
1177
|
+
include Aws::Structure
|
1178
|
+
end
|
1179
|
+
|
1180
|
+
# @!attribute [rw] email_channel_response
|
1181
|
+
# Email Channel Response.
|
1182
|
+
# @return [Types::EmailChannelResponse]
|
1183
|
+
#
|
1184
|
+
class DeleteEmailChannelResponse < Struct.new(
|
1185
|
+
:email_channel_response)
|
1186
|
+
include Aws::Structure
|
1187
|
+
end
|
1188
|
+
|
695
1189
|
# @note When making an API call, you may pass DeleteEventStreamRequest
|
696
1190
|
# data as a hash:
|
697
1191
|
#
|
@@ -770,6 +1264,240 @@ module Aws::Pinpoint
|
|
770
1264
|
include Aws::Structure
|
771
1265
|
end
|
772
1266
|
|
1267
|
+
# @note When making an API call, you may pass DeleteSmsChannelRequest
|
1268
|
+
# data as a hash:
|
1269
|
+
#
|
1270
|
+
# {
|
1271
|
+
# application_id: "__string", # required
|
1272
|
+
# }
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] application_id
|
1275
|
+
# @return [String]
|
1276
|
+
#
|
1277
|
+
class DeleteSmsChannelRequest < Struct.new(
|
1278
|
+
:application_id)
|
1279
|
+
include Aws::Structure
|
1280
|
+
end
|
1281
|
+
|
1282
|
+
# @!attribute [rw] sms_channel_response
|
1283
|
+
# SMS Channel Response.
|
1284
|
+
# @return [Types::SMSChannelResponse]
|
1285
|
+
#
|
1286
|
+
class DeleteSmsChannelResponse < Struct.new(
|
1287
|
+
:sms_channel_response)
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# The message configuration.
|
1292
|
+
#
|
1293
|
+
# @note When making an API call, you may pass DirectMessageConfiguration
|
1294
|
+
# data as a hash:
|
1295
|
+
#
|
1296
|
+
# {
|
1297
|
+
# apns_message: {
|
1298
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1299
|
+
# badge: 1,
|
1300
|
+
# body: "__string",
|
1301
|
+
# category: "__string",
|
1302
|
+
# data: {
|
1303
|
+
# "__string" => "__string",
|
1304
|
+
# },
|
1305
|
+
# media_url: "__string",
|
1306
|
+
# raw_content: "__string",
|
1307
|
+
# silent_push: false,
|
1308
|
+
# sound: "__string",
|
1309
|
+
# substitutions: {
|
1310
|
+
# "__string" => ["__string"],
|
1311
|
+
# },
|
1312
|
+
# thread_id: "__string",
|
1313
|
+
# title: "__string",
|
1314
|
+
# url: "__string",
|
1315
|
+
# },
|
1316
|
+
# default_message: {
|
1317
|
+
# body: "__string",
|
1318
|
+
# substitutions: {
|
1319
|
+
# "__string" => ["__string"],
|
1320
|
+
# },
|
1321
|
+
# },
|
1322
|
+
# default_push_notification_message: {
|
1323
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1324
|
+
# body: "__string",
|
1325
|
+
# data: {
|
1326
|
+
# "__string" => "__string",
|
1327
|
+
# },
|
1328
|
+
# silent_push: false,
|
1329
|
+
# substitutions: {
|
1330
|
+
# "__string" => ["__string"],
|
1331
|
+
# },
|
1332
|
+
# title: "__string",
|
1333
|
+
# url: "__string",
|
1334
|
+
# },
|
1335
|
+
# gcm_message: {
|
1336
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1337
|
+
# body: "__string",
|
1338
|
+
# collapse_key: "__string",
|
1339
|
+
# data: {
|
1340
|
+
# "__string" => "__string",
|
1341
|
+
# },
|
1342
|
+
# icon_reference: "__string",
|
1343
|
+
# image_icon_url: "__string",
|
1344
|
+
# image_url: "__string",
|
1345
|
+
# raw_content: "__string",
|
1346
|
+
# restricted_package_name: "__string",
|
1347
|
+
# silent_push: false,
|
1348
|
+
# small_image_icon_url: "__string",
|
1349
|
+
# sound: "__string",
|
1350
|
+
# substitutions: {
|
1351
|
+
# "__string" => ["__string"],
|
1352
|
+
# },
|
1353
|
+
# title: "__string",
|
1354
|
+
# url: "__string",
|
1355
|
+
# },
|
1356
|
+
# sms_message: {
|
1357
|
+
# body: "__string",
|
1358
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
1359
|
+
# sender_id: "__string",
|
1360
|
+
# substitutions: {
|
1361
|
+
# "__string" => ["__string"],
|
1362
|
+
# },
|
1363
|
+
# },
|
1364
|
+
# }
|
1365
|
+
#
|
1366
|
+
# @!attribute [rw] apns_message
|
1367
|
+
# The message to APNS channels. Overrides the default push
|
1368
|
+
# notification message.
|
1369
|
+
# @return [Types::APNSMessage]
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] default_message
|
1372
|
+
# The default message for all channels.
|
1373
|
+
# @return [Types::DefaultMessage]
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] default_push_notification_message
|
1376
|
+
# The default push notification message for all push channels.
|
1377
|
+
# @return [Types::DefaultPushNotificationMessage]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] gcm_message
|
1380
|
+
# The message to GCM channels. Overrides the default push notification
|
1381
|
+
# message.
|
1382
|
+
# @return [Types::GCMMessage]
|
1383
|
+
#
|
1384
|
+
# @!attribute [rw] sms_message
|
1385
|
+
# The message to SMS channels. Overrides the default message.
|
1386
|
+
# @return [Types::SMSMessage]
|
1387
|
+
#
|
1388
|
+
class DirectMessageConfiguration < Struct.new(
|
1389
|
+
:apns_message,
|
1390
|
+
:default_message,
|
1391
|
+
:default_push_notification_message,
|
1392
|
+
:gcm_message,
|
1393
|
+
:sms_message)
|
1394
|
+
include Aws::Structure
|
1395
|
+
end
|
1396
|
+
|
1397
|
+
# Email Channel Request
|
1398
|
+
#
|
1399
|
+
# @note When making an API call, you may pass EmailChannelRequest
|
1400
|
+
# data as a hash:
|
1401
|
+
#
|
1402
|
+
# {
|
1403
|
+
# enabled: false,
|
1404
|
+
# from_address: "__string",
|
1405
|
+
# identity: "__string",
|
1406
|
+
# role_arn: "__string",
|
1407
|
+
# }
|
1408
|
+
#
|
1409
|
+
# @!attribute [rw] enabled
|
1410
|
+
# If the channel is enabled for sending messages.
|
1411
|
+
# @return [Boolean]
|
1412
|
+
#
|
1413
|
+
# @!attribute [rw] from_address
|
1414
|
+
# The email address used to send emails from.
|
1415
|
+
# @return [String]
|
1416
|
+
#
|
1417
|
+
# @!attribute [rw] identity
|
1418
|
+
# The ARN of an identity verified with SES.
|
1419
|
+
# @return [String]
|
1420
|
+
#
|
1421
|
+
# @!attribute [rw] role_arn
|
1422
|
+
# The ARN of an IAM Role used to submit events to Mobile Analytics'
|
1423
|
+
# event ingestion service
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
class EmailChannelRequest < Struct.new(
|
1427
|
+
:enabled,
|
1428
|
+
:from_address,
|
1429
|
+
:identity,
|
1430
|
+
:role_arn)
|
1431
|
+
include Aws::Structure
|
1432
|
+
end
|
1433
|
+
|
1434
|
+
# Email Channel Response.
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] application_id
|
1437
|
+
# Application id
|
1438
|
+
# @return [String]
|
1439
|
+
#
|
1440
|
+
# @!attribute [rw] creation_date
|
1441
|
+
# The date that the settings were last updated in ISO 8601 format.
|
1442
|
+
# @return [String]
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] enabled
|
1445
|
+
# If the channel is enabled for sending messages.
|
1446
|
+
# @return [Boolean]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] from_address
|
1449
|
+
# The email address used to send emails from.
|
1450
|
+
# @return [String]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] id
|
1453
|
+
# Channel ID. Not used, only for backwards compatibility.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] identity
|
1457
|
+
# The ARN of an identity verified with SES.
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] is_archived
|
1461
|
+
# Is this channel archived
|
1462
|
+
# @return [Boolean]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] last_modified_by
|
1465
|
+
# Who last updated this entry
|
1466
|
+
# @return [String]
|
1467
|
+
#
|
1468
|
+
# @!attribute [rw] last_modified_date
|
1469
|
+
# Last date this was updated
|
1470
|
+
# @return [String]
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] platform
|
1473
|
+
# Platform type. Will be "EMAIL"
|
1474
|
+
# @return [String]
|
1475
|
+
#
|
1476
|
+
# @!attribute [rw] role_arn
|
1477
|
+
# The ARN of an IAM Role used to submit events to Mobile Analytics'
|
1478
|
+
# event ingestion service
|
1479
|
+
# @return [String]
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] version
|
1482
|
+
# Version of channel
|
1483
|
+
# @return [Integer]
|
1484
|
+
#
|
1485
|
+
class EmailChannelResponse < Struct.new(
|
1486
|
+
:application_id,
|
1487
|
+
:creation_date,
|
1488
|
+
:enabled,
|
1489
|
+
:from_address,
|
1490
|
+
:id,
|
1491
|
+
:identity,
|
1492
|
+
:is_archived,
|
1493
|
+
:last_modified_by,
|
1494
|
+
:last_modified_date,
|
1495
|
+
:platform,
|
1496
|
+
:role_arn,
|
1497
|
+
:version)
|
1498
|
+
include Aws::Structure
|
1499
|
+
end
|
1500
|
+
|
773
1501
|
# Endpoint update request
|
774
1502
|
#
|
775
1503
|
# @note When making an API call, you may pass EndpointBatchItem
|
@@ -780,7 +1508,7 @@ module Aws::Pinpoint
|
|
780
1508
|
# attributes: {
|
781
1509
|
# "__string" => ["__string"],
|
782
1510
|
# },
|
783
|
-
# channel_type: "
|
1511
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
784
1512
|
# demographic: {
|
785
1513
|
# app_version: "__string",
|
786
1514
|
# locale: "__string",
|
@@ -895,7 +1623,7 @@ module Aws::Pinpoint
|
|
895
1623
|
# attributes: {
|
896
1624
|
# "__string" => ["__string"],
|
897
1625
|
# },
|
898
|
-
# channel_type: "
|
1626
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
899
1627
|
# demographic: {
|
900
1628
|
# app_version: "__string",
|
901
1629
|
# locale: "__string",
|
@@ -1065,7 +1793,7 @@ module Aws::Pinpoint
|
|
1065
1793
|
# attributes: {
|
1066
1794
|
# "__string" => ["__string"],
|
1067
1795
|
# },
|
1068
|
-
# channel_type: "
|
1796
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
1069
1797
|
# demographic: {
|
1070
1798
|
# app_version: "__string",
|
1071
1799
|
# locale: "__string",
|
@@ -1229,15 +1957,14 @@ module Aws::Pinpoint
|
|
1229
1957
|
# The unique ID for the most recent request to update the endpoint.
|
1230
1958
|
# @return [String]
|
1231
1959
|
#
|
1960
|
+
# @!attribute [rw] shard_id
|
1961
|
+
# @return [String]
|
1962
|
+
#
|
1232
1963
|
# @!attribute [rw] user
|
1233
1964
|
# Custom user-specific attributes that your app reports to Amazon
|
1234
1965
|
# Pinpoint.
|
1235
1966
|
# @return [Types::EndpointUser]
|
1236
1967
|
#
|
1237
|
-
# @!attribute [rw] shard_id
|
1238
|
-
# The ShardId of endpoint
|
1239
|
-
# @return [String]
|
1240
|
-
#
|
1241
1968
|
class EndpointResponse < Struct.new(
|
1242
1969
|
:address,
|
1243
1970
|
:application_id,
|
@@ -1253,8 +1980,8 @@ module Aws::Pinpoint
|
|
1253
1980
|
:metrics,
|
1254
1981
|
:opt_out,
|
1255
1982
|
:request_id,
|
1256
|
-
:
|
1257
|
-
:
|
1983
|
+
:shard_id,
|
1984
|
+
:user)
|
1258
1985
|
include Aws::Structure
|
1259
1986
|
end
|
1260
1987
|
|
@@ -1332,65 +2059,203 @@ module Aws::Pinpoint
|
|
1332
2059
|
#
|
1333
2060
|
# {
|
1334
2061
|
# api_key: "__string",
|
2062
|
+
# enabled: false,
|
1335
2063
|
# }
|
1336
2064
|
#
|
1337
2065
|
# @!attribute [rw] api_key
|
1338
2066
|
# Platform credential API key from Google.
|
1339
2067
|
# @return [String]
|
1340
2068
|
#
|
2069
|
+
# @!attribute [rw] enabled
|
2070
|
+
# If the channel is enabled for sending messages.
|
2071
|
+
# @return [Boolean]
|
2072
|
+
#
|
1341
2073
|
class GCMChannelRequest < Struct.new(
|
1342
|
-
:api_key
|
2074
|
+
:api_key,
|
2075
|
+
:enabled)
|
1343
2076
|
include Aws::Structure
|
1344
2077
|
end
|
1345
2078
|
|
1346
2079
|
# Google Cloud Messaging channel definition
|
1347
2080
|
#
|
1348
|
-
# @!attribute [rw] application_id
|
1349
|
-
# The ID of the application to which the channel applies.
|
2081
|
+
# @!attribute [rw] application_id
|
2082
|
+
# The ID of the application to which the channel applies.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] creation_date
|
2086
|
+
# When was this segment created
|
2087
|
+
# @return [String]
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] credential
|
2090
|
+
# The GCM API key from Google.
|
2091
|
+
# @return [String]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] enabled
|
2094
|
+
# If the channel is enabled for sending messages.
|
2095
|
+
# @return [Boolean]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] id
|
2098
|
+
# Channel ID. Not used, only for backwards compatibility.
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] is_archived
|
2102
|
+
# Is this channel archived
|
2103
|
+
# @return [Boolean]
|
2104
|
+
#
|
2105
|
+
# @!attribute [rw] last_modified_by
|
2106
|
+
# Who last updated this entry
|
2107
|
+
# @return [String]
|
2108
|
+
#
|
2109
|
+
# @!attribute [rw] last_modified_date
|
2110
|
+
# Last date this was updated
|
2111
|
+
# @return [String]
|
2112
|
+
#
|
2113
|
+
# @!attribute [rw] platform
|
2114
|
+
# The platform type. Will be GCM
|
2115
|
+
# @return [String]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] version
|
2118
|
+
# Version of channel
|
2119
|
+
# @return [Integer]
|
2120
|
+
#
|
2121
|
+
class GCMChannelResponse < Struct.new(
|
2122
|
+
:application_id,
|
2123
|
+
:creation_date,
|
2124
|
+
:credential,
|
2125
|
+
:enabled,
|
2126
|
+
:id,
|
2127
|
+
:is_archived,
|
2128
|
+
:last_modified_by,
|
2129
|
+
:last_modified_date,
|
2130
|
+
:platform,
|
2131
|
+
:version)
|
2132
|
+
include Aws::Structure
|
2133
|
+
end
|
2134
|
+
|
2135
|
+
# GCM Message.
|
2136
|
+
#
|
2137
|
+
# @note When making an API call, you may pass GCMMessage
|
2138
|
+
# data as a hash:
|
2139
|
+
#
|
2140
|
+
# {
|
2141
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2142
|
+
# body: "__string",
|
2143
|
+
# collapse_key: "__string",
|
2144
|
+
# data: {
|
2145
|
+
# "__string" => "__string",
|
2146
|
+
# },
|
2147
|
+
# icon_reference: "__string",
|
2148
|
+
# image_icon_url: "__string",
|
2149
|
+
# image_url: "__string",
|
2150
|
+
# raw_content: "__string",
|
2151
|
+
# restricted_package_name: "__string",
|
2152
|
+
# silent_push: false,
|
2153
|
+
# small_image_icon_url: "__string",
|
2154
|
+
# sound: "__string",
|
2155
|
+
# substitutions: {
|
2156
|
+
# "__string" => ["__string"],
|
2157
|
+
# },
|
2158
|
+
# title: "__string",
|
2159
|
+
# url: "__string",
|
2160
|
+
# }
|
2161
|
+
#
|
2162
|
+
# @!attribute [rw] action
|
2163
|
+
# The action that occurs if the user taps a push notification
|
2164
|
+
# delivered by the campaign: OPEN\_APP - Your app launches, or it
|
2165
|
+
# becomes the foreground app if it has been sent to the background.
|
2166
|
+
# This is the default action. DEEP\_LINK - Uses deep linking features
|
2167
|
+
# in iOS and Android to open your app and display a designated user
|
2168
|
+
# interface within the app. URL - The default mobile browser on the
|
2169
|
+
# user's device launches and opens a web page at the URL you specify.
|
2170
|
+
# Possible values include: OPEN\_APP \| DEEP\_LINK \| URL
|
2171
|
+
# @return [String]
|
2172
|
+
#
|
2173
|
+
# @!attribute [rw] body
|
2174
|
+
# The message body of the notification, the email body or the text
|
2175
|
+
# message.
|
2176
|
+
# @return [String]
|
2177
|
+
#
|
2178
|
+
# @!attribute [rw] collapse_key
|
2179
|
+
# This parameter identifies a group of messages (e.g., with
|
2180
|
+
# collapse\_key: "Updates Available") that can be collapsed, so that
|
2181
|
+
# only the last message gets sent when delivery can be resumed. This
|
2182
|
+
# is intended to avoid sending too many of the same messages when the
|
2183
|
+
# device comes back online or becomes active.
|
1350
2184
|
# @return [String]
|
1351
2185
|
#
|
1352
|
-
# @!attribute [rw]
|
1353
|
-
#
|
2186
|
+
# @!attribute [rw] data
|
2187
|
+
# @return [Hash<String,String>]
|
2188
|
+
#
|
2189
|
+
# @!attribute [rw] icon_reference
|
2190
|
+
# The icon image name of the asset saved in your application.
|
1354
2191
|
# @return [String]
|
1355
2192
|
#
|
1356
|
-
# @!attribute [rw]
|
1357
|
-
# The
|
2193
|
+
# @!attribute [rw] image_icon_url
|
2194
|
+
# The URL that points to an image used as the large icon to the
|
2195
|
+
# notification content view.
|
1358
2196
|
# @return [String]
|
1359
2197
|
#
|
1360
|
-
# @!attribute [rw]
|
1361
|
-
# The
|
2198
|
+
# @!attribute [rw] image_url
|
2199
|
+
# The URL that points to an image used in the push notification.
|
1362
2200
|
# @return [String]
|
1363
2201
|
#
|
1364
|
-
# @!attribute [rw]
|
1365
|
-
#
|
2202
|
+
# @!attribute [rw] raw_content
|
2203
|
+
# The Raw JSON formatted string to be used as the payload. This value
|
2204
|
+
# overrides the message.
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @!attribute [rw] restricted_package_name
|
2208
|
+
# This parameter specifies the package name of the application where
|
2209
|
+
# the registration tokens must match in order to receive the message.
|
2210
|
+
# @return [String]
|
2211
|
+
#
|
2212
|
+
# @!attribute [rw] silent_push
|
2213
|
+
# Indicates if the message should display on the users device. Silent
|
2214
|
+
# pushes can be used for Remote Configuration and Phone Home use
|
2215
|
+
# cases.
|
1366
2216
|
# @return [Boolean]
|
1367
2217
|
#
|
1368
|
-
# @!attribute [rw]
|
1369
|
-
#
|
2218
|
+
# @!attribute [rw] small_image_icon_url
|
2219
|
+
# The URL that points to an image used as the small icon for the
|
2220
|
+
# notification which will be used to represent the notification in the
|
2221
|
+
# status bar and content view
|
1370
2222
|
# @return [String]
|
1371
2223
|
#
|
1372
|
-
# @!attribute [rw]
|
1373
|
-
#
|
2224
|
+
# @!attribute [rw] sound
|
2225
|
+
# Indicates a sound to play when the device receives the notification.
|
2226
|
+
# Supports default, or the filename of a sound resource bundled in the
|
2227
|
+
# app. Android sound files must reside in /res/raw/
|
1374
2228
|
# @return [String]
|
1375
2229
|
#
|
1376
|
-
# @!attribute [rw]
|
1377
|
-
#
|
2230
|
+
# @!attribute [rw] substitutions
|
2231
|
+
# @return [Hash<String,Array<String>>]
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] title
|
2234
|
+
# The message title that displays above the message on the user's
|
2235
|
+
# device.
|
1378
2236
|
# @return [String]
|
1379
2237
|
#
|
1380
|
-
# @!attribute [rw]
|
1381
|
-
#
|
1382
|
-
#
|
2238
|
+
# @!attribute [rw] url
|
2239
|
+
# The URL to open in the user's mobile browser. Used if the value for
|
2240
|
+
# Action is URL.
|
2241
|
+
# @return [String]
|
1383
2242
|
#
|
1384
|
-
class
|
1385
|
-
:
|
1386
|
-
:
|
1387
|
-
:
|
1388
|
-
:
|
1389
|
-
:
|
1390
|
-
:
|
1391
|
-
:
|
1392
|
-
:
|
1393
|
-
:
|
2243
|
+
class GCMMessage < Struct.new(
|
2244
|
+
:action,
|
2245
|
+
:body,
|
2246
|
+
:collapse_key,
|
2247
|
+
:data,
|
2248
|
+
:icon_reference,
|
2249
|
+
:image_icon_url,
|
2250
|
+
:image_url,
|
2251
|
+
:raw_content,
|
2252
|
+
:restricted_package_name,
|
2253
|
+
:silent_push,
|
2254
|
+
:small_image_icon_url,
|
2255
|
+
:sound,
|
2256
|
+
:substitutions,
|
2257
|
+
:title,
|
2258
|
+
:url)
|
1394
2259
|
include Aws::Structure
|
1395
2260
|
end
|
1396
2261
|
|
@@ -1418,6 +2283,30 @@ module Aws::Pinpoint
|
|
1418
2283
|
include Aws::Structure
|
1419
2284
|
end
|
1420
2285
|
|
2286
|
+
# @note When making an API call, you may pass GetApnsSandboxChannelRequest
|
2287
|
+
# data as a hash:
|
2288
|
+
#
|
2289
|
+
# {
|
2290
|
+
# application_id: "__string", # required
|
2291
|
+
# }
|
2292
|
+
#
|
2293
|
+
# @!attribute [rw] application_id
|
2294
|
+
# @return [String]
|
2295
|
+
#
|
2296
|
+
class GetApnsSandboxChannelRequest < Struct.new(
|
2297
|
+
:application_id)
|
2298
|
+
include Aws::Structure
|
2299
|
+
end
|
2300
|
+
|
2301
|
+
# @!attribute [rw] apns_sandbox_channel_response
|
2302
|
+
# Apple Development Push Notification Service channel definition.
|
2303
|
+
# @return [Types::APNSSandboxChannelResponse]
|
2304
|
+
#
|
2305
|
+
class GetApnsSandboxChannelResponse < Struct.new(
|
2306
|
+
:apns_sandbox_channel_response)
|
2307
|
+
include Aws::Structure
|
2308
|
+
end
|
2309
|
+
|
1421
2310
|
# @note When making an API call, you may pass GetApplicationSettingsRequest
|
1422
2311
|
# data as a hash:
|
1423
2312
|
#
|
@@ -1617,6 +2506,30 @@ module Aws::Pinpoint
|
|
1617
2506
|
include Aws::Structure
|
1618
2507
|
end
|
1619
2508
|
|
2509
|
+
# @note When making an API call, you may pass GetEmailChannelRequest
|
2510
|
+
# data as a hash:
|
2511
|
+
#
|
2512
|
+
# {
|
2513
|
+
# application_id: "__string", # required
|
2514
|
+
# }
|
2515
|
+
#
|
2516
|
+
# @!attribute [rw] application_id
|
2517
|
+
# @return [String]
|
2518
|
+
#
|
2519
|
+
class GetEmailChannelRequest < Struct.new(
|
2520
|
+
:application_id)
|
2521
|
+
include Aws::Structure
|
2522
|
+
end
|
2523
|
+
|
2524
|
+
# @!attribute [rw] email_channel_response
|
2525
|
+
# Email Channel Response.
|
2526
|
+
# @return [Types::EmailChannelResponse]
|
2527
|
+
#
|
2528
|
+
class GetEmailChannelResponse < Struct.new(
|
2529
|
+
:email_channel_response)
|
2530
|
+
include Aws::Structure
|
2531
|
+
end
|
2532
|
+
|
1620
2533
|
# @note When making an API call, you may pass GetEndpointRequest
|
1621
2534
|
# data as a hash:
|
1622
2535
|
#
|
@@ -1932,6 +2845,30 @@ module Aws::Pinpoint
|
|
1932
2845
|
include Aws::Structure
|
1933
2846
|
end
|
1934
2847
|
|
2848
|
+
# @note When making an API call, you may pass GetSmsChannelRequest
|
2849
|
+
# data as a hash:
|
2850
|
+
#
|
2851
|
+
# {
|
2852
|
+
# application_id: "__string", # required
|
2853
|
+
# }
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] application_id
|
2856
|
+
# @return [String]
|
2857
|
+
#
|
2858
|
+
class GetSmsChannelRequest < Struct.new(
|
2859
|
+
:application_id)
|
2860
|
+
include Aws::Structure
|
2861
|
+
end
|
2862
|
+
|
2863
|
+
# @!attribute [rw] sms_channel_response
|
2864
|
+
# SMS Channel Response.
|
2865
|
+
# @return [Types::SMSChannelResponse]
|
2866
|
+
#
|
2867
|
+
class GetSmsChannelResponse < Struct.new(
|
2868
|
+
:sms_channel_response)
|
2869
|
+
include Aws::Structure
|
2870
|
+
end
|
2871
|
+
|
1935
2872
|
# @note When making an API call, you may pass ImportJobRequest
|
1936
2873
|
# data as a hash:
|
1937
2874
|
#
|
@@ -2155,6 +3092,7 @@ module Aws::Pinpoint
|
|
2155
3092
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2156
3093
|
# body: "__string",
|
2157
3094
|
# image_icon_url: "__string",
|
3095
|
+
# image_small_icon_url: "__string",
|
2158
3096
|
# image_url: "__string",
|
2159
3097
|
# json_body: "__string",
|
2160
3098
|
# media_url: "__string",
|
@@ -2165,11 +3103,11 @@ module Aws::Pinpoint
|
|
2165
3103
|
#
|
2166
3104
|
# @!attribute [rw] action
|
2167
3105
|
# The action that occurs if the user taps a push notification
|
2168
|
-
# delivered by the campaign: OPEN\_APP
|
3106
|
+
# delivered by the campaign: OPEN\_APP - Your app launches, or it
|
2169
3107
|
# becomes the foreground app if it has been sent to the background.
|
2170
|
-
# This is the default action. DEEP\_LINK
|
3108
|
+
# This is the default action. DEEP\_LINK - Uses deep linking features
|
2171
3109
|
# in iOS and Android to open your app and display a designated user
|
2172
|
-
# interface within the app. URL
|
3110
|
+
# interface within the app. URL - The default mobile browser on the
|
2173
3111
|
# user's device launches and opens a web page at the URL you specify.
|
2174
3112
|
# @return [String]
|
2175
3113
|
#
|
@@ -2182,6 +3120,11 @@ module Aws::Pinpoint
|
|
2182
3120
|
# icon, for example, the app icon.
|
2183
3121
|
# @return [String]
|
2184
3122
|
#
|
3123
|
+
# @!attribute [rw] image_small_icon_url
|
3124
|
+
# The URL that points to the small icon image for the push
|
3125
|
+
# notification icon, for example, the app icon.
|
3126
|
+
# @return [String]
|
3127
|
+
#
|
2185
3128
|
# @!attribute [rw] image_url
|
2186
3129
|
# The URL that points to an image used in the push notification.
|
2187
3130
|
# @return [String]
|
@@ -2215,6 +3158,7 @@ module Aws::Pinpoint
|
|
2215
3158
|
:action,
|
2216
3159
|
:body,
|
2217
3160
|
:image_icon_url,
|
3161
|
+
:image_small_icon_url,
|
2218
3162
|
:image_url,
|
2219
3163
|
:json_body,
|
2220
3164
|
:media_url,
|
@@ -2250,6 +3194,7 @@ module Aws::Pinpoint
|
|
2250
3194
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2251
3195
|
# body: "__string",
|
2252
3196
|
# image_icon_url: "__string",
|
3197
|
+
# image_small_icon_url: "__string",
|
2253
3198
|
# image_url: "__string",
|
2254
3199
|
# json_body: "__string",
|
2255
3200
|
# media_url: "__string",
|
@@ -2261,6 +3206,7 @@ module Aws::Pinpoint
|
|
2261
3206
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2262
3207
|
# body: "__string",
|
2263
3208
|
# image_icon_url: "__string",
|
3209
|
+
# image_small_icon_url: "__string",
|
2264
3210
|
# image_url: "__string",
|
2265
3211
|
# json_body: "__string",
|
2266
3212
|
# media_url: "__string",
|
@@ -2268,10 +3214,16 @@ module Aws::Pinpoint
|
|
2268
3214
|
# title: "__string",
|
2269
3215
|
# url: "__string",
|
2270
3216
|
# },
|
3217
|
+
# email_message: {
|
3218
|
+
# body: "__string",
|
3219
|
+
# html_body: "__string",
|
3220
|
+
# title: "__string",
|
3221
|
+
# },
|
2271
3222
|
# gcm_message: {
|
2272
3223
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2273
3224
|
# body: "__string",
|
2274
3225
|
# image_icon_url: "__string",
|
3226
|
+
# image_small_icon_url: "__string",
|
2275
3227
|
# image_url: "__string",
|
2276
3228
|
# json_body: "__string",
|
2277
3229
|
# media_url: "__string",
|
@@ -2279,6 +3231,11 @@ module Aws::Pinpoint
|
|
2279
3231
|
# title: "__string",
|
2280
3232
|
# url: "__string",
|
2281
3233
|
# },
|
3234
|
+
# sms_message: {
|
3235
|
+
# body: "__string",
|
3236
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3237
|
+
# sender_id: "__string",
|
3238
|
+
# },
|
2282
3239
|
# }
|
2283
3240
|
#
|
2284
3241
|
# @!attribute [rw] apns_message
|
@@ -2290,15 +3247,188 @@ module Aws::Pinpoint
|
|
2290
3247
|
# The default message for all channels.
|
2291
3248
|
# @return [Types::Message]
|
2292
3249
|
#
|
3250
|
+
# @!attribute [rw] email_message
|
3251
|
+
# The email message configuration.
|
3252
|
+
# @return [Types::CampaignEmailMessage]
|
3253
|
+
#
|
2293
3254
|
# @!attribute [rw] gcm_message
|
2294
3255
|
# The message that the campaign delivers to GCM channels. Overrides
|
2295
3256
|
# the default message.
|
2296
3257
|
# @return [Types::Message]
|
2297
3258
|
#
|
3259
|
+
# @!attribute [rw] sms_message
|
3260
|
+
# The SMS message configuration.
|
3261
|
+
# @return [Types::CampaignSmsMessage]
|
3262
|
+
#
|
2298
3263
|
class MessageConfiguration < Struct.new(
|
2299
3264
|
:apns_message,
|
2300
3265
|
:default_message,
|
2301
|
-
:
|
3266
|
+
:email_message,
|
3267
|
+
:gcm_message,
|
3268
|
+
:sms_message)
|
3269
|
+
include Aws::Structure
|
3270
|
+
end
|
3271
|
+
|
3272
|
+
# Send message request.
|
3273
|
+
#
|
3274
|
+
# @note When making an API call, you may pass MessageRequest
|
3275
|
+
# data as a hash:
|
3276
|
+
#
|
3277
|
+
# {
|
3278
|
+
# addresses: {
|
3279
|
+
# "__string" => {
|
3280
|
+
# body_override: "__string",
|
3281
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
3282
|
+
# context: {
|
3283
|
+
# "__string" => "__string",
|
3284
|
+
# },
|
3285
|
+
# raw_content: "__string",
|
3286
|
+
# substitutions: {
|
3287
|
+
# "__string" => ["__string"],
|
3288
|
+
# },
|
3289
|
+
# title_override: "__string",
|
3290
|
+
# },
|
3291
|
+
# },
|
3292
|
+
# context: {
|
3293
|
+
# "__string" => "__string",
|
3294
|
+
# },
|
3295
|
+
# message_configuration: {
|
3296
|
+
# apns_message: {
|
3297
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3298
|
+
# badge: 1,
|
3299
|
+
# body: "__string",
|
3300
|
+
# category: "__string",
|
3301
|
+
# data: {
|
3302
|
+
# "__string" => "__string",
|
3303
|
+
# },
|
3304
|
+
# media_url: "__string",
|
3305
|
+
# raw_content: "__string",
|
3306
|
+
# silent_push: false,
|
3307
|
+
# sound: "__string",
|
3308
|
+
# substitutions: {
|
3309
|
+
# "__string" => ["__string"],
|
3310
|
+
# },
|
3311
|
+
# thread_id: "__string",
|
3312
|
+
# title: "__string",
|
3313
|
+
# url: "__string",
|
3314
|
+
# },
|
3315
|
+
# default_message: {
|
3316
|
+
# body: "__string",
|
3317
|
+
# substitutions: {
|
3318
|
+
# "__string" => ["__string"],
|
3319
|
+
# },
|
3320
|
+
# },
|
3321
|
+
# default_push_notification_message: {
|
3322
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3323
|
+
# body: "__string",
|
3324
|
+
# data: {
|
3325
|
+
# "__string" => "__string",
|
3326
|
+
# },
|
3327
|
+
# silent_push: false,
|
3328
|
+
# substitutions: {
|
3329
|
+
# "__string" => ["__string"],
|
3330
|
+
# },
|
3331
|
+
# title: "__string",
|
3332
|
+
# url: "__string",
|
3333
|
+
# },
|
3334
|
+
# gcm_message: {
|
3335
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3336
|
+
# body: "__string",
|
3337
|
+
# collapse_key: "__string",
|
3338
|
+
# data: {
|
3339
|
+
# "__string" => "__string",
|
3340
|
+
# },
|
3341
|
+
# icon_reference: "__string",
|
3342
|
+
# image_icon_url: "__string",
|
3343
|
+
# image_url: "__string",
|
3344
|
+
# raw_content: "__string",
|
3345
|
+
# restricted_package_name: "__string",
|
3346
|
+
# silent_push: false,
|
3347
|
+
# small_image_icon_url: "__string",
|
3348
|
+
# sound: "__string",
|
3349
|
+
# substitutions: {
|
3350
|
+
# "__string" => ["__string"],
|
3351
|
+
# },
|
3352
|
+
# title: "__string",
|
3353
|
+
# url: "__string",
|
3354
|
+
# },
|
3355
|
+
# sms_message: {
|
3356
|
+
# body: "__string",
|
3357
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3358
|
+
# sender_id: "__string",
|
3359
|
+
# substitutions: {
|
3360
|
+
# "__string" => ["__string"],
|
3361
|
+
# },
|
3362
|
+
# },
|
3363
|
+
# },
|
3364
|
+
# }
|
3365
|
+
#
|
3366
|
+
# @!attribute [rw] addresses
|
3367
|
+
# A map of destination addresses, with the address as the key(Email
|
3368
|
+
# address, phone number or push token) and the Address Configuration
|
3369
|
+
# as the value.
|
3370
|
+
# @return [Hash<String,Types::AddressConfiguration>]
|
3371
|
+
#
|
3372
|
+
# @!attribute [rw] context
|
3373
|
+
# @return [Hash<String,String>]
|
3374
|
+
#
|
3375
|
+
# @!attribute [rw] message_configuration
|
3376
|
+
# Message configuration.
|
3377
|
+
# @return [Types::DirectMessageConfiguration]
|
3378
|
+
#
|
3379
|
+
class MessageRequest < Struct.new(
|
3380
|
+
:addresses,
|
3381
|
+
:context,
|
3382
|
+
:message_configuration)
|
3383
|
+
include Aws::Structure
|
3384
|
+
end
|
3385
|
+
|
3386
|
+
# Send message response.
|
3387
|
+
#
|
3388
|
+
# @!attribute [rw] application_id
|
3389
|
+
# Application id of the message.
|
3390
|
+
# @return [String]
|
3391
|
+
#
|
3392
|
+
# @!attribute [rw] request_id
|
3393
|
+
# Original request Id for which this message was delivered.
|
3394
|
+
# @return [String]
|
3395
|
+
#
|
3396
|
+
# @!attribute [rw] result
|
3397
|
+
# A map containing a multi part response for each address, with the
|
3398
|
+
# address as the key(Email address, phone number or push token) and
|
3399
|
+
# the result as the value.
|
3400
|
+
# @return [Hash<String,Types::MessageResult>]
|
3401
|
+
#
|
3402
|
+
class MessageResponse < Struct.new(
|
3403
|
+
:application_id,
|
3404
|
+
:request_id,
|
3405
|
+
:result)
|
3406
|
+
include Aws::Structure
|
3407
|
+
end
|
3408
|
+
|
3409
|
+
# The result from sending a message to an address.
|
3410
|
+
#
|
3411
|
+
# @!attribute [rw] delivery_status
|
3412
|
+
# Delivery status of message.
|
3413
|
+
# @return [String]
|
3414
|
+
#
|
3415
|
+
# @!attribute [rw] status_code
|
3416
|
+
# Downstream service status code.
|
3417
|
+
# @return [Integer]
|
3418
|
+
#
|
3419
|
+
# @!attribute [rw] status_message
|
3420
|
+
# Status message for message delivery.
|
3421
|
+
# @return [String]
|
3422
|
+
#
|
3423
|
+
# @!attribute [rw] updated_token
|
3424
|
+
# If token was updated as part of delivery. (This is GCM Specific)
|
3425
|
+
# @return [String]
|
3426
|
+
#
|
3427
|
+
class MessageResult < Struct.new(
|
3428
|
+
:delivery_status,
|
3429
|
+
:status_code,
|
3430
|
+
:status_message,
|
3431
|
+
:updated_token)
|
2302
3432
|
include Aws::Structure
|
2303
3433
|
end
|
2304
3434
|
|
@@ -2309,7 +3439,6 @@ module Aws::Pinpoint
|
|
2309
3439
|
# application_id: "__string", # required
|
2310
3440
|
# write_event_stream: { # required
|
2311
3441
|
# destination_stream_arn: "__string",
|
2312
|
-
# external_id: "__string",
|
2313
3442
|
# role_arn: "__string",
|
2314
3443
|
# },
|
2315
3444
|
# }
|
@@ -2337,55 +3466,178 @@ module Aws::Pinpoint
|
|
2337
3466
|
include Aws::Structure
|
2338
3467
|
end
|
2339
3468
|
|
2340
|
-
# Quiet Time
|
3469
|
+
# Quiet Time
|
3470
|
+
#
|
3471
|
+
# @note When making an API call, you may pass QuietTime
|
3472
|
+
# data as a hash:
|
3473
|
+
#
|
3474
|
+
# {
|
3475
|
+
# end: "__string",
|
3476
|
+
# start: "__string",
|
3477
|
+
# }
|
3478
|
+
#
|
3479
|
+
# @!attribute [rw] end
|
3480
|
+
# The default end time for quiet time in ISO 8601 format.
|
3481
|
+
# @return [String]
|
3482
|
+
#
|
3483
|
+
# @!attribute [rw] start
|
3484
|
+
# The default start time for quiet time in ISO 8601 format.
|
3485
|
+
# @return [String]
|
3486
|
+
#
|
3487
|
+
class QuietTime < Struct.new(
|
3488
|
+
:end,
|
3489
|
+
:start)
|
3490
|
+
include Aws::Structure
|
3491
|
+
end
|
3492
|
+
|
3493
|
+
# Define how a segment based on recency of use.
|
3494
|
+
#
|
3495
|
+
# @note When making an API call, you may pass RecencyDimension
|
3496
|
+
# data as a hash:
|
3497
|
+
#
|
3498
|
+
# {
|
3499
|
+
# duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
|
3500
|
+
# recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
|
3501
|
+
# }
|
3502
|
+
#
|
3503
|
+
# @!attribute [rw] duration
|
3504
|
+
# The length of time during which users have been active or inactive
|
3505
|
+
# with your app. Valid values: HR\_24, DAY\_7, DAY\_14, DAY\_30
|
3506
|
+
# @return [String]
|
3507
|
+
#
|
3508
|
+
# @!attribute [rw] recency_type
|
3509
|
+
# The recency dimension type: ACTIVE - Users who have used your app
|
3510
|
+
# within the specified duration are included in the segment. INACTIVE
|
3511
|
+
# - Users who have not used your app within the specified duration are
|
3512
|
+
# included in the segment.
|
3513
|
+
# @return [String]
|
3514
|
+
#
|
3515
|
+
class RecencyDimension < Struct.new(
|
3516
|
+
:duration,
|
3517
|
+
:recency_type)
|
3518
|
+
include Aws::Structure
|
3519
|
+
end
|
3520
|
+
|
3521
|
+
# SMS Channel Request
|
2341
3522
|
#
|
2342
|
-
# @note When making an API call, you may pass
|
3523
|
+
# @note When making an API call, you may pass SMSChannelRequest
|
2343
3524
|
# data as a hash:
|
2344
3525
|
#
|
2345
3526
|
# {
|
2346
|
-
#
|
2347
|
-
#
|
3527
|
+
# enabled: false,
|
3528
|
+
# sender_id: "__string",
|
2348
3529
|
# }
|
2349
3530
|
#
|
2350
|
-
# @!attribute [rw]
|
2351
|
-
#
|
3531
|
+
# @!attribute [rw] enabled
|
3532
|
+
# If the channel is enabled for sending messages.
|
3533
|
+
# @return [Boolean]
|
3534
|
+
#
|
3535
|
+
# @!attribute [rw] sender_id
|
3536
|
+
# Sender identifier of your messages.
|
2352
3537
|
# @return [String]
|
2353
3538
|
#
|
2354
|
-
|
2355
|
-
|
3539
|
+
class SMSChannelRequest < Struct.new(
|
3540
|
+
:enabled,
|
3541
|
+
:sender_id)
|
3542
|
+
include Aws::Structure
|
3543
|
+
end
|
3544
|
+
|
3545
|
+
# SMS Channel Response.
|
3546
|
+
#
|
3547
|
+
# @!attribute [rw] application_id
|
3548
|
+
# Application id
|
2356
3549
|
# @return [String]
|
2357
3550
|
#
|
2358
|
-
|
2359
|
-
|
2360
|
-
|
3551
|
+
# @!attribute [rw] creation_date
|
3552
|
+
# The date that the settings were last updated in ISO 8601 format.
|
3553
|
+
# @return [String]
|
3554
|
+
#
|
3555
|
+
# @!attribute [rw] enabled
|
3556
|
+
# If the channel is enabled for sending messages.
|
3557
|
+
# @return [Boolean]
|
3558
|
+
#
|
3559
|
+
# @!attribute [rw] id
|
3560
|
+
# Channel ID. Not used, only for backwards compatibility.
|
3561
|
+
# @return [String]
|
3562
|
+
#
|
3563
|
+
# @!attribute [rw] is_archived
|
3564
|
+
# Is this channel archived
|
3565
|
+
# @return [Boolean]
|
3566
|
+
#
|
3567
|
+
# @!attribute [rw] last_modified_by
|
3568
|
+
# Who last updated this entry
|
3569
|
+
# @return [String]
|
3570
|
+
#
|
3571
|
+
# @!attribute [rw] last_modified_date
|
3572
|
+
# Last date this was updated
|
3573
|
+
# @return [String]
|
3574
|
+
#
|
3575
|
+
# @!attribute [rw] platform
|
3576
|
+
# Platform type. Will be "SMS"
|
3577
|
+
# @return [String]
|
3578
|
+
#
|
3579
|
+
# @!attribute [rw] sender_id
|
3580
|
+
# Sender identifier of your messages.
|
3581
|
+
# @return [String]
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] short_code
|
3584
|
+
# The short code registered with the phone provider.
|
3585
|
+
# @return [String]
|
3586
|
+
#
|
3587
|
+
# @!attribute [rw] version
|
3588
|
+
# Version of channel
|
3589
|
+
# @return [Integer]
|
3590
|
+
#
|
3591
|
+
class SMSChannelResponse < Struct.new(
|
3592
|
+
:application_id,
|
3593
|
+
:creation_date,
|
3594
|
+
:enabled,
|
3595
|
+
:id,
|
3596
|
+
:is_archived,
|
3597
|
+
:last_modified_by,
|
3598
|
+
:last_modified_date,
|
3599
|
+
:platform,
|
3600
|
+
:sender_id,
|
3601
|
+
:short_code,
|
3602
|
+
:version)
|
2361
3603
|
include Aws::Structure
|
2362
3604
|
end
|
2363
3605
|
|
2364
|
-
#
|
3606
|
+
# SMS Message.
|
2365
3607
|
#
|
2366
|
-
# @note When making an API call, you may pass
|
3608
|
+
# @note When making an API call, you may pass SMSMessage
|
2367
3609
|
# data as a hash:
|
2368
3610
|
#
|
2369
3611
|
# {
|
2370
|
-
#
|
2371
|
-
#
|
3612
|
+
# body: "__string",
|
3613
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3614
|
+
# sender_id: "__string",
|
3615
|
+
# substitutions: {
|
3616
|
+
# "__string" => ["__string"],
|
3617
|
+
# },
|
2372
3618
|
# }
|
2373
3619
|
#
|
2374
|
-
# @!attribute [rw]
|
2375
|
-
# The
|
2376
|
-
#
|
3620
|
+
# @!attribute [rw] body
|
3621
|
+
# The message body of the notification, the email body or the text
|
3622
|
+
# message.
|
2377
3623
|
# @return [String]
|
2378
3624
|
#
|
2379
|
-
# @!attribute [rw]
|
2380
|
-
#
|
2381
|
-
# within the specified duration are included in the segment. INACTIVE
|
2382
|
-
# – Users who have not used your app within the specified duration are
|
2383
|
-
# included in the segment.
|
3625
|
+
# @!attribute [rw] message_type
|
3626
|
+
# Is this a transaction priority message or lower priority.
|
2384
3627
|
# @return [String]
|
2385
3628
|
#
|
2386
|
-
|
2387
|
-
|
2388
|
-
|
3629
|
+
# @!attribute [rw] sender_id
|
3630
|
+
# Sender ID of sent message.
|
3631
|
+
# @return [String]
|
3632
|
+
#
|
3633
|
+
# @!attribute [rw] substitutions
|
3634
|
+
# @return [Hash<String,Array<String>>]
|
3635
|
+
#
|
3636
|
+
class SMSMessage < Struct.new(
|
3637
|
+
:body,
|
3638
|
+
:message_type,
|
3639
|
+
:sender_id,
|
3640
|
+
:substitutions)
|
2389
3641
|
include Aws::Structure
|
2390
3642
|
end
|
2391
3643
|
|
@@ -2477,6 +3729,10 @@ module Aws::Pinpoint
|
|
2477
3729
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2478
3730
|
# values: ["__string"],
|
2479
3731
|
# },
|
3732
|
+
# channel: {
|
3733
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3734
|
+
# values: ["__string"],
|
3735
|
+
# },
|
2480
3736
|
# device_type: {
|
2481
3737
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2482
3738
|
# values: ["__string"],
|
@@ -2499,6 +3755,10 @@ module Aws::Pinpoint
|
|
2499
3755
|
# The app version criteria for the segment.
|
2500
3756
|
# @return [Types::SetDimension]
|
2501
3757
|
#
|
3758
|
+
# @!attribute [rw] channel
|
3759
|
+
# The channel criteria for the segment.
|
3760
|
+
# @return [Types::SetDimension]
|
3761
|
+
#
|
2502
3762
|
# @!attribute [rw] device_type
|
2503
3763
|
# The device type criteria for the segment.
|
2504
3764
|
# @return [Types::SetDimension]
|
@@ -2517,6 +3777,7 @@ module Aws::Pinpoint
|
|
2517
3777
|
#
|
2518
3778
|
class SegmentDemographics < Struct.new(
|
2519
3779
|
:app_version,
|
3780
|
+
:channel,
|
2520
3781
|
:device_type,
|
2521
3782
|
:make,
|
2522
3783
|
:model,
|
@@ -2547,6 +3808,10 @@ module Aws::Pinpoint
|
|
2547
3808
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2548
3809
|
# values: ["__string"],
|
2549
3810
|
# },
|
3811
|
+
# channel: {
|
3812
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3813
|
+
# values: ["__string"],
|
3814
|
+
# },
|
2550
3815
|
# device_type: {
|
2551
3816
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2552
3817
|
# values: ["__string"],
|
@@ -2609,6 +3874,9 @@ module Aws::Pinpoint
|
|
2609
3874
|
|
2610
3875
|
# Segment import definition.
|
2611
3876
|
#
|
3877
|
+
# @!attribute [rw] channel_counts
|
3878
|
+
# @return [Hash<String,Integer>]
|
3879
|
+
#
|
2612
3880
|
# @!attribute [rw] external_id
|
2613
3881
|
# A unique, custom ID assigned to the IAM role that restricts who can
|
2614
3882
|
# assume the role.
|
@@ -2635,6 +3903,7 @@ module Aws::Pinpoint
|
|
2635
3903
|
# @return [Integer]
|
2636
3904
|
#
|
2637
3905
|
class SegmentImportResource < Struct.new(
|
3906
|
+
:channel_counts,
|
2638
3907
|
:external_id,
|
2639
3908
|
:format,
|
2640
3909
|
:role_arn,
|
@@ -2695,11 +3964,11 @@ module Aws::Pinpoint
|
|
2695
3964
|
# @return [String]
|
2696
3965
|
#
|
2697
3966
|
# @!attribute [rw] segment_type
|
2698
|
-
# The segment type: DIMENSIONAL
|
3967
|
+
# The segment type: DIMENSIONAL - A dynamic segment built from
|
2699
3968
|
# selection criteria based on endpoint data reported by your app. You
|
2700
3969
|
# create this type of segment by using the segment builder in the
|
2701
3970
|
# Amazon Pinpoint console or by making a POST request to the segments
|
2702
|
-
# resource. IMPORT
|
3971
|
+
# resource. IMPORT - A static segment built from an imported set of
|
2703
3972
|
# endpoint definitions. You create this type of segment by importing a
|
2704
3973
|
# segment in the Amazon Pinpoint console or by making a POST request
|
2705
3974
|
# to the jobs/import resource.
|
@@ -2739,6 +4008,123 @@ module Aws::Pinpoint
|
|
2739
4008
|
include Aws::Structure
|
2740
4009
|
end
|
2741
4010
|
|
4011
|
+
# @note When making an API call, you may pass SendMessagesRequest
|
4012
|
+
# data as a hash:
|
4013
|
+
#
|
4014
|
+
# {
|
4015
|
+
# application_id: "__string", # required
|
4016
|
+
# message_request: { # required
|
4017
|
+
# addresses: {
|
4018
|
+
# "__string" => {
|
4019
|
+
# body_override: "__string",
|
4020
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
4021
|
+
# context: {
|
4022
|
+
# "__string" => "__string",
|
4023
|
+
# },
|
4024
|
+
# raw_content: "__string",
|
4025
|
+
# substitutions: {
|
4026
|
+
# "__string" => ["__string"],
|
4027
|
+
# },
|
4028
|
+
# title_override: "__string",
|
4029
|
+
# },
|
4030
|
+
# },
|
4031
|
+
# context: {
|
4032
|
+
# "__string" => "__string",
|
4033
|
+
# },
|
4034
|
+
# message_configuration: {
|
4035
|
+
# apns_message: {
|
4036
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4037
|
+
# badge: 1,
|
4038
|
+
# body: "__string",
|
4039
|
+
# category: "__string",
|
4040
|
+
# data: {
|
4041
|
+
# "__string" => "__string",
|
4042
|
+
# },
|
4043
|
+
# media_url: "__string",
|
4044
|
+
# raw_content: "__string",
|
4045
|
+
# silent_push: false,
|
4046
|
+
# sound: "__string",
|
4047
|
+
# substitutions: {
|
4048
|
+
# "__string" => ["__string"],
|
4049
|
+
# },
|
4050
|
+
# thread_id: "__string",
|
4051
|
+
# title: "__string",
|
4052
|
+
# url: "__string",
|
4053
|
+
# },
|
4054
|
+
# default_message: {
|
4055
|
+
# body: "__string",
|
4056
|
+
# substitutions: {
|
4057
|
+
# "__string" => ["__string"],
|
4058
|
+
# },
|
4059
|
+
# },
|
4060
|
+
# default_push_notification_message: {
|
4061
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4062
|
+
# body: "__string",
|
4063
|
+
# data: {
|
4064
|
+
# "__string" => "__string",
|
4065
|
+
# },
|
4066
|
+
# silent_push: false,
|
4067
|
+
# substitutions: {
|
4068
|
+
# "__string" => ["__string"],
|
4069
|
+
# },
|
4070
|
+
# title: "__string",
|
4071
|
+
# url: "__string",
|
4072
|
+
# },
|
4073
|
+
# gcm_message: {
|
4074
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4075
|
+
# body: "__string",
|
4076
|
+
# collapse_key: "__string",
|
4077
|
+
# data: {
|
4078
|
+
# "__string" => "__string",
|
4079
|
+
# },
|
4080
|
+
# icon_reference: "__string",
|
4081
|
+
# image_icon_url: "__string",
|
4082
|
+
# image_url: "__string",
|
4083
|
+
# raw_content: "__string",
|
4084
|
+
# restricted_package_name: "__string",
|
4085
|
+
# silent_push: false,
|
4086
|
+
# small_image_icon_url: "__string",
|
4087
|
+
# sound: "__string",
|
4088
|
+
# substitutions: {
|
4089
|
+
# "__string" => ["__string"],
|
4090
|
+
# },
|
4091
|
+
# title: "__string",
|
4092
|
+
# url: "__string",
|
4093
|
+
# },
|
4094
|
+
# sms_message: {
|
4095
|
+
# body: "__string",
|
4096
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4097
|
+
# sender_id: "__string",
|
4098
|
+
# substitutions: {
|
4099
|
+
# "__string" => ["__string"],
|
4100
|
+
# },
|
4101
|
+
# },
|
4102
|
+
# },
|
4103
|
+
# },
|
4104
|
+
# }
|
4105
|
+
#
|
4106
|
+
# @!attribute [rw] application_id
|
4107
|
+
# @return [String]
|
4108
|
+
#
|
4109
|
+
# @!attribute [rw] message_request
|
4110
|
+
# Send message request.
|
4111
|
+
# @return [Types::MessageRequest]
|
4112
|
+
#
|
4113
|
+
class SendMessagesRequest < Struct.new(
|
4114
|
+
:application_id,
|
4115
|
+
:message_request)
|
4116
|
+
include Aws::Structure
|
4117
|
+
end
|
4118
|
+
|
4119
|
+
# @!attribute [rw] message_response
|
4120
|
+
# Send message response.
|
4121
|
+
# @return [Types::MessageResponse]
|
4122
|
+
#
|
4123
|
+
class SendMessagesResponse < Struct.new(
|
4124
|
+
:message_response)
|
4125
|
+
include Aws::Structure
|
4126
|
+
end
|
4127
|
+
|
2742
4128
|
# Dimension specification of a segment.
|
2743
4129
|
#
|
2744
4130
|
# @note When making an API call, you may pass SetDimension
|
@@ -2750,8 +4136,8 @@ module Aws::Pinpoint
|
|
2750
4136
|
# }
|
2751
4137
|
#
|
2752
4138
|
# @!attribute [rw] dimension_type
|
2753
|
-
# The type of dimension: INCLUSIVE
|
2754
|
-
# are included in the segment. EXCLUSIVE
|
4139
|
+
# The type of dimension: INCLUSIVE - Endpoints that match the criteria
|
4140
|
+
# are included in the segment. EXCLUSIVE - Endpoints that match the
|
2755
4141
|
# criteria are excluded from the segment.
|
2756
4142
|
# @return [String]
|
2757
4143
|
#
|
@@ -2811,6 +4197,7 @@ module Aws::Pinpoint
|
|
2811
4197
|
# {
|
2812
4198
|
# apns_channel_request: { # required
|
2813
4199
|
# certificate: "__string",
|
4200
|
+
# enabled: false,
|
2814
4201
|
# private_key: "__string",
|
2815
4202
|
# },
|
2816
4203
|
# application_id: "__string", # required
|
@@ -2838,6 +4225,40 @@ module Aws::Pinpoint
|
|
2838
4225
|
include Aws::Structure
|
2839
4226
|
end
|
2840
4227
|
|
4228
|
+
# @note When making an API call, you may pass UpdateApnsSandboxChannelRequest
|
4229
|
+
# data as a hash:
|
4230
|
+
#
|
4231
|
+
# {
|
4232
|
+
# apns_sandbox_channel_request: { # required
|
4233
|
+
# certificate: "__string",
|
4234
|
+
# enabled: false,
|
4235
|
+
# private_key: "__string",
|
4236
|
+
# },
|
4237
|
+
# application_id: "__string", # required
|
4238
|
+
# }
|
4239
|
+
#
|
4240
|
+
# @!attribute [rw] apns_sandbox_channel_request
|
4241
|
+
# Apple Development Push Notification Service channel definition.
|
4242
|
+
# @return [Types::APNSSandboxChannelRequest]
|
4243
|
+
#
|
4244
|
+
# @!attribute [rw] application_id
|
4245
|
+
# @return [String]
|
4246
|
+
#
|
4247
|
+
class UpdateApnsSandboxChannelRequest < Struct.new(
|
4248
|
+
:apns_sandbox_channel_request,
|
4249
|
+
:application_id)
|
4250
|
+
include Aws::Structure
|
4251
|
+
end
|
4252
|
+
|
4253
|
+
# @!attribute [rw] apns_sandbox_channel_response
|
4254
|
+
# Apple Development Push Notification Service channel definition.
|
4255
|
+
# @return [Types::APNSSandboxChannelResponse]
|
4256
|
+
#
|
4257
|
+
class UpdateApnsSandboxChannelResponse < Struct.new(
|
4258
|
+
:apns_sandbox_channel_response)
|
4259
|
+
include Aws::Structure
|
4260
|
+
end
|
4261
|
+
|
2841
4262
|
# @note When making an API call, you may pass UpdateApplicationSettingsRequest
|
2842
4263
|
# data as a hash:
|
2843
4264
|
#
|
@@ -2891,6 +4312,7 @@ module Aws::Pinpoint
|
|
2891
4312
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2892
4313
|
# body: "__string",
|
2893
4314
|
# image_icon_url: "__string",
|
4315
|
+
# image_small_icon_url: "__string",
|
2894
4316
|
# image_url: "__string",
|
2895
4317
|
# json_body: "__string",
|
2896
4318
|
# media_url: "__string",
|
@@ -2902,6 +4324,7 @@ module Aws::Pinpoint
|
|
2902
4324
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2903
4325
|
# body: "__string",
|
2904
4326
|
# image_icon_url: "__string",
|
4327
|
+
# image_small_icon_url: "__string",
|
2905
4328
|
# image_url: "__string",
|
2906
4329
|
# json_body: "__string",
|
2907
4330
|
# media_url: "__string",
|
@@ -2909,10 +4332,16 @@ module Aws::Pinpoint
|
|
2909
4332
|
# title: "__string",
|
2910
4333
|
# url: "__string",
|
2911
4334
|
# },
|
4335
|
+
# email_message: {
|
4336
|
+
# body: "__string",
|
4337
|
+
# html_body: "__string",
|
4338
|
+
# title: "__string",
|
4339
|
+
# },
|
2912
4340
|
# gcm_message: {
|
2913
4341
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2914
4342
|
# body: "__string",
|
2915
4343
|
# image_icon_url: "__string",
|
4344
|
+
# image_small_icon_url: "__string",
|
2916
4345
|
# image_url: "__string",
|
2917
4346
|
# json_body: "__string",
|
2918
4347
|
# media_url: "__string",
|
@@ -2920,6 +4349,11 @@ module Aws::Pinpoint
|
|
2920
4349
|
# title: "__string",
|
2921
4350
|
# url: "__string",
|
2922
4351
|
# },
|
4352
|
+
# sms_message: {
|
4353
|
+
# body: "__string",
|
4354
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4355
|
+
# sender_id: "__string",
|
4356
|
+
# },
|
2923
4357
|
# },
|
2924
4358
|
# schedule: {
|
2925
4359
|
# end_time: "__string",
|
@@ -2949,6 +4383,7 @@ module Aws::Pinpoint
|
|
2949
4383
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2950
4384
|
# body: "__string",
|
2951
4385
|
# image_icon_url: "__string",
|
4386
|
+
# image_small_icon_url: "__string",
|
2952
4387
|
# image_url: "__string",
|
2953
4388
|
# json_body: "__string",
|
2954
4389
|
# media_url: "__string",
|
@@ -2960,6 +4395,7 @@ module Aws::Pinpoint
|
|
2960
4395
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2961
4396
|
# body: "__string",
|
2962
4397
|
# image_icon_url: "__string",
|
4398
|
+
# image_small_icon_url: "__string",
|
2963
4399
|
# image_url: "__string",
|
2964
4400
|
# json_body: "__string",
|
2965
4401
|
# media_url: "__string",
|
@@ -2967,10 +4403,16 @@ module Aws::Pinpoint
|
|
2967
4403
|
# title: "__string",
|
2968
4404
|
# url: "__string",
|
2969
4405
|
# },
|
4406
|
+
# email_message: {
|
4407
|
+
# body: "__string",
|
4408
|
+
# html_body: "__string",
|
4409
|
+
# title: "__string",
|
4410
|
+
# },
|
2970
4411
|
# gcm_message: {
|
2971
4412
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
2972
4413
|
# body: "__string",
|
2973
4414
|
# image_icon_url: "__string",
|
4415
|
+
# image_small_icon_url: "__string",
|
2974
4416
|
# image_url: "__string",
|
2975
4417
|
# json_body: "__string",
|
2976
4418
|
# media_url: "__string",
|
@@ -2978,6 +4420,11 @@ module Aws::Pinpoint
|
|
2978
4420
|
# title: "__string",
|
2979
4421
|
# url: "__string",
|
2980
4422
|
# },
|
4423
|
+
# sms_message: {
|
4424
|
+
# body: "__string",
|
4425
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4426
|
+
# sender_id: "__string",
|
4427
|
+
# },
|
2981
4428
|
# },
|
2982
4429
|
# name: "__string",
|
2983
4430
|
# schedule: {
|
@@ -3024,6 +4471,41 @@ module Aws::Pinpoint
|
|
3024
4471
|
include Aws::Structure
|
3025
4472
|
end
|
3026
4473
|
|
4474
|
+
# @note When making an API call, you may pass UpdateEmailChannelRequest
|
4475
|
+
# data as a hash:
|
4476
|
+
#
|
4477
|
+
# {
|
4478
|
+
# application_id: "__string", # required
|
4479
|
+
# email_channel_request: { # required
|
4480
|
+
# enabled: false,
|
4481
|
+
# from_address: "__string",
|
4482
|
+
# identity: "__string",
|
4483
|
+
# role_arn: "__string",
|
4484
|
+
# },
|
4485
|
+
# }
|
4486
|
+
#
|
4487
|
+
# @!attribute [rw] application_id
|
4488
|
+
# @return [String]
|
4489
|
+
#
|
4490
|
+
# @!attribute [rw] email_channel_request
|
4491
|
+
# Email Channel Request
|
4492
|
+
# @return [Types::EmailChannelRequest]
|
4493
|
+
#
|
4494
|
+
class UpdateEmailChannelRequest < Struct.new(
|
4495
|
+
:application_id,
|
4496
|
+
:email_channel_request)
|
4497
|
+
include Aws::Structure
|
4498
|
+
end
|
4499
|
+
|
4500
|
+
# @!attribute [rw] email_channel_response
|
4501
|
+
# Email Channel Response.
|
4502
|
+
# @return [Types::EmailChannelResponse]
|
4503
|
+
#
|
4504
|
+
class UpdateEmailChannelResponse < Struct.new(
|
4505
|
+
:email_channel_response)
|
4506
|
+
include Aws::Structure
|
4507
|
+
end
|
4508
|
+
|
3027
4509
|
# @note When making an API call, you may pass UpdateEndpointRequest
|
3028
4510
|
# data as a hash:
|
3029
4511
|
#
|
@@ -3035,7 +4517,7 @@ module Aws::Pinpoint
|
|
3035
4517
|
# attributes: {
|
3036
4518
|
# "__string" => ["__string"],
|
3037
4519
|
# },
|
3038
|
-
# channel_type: "
|
4520
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
3039
4521
|
# demographic: {
|
3040
4522
|
# app_version: "__string",
|
3041
4523
|
# locale: "__string",
|
@@ -3108,7 +4590,7 @@ module Aws::Pinpoint
|
|
3108
4590
|
# attributes: {
|
3109
4591
|
# "__string" => ["__string"],
|
3110
4592
|
# },
|
3111
|
-
# channel_type: "
|
4593
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
|
3112
4594
|
# demographic: {
|
3113
4595
|
# app_version: "__string",
|
3114
4596
|
# locale: "__string",
|
@@ -3175,6 +4657,7 @@ module Aws::Pinpoint
|
|
3175
4657
|
# application_id: "__string", # required
|
3176
4658
|
# gcm_channel_request: { # required
|
3177
4659
|
# api_key: "__string",
|
4660
|
+
# enabled: false,
|
3178
4661
|
# },
|
3179
4662
|
# }
|
3180
4663
|
#
|
@@ -3225,6 +4708,10 @@ module Aws::Pinpoint
|
|
3225
4708
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3226
4709
|
# values: ["__string"],
|
3227
4710
|
# },
|
4711
|
+
# channel: {
|
4712
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4713
|
+
# values: ["__string"],
|
4714
|
+
# },
|
3228
4715
|
# device_type: {
|
3229
4716
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3230
4717
|
# values: ["__string"],
|
@@ -3285,6 +4772,39 @@ module Aws::Pinpoint
|
|
3285
4772
|
include Aws::Structure
|
3286
4773
|
end
|
3287
4774
|
|
4775
|
+
# @note When making an API call, you may pass UpdateSmsChannelRequest
|
4776
|
+
# data as a hash:
|
4777
|
+
#
|
4778
|
+
# {
|
4779
|
+
# application_id: "__string", # required
|
4780
|
+
# sms_channel_request: { # required
|
4781
|
+
# enabled: false,
|
4782
|
+
# sender_id: "__string",
|
4783
|
+
# },
|
4784
|
+
# }
|
4785
|
+
#
|
4786
|
+
# @!attribute [rw] application_id
|
4787
|
+
# @return [String]
|
4788
|
+
#
|
4789
|
+
# @!attribute [rw] sms_channel_request
|
4790
|
+
# SMS Channel Request
|
4791
|
+
# @return [Types::SMSChannelRequest]
|
4792
|
+
#
|
4793
|
+
class UpdateSmsChannelRequest < Struct.new(
|
4794
|
+
:application_id,
|
4795
|
+
:sms_channel_request)
|
4796
|
+
include Aws::Structure
|
4797
|
+
end
|
4798
|
+
|
4799
|
+
# @!attribute [rw] sms_channel_response
|
4800
|
+
# SMS Channel Response.
|
4801
|
+
# @return [Types::SMSChannelResponse]
|
4802
|
+
#
|
4803
|
+
class UpdateSmsChannelResponse < Struct.new(
|
4804
|
+
:sms_channel_response)
|
4805
|
+
include Aws::Structure
|
4806
|
+
end
|
4807
|
+
|
3288
4808
|
# Creating application setting request
|
3289
4809
|
#
|
3290
4810
|
# @note When making an API call, you may pass WriteApplicationSettingsRequest
|
@@ -3332,6 +4852,7 @@ module Aws::Pinpoint
|
|
3332
4852
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3333
4853
|
# body: "__string",
|
3334
4854
|
# image_icon_url: "__string",
|
4855
|
+
# image_small_icon_url: "__string",
|
3335
4856
|
# image_url: "__string",
|
3336
4857
|
# json_body: "__string",
|
3337
4858
|
# media_url: "__string",
|
@@ -3343,6 +4864,7 @@ module Aws::Pinpoint
|
|
3343
4864
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3344
4865
|
# body: "__string",
|
3345
4866
|
# image_icon_url: "__string",
|
4867
|
+
# image_small_icon_url: "__string",
|
3346
4868
|
# image_url: "__string",
|
3347
4869
|
# json_body: "__string",
|
3348
4870
|
# media_url: "__string",
|
@@ -3350,10 +4872,16 @@ module Aws::Pinpoint
|
|
3350
4872
|
# title: "__string",
|
3351
4873
|
# url: "__string",
|
3352
4874
|
# },
|
4875
|
+
# email_message: {
|
4876
|
+
# body: "__string",
|
4877
|
+
# html_body: "__string",
|
4878
|
+
# title: "__string",
|
4879
|
+
# },
|
3353
4880
|
# gcm_message: {
|
3354
4881
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3355
4882
|
# body: "__string",
|
3356
4883
|
# image_icon_url: "__string",
|
4884
|
+
# image_small_icon_url: "__string",
|
3357
4885
|
# image_url: "__string",
|
3358
4886
|
# json_body: "__string",
|
3359
4887
|
# media_url: "__string",
|
@@ -3361,6 +4889,11 @@ module Aws::Pinpoint
|
|
3361
4889
|
# title: "__string",
|
3362
4890
|
# url: "__string",
|
3363
4891
|
# },
|
4892
|
+
# sms_message: {
|
4893
|
+
# body: "__string",
|
4894
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4895
|
+
# sender_id: "__string",
|
4896
|
+
# },
|
3364
4897
|
# },
|
3365
4898
|
# schedule: {
|
3366
4899
|
# end_time: "__string",
|
@@ -3390,6 +4923,7 @@ module Aws::Pinpoint
|
|
3390
4923
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3391
4924
|
# body: "__string",
|
3392
4925
|
# image_icon_url: "__string",
|
4926
|
+
# image_small_icon_url: "__string",
|
3393
4927
|
# image_url: "__string",
|
3394
4928
|
# json_body: "__string",
|
3395
4929
|
# media_url: "__string",
|
@@ -3401,6 +4935,7 @@ module Aws::Pinpoint
|
|
3401
4935
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3402
4936
|
# body: "__string",
|
3403
4937
|
# image_icon_url: "__string",
|
4938
|
+
# image_small_icon_url: "__string",
|
3404
4939
|
# image_url: "__string",
|
3405
4940
|
# json_body: "__string",
|
3406
4941
|
# media_url: "__string",
|
@@ -3408,10 +4943,16 @@ module Aws::Pinpoint
|
|
3408
4943
|
# title: "__string",
|
3409
4944
|
# url: "__string",
|
3410
4945
|
# },
|
4946
|
+
# email_message: {
|
4947
|
+
# body: "__string",
|
4948
|
+
# html_body: "__string",
|
4949
|
+
# title: "__string",
|
4950
|
+
# },
|
3411
4951
|
# gcm_message: {
|
3412
4952
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3413
4953
|
# body: "__string",
|
3414
4954
|
# image_icon_url: "__string",
|
4955
|
+
# image_small_icon_url: "__string",
|
3415
4956
|
# image_url: "__string",
|
3416
4957
|
# json_body: "__string",
|
3417
4958
|
# media_url: "__string",
|
@@ -3419,6 +4960,11 @@ module Aws::Pinpoint
|
|
3419
4960
|
# title: "__string",
|
3420
4961
|
# url: "__string",
|
3421
4962
|
# },
|
4963
|
+
# sms_message: {
|
4964
|
+
# body: "__string",
|
4965
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4966
|
+
# sender_id: "__string",
|
4967
|
+
# },
|
3422
4968
|
# },
|
3423
4969
|
# name: "__string",
|
3424
4970
|
# schedule: {
|
@@ -3511,7 +5057,6 @@ module Aws::Pinpoint
|
|
3511
5057
|
#
|
3512
5058
|
# {
|
3513
5059
|
# destination_stream_arn: "__string",
|
3514
|
-
# external_id: "__string",
|
3515
5060
|
# role_arn: "__string",
|
3516
5061
|
# }
|
3517
5062
|
#
|
@@ -3523,11 +5068,6 @@ module Aws::Pinpoint
|
|
3523
5068
|
# Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT\_ID:stream/STREAM\_NAME
|
3524
5069
|
# @return [String]
|
3525
5070
|
#
|
3526
|
-
# @!attribute [rw] external_id
|
3527
|
-
# The external ID assigned the IAM role that authorizes Amazon
|
3528
|
-
# Pinpoint to publish to the stream.
|
3529
|
-
# @return [String]
|
3530
|
-
#
|
3531
5071
|
# @!attribute [rw] role_arn
|
3532
5072
|
# The IAM role that authorizes Amazon Pinpoint to publish events to
|
3533
5073
|
# the stream in your account.
|
@@ -3535,7 +5075,6 @@ module Aws::Pinpoint
|
|
3535
5075
|
#
|
3536
5076
|
class WriteEventStream < Struct.new(
|
3537
5077
|
:destination_stream_arn,
|
3538
|
-
:external_id,
|
3539
5078
|
:role_arn)
|
3540
5079
|
include Aws::Structure
|
3541
5080
|
end
|
@@ -3564,6 +5103,10 @@ module Aws::Pinpoint
|
|
3564
5103
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3565
5104
|
# values: ["__string"],
|
3566
5105
|
# },
|
5106
|
+
# channel: {
|
5107
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
5108
|
+
# values: ["__string"],
|
5109
|
+
# },
|
3567
5110
|
# device_type: {
|
3568
5111
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3569
5112
|
# values: ["__string"],
|
@@ -3622,6 +5165,7 @@ module Aws::Pinpoint
|
|
3622
5165
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3623
5166
|
# body: "__string",
|
3624
5167
|
# image_icon_url: "__string",
|
5168
|
+
# image_small_icon_url: "__string",
|
3625
5169
|
# image_url: "__string",
|
3626
5170
|
# json_body: "__string",
|
3627
5171
|
# media_url: "__string",
|
@@ -3633,6 +5177,7 @@ module Aws::Pinpoint
|
|
3633
5177
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3634
5178
|
# body: "__string",
|
3635
5179
|
# image_icon_url: "__string",
|
5180
|
+
# image_small_icon_url: "__string",
|
3636
5181
|
# image_url: "__string",
|
3637
5182
|
# json_body: "__string",
|
3638
5183
|
# media_url: "__string",
|
@@ -3640,10 +5185,16 @@ module Aws::Pinpoint
|
|
3640
5185
|
# title: "__string",
|
3641
5186
|
# url: "__string",
|
3642
5187
|
# },
|
5188
|
+
# email_message: {
|
5189
|
+
# body: "__string",
|
5190
|
+
# html_body: "__string",
|
5191
|
+
# title: "__string",
|
5192
|
+
# },
|
3643
5193
|
# gcm_message: {
|
3644
5194
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3645
5195
|
# body: "__string",
|
3646
5196
|
# image_icon_url: "__string",
|
5197
|
+
# image_small_icon_url: "__string",
|
3647
5198
|
# image_url: "__string",
|
3648
5199
|
# json_body: "__string",
|
3649
5200
|
# media_url: "__string",
|
@@ -3651,6 +5202,11 @@ module Aws::Pinpoint
|
|
3651
5202
|
# title: "__string",
|
3652
5203
|
# url: "__string",
|
3653
5204
|
# },
|
5205
|
+
# sms_message: {
|
5206
|
+
# body: "__string",
|
5207
|
+
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
5208
|
+
# sender_id: "__string",
|
5209
|
+
# },
|
3654
5210
|
# },
|
3655
5211
|
# schedule: {
|
3656
5212
|
# end_time: "__string",
|