aws-sdk-pinpoint 1.27.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +740 -22
- data/lib/aws-sdk-pinpoint/client_api.rb +454 -0
- data/lib/aws-sdk-pinpoint/types.rb +1622 -78
- 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: 29a859d4f78744be10e956a678911e60cb1fd074
|
4
|
+
data.tar.gz: d231cea5ae4f481dece65f9b50a2f07d4dff15df
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b1a32d682260b3d3e19ba7f6840db02590d1052240f6dff77dad394fdd4d5911e942bf16c71f5d5ac91e8b14b7a8c3e972eda891e1c0df586327f47e6556fbf5
|
7
|
+
data.tar.gz: b60af69eb5a3569b2b3e93e65972ccf80c2bb737edc97718312871b4dcc1eb7b668b598d6f9d1dc566cb62e4543f4a882d195dd88e0649567aaa0cab9aa9da5a
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -427,6 +427,17 @@ module Aws::Pinpoint
|
|
427
427
|
# timezone: "__string",
|
428
428
|
# },
|
429
429
|
# size_percent: 1, # required
|
430
|
+
# template_configuration: {
|
431
|
+
# email_template: {
|
432
|
+
# name: "__string",
|
433
|
+
# },
|
434
|
+
# push_template: {
|
435
|
+
# name: "__string",
|
436
|
+
# },
|
437
|
+
# sms_template: {
|
438
|
+
# name: "__string",
|
439
|
+
# },
|
440
|
+
# },
|
430
441
|
# treatment_description: "__string",
|
431
442
|
# treatment_name: "__string",
|
432
443
|
# },
|
@@ -566,6 +577,17 @@ module Aws::Pinpoint
|
|
566
577
|
# tags: {
|
567
578
|
# "__string" => "__string",
|
568
579
|
# },
|
580
|
+
# template_configuration: {
|
581
|
+
# email_template: {
|
582
|
+
# name: "__string",
|
583
|
+
# },
|
584
|
+
# push_template: {
|
585
|
+
# name: "__string",
|
586
|
+
# },
|
587
|
+
# sms_template: {
|
588
|
+
# name: "__string",
|
589
|
+
# },
|
590
|
+
# },
|
569
591
|
# treatment_description: "__string",
|
570
592
|
# treatment_name: "__string",
|
571
593
|
# },
|
@@ -662,6 +684,9 @@ module Aws::Pinpoint
|
|
662
684
|
# resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
|
663
685
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
664
686
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
687
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
688
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
689
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
665
690
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
666
691
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
667
692
|
# resp.campaign_response.application_id #=> String
|
@@ -771,6 +796,9 @@ module Aws::Pinpoint
|
|
771
796
|
# resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
772
797
|
# resp.campaign_response.tags #=> Hash
|
773
798
|
# resp.campaign_response.tags["__string"] #=> String
|
799
|
+
# resp.campaign_response.template_configuration.email_template.name #=> String
|
800
|
+
# resp.campaign_response.template_configuration.push_template.name #=> String
|
801
|
+
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
774
802
|
# resp.campaign_response.treatment_description #=> String
|
775
803
|
# resp.campaign_response.treatment_name #=> String
|
776
804
|
# resp.campaign_response.version #=> Integer
|
@@ -784,7 +812,49 @@ module Aws::Pinpoint
|
|
784
812
|
req.send_request(options)
|
785
813
|
end
|
786
814
|
|
787
|
-
# Creates a
|
815
|
+
# Creates a message template that you can use in messages that are sent
|
816
|
+
# through the email channel.
|
817
|
+
#
|
818
|
+
# @option params [required, Types::EmailTemplateRequest] :email_template_request
|
819
|
+
# Specifies the content and settings for a message template that can be
|
820
|
+
# used in messages that are sent through the email channel.
|
821
|
+
#
|
822
|
+
# @option params [required, String] :template_name
|
823
|
+
#
|
824
|
+
# @return [Types::CreateEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
825
|
+
#
|
826
|
+
# * {Types::CreateEmailTemplateResponse#create_template_message_body #create_template_message_body} => Types::CreateTemplateMessageBody
|
827
|
+
#
|
828
|
+
# @example Request syntax with placeholder values
|
829
|
+
#
|
830
|
+
# resp = client.create_email_template({
|
831
|
+
# email_template_request: { # required
|
832
|
+
# html_part: "__string",
|
833
|
+
# subject: "__string",
|
834
|
+
# tags: {
|
835
|
+
# "__string" => "__string",
|
836
|
+
# },
|
837
|
+
# text_part: "__string",
|
838
|
+
# },
|
839
|
+
# template_name: "__string", # required
|
840
|
+
# })
|
841
|
+
#
|
842
|
+
# @example Response structure
|
843
|
+
#
|
844
|
+
# resp.create_template_message_body.arn #=> String
|
845
|
+
# resp.create_template_message_body.message #=> String
|
846
|
+
# resp.create_template_message_body.request_id #=> String
|
847
|
+
#
|
848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateEmailTemplate AWS API Documentation
|
849
|
+
#
|
850
|
+
# @overload create_email_template(params = {})
|
851
|
+
# @param [Hash] params ({})
|
852
|
+
def create_email_template(params = {}, options = {})
|
853
|
+
req = build_request(:create_email_template, params)
|
854
|
+
req.send_request(options)
|
855
|
+
end
|
856
|
+
|
857
|
+
# Creates an export job for an application.
|
788
858
|
#
|
789
859
|
# @option params [required, String] :application_id
|
790
860
|
#
|
@@ -837,7 +907,7 @@ module Aws::Pinpoint
|
|
837
907
|
req.send_request(options)
|
838
908
|
end
|
839
909
|
|
840
|
-
# Creates
|
910
|
+
# Creates an import job for an application.
|
841
911
|
#
|
842
912
|
# @option params [required, String] :application_id
|
843
913
|
#
|
@@ -898,6 +968,90 @@ module Aws::Pinpoint
|
|
898
968
|
req.send_request(options)
|
899
969
|
end
|
900
970
|
|
971
|
+
# Creates a message template that you can use in messages that are sent
|
972
|
+
# through a push notification channel.
|
973
|
+
#
|
974
|
+
# @option params [required, Types::PushNotificationTemplateRequest] :push_notification_template_request
|
975
|
+
# Specifies the content and settings for a message template that can be
|
976
|
+
# used in messages that are sent through a push notification channel.
|
977
|
+
#
|
978
|
+
# @option params [required, String] :template_name
|
979
|
+
#
|
980
|
+
# @return [Types::CreatePushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
981
|
+
#
|
982
|
+
# * {Types::CreatePushTemplateResponse#create_template_message_body #create_template_message_body} => Types::CreateTemplateMessageBody
|
983
|
+
#
|
984
|
+
# @example Request syntax with placeholder values
|
985
|
+
#
|
986
|
+
# resp = client.create_push_template({
|
987
|
+
# push_notification_template_request: { # required
|
988
|
+
# adm: {
|
989
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
990
|
+
# body: "__string",
|
991
|
+
# image_icon_url: "__string",
|
992
|
+
# image_url: "__string",
|
993
|
+
# small_image_icon_url: "__string",
|
994
|
+
# sound: "__string",
|
995
|
+
# title: "__string",
|
996
|
+
# url: "__string",
|
997
|
+
# },
|
998
|
+
# apns: {
|
999
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1000
|
+
# body: "__string",
|
1001
|
+
# media_url: "__string",
|
1002
|
+
# sound: "__string",
|
1003
|
+
# title: "__string",
|
1004
|
+
# url: "__string",
|
1005
|
+
# },
|
1006
|
+
# baidu: {
|
1007
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1008
|
+
# body: "__string",
|
1009
|
+
# image_icon_url: "__string",
|
1010
|
+
# image_url: "__string",
|
1011
|
+
# small_image_icon_url: "__string",
|
1012
|
+
# sound: "__string",
|
1013
|
+
# title: "__string",
|
1014
|
+
# url: "__string",
|
1015
|
+
# },
|
1016
|
+
# default: {
|
1017
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1018
|
+
# body: "__string",
|
1019
|
+
# sound: "__string",
|
1020
|
+
# title: "__string",
|
1021
|
+
# url: "__string",
|
1022
|
+
# },
|
1023
|
+
# gcm: {
|
1024
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1025
|
+
# body: "__string",
|
1026
|
+
# image_icon_url: "__string",
|
1027
|
+
# image_url: "__string",
|
1028
|
+
# small_image_icon_url: "__string",
|
1029
|
+
# sound: "__string",
|
1030
|
+
# title: "__string",
|
1031
|
+
# url: "__string",
|
1032
|
+
# },
|
1033
|
+
# tags: {
|
1034
|
+
# "__string" => "__string",
|
1035
|
+
# },
|
1036
|
+
# },
|
1037
|
+
# template_name: "__string", # required
|
1038
|
+
# })
|
1039
|
+
#
|
1040
|
+
# @example Response structure
|
1041
|
+
#
|
1042
|
+
# resp.create_template_message_body.arn #=> String
|
1043
|
+
# resp.create_template_message_body.message #=> String
|
1044
|
+
# resp.create_template_message_body.request_id #=> String
|
1045
|
+
#
|
1046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreatePushTemplate AWS API Documentation
|
1047
|
+
#
|
1048
|
+
# @overload create_push_template(params = {})
|
1049
|
+
# @param [Hash] params ({})
|
1050
|
+
def create_push_template(params = {}, options = {})
|
1051
|
+
req = build_request(:create_push_template, params)
|
1052
|
+
req.send_request(options)
|
1053
|
+
end
|
1054
|
+
|
901
1055
|
# Creates a new segment for an application or updates the configuration,
|
902
1056
|
# dimension, and other settings for an existing segment that's
|
903
1057
|
# associated with an application.
|
@@ -1183,6 +1337,46 @@ module Aws::Pinpoint
|
|
1183
1337
|
req.send_request(options)
|
1184
1338
|
end
|
1185
1339
|
|
1340
|
+
# Creates a message template that you can use in messages that are sent
|
1341
|
+
# through the SMS channel.
|
1342
|
+
#
|
1343
|
+
# @option params [required, Types::SMSTemplateRequest] :sms_template_request
|
1344
|
+
# Specifies the content and settings for a message template that can be
|
1345
|
+
# used in text messages that are sent through the SMS channel.
|
1346
|
+
#
|
1347
|
+
# @option params [required, String] :template_name
|
1348
|
+
#
|
1349
|
+
# @return [Types::CreateSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1350
|
+
#
|
1351
|
+
# * {Types::CreateSmsTemplateResponse#create_template_message_body #create_template_message_body} => Types::CreateTemplateMessageBody
|
1352
|
+
#
|
1353
|
+
# @example Request syntax with placeholder values
|
1354
|
+
#
|
1355
|
+
# resp = client.create_sms_template({
|
1356
|
+
# sms_template_request: { # required
|
1357
|
+
# body: "__string",
|
1358
|
+
# tags: {
|
1359
|
+
# "__string" => "__string",
|
1360
|
+
# },
|
1361
|
+
# },
|
1362
|
+
# template_name: "__string", # required
|
1363
|
+
# })
|
1364
|
+
#
|
1365
|
+
# @example Response structure
|
1366
|
+
#
|
1367
|
+
# resp.create_template_message_body.arn #=> String
|
1368
|
+
# resp.create_template_message_body.message #=> String
|
1369
|
+
# resp.create_template_message_body.request_id #=> String
|
1370
|
+
#
|
1371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSmsTemplate AWS API Documentation
|
1372
|
+
#
|
1373
|
+
# @overload create_sms_template(params = {})
|
1374
|
+
# @param [Hash] params ({})
|
1375
|
+
def create_sms_template(params = {}, options = {})
|
1376
|
+
req = build_request(:create_sms_template, params)
|
1377
|
+
req.send_request(options)
|
1378
|
+
end
|
1379
|
+
|
1186
1380
|
# Disables the ADM channel for an application and deletes any existing
|
1187
1381
|
# settings for the channel.
|
1188
1382
|
#
|
@@ -1553,6 +1747,9 @@ module Aws::Pinpoint
|
|
1553
1747
|
# resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
|
1554
1748
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
1555
1749
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
1750
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
1751
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
1752
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
1556
1753
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
1557
1754
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
1558
1755
|
# resp.campaign_response.application_id #=> String
|
@@ -1662,6 +1859,9 @@ module Aws::Pinpoint
|
|
1662
1859
|
# resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
1663
1860
|
# resp.campaign_response.tags #=> Hash
|
1664
1861
|
# resp.campaign_response.tags["__string"] #=> String
|
1862
|
+
# resp.campaign_response.template_configuration.email_template.name #=> String
|
1863
|
+
# resp.campaign_response.template_configuration.push_template.name #=> String
|
1864
|
+
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
1665
1865
|
# resp.campaign_response.treatment_description #=> String
|
1666
1866
|
# resp.campaign_response.treatment_name #=> String
|
1667
1867
|
# resp.campaign_response.version #=> Integer
|
@@ -1717,6 +1917,35 @@ module Aws::Pinpoint
|
|
1717
1917
|
req.send_request(options)
|
1718
1918
|
end
|
1719
1919
|
|
1920
|
+
# Deletes a message template that was designed for use in messages that
|
1921
|
+
# were sent through the email channel.
|
1922
|
+
#
|
1923
|
+
# @option params [required, String] :template_name
|
1924
|
+
#
|
1925
|
+
# @return [Types::DeleteEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1926
|
+
#
|
1927
|
+
# * {Types::DeleteEmailTemplateResponse#message_body #message_body} => Types::MessageBody
|
1928
|
+
#
|
1929
|
+
# @example Request syntax with placeholder values
|
1930
|
+
#
|
1931
|
+
# resp = client.delete_email_template({
|
1932
|
+
# template_name: "__string", # required
|
1933
|
+
# })
|
1934
|
+
#
|
1935
|
+
# @example Response structure
|
1936
|
+
#
|
1937
|
+
# resp.message_body.message #=> String
|
1938
|
+
# resp.message_body.request_id #=> String
|
1939
|
+
#
|
1940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailTemplate AWS API Documentation
|
1941
|
+
#
|
1942
|
+
# @overload delete_email_template(params = {})
|
1943
|
+
# @param [Hash] params ({})
|
1944
|
+
def delete_email_template(params = {}, options = {})
|
1945
|
+
req = build_request(:delete_email_template, params)
|
1946
|
+
req.send_request(options)
|
1947
|
+
end
|
1948
|
+
|
1720
1949
|
# Deletes an endpoint from an application.
|
1721
1950
|
#
|
1722
1951
|
# @option params [required, String] :application_id
|
@@ -1849,6 +2078,35 @@ module Aws::Pinpoint
|
|
1849
2078
|
req.send_request(options)
|
1850
2079
|
end
|
1851
2080
|
|
2081
|
+
# Deletes a message template that was designed for use in messages that
|
2082
|
+
# were sent through a push notification channel.
|
2083
|
+
#
|
2084
|
+
# @option params [required, String] :template_name
|
2085
|
+
#
|
2086
|
+
# @return [Types::DeletePushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2087
|
+
#
|
2088
|
+
# * {Types::DeletePushTemplateResponse#message_body #message_body} => Types::MessageBody
|
2089
|
+
#
|
2090
|
+
# @example Request syntax with placeholder values
|
2091
|
+
#
|
2092
|
+
# resp = client.delete_push_template({
|
2093
|
+
# template_name: "__string", # required
|
2094
|
+
# })
|
2095
|
+
#
|
2096
|
+
# @example Response structure
|
2097
|
+
#
|
2098
|
+
# resp.message_body.message #=> String
|
2099
|
+
# resp.message_body.request_id #=> String
|
2100
|
+
#
|
2101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeletePushTemplate AWS API Documentation
|
2102
|
+
#
|
2103
|
+
# @overload delete_push_template(params = {})
|
2104
|
+
# @param [Hash] params ({})
|
2105
|
+
def delete_push_template(params = {}, options = {})
|
2106
|
+
req = build_request(:delete_push_template, params)
|
2107
|
+
req.send_request(options)
|
2108
|
+
end
|
2109
|
+
|
1852
2110
|
# Deletes a segment from an application.
|
1853
2111
|
#
|
1854
2112
|
# @option params [required, String] :application_id
|
@@ -2018,6 +2276,35 @@ module Aws::Pinpoint
|
|
2018
2276
|
req.send_request(options)
|
2019
2277
|
end
|
2020
2278
|
|
2279
|
+
# Deletes a message template that was designed for use in messages that
|
2280
|
+
# were sent through the SMS channel.
|
2281
|
+
#
|
2282
|
+
# @option params [required, String] :template_name
|
2283
|
+
#
|
2284
|
+
# @return [Types::DeleteSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2285
|
+
#
|
2286
|
+
# * {Types::DeleteSmsTemplateResponse#message_body #message_body} => Types::MessageBody
|
2287
|
+
#
|
2288
|
+
# @example Request syntax with placeholder values
|
2289
|
+
#
|
2290
|
+
# resp = client.delete_sms_template({
|
2291
|
+
# template_name: "__string", # required
|
2292
|
+
# })
|
2293
|
+
#
|
2294
|
+
# @example Response structure
|
2295
|
+
#
|
2296
|
+
# resp.message_body.message #=> String
|
2297
|
+
# resp.message_body.request_id #=> String
|
2298
|
+
#
|
2299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsTemplate AWS API Documentation
|
2300
|
+
#
|
2301
|
+
# @overload delete_sms_template(params = {})
|
2302
|
+
# @param [Hash] params ({})
|
2303
|
+
def delete_sms_template(params = {}, options = {})
|
2304
|
+
req = build_request(:delete_sms_template, params)
|
2305
|
+
req.send_request(options)
|
2306
|
+
end
|
2307
|
+
|
2021
2308
|
# Deletes all the endpoints that are associated with a specific user ID.
|
2022
2309
|
#
|
2023
2310
|
# @option params [required, String] :application_id
|
@@ -2472,8 +2759,8 @@ module Aws::Pinpoint
|
|
2472
2759
|
req.send_request(options)
|
2473
2760
|
end
|
2474
2761
|
|
2475
|
-
# Retrieves information about the status and settings of the Baidu
|
2476
|
-
#
|
2762
|
+
# Retrieves information about the status and settings of the Baidu
|
2763
|
+
# channel for an application.
|
2477
2764
|
#
|
2478
2765
|
# @option params [required, String] :application_id
|
2479
2766
|
#
|
@@ -2619,6 +2906,9 @@ module Aws::Pinpoint
|
|
2619
2906
|
# resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
|
2620
2907
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
2621
2908
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
2909
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
2910
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
2911
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
2622
2912
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
2623
2913
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
2624
2914
|
# resp.campaign_response.application_id #=> String
|
@@ -2728,6 +3018,9 @@ module Aws::Pinpoint
|
|
2728
3018
|
# resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
2729
3019
|
# resp.campaign_response.tags #=> Hash
|
2730
3020
|
# resp.campaign_response.tags["__string"] #=> String
|
3021
|
+
# resp.campaign_response.template_configuration.email_template.name #=> String
|
3022
|
+
# resp.campaign_response.template_configuration.push_template.name #=> String
|
3023
|
+
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
2731
3024
|
# resp.campaign_response.treatment_description #=> String
|
2732
3025
|
# resp.campaign_response.treatment_name #=> String
|
2733
3026
|
# resp.campaign_response.version #=> Integer
|
@@ -2963,6 +3256,9 @@ module Aws::Pinpoint
|
|
2963
3256
|
# resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
|
2964
3257
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
2965
3258
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3259
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
3260
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
3261
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
2966
3262
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
2967
3263
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
2968
3264
|
# resp.campaign_response.application_id #=> String
|
@@ -3072,6 +3368,9 @@ module Aws::Pinpoint
|
|
3072
3368
|
# resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3073
3369
|
# resp.campaign_response.tags #=> Hash
|
3074
3370
|
# resp.campaign_response.tags["__string"] #=> String
|
3371
|
+
# resp.campaign_response.template_configuration.email_template.name #=> String
|
3372
|
+
# resp.campaign_response.template_configuration.push_template.name #=> String
|
3373
|
+
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
3075
3374
|
# resp.campaign_response.treatment_description #=> String
|
3076
3375
|
# resp.campaign_response.treatment_name #=> String
|
3077
3376
|
# resp.campaign_response.version #=> Integer
|
@@ -3201,6 +3500,9 @@ module Aws::Pinpoint
|
|
3201
3500
|
# resp.campaigns_response.item[0].additional_treatments[0].schedule.timezone #=> String
|
3202
3501
|
# resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
|
3203
3502
|
# resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3503
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
|
3504
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
|
3505
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
|
3204
3506
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
|
3205
3507
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
|
3206
3508
|
# resp.campaigns_response.item[0].application_id #=> String
|
@@ -3310,6 +3612,9 @@ module Aws::Pinpoint
|
|
3310
3612
|
# resp.campaigns_response.item[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3311
3613
|
# resp.campaigns_response.item[0].tags #=> Hash
|
3312
3614
|
# resp.campaigns_response.item[0].tags["__string"] #=> String
|
3615
|
+
# resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
|
3616
|
+
# resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
|
3617
|
+
# resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
|
3313
3618
|
# resp.campaigns_response.item[0].treatment_description #=> String
|
3314
3619
|
# resp.campaigns_response.item[0].treatment_name #=> String
|
3315
3620
|
# resp.campaigns_response.item[0].version #=> Integer
|
@@ -3438,6 +3743,9 @@ module Aws::Pinpoint
|
|
3438
3743
|
# resp.campaigns_response.item[0].additional_treatments[0].schedule.timezone #=> String
|
3439
3744
|
# resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
|
3440
3745
|
# resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3746
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
|
3747
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
|
3748
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
|
3441
3749
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
|
3442
3750
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
|
3443
3751
|
# resp.campaigns_response.item[0].application_id #=> String
|
@@ -3547,6 +3855,9 @@ module Aws::Pinpoint
|
|
3547
3855
|
# resp.campaigns_response.item[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3548
3856
|
# resp.campaigns_response.item[0].tags #=> Hash
|
3549
3857
|
# resp.campaigns_response.item[0].tags["__string"] #=> String
|
3858
|
+
# resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
|
3859
|
+
# resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
|
3860
|
+
# resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
|
3550
3861
|
# resp.campaigns_response.item[0].treatment_description #=> String
|
3551
3862
|
# resp.campaigns_response.item[0].treatment_name #=> String
|
3552
3863
|
# resp.campaigns_response.item[0].version #=> Integer
|
@@ -3640,6 +3951,43 @@ module Aws::Pinpoint
|
|
3640
3951
|
req.send_request(options)
|
3641
3952
|
end
|
3642
3953
|
|
3954
|
+
# Retrieves the content and settings for a message template that you can
|
3955
|
+
# use in messages that are sent through the email channel.
|
3956
|
+
#
|
3957
|
+
# @option params [required, String] :template_name
|
3958
|
+
#
|
3959
|
+
# @return [Types::GetEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3960
|
+
#
|
3961
|
+
# * {Types::GetEmailTemplateResponse#email_template_response #email_template_response} => Types::EmailTemplateResponse
|
3962
|
+
#
|
3963
|
+
# @example Request syntax with placeholder values
|
3964
|
+
#
|
3965
|
+
# resp = client.get_email_template({
|
3966
|
+
# template_name: "__string", # required
|
3967
|
+
# })
|
3968
|
+
#
|
3969
|
+
# @example Response structure
|
3970
|
+
#
|
3971
|
+
# resp.email_template_response.arn #=> String
|
3972
|
+
# resp.email_template_response.creation_date #=> String
|
3973
|
+
# resp.email_template_response.html_part #=> String
|
3974
|
+
# resp.email_template_response.last_modified_date #=> String
|
3975
|
+
# resp.email_template_response.subject #=> String
|
3976
|
+
# resp.email_template_response.tags #=> Hash
|
3977
|
+
# resp.email_template_response.tags["__string"] #=> String
|
3978
|
+
# resp.email_template_response.template_name #=> String
|
3979
|
+
# resp.email_template_response.template_type #=> String, one of "EMAIL", "SMS", "PUSH"
|
3980
|
+
# resp.email_template_response.text_part #=> String
|
3981
|
+
#
|
3982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailTemplate AWS API Documentation
|
3983
|
+
#
|
3984
|
+
# @overload get_email_template(params = {})
|
3985
|
+
# @param [Hash] params ({})
|
3986
|
+
def get_email_template(params = {}, options = {})
|
3987
|
+
req = build_request(:get_email_template, params)
|
3988
|
+
req.send_request(options)
|
3989
|
+
end
|
3990
|
+
|
3643
3991
|
# Retrieves information about the settings and attributes of a specific
|
3644
3992
|
# endpoint for an application.
|
3645
3993
|
#
|
@@ -3980,6 +4328,75 @@ module Aws::Pinpoint
|
|
3980
4328
|
req.send_request(options)
|
3981
4329
|
end
|
3982
4330
|
|
4331
|
+
# Retrieves the content and settings for a message template that you can
|
4332
|
+
# use in messages that are sent through a push notification channel.
|
4333
|
+
#
|
4334
|
+
# @option params [required, String] :template_name
|
4335
|
+
#
|
4336
|
+
# @return [Types::GetPushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4337
|
+
#
|
4338
|
+
# * {Types::GetPushTemplateResponse#push_notification_template_response #push_notification_template_response} => Types::PushNotificationTemplateResponse
|
4339
|
+
#
|
4340
|
+
# @example Request syntax with placeholder values
|
4341
|
+
#
|
4342
|
+
# resp = client.get_push_template({
|
4343
|
+
# template_name: "__string", # required
|
4344
|
+
# })
|
4345
|
+
#
|
4346
|
+
# @example Response structure
|
4347
|
+
#
|
4348
|
+
# resp.push_notification_template_response.adm.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4349
|
+
# resp.push_notification_template_response.adm.body #=> String
|
4350
|
+
# resp.push_notification_template_response.adm.image_icon_url #=> String
|
4351
|
+
# resp.push_notification_template_response.adm.image_url #=> String
|
4352
|
+
# resp.push_notification_template_response.adm.small_image_icon_url #=> String
|
4353
|
+
# resp.push_notification_template_response.adm.sound #=> String
|
4354
|
+
# resp.push_notification_template_response.adm.title #=> String
|
4355
|
+
# resp.push_notification_template_response.adm.url #=> String
|
4356
|
+
# resp.push_notification_template_response.apns.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4357
|
+
# resp.push_notification_template_response.apns.body #=> String
|
4358
|
+
# resp.push_notification_template_response.apns.media_url #=> String
|
4359
|
+
# resp.push_notification_template_response.apns.sound #=> String
|
4360
|
+
# resp.push_notification_template_response.apns.title #=> String
|
4361
|
+
# resp.push_notification_template_response.apns.url #=> String
|
4362
|
+
# resp.push_notification_template_response.arn #=> String
|
4363
|
+
# resp.push_notification_template_response.baidu.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4364
|
+
# resp.push_notification_template_response.baidu.body #=> String
|
4365
|
+
# resp.push_notification_template_response.baidu.image_icon_url #=> String
|
4366
|
+
# resp.push_notification_template_response.baidu.image_url #=> String
|
4367
|
+
# resp.push_notification_template_response.baidu.small_image_icon_url #=> String
|
4368
|
+
# resp.push_notification_template_response.baidu.sound #=> String
|
4369
|
+
# resp.push_notification_template_response.baidu.title #=> String
|
4370
|
+
# resp.push_notification_template_response.baidu.url #=> String
|
4371
|
+
# resp.push_notification_template_response.creation_date #=> String
|
4372
|
+
# resp.push_notification_template_response.default.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4373
|
+
# resp.push_notification_template_response.default.body #=> String
|
4374
|
+
# resp.push_notification_template_response.default.sound #=> String
|
4375
|
+
# resp.push_notification_template_response.default.title #=> String
|
4376
|
+
# resp.push_notification_template_response.default.url #=> String
|
4377
|
+
# resp.push_notification_template_response.gcm.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4378
|
+
# resp.push_notification_template_response.gcm.body #=> String
|
4379
|
+
# resp.push_notification_template_response.gcm.image_icon_url #=> String
|
4380
|
+
# resp.push_notification_template_response.gcm.image_url #=> String
|
4381
|
+
# resp.push_notification_template_response.gcm.small_image_icon_url #=> String
|
4382
|
+
# resp.push_notification_template_response.gcm.sound #=> String
|
4383
|
+
# resp.push_notification_template_response.gcm.title #=> String
|
4384
|
+
# resp.push_notification_template_response.gcm.url #=> String
|
4385
|
+
# resp.push_notification_template_response.last_modified_date #=> String
|
4386
|
+
# resp.push_notification_template_response.tags #=> Hash
|
4387
|
+
# resp.push_notification_template_response.tags["__string"] #=> String
|
4388
|
+
# resp.push_notification_template_response.template_name #=> String
|
4389
|
+
# resp.push_notification_template_response.template_type #=> String, one of "EMAIL", "SMS", "PUSH"
|
4390
|
+
#
|
4391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplate AWS API Documentation
|
4392
|
+
#
|
4393
|
+
# @overload get_push_template(params = {})
|
4394
|
+
# @param [Hash] params ({})
|
4395
|
+
def get_push_template(params = {}, options = {})
|
4396
|
+
req = build_request(:get_push_template, params)
|
4397
|
+
req.send_request(options)
|
4398
|
+
end
|
4399
|
+
|
3983
4400
|
# Retrieves information about the configuration, dimension, and other
|
3984
4401
|
# settings for a specific segment that's associated with an
|
3985
4402
|
# application.
|
@@ -4670,6 +5087,41 @@ module Aws::Pinpoint
|
|
4670
5087
|
req.send_request(options)
|
4671
5088
|
end
|
4672
5089
|
|
5090
|
+
# Retrieves the content and settings for a message template that you can
|
5091
|
+
# use in messages that are sent through the SMS channel.
|
5092
|
+
#
|
5093
|
+
# @option params [required, String] :template_name
|
5094
|
+
#
|
5095
|
+
# @return [Types::GetSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5096
|
+
#
|
5097
|
+
# * {Types::GetSmsTemplateResponse#sms_template_response #sms_template_response} => Types::SMSTemplateResponse
|
5098
|
+
#
|
5099
|
+
# @example Request syntax with placeholder values
|
5100
|
+
#
|
5101
|
+
# resp = client.get_sms_template({
|
5102
|
+
# template_name: "__string", # required
|
5103
|
+
# })
|
5104
|
+
#
|
5105
|
+
# @example Response structure
|
5106
|
+
#
|
5107
|
+
# resp.sms_template_response.arn #=> String
|
5108
|
+
# resp.sms_template_response.body #=> String
|
5109
|
+
# resp.sms_template_response.creation_date #=> String
|
5110
|
+
# resp.sms_template_response.last_modified_date #=> String
|
5111
|
+
# resp.sms_template_response.tags #=> Hash
|
5112
|
+
# resp.sms_template_response.tags["__string"] #=> String
|
5113
|
+
# resp.sms_template_response.template_name #=> String
|
5114
|
+
# resp.sms_template_response.template_type #=> String, one of "EMAIL", "SMS", "PUSH"
|
5115
|
+
#
|
5116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsTemplate AWS API Documentation
|
5117
|
+
#
|
5118
|
+
# @overload get_sms_template(params = {})
|
5119
|
+
# @param [Hash] params ({})
|
5120
|
+
def get_sms_template(params = {}, options = {})
|
5121
|
+
req = build_request(:get_sms_template, params)
|
5122
|
+
req.send_request(options)
|
5123
|
+
end
|
5124
|
+
|
4673
5125
|
# Retrieves information about all the endpoints that are associated with
|
4674
5126
|
# a specific user ID.
|
4675
5127
|
#
|
@@ -4773,7 +5225,7 @@ module Aws::Pinpoint
|
|
4773
5225
|
end
|
4774
5226
|
|
4775
5227
|
# Retrieves all the tags (keys and values) that are associated with an
|
4776
|
-
# application, campaign, or segment.
|
5228
|
+
# application, campaign, message template, or segment.
|
4777
5229
|
#
|
4778
5230
|
# @option params [required, String] :resource_arn
|
4779
5231
|
#
|
@@ -4801,6 +5253,51 @@ module Aws::Pinpoint
|
|
4801
5253
|
req.send_request(options)
|
4802
5254
|
end
|
4803
5255
|
|
5256
|
+
# Retrieves information about all the message templates that are
|
5257
|
+
# associated with your Amazon Pinpoint account.
|
5258
|
+
#
|
5259
|
+
# @option params [String] :next_token
|
5260
|
+
#
|
5261
|
+
# @option params [String] :page_size
|
5262
|
+
#
|
5263
|
+
# @option params [String] :prefix
|
5264
|
+
#
|
5265
|
+
# @option params [String] :template_type
|
5266
|
+
#
|
5267
|
+
# @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5268
|
+
#
|
5269
|
+
# * {Types::ListTemplatesResponse#templates_response #templates_response} => Types::TemplatesResponse
|
5270
|
+
#
|
5271
|
+
# @example Request syntax with placeholder values
|
5272
|
+
#
|
5273
|
+
# resp = client.list_templates({
|
5274
|
+
# next_token: "__string",
|
5275
|
+
# page_size: "__string",
|
5276
|
+
# prefix: "__string",
|
5277
|
+
# template_type: "__string",
|
5278
|
+
# })
|
5279
|
+
#
|
5280
|
+
# @example Response structure
|
5281
|
+
#
|
5282
|
+
# resp.templates_response.item #=> Array
|
5283
|
+
# resp.templates_response.item[0].arn #=> String
|
5284
|
+
# resp.templates_response.item[0].creation_date #=> String
|
5285
|
+
# resp.templates_response.item[0].last_modified_date #=> String
|
5286
|
+
# resp.templates_response.item[0].tags #=> Hash
|
5287
|
+
# resp.templates_response.item[0].tags["__string"] #=> String
|
5288
|
+
# resp.templates_response.item[0].template_name #=> String
|
5289
|
+
# resp.templates_response.item[0].template_type #=> String, one of "EMAIL", "SMS", "PUSH"
|
5290
|
+
# resp.templates_response.next_token #=> String
|
5291
|
+
#
|
5292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplates AWS API Documentation
|
5293
|
+
#
|
5294
|
+
# @overload list_templates(params = {})
|
5295
|
+
# @param [Hash] params ({})
|
5296
|
+
def list_templates(params = {}, options = {})
|
5297
|
+
req = build_request(:list_templates, params)
|
5298
|
+
req.send_request(options)
|
5299
|
+
end
|
5300
|
+
|
4804
5301
|
# Retrieves information about a phone number.
|
4805
5302
|
#
|
4806
5303
|
# @option params [required, Types::NumberValidateRequest] :number_validate_request
|
@@ -5232,6 +5729,17 @@ module Aws::Pinpoint
|
|
5232
5729
|
# voice_id: "__string",
|
5233
5730
|
# },
|
5234
5731
|
# },
|
5732
|
+
# template_configuration: {
|
5733
|
+
# email_template: {
|
5734
|
+
# name: "__string",
|
5735
|
+
# },
|
5736
|
+
# push_template: {
|
5737
|
+
# name: "__string",
|
5738
|
+
# },
|
5739
|
+
# sms_template: {
|
5740
|
+
# name: "__string",
|
5741
|
+
# },
|
5742
|
+
# },
|
5235
5743
|
# trace_id: "__string",
|
5236
5744
|
# },
|
5237
5745
|
# })
|
@@ -5437,6 +5945,17 @@ module Aws::Pinpoint
|
|
5437
5945
|
# voice_id: "__string",
|
5438
5946
|
# },
|
5439
5947
|
# },
|
5948
|
+
# template_configuration: {
|
5949
|
+
# email_template: {
|
5950
|
+
# name: "__string",
|
5951
|
+
# },
|
5952
|
+
# push_template: {
|
5953
|
+
# name: "__string",
|
5954
|
+
# },
|
5955
|
+
# sms_template: {
|
5956
|
+
# name: "__string",
|
5957
|
+
# },
|
5958
|
+
# },
|
5440
5959
|
# trace_id: "__string",
|
5441
5960
|
# users: { # required
|
5442
5961
|
# "__string" => {
|
@@ -5477,13 +5996,13 @@ module Aws::Pinpoint
|
|
5477
5996
|
end
|
5478
5997
|
|
5479
5998
|
# Adds one or more tags (keys and values) to an application, campaign,
|
5480
|
-
# or segment.
|
5999
|
+
# message template, or segment.
|
5481
6000
|
#
|
5482
6001
|
# @option params [required, String] :resource_arn
|
5483
6002
|
#
|
5484
6003
|
# @option params [required, Types::TagsModel] :tags_model
|
5485
|
-
# Specifies the tags (keys and values) for an application, campaign,
|
5486
|
-
# segment.
|
6004
|
+
# Specifies the tags (keys and values) for an application, campaign,
|
6005
|
+
# message template, or segment.
|
5487
6006
|
#
|
5488
6007
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5489
6008
|
#
|
@@ -5508,7 +6027,7 @@ module Aws::Pinpoint
|
|
5508
6027
|
end
|
5509
6028
|
|
5510
6029
|
# Removes one or more tags (keys and values) from an application,
|
5511
|
-
# campaign, or segment.
|
6030
|
+
# campaign, message template, or segment.
|
5512
6031
|
#
|
5513
6032
|
# @option params [required, String] :resource_arn
|
5514
6033
|
#
|
@@ -5532,7 +6051,8 @@ module Aws::Pinpoint
|
|
5532
6051
|
req.send_request(options)
|
5533
6052
|
end
|
5534
6053
|
|
5535
|
-
#
|
6054
|
+
# Enables the ADM channel for an application or updates the status and
|
6055
|
+
# settings of the ADM channel for an application.
|
5536
6056
|
#
|
5537
6057
|
# @option params [required, Types::ADMChannelRequest] :adm_channel_request
|
5538
6058
|
# Specifies the status and settings of the ADM (Amazon Device Messaging)
|
@@ -5577,7 +6097,8 @@ module Aws::Pinpoint
|
|
5577
6097
|
req.send_request(options)
|
5578
6098
|
end
|
5579
6099
|
|
5580
|
-
#
|
6100
|
+
# Enables the APNs channel for an application or updates the status and
|
6101
|
+
# settings of the APNs channel for an application.
|
5581
6102
|
#
|
5582
6103
|
# @option params [required, Types::APNSChannelRequest] :apns_channel_request
|
5583
6104
|
# Specifies the status and settings of the APNs (Apple Push Notification
|
@@ -5629,7 +6150,8 @@ module Aws::Pinpoint
|
|
5629
6150
|
req.send_request(options)
|
5630
6151
|
end
|
5631
6152
|
|
5632
|
-
#
|
6153
|
+
# Enables the APNs sandbox channel for an application or updates the
|
6154
|
+
# status and settings of the APNs sandbox channel for an application.
|
5633
6155
|
#
|
5634
6156
|
# @option params [required, Types::APNSSandboxChannelRequest] :apns_sandbox_channel_request
|
5635
6157
|
# Specifies the status and settings of the APNs (Apple Push Notification
|
@@ -5681,7 +6203,8 @@ module Aws::Pinpoint
|
|
5681
6203
|
req.send_request(options)
|
5682
6204
|
end
|
5683
6205
|
|
5684
|
-
#
|
6206
|
+
# Enables the APNs VoIP channel for an application or updates the status
|
6207
|
+
# and settings of the APNs VoIP channel for an application.
|
5685
6208
|
#
|
5686
6209
|
# @option params [required, Types::APNSVoipChannelRequest] :apns_voip_channel_request
|
5687
6210
|
# Specifies the status and settings of the APNs (Apple Push Notification
|
@@ -5733,7 +6256,8 @@ module Aws::Pinpoint
|
|
5733
6256
|
req.send_request(options)
|
5734
6257
|
end
|
5735
6258
|
|
5736
|
-
#
|
6259
|
+
# Enables the APNs VoIP sandbox channel for an application or updates
|
6260
|
+
# the status and settings of the APNs VoIP sandbox channel for an
|
5737
6261
|
# application.
|
5738
6262
|
#
|
5739
6263
|
# @option params [required, Types::APNSVoipSandboxChannelRequest] :apns_voip_sandbox_channel_request
|
@@ -5844,7 +6368,8 @@ module Aws::Pinpoint
|
|
5844
6368
|
req.send_request(options)
|
5845
6369
|
end
|
5846
6370
|
|
5847
|
-
#
|
6371
|
+
# Enables the Baidu channel for an application or updates the status and
|
6372
|
+
# settings of the Baidu channel for an application.
|
5848
6373
|
#
|
5849
6374
|
# @option params [required, String] :application_id
|
5850
6375
|
#
|
@@ -6027,6 +6552,17 @@ module Aws::Pinpoint
|
|
6027
6552
|
# timezone: "__string",
|
6028
6553
|
# },
|
6029
6554
|
# size_percent: 1, # required
|
6555
|
+
# template_configuration: {
|
6556
|
+
# email_template: {
|
6557
|
+
# name: "__string",
|
6558
|
+
# },
|
6559
|
+
# push_template: {
|
6560
|
+
# name: "__string",
|
6561
|
+
# },
|
6562
|
+
# sms_template: {
|
6563
|
+
# name: "__string",
|
6564
|
+
# },
|
6565
|
+
# },
|
6030
6566
|
# treatment_description: "__string",
|
6031
6567
|
# treatment_name: "__string",
|
6032
6568
|
# },
|
@@ -6166,6 +6702,17 @@ module Aws::Pinpoint
|
|
6166
6702
|
# tags: {
|
6167
6703
|
# "__string" => "__string",
|
6168
6704
|
# },
|
6705
|
+
# template_configuration: {
|
6706
|
+
# email_template: {
|
6707
|
+
# name: "__string",
|
6708
|
+
# },
|
6709
|
+
# push_template: {
|
6710
|
+
# name: "__string",
|
6711
|
+
# },
|
6712
|
+
# sms_template: {
|
6713
|
+
# name: "__string",
|
6714
|
+
# },
|
6715
|
+
# },
|
6169
6716
|
# treatment_description: "__string",
|
6170
6717
|
# treatment_name: "__string",
|
6171
6718
|
# },
|
@@ -6262,6 +6809,9 @@ module Aws::Pinpoint
|
|
6262
6809
|
# resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
|
6263
6810
|
# resp.campaign_response.additional_treatments[0].size_percent #=> Integer
|
6264
6811
|
# resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
6812
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
6813
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
6814
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
6265
6815
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
6266
6816
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
6267
6817
|
# resp.campaign_response.application_id #=> String
|
@@ -6371,6 +6921,9 @@ module Aws::Pinpoint
|
|
6371
6921
|
# resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
6372
6922
|
# resp.campaign_response.tags #=> Hash
|
6373
6923
|
# resp.campaign_response.tags["__string"] #=> String
|
6924
|
+
# resp.campaign_response.template_configuration.email_template.name #=> String
|
6925
|
+
# resp.campaign_response.template_configuration.push_template.name #=> String
|
6926
|
+
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
6374
6927
|
# resp.campaign_response.treatment_description #=> String
|
6375
6928
|
# resp.campaign_response.treatment_name #=> String
|
6376
6929
|
# resp.campaign_response.version #=> Integer
|
@@ -6384,8 +6937,8 @@ module Aws::Pinpoint
|
|
6384
6937
|
req.send_request(options)
|
6385
6938
|
end
|
6386
6939
|
|
6387
|
-
#
|
6388
|
-
# application.
|
6940
|
+
# Enables the email channel for an application or updates the status and
|
6941
|
+
# settings of the email channel for an application.
|
6389
6942
|
#
|
6390
6943
|
# @option params [required, String] :application_id
|
6391
6944
|
#
|
@@ -6437,6 +6990,47 @@ module Aws::Pinpoint
|
|
6437
6990
|
req.send_request(options)
|
6438
6991
|
end
|
6439
6992
|
|
6993
|
+
# Updates an existing message template that you can use in messages that
|
6994
|
+
# are sent through the email channel.
|
6995
|
+
#
|
6996
|
+
# @option params [required, Types::EmailTemplateRequest] :email_template_request
|
6997
|
+
# Specifies the content and settings for a message template that can be
|
6998
|
+
# used in messages that are sent through the email channel.
|
6999
|
+
#
|
7000
|
+
# @option params [required, String] :template_name
|
7001
|
+
#
|
7002
|
+
# @return [Types::UpdateEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7003
|
+
#
|
7004
|
+
# * {Types::UpdateEmailTemplateResponse#message_body #message_body} => Types::MessageBody
|
7005
|
+
#
|
7006
|
+
# @example Request syntax with placeholder values
|
7007
|
+
#
|
7008
|
+
# resp = client.update_email_template({
|
7009
|
+
# email_template_request: { # required
|
7010
|
+
# html_part: "__string",
|
7011
|
+
# subject: "__string",
|
7012
|
+
# tags: {
|
7013
|
+
# "__string" => "__string",
|
7014
|
+
# },
|
7015
|
+
# text_part: "__string",
|
7016
|
+
# },
|
7017
|
+
# template_name: "__string", # required
|
7018
|
+
# })
|
7019
|
+
#
|
7020
|
+
# @example Response structure
|
7021
|
+
#
|
7022
|
+
# resp.message_body.message #=> String
|
7023
|
+
# resp.message_body.request_id #=> String
|
7024
|
+
#
|
7025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailTemplate AWS API Documentation
|
7026
|
+
#
|
7027
|
+
# @overload update_email_template(params = {})
|
7028
|
+
# @param [Hash] params ({})
|
7029
|
+
def update_email_template(params = {}, options = {})
|
7030
|
+
req = build_request(:update_email_template, params)
|
7031
|
+
req.send_request(options)
|
7032
|
+
end
|
7033
|
+
|
6440
7034
|
# Creates a new endpoint for an application or updates the settings and
|
6441
7035
|
# attributes of an existing endpoint for an application. You can also
|
6442
7036
|
# use this operation to define custom attributes (Attributes, Metrics,
|
@@ -6591,7 +7185,8 @@ module Aws::Pinpoint
|
|
6591
7185
|
req.send_request(options)
|
6592
7186
|
end
|
6593
7187
|
|
6594
|
-
#
|
7188
|
+
# Enables the GCM channel for an application or updates the status and
|
7189
|
+
# settings of the GCM channel for an application.
|
6595
7190
|
#
|
6596
7191
|
# @option params [required, String] :application_id
|
6597
7192
|
#
|
@@ -6638,6 +7233,89 @@ module Aws::Pinpoint
|
|
6638
7233
|
req.send_request(options)
|
6639
7234
|
end
|
6640
7235
|
|
7236
|
+
# Updates an existing message template that you can use in messages that
|
7237
|
+
# are sent through a push notification channel.
|
7238
|
+
#
|
7239
|
+
# @option params [required, Types::PushNotificationTemplateRequest] :push_notification_template_request
|
7240
|
+
# Specifies the content and settings for a message template that can be
|
7241
|
+
# used in messages that are sent through a push notification channel.
|
7242
|
+
#
|
7243
|
+
# @option params [required, String] :template_name
|
7244
|
+
#
|
7245
|
+
# @return [Types::UpdatePushTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7246
|
+
#
|
7247
|
+
# * {Types::UpdatePushTemplateResponse#message_body #message_body} => Types::MessageBody
|
7248
|
+
#
|
7249
|
+
# @example Request syntax with placeholder values
|
7250
|
+
#
|
7251
|
+
# resp = client.update_push_template({
|
7252
|
+
# push_notification_template_request: { # required
|
7253
|
+
# adm: {
|
7254
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
7255
|
+
# body: "__string",
|
7256
|
+
# image_icon_url: "__string",
|
7257
|
+
# image_url: "__string",
|
7258
|
+
# small_image_icon_url: "__string",
|
7259
|
+
# sound: "__string",
|
7260
|
+
# title: "__string",
|
7261
|
+
# url: "__string",
|
7262
|
+
# },
|
7263
|
+
# apns: {
|
7264
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
7265
|
+
# body: "__string",
|
7266
|
+
# media_url: "__string",
|
7267
|
+
# sound: "__string",
|
7268
|
+
# title: "__string",
|
7269
|
+
# url: "__string",
|
7270
|
+
# },
|
7271
|
+
# baidu: {
|
7272
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
7273
|
+
# body: "__string",
|
7274
|
+
# image_icon_url: "__string",
|
7275
|
+
# image_url: "__string",
|
7276
|
+
# small_image_icon_url: "__string",
|
7277
|
+
# sound: "__string",
|
7278
|
+
# title: "__string",
|
7279
|
+
# url: "__string",
|
7280
|
+
# },
|
7281
|
+
# default: {
|
7282
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
7283
|
+
# body: "__string",
|
7284
|
+
# sound: "__string",
|
7285
|
+
# title: "__string",
|
7286
|
+
# url: "__string",
|
7287
|
+
# },
|
7288
|
+
# gcm: {
|
7289
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
7290
|
+
# body: "__string",
|
7291
|
+
# image_icon_url: "__string",
|
7292
|
+
# image_url: "__string",
|
7293
|
+
# small_image_icon_url: "__string",
|
7294
|
+
# sound: "__string",
|
7295
|
+
# title: "__string",
|
7296
|
+
# url: "__string",
|
7297
|
+
# },
|
7298
|
+
# tags: {
|
7299
|
+
# "__string" => "__string",
|
7300
|
+
# },
|
7301
|
+
# },
|
7302
|
+
# template_name: "__string", # required
|
7303
|
+
# })
|
7304
|
+
#
|
7305
|
+
# @example Response structure
|
7306
|
+
#
|
7307
|
+
# resp.message_body.message #=> String
|
7308
|
+
# resp.message_body.request_id #=> String
|
7309
|
+
#
|
7310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdatePushTemplate AWS API Documentation
|
7311
|
+
#
|
7312
|
+
# @overload update_push_template(params = {})
|
7313
|
+
# @param [Hash] params ({})
|
7314
|
+
def update_push_template(params = {}, options = {})
|
7315
|
+
req = build_request(:update_push_template, params)
|
7316
|
+
req.send_request(options)
|
7317
|
+
end
|
7318
|
+
|
6641
7319
|
# Creates a new segment for an application or updates the configuration,
|
6642
7320
|
# dimension, and other settings for an existing segment that's
|
6643
7321
|
# associated with an application.
|
@@ -6926,7 +7604,8 @@ module Aws::Pinpoint
|
|
6926
7604
|
req.send_request(options)
|
6927
7605
|
end
|
6928
7606
|
|
6929
|
-
#
|
7607
|
+
# Enables the SMS channel for an application or updates the status and
|
7608
|
+
# settings of the SMS channel for an application.
|
6930
7609
|
#
|
6931
7610
|
# @option params [required, String] :application_id
|
6932
7611
|
#
|
@@ -6975,8 +7654,47 @@ module Aws::Pinpoint
|
|
6975
7654
|
req.send_request(options)
|
6976
7655
|
end
|
6977
7656
|
|
6978
|
-
# Updates
|
6979
|
-
#
|
7657
|
+
# Updates an existing message template that you can use in messages that
|
7658
|
+
# are sent through the SMS channel.
|
7659
|
+
#
|
7660
|
+
# @option params [required, Types::SMSTemplateRequest] :sms_template_request
|
7661
|
+
# Specifies the content and settings for a message template that can be
|
7662
|
+
# used in text messages that are sent through the SMS channel.
|
7663
|
+
#
|
7664
|
+
# @option params [required, String] :template_name
|
7665
|
+
#
|
7666
|
+
# @return [Types::UpdateSmsTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7667
|
+
#
|
7668
|
+
# * {Types::UpdateSmsTemplateResponse#message_body #message_body} => Types::MessageBody
|
7669
|
+
#
|
7670
|
+
# @example Request syntax with placeholder values
|
7671
|
+
#
|
7672
|
+
# resp = client.update_sms_template({
|
7673
|
+
# sms_template_request: { # required
|
7674
|
+
# body: "__string",
|
7675
|
+
# tags: {
|
7676
|
+
# "__string" => "__string",
|
7677
|
+
# },
|
7678
|
+
# },
|
7679
|
+
# template_name: "__string", # required
|
7680
|
+
# })
|
7681
|
+
#
|
7682
|
+
# @example Response structure
|
7683
|
+
#
|
7684
|
+
# resp.message_body.message #=> String
|
7685
|
+
# resp.message_body.request_id #=> String
|
7686
|
+
#
|
7687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsTemplate AWS API Documentation
|
7688
|
+
#
|
7689
|
+
# @overload update_sms_template(params = {})
|
7690
|
+
# @param [Hash] params ({})
|
7691
|
+
def update_sms_template(params = {}, options = {})
|
7692
|
+
req = build_request(:update_sms_template, params)
|
7693
|
+
req.send_request(options)
|
7694
|
+
end
|
7695
|
+
|
7696
|
+
# Enables the voice channel for an application or updates the status and
|
7697
|
+
# settings of the voice channel for an application.
|
6980
7698
|
#
|
6981
7699
|
# @option params [required, String] :application_id
|
6982
7700
|
#
|
@@ -7033,7 +7751,7 @@ module Aws::Pinpoint
|
|
7033
7751
|
params: params,
|
7034
7752
|
config: config)
|
7035
7753
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
7036
|
-
context[:gem_version] = '1.
|
7754
|
+
context[:gem_version] = '1.28.0'
|
7037
7755
|
Seahorse::Client::Request.new(handlers, context)
|
7038
7756
|
end
|
7039
7757
|
|