aws-sdk-pinpoint 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,21 +8,260 @@
8
8
  module Aws::Pinpoint
9
9
  module Types
10
10
 
11
+ # Amazon Device Messaging channel definition.
12
+ #
13
+ # @note When making an API call, you may pass ADMChannelRequest
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # client_id: "__string",
18
+ # client_secret: "__string",
19
+ # enabled: false,
20
+ # }
21
+ #
22
+ # @!attribute [rw] client_id
23
+ # Client ID as gotten from Amazon
24
+ # @return [String]
25
+ #
26
+ # @!attribute [rw] client_secret
27
+ # Client secret as gotten from Amazon
28
+ # @return [String]
29
+ #
30
+ # @!attribute [rw] enabled
31
+ # If the channel is enabled for sending messages.
32
+ # @return [Boolean]
33
+ #
34
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ADMChannelRequest AWS API Documentation
35
+ #
36
+ class ADMChannelRequest < Struct.new(
37
+ :client_id,
38
+ :client_secret,
39
+ :enabled)
40
+ include Aws::Structure
41
+ end
42
+
43
+ # Amazon Device Messaging channel definition.
44
+ #
45
+ # @!attribute [rw] application_id
46
+ # Application id
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] creation_date
50
+ # When was this segment created
51
+ # @return [String]
52
+ #
53
+ # @!attribute [rw] enabled
54
+ # If the channel is enabled for sending messages.
55
+ # @return [Boolean]
56
+ #
57
+ # @!attribute [rw] id
58
+ # Channel ID. Not used, only for backwards compatibility.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] is_archived
62
+ # Is this channel archived
63
+ # @return [Boolean]
64
+ #
65
+ # @!attribute [rw] last_modified_by
66
+ # Who last updated this entry
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] last_modified_date
70
+ # Last date this was updated
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] platform
74
+ # Platform type. Will be "ADM"
75
+ # @return [String]
76
+ #
77
+ # @!attribute [rw] version
78
+ # Version of channel
79
+ # @return [Integer]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ADMChannelResponse AWS API Documentation
82
+ #
83
+ class ADMChannelResponse < Struct.new(
84
+ :application_id,
85
+ :creation_date,
86
+ :enabled,
87
+ :id,
88
+ :is_archived,
89
+ :last_modified_by,
90
+ :last_modified_date,
91
+ :platform,
92
+ :version)
93
+ include Aws::Structure
94
+ end
95
+
96
+ # ADM Message.
97
+ #
98
+ # @note When making an API call, you may pass ADMMessage
99
+ # data as a hash:
100
+ #
101
+ # {
102
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
103
+ # body: "__string",
104
+ # consolidation_key: "__string",
105
+ # data: {
106
+ # "__string" => "__string",
107
+ # },
108
+ # expires_after: "__string",
109
+ # icon_reference: "__string",
110
+ # image_icon_url: "__string",
111
+ # image_url: "__string",
112
+ # json_data: "__string",
113
+ # md5: "__string",
114
+ # raw_content: "__string",
115
+ # silent_push: false,
116
+ # small_image_icon_url: "__string",
117
+ # sound: "__string",
118
+ # substitutions: {
119
+ # "__string" => ["__string"],
120
+ # },
121
+ # title: "__string",
122
+ # url: "__string",
123
+ # }
124
+ #
125
+ # @!attribute [rw] action
126
+ # The action that occurs if the user taps a push notification
127
+ # delivered by the campaign: OPEN\_APP - Your app launches, or it
128
+ # becomes the foreground app if it has been sent to the background.
129
+ # This is the default action. DEEP\_LINK - Uses deep linking features
130
+ # in iOS and Android to open your app and display a designated user
131
+ # interface within the app. URL - The default mobile browser on the
132
+ # user's device launches and opens a web page at the URL you specify.
133
+ # Possible values include: OPEN\_APP \| DEEP\_LINK \| URL
134
+ # @return [String]
135
+ #
136
+ # @!attribute [rw] body
137
+ # The message body of the notification, the email body or the text
138
+ # message.
139
+ # @return [String]
140
+ #
141
+ # @!attribute [rw] consolidation_key
142
+ # Optional. Arbitrary string used to indicate multiple messages are
143
+ # logically the same and that ADM is allowed to drop previously
144
+ # enqueued messages in favor of this one.
145
+ # @return [String]
146
+ #
147
+ # @!attribute [rw] data
148
+ # @return [Hash<String,String>]
149
+ #
150
+ # @!attribute [rw] expires_after
151
+ # Optional. Number of seconds ADM should retain the message if the
152
+ # device is offline
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] icon_reference
156
+ # The icon image name of the asset saved in your application.
157
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] image_icon_url
160
+ # The URL that points to an image used as the large icon to the
161
+ # notification content view.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] image_url
165
+ # The URL that points to an image used in the push notification.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] json_data
169
+ # The data payload used for a silent push. This payload is added to
170
+ # the notifications' data.pinpoint.jsonBody' object
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] md5
174
+ # Optional. Base-64-encoded MD5 checksum of the data parameter. Used
175
+ # to verify data integrity
176
+ # @return [String]
177
+ #
178
+ # @!attribute [rw] raw_content
179
+ # The Raw JSON formatted string to be used as the payload. This value
180
+ # overrides the message.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] silent_push
184
+ # Indicates if the message should display on the users device. Silent
185
+ # pushes can be used for Remote Configuration and Phone Home use
186
+ # cases.
187
+ # @return [Boolean]
188
+ #
189
+ # @!attribute [rw] small_image_icon_url
190
+ # The URL that points to an image used as the small icon for the
191
+ # notification which will be used to represent the notification in the
192
+ # status bar and content view
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] sound
196
+ # Indicates a sound to play when the device receives the notification.
197
+ # Supports default, or the filename of a sound resource bundled in the
198
+ # app. Android sound files must reside in /res/raw/
199
+ # @return [String]
200
+ #
201
+ # @!attribute [rw] substitutions
202
+ # @return [Hash<String,Array<String>>]
203
+ #
204
+ # @!attribute [rw] title
205
+ # The message title that displays above the message on the user's
206
+ # device.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] url
210
+ # The URL to open in the user's mobile browser. Used if the value for
211
+ # Action is URL.
212
+ # @return [String]
213
+ #
214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ADMMessage AWS API Documentation
215
+ #
216
+ class ADMMessage < Struct.new(
217
+ :action,
218
+ :body,
219
+ :consolidation_key,
220
+ :data,
221
+ :expires_after,
222
+ :icon_reference,
223
+ :image_icon_url,
224
+ :image_url,
225
+ :json_data,
226
+ :md5,
227
+ :raw_content,
228
+ :silent_push,
229
+ :small_image_icon_url,
230
+ :sound,
231
+ :substitutions,
232
+ :title,
233
+ :url)
234
+ include Aws::Structure
235
+ end
236
+
11
237
  # Apple Push Notification Service channel definition.
12
238
  #
13
239
  # @note When making an API call, you may pass APNSChannelRequest
14
240
  # data as a hash:
15
241
  #
16
242
  # {
243
+ # bundle_id: "__string",
17
244
  # certificate: "__string",
245
+ # default_authentication_method: "__string",
18
246
  # enabled: false,
19
247
  # private_key: "__string",
248
+ # team_id: "__string",
249
+ # token_key: "__string",
250
+ # token_key_id: "__string",
20
251
  # }
21
252
  #
253
+ # @!attribute [rw] bundle_id
254
+ # The bundle id used for APNs Tokens.
255
+ # @return [String]
256
+ #
22
257
  # @!attribute [rw] certificate
23
258
  # The distribution certificate from Apple.
24
259
  # @return [String]
25
260
  #
261
+ # @!attribute [rw] default_authentication_method
262
+ # The default authentication method used for APNs.
263
+ # @return [String]
264
+ #
26
265
  # @!attribute [rw] enabled
27
266
  # If the channel is enabled for sending messages.
28
267
  # @return [Boolean]
@@ -31,10 +270,29 @@ module Aws::Pinpoint
31
270
  # The certificate private key.
32
271
  # @return [String]
33
272
  #
273
+ # @!attribute [rw] team_id
274
+ # The team id used for APNs Tokens.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] token_key
278
+ # The token key used for APNs Tokens.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] token_key_id
282
+ # The token key used for APNs Tokens.
283
+ # @return [String]
284
+ #
285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSChannelRequest AWS API Documentation
286
+ #
34
287
  class APNSChannelRequest < Struct.new(
288
+ :bundle_id,
35
289
  :certificate,
290
+ :default_authentication_method,
36
291
  :enabled,
37
- :private_key)
292
+ :private_key,
293
+ :team_id,
294
+ :token_key,
295
+ :token_key_id)
38
296
  include Aws::Structure
39
297
  end
40
298
 
@@ -76,6 +334,8 @@ module Aws::Pinpoint
76
334
  # Version of channel
77
335
  # @return [Integer]
78
336
  #
337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSChannelResponse AWS API Documentation
338
+ #
79
339
  class APNSChannelResponse < Struct.new(
80
340
  :application_id,
81
341
  :creation_date,
@@ -102,7 +362,9 @@ module Aws::Pinpoint
102
362
  # data: {
103
363
  # "__string" => "__string",
104
364
  # },
365
+ # json_data: "__string",
105
366
  # media_url: "__string",
367
+ # preferred_authentication_method: "__string",
106
368
  # raw_content: "__string",
107
369
  # silent_push: false,
108
370
  # sound: "__string",
@@ -146,10 +408,20 @@ module Aws::Pinpoint
146
408
  # @!attribute [rw] data
147
409
  # @return [Hash<String,String>]
148
410
  #
411
+ # @!attribute [rw] json_data
412
+ # The data payload used for a silent push. This payload is added to
413
+ # the notifications' data.pinpoint.jsonBody' object
414
+ # @return [String]
415
+ #
149
416
  # @!attribute [rw] media_url
150
417
  # The URL that points to a video used in the push notification.
151
418
  # @return [String]
152
419
  #
420
+ # @!attribute [rw] preferred_authentication_method
421
+ # The preferred authentication method, either "CERTIFICATE" or
422
+ # "TOKEN"
423
+ # @return [String]
424
+ #
153
425
  # @!attribute [rw] raw_content
154
426
  # The Raw JSON formatted string to be used as the payload. This value
155
427
  # overrides the message.
@@ -189,13 +461,17 @@ module Aws::Pinpoint
189
461
  # Action is URL.
190
462
  # @return [String]
191
463
  #
464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSMessage AWS API Documentation
465
+ #
192
466
  class APNSMessage < Struct.new(
193
467
  :action,
194
468
  :badge,
195
469
  :body,
196
470
  :category,
197
471
  :data,
472
+ :json_data,
198
473
  :media_url,
474
+ :preferred_authentication_method,
199
475
  :raw_content,
200
476
  :silent_push,
201
477
  :sound,
@@ -212,15 +488,28 @@ module Aws::Pinpoint
212
488
  # data as a hash:
213
489
  #
214
490
  # {
491
+ # bundle_id: "__string",
215
492
  # certificate: "__string",
493
+ # default_authentication_method: "__string",
216
494
  # enabled: false,
217
495
  # private_key: "__string",
496
+ # team_id: "__string",
497
+ # token_key: "__string",
498
+ # token_key_id: "__string",
218
499
  # }
219
500
  #
501
+ # @!attribute [rw] bundle_id
502
+ # The bundle id used for APNs Tokens.
503
+ # @return [String]
504
+ #
220
505
  # @!attribute [rw] certificate
221
506
  # The distribution certificate from Apple.
222
507
  # @return [String]
223
508
  #
509
+ # @!attribute [rw] default_authentication_method
510
+ # The default authentication method used for APNs.
511
+ # @return [String]
512
+ #
224
513
  # @!attribute [rw] enabled
225
514
  # If the channel is enabled for sending messages.
226
515
  # @return [Boolean]
@@ -229,10 +518,29 @@ module Aws::Pinpoint
229
518
  # The certificate private key.
230
519
  # @return [String]
231
520
  #
521
+ # @!attribute [rw] team_id
522
+ # The team id used for APNs Tokens.
523
+ # @return [String]
524
+ #
525
+ # @!attribute [rw] token_key
526
+ # The token key used for APNs Tokens.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] token_key_id
530
+ # The token key used for APNs Tokens.
531
+ # @return [String]
532
+ #
533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSSandboxChannelRequest AWS API Documentation
534
+ #
232
535
  class APNSSandboxChannelRequest < Struct.new(
536
+ :bundle_id,
233
537
  :certificate,
538
+ :default_authentication_method,
234
539
  :enabled,
235
- :private_key)
540
+ :private_key,
541
+ :team_id,
542
+ :token_key,
543
+ :token_key_id)
236
544
  include Aws::Structure
237
545
  end
238
546
 
@@ -274,6 +582,8 @@ module Aws::Pinpoint
274
582
  # Version of channel
275
583
  # @return [Integer]
276
584
  #
585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSSandboxChannelResponse AWS API Documentation
586
+ #
277
587
  class APNSSandboxChannelResponse < Struct.new(
278
588
  :application_id,
279
589
  :creation_date,
@@ -293,6 +603,8 @@ module Aws::Pinpoint
293
603
  # List of campaign activities
294
604
  # @return [Array<Types::ActivityResponse>]
295
605
  #
606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ActivitiesResponse AWS API Documentation
607
+ #
296
608
  class ActivitiesResponse < Struct.new(
297
609
  :item)
298
610
  include Aws::Structure
@@ -357,6 +669,8 @@ module Aws::Pinpoint
357
669
  # The ID of a variation of the campaign used for A/B testing.
358
670
  # @return [String]
359
671
  #
672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ActivityResponse AWS API Documentation
673
+ #
360
674
  class ActivityResponse < Struct.new(
361
675
  :application_id,
362
676
  :campaign_id,
@@ -381,7 +695,7 @@ module Aws::Pinpoint
381
695
  #
382
696
  # {
383
697
  # body_override: "__string",
384
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
698
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
385
699
  # context: {
386
700
  # "__string" => "__string",
387
701
  # },
@@ -416,6 +730,8 @@ module Aws::Pinpoint
416
730
  # applicable.
417
731
  # @return [String]
418
732
  #
733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/AddressConfiguration AWS API Documentation
734
+ #
419
735
  class AddressConfiguration < Struct.new(
420
736
  :body_override,
421
737
  :channel_type,
@@ -436,6 +752,8 @@ module Aws::Pinpoint
436
752
  # The display name of the application.
437
753
  # @return [String]
438
754
  #
755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ApplicationResponse AWS API Documentation
756
+ #
439
757
  class ApplicationResponse < Struct.new(
440
758
  :id,
441
759
  :name)
@@ -464,6 +782,8 @@ module Aws::Pinpoint
464
782
  # default with a quiet time of its own.
465
783
  # @return [Types::QuietTime]
466
784
  #
785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ApplicationSettingsResource AWS API Documentation
786
+ #
467
787
  class ApplicationSettingsResource < Struct.new(
468
788
  :application_id,
469
789
  :last_modified_date,
@@ -483,6 +803,8 @@ module Aws::Pinpoint
483
803
  # of results in a paginated response.
484
804
  # @return [String]
485
805
  #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ApplicationsResponse AWS API Documentation
807
+ #
486
808
  class ApplicationsResponse < Struct.new(
487
809
  :item,
488
810
  :next_token)
@@ -508,57 +830,272 @@ module Aws::Pinpoint
508
830
  # @!attribute [rw] values
509
831
  # @return [Array<String>]
510
832
  #
833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/AttributeDimension AWS API Documentation
834
+ #
511
835
  class AttributeDimension < Struct.new(
512
836
  :attribute_type,
513
837
  :values)
514
838
  include Aws::Structure
515
839
  end
516
840
 
517
- # The email message configuration.
841
+ # Baidu Cloud Push credentials
518
842
  #
519
- # @note When making an API call, you may pass CampaignEmailMessage
843
+ # @note When making an API call, you may pass BaiduChannelRequest
520
844
  # data as a hash:
521
845
  #
522
846
  # {
523
- # body: "__string",
524
- # from_address: "__string",
525
- # html_body: "__string",
526
- # title: "__string",
847
+ # api_key: "__string",
848
+ # enabled: false,
849
+ # secret_key: "__string",
527
850
  # }
528
851
  #
529
- # @!attribute [rw] body
530
- # The email text body.
852
+ # @!attribute [rw] api_key
853
+ # Platform credential API key from Baidu.
531
854
  # @return [String]
532
855
  #
533
- # @!attribute [rw] from_address
534
- # The email address used to send the email from. Defaults to use
535
- # FromAddress specified in the Email Channel.
536
- # @return [String]
856
+ # @!attribute [rw] enabled
857
+ # If the channel is enabled for sending messages.
858
+ # @return [Boolean]
537
859
  #
538
- # @!attribute [rw] html_body
539
- # The email html body.
860
+ # @!attribute [rw] secret_key
861
+ # Platform credential Secret key from Baidu.
540
862
  # @return [String]
541
863
  #
542
- # @!attribute [rw] title
543
- # The email title (Or subject).
544
- # @return [String]
864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/BaiduChannelRequest AWS API Documentation
545
865
  #
546
- class CampaignEmailMessage < Struct.new(
547
- :body,
548
- :from_address,
549
- :html_body,
550
- :title)
866
+ class BaiduChannelRequest < Struct.new(
867
+ :api_key,
868
+ :enabled,
869
+ :secret_key)
551
870
  include Aws::Structure
552
871
  end
553
872
 
554
- # Campaign Limits are used to limit the number of messages that can be
555
- # sent to a user.
556
- #
557
- # @note When making an API call, you may pass CampaignLimits
558
- # data as a hash:
873
+ # Baidu Cloud Messaging channel definition
874
+ #
875
+ # @!attribute [rw] application_id
876
+ # Application id
877
+ # @return [String]
878
+ #
879
+ # @!attribute [rw] creation_date
880
+ # When was this segment created
881
+ # @return [String]
882
+ #
883
+ # @!attribute [rw] credential
884
+ # The Baidu API key from Baidu.
885
+ # @return [String]
886
+ #
887
+ # @!attribute [rw] enabled
888
+ # If the channel is enabled for sending messages.
889
+ # @return [Boolean]
890
+ #
891
+ # @!attribute [rw] id
892
+ # Channel ID. Not used, only for backwards compatibility.
893
+ # @return [String]
894
+ #
895
+ # @!attribute [rw] is_archived
896
+ # Is this channel archived
897
+ # @return [Boolean]
898
+ #
899
+ # @!attribute [rw] last_modified_by
900
+ # Who made the last change
901
+ # @return [String]
902
+ #
903
+ # @!attribute [rw] last_modified_date
904
+ # Last date this was updated
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] platform
908
+ # The platform type. Will be BAIDU
909
+ # @return [String]
910
+ #
911
+ # @!attribute [rw] version
912
+ # Version of channel
913
+ # @return [Integer]
914
+ #
915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/BaiduChannelResponse AWS API Documentation
916
+ #
917
+ class BaiduChannelResponse < Struct.new(
918
+ :application_id,
919
+ :creation_date,
920
+ :credential,
921
+ :enabled,
922
+ :id,
923
+ :is_archived,
924
+ :last_modified_by,
925
+ :last_modified_date,
926
+ :platform,
927
+ :version)
928
+ include Aws::Structure
929
+ end
930
+
931
+ # Baidu Message.
932
+ #
933
+ # @note When making an API call, you may pass BaiduMessage
934
+ # data as a hash:
935
+ #
936
+ # {
937
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
938
+ # body: "__string",
939
+ # data: {
940
+ # "__string" => "__string",
941
+ # },
942
+ # icon_reference: "__string",
943
+ # image_icon_url: "__string",
944
+ # image_url: "__string",
945
+ # json_data: "__string",
946
+ # raw_content: "__string",
947
+ # silent_push: false,
948
+ # small_image_icon_url: "__string",
949
+ # sound: "__string",
950
+ # substitutions: {
951
+ # "__string" => ["__string"],
952
+ # },
953
+ # title: "__string",
954
+ # url: "__string",
955
+ # }
956
+ #
957
+ # @!attribute [rw] action
958
+ # The action that occurs if the user taps a push notification
959
+ # delivered by the campaign: OPEN\_APP - Your app launches, or it
960
+ # becomes the foreground app if it has been sent to the background.
961
+ # This is the default action. DEEP\_LINK - Uses deep linking features
962
+ # in iOS and Android to open your app and display a designated user
963
+ # interface within the app. URL - The default mobile browser on the
964
+ # user's device launches and opens a web page at the URL you specify.
965
+ # Possible values include: OPEN\_APP \| DEEP\_LINK \| URL
966
+ # @return [String]
967
+ #
968
+ # @!attribute [rw] body
969
+ # The message body of the notification, the email body or the text
970
+ # message.
971
+ # @return [String]
972
+ #
973
+ # @!attribute [rw] data
974
+ # @return [Hash<String,String>]
975
+ #
976
+ # @!attribute [rw] icon_reference
977
+ # The icon image name of the asset saved in your application.
978
+ # @return [String]
979
+ #
980
+ # @!attribute [rw] image_icon_url
981
+ # The URL that points to an image used as the large icon to the
982
+ # notification content view.
983
+ # @return [String]
984
+ #
985
+ # @!attribute [rw] image_url
986
+ # The URL that points to an image used in the push notification.
987
+ # @return [String]
988
+ #
989
+ # @!attribute [rw] json_data
990
+ # The data payload used for a silent push. This payload is added to
991
+ # the notifications' data.pinpoint.jsonBody' object
992
+ # @return [String]
993
+ #
994
+ # @!attribute [rw] raw_content
995
+ # The Raw JSON formatted string to be used as the payload. This value
996
+ # overrides the message.
997
+ # @return [String]
998
+ #
999
+ # @!attribute [rw] silent_push
1000
+ # Indicates if the message should display on the users device. Silent
1001
+ # pushes can be used for Remote Configuration and Phone Home use
1002
+ # cases.
1003
+ # @return [Boolean]
1004
+ #
1005
+ # @!attribute [rw] small_image_icon_url
1006
+ # The URL that points to an image used as the small icon for the
1007
+ # notification which will be used to represent the notification in the
1008
+ # status bar and content view
1009
+ # @return [String]
1010
+ #
1011
+ # @!attribute [rw] sound
1012
+ # Indicates a sound to play when the device receives the notification.
1013
+ # Supports default, or the filename of a sound resource bundled in the
1014
+ # app. Android sound files must reside in /res/raw/
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] substitutions
1018
+ # @return [Hash<String,Array<String>>]
1019
+ #
1020
+ # @!attribute [rw] title
1021
+ # The message title that displays above the message on the user's
1022
+ # device.
1023
+ # @return [String]
1024
+ #
1025
+ # @!attribute [rw] url
1026
+ # The URL to open in the user's mobile browser. Used if the value for
1027
+ # Action is URL.
1028
+ # @return [String]
1029
+ #
1030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/BaiduMessage AWS API Documentation
1031
+ #
1032
+ class BaiduMessage < Struct.new(
1033
+ :action,
1034
+ :body,
1035
+ :data,
1036
+ :icon_reference,
1037
+ :image_icon_url,
1038
+ :image_url,
1039
+ :json_data,
1040
+ :raw_content,
1041
+ :silent_push,
1042
+ :small_image_icon_url,
1043
+ :sound,
1044
+ :substitutions,
1045
+ :title,
1046
+ :url)
1047
+ include Aws::Structure
1048
+ end
1049
+
1050
+ # The email message configuration.
1051
+ #
1052
+ # @note When making an API call, you may pass CampaignEmailMessage
1053
+ # data as a hash:
1054
+ #
1055
+ # {
1056
+ # body: "__string",
1057
+ # from_address: "__string",
1058
+ # html_body: "__string",
1059
+ # title: "__string",
1060
+ # }
1061
+ #
1062
+ # @!attribute [rw] body
1063
+ # The email text body.
1064
+ # @return [String]
1065
+ #
1066
+ # @!attribute [rw] from_address
1067
+ # The email address used to send the email from. Defaults to use
1068
+ # FromAddress specified in the Email Channel.
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] html_body
1072
+ # The email html body.
1073
+ # @return [String]
1074
+ #
1075
+ # @!attribute [rw] title
1076
+ # The email title (Or subject).
1077
+ # @return [String]
1078
+ #
1079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignEmailMessage AWS API Documentation
1080
+ #
1081
+ class CampaignEmailMessage < Struct.new(
1082
+ :body,
1083
+ :from_address,
1084
+ :html_body,
1085
+ :title)
1086
+ include Aws::Structure
1087
+ end
1088
+
1089
+ # Campaign Limits are used to limit the number of messages that can be
1090
+ # sent to a user.
1091
+ #
1092
+ # @note When making an API call, you may pass CampaignLimits
1093
+ # data as a hash:
559
1094
  #
560
1095
  # {
561
1096
  # daily: 1,
1097
+ # maximum_duration: 1,
1098
+ # messages_per_second: 1,
562
1099
  # total: 1,
563
1100
  # }
564
1101
  #
@@ -566,12 +1103,27 @@ module Aws::Pinpoint
566
1103
  # The maximum number of messages that the campaign can send daily.
567
1104
  # @return [Integer]
568
1105
  #
1106
+ # @!attribute [rw] maximum_duration
1107
+ # The maximum duration of a campaign from the scheduled start. Must be
1108
+ # a minimum of 60 seconds.
1109
+ # @return [Integer]
1110
+ #
1111
+ # @!attribute [rw] messages_per_second
1112
+ # The maximum number of messages per second that the campaign will
1113
+ # send. This is a best effort maximum cap and can go as high as 20000
1114
+ # and as low as 50
1115
+ # @return [Integer]
1116
+ #
569
1117
  # @!attribute [rw] total
570
1118
  # The maximum total number of messages that the campaign can send.
571
1119
  # @return [Integer]
572
1120
  #
1121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignLimits AWS API Documentation
1122
+ #
573
1123
  class CampaignLimits < Struct.new(
574
1124
  :daily,
1125
+ :maximum_duration,
1126
+ :messages_per_second,
575
1127
  :total)
576
1128
  include Aws::Structure
577
1129
  end
@@ -658,6 +1210,8 @@ module Aws::Pinpoint
658
1210
  # The campaign version number.
659
1211
  # @return [Integer]
660
1212
  #
1213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignResponse AWS API Documentation
1214
+ #
661
1215
  class CampaignResponse < Struct.new(
662
1216
  :additional_treatments,
663
1217
  :application_id,
@@ -705,6 +1259,8 @@ module Aws::Pinpoint
705
1259
  # Sender ID of sent message.
706
1260
  # @return [String]
707
1261
  #
1262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignSmsMessage AWS API Documentation
1263
+ #
708
1264
  class CampaignSmsMessage < Struct.new(
709
1265
  :body,
710
1266
  :message_type,
@@ -720,6 +1276,8 @@ module Aws::Pinpoint
720
1276
  # PENDING\_NEXT\_RUN, COMPLETED, PAUSED
721
1277
  # @return [String]
722
1278
  #
1279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignState AWS API Documentation
1280
+ #
723
1281
  class CampaignState < Struct.new(
724
1282
  :campaign_status)
725
1283
  include Aws::Structure
@@ -736,6 +1294,8 @@ module Aws::Pinpoint
736
1294
  # of results in a paginated response.
737
1295
  # @return [String]
738
1296
  #
1297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignsResponse AWS API Documentation
1298
+ #
739
1299
  class CampaignsResponse < Struct.new(
740
1300
  :item,
741
1301
  :next_token)
@@ -755,6 +1315,8 @@ module Aws::Pinpoint
755
1315
  # Application Request.
756
1316
  # @return [Types::CreateApplicationRequest]
757
1317
  #
1318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateAppRequest AWS API Documentation
1319
+ #
758
1320
  class CreateAppRequest < Struct.new(
759
1321
  :create_application_request)
760
1322
  include Aws::Structure
@@ -764,6 +1326,8 @@ module Aws::Pinpoint
764
1326
  # Application Response.
765
1327
  # @return [Types::ApplicationResponse]
766
1328
  #
1329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateAppResponse AWS API Documentation
1330
+ #
767
1331
  class CreateAppResponse < Struct.new(
768
1332
  :application_response)
769
1333
  include Aws::Structure
@@ -783,6 +1347,8 @@ module Aws::Pinpoint
783
1347
  # console.
784
1348
  # @return [String]
785
1349
  #
1350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateApplicationRequest AWS API Documentation
1351
+ #
786
1352
  class CreateApplicationRequest < Struct.new(
787
1353
  :name)
788
1354
  include Aws::Structure
@@ -869,6 +1435,8 @@ module Aws::Pinpoint
869
1435
  # is_paused: false,
870
1436
  # limits: {
871
1437
  # daily: 1,
1438
+ # maximum_duration: 1,
1439
+ # messages_per_second: 1,
872
1440
  # total: 1,
873
1441
  # },
874
1442
  # message_configuration: {
@@ -937,6 +1505,7 @@ module Aws::Pinpoint
937
1505
  # },
938
1506
  # segment_id: "__string",
939
1507
  # segment_version: 1,
1508
+ # trace: false,
940
1509
  # treatment_description: "__string",
941
1510
  # treatment_name: "__string",
942
1511
  # },
@@ -949,6 +1518,8 @@ module Aws::Pinpoint
949
1518
  # Used to create a campaign.
950
1519
  # @return [Types::WriteCampaignRequest]
951
1520
  #
1521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateCampaignRequest AWS API Documentation
1522
+ #
952
1523
  class CreateCampaignRequest < Struct.new(
953
1524
  :application_id,
954
1525
  :write_campaign_request)
@@ -959,6 +1530,8 @@ module Aws::Pinpoint
959
1530
  # Campaign definition
960
1531
  # @return [Types::CampaignResponse]
961
1532
  #
1533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateCampaignResponse AWS API Documentation
1534
+ #
962
1535
  class CreateCampaignResponse < Struct.new(
963
1536
  :campaign_response)
964
1537
  include Aws::Structure
@@ -987,6 +1560,8 @@ module Aws::Pinpoint
987
1560
  # @!attribute [rw] import_job_request
988
1561
  # @return [Types::ImportJobRequest]
989
1562
  #
1563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJobRequest AWS API Documentation
1564
+ #
990
1565
  class CreateImportJobRequest < Struct.new(
991
1566
  :application_id,
992
1567
  :import_job_request)
@@ -996,6 +1571,8 @@ module Aws::Pinpoint
996
1571
  # @!attribute [rw] import_job_response
997
1572
  # @return [Types::ImportJobResponse]
998
1573
  #
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJobResponse AWS API Documentation
1575
+ #
999
1576
  class CreateImportJobResponse < Struct.new(
1000
1577
  :import_job_response)
1001
1578
  include Aws::Structure
@@ -1070,6 +1647,8 @@ module Aws::Pinpoint
1070
1647
  # Segment definition.
1071
1648
  # @return [Types::WriteSegmentRequest]
1072
1649
  #
1650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSegmentRequest AWS API Documentation
1651
+ #
1073
1652
  class CreateSegmentRequest < Struct.new(
1074
1653
  :application_id,
1075
1654
  :write_segment_request)
@@ -1080,6 +1659,8 @@ module Aws::Pinpoint
1080
1659
  # Segment definition.
1081
1660
  # @return [Types::SegmentResponse]
1082
1661
  #
1662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSegmentResponse AWS API Documentation
1663
+ #
1083
1664
  class CreateSegmentResponse < Struct.new(
1084
1665
  :segment_response)
1085
1666
  include Aws::Structure
@@ -1105,6 +1686,8 @@ module Aws::Pinpoint
1105
1686
  # @!attribute [rw] substitutions
1106
1687
  # @return [Hash<String,Array<String>>]
1107
1688
  #
1689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DefaultMessage AWS API Documentation
1690
+ #
1108
1691
  class DefaultMessage < Struct.new(
1109
1692
  :body,
1110
1693
  :substitutions)
@@ -1122,6 +1705,7 @@ module Aws::Pinpoint
1122
1705
  # data: {
1123
1706
  # "__string" => "__string",
1124
1707
  # },
1708
+ # json_data: "__string",
1125
1709
  # silent_push: false,
1126
1710
  # substitutions: {
1127
1711
  # "__string" => ["__string"],
@@ -1149,6 +1733,11 @@ module Aws::Pinpoint
1149
1733
  # @!attribute [rw] data
1150
1734
  # @return [Hash<String,String>]
1151
1735
  #
1736
+ # @!attribute [rw] json_data
1737
+ # The data payload used for a silent push. This payload is added to
1738
+ # the notifications' data.pinpoint.jsonBody' object
1739
+ # @return [String]
1740
+ #
1152
1741
  # @!attribute [rw] silent_push
1153
1742
  # Indicates if the message should display on the users device. Silent
1154
1743
  # pushes can be used for Remote Configuration and Phone Home use
@@ -1168,10 +1757,13 @@ module Aws::Pinpoint
1168
1757
  # Action is URL.
1169
1758
  # @return [String]
1170
1759
  #
1760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DefaultPushNotificationMessage AWS API Documentation
1761
+ #
1171
1762
  class DefaultPushNotificationMessage < Struct.new(
1172
1763
  :action,
1173
1764
  :body,
1174
1765
  :data,
1766
+ :json_data,
1175
1767
  :silent_push,
1176
1768
  :substitutions,
1177
1769
  :title,
@@ -1179,6 +1771,34 @@ module Aws::Pinpoint
1179
1771
  include Aws::Structure
1180
1772
  end
1181
1773
 
1774
+ # @note When making an API call, you may pass DeleteAdmChannelRequest
1775
+ # data as a hash:
1776
+ #
1777
+ # {
1778
+ # application_id: "__string", # required
1779
+ # }
1780
+ #
1781
+ # @!attribute [rw] application_id
1782
+ # @return [String]
1783
+ #
1784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAdmChannelRequest AWS API Documentation
1785
+ #
1786
+ class DeleteAdmChannelRequest < Struct.new(
1787
+ :application_id)
1788
+ include Aws::Structure
1789
+ end
1790
+
1791
+ # @!attribute [rw] adm_channel_response
1792
+ # Amazon Device Messaging channel definition.
1793
+ # @return [Types::ADMChannelResponse]
1794
+ #
1795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAdmChannelResponse AWS API Documentation
1796
+ #
1797
+ class DeleteAdmChannelResponse < Struct.new(
1798
+ :adm_channel_response)
1799
+ include Aws::Structure
1800
+ end
1801
+
1182
1802
  # @note When making an API call, you may pass DeleteApnsChannelRequest
1183
1803
  # data as a hash:
1184
1804
  #
@@ -1189,6 +1809,8 @@ module Aws::Pinpoint
1189
1809
  # @!attribute [rw] application_id
1190
1810
  # @return [String]
1191
1811
  #
1812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsChannelRequest AWS API Documentation
1813
+ #
1192
1814
  class DeleteApnsChannelRequest < Struct.new(
1193
1815
  :application_id)
1194
1816
  include Aws::Structure
@@ -1198,6 +1820,8 @@ module Aws::Pinpoint
1198
1820
  # Apple Distribution Push Notification Service channel definition.
1199
1821
  # @return [Types::APNSChannelResponse]
1200
1822
  #
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsChannelResponse AWS API Documentation
1824
+ #
1201
1825
  class DeleteApnsChannelResponse < Struct.new(
1202
1826
  :apns_channel_response)
1203
1827
  include Aws::Structure
@@ -1213,6 +1837,8 @@ module Aws::Pinpoint
1213
1837
  # @!attribute [rw] application_id
1214
1838
  # @return [String]
1215
1839
  #
1840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsSandboxChannelRequest AWS API Documentation
1841
+ #
1216
1842
  class DeleteApnsSandboxChannelRequest < Struct.new(
1217
1843
  :application_id)
1218
1844
  include Aws::Structure
@@ -1222,6 +1848,8 @@ module Aws::Pinpoint
1222
1848
  # Apple Development Push Notification Service channel definition.
1223
1849
  # @return [Types::APNSSandboxChannelResponse]
1224
1850
  #
1851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsSandboxChannelResponse AWS API Documentation
1852
+ #
1225
1853
  class DeleteApnsSandboxChannelResponse < Struct.new(
1226
1854
  :apns_sandbox_channel_response)
1227
1855
  include Aws::Structure
@@ -1237,6 +1865,8 @@ module Aws::Pinpoint
1237
1865
  # @!attribute [rw] application_id
1238
1866
  # @return [String]
1239
1867
  #
1868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAppRequest AWS API Documentation
1869
+ #
1240
1870
  class DeleteAppRequest < Struct.new(
1241
1871
  :application_id)
1242
1872
  include Aws::Structure
@@ -1246,24 +1876,56 @@ module Aws::Pinpoint
1246
1876
  # Application Response.
1247
1877
  # @return [Types::ApplicationResponse]
1248
1878
  #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAppResponse AWS API Documentation
1880
+ #
1249
1881
  class DeleteAppResponse < Struct.new(
1250
1882
  :application_response)
1251
1883
  include Aws::Structure
1252
1884
  end
1253
1885
 
1254
- # @note When making an API call, you may pass DeleteCampaignRequest
1886
+ # @note When making an API call, you may pass DeleteBaiduChannelRequest
1255
1887
  # data as a hash:
1256
1888
  #
1257
1889
  # {
1258
1890
  # application_id: "__string", # required
1259
- # campaign_id: "__string", # required
1260
1891
  # }
1261
1892
  #
1262
1893
  # @!attribute [rw] application_id
1263
1894
  # @return [String]
1264
1895
  #
1265
- # @!attribute [rw] campaign_id
1266
- # @return [String]
1896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteBaiduChannelRequest AWS API Documentation
1897
+ #
1898
+ class DeleteBaiduChannelRequest < Struct.new(
1899
+ :application_id)
1900
+ include Aws::Structure
1901
+ end
1902
+
1903
+ # @!attribute [rw] baidu_channel_response
1904
+ # Baidu Cloud Messaging channel definition
1905
+ # @return [Types::BaiduChannelResponse]
1906
+ #
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteBaiduChannelResponse AWS API Documentation
1908
+ #
1909
+ class DeleteBaiduChannelResponse < Struct.new(
1910
+ :baidu_channel_response)
1911
+ include Aws::Structure
1912
+ end
1913
+
1914
+ # @note When making an API call, you may pass DeleteCampaignRequest
1915
+ # data as a hash:
1916
+ #
1917
+ # {
1918
+ # application_id: "__string", # required
1919
+ # campaign_id: "__string", # required
1920
+ # }
1921
+ #
1922
+ # @!attribute [rw] application_id
1923
+ # @return [String]
1924
+ #
1925
+ # @!attribute [rw] campaign_id
1926
+ # @return [String]
1927
+ #
1928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteCampaignRequest AWS API Documentation
1267
1929
  #
1268
1930
  class DeleteCampaignRequest < Struct.new(
1269
1931
  :application_id,
@@ -1275,6 +1937,8 @@ module Aws::Pinpoint
1275
1937
  # Campaign definition
1276
1938
  # @return [Types::CampaignResponse]
1277
1939
  #
1940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteCampaignResponse AWS API Documentation
1941
+ #
1278
1942
  class DeleteCampaignResponse < Struct.new(
1279
1943
  :campaign_response)
1280
1944
  include Aws::Structure
@@ -1290,6 +1954,8 @@ module Aws::Pinpoint
1290
1954
  # @!attribute [rw] application_id
1291
1955
  # @return [String]
1292
1956
  #
1957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailChannelRequest AWS API Documentation
1958
+ #
1293
1959
  class DeleteEmailChannelRequest < Struct.new(
1294
1960
  :application_id)
1295
1961
  include Aws::Structure
@@ -1299,6 +1965,8 @@ module Aws::Pinpoint
1299
1965
  # Email Channel Response.
1300
1966
  # @return [Types::EmailChannelResponse]
1301
1967
  #
1968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailChannelResponse AWS API Documentation
1969
+ #
1302
1970
  class DeleteEmailChannelResponse < Struct.new(
1303
1971
  :email_channel_response)
1304
1972
  include Aws::Structure
@@ -1312,9 +1980,10 @@ module Aws::Pinpoint
1312
1980
  # }
1313
1981
  #
1314
1982
  # @!attribute [rw] application_id
1315
- # Application Id.
1316
1983
  # @return [String]
1317
1984
  #
1985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStreamRequest AWS API Documentation
1986
+ #
1318
1987
  class DeleteEventStreamRequest < Struct.new(
1319
1988
  :application_id)
1320
1989
  include Aws::Structure
@@ -1324,6 +1993,8 @@ module Aws::Pinpoint
1324
1993
  # Model for an event publishing subscription export.
1325
1994
  # @return [Types::EventStream]
1326
1995
  #
1996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStreamResponse AWS API Documentation
1997
+ #
1327
1998
  class DeleteEventStreamResponse < Struct.new(
1328
1999
  :event_stream)
1329
2000
  include Aws::Structure
@@ -1339,6 +2010,8 @@ module Aws::Pinpoint
1339
2010
  # @!attribute [rw] application_id
1340
2011
  # @return [String]
1341
2012
  #
2013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteGcmChannelRequest AWS API Documentation
2014
+ #
1342
2015
  class DeleteGcmChannelRequest < Struct.new(
1343
2016
  :application_id)
1344
2017
  include Aws::Structure
@@ -1348,6 +2021,8 @@ module Aws::Pinpoint
1348
2021
  # Google Cloud Messaging channel definition
1349
2022
  # @return [Types::GCMChannelResponse]
1350
2023
  #
2024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteGcmChannelResponse AWS API Documentation
2025
+ #
1351
2026
  class DeleteGcmChannelResponse < Struct.new(
1352
2027
  :gcm_channel_response)
1353
2028
  include Aws::Structure
@@ -1367,6 +2042,8 @@ module Aws::Pinpoint
1367
2042
  # @!attribute [rw] segment_id
1368
2043
  # @return [String]
1369
2044
  #
2045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSegmentRequest AWS API Documentation
2046
+ #
1370
2047
  class DeleteSegmentRequest < Struct.new(
1371
2048
  :application_id,
1372
2049
  :segment_id)
@@ -1377,6 +2054,8 @@ module Aws::Pinpoint
1377
2054
  # Segment definition.
1378
2055
  # @return [Types::SegmentResponse]
1379
2056
  #
2057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSegmentResponse AWS API Documentation
2058
+ #
1380
2059
  class DeleteSegmentResponse < Struct.new(
1381
2060
  :segment_response)
1382
2061
  include Aws::Structure
@@ -1392,6 +2071,8 @@ module Aws::Pinpoint
1392
2071
  # @!attribute [rw] application_id
1393
2072
  # @return [String]
1394
2073
  #
2074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsChannelRequest AWS API Documentation
2075
+ #
1395
2076
  class DeleteSmsChannelRequest < Struct.new(
1396
2077
  :application_id)
1397
2078
  include Aws::Structure
@@ -1401,6 +2082,8 @@ module Aws::Pinpoint
1401
2082
  # SMS Channel Response.
1402
2083
  # @return [Types::SMSChannelResponse]
1403
2084
  #
2085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsChannelResponse AWS API Documentation
2086
+ #
1404
2087
  class DeleteSmsChannelResponse < Struct.new(
1405
2088
  :sms_channel_response)
1406
2089
  include Aws::Structure
@@ -1412,6 +2095,29 @@ module Aws::Pinpoint
1412
2095
  # data as a hash:
1413
2096
  #
1414
2097
  # {
2098
+ # adm_message: {
2099
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
2100
+ # body: "__string",
2101
+ # consolidation_key: "__string",
2102
+ # data: {
2103
+ # "__string" => "__string",
2104
+ # },
2105
+ # expires_after: "__string",
2106
+ # icon_reference: "__string",
2107
+ # image_icon_url: "__string",
2108
+ # image_url: "__string",
2109
+ # json_data: "__string",
2110
+ # md5: "__string",
2111
+ # raw_content: "__string",
2112
+ # silent_push: false,
2113
+ # small_image_icon_url: "__string",
2114
+ # sound: "__string",
2115
+ # substitutions: {
2116
+ # "__string" => ["__string"],
2117
+ # },
2118
+ # title: "__string",
2119
+ # url: "__string",
2120
+ # },
1415
2121
  # apns_message: {
1416
2122
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1417
2123
  # badge: 1,
@@ -1420,7 +2126,9 @@ module Aws::Pinpoint
1420
2126
  # data: {
1421
2127
  # "__string" => "__string",
1422
2128
  # },
2129
+ # json_data: "__string",
1423
2130
  # media_url: "__string",
2131
+ # preferred_authentication_method: "__string",
1424
2132
  # raw_content: "__string",
1425
2133
  # silent_push: false,
1426
2134
  # sound: "__string",
@@ -1431,6 +2139,26 @@ module Aws::Pinpoint
1431
2139
  # title: "__string",
1432
2140
  # url: "__string",
1433
2141
  # },
2142
+ # baidu_message: {
2143
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
2144
+ # body: "__string",
2145
+ # data: {
2146
+ # "__string" => "__string",
2147
+ # },
2148
+ # icon_reference: "__string",
2149
+ # image_icon_url: "__string",
2150
+ # image_url: "__string",
2151
+ # json_data: "__string",
2152
+ # raw_content: "__string",
2153
+ # silent_push: false,
2154
+ # small_image_icon_url: "__string",
2155
+ # sound: "__string",
2156
+ # substitutions: {
2157
+ # "__string" => ["__string"],
2158
+ # },
2159
+ # title: "__string",
2160
+ # url: "__string",
2161
+ # },
1434
2162
  # default_message: {
1435
2163
  # body: "__string",
1436
2164
  # substitutions: {
@@ -1443,6 +2171,7 @@ module Aws::Pinpoint
1443
2171
  # data: {
1444
2172
  # "__string" => "__string",
1445
2173
  # },
2174
+ # json_data: "__string",
1446
2175
  # silent_push: false,
1447
2176
  # substitutions: {
1448
2177
  # "__string" => ["__string"],
@@ -1450,6 +2179,16 @@ module Aws::Pinpoint
1450
2179
  # title: "__string",
1451
2180
  # url: "__string",
1452
2181
  # },
2182
+ # email_message: {
2183
+ # body: "__string",
2184
+ # from_address: "__string",
2185
+ # html_body: "__string",
2186
+ # substitutions: {
2187
+ # "__string" => ["__string"],
2188
+ # },
2189
+ # template_arn: "__string",
2190
+ # title: "__string",
2191
+ # },
1453
2192
  # gcm_message: {
1454
2193
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1455
2194
  # body: "__string",
@@ -1460,6 +2199,7 @@ module Aws::Pinpoint
1460
2199
  # icon_reference: "__string",
1461
2200
  # image_icon_url: "__string",
1462
2201
  # image_url: "__string",
2202
+ # json_data: "__string",
1463
2203
  # raw_content: "__string",
1464
2204
  # restricted_package_name: "__string",
1465
2205
  # silent_push: false,
@@ -1481,11 +2221,21 @@ module Aws::Pinpoint
1481
2221
  # },
1482
2222
  # }
1483
2223
  #
2224
+ # @!attribute [rw] adm_message
2225
+ # The message to ADM channels. Overrides the default push notification
2226
+ # message.
2227
+ # @return [Types::ADMMessage]
2228
+ #
1484
2229
  # @!attribute [rw] apns_message
1485
2230
  # The message to APNS channels. Overrides the default push
1486
2231
  # notification message.
1487
2232
  # @return [Types::APNSMessage]
1488
2233
  #
2234
+ # @!attribute [rw] baidu_message
2235
+ # The message to Baidu GCM channels. Overrides the default push
2236
+ # notification message.
2237
+ # @return [Types::BaiduMessage]
2238
+ #
1489
2239
  # @!attribute [rw] default_message
1490
2240
  # The default message for all channels.
1491
2241
  # @return [Types::DefaultMessage]
@@ -1494,6 +2244,10 @@ module Aws::Pinpoint
1494
2244
  # The default push notification message for all push channels.
1495
2245
  # @return [Types::DefaultPushNotificationMessage]
1496
2246
  #
2247
+ # @!attribute [rw] email_message
2248
+ # The message to Email channels. Overrides the default message.
2249
+ # @return [Types::EmailMessage]
2250
+ #
1497
2251
  # @!attribute [rw] gcm_message
1498
2252
  # The message to GCM channels. Overrides the default push notification
1499
2253
  # message.
@@ -1503,10 +2257,15 @@ module Aws::Pinpoint
1503
2257
  # The message to SMS channels. Overrides the default message.
1504
2258
  # @return [Types::SMSMessage]
1505
2259
  #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DirectMessageConfiguration AWS API Documentation
2261
+ #
1506
2262
  class DirectMessageConfiguration < Struct.new(
2263
+ :adm_message,
1507
2264
  :apns_message,
2265
+ :baidu_message,
1508
2266
  :default_message,
1509
2267
  :default_push_notification_message,
2268
+ :email_message,
1510
2269
  :gcm_message,
1511
2270
  :sms_message)
1512
2271
  include Aws::Structure
@@ -1541,6 +2300,8 @@ module Aws::Pinpoint
1541
2300
  # event ingestion service
1542
2301
  # @return [String]
1543
2302
  #
2303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailChannelRequest AWS API Documentation
2304
+ #
1544
2305
  class EmailChannelRequest < Struct.new(
1545
2306
  :enabled,
1546
2307
  :from_address,
@@ -1600,6 +2361,8 @@ module Aws::Pinpoint
1600
2361
  # Version of channel
1601
2362
  # @return [Integer]
1602
2363
  #
2364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailChannelResponse AWS API Documentation
2365
+ #
1603
2366
  class EmailChannelResponse < Struct.new(
1604
2367
  :application_id,
1605
2368
  :creation_date,
@@ -1616,6 +2379,59 @@ module Aws::Pinpoint
1616
2379
  include Aws::Structure
1617
2380
  end
1618
2381
 
2382
+ # Email Message.
2383
+ #
2384
+ # @note When making an API call, you may pass EmailMessage
2385
+ # data as a hash:
2386
+ #
2387
+ # {
2388
+ # body: "__string",
2389
+ # from_address: "__string",
2390
+ # html_body: "__string",
2391
+ # substitutions: {
2392
+ # "__string" => ["__string"],
2393
+ # },
2394
+ # template_arn: "__string",
2395
+ # title: "__string",
2396
+ # }
2397
+ #
2398
+ # @!attribute [rw] body
2399
+ # The message body of the notification, the email body or the text
2400
+ # message.
2401
+ # @return [String]
2402
+ #
2403
+ # @!attribute [rw] from_address
2404
+ # The email address used to send the email from. Defaults to use
2405
+ # FromAddress specified in the Email Channel.
2406
+ # @return [String]
2407
+ #
2408
+ # @!attribute [rw] html_body
2409
+ # The HTML part of the email.
2410
+ # @return [String]
2411
+ #
2412
+ # @!attribute [rw] substitutions
2413
+ # @return [Hash<String,Array<String>>]
2414
+ #
2415
+ # @!attribute [rw] template_arn
2416
+ # The ARN of the template to use for the email.
2417
+ # @return [String]
2418
+ #
2419
+ # @!attribute [rw] title
2420
+ # The subject of the email.
2421
+ # @return [String]
2422
+ #
2423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailMessage AWS API Documentation
2424
+ #
2425
+ class EmailMessage < Struct.new(
2426
+ :body,
2427
+ :from_address,
2428
+ :html_body,
2429
+ :substitutions,
2430
+ :template_arn,
2431
+ :title)
2432
+ include Aws::Structure
2433
+ end
2434
+
1619
2435
  # Endpoint update request
1620
2436
  #
1621
2437
  # @note When making an API call, you may pass EndpointBatchItem
@@ -1626,7 +2442,7 @@ module Aws::Pinpoint
1626
2442
  # attributes: {
1627
2443
  # "__string" => ["__string"],
1628
2444
  # },
1629
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
2445
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
1630
2446
  # demographic: {
1631
2447
  # app_version: "__string",
1632
2448
  # locale: "__string",
@@ -1713,6 +2529,8 @@ module Aws::Pinpoint
1713
2529
  # Pinpoint.
1714
2530
  # @return [Types::EndpointUser]
1715
2531
  #
2532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointBatchItem AWS API Documentation
2533
+ #
1716
2534
  class EndpointBatchItem < Struct.new(
1717
2535
  :address,
1718
2536
  :attributes,
@@ -1741,7 +2559,7 @@ module Aws::Pinpoint
1741
2559
  # attributes: {
1742
2560
  # "__string" => ["__string"],
1743
2561
  # },
1744
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
2562
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
1745
2563
  # demographic: {
1746
2564
  # app_version: "__string",
1747
2565
  # locale: "__string",
@@ -1782,6 +2600,8 @@ module Aws::Pinpoint
1782
2600
  # List of items to update. Maximum 100 items
1783
2601
  # @return [Array<Types::EndpointBatchItem>]
1784
2602
  #
2603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointBatchRequest AWS API Documentation
2604
+ #
1785
2605
  class EndpointBatchRequest < Struct.new(
1786
2606
  :item)
1787
2607
  include Aws::Structure
@@ -1838,6 +2658,8 @@ module Aws::Pinpoint
1838
2658
  # as Americas/Los\_Angeles.
1839
2659
  # @return [String]
1840
2660
  #
2661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointDemographic AWS API Documentation
2662
+ #
1841
2663
  class EndpointDemographic < Struct.new(
1842
2664
  :app_version,
1843
2665
  :locale,
@@ -1891,6 +2713,8 @@ module Aws::Pinpoint
1891
2713
  # state in US.
1892
2714
  # @return [String]
1893
2715
  #
2716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointLocation AWS API Documentation
2717
+ #
1894
2718
  class EndpointLocation < Struct.new(
1895
2719
  :city,
1896
2720
  :country,
@@ -1901,6 +2725,39 @@ module Aws::Pinpoint
1901
2725
  include Aws::Structure
1902
2726
  end
1903
2727
 
2728
+ # The result from sending a message to an endpoint.
2729
+ #
2730
+ # @!attribute [rw] address
2731
+ # Address that endpoint message was delivered to.
2732
+ # @return [String]
2733
+ #
2734
+ # @!attribute [rw] delivery_status
2735
+ # Delivery status of message.
2736
+ # @return [String]
2737
+ #
2738
+ # @!attribute [rw] status_code
2739
+ # Downstream service status code.
2740
+ # @return [Integer]
2741
+ #
2742
+ # @!attribute [rw] status_message
2743
+ # Status message for message delivery.
2744
+ # @return [String]
2745
+ #
2746
+ # @!attribute [rw] updated_token
2747
+ # If token was updated as part of delivery. (This is GCM Specific)
2748
+ # @return [String]
2749
+ #
2750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointMessageResult AWS API Documentation
2751
+ #
2752
+ class EndpointMessageResult < Struct.new(
2753
+ :address,
2754
+ :delivery_status,
2755
+ :status_code,
2756
+ :status_message,
2757
+ :updated_token)
2758
+ include Aws::Structure
2759
+ end
2760
+
1904
2761
  # Endpoint update request
1905
2762
  #
1906
2763
  # @note When making an API call, you may pass EndpointRequest
@@ -1911,7 +2768,7 @@ module Aws::Pinpoint
1911
2768
  # attributes: {
1912
2769
  # "__string" => ["__string"],
1913
2770
  # },
1914
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
2771
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
1915
2772
  # demographic: {
1916
2773
  # app_version: "__string",
1917
2774
  # locale: "__string",
@@ -1993,6 +2850,8 @@ module Aws::Pinpoint
1993
2850
  # Pinpoint.
1994
2851
  # @return [Types::EndpointUser]
1995
2852
  #
2853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointRequest AWS API Documentation
2854
+ #
1996
2855
  class EndpointRequest < Struct.new(
1997
2856
  :address,
1998
2857
  :attributes,
@@ -2076,6 +2935,7 @@ module Aws::Pinpoint
2076
2935
  # @return [String]
2077
2936
  #
2078
2937
  # @!attribute [rw] shard_id
2938
+ # The ShardId of endpoint.
2079
2939
  # @return [String]
2080
2940
  #
2081
2941
  # @!attribute [rw] user
@@ -2083,6 +2943,8 @@ module Aws::Pinpoint
2083
2943
  # Pinpoint.
2084
2944
  # @return [Types::EndpointUser]
2085
2945
  #
2946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointResponse AWS API Documentation
2947
+ #
2086
2948
  class EndpointResponse < Struct.new(
2087
2949
  :address,
2088
2950
  :application_id,
@@ -2103,6 +2965,54 @@ module Aws::Pinpoint
2103
2965
  include Aws::Structure
2104
2966
  end
2105
2967
 
2968
+ # Endpoint send configuration.
2969
+ #
2970
+ # @note When making an API call, you may pass EndpointSendConfiguration
2971
+ # data as a hash:
2972
+ #
2973
+ # {
2974
+ # body_override: "__string",
2975
+ # context: {
2976
+ # "__string" => "__string",
2977
+ # },
2978
+ # raw_content: "__string",
2979
+ # substitutions: {
2980
+ # "__string" => ["__string"],
2981
+ # },
2982
+ # title_override: "__string",
2983
+ # }
2984
+ #
2985
+ # @!attribute [rw] body_override
2986
+ # Body override. If specified will override default body.
2987
+ # @return [String]
2988
+ #
2989
+ # @!attribute [rw] context
2990
+ # @return [Hash<String,String>]
2991
+ #
2992
+ # @!attribute [rw] raw_content
2993
+ # The Raw JSON formatted string to be used as the payload. This value
2994
+ # overrides the message.
2995
+ # @return [String]
2996
+ #
2997
+ # @!attribute [rw] substitutions
2998
+ # @return [Hash<String,Array<String>>]
2999
+ #
3000
+ # @!attribute [rw] title_override
3001
+ # Title override. If specified will override default title if
3002
+ # applicable.
3003
+ # @return [String]
3004
+ #
3005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointSendConfiguration AWS API Documentation
3006
+ #
3007
+ class EndpointSendConfiguration < Struct.new(
3008
+ :body_override,
3009
+ :context,
3010
+ :raw_content,
3011
+ :substitutions,
3012
+ :title_override)
3013
+ include Aws::Structure
3014
+ end
3015
+
2106
3016
  # Endpoint user specific custom userAttributes
2107
3017
  #
2108
3018
  # @note When making an API call, you may pass EndpointUser
@@ -2122,6 +3032,8 @@ module Aws::Pinpoint
2122
3032
  # The unique ID of the user.
2123
3033
  # @return [String]
2124
3034
  #
3035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointUser AWS API Documentation
3036
+ #
2125
3037
  class EndpointUser < Struct.new(
2126
3038
  :user_attributes,
2127
3039
  :user_id)
@@ -2160,6 +3072,8 @@ module Aws::Pinpoint
2160
3072
  # the stream in your account.
2161
3073
  # @return [String]
2162
3074
  #
3075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventStream AWS API Documentation
3076
+ #
2163
3077
  class EventStream < Struct.new(
2164
3078
  :application_id,
2165
3079
  :destination_stream_arn,
@@ -2188,6 +3102,8 @@ module Aws::Pinpoint
2188
3102
  # If the channel is enabled for sending messages.
2189
3103
  # @return [Boolean]
2190
3104
  #
3105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GCMChannelRequest AWS API Documentation
3106
+ #
2191
3107
  class GCMChannelRequest < Struct.new(
2192
3108
  :api_key,
2193
3109
  :enabled)
@@ -2236,6 +3152,8 @@ module Aws::Pinpoint
2236
3152
  # Version of channel
2237
3153
  # @return [Integer]
2238
3154
  #
3155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GCMChannelResponse AWS API Documentation
3156
+ #
2239
3157
  class GCMChannelResponse < Struct.new(
2240
3158
  :application_id,
2241
3159
  :creation_date,
@@ -2265,6 +3183,7 @@ module Aws::Pinpoint
2265
3183
  # icon_reference: "__string",
2266
3184
  # image_icon_url: "__string",
2267
3185
  # image_url: "__string",
3186
+ # json_data: "__string",
2268
3187
  # raw_content: "__string",
2269
3188
  # restricted_package_name: "__string",
2270
3189
  # silent_push: false,
@@ -2317,6 +3236,11 @@ module Aws::Pinpoint
2317
3236
  # The URL that points to an image used in the push notification.
2318
3237
  # @return [String]
2319
3238
  #
3239
+ # @!attribute [rw] json_data
3240
+ # The data payload used for a silent push. This payload is added to
3241
+ # the notifications' data.pinpoint.jsonBody' object
3242
+ # @return [String]
3243
+ #
2320
3244
  # @!attribute [rw] raw_content
2321
3245
  # The Raw JSON formatted string to be used as the payload. This value
2322
3246
  # overrides the message.
@@ -2358,6 +3282,8 @@ module Aws::Pinpoint
2358
3282
  # Action is URL.
2359
3283
  # @return [String]
2360
3284
  #
3285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GCMMessage AWS API Documentation
3286
+ #
2361
3287
  class GCMMessage < Struct.new(
2362
3288
  :action,
2363
3289
  :body,
@@ -2366,6 +3292,7 @@ module Aws::Pinpoint
2366
3292
  :icon_reference,
2367
3293
  :image_icon_url,
2368
3294
  :image_url,
3295
+ :json_data,
2369
3296
  :raw_content,
2370
3297
  :restricted_package_name,
2371
3298
  :silent_push,
@@ -2377,6 +3304,34 @@ module Aws::Pinpoint
2377
3304
  include Aws::Structure
2378
3305
  end
2379
3306
 
3307
+ # @note When making an API call, you may pass GetAdmChannelRequest
3308
+ # data as a hash:
3309
+ #
3310
+ # {
3311
+ # application_id: "__string", # required
3312
+ # }
3313
+ #
3314
+ # @!attribute [rw] application_id
3315
+ # @return [String]
3316
+ #
3317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAdmChannelRequest AWS API Documentation
3318
+ #
3319
+ class GetAdmChannelRequest < Struct.new(
3320
+ :application_id)
3321
+ include Aws::Structure
3322
+ end
3323
+
3324
+ # @!attribute [rw] adm_channel_response
3325
+ # Amazon Device Messaging channel definition.
3326
+ # @return [Types::ADMChannelResponse]
3327
+ #
3328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAdmChannelResponse AWS API Documentation
3329
+ #
3330
+ class GetAdmChannelResponse < Struct.new(
3331
+ :adm_channel_response)
3332
+ include Aws::Structure
3333
+ end
3334
+
2380
3335
  # @note When making an API call, you may pass GetApnsChannelRequest
2381
3336
  # data as a hash:
2382
3337
  #
@@ -2387,6 +3342,8 @@ module Aws::Pinpoint
2387
3342
  # @!attribute [rw] application_id
2388
3343
  # @return [String]
2389
3344
  #
3345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsChannelRequest AWS API Documentation
3346
+ #
2390
3347
  class GetApnsChannelRequest < Struct.new(
2391
3348
  :application_id)
2392
3349
  include Aws::Structure
@@ -2396,6 +3353,8 @@ module Aws::Pinpoint
2396
3353
  # Apple Distribution Push Notification Service channel definition.
2397
3354
  # @return [Types::APNSChannelResponse]
2398
3355
  #
3356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsChannelResponse AWS API Documentation
3357
+ #
2399
3358
  class GetApnsChannelResponse < Struct.new(
2400
3359
  :apns_channel_response)
2401
3360
  include Aws::Structure
@@ -2411,6 +3370,8 @@ module Aws::Pinpoint
2411
3370
  # @!attribute [rw] application_id
2412
3371
  # @return [String]
2413
3372
  #
3373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsSandboxChannelRequest AWS API Documentation
3374
+ #
2414
3375
  class GetApnsSandboxChannelRequest < Struct.new(
2415
3376
  :application_id)
2416
3377
  include Aws::Structure
@@ -2420,6 +3381,8 @@ module Aws::Pinpoint
2420
3381
  # Apple Development Push Notification Service channel definition.
2421
3382
  # @return [Types::APNSSandboxChannelResponse]
2422
3383
  #
3384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsSandboxChannelResponse AWS API Documentation
3385
+ #
2423
3386
  class GetApnsSandboxChannelResponse < Struct.new(
2424
3387
  :apns_sandbox_channel_response)
2425
3388
  include Aws::Structure
@@ -2435,6 +3398,8 @@ module Aws::Pinpoint
2435
3398
  # @!attribute [rw] application_id
2436
3399
  # @return [String]
2437
3400
  #
3401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAppRequest AWS API Documentation
3402
+ #
2438
3403
  class GetAppRequest < Struct.new(
2439
3404
  :application_id)
2440
3405
  include Aws::Structure
@@ -2444,6 +3409,8 @@ module Aws::Pinpoint
2444
3409
  # Application Response.
2445
3410
  # @return [Types::ApplicationResponse]
2446
3411
  #
3412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAppResponse AWS API Documentation
3413
+ #
2447
3414
  class GetAppResponse < Struct.new(
2448
3415
  :application_response)
2449
3416
  include Aws::Structure
@@ -2459,6 +3426,8 @@ module Aws::Pinpoint
2459
3426
  # @!attribute [rw] application_id
2460
3427
  # @return [String]
2461
3428
  #
3429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationSettingsRequest AWS API Documentation
3430
+ #
2462
3431
  class GetApplicationSettingsRequest < Struct.new(
2463
3432
  :application_id)
2464
3433
  include Aws::Structure
@@ -2468,6 +3437,8 @@ module Aws::Pinpoint
2468
3437
  # Application settings.
2469
3438
  # @return [Types::ApplicationSettingsResource]
2470
3439
  #
3440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationSettingsResponse AWS API Documentation
3441
+ #
2471
3442
  class GetApplicationSettingsResponse < Struct.new(
2472
3443
  :application_settings_resource)
2473
3444
  include Aws::Structure
@@ -2487,6 +3458,8 @@ module Aws::Pinpoint
2487
3458
  # @!attribute [rw] token
2488
3459
  # @return [String]
2489
3460
  #
3461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAppsRequest AWS API Documentation
3462
+ #
2490
3463
  class GetAppsRequest < Struct.new(
2491
3464
  :page_size,
2492
3465
  :token)
@@ -2497,33 +3470,65 @@ module Aws::Pinpoint
2497
3470
  # Get Applications Result.
2498
3471
  # @return [Types::ApplicationsResponse]
2499
3472
  #
3473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAppsResponse AWS API Documentation
3474
+ #
2500
3475
  class GetAppsResponse < Struct.new(
2501
3476
  :applications_response)
2502
3477
  include Aws::Structure
2503
3478
  end
2504
3479
 
2505
- # @note When making an API call, you may pass GetCampaignActivitiesRequest
3480
+ # @note When making an API call, you may pass GetBaiduChannelRequest
2506
3481
  # data as a hash:
2507
3482
  #
2508
3483
  # {
2509
3484
  # application_id: "__string", # required
2510
- # campaign_id: "__string", # required
2511
- # page_size: "__string",
2512
- # token: "__string",
2513
3485
  # }
2514
3486
  #
2515
3487
  # @!attribute [rw] application_id
2516
3488
  # @return [String]
2517
3489
  #
2518
- # @!attribute [rw] campaign_id
2519
- # @return [String]
3490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetBaiduChannelRequest AWS API Documentation
2520
3491
  #
2521
- # @!attribute [rw] page_size
2522
- # @return [String]
3492
+ class GetBaiduChannelRequest < Struct.new(
3493
+ :application_id)
3494
+ include Aws::Structure
3495
+ end
3496
+
3497
+ # @!attribute [rw] baidu_channel_response
3498
+ # Baidu Cloud Messaging channel definition
3499
+ # @return [Types::BaiduChannelResponse]
3500
+ #
3501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetBaiduChannelResponse AWS API Documentation
3502
+ #
3503
+ class GetBaiduChannelResponse < Struct.new(
3504
+ :baidu_channel_response)
3505
+ include Aws::Structure
3506
+ end
3507
+
3508
+ # @note When making an API call, you may pass GetCampaignActivitiesRequest
3509
+ # data as a hash:
3510
+ #
3511
+ # {
3512
+ # application_id: "__string", # required
3513
+ # campaign_id: "__string", # required
3514
+ # page_size: "__string",
3515
+ # token: "__string",
3516
+ # }
3517
+ #
3518
+ # @!attribute [rw] application_id
3519
+ # @return [String]
3520
+ #
3521
+ # @!attribute [rw] campaign_id
3522
+ # @return [String]
3523
+ #
3524
+ # @!attribute [rw] page_size
3525
+ # @return [String]
2523
3526
  #
2524
3527
  # @!attribute [rw] token
2525
3528
  # @return [String]
2526
3529
  #
3530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignActivitiesRequest AWS API Documentation
3531
+ #
2527
3532
  class GetCampaignActivitiesRequest < Struct.new(
2528
3533
  :application_id,
2529
3534
  :campaign_id,
@@ -2536,6 +3541,8 @@ module Aws::Pinpoint
2536
3541
  # Activities for campaign.
2537
3542
  # @return [Types::ActivitiesResponse]
2538
3543
  #
3544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignActivitiesResponse AWS API Documentation
3545
+ #
2539
3546
  class GetCampaignActivitiesResponse < Struct.new(
2540
3547
  :activities_response)
2541
3548
  include Aws::Structure
@@ -2555,6 +3562,8 @@ module Aws::Pinpoint
2555
3562
  # @!attribute [rw] campaign_id
2556
3563
  # @return [String]
2557
3564
  #
3565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignRequest AWS API Documentation
3566
+ #
2558
3567
  class GetCampaignRequest < Struct.new(
2559
3568
  :application_id,
2560
3569
  :campaign_id)
@@ -2565,6 +3574,8 @@ module Aws::Pinpoint
2565
3574
  # Campaign definition
2566
3575
  # @return [Types::CampaignResponse]
2567
3576
  #
3577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignResponse AWS API Documentation
3578
+ #
2568
3579
  class GetCampaignResponse < Struct.new(
2569
3580
  :campaign_response)
2570
3581
  include Aws::Structure
@@ -2588,6 +3599,8 @@ module Aws::Pinpoint
2588
3599
  # @!attribute [rw] version
2589
3600
  # @return [String]
2590
3601
  #
3602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersionRequest AWS API Documentation
3603
+ #
2591
3604
  class GetCampaignVersionRequest < Struct.new(
2592
3605
  :application_id,
2593
3606
  :campaign_id,
@@ -2599,6 +3612,8 @@ module Aws::Pinpoint
2599
3612
  # Campaign definition
2600
3613
  # @return [Types::CampaignResponse]
2601
3614
  #
3615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersionResponse AWS API Documentation
3616
+ #
2602
3617
  class GetCampaignVersionResponse < Struct.new(
2603
3618
  :campaign_response)
2604
3619
  include Aws::Structure
@@ -2626,6 +3641,8 @@ module Aws::Pinpoint
2626
3641
  # @!attribute [rw] token
2627
3642
  # @return [String]
2628
3643
  #
3644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersionsRequest AWS API Documentation
3645
+ #
2629
3646
  class GetCampaignVersionsRequest < Struct.new(
2630
3647
  :application_id,
2631
3648
  :campaign_id,
@@ -2638,6 +3655,8 @@ module Aws::Pinpoint
2638
3655
  # List of available campaigns.
2639
3656
  # @return [Types::CampaignsResponse]
2640
3657
  #
3658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersionsResponse AWS API Documentation
3659
+ #
2641
3660
  class GetCampaignVersionsResponse < Struct.new(
2642
3661
  :campaigns_response)
2643
3662
  include Aws::Structure
@@ -2661,6 +3680,8 @@ module Aws::Pinpoint
2661
3680
  # @!attribute [rw] token
2662
3681
  # @return [String]
2663
3682
  #
3683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignsRequest AWS API Documentation
3684
+ #
2664
3685
  class GetCampaignsRequest < Struct.new(
2665
3686
  :application_id,
2666
3687
  :page_size,
@@ -2672,6 +3693,8 @@ module Aws::Pinpoint
2672
3693
  # List of available campaigns.
2673
3694
  # @return [Types::CampaignsResponse]
2674
3695
  #
3696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignsResponse AWS API Documentation
3697
+ #
2675
3698
  class GetCampaignsResponse < Struct.new(
2676
3699
  :campaigns_response)
2677
3700
  include Aws::Structure
@@ -2687,6 +3710,8 @@ module Aws::Pinpoint
2687
3710
  # @!attribute [rw] application_id
2688
3711
  # @return [String]
2689
3712
  #
3713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailChannelRequest AWS API Documentation
3714
+ #
2690
3715
  class GetEmailChannelRequest < Struct.new(
2691
3716
  :application_id)
2692
3717
  include Aws::Structure
@@ -2696,6 +3721,8 @@ module Aws::Pinpoint
2696
3721
  # Email Channel Response.
2697
3722
  # @return [Types::EmailChannelResponse]
2698
3723
  #
3724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailChannelResponse AWS API Documentation
3725
+ #
2699
3726
  class GetEmailChannelResponse < Struct.new(
2700
3727
  :email_channel_response)
2701
3728
  include Aws::Structure
@@ -2715,6 +3742,8 @@ module Aws::Pinpoint
2715
3742
  # @!attribute [rw] endpoint_id
2716
3743
  # @return [String]
2717
3744
  #
3745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEndpointRequest AWS API Documentation
3746
+ #
2718
3747
  class GetEndpointRequest < Struct.new(
2719
3748
  :application_id,
2720
3749
  :endpoint_id)
@@ -2725,6 +3754,8 @@ module Aws::Pinpoint
2725
3754
  # Endpoint response
2726
3755
  # @return [Types::EndpointResponse]
2727
3756
  #
3757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEndpointResponse AWS API Documentation
3758
+ #
2728
3759
  class GetEndpointResponse < Struct.new(
2729
3760
  :endpoint_response)
2730
3761
  include Aws::Structure
@@ -2738,9 +3769,10 @@ module Aws::Pinpoint
2738
3769
  # }
2739
3770
  #
2740
3771
  # @!attribute [rw] application_id
2741
- # Application Id.
2742
3772
  # @return [String]
2743
3773
  #
3774
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEventStreamRequest AWS API Documentation
3775
+ #
2744
3776
  class GetEventStreamRequest < Struct.new(
2745
3777
  :application_id)
2746
3778
  include Aws::Structure
@@ -2750,6 +3782,8 @@ module Aws::Pinpoint
2750
3782
  # Model for an event publishing subscription export.
2751
3783
  # @return [Types::EventStream]
2752
3784
  #
3785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEventStreamResponse AWS API Documentation
3786
+ #
2753
3787
  class GetEventStreamResponse < Struct.new(
2754
3788
  :event_stream)
2755
3789
  include Aws::Structure
@@ -2765,6 +3799,8 @@ module Aws::Pinpoint
2765
3799
  # @!attribute [rw] application_id
2766
3800
  # @return [String]
2767
3801
  #
3802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetGcmChannelRequest AWS API Documentation
3803
+ #
2768
3804
  class GetGcmChannelRequest < Struct.new(
2769
3805
  :application_id)
2770
3806
  include Aws::Structure
@@ -2774,6 +3810,8 @@ module Aws::Pinpoint
2774
3810
  # Google Cloud Messaging channel definition
2775
3811
  # @return [Types::GCMChannelResponse]
2776
3812
  #
3813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetGcmChannelResponse AWS API Documentation
3814
+ #
2777
3815
  class GetGcmChannelResponse < Struct.new(
2778
3816
  :gcm_channel_response)
2779
3817
  include Aws::Structure
@@ -2793,6 +3831,8 @@ module Aws::Pinpoint
2793
3831
  # @!attribute [rw] job_id
2794
3832
  # @return [String]
2795
3833
  #
3834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobRequest AWS API Documentation
3835
+ #
2796
3836
  class GetImportJobRequest < Struct.new(
2797
3837
  :application_id,
2798
3838
  :job_id)
@@ -2802,6 +3842,8 @@ module Aws::Pinpoint
2802
3842
  # @!attribute [rw] import_job_response
2803
3843
  # @return [Types::ImportJobResponse]
2804
3844
  #
3845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobResponse AWS API Documentation
3846
+ #
2805
3847
  class GetImportJobResponse < Struct.new(
2806
3848
  :import_job_response)
2807
3849
  include Aws::Structure
@@ -2825,6 +3867,8 @@ module Aws::Pinpoint
2825
3867
  # @!attribute [rw] token
2826
3868
  # @return [String]
2827
3869
  #
3870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobsRequest AWS API Documentation
3871
+ #
2828
3872
  class GetImportJobsRequest < Struct.new(
2829
3873
  :application_id,
2830
3874
  :page_size,
@@ -2836,6 +3880,8 @@ module Aws::Pinpoint
2836
3880
  # Import job list.
2837
3881
  # @return [Types::ImportJobsResponse]
2838
3882
  #
3883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobsResponse AWS API Documentation
3884
+ #
2839
3885
  class GetImportJobsResponse < Struct.new(
2840
3886
  :import_jobs_response)
2841
3887
  include Aws::Structure
@@ -2863,6 +3909,8 @@ module Aws::Pinpoint
2863
3909
  # @!attribute [rw] token
2864
3910
  # @return [String]
2865
3911
  #
3912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentImportJobsRequest AWS API Documentation
3913
+ #
2866
3914
  class GetSegmentImportJobsRequest < Struct.new(
2867
3915
  :application_id,
2868
3916
  :page_size,
@@ -2875,6 +3923,8 @@ module Aws::Pinpoint
2875
3923
  # Import job list.
2876
3924
  # @return [Types::ImportJobsResponse]
2877
3925
  #
3926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentImportJobsResponse AWS API Documentation
3927
+ #
2878
3928
  class GetSegmentImportJobsResponse < Struct.new(
2879
3929
  :import_jobs_response)
2880
3930
  include Aws::Structure
@@ -2894,6 +3944,8 @@ module Aws::Pinpoint
2894
3944
  # @!attribute [rw] segment_id
2895
3945
  # @return [String]
2896
3946
  #
3947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentRequest AWS API Documentation
3948
+ #
2897
3949
  class GetSegmentRequest < Struct.new(
2898
3950
  :application_id,
2899
3951
  :segment_id)
@@ -2904,6 +3956,8 @@ module Aws::Pinpoint
2904
3956
  # Segment definition.
2905
3957
  # @return [Types::SegmentResponse]
2906
3958
  #
3959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentResponse AWS API Documentation
3960
+ #
2907
3961
  class GetSegmentResponse < Struct.new(
2908
3962
  :segment_response)
2909
3963
  include Aws::Structure
@@ -2927,6 +3981,8 @@ module Aws::Pinpoint
2927
3981
  # @!attribute [rw] version
2928
3982
  # @return [String]
2929
3983
  #
3984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersionRequest AWS API Documentation
3985
+ #
2930
3986
  class GetSegmentVersionRequest < Struct.new(
2931
3987
  :application_id,
2932
3988
  :segment_id,
@@ -2938,6 +3994,8 @@ module Aws::Pinpoint
2938
3994
  # Segment definition.
2939
3995
  # @return [Types::SegmentResponse]
2940
3996
  #
3997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersionResponse AWS API Documentation
3998
+ #
2941
3999
  class GetSegmentVersionResponse < Struct.new(
2942
4000
  :segment_response)
2943
4001
  include Aws::Structure
@@ -2965,6 +4023,8 @@ module Aws::Pinpoint
2965
4023
  # @!attribute [rw] token
2966
4024
  # @return [String]
2967
4025
  #
4026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersionsRequest AWS API Documentation
4027
+ #
2968
4028
  class GetSegmentVersionsRequest < Struct.new(
2969
4029
  :application_id,
2970
4030
  :page_size,
@@ -2977,6 +4037,8 @@ module Aws::Pinpoint
2977
4037
  # Segments in your account.
2978
4038
  # @return [Types::SegmentsResponse]
2979
4039
  #
4040
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersionsResponse AWS API Documentation
4041
+ #
2980
4042
  class GetSegmentVersionsResponse < Struct.new(
2981
4043
  :segments_response)
2982
4044
  include Aws::Structure
@@ -3000,6 +4062,8 @@ module Aws::Pinpoint
3000
4062
  # @!attribute [rw] token
3001
4063
  # @return [String]
3002
4064
  #
4065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentsRequest AWS API Documentation
4066
+ #
3003
4067
  class GetSegmentsRequest < Struct.new(
3004
4068
  :application_id,
3005
4069
  :page_size,
@@ -3011,6 +4075,8 @@ module Aws::Pinpoint
3011
4075
  # Segments in your account.
3012
4076
  # @return [Types::SegmentsResponse]
3013
4077
  #
4078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentsResponse AWS API Documentation
4079
+ #
3014
4080
  class GetSegmentsResponse < Struct.new(
3015
4081
  :segments_response)
3016
4082
  include Aws::Structure
@@ -3026,6 +4092,8 @@ module Aws::Pinpoint
3026
4092
  # @!attribute [rw] application_id
3027
4093
  # @return [String]
3028
4094
  #
4095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsChannelRequest AWS API Documentation
4096
+ #
3029
4097
  class GetSmsChannelRequest < Struct.new(
3030
4098
  :application_id)
3031
4099
  include Aws::Structure
@@ -3035,6 +4103,8 @@ module Aws::Pinpoint
3035
4103
  # SMS Channel Response.
3036
4104
  # @return [Types::SMSChannelResponse]
3037
4105
  #
4106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsChannelResponse AWS API Documentation
4107
+ #
3038
4108
  class GetSmsChannelResponse < Struct.new(
3039
4109
  :sms_channel_response)
3040
4110
  include Aws::Structure
@@ -3097,6 +4167,8 @@ module Aws::Pinpoint
3097
4167
  # DefineSegment is true.
3098
4168
  # @return [String]
3099
4169
  #
4170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ImportJobRequest AWS API Documentation
4171
+ #
3100
4172
  class ImportJobRequest < Struct.new(
3101
4173
  :define_segment,
3102
4174
  :external_id,
@@ -3152,6 +4224,8 @@ module Aws::Pinpoint
3152
4224
  # DefineSegment is true.
3153
4225
  # @return [String]
3154
4226
  #
4227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ImportJobResource AWS API Documentation
4228
+ #
3155
4229
  class ImportJobResource < Struct.new(
3156
4230
  :define_segment,
3157
4231
  :external_id,
@@ -3222,6 +4296,8 @@ module Aws::Pinpoint
3222
4296
  # The job type. Will be Import.
3223
4297
  # @return [String]
3224
4298
  #
4299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ImportJobResponse AWS API Documentation
4300
+ #
3225
4301
  class ImportJobResponse < Struct.new(
3226
4302
  :application_id,
3227
4303
  :completed_pieces,
@@ -3250,6 +4326,8 @@ module Aws::Pinpoint
3250
4326
  # of results in a paginated response.
3251
4327
  # @return [String]
3252
4328
  #
4329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ImportJobsResponse AWS API Documentation
4330
+ #
3253
4331
  class ImportJobsResponse < Struct.new(
3254
4332
  :item,
3255
4333
  :next_token)
@@ -3331,6 +4409,8 @@ module Aws::Pinpoint
3331
4409
  # Action is URL.
3332
4410
  # @return [String]
3333
4411
  #
4412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Message AWS API Documentation
4413
+ #
3334
4414
  class Message < Struct.new(
3335
4415
  :action,
3336
4416
  :body,
@@ -3356,6 +4436,8 @@ module Aws::Pinpoint
3356
4436
  # The unique message body ID.
3357
4437
  # @return [String]
3358
4438
  #
4439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageBody AWS API Documentation
4440
+ #
3359
4441
  class MessageBody < Struct.new(
3360
4442
  :message,
3361
4443
  :request_id)
@@ -3442,6 +4524,8 @@ module Aws::Pinpoint
3442
4524
  # The SMS message configuration.
3443
4525
  # @return [Types::CampaignSmsMessage]
3444
4526
  #
4527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageConfiguration AWS API Documentation
4528
+ #
3445
4529
  class MessageConfiguration < Struct.new(
3446
4530
  :apns_message,
3447
4531
  :default_message,
@@ -3460,7 +4544,7 @@ module Aws::Pinpoint
3460
4544
  # addresses: {
3461
4545
  # "__string" => {
3462
4546
  # body_override: "__string",
3463
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
4547
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
3464
4548
  # context: {
3465
4549
  # "__string" => "__string",
3466
4550
  # },
@@ -3471,10 +4555,49 @@ module Aws::Pinpoint
3471
4555
  # title_override: "__string",
3472
4556
  # },
3473
4557
  # },
4558
+ # campaign: {
4559
+ # "__string" => "__string",
4560
+ # },
3474
4561
  # context: {
3475
4562
  # "__string" => "__string",
3476
4563
  # },
4564
+ # endpoints: {
4565
+ # "__string" => {
4566
+ # body_override: "__string",
4567
+ # context: {
4568
+ # "__string" => "__string",
4569
+ # },
4570
+ # raw_content: "__string",
4571
+ # substitutions: {
4572
+ # "__string" => ["__string"],
4573
+ # },
4574
+ # title_override: "__string",
4575
+ # },
4576
+ # },
3477
4577
  # message_configuration: {
4578
+ # adm_message: {
4579
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
4580
+ # body: "__string",
4581
+ # consolidation_key: "__string",
4582
+ # data: {
4583
+ # "__string" => "__string",
4584
+ # },
4585
+ # expires_after: "__string",
4586
+ # icon_reference: "__string",
4587
+ # image_icon_url: "__string",
4588
+ # image_url: "__string",
4589
+ # json_data: "__string",
4590
+ # md5: "__string",
4591
+ # raw_content: "__string",
4592
+ # silent_push: false,
4593
+ # small_image_icon_url: "__string",
4594
+ # sound: "__string",
4595
+ # substitutions: {
4596
+ # "__string" => ["__string"],
4597
+ # },
4598
+ # title: "__string",
4599
+ # url: "__string",
4600
+ # },
3478
4601
  # apns_message: {
3479
4602
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
3480
4603
  # badge: 1,
@@ -3483,7 +4606,9 @@ module Aws::Pinpoint
3483
4606
  # data: {
3484
4607
  # "__string" => "__string",
3485
4608
  # },
4609
+ # json_data: "__string",
3486
4610
  # media_url: "__string",
4611
+ # preferred_authentication_method: "__string",
3487
4612
  # raw_content: "__string",
3488
4613
  # silent_push: false,
3489
4614
  # sound: "__string",
@@ -3494,6 +4619,26 @@ module Aws::Pinpoint
3494
4619
  # title: "__string",
3495
4620
  # url: "__string",
3496
4621
  # },
4622
+ # baidu_message: {
4623
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
4624
+ # body: "__string",
4625
+ # data: {
4626
+ # "__string" => "__string",
4627
+ # },
4628
+ # icon_reference: "__string",
4629
+ # image_icon_url: "__string",
4630
+ # image_url: "__string",
4631
+ # json_data: "__string",
4632
+ # raw_content: "__string",
4633
+ # silent_push: false,
4634
+ # small_image_icon_url: "__string",
4635
+ # sound: "__string",
4636
+ # substitutions: {
4637
+ # "__string" => ["__string"],
4638
+ # },
4639
+ # title: "__string",
4640
+ # url: "__string",
4641
+ # },
3497
4642
  # default_message: {
3498
4643
  # body: "__string",
3499
4644
  # substitutions: {
@@ -3506,6 +4651,7 @@ module Aws::Pinpoint
3506
4651
  # data: {
3507
4652
  # "__string" => "__string",
3508
4653
  # },
4654
+ # json_data: "__string",
3509
4655
  # silent_push: false,
3510
4656
  # substitutions: {
3511
4657
  # "__string" => ["__string"],
@@ -3513,6 +4659,16 @@ module Aws::Pinpoint
3513
4659
  # title: "__string",
3514
4660
  # url: "__string",
3515
4661
  # },
4662
+ # email_message: {
4663
+ # body: "__string",
4664
+ # from_address: "__string",
4665
+ # html_body: "__string",
4666
+ # substitutions: {
4667
+ # "__string" => ["__string"],
4668
+ # },
4669
+ # template_arn: "__string",
4670
+ # title: "__string",
4671
+ # },
3516
4672
  # gcm_message: {
3517
4673
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
3518
4674
  # body: "__string",
@@ -3523,6 +4679,7 @@ module Aws::Pinpoint
3523
4679
  # icon_reference: "__string",
3524
4680
  # image_icon_url: "__string",
3525
4681
  # image_url: "__string",
4682
+ # json_data: "__string",
3526
4683
  # raw_content: "__string",
3527
4684
  # restricted_package_name: "__string",
3528
4685
  # silent_push: false,
@@ -3543,6 +4700,7 @@ module Aws::Pinpoint
3543
4700
  # },
3544
4701
  # },
3545
4702
  # },
4703
+ # request_id: "__string",
3546
4704
  # }
3547
4705
  #
3548
4706
  # @!attribute [rw] addresses
@@ -3551,17 +4709,35 @@ module Aws::Pinpoint
3551
4709
  # as the value.
3552
4710
  # @return [Hash<String,Types::AddressConfiguration>]
3553
4711
  #
4712
+ # @!attribute [rw] campaign
4713
+ # @return [Hash<String,String>]
4714
+ #
3554
4715
  # @!attribute [rw] context
3555
4716
  # @return [Hash<String,String>]
3556
4717
  #
4718
+ # @!attribute [rw] endpoints
4719
+ # A map of destination addresses, with the address as the key(Email
4720
+ # address, phone number or push token) and the Address Configuration
4721
+ # as the value.
4722
+ # @return [Hash<String,Types::EndpointSendConfiguration>]
4723
+ #
3557
4724
  # @!attribute [rw] message_configuration
3558
4725
  # Message configuration.
3559
4726
  # @return [Types::DirectMessageConfiguration]
3560
4727
  #
4728
+ # @!attribute [rw] request_id
4729
+ # Original request Id for which this message is delivered.
4730
+ # @return [String]
4731
+ #
4732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageRequest AWS API Documentation
4733
+ #
3561
4734
  class MessageRequest < Struct.new(
3562
4735
  :addresses,
4736
+ :campaign,
3563
4737
  :context,
3564
- :message_configuration)
4738
+ :endpoints,
4739
+ :message_configuration,
4740
+ :request_id)
3565
4741
  include Aws::Structure
3566
4742
  end
3567
4743
 
@@ -3571,6 +4747,11 @@ module Aws::Pinpoint
3571
4747
  # Application id of the message.
3572
4748
  # @return [String]
3573
4749
  #
4750
+ # @!attribute [rw] endpoint_result
4751
+ # A map containing a multi part response for each address, with the
4752
+ # endpointId as the key and the result as the value.
4753
+ # @return [Hash<String,Types::EndpointMessageResult>]
4754
+ #
3574
4755
  # @!attribute [rw] request_id
3575
4756
  # Original request Id for which this message was delivered.
3576
4757
  # @return [String]
@@ -3581,8 +4762,11 @@ module Aws::Pinpoint
3581
4762
  # the result as the value.
3582
4763
  # @return [Hash<String,Types::MessageResult>]
3583
4764
  #
4765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageResponse AWS API Documentation
4766
+ #
3584
4767
  class MessageResponse < Struct.new(
3585
4768
  :application_id,
4769
+ :endpoint_result,
3586
4770
  :request_id,
3587
4771
  :result)
3588
4772
  include Aws::Structure
@@ -3606,6 +4790,8 @@ module Aws::Pinpoint
3606
4790
  # If token was updated as part of delivery. (This is GCM Specific)
3607
4791
  # @return [String]
3608
4792
  #
4793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageResult AWS API Documentation
4794
+ #
3609
4795
  class MessageResult < Struct.new(
3610
4796
  :delivery_status,
3611
4797
  :status_code,
@@ -3621,18 +4807,20 @@ module Aws::Pinpoint
3621
4807
  # application_id: "__string", # required
3622
4808
  # write_event_stream: { # required
3623
4809
  # destination_stream_arn: "__string",
4810
+ # external_id: "__string",
3624
4811
  # role_arn: "__string",
3625
4812
  # },
3626
4813
  # }
3627
4814
  #
3628
4815
  # @!attribute [rw] application_id
3629
- # Application Id.
3630
4816
  # @return [String]
3631
4817
  #
3632
4818
  # @!attribute [rw] write_event_stream
3633
- # Write event stream wrapper.
4819
+ # Request to save an EventStream.
3634
4820
  # @return [Types::WriteEventStream]
3635
4821
  #
4822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventStreamRequest AWS API Documentation
4823
+ #
3636
4824
  class PutEventStreamRequest < Struct.new(
3637
4825
  :application_id,
3638
4826
  :write_event_stream)
@@ -3643,6 +4831,8 @@ module Aws::Pinpoint
3643
4831
  # Model for an event publishing subscription export.
3644
4832
  # @return [Types::EventStream]
3645
4833
  #
4834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventStreamResponse AWS API Documentation
4835
+ #
3646
4836
  class PutEventStreamResponse < Struct.new(
3647
4837
  :event_stream)
3648
4838
  include Aws::Structure
@@ -3666,6 +4856,8 @@ module Aws::Pinpoint
3666
4856
  # The default start time for quiet time in ISO 8601 format.
3667
4857
  # @return [String]
3668
4858
  #
4859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/QuietTime AWS API Documentation
4860
+ #
3669
4861
  class QuietTime < Struct.new(
3670
4862
  :end,
3671
4863
  :start)
@@ -3694,6 +4886,8 @@ module Aws::Pinpoint
3694
4886
  # included in the segment.
3695
4887
  # @return [String]
3696
4888
  #
4889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RecencyDimension AWS API Documentation
4890
+ #
3697
4891
  class RecencyDimension < Struct.new(
3698
4892
  :duration,
3699
4893
  :recency_type)
@@ -3708,6 +4902,7 @@ module Aws::Pinpoint
3708
4902
  # {
3709
4903
  # enabled: false,
3710
4904
  # sender_id: "__string",
4905
+ # short_code: "__string",
3711
4906
  # }
3712
4907
  #
3713
4908
  # @!attribute [rw] enabled
@@ -3718,9 +4913,16 @@ module Aws::Pinpoint
3718
4913
  # Sender identifier of your messages.
3719
4914
  # @return [String]
3720
4915
  #
4916
+ # @!attribute [rw] short_code
4917
+ # ShortCode registered with phone provider.
4918
+ # @return [String]
4919
+ #
4920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSChannelRequest AWS API Documentation
4921
+ #
3721
4922
  class SMSChannelRequest < Struct.new(
3722
4923
  :enabled,
3723
- :sender_id)
4924
+ :sender_id,
4925
+ :short_code)
3724
4926
  include Aws::Structure
3725
4927
  end
3726
4928
 
@@ -3770,6 +4972,8 @@ module Aws::Pinpoint
3770
4972
  # Version of channel
3771
4973
  # @return [Integer]
3772
4974
  #
4975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSChannelResponse AWS API Documentation
4976
+ #
3773
4977
  class SMSChannelResponse < Struct.new(
3774
4978
  :application_id,
3775
4979
  :creation_date,
@@ -3815,6 +5019,8 @@ module Aws::Pinpoint
3815
5019
  # @!attribute [rw] substitutions
3816
5020
  # @return [Hash<String,Array<String>>]
3817
5021
  #
5022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSMessage AWS API Documentation
5023
+ #
3818
5024
  class SMSMessage < Struct.new(
3819
5025
  :body,
3820
5026
  :message_type,
@@ -3870,6 +5076,8 @@ module Aws::Pinpoint
3870
5076
  # UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
3871
5077
  # @return [String]
3872
5078
  #
5079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Schedule AWS API Documentation
5080
+ #
3873
5081
  class Schedule < Struct.new(
3874
5082
  :end_time,
3875
5083
  :frequency,
@@ -3896,6 +5104,8 @@ module Aws::Pinpoint
3896
5104
  # The recency of use.
3897
5105
  # @return [Types::RecencyDimension]
3898
5106
  #
5107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentBehaviors AWS API Documentation
5108
+ #
3899
5109
  class SegmentBehaviors < Struct.new(
3900
5110
  :recency)
3901
5111
  include Aws::Structure
@@ -3957,6 +5167,8 @@ module Aws::Pinpoint
3957
5167
  # The device platform criteria for the segment.
3958
5168
  # @return [Types::SetDimension]
3959
5169
  #
5170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentDemographics AWS API Documentation
5171
+ #
3960
5172
  class SegmentDemographics < Struct.new(
3961
5173
  :app_version,
3962
5174
  :channel,
@@ -4045,6 +5257,8 @@ module Aws::Pinpoint
4045
5257
  # Custom segment user attributes.
4046
5258
  # @return [Hash<String,Types::AttributeDimension>]
4047
5259
  #
5260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentDimensions AWS API Documentation
5261
+ #
4048
5262
  class SegmentDimensions < Struct.new(
4049
5263
  :attributes,
4050
5264
  :behavior,
@@ -4084,6 +5298,8 @@ module Aws::Pinpoint
4084
5298
  # this segment.
4085
5299
  # @return [Integer]
4086
5300
  #
5301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentImportResource AWS API Documentation
5302
+ #
4087
5303
  class SegmentImportResource < Struct.new(
4088
5304
  :channel_counts,
4089
5305
  :external_id,
@@ -4106,114 +5322,525 @@ module Aws::Pinpoint
4106
5322
  # },
4107
5323
  # }
4108
5324
  #
4109
- # @!attribute [rw] country
4110
- # The country filter according to ISO 3166-1 Alpha-2 codes.
4111
- # @return [Types::SetDimension]
4112
- #
4113
- class SegmentLocation < Struct.new(
4114
- :country)
4115
- include Aws::Structure
4116
- end
4117
-
4118
- # Segment definition.
5325
+ # @!attribute [rw] country
5326
+ # The country filter according to ISO 3166-1 Alpha-2 codes.
5327
+ # @return [Types::SetDimension]
5328
+ #
5329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentLocation AWS API Documentation
5330
+ #
5331
+ class SegmentLocation < Struct.new(
5332
+ :country)
5333
+ include Aws::Structure
5334
+ end
5335
+
5336
+ # Segment definition.
5337
+ #
5338
+ # @!attribute [rw] application_id
5339
+ # The ID of the application to which the segment applies.
5340
+ # @return [String]
5341
+ #
5342
+ # @!attribute [rw] creation_date
5343
+ # The date the segment was created in ISO 8601 format.
5344
+ # @return [String]
5345
+ #
5346
+ # @!attribute [rw] dimensions
5347
+ # The segment dimensions attributes.
5348
+ # @return [Types::SegmentDimensions]
5349
+ #
5350
+ # @!attribute [rw] id
5351
+ # The unique segment ID.
5352
+ # @return [String]
5353
+ #
5354
+ # @!attribute [rw] import_definition
5355
+ # The import job settings.
5356
+ # @return [Types::SegmentImportResource]
5357
+ #
5358
+ # @!attribute [rw] last_modified_date
5359
+ # The date the segment was last updated in ISO 8601 format.
5360
+ # @return [String]
5361
+ #
5362
+ # @!attribute [rw] name
5363
+ # The name of segment
5364
+ # @return [String]
5365
+ #
5366
+ # @!attribute [rw] segment_type
5367
+ # The segment type: DIMENSIONAL - A dynamic segment built from
5368
+ # selection criteria based on endpoint data reported by your app. You
5369
+ # create this type of segment by using the segment builder in the
5370
+ # Amazon Pinpoint console or by making a POST request to the segments
5371
+ # resource. IMPORT - A static segment built from an imported set of
5372
+ # endpoint definitions. You create this type of segment by importing a
5373
+ # segment in the Amazon Pinpoint console or by making a POST request
5374
+ # to the jobs/import resource.
5375
+ # @return [String]
5376
+ #
5377
+ # @!attribute [rw] version
5378
+ # The segment version number.
5379
+ # @return [Integer]
5380
+ #
5381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentResponse AWS API Documentation
5382
+ #
5383
+ class SegmentResponse < Struct.new(
5384
+ :application_id,
5385
+ :creation_date,
5386
+ :dimensions,
5387
+ :id,
5388
+ :import_definition,
5389
+ :last_modified_date,
5390
+ :name,
5391
+ :segment_type,
5392
+ :version)
5393
+ include Aws::Structure
5394
+ end
5395
+
5396
+ # Segments in your account.
5397
+ #
5398
+ # @!attribute [rw] item
5399
+ # The list of segments.
5400
+ # @return [Array<Types::SegmentResponse>]
5401
+ #
5402
+ # @!attribute [rw] next_token
5403
+ # An identifier used to retrieve the next page of results. The token
5404
+ # is null if no additional pages exist.
5405
+ # @return [String]
5406
+ #
5407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentsResponse AWS API Documentation
5408
+ #
5409
+ class SegmentsResponse < Struct.new(
5410
+ :item,
5411
+ :next_token)
5412
+ include Aws::Structure
5413
+ end
5414
+
5415
+ # @note When making an API call, you may pass SendMessagesRequest
5416
+ # data as a hash:
5417
+ #
5418
+ # {
5419
+ # application_id: "__string", # required
5420
+ # message_request: { # required
5421
+ # addresses: {
5422
+ # "__string" => {
5423
+ # body_override: "__string",
5424
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
5425
+ # context: {
5426
+ # "__string" => "__string",
5427
+ # },
5428
+ # raw_content: "__string",
5429
+ # substitutions: {
5430
+ # "__string" => ["__string"],
5431
+ # },
5432
+ # title_override: "__string",
5433
+ # },
5434
+ # },
5435
+ # campaign: {
5436
+ # "__string" => "__string",
5437
+ # },
5438
+ # context: {
5439
+ # "__string" => "__string",
5440
+ # },
5441
+ # endpoints: {
5442
+ # "__string" => {
5443
+ # body_override: "__string",
5444
+ # context: {
5445
+ # "__string" => "__string",
5446
+ # },
5447
+ # raw_content: "__string",
5448
+ # substitutions: {
5449
+ # "__string" => ["__string"],
5450
+ # },
5451
+ # title_override: "__string",
5452
+ # },
5453
+ # },
5454
+ # message_configuration: {
5455
+ # adm_message: {
5456
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5457
+ # body: "__string",
5458
+ # consolidation_key: "__string",
5459
+ # data: {
5460
+ # "__string" => "__string",
5461
+ # },
5462
+ # expires_after: "__string",
5463
+ # icon_reference: "__string",
5464
+ # image_icon_url: "__string",
5465
+ # image_url: "__string",
5466
+ # json_data: "__string",
5467
+ # md5: "__string",
5468
+ # raw_content: "__string",
5469
+ # silent_push: false,
5470
+ # small_image_icon_url: "__string",
5471
+ # sound: "__string",
5472
+ # substitutions: {
5473
+ # "__string" => ["__string"],
5474
+ # },
5475
+ # title: "__string",
5476
+ # url: "__string",
5477
+ # },
5478
+ # apns_message: {
5479
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5480
+ # badge: 1,
5481
+ # body: "__string",
5482
+ # category: "__string",
5483
+ # data: {
5484
+ # "__string" => "__string",
5485
+ # },
5486
+ # json_data: "__string",
5487
+ # media_url: "__string",
5488
+ # preferred_authentication_method: "__string",
5489
+ # raw_content: "__string",
5490
+ # silent_push: false,
5491
+ # sound: "__string",
5492
+ # substitutions: {
5493
+ # "__string" => ["__string"],
5494
+ # },
5495
+ # thread_id: "__string",
5496
+ # title: "__string",
5497
+ # url: "__string",
5498
+ # },
5499
+ # baidu_message: {
5500
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5501
+ # body: "__string",
5502
+ # data: {
5503
+ # "__string" => "__string",
5504
+ # },
5505
+ # icon_reference: "__string",
5506
+ # image_icon_url: "__string",
5507
+ # image_url: "__string",
5508
+ # json_data: "__string",
5509
+ # raw_content: "__string",
5510
+ # silent_push: false,
5511
+ # small_image_icon_url: "__string",
5512
+ # sound: "__string",
5513
+ # substitutions: {
5514
+ # "__string" => ["__string"],
5515
+ # },
5516
+ # title: "__string",
5517
+ # url: "__string",
5518
+ # },
5519
+ # default_message: {
5520
+ # body: "__string",
5521
+ # substitutions: {
5522
+ # "__string" => ["__string"],
5523
+ # },
5524
+ # },
5525
+ # default_push_notification_message: {
5526
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5527
+ # body: "__string",
5528
+ # data: {
5529
+ # "__string" => "__string",
5530
+ # },
5531
+ # json_data: "__string",
5532
+ # silent_push: false,
5533
+ # substitutions: {
5534
+ # "__string" => ["__string"],
5535
+ # },
5536
+ # title: "__string",
5537
+ # url: "__string",
5538
+ # },
5539
+ # email_message: {
5540
+ # body: "__string",
5541
+ # from_address: "__string",
5542
+ # html_body: "__string",
5543
+ # substitutions: {
5544
+ # "__string" => ["__string"],
5545
+ # },
5546
+ # template_arn: "__string",
5547
+ # title: "__string",
5548
+ # },
5549
+ # gcm_message: {
5550
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5551
+ # body: "__string",
5552
+ # collapse_key: "__string",
5553
+ # data: {
5554
+ # "__string" => "__string",
5555
+ # },
5556
+ # icon_reference: "__string",
5557
+ # image_icon_url: "__string",
5558
+ # image_url: "__string",
5559
+ # json_data: "__string",
5560
+ # raw_content: "__string",
5561
+ # restricted_package_name: "__string",
5562
+ # silent_push: false,
5563
+ # small_image_icon_url: "__string",
5564
+ # sound: "__string",
5565
+ # substitutions: {
5566
+ # "__string" => ["__string"],
5567
+ # },
5568
+ # title: "__string",
5569
+ # url: "__string",
5570
+ # },
5571
+ # sms_message: {
5572
+ # body: "__string",
5573
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
5574
+ # sender_id: "__string",
5575
+ # substitutions: {
5576
+ # "__string" => ["__string"],
5577
+ # },
5578
+ # },
5579
+ # },
5580
+ # request_id: "__string",
5581
+ # },
5582
+ # }
5583
+ #
5584
+ # @!attribute [rw] application_id
5585
+ # @return [String]
5586
+ #
5587
+ # @!attribute [rw] message_request
5588
+ # Send message request.
5589
+ # @return [Types::MessageRequest]
5590
+ #
5591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendMessagesRequest AWS API Documentation
5592
+ #
5593
+ class SendMessagesRequest < Struct.new(
5594
+ :application_id,
5595
+ :message_request)
5596
+ include Aws::Structure
5597
+ end
5598
+
5599
+ # @!attribute [rw] message_response
5600
+ # Send message response.
5601
+ # @return [Types::MessageResponse]
5602
+ #
5603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendMessagesResponse AWS API Documentation
5604
+ #
5605
+ class SendMessagesResponse < Struct.new(
5606
+ :message_response)
5607
+ include Aws::Structure
5608
+ end
5609
+
5610
+ # Send message request.
5611
+ #
5612
+ # @note When making an API call, you may pass SendUsersMessageRequest
5613
+ # data as a hash:
5614
+ #
5615
+ # {
5616
+ # context: {
5617
+ # "__string" => "__string",
5618
+ # },
5619
+ # message_configuration: {
5620
+ # adm_message: {
5621
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5622
+ # body: "__string",
5623
+ # consolidation_key: "__string",
5624
+ # data: {
5625
+ # "__string" => "__string",
5626
+ # },
5627
+ # expires_after: "__string",
5628
+ # icon_reference: "__string",
5629
+ # image_icon_url: "__string",
5630
+ # image_url: "__string",
5631
+ # json_data: "__string",
5632
+ # md5: "__string",
5633
+ # raw_content: "__string",
5634
+ # silent_push: false,
5635
+ # small_image_icon_url: "__string",
5636
+ # sound: "__string",
5637
+ # substitutions: {
5638
+ # "__string" => ["__string"],
5639
+ # },
5640
+ # title: "__string",
5641
+ # url: "__string",
5642
+ # },
5643
+ # apns_message: {
5644
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5645
+ # badge: 1,
5646
+ # body: "__string",
5647
+ # category: "__string",
5648
+ # data: {
5649
+ # "__string" => "__string",
5650
+ # },
5651
+ # json_data: "__string",
5652
+ # media_url: "__string",
5653
+ # preferred_authentication_method: "__string",
5654
+ # raw_content: "__string",
5655
+ # silent_push: false,
5656
+ # sound: "__string",
5657
+ # substitutions: {
5658
+ # "__string" => ["__string"],
5659
+ # },
5660
+ # thread_id: "__string",
5661
+ # title: "__string",
5662
+ # url: "__string",
5663
+ # },
5664
+ # baidu_message: {
5665
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5666
+ # body: "__string",
5667
+ # data: {
5668
+ # "__string" => "__string",
5669
+ # },
5670
+ # icon_reference: "__string",
5671
+ # image_icon_url: "__string",
5672
+ # image_url: "__string",
5673
+ # json_data: "__string",
5674
+ # raw_content: "__string",
5675
+ # silent_push: false,
5676
+ # small_image_icon_url: "__string",
5677
+ # sound: "__string",
5678
+ # substitutions: {
5679
+ # "__string" => ["__string"],
5680
+ # },
5681
+ # title: "__string",
5682
+ # url: "__string",
5683
+ # },
5684
+ # default_message: {
5685
+ # body: "__string",
5686
+ # substitutions: {
5687
+ # "__string" => ["__string"],
5688
+ # },
5689
+ # },
5690
+ # default_push_notification_message: {
5691
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5692
+ # body: "__string",
5693
+ # data: {
5694
+ # "__string" => "__string",
5695
+ # },
5696
+ # json_data: "__string",
5697
+ # silent_push: false,
5698
+ # substitutions: {
5699
+ # "__string" => ["__string"],
5700
+ # },
5701
+ # title: "__string",
5702
+ # url: "__string",
5703
+ # },
5704
+ # email_message: {
5705
+ # body: "__string",
5706
+ # from_address: "__string",
5707
+ # html_body: "__string",
5708
+ # substitutions: {
5709
+ # "__string" => ["__string"],
5710
+ # },
5711
+ # template_arn: "__string",
5712
+ # title: "__string",
5713
+ # },
5714
+ # gcm_message: {
5715
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5716
+ # body: "__string",
5717
+ # collapse_key: "__string",
5718
+ # data: {
5719
+ # "__string" => "__string",
5720
+ # },
5721
+ # icon_reference: "__string",
5722
+ # image_icon_url: "__string",
5723
+ # image_url: "__string",
5724
+ # json_data: "__string",
5725
+ # raw_content: "__string",
5726
+ # restricted_package_name: "__string",
5727
+ # silent_push: false,
5728
+ # small_image_icon_url: "__string",
5729
+ # sound: "__string",
5730
+ # substitutions: {
5731
+ # "__string" => ["__string"],
5732
+ # },
5733
+ # title: "__string",
5734
+ # url: "__string",
5735
+ # },
5736
+ # sms_message: {
5737
+ # body: "__string",
5738
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
5739
+ # sender_id: "__string",
5740
+ # substitutions: {
5741
+ # "__string" => ["__string"],
5742
+ # },
5743
+ # },
5744
+ # },
5745
+ # request_id: "__string",
5746
+ # users: {
5747
+ # "__string" => {
5748
+ # body_override: "__string",
5749
+ # context: {
5750
+ # "__string" => "__string",
5751
+ # },
5752
+ # raw_content: "__string",
5753
+ # substitutions: {
5754
+ # "__string" => ["__string"],
5755
+ # },
5756
+ # title_override: "__string",
5757
+ # },
5758
+ # },
5759
+ # }
5760
+ #
5761
+ # @!attribute [rw] context
5762
+ # @return [Hash<String,String>]
4119
5763
  #
4120
- # @!attribute [rw] application_id
4121
- # The ID of the application to which the segment applies.
4122
- # @return [String]
5764
+ # @!attribute [rw] message_configuration
5765
+ # Message configuration.
5766
+ # @return [Types::DirectMessageConfiguration]
4123
5767
  #
4124
- # @!attribute [rw] creation_date
4125
- # The date the segment was created in ISO 8601 format.
5768
+ # @!attribute [rw] request_id
5769
+ # Original request Id for which this message is delivered.
4126
5770
  # @return [String]
4127
5771
  #
4128
- # @!attribute [rw] dimensions
4129
- # The segment dimensions attributes.
4130
- # @return [Types::SegmentDimensions]
5772
+ # @!attribute [rw] users
5773
+ # A map of destination endpoints, with the EndpointId as the key
5774
+ # Endpoint Message Configuration as the value.
5775
+ # @return [Hash<String,Types::EndpointSendConfiguration>]
4131
5776
  #
4132
- # @!attribute [rw] id
4133
- # The unique segment ID.
4134
- # @return [String]
5777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessageRequest AWS API Documentation
4135
5778
  #
4136
- # @!attribute [rw] import_definition
4137
- # The import job settings.
4138
- # @return [Types::SegmentImportResource]
5779
+ class SendUsersMessageRequest < Struct.new(
5780
+ :context,
5781
+ :message_configuration,
5782
+ :request_id,
5783
+ :users)
5784
+ include Aws::Structure
5785
+ end
5786
+
5787
+ # User send message response.
4139
5788
  #
4140
- # @!attribute [rw] last_modified_date
4141
- # The date the segment was last updated in ISO 8601 format.
5789
+ # @!attribute [rw] application_id
5790
+ # Application id of the message.
4142
5791
  # @return [String]
4143
5792
  #
4144
- # @!attribute [rw] name
4145
- # The name of segment
5793
+ # @!attribute [rw] request_id
5794
+ # Original request Id for which this message was delivered.
4146
5795
  # @return [String]
4147
5796
  #
4148
- # @!attribute [rw] segment_type
4149
- # The segment type: DIMENSIONAL - A dynamic segment built from
4150
- # selection criteria based on endpoint data reported by your app. You
4151
- # create this type of segment by using the segment builder in the
4152
- # Amazon Pinpoint console or by making a POST request to the segments
4153
- # resource. IMPORT - A static segment built from an imported set of
4154
- # endpoint definitions. You create this type of segment by importing a
4155
- # segment in the Amazon Pinpoint console or by making a POST request
4156
- # to the jobs/import resource.
4157
- # @return [String]
5797
+ # @!attribute [rw] result
5798
+ # A map containing of UserId to Map of EndpointId to Endpoint Message
5799
+ # Result.
5800
+ # @return [Hash<String,Hash<String,Types::EndpointMessageResult>>]
4158
5801
  #
4159
- # @!attribute [rw] version
4160
- # The segment version number.
4161
- # @return [Integer]
5802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessageResponse AWS API Documentation
4162
5803
  #
4163
- class SegmentResponse < Struct.new(
5804
+ class SendUsersMessageResponse < Struct.new(
4164
5805
  :application_id,
4165
- :creation_date,
4166
- :dimensions,
4167
- :id,
4168
- :import_definition,
4169
- :last_modified_date,
4170
- :name,
4171
- :segment_type,
4172
- :version)
4173
- include Aws::Structure
4174
- end
4175
-
4176
- # Segments in your account.
4177
- #
4178
- # @!attribute [rw] item
4179
- # The list of segments.
4180
- # @return [Array<Types::SegmentResponse>]
4181
- #
4182
- # @!attribute [rw] next_token
4183
- # An identifier used to retrieve the next page of results. The token
4184
- # is null if no additional pages exist.
4185
- # @return [String]
4186
- #
4187
- class SegmentsResponse < Struct.new(
4188
- :item,
4189
- :next_token)
5806
+ :request_id,
5807
+ :result)
4190
5808
  include Aws::Structure
4191
5809
  end
4192
5810
 
4193
- # @note When making an API call, you may pass SendMessagesRequest
5811
+ # @note When making an API call, you may pass SendUsersMessagesRequest
4194
5812
  # data as a hash:
4195
5813
  #
4196
5814
  # {
4197
5815
  # application_id: "__string", # required
4198
- # message_request: { # required
4199
- # addresses: {
4200
- # "__string" => {
4201
- # body_override: "__string",
4202
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
4203
- # context: {
5816
+ # send_users_message_request: { # required
5817
+ # context: {
5818
+ # "__string" => "__string",
5819
+ # },
5820
+ # message_configuration: {
5821
+ # adm_message: {
5822
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5823
+ # body: "__string",
5824
+ # consolidation_key: "__string",
5825
+ # data: {
4204
5826
  # "__string" => "__string",
4205
5827
  # },
5828
+ # expires_after: "__string",
5829
+ # icon_reference: "__string",
5830
+ # image_icon_url: "__string",
5831
+ # image_url: "__string",
5832
+ # json_data: "__string",
5833
+ # md5: "__string",
4206
5834
  # raw_content: "__string",
5835
+ # silent_push: false,
5836
+ # small_image_icon_url: "__string",
5837
+ # sound: "__string",
4207
5838
  # substitutions: {
4208
5839
  # "__string" => ["__string"],
4209
5840
  # },
4210
- # title_override: "__string",
5841
+ # title: "__string",
5842
+ # url: "__string",
4211
5843
  # },
4212
- # },
4213
- # context: {
4214
- # "__string" => "__string",
4215
- # },
4216
- # message_configuration: {
4217
5844
  # apns_message: {
4218
5845
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
4219
5846
  # badge: 1,
@@ -4222,7 +5849,9 @@ module Aws::Pinpoint
4222
5849
  # data: {
4223
5850
  # "__string" => "__string",
4224
5851
  # },
5852
+ # json_data: "__string",
4225
5853
  # media_url: "__string",
5854
+ # preferred_authentication_method: "__string",
4226
5855
  # raw_content: "__string",
4227
5856
  # silent_push: false,
4228
5857
  # sound: "__string",
@@ -4233,6 +5862,26 @@ module Aws::Pinpoint
4233
5862
  # title: "__string",
4234
5863
  # url: "__string",
4235
5864
  # },
5865
+ # baidu_message: {
5866
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
5867
+ # body: "__string",
5868
+ # data: {
5869
+ # "__string" => "__string",
5870
+ # },
5871
+ # icon_reference: "__string",
5872
+ # image_icon_url: "__string",
5873
+ # image_url: "__string",
5874
+ # json_data: "__string",
5875
+ # raw_content: "__string",
5876
+ # silent_push: false,
5877
+ # small_image_icon_url: "__string",
5878
+ # sound: "__string",
5879
+ # substitutions: {
5880
+ # "__string" => ["__string"],
5881
+ # },
5882
+ # title: "__string",
5883
+ # url: "__string",
5884
+ # },
4236
5885
  # default_message: {
4237
5886
  # body: "__string",
4238
5887
  # substitutions: {
@@ -4245,6 +5894,7 @@ module Aws::Pinpoint
4245
5894
  # data: {
4246
5895
  # "__string" => "__string",
4247
5896
  # },
5897
+ # json_data: "__string",
4248
5898
  # silent_push: false,
4249
5899
  # substitutions: {
4250
5900
  # "__string" => ["__string"],
@@ -4252,6 +5902,16 @@ module Aws::Pinpoint
4252
5902
  # title: "__string",
4253
5903
  # url: "__string",
4254
5904
  # },
5905
+ # email_message: {
5906
+ # body: "__string",
5907
+ # from_address: "__string",
5908
+ # html_body: "__string",
5909
+ # substitutions: {
5910
+ # "__string" => ["__string"],
5911
+ # },
5912
+ # template_arn: "__string",
5913
+ # title: "__string",
5914
+ # },
4255
5915
  # gcm_message: {
4256
5916
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
4257
5917
  # body: "__string",
@@ -4262,6 +5922,7 @@ module Aws::Pinpoint
4262
5922
  # icon_reference: "__string",
4263
5923
  # image_icon_url: "__string",
4264
5924
  # image_url: "__string",
5925
+ # json_data: "__string",
4265
5926
  # raw_content: "__string",
4266
5927
  # restricted_package_name: "__string",
4267
5928
  # silent_push: false,
@@ -4282,28 +5943,46 @@ module Aws::Pinpoint
4282
5943
  # },
4283
5944
  # },
4284
5945
  # },
5946
+ # request_id: "__string",
5947
+ # users: {
5948
+ # "__string" => {
5949
+ # body_override: "__string",
5950
+ # context: {
5951
+ # "__string" => "__string",
5952
+ # },
5953
+ # raw_content: "__string",
5954
+ # substitutions: {
5955
+ # "__string" => ["__string"],
5956
+ # },
5957
+ # title_override: "__string",
5958
+ # },
5959
+ # },
4285
5960
  # },
4286
5961
  # }
4287
5962
  #
4288
5963
  # @!attribute [rw] application_id
4289
5964
  # @return [String]
4290
5965
  #
4291
- # @!attribute [rw] message_request
5966
+ # @!attribute [rw] send_users_message_request
4292
5967
  # Send message request.
4293
- # @return [Types::MessageRequest]
5968
+ # @return [Types::SendUsersMessageRequest]
4294
5969
  #
4295
- class SendMessagesRequest < Struct.new(
5970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessagesRequest AWS API Documentation
5971
+ #
5972
+ class SendUsersMessagesRequest < Struct.new(
4296
5973
  :application_id,
4297
- :message_request)
5974
+ :send_users_message_request)
4298
5975
  include Aws::Structure
4299
5976
  end
4300
5977
 
4301
- # @!attribute [rw] message_response
4302
- # Send message response.
4303
- # @return [Types::MessageResponse]
5978
+ # @!attribute [rw] send_users_message_response
5979
+ # User send message response.
5980
+ # @return [Types::SendUsersMessageResponse]
4304
5981
  #
4305
- class SendMessagesResponse < Struct.new(
4306
- :message_response)
5982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessagesResponse AWS API Documentation
5983
+ #
5984
+ class SendUsersMessagesResponse < Struct.new(
5985
+ :send_users_message_response)
4307
5986
  include Aws::Structure
4308
5987
  end
4309
5988
 
@@ -4326,6 +6005,8 @@ module Aws::Pinpoint
4326
6005
  # @!attribute [rw] values
4327
6006
  # @return [Array<String>]
4328
6007
  #
6008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SetDimension AWS API Documentation
6009
+ #
4329
6010
  class SetDimension < Struct.new(
4330
6011
  :dimension_type,
4331
6012
  :values)
@@ -4362,6 +6043,8 @@ module Aws::Pinpoint
4362
6043
  # The custom name of a variation of the campaign used for A/B testing.
4363
6044
  # @return [String]
4364
6045
  #
6046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TreatmentResource AWS API Documentation
6047
+ #
4365
6048
  class TreatmentResource < Struct.new(
4366
6049
  :id,
4367
6050
  :message_configuration,
@@ -4373,14 +6056,57 @@ module Aws::Pinpoint
4373
6056
  include Aws::Structure
4374
6057
  end
4375
6058
 
6059
+ # @note When making an API call, you may pass UpdateAdmChannelRequest
6060
+ # data as a hash:
6061
+ #
6062
+ # {
6063
+ # adm_channel_request: { # required
6064
+ # client_id: "__string",
6065
+ # client_secret: "__string",
6066
+ # enabled: false,
6067
+ # },
6068
+ # application_id: "__string", # required
6069
+ # }
6070
+ #
6071
+ # @!attribute [rw] adm_channel_request
6072
+ # Amazon Device Messaging channel definition.
6073
+ # @return [Types::ADMChannelRequest]
6074
+ #
6075
+ # @!attribute [rw] application_id
6076
+ # @return [String]
6077
+ #
6078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateAdmChannelRequest AWS API Documentation
6079
+ #
6080
+ class UpdateAdmChannelRequest < Struct.new(
6081
+ :adm_channel_request,
6082
+ :application_id)
6083
+ include Aws::Structure
6084
+ end
6085
+
6086
+ # @!attribute [rw] adm_channel_response
6087
+ # Amazon Device Messaging channel definition.
6088
+ # @return [Types::ADMChannelResponse]
6089
+ #
6090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateAdmChannelResponse AWS API Documentation
6091
+ #
6092
+ class UpdateAdmChannelResponse < Struct.new(
6093
+ :adm_channel_response)
6094
+ include Aws::Structure
6095
+ end
6096
+
4376
6097
  # @note When making an API call, you may pass UpdateApnsChannelRequest
4377
6098
  # data as a hash:
4378
6099
  #
4379
6100
  # {
4380
6101
  # apns_channel_request: { # required
6102
+ # bundle_id: "__string",
4381
6103
  # certificate: "__string",
6104
+ # default_authentication_method: "__string",
4382
6105
  # enabled: false,
4383
6106
  # private_key: "__string",
6107
+ # team_id: "__string",
6108
+ # token_key: "__string",
6109
+ # token_key_id: "__string",
4384
6110
  # },
4385
6111
  # application_id: "__string", # required
4386
6112
  # }
@@ -4392,6 +6118,8 @@ module Aws::Pinpoint
4392
6118
  # @!attribute [rw] application_id
4393
6119
  # @return [String]
4394
6120
  #
6121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsChannelRequest AWS API Documentation
6122
+ #
4395
6123
  class UpdateApnsChannelRequest < Struct.new(
4396
6124
  :apns_channel_request,
4397
6125
  :application_id)
@@ -4402,6 +6130,8 @@ module Aws::Pinpoint
4402
6130
  # Apple Distribution Push Notification Service channel definition.
4403
6131
  # @return [Types::APNSChannelResponse]
4404
6132
  #
6133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsChannelResponse AWS API Documentation
6134
+ #
4405
6135
  class UpdateApnsChannelResponse < Struct.new(
4406
6136
  :apns_channel_response)
4407
6137
  include Aws::Structure
@@ -4412,9 +6142,14 @@ module Aws::Pinpoint
4412
6142
  #
4413
6143
  # {
4414
6144
  # apns_sandbox_channel_request: { # required
6145
+ # bundle_id: "__string",
4415
6146
  # certificate: "__string",
6147
+ # default_authentication_method: "__string",
4416
6148
  # enabled: false,
4417
6149
  # private_key: "__string",
6150
+ # team_id: "__string",
6151
+ # token_key: "__string",
6152
+ # token_key_id: "__string",
4418
6153
  # },
4419
6154
  # application_id: "__string", # required
4420
6155
  # }
@@ -4426,6 +6161,8 @@ module Aws::Pinpoint
4426
6161
  # @!attribute [rw] application_id
4427
6162
  # @return [String]
4428
6163
  #
6164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsSandboxChannelRequest AWS API Documentation
6165
+ #
4429
6166
  class UpdateApnsSandboxChannelRequest < Struct.new(
4430
6167
  :apns_sandbox_channel_request,
4431
6168
  :application_id)
@@ -4436,6 +6173,8 @@ module Aws::Pinpoint
4436
6173
  # Apple Development Push Notification Service channel definition.
4437
6174
  # @return [Types::APNSSandboxChannelResponse]
4438
6175
  #
6176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsSandboxChannelResponse AWS API Documentation
6177
+ #
4439
6178
  class UpdateApnsSandboxChannelResponse < Struct.new(
4440
6179
  :apns_sandbox_channel_response)
4441
6180
  include Aws::Structure
@@ -4449,6 +6188,8 @@ module Aws::Pinpoint
4449
6188
  # write_application_settings_request: { # required
4450
6189
  # limits: {
4451
6190
  # daily: 1,
6191
+ # maximum_duration: 1,
6192
+ # messages_per_second: 1,
4452
6193
  # total: 1,
4453
6194
  # },
4454
6195
  # quiet_time: {
@@ -4465,6 +6206,8 @@ module Aws::Pinpoint
4465
6206
  # Creating application setting request
4466
6207
  # @return [Types::WriteApplicationSettingsRequest]
4467
6208
  #
6209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApplicationSettingsRequest AWS API Documentation
6210
+ #
4468
6211
  class UpdateApplicationSettingsRequest < Struct.new(
4469
6212
  :application_id,
4470
6213
  :write_application_settings_request)
@@ -4475,11 +6218,51 @@ module Aws::Pinpoint
4475
6218
  # Application settings.
4476
6219
  # @return [Types::ApplicationSettingsResource]
4477
6220
  #
6221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApplicationSettingsResponse AWS API Documentation
6222
+ #
4478
6223
  class UpdateApplicationSettingsResponse < Struct.new(
4479
6224
  :application_settings_resource)
4480
6225
  include Aws::Structure
4481
6226
  end
4482
6227
 
6228
+ # @note When making an API call, you may pass UpdateBaiduChannelRequest
6229
+ # data as a hash:
6230
+ #
6231
+ # {
6232
+ # application_id: "__string", # required
6233
+ # baidu_channel_request: { # required
6234
+ # api_key: "__string",
6235
+ # enabled: false,
6236
+ # secret_key: "__string",
6237
+ # },
6238
+ # }
6239
+ #
6240
+ # @!attribute [rw] application_id
6241
+ # @return [String]
6242
+ #
6243
+ # @!attribute [rw] baidu_channel_request
6244
+ # Baidu Cloud Push credentials
6245
+ # @return [Types::BaiduChannelRequest]
6246
+ #
6247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateBaiduChannelRequest AWS API Documentation
6248
+ #
6249
+ class UpdateBaiduChannelRequest < Struct.new(
6250
+ :application_id,
6251
+ :baidu_channel_request)
6252
+ include Aws::Structure
6253
+ end
6254
+
6255
+ # @!attribute [rw] baidu_channel_response
6256
+ # Baidu Cloud Messaging channel definition
6257
+ # @return [Types::BaiduChannelResponse]
6258
+ #
6259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateBaiduChannelResponse AWS API Documentation
6260
+ #
6261
+ class UpdateBaiduChannelResponse < Struct.new(
6262
+ :baidu_channel_response)
6263
+ include Aws::Structure
6264
+ end
6265
+
4483
6266
  # @note When making an API call, you may pass UpdateCampaignRequest
4484
6267
  # data as a hash:
4485
6268
  #
@@ -4562,6 +6345,8 @@ module Aws::Pinpoint
4562
6345
  # is_paused: false,
4563
6346
  # limits: {
4564
6347
  # daily: 1,
6348
+ # maximum_duration: 1,
6349
+ # messages_per_second: 1,
4565
6350
  # total: 1,
4566
6351
  # },
4567
6352
  # message_configuration: {
@@ -4630,6 +6415,7 @@ module Aws::Pinpoint
4630
6415
  # },
4631
6416
  # segment_id: "__string",
4632
6417
  # segment_version: 1,
6418
+ # trace: false,
4633
6419
  # treatment_description: "__string",
4634
6420
  # treatment_name: "__string",
4635
6421
  # },
@@ -4645,6 +6431,8 @@ module Aws::Pinpoint
4645
6431
  # Used to create a campaign.
4646
6432
  # @return [Types::WriteCampaignRequest]
4647
6433
  #
6434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateCampaignRequest AWS API Documentation
6435
+ #
4648
6436
  class UpdateCampaignRequest < Struct.new(
4649
6437
  :application_id,
4650
6438
  :campaign_id,
@@ -4656,6 +6444,8 @@ module Aws::Pinpoint
4656
6444
  # Campaign definition
4657
6445
  # @return [Types::CampaignResponse]
4658
6446
  #
6447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateCampaignResponse AWS API Documentation
6448
+ #
4659
6449
  class UpdateCampaignResponse < Struct.new(
4660
6450
  :campaign_response)
4661
6451
  include Aws::Structure
@@ -4681,6 +6471,8 @@ module Aws::Pinpoint
4681
6471
  # Email Channel Request
4682
6472
  # @return [Types::EmailChannelRequest]
4683
6473
  #
6474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailChannelRequest AWS API Documentation
6475
+ #
4684
6476
  class UpdateEmailChannelRequest < Struct.new(
4685
6477
  :application_id,
4686
6478
  :email_channel_request)
@@ -4691,6 +6483,8 @@ module Aws::Pinpoint
4691
6483
  # Email Channel Response.
4692
6484
  # @return [Types::EmailChannelResponse]
4693
6485
  #
6486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailChannelResponse AWS API Documentation
6487
+ #
4694
6488
  class UpdateEmailChannelResponse < Struct.new(
4695
6489
  :email_channel_response)
4696
6490
  include Aws::Structure
@@ -4707,7 +6501,7 @@ module Aws::Pinpoint
4707
6501
  # attributes: {
4708
6502
  # "__string" => ["__string"],
4709
6503
  # },
4710
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
6504
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
4711
6505
  # demographic: {
4712
6506
  # app_version: "__string",
4713
6507
  # locale: "__string",
@@ -4752,6 +6546,8 @@ module Aws::Pinpoint
4752
6546
  # Endpoint update request
4753
6547
  # @return [Types::EndpointRequest]
4754
6548
  #
6549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointRequest AWS API Documentation
6550
+ #
4755
6551
  class UpdateEndpointRequest < Struct.new(
4756
6552
  :application_id,
4757
6553
  :endpoint_id,
@@ -4763,6 +6559,8 @@ module Aws::Pinpoint
4763
6559
  # Simple message object.
4764
6560
  # @return [Types::MessageBody]
4765
6561
  #
6562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointResponse AWS API Documentation
6563
+ #
4766
6564
  class UpdateEndpointResponse < Struct.new(
4767
6565
  :message_body)
4768
6566
  include Aws::Structure
@@ -4780,7 +6578,7 @@ module Aws::Pinpoint
4780
6578
  # attributes: {
4781
6579
  # "__string" => ["__string"],
4782
6580
  # },
4783
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
6581
+ # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL, BAIDU
4784
6582
  # demographic: {
4785
6583
  # app_version: "__string",
4786
6584
  # locale: "__string",
@@ -4825,6 +6623,8 @@ module Aws::Pinpoint
4825
6623
  # Endpoint batch update request.
4826
6624
  # @return [Types::EndpointBatchRequest]
4827
6625
  #
6626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointsBatchRequest AWS API Documentation
6627
+ #
4828
6628
  class UpdateEndpointsBatchRequest < Struct.new(
4829
6629
  :application_id,
4830
6630
  :endpoint_batch_request)
@@ -4835,6 +6635,8 @@ module Aws::Pinpoint
4835
6635
  # Simple message object.
4836
6636
  # @return [Types::MessageBody]
4837
6637
  #
6638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointsBatchResponse AWS API Documentation
6639
+ #
4838
6640
  class UpdateEndpointsBatchResponse < Struct.new(
4839
6641
  :message_body)
4840
6642
  include Aws::Structure
@@ -4858,6 +6660,8 @@ module Aws::Pinpoint
4858
6660
  # Google Cloud Messaging credentials
4859
6661
  # @return [Types::GCMChannelRequest]
4860
6662
  #
6663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannelRequest AWS API Documentation
6664
+ #
4861
6665
  class UpdateGcmChannelRequest < Struct.new(
4862
6666
  :application_id,
4863
6667
  :gcm_channel_request)
@@ -4868,6 +6672,8 @@ module Aws::Pinpoint
4868
6672
  # Google Cloud Messaging channel definition
4869
6673
  # @return [Types::GCMChannelResponse]
4870
6674
  #
6675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannelResponse AWS API Documentation
6676
+ #
4871
6677
  class UpdateGcmChannelResponse < Struct.new(
4872
6678
  :gcm_channel_response)
4873
6679
  include Aws::Structure
@@ -4946,6 +6752,8 @@ module Aws::Pinpoint
4946
6752
  # Segment definition.
4947
6753
  # @return [Types::WriteSegmentRequest]
4948
6754
  #
6755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSegmentRequest AWS API Documentation
6756
+ #
4949
6757
  class UpdateSegmentRequest < Struct.new(
4950
6758
  :application_id,
4951
6759
  :segment_id,
@@ -4957,6 +6765,8 @@ module Aws::Pinpoint
4957
6765
  # Segment definition.
4958
6766
  # @return [Types::SegmentResponse]
4959
6767
  #
6768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSegmentResponse AWS API Documentation
6769
+ #
4960
6770
  class UpdateSegmentResponse < Struct.new(
4961
6771
  :segment_response)
4962
6772
  include Aws::Structure
@@ -4970,6 +6780,7 @@ module Aws::Pinpoint
4970
6780
  # sms_channel_request: { # required
4971
6781
  # enabled: false,
4972
6782
  # sender_id: "__string",
6783
+ # short_code: "__string",
4973
6784
  # },
4974
6785
  # }
4975
6786
  #
@@ -4980,6 +6791,8 @@ module Aws::Pinpoint
4980
6791
  # SMS Channel Request
4981
6792
  # @return [Types::SMSChannelRequest]
4982
6793
  #
6794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannelRequest AWS API Documentation
6795
+ #
4983
6796
  class UpdateSmsChannelRequest < Struct.new(
4984
6797
  :application_id,
4985
6798
  :sms_channel_request)
@@ -4990,6 +6803,8 @@ module Aws::Pinpoint
4990
6803
  # SMS Channel Response.
4991
6804
  # @return [Types::SMSChannelResponse]
4992
6805
  #
6806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannelResponse AWS API Documentation
6807
+ #
4993
6808
  class UpdateSmsChannelResponse < Struct.new(
4994
6809
  :sms_channel_response)
4995
6810
  include Aws::Structure
@@ -5003,6 +6818,8 @@ module Aws::Pinpoint
5003
6818
  # {
5004
6819
  # limits: {
5005
6820
  # daily: 1,
6821
+ # maximum_duration: 1,
6822
+ # messages_per_second: 1,
5006
6823
  # total: 1,
5007
6824
  # },
5008
6825
  # quiet_time: {
@@ -5023,6 +6840,8 @@ module Aws::Pinpoint
5023
6840
  # default with a quiet time of its own.
5024
6841
  # @return [Types::QuietTime]
5025
6842
  #
6843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteApplicationSettingsRequest AWS API Documentation
6844
+ #
5026
6845
  class WriteApplicationSettingsRequest < Struct.new(
5027
6846
  :limits,
5028
6847
  :quiet_time)
@@ -5110,6 +6929,8 @@ module Aws::Pinpoint
5110
6929
  # is_paused: false,
5111
6930
  # limits: {
5112
6931
  # daily: 1,
6932
+ # maximum_duration: 1,
6933
+ # messages_per_second: 1,
5113
6934
  # total: 1,
5114
6935
  # },
5115
6936
  # message_configuration: {
@@ -5178,6 +6999,7 @@ module Aws::Pinpoint
5178
6999
  # },
5179
7000
  # segment_id: "__string",
5180
7001
  # segment_version: 1,
7002
+ # trace: false,
5181
7003
  # treatment_description: "__string",
5182
7004
  # treatment_name: "__string",
5183
7005
  # }
@@ -5224,6 +7046,11 @@ module Aws::Pinpoint
5224
7046
  # The version of the segment to which the campaign sends messages.
5225
7047
  # @return [Integer]
5226
7048
  #
7049
+ # @!attribute [rw] trace
7050
+ # Whether or not to enable trace logging for the campaign.
7051
+ # Undocumented
7052
+ # @return [Boolean]
7053
+ #
5227
7054
  # @!attribute [rw] treatment_description
5228
7055
  # A custom description for the treatment.
5229
7056
  # @return [String]
@@ -5232,6 +7059,8 @@ module Aws::Pinpoint
5232
7059
  # The custom name of a variation of the campaign used for A/B testing.
5233
7060
  # @return [String]
5234
7061
  #
7062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteCampaignRequest AWS API Documentation
7063
+ #
5235
7064
  class WriteCampaignRequest < Struct.new(
5236
7065
  :additional_treatments,
5237
7066
  :description,
@@ -5243,6 +7072,7 @@ module Aws::Pinpoint
5243
7072
  :schedule,
5244
7073
  :segment_id,
5245
7074
  :segment_version,
7075
+ :trace,
5246
7076
  :treatment_description,
5247
7077
  :treatment_name)
5248
7078
  include Aws::Structure
@@ -5255,6 +7085,7 @@ module Aws::Pinpoint
5255
7085
  #
5256
7086
  # {
5257
7087
  # destination_stream_arn: "__string",
7088
+ # external_id: "__string",
5258
7089
  # role_arn: "__string",
5259
7090
  # }
5260
7091
  #
@@ -5266,13 +7097,21 @@ module Aws::Pinpoint
5266
7097
  # Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT\_ID:stream/STREAM\_NAME
5267
7098
  # @return [String]
5268
7099
  #
7100
+ # @!attribute [rw] external_id
7101
+ # The external ID assigned the IAM role that authorizes Amazon
7102
+ # Pinpoint to publish to the stream.
7103
+ # @return [String]
7104
+ #
5269
7105
  # @!attribute [rw] role_arn
5270
7106
  # The IAM role that authorizes Amazon Pinpoint to publish events to
5271
7107
  # the stream in your account.
5272
7108
  # @return [String]
5273
7109
  #
7110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteEventStream AWS API Documentation
7111
+ #
5274
7112
  class WriteEventStream < Struct.new(
5275
7113
  :destination_stream_arn,
7114
+ :external_id,
5276
7115
  :role_arn)
5277
7116
  include Aws::Structure
5278
7117
  end
@@ -5346,6 +7185,8 @@ module Aws::Pinpoint
5346
7185
  # The name of segment
5347
7186
  # @return [String]
5348
7187
  #
7188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteSegmentRequest AWS API Documentation
7189
+ #
5349
7190
  class WriteSegmentRequest < Struct.new(
5350
7191
  :dimensions,
5351
7192
  :name)
@@ -5446,6 +7287,8 @@ module Aws::Pinpoint
5446
7287
  # The custom name of a variation of the campaign used for A/B testing.
5447
7288
  # @return [String]
5448
7289
  #
7290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteTreatmentResource AWS API Documentation
7291
+ #
5449
7292
  class WriteTreatmentResource < Struct.new(
5450
7293
  :message_configuration,
5451
7294
  :schedule,