aws-sdk-pinpoint 1.31.0 → 1.32.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +264 -36
- data/lib/aws-sdk-pinpoint/client_api.rb +102 -0
- data/lib/aws-sdk-pinpoint/types.rb +482 -48
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6348954088848932afadbe022e13092f48fbeac1
|
4
|
+
data.tar.gz: 9abb309ed6840c43f6d771145b1f0d1d84039a3a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a5fb91d3d939e58741dab5f4c2041191238b06afeeb4446c17766b01248202b5bdcced851cada31a8ba3dd0bae1337522c229039a45d7fee426787b1b97369eb
|
7
|
+
data.tar.gz: 7f7a4c037f758429ed3318a4f435fbea10f1c3de451dba6ef622dffe0782a490554cbcf37a4a05fdc93ac0b930087af998d02e522686e4fcc18a51ed34b92711
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -430,15 +430,19 @@ module Aws::Pinpoint
|
|
430
430
|
# template_configuration: {
|
431
431
|
# email_template: {
|
432
432
|
# name: "__string",
|
433
|
+
# version: "__string",
|
433
434
|
# },
|
434
435
|
# push_template: {
|
435
436
|
# name: "__string",
|
437
|
+
# version: "__string",
|
436
438
|
# },
|
437
439
|
# sms_template: {
|
438
440
|
# name: "__string",
|
441
|
+
# version: "__string",
|
439
442
|
# },
|
440
443
|
# voice_template: {
|
441
444
|
# name: "__string",
|
445
|
+
# version: "__string",
|
442
446
|
# },
|
443
447
|
# },
|
444
448
|
# treatment_description: "__string",
|
@@ -583,15 +587,19 @@ module Aws::Pinpoint
|
|
583
587
|
# template_configuration: {
|
584
588
|
# email_template: {
|
585
589
|
# name: "__string",
|
590
|
+
# version: "__string",
|
586
591
|
# },
|
587
592
|
# push_template: {
|
588
593
|
# name: "__string",
|
594
|
+
# version: "__string",
|
589
595
|
# },
|
590
596
|
# sms_template: {
|
591
597
|
# name: "__string",
|
598
|
+
# version: "__string",
|
592
599
|
# },
|
593
600
|
# voice_template: {
|
594
601
|
# name: "__string",
|
602
|
+
# version: "__string",
|
595
603
|
# },
|
596
604
|
# },
|
597
605
|
# treatment_description: "__string",
|
@@ -691,9 +699,13 @@ module Aws::Pinpoint
|
|
691
699
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
692
700
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
693
701
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
702
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
|
694
703
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
704
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
|
695
705
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
706
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
|
696
707
|
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
708
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
|
697
709
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
698
710
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
699
711
|
# resp.campaign_response.application_id #=> String
|
@@ -804,9 +816,13 @@ module Aws::Pinpoint
|
|
804
816
|
# resp.campaign_response.tags #=> Hash
|
805
817
|
# resp.campaign_response.tags["__string"] #=> String
|
806
818
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
819
|
+
# resp.campaign_response.template_configuration.email_template.version #=> String
|
807
820
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
821
|
+
# resp.campaign_response.template_configuration.push_template.version #=> String
|
808
822
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
823
|
+
# resp.campaign_response.template_configuration.sms_template.version #=> String
|
809
824
|
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
825
|
+
# resp.campaign_response.template_configuration.voice_template.version #=> String
|
810
826
|
# resp.campaign_response.treatment_description #=> String
|
811
827
|
# resp.campaign_response.treatment_name #=> String
|
812
828
|
# resp.campaign_response.version #=> Integer
|
@@ -820,8 +836,8 @@ module Aws::Pinpoint
|
|
820
836
|
req.send_request(options)
|
821
837
|
end
|
822
838
|
|
823
|
-
# Creates a message template
|
824
|
-
#
|
839
|
+
# Creates a message template for messages that are sent through the
|
840
|
+
# email channel.
|
825
841
|
#
|
826
842
|
# @option params [required, Types::EmailTemplateRequest] :email_template_request
|
827
843
|
# Specifies the content and settings for a message template that can be
|
@@ -1107,6 +1123,7 @@ module Aws::Pinpoint
|
|
1107
1123
|
# },
|
1108
1124
|
# next_activity: "__string",
|
1109
1125
|
# template_name: "__string",
|
1126
|
+
# template_version: "__string",
|
1110
1127
|
# },
|
1111
1128
|
# holdout: {
|
1112
1129
|
# next_activity: "__string",
|
@@ -1324,6 +1341,7 @@ module Aws::Pinpoint
|
|
1324
1341
|
# resp.journey_response.activities["__string"].email.message_config.from_address #=> String
|
1325
1342
|
# resp.journey_response.activities["__string"].email.next_activity #=> String
|
1326
1343
|
# resp.journey_response.activities["__string"].email.template_name #=> String
|
1344
|
+
# resp.journey_response.activities["__string"].email.template_version #=> String
|
1327
1345
|
# resp.journey_response.activities["__string"].holdout.next_activity #=> String
|
1328
1346
|
# resp.journey_response.activities["__string"].holdout.percentage #=> Integer
|
1329
1347
|
# resp.journey_response.activities["__string"].multi_condition.branches #=> Array
|
@@ -1417,8 +1435,8 @@ module Aws::Pinpoint
|
|
1417
1435
|
req.send_request(options)
|
1418
1436
|
end
|
1419
1437
|
|
1420
|
-
# Creates a message template
|
1421
|
-
#
|
1438
|
+
# Creates a message template for messages that are sent through a push
|
1439
|
+
# notification channel.
|
1422
1440
|
#
|
1423
1441
|
# @option params [required, Types::PushNotificationTemplateRequest] :push_notification_template_request
|
1424
1442
|
# Specifies the content and settings for a message template that can be
|
@@ -1792,8 +1810,8 @@ module Aws::Pinpoint
|
|
1792
1810
|
req.send_request(options)
|
1793
1811
|
end
|
1794
1812
|
|
1795
|
-
# Creates a message template
|
1796
|
-
#
|
1813
|
+
# Creates a message template for messages that are sent through the SMS
|
1814
|
+
# channel.
|
1797
1815
|
#
|
1798
1816
|
# @option params [required, Types::SMSTemplateRequest] :sms_template_request
|
1799
1817
|
# Specifies the content and settings for a message template that can be
|
@@ -1834,8 +1852,8 @@ module Aws::Pinpoint
|
|
1834
1852
|
req.send_request(options)
|
1835
1853
|
end
|
1836
1854
|
|
1837
|
-
# Creates a message template
|
1838
|
-
#
|
1855
|
+
# Creates a message template for messages that are sent through the
|
1856
|
+
# voice channel.
|
1839
1857
|
#
|
1840
1858
|
# @option params [required, String] :template_name
|
1841
1859
|
#
|
@@ -2249,9 +2267,13 @@ module Aws::Pinpoint
|
|
2249
2267
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
2250
2268
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
2251
2269
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
2270
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
|
2252
2271
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
2272
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
|
2253
2273
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
2274
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
|
2254
2275
|
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
2276
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
|
2255
2277
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
2256
2278
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
2257
2279
|
# resp.campaign_response.application_id #=> String
|
@@ -2362,9 +2384,13 @@ module Aws::Pinpoint
|
|
2362
2384
|
# resp.campaign_response.tags #=> Hash
|
2363
2385
|
# resp.campaign_response.tags["__string"] #=> String
|
2364
2386
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
2387
|
+
# resp.campaign_response.template_configuration.email_template.version #=> String
|
2365
2388
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
2389
|
+
# resp.campaign_response.template_configuration.push_template.version #=> String
|
2366
2390
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
2391
|
+
# resp.campaign_response.template_configuration.sms_template.version #=> String
|
2367
2392
|
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
2393
|
+
# resp.campaign_response.template_configuration.voice_template.version #=> String
|
2368
2394
|
# resp.campaign_response.treatment_description #=> String
|
2369
2395
|
# resp.campaign_response.treatment_name #=> String
|
2370
2396
|
# resp.campaign_response.version #=> Integer
|
@@ -2420,11 +2446,13 @@ module Aws::Pinpoint
|
|
2420
2446
|
req.send_request(options)
|
2421
2447
|
end
|
2422
2448
|
|
2423
|
-
# Deletes a message template
|
2424
|
-
#
|
2449
|
+
# Deletes a message template for messages that were sent through the
|
2450
|
+
# email channel.
|
2425
2451
|
#
|
2426
2452
|
# @option params [required, String] :template_name
|
2427
2453
|
#
|
2454
|
+
# @option params [String] :version
|
2455
|
+
#
|
2428
2456
|
# @return [Types::DeleteEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2429
2457
|
#
|
2430
2458
|
# * {Types::DeleteEmailTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -2433,6 +2461,7 @@ module Aws::Pinpoint
|
|
2433
2461
|
#
|
2434
2462
|
# resp = client.delete_email_template({
|
2435
2463
|
# template_name: "__string", # required
|
2464
|
+
# version: "__string",
|
2436
2465
|
# })
|
2437
2466
|
#
|
2438
2467
|
# @example Response structure
|
@@ -2660,6 +2689,7 @@ module Aws::Pinpoint
|
|
2660
2689
|
# resp.journey_response.activities["__string"].email.message_config.from_address #=> String
|
2661
2690
|
# resp.journey_response.activities["__string"].email.next_activity #=> String
|
2662
2691
|
# resp.journey_response.activities["__string"].email.template_name #=> String
|
2692
|
+
# resp.journey_response.activities["__string"].email.template_version #=> String
|
2663
2693
|
# resp.journey_response.activities["__string"].holdout.next_activity #=> String
|
2664
2694
|
# resp.journey_response.activities["__string"].holdout.percentage #=> Integer
|
2665
2695
|
# resp.journey_response.activities["__string"].multi_condition.branches #=> Array
|
@@ -2753,11 +2783,13 @@ module Aws::Pinpoint
|
|
2753
2783
|
req.send_request(options)
|
2754
2784
|
end
|
2755
2785
|
|
2756
|
-
# Deletes a message template
|
2757
|
-
#
|
2786
|
+
# Deletes a message template for messages that were sent through a push
|
2787
|
+
# notification channel.
|
2758
2788
|
#
|
2759
2789
|
# @option params [required, String] :template_name
|
2760
2790
|
#
|
2791
|
+
# @option params [String] :version
|
2792
|
+
#
|
2761
2793
|
# @return [Types::DeletePushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2762
2794
|
#
|
2763
2795
|
# * {Types::DeletePushTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -2766,6 +2798,7 @@ module Aws::Pinpoint
|
|
2766
2798
|
#
|
2767
2799
|
# resp = client.delete_push_template({
|
2768
2800
|
# template_name: "__string", # required
|
2801
|
+
# version: "__string",
|
2769
2802
|
# })
|
2770
2803
|
#
|
2771
2804
|
# @example Response structure
|
@@ -2951,11 +2984,13 @@ module Aws::Pinpoint
|
|
2951
2984
|
req.send_request(options)
|
2952
2985
|
end
|
2953
2986
|
|
2954
|
-
# Deletes a message template
|
2955
|
-
#
|
2987
|
+
# Deletes a message template for messages that were sent through the SMS
|
2988
|
+
# channel.
|
2956
2989
|
#
|
2957
2990
|
# @option params [required, String] :template_name
|
2958
2991
|
#
|
2992
|
+
# @option params [String] :version
|
2993
|
+
#
|
2959
2994
|
# @return [Types::DeleteSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2960
2995
|
#
|
2961
2996
|
# * {Types::DeleteSmsTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -2964,6 +2999,7 @@ module Aws::Pinpoint
|
|
2964
2999
|
#
|
2965
3000
|
# resp = client.delete_sms_template({
|
2966
3001
|
# template_name: "__string", # required
|
3002
|
+
# version: "__string",
|
2967
3003
|
# })
|
2968
3004
|
#
|
2969
3005
|
# @example Response structure
|
@@ -3080,11 +3116,13 @@ module Aws::Pinpoint
|
|
3080
3116
|
req.send_request(options)
|
3081
3117
|
end
|
3082
3118
|
|
3083
|
-
# Deletes a message template
|
3084
|
-
#
|
3119
|
+
# Deletes a message template for messages that were sent through the
|
3120
|
+
# voice channel.
|
3085
3121
|
#
|
3086
3122
|
# @option params [required, String] :template_name
|
3087
3123
|
#
|
3124
|
+
# @option params [String] :version
|
3125
|
+
#
|
3088
3126
|
# @return [Types::DeleteVoiceTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3089
3127
|
#
|
3090
3128
|
# * {Types::DeleteVoiceTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -3093,6 +3131,7 @@ module Aws::Pinpoint
|
|
3093
3131
|
#
|
3094
3132
|
# resp = client.delete_voice_template({
|
3095
3133
|
# template_name: "__string", # required
|
3134
|
+
# version: "__string",
|
3096
3135
|
# })
|
3097
3136
|
#
|
3098
3137
|
# @example Response structure
|
@@ -3426,7 +3465,8 @@ module Aws::Pinpoint
|
|
3426
3465
|
req.send_request(options)
|
3427
3466
|
end
|
3428
3467
|
|
3429
|
-
# Retrieves information about all
|
3468
|
+
# Retrieves information about all the applications that are associated
|
3469
|
+
# with your Amazon Pinpoint account.
|
3430
3470
|
#
|
3431
3471
|
# @option params [String] :page_size
|
3432
3472
|
#
|
@@ -3610,9 +3650,13 @@ module Aws::Pinpoint
|
|
3610
3650
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
3611
3651
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3612
3652
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
3653
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
|
3613
3654
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
3655
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
|
3614
3656
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
3657
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
|
3615
3658
|
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
3659
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
|
3616
3660
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
3617
3661
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
3618
3662
|
# resp.campaign_response.application_id #=> String
|
@@ -3723,9 +3767,13 @@ module Aws::Pinpoint
|
|
3723
3767
|
# resp.campaign_response.tags #=> Hash
|
3724
3768
|
# resp.campaign_response.tags["__string"] #=> String
|
3725
3769
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
3770
|
+
# resp.campaign_response.template_configuration.email_template.version #=> String
|
3726
3771
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
3772
|
+
# resp.campaign_response.template_configuration.push_template.version #=> String
|
3727
3773
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
3774
|
+
# resp.campaign_response.template_configuration.sms_template.version #=> String
|
3728
3775
|
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
3776
|
+
# resp.campaign_response.template_configuration.voice_template.version #=> String
|
3729
3777
|
# resp.campaign_response.treatment_description #=> String
|
3730
3778
|
# resp.campaign_response.treatment_name #=> String
|
3731
3779
|
# resp.campaign_response.version #=> Integer
|
@@ -3962,9 +4010,13 @@ module Aws::Pinpoint
|
|
3962
4010
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
3963
4011
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3964
4012
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
4013
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
|
3965
4014
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
4015
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
|
3966
4016
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
4017
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
|
3967
4018
|
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
4019
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
|
3968
4020
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
3969
4021
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
3970
4022
|
# resp.campaign_response.application_id #=> String
|
@@ -4075,9 +4127,13 @@ module Aws::Pinpoint
|
|
4075
4127
|
# resp.campaign_response.tags #=> Hash
|
4076
4128
|
# resp.campaign_response.tags["__string"] #=> String
|
4077
4129
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
4130
|
+
# resp.campaign_response.template_configuration.email_template.version #=> String
|
4078
4131
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
4132
|
+
# resp.campaign_response.template_configuration.push_template.version #=> String
|
4079
4133
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
4134
|
+
# resp.campaign_response.template_configuration.sms_template.version #=> String
|
4080
4135
|
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
4136
|
+
# resp.campaign_response.template_configuration.voice_template.version #=> String
|
4081
4137
|
# resp.campaign_response.treatment_description #=> String
|
4082
4138
|
# resp.campaign_response.treatment_name #=> String
|
4083
4139
|
# resp.campaign_response.version #=> Integer
|
@@ -4208,9 +4264,13 @@ module Aws::Pinpoint
|
|
4208
4264
|
# resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
|
4209
4265
|
# resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
4210
4266
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
|
4267
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.version #=> String
|
4211
4268
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
|
4269
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.version #=> String
|
4212
4270
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
|
4271
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.version #=> String
|
4213
4272
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.name #=> String
|
4273
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.version #=> String
|
4214
4274
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
|
4215
4275
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
|
4216
4276
|
# resp.campaigns_response.item[0].application_id #=> String
|
@@ -4321,9 +4381,13 @@ module Aws::Pinpoint
|
|
4321
4381
|
# resp.campaigns_response.item[0].tags #=> Hash
|
4322
4382
|
# resp.campaigns_response.item[0].tags["__string"] #=> String
|
4323
4383
|
# resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
|
4384
|
+
# resp.campaigns_response.item[0].template_configuration.email_template.version #=> String
|
4324
4385
|
# resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
|
4386
|
+
# resp.campaigns_response.item[0].template_configuration.push_template.version #=> String
|
4325
4387
|
# resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
|
4388
|
+
# resp.campaigns_response.item[0].template_configuration.sms_template.version #=> String
|
4326
4389
|
# resp.campaigns_response.item[0].template_configuration.voice_template.name #=> String
|
4390
|
+
# resp.campaigns_response.item[0].template_configuration.voice_template.version #=> String
|
4327
4391
|
# resp.campaigns_response.item[0].treatment_description #=> String
|
4328
4392
|
# resp.campaigns_response.item[0].treatment_name #=> String
|
4329
4393
|
# resp.campaigns_response.item[0].version #=> Integer
|
@@ -4453,9 +4517,13 @@ module Aws::Pinpoint
|
|
4453
4517
|
# resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
|
4454
4518
|
# resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
4455
4519
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
|
4520
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.version #=> String
|
4456
4521
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
|
4522
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.version #=> String
|
4457
4523
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
|
4524
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.version #=> String
|
4458
4525
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.name #=> String
|
4526
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.version #=> String
|
4459
4527
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
|
4460
4528
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
|
4461
4529
|
# resp.campaigns_response.item[0].application_id #=> String
|
@@ -4566,9 +4634,13 @@ module Aws::Pinpoint
|
|
4566
4634
|
# resp.campaigns_response.item[0].tags #=> Hash
|
4567
4635
|
# resp.campaigns_response.item[0].tags["__string"] #=> String
|
4568
4636
|
# resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
|
4637
|
+
# resp.campaigns_response.item[0].template_configuration.email_template.version #=> String
|
4569
4638
|
# resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
|
4639
|
+
# resp.campaigns_response.item[0].template_configuration.push_template.version #=> String
|
4570
4640
|
# resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
|
4641
|
+
# resp.campaigns_response.item[0].template_configuration.sms_template.version #=> String
|
4571
4642
|
# resp.campaigns_response.item[0].template_configuration.voice_template.name #=> String
|
4643
|
+
# resp.campaigns_response.item[0].template_configuration.voice_template.version #=> String
|
4572
4644
|
# resp.campaigns_response.item[0].treatment_description #=> String
|
4573
4645
|
# resp.campaigns_response.item[0].treatment_name #=> String
|
4574
4646
|
# resp.campaigns_response.item[0].version #=> Integer
|
@@ -4662,11 +4734,13 @@ module Aws::Pinpoint
|
|
4662
4734
|
req.send_request(options)
|
4663
4735
|
end
|
4664
4736
|
|
4665
|
-
# Retrieves the content and settings
|
4666
|
-
#
|
4737
|
+
# Retrieves the content and settings of a message template for messages
|
4738
|
+
# that are sent through the email channel.
|
4667
4739
|
#
|
4668
4740
|
# @option params [required, String] :template_name
|
4669
4741
|
#
|
4742
|
+
# @option params [String] :version
|
4743
|
+
#
|
4670
4744
|
# @return [Types::GetEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4671
4745
|
#
|
4672
4746
|
# * {Types::GetEmailTemplateResponse#email_template_response #email_template_response} => Types::EmailTemplateResponse
|
@@ -4675,6 +4749,7 @@ module Aws::Pinpoint
|
|
4675
4749
|
#
|
4676
4750
|
# resp = client.get_email_template({
|
4677
4751
|
# template_name: "__string", # required
|
4752
|
+
# version: "__string",
|
4678
4753
|
# })
|
4679
4754
|
#
|
4680
4755
|
# @example Response structure
|
@@ -4691,6 +4766,7 @@ module Aws::Pinpoint
|
|
4691
4766
|
# resp.email_template_response.template_name #=> String
|
4692
4767
|
# resp.email_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
4693
4768
|
# resp.email_template_response.text_part #=> String
|
4769
|
+
# resp.email_template_response.version #=> String
|
4694
4770
|
#
|
4695
4771
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailTemplate AWS API Documentation
|
4696
4772
|
#
|
@@ -5121,6 +5197,7 @@ module Aws::Pinpoint
|
|
5121
5197
|
# resp.journey_response.activities["__string"].email.message_config.from_address #=> String
|
5122
5198
|
# resp.journey_response.activities["__string"].email.next_activity #=> String
|
5123
5199
|
# resp.journey_response.activities["__string"].email.template_name #=> String
|
5200
|
+
# resp.journey_response.activities["__string"].email.template_version #=> String
|
5124
5201
|
# resp.journey_response.activities["__string"].holdout.next_activity #=> String
|
5125
5202
|
# resp.journey_response.activities["__string"].holdout.percentage #=> Integer
|
5126
5203
|
# resp.journey_response.activities["__string"].multi_condition.branches #=> Array
|
@@ -5361,11 +5438,13 @@ module Aws::Pinpoint
|
|
5361
5438
|
req.send_request(options)
|
5362
5439
|
end
|
5363
5440
|
|
5364
|
-
# Retrieves the content and settings
|
5365
|
-
#
|
5441
|
+
# Retrieves the content and settings of a message template for messages
|
5442
|
+
# that are sent through a push notification channel.
|
5366
5443
|
#
|
5367
5444
|
# @option params [required, String] :template_name
|
5368
5445
|
#
|
5446
|
+
# @option params [String] :version
|
5447
|
+
#
|
5369
5448
|
# @return [Types::GetPushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5370
5449
|
#
|
5371
5450
|
# * {Types::GetPushTemplateResponse#push_notification_template_response #push_notification_template_response} => Types::PushNotificationTemplateResponse
|
@@ -5374,6 +5453,7 @@ module Aws::Pinpoint
|
|
5374
5453
|
#
|
5375
5454
|
# resp = client.get_push_template({
|
5376
5455
|
# template_name: "__string", # required
|
5456
|
+
# version: "__string",
|
5377
5457
|
# })
|
5378
5458
|
#
|
5379
5459
|
# @example Response structure
|
@@ -5426,6 +5506,7 @@ module Aws::Pinpoint
|
|
5426
5506
|
# resp.push_notification_template_response.template_description #=> String
|
5427
5507
|
# resp.push_notification_template_response.template_name #=> String
|
5428
5508
|
# resp.push_notification_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
5509
|
+
# resp.push_notification_template_response.version #=> String
|
5429
5510
|
#
|
5430
5511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplate AWS API Documentation
|
5431
5512
|
#
|
@@ -5814,7 +5895,7 @@ module Aws::Pinpoint
|
|
5814
5895
|
end
|
5815
5896
|
|
5816
5897
|
# Retrieves information about the configuration, dimension, and other
|
5817
|
-
# settings for all versions of a specific segment that's associated
|
5898
|
+
# settings for all the versions of a specific segment that's associated
|
5818
5899
|
# with an application.
|
5819
5900
|
#
|
5820
5901
|
# @option params [required, String] :application_id
|
@@ -6126,11 +6207,13 @@ module Aws::Pinpoint
|
|
6126
6207
|
req.send_request(options)
|
6127
6208
|
end
|
6128
6209
|
|
6129
|
-
# Retrieves the content and settings
|
6130
|
-
#
|
6210
|
+
# Retrieves the content and settings of a message template for messages
|
6211
|
+
# that are sent through the SMS channel.
|
6131
6212
|
#
|
6132
6213
|
# @option params [required, String] :template_name
|
6133
6214
|
#
|
6215
|
+
# @option params [String] :version
|
6216
|
+
#
|
6134
6217
|
# @return [Types::GetSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6135
6218
|
#
|
6136
6219
|
# * {Types::GetSmsTemplateResponse#sms_template_response #sms_template_response} => Types::SMSTemplateResponse
|
@@ -6139,6 +6222,7 @@ module Aws::Pinpoint
|
|
6139
6222
|
#
|
6140
6223
|
# resp = client.get_sms_template({
|
6141
6224
|
# template_name: "__string", # required
|
6225
|
+
# version: "__string",
|
6142
6226
|
# })
|
6143
6227
|
#
|
6144
6228
|
# @example Response structure
|
@@ -6153,6 +6237,7 @@ module Aws::Pinpoint
|
|
6153
6237
|
# resp.sms_template_response.template_description #=> String
|
6154
6238
|
# resp.sms_template_response.template_name #=> String
|
6155
6239
|
# resp.sms_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
6240
|
+
# resp.sms_template_response.version #=> String
|
6156
6241
|
#
|
6157
6242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsTemplate AWS API Documentation
|
6158
6243
|
#
|
@@ -6264,11 +6349,13 @@ module Aws::Pinpoint
|
|
6264
6349
|
req.send_request(options)
|
6265
6350
|
end
|
6266
6351
|
|
6267
|
-
# Retrieves the content and settings
|
6268
|
-
#
|
6352
|
+
# Retrieves the content and settings of a message template for messages
|
6353
|
+
# that are sent through the voice channel.
|
6269
6354
|
#
|
6270
6355
|
# @option params [required, String] :template_name
|
6271
6356
|
#
|
6357
|
+
# @option params [String] :version
|
6358
|
+
#
|
6272
6359
|
# @return [Types::GetVoiceTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6273
6360
|
#
|
6274
6361
|
# * {Types::GetVoiceTemplateResponse#voice_template_response #voice_template_response} => Types::VoiceTemplateResponse
|
@@ -6277,6 +6364,7 @@ module Aws::Pinpoint
|
|
6277
6364
|
#
|
6278
6365
|
# resp = client.get_voice_template({
|
6279
6366
|
# template_name: "__string", # required
|
6367
|
+
# version: "__string",
|
6280
6368
|
# })
|
6281
6369
|
#
|
6282
6370
|
# @example Response structure
|
@@ -6292,6 +6380,7 @@ module Aws::Pinpoint
|
|
6292
6380
|
# resp.voice_template_response.template_description #=> String
|
6293
6381
|
# resp.voice_template_response.template_name #=> String
|
6294
6382
|
# resp.voice_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
6383
|
+
# resp.voice_template_response.version #=> String
|
6295
6384
|
# resp.voice_template_response.voice_id #=> String
|
6296
6385
|
#
|
6297
6386
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetVoiceTemplate AWS API Documentation
|
@@ -6387,6 +6476,7 @@ module Aws::Pinpoint
|
|
6387
6476
|
# resp.journeys_response.item[0].activities["__string"].email.message_config.from_address #=> String
|
6388
6477
|
# resp.journeys_response.item[0].activities["__string"].email.next_activity #=> String
|
6389
6478
|
# resp.journeys_response.item[0].activities["__string"].email.template_name #=> String
|
6479
|
+
# resp.journeys_response.item[0].activities["__string"].email.template_version #=> String
|
6390
6480
|
# resp.journeys_response.item[0].activities["__string"].holdout.next_activity #=> String
|
6391
6481
|
# resp.journeys_response.item[0].activities["__string"].holdout.percentage #=> Integer
|
6392
6482
|
# resp.journeys_response.item[0].activities["__string"].multi_condition.branches #=> Array
|
@@ -6510,6 +6600,53 @@ module Aws::Pinpoint
|
|
6510
6600
|
req.send_request(options)
|
6511
6601
|
end
|
6512
6602
|
|
6603
|
+
# Retrieves information about all the versions of a specific message
|
6604
|
+
# template.
|
6605
|
+
#
|
6606
|
+
# @option params [String] :next_token
|
6607
|
+
#
|
6608
|
+
# @option params [String] :page_size
|
6609
|
+
#
|
6610
|
+
# @option params [required, String] :template_name
|
6611
|
+
#
|
6612
|
+
# @option params [required, String] :template_type
|
6613
|
+
#
|
6614
|
+
# @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6615
|
+
#
|
6616
|
+
# * {Types::ListTemplateVersionsResponse#template_versions_response #template_versions_response} => Types::TemplateVersionsResponse
|
6617
|
+
#
|
6618
|
+
# @example Request syntax with placeholder values
|
6619
|
+
#
|
6620
|
+
# resp = client.list_template_versions({
|
6621
|
+
# next_token: "__string",
|
6622
|
+
# page_size: "__string",
|
6623
|
+
# template_name: "__string", # required
|
6624
|
+
# template_type: "__string", # required
|
6625
|
+
# })
|
6626
|
+
#
|
6627
|
+
# @example Response structure
|
6628
|
+
#
|
6629
|
+
# resp.template_versions_response.item #=> Array
|
6630
|
+
# resp.template_versions_response.item[0].creation_date #=> String
|
6631
|
+
# resp.template_versions_response.item[0].default_substitutions #=> String
|
6632
|
+
# resp.template_versions_response.item[0].last_modified_date #=> String
|
6633
|
+
# resp.template_versions_response.item[0].template_description #=> String
|
6634
|
+
# resp.template_versions_response.item[0].template_name #=> String
|
6635
|
+
# resp.template_versions_response.item[0].template_type #=> String
|
6636
|
+
# resp.template_versions_response.item[0].version #=> String
|
6637
|
+
# resp.template_versions_response.message #=> String
|
6638
|
+
# resp.template_versions_response.next_token #=> String
|
6639
|
+
# resp.template_versions_response.request_id #=> String
|
6640
|
+
#
|
6641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplateVersions AWS API Documentation
|
6642
|
+
#
|
6643
|
+
# @overload list_template_versions(params = {})
|
6644
|
+
# @param [Hash] params ({})
|
6645
|
+
def list_template_versions(params = {}, options = {})
|
6646
|
+
req = build_request(:list_template_versions, params)
|
6647
|
+
req.send_request(options)
|
6648
|
+
end
|
6649
|
+
|
6513
6650
|
# Retrieves information about all the message templates that are
|
6514
6651
|
# associated with your Amazon Pinpoint account.
|
6515
6652
|
#
|
@@ -6546,6 +6683,7 @@ module Aws::Pinpoint
|
|
6546
6683
|
# resp.templates_response.item[0].template_description #=> String
|
6547
6684
|
# resp.templates_response.item[0].template_name #=> String
|
6548
6685
|
# resp.templates_response.item[0].template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
6686
|
+
# resp.templates_response.item[0].version #=> String
|
6549
6687
|
# resp.templates_response.next_token #=> String
|
6550
6688
|
#
|
6551
6689
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplates AWS API Documentation
|
@@ -6991,15 +7129,19 @@ module Aws::Pinpoint
|
|
6991
7129
|
# template_configuration: {
|
6992
7130
|
# email_template: {
|
6993
7131
|
# name: "__string",
|
7132
|
+
# version: "__string",
|
6994
7133
|
# },
|
6995
7134
|
# push_template: {
|
6996
7135
|
# name: "__string",
|
7136
|
+
# version: "__string",
|
6997
7137
|
# },
|
6998
7138
|
# sms_template: {
|
6999
7139
|
# name: "__string",
|
7140
|
+
# version: "__string",
|
7000
7141
|
# },
|
7001
7142
|
# voice_template: {
|
7002
7143
|
# name: "__string",
|
7144
|
+
# version: "__string",
|
7003
7145
|
# },
|
7004
7146
|
# },
|
7005
7147
|
# trace_id: "__string",
|
@@ -7211,15 +7353,19 @@ module Aws::Pinpoint
|
|
7211
7353
|
# template_configuration: {
|
7212
7354
|
# email_template: {
|
7213
7355
|
# name: "__string",
|
7356
|
+
# version: "__string",
|
7214
7357
|
# },
|
7215
7358
|
# push_template: {
|
7216
7359
|
# name: "__string",
|
7360
|
+
# version: "__string",
|
7217
7361
|
# },
|
7218
7362
|
# sms_template: {
|
7219
7363
|
# name: "__string",
|
7364
|
+
# version: "__string",
|
7220
7365
|
# },
|
7221
7366
|
# voice_template: {
|
7222
7367
|
# name: "__string",
|
7368
|
+
# version: "__string",
|
7223
7369
|
# },
|
7224
7370
|
# },
|
7225
7371
|
# trace_id: "__string",
|
@@ -7821,15 +7967,19 @@ module Aws::Pinpoint
|
|
7821
7967
|
# template_configuration: {
|
7822
7968
|
# email_template: {
|
7823
7969
|
# name: "__string",
|
7970
|
+
# version: "__string",
|
7824
7971
|
# },
|
7825
7972
|
# push_template: {
|
7826
7973
|
# name: "__string",
|
7974
|
+
# version: "__string",
|
7827
7975
|
# },
|
7828
7976
|
# sms_template: {
|
7829
7977
|
# name: "__string",
|
7978
|
+
# version: "__string",
|
7830
7979
|
# },
|
7831
7980
|
# voice_template: {
|
7832
7981
|
# name: "__string",
|
7982
|
+
# version: "__string",
|
7833
7983
|
# },
|
7834
7984
|
# },
|
7835
7985
|
# treatment_description: "__string",
|
@@ -7974,15 +8124,19 @@ module Aws::Pinpoint
|
|
7974
8124
|
# template_configuration: {
|
7975
8125
|
# email_template: {
|
7976
8126
|
# name: "__string",
|
8127
|
+
# version: "__string",
|
7977
8128
|
# },
|
7978
8129
|
# push_template: {
|
7979
8130
|
# name: "__string",
|
8131
|
+
# version: "__string",
|
7980
8132
|
# },
|
7981
8133
|
# sms_template: {
|
7982
8134
|
# name: "__string",
|
8135
|
+
# version: "__string",
|
7983
8136
|
# },
|
7984
8137
|
# voice_template: {
|
7985
8138
|
# name: "__string",
|
8139
|
+
# version: "__string",
|
7986
8140
|
# },
|
7987
8141
|
# },
|
7988
8142
|
# treatment_description: "__string",
|
@@ -8082,9 +8236,13 @@ module Aws::Pinpoint
|
|
8082
8236
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
8083
8237
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
8084
8238
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
8239
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
|
8085
8240
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
8241
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
|
8086
8242
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
8243
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
|
8087
8244
|
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
8245
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
|
8088
8246
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
8089
8247
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
8090
8248
|
# resp.campaign_response.application_id #=> String
|
@@ -8195,9 +8353,13 @@ module Aws::Pinpoint
|
|
8195
8353
|
# resp.campaign_response.tags #=> Hash
|
8196
8354
|
# resp.campaign_response.tags["__string"] #=> String
|
8197
8355
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
8356
|
+
# resp.campaign_response.template_configuration.email_template.version #=> String
|
8198
8357
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
8358
|
+
# resp.campaign_response.template_configuration.push_template.version #=> String
|
8199
8359
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
8360
|
+
# resp.campaign_response.template_configuration.sms_template.version #=> String
|
8200
8361
|
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
8362
|
+
# resp.campaign_response.template_configuration.voice_template.version #=> String
|
8201
8363
|
# resp.campaign_response.treatment_description #=> String
|
8202
8364
|
# resp.campaign_response.treatment_name #=> String
|
8203
8365
|
# resp.campaign_response.version #=> Integer
|
@@ -8264,8 +8426,10 @@ module Aws::Pinpoint
|
|
8264
8426
|
req.send_request(options)
|
8265
8427
|
end
|
8266
8428
|
|
8267
|
-
# Updates an existing message template
|
8268
|
-
#
|
8429
|
+
# Updates an existing message template for messages that are sent
|
8430
|
+
# through the email channel.
|
8431
|
+
#
|
8432
|
+
# @option params [Boolean] :create_new_version
|
8269
8433
|
#
|
8270
8434
|
# @option params [required, Types::EmailTemplateRequest] :email_template_request
|
8271
8435
|
# Specifies the content and settings for a message template that can be
|
@@ -8273,6 +8437,8 @@ module Aws::Pinpoint
|
|
8273
8437
|
#
|
8274
8438
|
# @option params [required, String] :template_name
|
8275
8439
|
#
|
8440
|
+
# @option params [String] :version
|
8441
|
+
#
|
8276
8442
|
# @return [Types::UpdateEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8277
8443
|
#
|
8278
8444
|
# * {Types::UpdateEmailTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -8280,6 +8446,7 @@ module Aws::Pinpoint
|
|
8280
8446
|
# @example Request syntax with placeholder values
|
8281
8447
|
#
|
8282
8448
|
# resp = client.update_email_template({
|
8449
|
+
# create_new_version: false,
|
8283
8450
|
# email_template_request: { # required
|
8284
8451
|
# default_substitutions: "__string",
|
8285
8452
|
# html_part: "__string",
|
@@ -8291,6 +8458,7 @@ module Aws::Pinpoint
|
|
8291
8458
|
# text_part: "__string",
|
8292
8459
|
# },
|
8293
8460
|
# template_name: "__string", # required
|
8461
|
+
# version: "__string",
|
8294
8462
|
# })
|
8295
8463
|
#
|
8296
8464
|
# @example Response structure
|
@@ -8641,6 +8809,7 @@ module Aws::Pinpoint
|
|
8641
8809
|
# },
|
8642
8810
|
# next_activity: "__string",
|
8643
8811
|
# template_name: "__string",
|
8812
|
+
# template_version: "__string",
|
8644
8813
|
# },
|
8645
8814
|
# holdout: {
|
8646
8815
|
# next_activity: "__string",
|
@@ -8858,6 +9027,7 @@ module Aws::Pinpoint
|
|
8858
9027
|
# resp.journey_response.activities["__string"].email.message_config.from_address #=> String
|
8859
9028
|
# resp.journey_response.activities["__string"].email.next_activity #=> String
|
8860
9029
|
# resp.journey_response.activities["__string"].email.template_name #=> String
|
9030
|
+
# resp.journey_response.activities["__string"].email.template_version #=> String
|
8861
9031
|
# resp.journey_response.activities["__string"].holdout.next_activity #=> String
|
8862
9032
|
# resp.journey_response.activities["__string"].holdout.percentage #=> Integer
|
8863
9033
|
# resp.journey_response.activities["__string"].multi_condition.branches #=> Array
|
@@ -8951,7 +9121,7 @@ module Aws::Pinpoint
|
|
8951
9121
|
req.send_request(options)
|
8952
9122
|
end
|
8953
9123
|
|
8954
|
-
# Cancels an active journey.
|
9124
|
+
# Cancels (stops) an active journey.
|
8955
9125
|
#
|
8956
9126
|
# @option params [required, String] :application_id
|
8957
9127
|
#
|
@@ -9036,6 +9206,7 @@ module Aws::Pinpoint
|
|
9036
9206
|
# resp.journey_response.activities["__string"].email.message_config.from_address #=> String
|
9037
9207
|
# resp.journey_response.activities["__string"].email.next_activity #=> String
|
9038
9208
|
# resp.journey_response.activities["__string"].email.template_name #=> String
|
9209
|
+
# resp.journey_response.activities["__string"].email.template_version #=> String
|
9039
9210
|
# resp.journey_response.activities["__string"].holdout.next_activity #=> String
|
9040
9211
|
# resp.journey_response.activities["__string"].holdout.percentage #=> Integer
|
9041
9212
|
# resp.journey_response.activities["__string"].multi_condition.branches #=> Array
|
@@ -9129,8 +9300,10 @@ module Aws::Pinpoint
|
|
9129
9300
|
req.send_request(options)
|
9130
9301
|
end
|
9131
9302
|
|
9132
|
-
# Updates an existing message template
|
9133
|
-
#
|
9303
|
+
# Updates an existing message template for messages that are sent
|
9304
|
+
# through a push notification channel.
|
9305
|
+
#
|
9306
|
+
# @option params [Boolean] :create_new_version
|
9134
9307
|
#
|
9135
9308
|
# @option params [required, Types::PushNotificationTemplateRequest] :push_notification_template_request
|
9136
9309
|
# Specifies the content and settings for a message template that can be
|
@@ -9138,6 +9311,8 @@ module Aws::Pinpoint
|
|
9138
9311
|
#
|
9139
9312
|
# @option params [required, String] :template_name
|
9140
9313
|
#
|
9314
|
+
# @option params [String] :version
|
9315
|
+
#
|
9141
9316
|
# @return [Types::UpdatePushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9142
9317
|
#
|
9143
9318
|
# * {Types::UpdatePushTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -9145,6 +9320,7 @@ module Aws::Pinpoint
|
|
9145
9320
|
# @example Request syntax with placeholder values
|
9146
9321
|
#
|
9147
9322
|
# resp = client.update_push_template({
|
9323
|
+
# create_new_version: false,
|
9148
9324
|
# push_notification_template_request: { # required
|
9149
9325
|
# adm: {
|
9150
9326
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -9202,6 +9378,7 @@ module Aws::Pinpoint
|
|
9202
9378
|
# template_description: "__string",
|
9203
9379
|
# },
|
9204
9380
|
# template_name: "__string", # required
|
9381
|
+
# version: "__string",
|
9205
9382
|
# })
|
9206
9383
|
#
|
9207
9384
|
# @example Response structure
|
@@ -9556,8 +9733,10 @@ module Aws::Pinpoint
|
|
9556
9733
|
req.send_request(options)
|
9557
9734
|
end
|
9558
9735
|
|
9559
|
-
# Updates an existing message template
|
9560
|
-
#
|
9736
|
+
# Updates an existing message template for messages that are sent
|
9737
|
+
# through the SMS channel.
|
9738
|
+
#
|
9739
|
+
# @option params [Boolean] :create_new_version
|
9561
9740
|
#
|
9562
9741
|
# @option params [required, Types::SMSTemplateRequest] :sms_template_request
|
9563
9742
|
# Specifies the content and settings for a message template that can be
|
@@ -9565,6 +9744,8 @@ module Aws::Pinpoint
|
|
9565
9744
|
#
|
9566
9745
|
# @option params [required, String] :template_name
|
9567
9746
|
#
|
9747
|
+
# @option params [String] :version
|
9748
|
+
#
|
9568
9749
|
# @return [Types::UpdateSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9569
9750
|
#
|
9570
9751
|
# * {Types::UpdateSmsTemplateResponse#message_body #message_body} => Types::MessageBody
|
@@ -9572,6 +9753,7 @@ module Aws::Pinpoint
|
|
9572
9753
|
# @example Request syntax with placeholder values
|
9573
9754
|
#
|
9574
9755
|
# resp = client.update_sms_template({
|
9756
|
+
# create_new_version: false,
|
9575
9757
|
# sms_template_request: { # required
|
9576
9758
|
# body: "__string",
|
9577
9759
|
# default_substitutions: "__string",
|
@@ -9581,6 +9763,7 @@ module Aws::Pinpoint
|
|
9581
9763
|
# template_description: "__string",
|
9582
9764
|
# },
|
9583
9765
|
# template_name: "__string", # required
|
9766
|
+
# version: "__string",
|
9584
9767
|
# })
|
9585
9768
|
#
|
9586
9769
|
# @example Response structure
|
@@ -9597,6 +9780,45 @@ module Aws::Pinpoint
|
|
9597
9780
|
req.send_request(options)
|
9598
9781
|
end
|
9599
9782
|
|
9783
|
+
# Changes the status of a specific version of a message template to
|
9784
|
+
# *active*.
|
9785
|
+
#
|
9786
|
+
# @option params [required, Types::TemplateActiveVersionRequest] :template_active_version_request
|
9787
|
+
# Specifies which version of a message template to use as the active
|
9788
|
+
# version of the template.
|
9789
|
+
#
|
9790
|
+
# @option params [required, String] :template_name
|
9791
|
+
#
|
9792
|
+
# @option params [required, String] :template_type
|
9793
|
+
#
|
9794
|
+
# @return [Types::UpdateTemplateActiveVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9795
|
+
#
|
9796
|
+
# * {Types::UpdateTemplateActiveVersionResponse#message_body #message_body} => Types::MessageBody
|
9797
|
+
#
|
9798
|
+
# @example Request syntax with placeholder values
|
9799
|
+
#
|
9800
|
+
# resp = client.update_template_active_version({
|
9801
|
+
# template_active_version_request: { # required
|
9802
|
+
# version: "__string",
|
9803
|
+
# },
|
9804
|
+
# template_name: "__string", # required
|
9805
|
+
# template_type: "__string", # required
|
9806
|
+
# })
|
9807
|
+
#
|
9808
|
+
# @example Response structure
|
9809
|
+
#
|
9810
|
+
# resp.message_body.message #=> String
|
9811
|
+
# resp.message_body.request_id #=> String
|
9812
|
+
#
|
9813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateTemplateActiveVersion AWS API Documentation
|
9814
|
+
#
|
9815
|
+
# @overload update_template_active_version(params = {})
|
9816
|
+
# @param [Hash] params ({})
|
9817
|
+
def update_template_active_version(params = {}, options = {})
|
9818
|
+
req = build_request(:update_template_active_version, params)
|
9819
|
+
req.send_request(options)
|
9820
|
+
end
|
9821
|
+
|
9600
9822
|
# Enables the voice channel for an application or updates the status and
|
9601
9823
|
# settings of the voice channel for an application.
|
9602
9824
|
#
|
@@ -9641,11 +9863,15 @@ module Aws::Pinpoint
|
|
9641
9863
|
req.send_request(options)
|
9642
9864
|
end
|
9643
9865
|
|
9644
|
-
# Updates an existing message template
|
9645
|
-
#
|
9866
|
+
# Updates an existing message template for messages that are sent
|
9867
|
+
# through the voice channel.
|
9868
|
+
#
|
9869
|
+
# @option params [Boolean] :create_new_version
|
9646
9870
|
#
|
9647
9871
|
# @option params [required, String] :template_name
|
9648
9872
|
#
|
9873
|
+
# @option params [String] :version
|
9874
|
+
#
|
9649
9875
|
# @option params [required, Types::VoiceTemplateRequest] :voice_template_request
|
9650
9876
|
# Specifies the content and settings for a message template that can be
|
9651
9877
|
# used in messages that are sent through the voice channel.
|
@@ -9657,7 +9883,9 @@ module Aws::Pinpoint
|
|
9657
9883
|
# @example Request syntax with placeholder values
|
9658
9884
|
#
|
9659
9885
|
# resp = client.update_voice_template({
|
9886
|
+
# create_new_version: false,
|
9660
9887
|
# template_name: "__string", # required
|
9888
|
+
# version: "__string",
|
9661
9889
|
# voice_template_request: { # required
|
9662
9890
|
# body: "__string",
|
9663
9891
|
# default_substitutions: "__string",
|
@@ -9697,7 +9925,7 @@ module Aws::Pinpoint
|
|
9697
9925
|
params: params,
|
9698
9926
|
config: config)
|
9699
9927
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
9700
|
-
context[:gem_version] = '1.
|
9928
|
+
context[:gem_version] = '1.32.0'
|
9701
9929
|
Seahorse::Client::Request.new(handlers, context)
|
9702
9930
|
end
|
9703
9931
|
|