aws-sdk-pinpoint 1.27.0 → 1.28.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.
@@ -511,19 +511,63 @@ module Aws::Pinpoint
511
511
  # @!attribute [rw] raw_content
512
512
  # The raw, JSON-formatted string to use as the payload for the
513
513
  # notification message. This value overrides the message.
514
+ #
515
+ # <note markdown="1">If you specify the raw content of an APNs push notification, the
516
+ # message payload has to include the content-available key. The value
517
+ # of the content-available key has to be an integer, and can only be 0
518
+ # or 1. If you're sending a standard notification, set the value of
519
+ # content-available to 0. If you're sending a silent (background)
520
+ # notification, set the value of content-available to 1. Additionally,
521
+ # silent notification payloads can't include the alert, badge, or
522
+ # sound keys. For more information, see [Generating a Remote
523
+ # Notification][1] and [Pushing Background Updates to Your App][2] on
524
+ # the Apple Developer website.
525
+ #
526
+ # </note>
527
+ #
528
+ #
529
+ #
530
+ # [1]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification
531
+ # [2]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app
514
532
  # @return [String]
515
533
  #
516
534
  # @!attribute [rw] silent_push
517
- # Specifies whether the notification is a silent push notification,
518
- # which is a push notification that doesn't display on a recipient's
519
- # device. Silent push notifications can be used for cases such as
520
- # updating an app's configuration, displaying messages in an in-app
521
- # message center, or supporting phone home functionality.
535
+ # Specifies whether the notification is a silent push notification. A
536
+ # silent (or background) push notification isn't displayed on
537
+ # recipients' devices. You can use silent push notifications to make
538
+ # small updates to your app, or to display messages in an in-app
539
+ # message center.
540
+ #
541
+ # Amazon Pinpoint uses this property to determine the correct value
542
+ # for the apns-push-type request header when it sends the notification
543
+ # message to APNs. If you specify a value of true for this property,
544
+ # Amazon Pinpoint sets the value for the apns-push-type header field
545
+ # to background.
546
+ #
547
+ # <note markdown="1">If you specify the raw content of an APNs push notification, the
548
+ # message payload has to include the content-available key. For silent
549
+ # (background) notifications, set the value of content-available to 1.
550
+ # Additionally, the message payload for a silent notification can't
551
+ # include the alert, badge, or sound keys. For more information, see
552
+ # [Generating a Remote Notification][1] and [Pushing Background
553
+ # Updates to Your App][2] on the Apple Developer website.
554
+ #
555
+ # Apple has indicated that they will throttle "excessive" background
556
+ # notifications based on current traffic volumes. To prevent your
557
+ # notifications being throttled, Apple recommends that you send no
558
+ # more than 3 silent push notifications to each recipient per hour.
559
+ #
560
+ # </note>
561
+ #
562
+ #
563
+ #
564
+ # [1]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification
565
+ # [2]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app
522
566
  # @return [Boolean]
523
567
  #
524
568
  # @!attribute [rw] sound
525
569
  # The key for the sound to play when the recipient receives the push
526
- # notification. The value of this key is the name of a sound file in
570
+ # notification. The value for this key is the name of a sound file in
527
571
  # your app's main bundle or the Library/Sounds folder in your app's
528
572
  # data container. If the sound file can't be found or you specify
529
573
  # default for the value, the system plays the default alert sound.
@@ -586,6 +630,80 @@ module Aws::Pinpoint
586
630
  include Aws::Structure
587
631
  end
588
632
 
633
+ # Specifies the content and settings for a message template that can be
634
+ # used in push notifications that are sent through the APNs (Apple Push
635
+ # Notification service) channel.
636
+ #
637
+ # @note When making an API call, you may pass APNSPushNotificationTemplate
638
+ # data as a hash:
639
+ #
640
+ # {
641
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
642
+ # body: "__string",
643
+ # media_url: "__string",
644
+ # sound: "__string",
645
+ # title: "__string",
646
+ # url: "__string",
647
+ # }
648
+ #
649
+ # @!attribute [rw] action
650
+ # The action to occur if a recipient taps a push notification that's
651
+ # based on the message template. Valid values are:
652
+ #
653
+ # * OPEN\_APP - Your app opens or it becomes the foreground app if it
654
+ # was sent to the background. This is the default action.
655
+ #
656
+ # * DEEP\_LINK - Your app opens and displays a designated user
657
+ # interface in the app. This setting uses the deep-linking features
658
+ # of the iOS platform.
659
+ #
660
+ # * URL - The default mobile browser on the recipient's device opens
661
+ # and loads the web page at a URL that you specify.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] body
665
+ # The message body to use in push notifications that are based on the
666
+ # message template.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] media_url
670
+ # The URL of an image or video to display in push notifications that
671
+ # are based on the message template.
672
+ # @return [String]
673
+ #
674
+ # @!attribute [rw] sound
675
+ # The key for the sound to play when the recipient receives a push
676
+ # notification that's based on the message template. The value for
677
+ # this key is the name of a sound file in your app's main bundle or
678
+ # the Library/Sounds folder in your app's data container. If the
679
+ # sound file can't be found or you specify default for the value, the
680
+ # system plays the default alert sound.
681
+ # @return [String]
682
+ #
683
+ # @!attribute [rw] title
684
+ # The title to use in push notifications that are based on the message
685
+ # template. This title appears above the notification message on a
686
+ # recipient's device.
687
+ # @return [String]
688
+ #
689
+ # @!attribute [rw] url
690
+ # The URL to open in the recipient's default mobile browser, if a
691
+ # recipient taps a push notification that's based on the message
692
+ # template and the value of the Action property is URL.
693
+ # @return [String]
694
+ #
695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSPushNotificationTemplate AWS API Documentation
696
+ #
697
+ class APNSPushNotificationTemplate < Struct.new(
698
+ :action,
699
+ :body,
700
+ :media_url,
701
+ :sound,
702
+ :title,
703
+ :url)
704
+ include Aws::Structure
705
+ end
706
+
589
707
  # Specifies the status and settings of the APNs (Apple Push Notification
590
708
  # service) sandbox channel for an application.
591
709
  #
@@ -1209,6 +1327,95 @@ module Aws::Pinpoint
1209
1327
  include Aws::Structure
1210
1328
  end
1211
1329
 
1330
+ # Specifies the content and settings for a message template can be used
1331
+ # in push notifications that are sent through the ADM (Amazon Device
1332
+ # Messaging), GCM (Firebase Cloud Messaging, formerly Google Cloud
1333
+ # Messaging), or Baidu (Baidu Cloud Push) channel.
1334
+ #
1335
+ # @note When making an API call, you may pass AndroidPushNotificationTemplate
1336
+ # data as a hash:
1337
+ #
1338
+ # {
1339
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1340
+ # body: "__string",
1341
+ # image_icon_url: "__string",
1342
+ # image_url: "__string",
1343
+ # small_image_icon_url: "__string",
1344
+ # sound: "__string",
1345
+ # title: "__string",
1346
+ # url: "__string",
1347
+ # }
1348
+ #
1349
+ # @!attribute [rw] action
1350
+ # The action to occur if a recipient taps a push notification that's
1351
+ # based on the message template. Valid values are:
1352
+ #
1353
+ # * OPEN\_APP - Your app opens or it becomes the foreground app if it
1354
+ # was sent to the background. This is the default action.
1355
+ #
1356
+ # * DEEP\_LINK - Your app opens and displays a designated user
1357
+ # interface in the app. This action uses the deep-linking features
1358
+ # of the Android platform.
1359
+ #
1360
+ # * URL - The default mobile browser on the recipient's device opens
1361
+ # and loads the web page at a URL that you specify.
1362
+ # @return [String]
1363
+ #
1364
+ # @!attribute [rw] body
1365
+ # The message body to use in a push notification that's based on the
1366
+ # message template.
1367
+ # @return [String]
1368
+ #
1369
+ # @!attribute [rw] image_icon_url
1370
+ # The URL of the large icon image to display in the content view of a
1371
+ # push notification that's based on the message template.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] image_url
1375
+ # The URL of an image to display in a push notification that's based
1376
+ # on the message template.
1377
+ # @return [String]
1378
+ #
1379
+ # @!attribute [rw] small_image_icon_url
1380
+ # The URL of the small icon image to display in the status bar and the
1381
+ # content view of a push notification that's based on the message
1382
+ # template.
1383
+ # @return [String]
1384
+ #
1385
+ # @!attribute [rw] sound
1386
+ # The sound to play when a recipient receives a push notification
1387
+ # that's based on the message template. You can use the default
1388
+ # stream or specify the file name of a sound resource that's bundled
1389
+ # in your app. On an Android platform, the sound file must reside in
1390
+ # /res/raw/.
1391
+ # @return [String]
1392
+ #
1393
+ # @!attribute [rw] title
1394
+ # The title to use in a push notification that's based on the message
1395
+ # template. This title appears above the notification message on a
1396
+ # recipient's device.
1397
+ # @return [String]
1398
+ #
1399
+ # @!attribute [rw] url
1400
+ # The URL to open in a recipient's default mobile browser, if a
1401
+ # recipient taps a a push notification that's based on the message
1402
+ # template and the value of the Action property is URL.
1403
+ # @return [String]
1404
+ #
1405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/AndroidPushNotificationTemplate AWS API Documentation
1406
+ #
1407
+ class AndroidPushNotificationTemplate < Struct.new(
1408
+ :action,
1409
+ :body,
1410
+ :image_icon_url,
1411
+ :image_url,
1412
+ :small_image_icon_url,
1413
+ :sound,
1414
+ :title,
1415
+ :url)
1416
+ include Aws::Structure
1417
+ end
1418
+
1212
1419
  # Provides the results of a query that retrieved the data for a standard
1213
1420
  # metric that applies to an application, and provides information about
1214
1421
  # that query.
@@ -1219,8 +1426,8 @@ module Aws::Pinpoint
1219
1426
  # @return [String]
1220
1427
  #
1221
1428
  # @!attribute [rw] end_time
1222
- # The last date or date and time of the date range that was used to
1223
- # filter the query results, in ISO 8601 format. The date range is
1429
+ # The last date and time of the date range that was used to filter the
1430
+ # query results, in extended ISO 8601 format. The date range is
1224
1431
  # inclusive.
1225
1432
  # @return [Time]
1226
1433
  #
@@ -1230,7 +1437,11 @@ module Aws::Pinpoint
1230
1437
  # describes the associated metric and consists of two or more terms,
1231
1438
  # which are comprised of lowercase alphanumeric characters, separated
1232
1439
  # by a hyphen. For a list of valid values, see the [Amazon Pinpoint
1233
- # Developer Guide](developerguide.html).
1440
+ # Developer Guide][1].
1441
+ #
1442
+ #
1443
+ #
1444
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
1234
1445
  # @return [String]
1235
1446
  #
1236
1447
  # @!attribute [rw] kpi_result
@@ -1241,14 +1452,14 @@ module Aws::Pinpoint
1241
1452
  #
1242
1453
  # @!attribute [rw] next_token
1243
1454
  # The string to use in a subsequent request to get the next page of
1244
- # results in a paginated response. This value is null for the App
1245
- # Metrics resource. The App Metrics resource returns all results in a
1246
- # single page.
1455
+ # results in a paginated response. This value is null for the
1456
+ # Application Metrics resource. The Application Metrics resource
1457
+ # returns all results in a single page.
1247
1458
  # @return [String]
1248
1459
  #
1249
1460
  # @!attribute [rw] start_time
1250
- # The first date or date and time of the date range that was used to
1251
- # filter the query results, in ISO 8601 format. The date range is
1461
+ # The first date and time of the date range that was used to filter
1462
+ # the query results, in extended ISO 8601 format. The date range is
1252
1463
  # inclusive.
1253
1464
  # @return [Time]
1254
1465
  #
@@ -1416,12 +1627,12 @@ module Aws::Pinpoint
1416
1627
  # endpoints. Valid values are:
1417
1628
  #
1418
1629
  # * endpoint-custom-attributes - Custom attributes that describe
1419
- # endpoints
1630
+ # endpoints.
1420
1631
  #
1421
1632
  # * endpoint-custom-metrics - Custom metrics that your app reports to
1422
- # Amazon Pinpoint for endpoints
1633
+ # Amazon Pinpoint for endpoints.
1423
1634
  #
1424
- # * endpoint-user-attributes - Custom attributes that describe users
1635
+ # * endpoint-user-attributes - Custom attributes that describe users.
1425
1636
  # @return [String]
1426
1637
  #
1427
1638
  # @!attribute [rw] attributes
@@ -1722,8 +1933,8 @@ module Aws::Pinpoint
1722
1933
  # @return [String]
1723
1934
  #
1724
1935
  # @!attribute [rw] end_time
1725
- # The last date or date and time of the date range that was used to
1726
- # filter the query results, in ISO 8601 format. The date range is
1936
+ # The last date and time of the date range that was used to filter the
1937
+ # query results, in extended ISO 8601 format. The date range is
1727
1938
  # inclusive.
1728
1939
  # @return [Time]
1729
1940
  #
@@ -1733,7 +1944,11 @@ module Aws::Pinpoint
1733
1944
  # describes the associated metric and consists of two or more terms,
1734
1945
  # which are comprised of lowercase alphanumeric characters, separated
1735
1946
  # by a hyphen. For a list of valid values, see the [Amazon Pinpoint
1736
- # Developer Guide](developerguide.html).
1947
+ # Developer Guide][1].
1948
+ #
1949
+ #
1950
+ #
1951
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
1737
1952
  # @return [String]
1738
1953
  #
1739
1954
  # @!attribute [rw] kpi_result
@@ -1750,8 +1965,8 @@ module Aws::Pinpoint
1750
1965
  # @return [String]
1751
1966
  #
1752
1967
  # @!attribute [rw] start_time
1753
- # The first date or date and time of the date range that was used to
1754
- # filter the query results, in ISO 8601 format. The date range is
1968
+ # The first date and time of the date range that was used to filter
1969
+ # the query results, in extended ISO 8601 format. The date range is
1755
1970
  # inclusive.
1756
1971
  # @return [Time]
1757
1972
  #
@@ -2029,6 +2244,10 @@ module Aws::Pinpoint
2029
2244
  # required tag key and an associated tag value.
2030
2245
  # @return [Hash<String,String>]
2031
2246
  #
2247
+ # @!attribute [rw] template_configuration
2248
+ # The message template that’s used for the campaign.
2249
+ # @return [Types::TemplateConfiguration]
2250
+ #
2032
2251
  # @!attribute [rw] treatment_description
2033
2252
  # The custom description of a variation of the campaign that's used
2034
2253
  # for A/B testing.
@@ -2065,6 +2284,7 @@ module Aws::Pinpoint
2065
2284
  :segment_version,
2066
2285
  :state,
2067
2286
  :tags,
2287
+ :template_configuration,
2068
2288
  :treatment_description,
2069
2289
  :treatment_name,
2070
2290
  :version)
@@ -2411,6 +2631,17 @@ module Aws::Pinpoint
2411
2631
  # timezone: "__string",
2412
2632
  # },
2413
2633
  # size_percent: 1, # required
2634
+ # template_configuration: {
2635
+ # email_template: {
2636
+ # name: "__string",
2637
+ # },
2638
+ # push_template: {
2639
+ # name: "__string",
2640
+ # },
2641
+ # sms_template: {
2642
+ # name: "__string",
2643
+ # },
2644
+ # },
2414
2645
  # treatment_description: "__string",
2415
2646
  # treatment_name: "__string",
2416
2647
  # },
@@ -2550,6 +2781,17 @@ module Aws::Pinpoint
2550
2781
  # tags: {
2551
2782
  # "__string" => "__string",
2552
2783
  # },
2784
+ # template_configuration: {
2785
+ # email_template: {
2786
+ # name: "__string",
2787
+ # },
2788
+ # push_template: {
2789
+ # name: "__string",
2790
+ # },
2791
+ # sms_template: {
2792
+ # name: "__string",
2793
+ # },
2794
+ # },
2553
2795
  # treatment_description: "__string",
2554
2796
  # treatment_name: "__string",
2555
2797
  # },
@@ -2582,6 +2824,48 @@ module Aws::Pinpoint
2582
2824
  include Aws::Structure
2583
2825
  end
2584
2826
 
2827
+ # @note When making an API call, you may pass CreateEmailTemplateRequest
2828
+ # data as a hash:
2829
+ #
2830
+ # {
2831
+ # email_template_request: { # required
2832
+ # html_part: "__string",
2833
+ # subject: "__string",
2834
+ # tags: {
2835
+ # "__string" => "__string",
2836
+ # },
2837
+ # text_part: "__string",
2838
+ # },
2839
+ # template_name: "__string", # required
2840
+ # }
2841
+ #
2842
+ # @!attribute [rw] email_template_request
2843
+ # Specifies the content and settings for a message template that can
2844
+ # be used in messages that are sent through the email channel.
2845
+ # @return [Types::EmailTemplateRequest]
2846
+ #
2847
+ # @!attribute [rw] template_name
2848
+ # @return [String]
2849
+ #
2850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateEmailTemplateRequest AWS API Documentation
2851
+ #
2852
+ class CreateEmailTemplateRequest < Struct.new(
2853
+ :email_template_request,
2854
+ :template_name)
2855
+ include Aws::Structure
2856
+ end
2857
+
2858
+ # @!attribute [rw] create_template_message_body
2859
+ # Provides information about an API request or response.
2860
+ # @return [Types::CreateTemplateMessageBody]
2861
+ #
2862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateEmailTemplateResponse AWS API Documentation
2863
+ #
2864
+ class CreateEmailTemplateResponse < Struct.new(
2865
+ :create_template_message_body)
2866
+ include Aws::Structure
2867
+ end
2868
+
2585
2869
  # @note When making an API call, you may pass CreateExportJobRequest
2586
2870
  # data as a hash:
2587
2871
  #
@@ -2674,6 +2958,91 @@ module Aws::Pinpoint
2674
2958
  include Aws::Structure
2675
2959
  end
2676
2960
 
2961
+ # @note When making an API call, you may pass CreatePushTemplateRequest
2962
+ # data as a hash:
2963
+ #
2964
+ # {
2965
+ # push_notification_template_request: { # required
2966
+ # adm: {
2967
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
2968
+ # body: "__string",
2969
+ # image_icon_url: "__string",
2970
+ # image_url: "__string",
2971
+ # small_image_icon_url: "__string",
2972
+ # sound: "__string",
2973
+ # title: "__string",
2974
+ # url: "__string",
2975
+ # },
2976
+ # apns: {
2977
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
2978
+ # body: "__string",
2979
+ # media_url: "__string",
2980
+ # sound: "__string",
2981
+ # title: "__string",
2982
+ # url: "__string",
2983
+ # },
2984
+ # baidu: {
2985
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
2986
+ # body: "__string",
2987
+ # image_icon_url: "__string",
2988
+ # image_url: "__string",
2989
+ # small_image_icon_url: "__string",
2990
+ # sound: "__string",
2991
+ # title: "__string",
2992
+ # url: "__string",
2993
+ # },
2994
+ # default: {
2995
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
2996
+ # body: "__string",
2997
+ # sound: "__string",
2998
+ # title: "__string",
2999
+ # url: "__string",
3000
+ # },
3001
+ # gcm: {
3002
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
3003
+ # body: "__string",
3004
+ # image_icon_url: "__string",
3005
+ # image_url: "__string",
3006
+ # small_image_icon_url: "__string",
3007
+ # sound: "__string",
3008
+ # title: "__string",
3009
+ # url: "__string",
3010
+ # },
3011
+ # tags: {
3012
+ # "__string" => "__string",
3013
+ # },
3014
+ # },
3015
+ # template_name: "__string", # required
3016
+ # }
3017
+ #
3018
+ # @!attribute [rw] push_notification_template_request
3019
+ # Specifies the content and settings for a message template that can
3020
+ # be used in messages that are sent through a push notification
3021
+ # channel.
3022
+ # @return [Types::PushNotificationTemplateRequest]
3023
+ #
3024
+ # @!attribute [rw] template_name
3025
+ # @return [String]
3026
+ #
3027
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreatePushTemplateRequest AWS API Documentation
3028
+ #
3029
+ class CreatePushTemplateRequest < Struct.new(
3030
+ :push_notification_template_request,
3031
+ :template_name)
3032
+ include Aws::Structure
3033
+ end
3034
+
3035
+ # @!attribute [rw] create_template_message_body
3036
+ # Provides information about an API request or response.
3037
+ # @return [Types::CreateTemplateMessageBody]
3038
+ #
3039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreatePushTemplateResponse AWS API Documentation
3040
+ #
3041
+ class CreatePushTemplateResponse < Struct.new(
3042
+ :create_template_message_body)
3043
+ include Aws::Structure
3044
+ end
3045
+
2677
3046
  # @note When making an API call, you may pass CreateSegmentRequest
2678
3047
  # data as a hash:
2679
3048
  #
@@ -2863,6 +3232,66 @@ module Aws::Pinpoint
2863
3232
  include Aws::Structure
2864
3233
  end
2865
3234
 
3235
+ # @note When making an API call, you may pass CreateSmsTemplateRequest
3236
+ # data as a hash:
3237
+ #
3238
+ # {
3239
+ # sms_template_request: { # required
3240
+ # body: "__string",
3241
+ # tags: {
3242
+ # "__string" => "__string",
3243
+ # },
3244
+ # },
3245
+ # template_name: "__string", # required
3246
+ # }
3247
+ #
3248
+ # @!attribute [rw] sms_template_request
3249
+ # Specifies the content and settings for a message template that can
3250
+ # be used in text messages that are sent through the SMS channel.
3251
+ # @return [Types::SMSTemplateRequest]
3252
+ #
3253
+ # @!attribute [rw] template_name
3254
+ # @return [String]
3255
+ #
3256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSmsTemplateRequest AWS API Documentation
3257
+ #
3258
+ class CreateSmsTemplateRequest < Struct.new(
3259
+ :sms_template_request,
3260
+ :template_name)
3261
+ include Aws::Structure
3262
+ end
3263
+
3264
+ # @!attribute [rw] create_template_message_body
3265
+ # Provides information about an API request or response.
3266
+ # @return [Types::CreateTemplateMessageBody]
3267
+ #
3268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSmsTemplateResponse AWS API Documentation
3269
+ #
3270
+ class CreateSmsTemplateResponse < Struct.new(
3271
+ :create_template_message_body)
3272
+ include Aws::Structure
3273
+ end
3274
+
3275
+ # Provides information about an API request or response.
3276
+ #
3277
+ # @!attribute [rw] arn
3278
+ # @return [String]
3279
+ #
3280
+ # @!attribute [rw] message
3281
+ # @return [String]
3282
+ #
3283
+ # @!attribute [rw] request_id
3284
+ # @return [String]
3285
+ #
3286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateTemplateMessageBody AWS API Documentation
3287
+ #
3288
+ class CreateTemplateMessageBody < Struct.new(
3289
+ :arn,
3290
+ :message,
3291
+ :request_id)
3292
+ include Aws::Structure
3293
+ end
3294
+
2866
3295
  # Specifies the default message to use for all channels.
2867
3296
  #
2868
3297
  # @note When making an API call, you may pass DefaultMessage
@@ -2977,6 +3406,78 @@ module Aws::Pinpoint
2977
3406
  include Aws::Structure
2978
3407
  end
2979
3408
 
3409
+ # Specifies the settings and content for the default message template
3410
+ # that's used in messages that are sent through a push notification
3411
+ # channel.
3412
+ #
3413
+ # @note When making an API call, you may pass DefaultPushNotificationTemplate
3414
+ # data as a hash:
3415
+ #
3416
+ # {
3417
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
3418
+ # body: "__string",
3419
+ # sound: "__string",
3420
+ # title: "__string",
3421
+ # url: "__string",
3422
+ # }
3423
+ #
3424
+ # @!attribute [rw] action
3425
+ # The action to occur if a recipient taps a push notification that's
3426
+ # based on the message template. Valid values are:
3427
+ #
3428
+ # * OPEN\_APP - Your app opens or it becomes the foreground app if it
3429
+ # was sent to the background. This is the default action.
3430
+ #
3431
+ # * DEEP\_LINK - Your app opens and displays a designated user
3432
+ # interface in the app. This setting uses the deep-linking features
3433
+ # of the iOS and Android platforms.
3434
+ #
3435
+ # * URL - The default mobile browser on the recipient's device opens
3436
+ # and loads the web page at a URL that you specify.
3437
+ # @return [String]
3438
+ #
3439
+ # @!attribute [rw] body
3440
+ # The message body to use in push notifications that are based on the
3441
+ # message template.
3442
+ # @return [String]
3443
+ #
3444
+ # @!attribute [rw] sound
3445
+ # The sound to play when a recipient receives a push notification
3446
+ # that's based on the message template. You can use the default
3447
+ # stream or specify the file name of a sound resource that's bundled
3448
+ # in your app. On an Android platform, the sound file must reside in
3449
+ # /res/raw/.
3450
+ #
3451
+ # For an iOS platform, this value is the key for the name of a sound
3452
+ # file in your app's main bundle or the Library/Sounds folder in your
3453
+ # app's data container. If the sound file can't be found or you
3454
+ # specify default for the value, the system plays the default alert
3455
+ # sound.
3456
+ # @return [String]
3457
+ #
3458
+ # @!attribute [rw] title
3459
+ # The title to use in push notifications that are based on the message
3460
+ # template. This title appears above the notification message on a
3461
+ # recipient's device.
3462
+ # @return [String]
3463
+ #
3464
+ # @!attribute [rw] url
3465
+ # The URL to open in a recipient's default mobile browser, if a
3466
+ # recipient taps a push notification that's based on the message
3467
+ # template and the value of the Action property is URL.
3468
+ # @return [String]
3469
+ #
3470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DefaultPushNotificationTemplate AWS API Documentation
3471
+ #
3472
+ class DefaultPushNotificationTemplate < Struct.new(
3473
+ :action,
3474
+ :body,
3475
+ :sound,
3476
+ :title,
3477
+ :url)
3478
+ include Aws::Structure
3479
+ end
3480
+
2980
3481
  # @note When making an API call, you may pass DeleteAdmChannelRequest
2981
3482
  # data as a hash:
2982
3483
  #
@@ -3244,6 +3745,34 @@ module Aws::Pinpoint
3244
3745
  include Aws::Structure
3245
3746
  end
3246
3747
 
3748
+ # @note When making an API call, you may pass DeleteEmailTemplateRequest
3749
+ # data as a hash:
3750
+ #
3751
+ # {
3752
+ # template_name: "__string", # required
3753
+ # }
3754
+ #
3755
+ # @!attribute [rw] template_name
3756
+ # @return [String]
3757
+ #
3758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailTemplateRequest AWS API Documentation
3759
+ #
3760
+ class DeleteEmailTemplateRequest < Struct.new(
3761
+ :template_name)
3762
+ include Aws::Structure
3763
+ end
3764
+
3765
+ # @!attribute [rw] message_body
3766
+ # Provides information about an API request or response.
3767
+ # @return [Types::MessageBody]
3768
+ #
3769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailTemplateResponse AWS API Documentation
3770
+ #
3771
+ class DeleteEmailTemplateResponse < Struct.new(
3772
+ :message_body)
3773
+ include Aws::Structure
3774
+ end
3775
+
3247
3776
  # @note When making an API call, you may pass DeleteEndpointRequest
3248
3777
  # data as a hash:
3249
3778
  #
@@ -3338,6 +3867,34 @@ module Aws::Pinpoint
3338
3867
  include Aws::Structure
3339
3868
  end
3340
3869
 
3870
+ # @note When making an API call, you may pass DeletePushTemplateRequest
3871
+ # data as a hash:
3872
+ #
3873
+ # {
3874
+ # template_name: "__string", # required
3875
+ # }
3876
+ #
3877
+ # @!attribute [rw] template_name
3878
+ # @return [String]
3879
+ #
3880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeletePushTemplateRequest AWS API Documentation
3881
+ #
3882
+ class DeletePushTemplateRequest < Struct.new(
3883
+ :template_name)
3884
+ include Aws::Structure
3885
+ end
3886
+
3887
+ # @!attribute [rw] message_body
3888
+ # Provides information about an API request or response.
3889
+ # @return [Types::MessageBody]
3890
+ #
3891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeletePushTemplateResponse AWS API Documentation
3892
+ #
3893
+ class DeletePushTemplateResponse < Struct.new(
3894
+ :message_body)
3895
+ include Aws::Structure
3896
+ end
3897
+
3341
3898
  # @note When making an API call, you may pass DeleteSegmentRequest
3342
3899
  # data as a hash:
3343
3900
  #
@@ -3401,6 +3958,34 @@ module Aws::Pinpoint
3401
3958
  include Aws::Structure
3402
3959
  end
3403
3960
 
3961
+ # @note When making an API call, you may pass DeleteSmsTemplateRequest
3962
+ # data as a hash:
3963
+ #
3964
+ # {
3965
+ # template_name: "__string", # required
3966
+ # }
3967
+ #
3968
+ # @!attribute [rw] template_name
3969
+ # @return [String]
3970
+ #
3971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsTemplateRequest AWS API Documentation
3972
+ #
3973
+ class DeleteSmsTemplateRequest < Struct.new(
3974
+ :template_name)
3975
+ include Aws::Structure
3976
+ end
3977
+
3978
+ # @!attribute [rw] message_body
3979
+ # Provides information about an API request or response.
3980
+ # @return [Types::MessageBody]
3981
+ #
3982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsTemplateResponse AWS API Documentation
3983
+ #
3984
+ class DeleteSmsTemplateResponse < Struct.new(
3985
+ :message_body)
3986
+ include Aws::Structure
3987
+ end
3988
+
3404
3989
  # @note When making an API call, you may pass DeleteUserEndpointsRequest
3405
3990
  # data as a hash:
3406
3991
  #
@@ -3648,7 +4233,8 @@ module Aws::Pinpoint
3648
4233
  # @return [Types::DefaultMessage]
3649
4234
  #
3650
4235
  # @!attribute [rw] default_push_notification_message
3651
- # The default push notification message for all push channels.
4236
+ # The default push notification message for all push notification
4237
+ # channels.
3652
4238
  # @return [Types::DefaultPushNotificationMessage]
3653
4239
  #
3654
4240
  # @!attribute [rw] email_message
@@ -3905,16 +4491,126 @@ module Aws::Pinpoint
3905
4491
  # override the default variables with individual address variables.
3906
4492
  # @return [Hash<String,Array<String>>]
3907
4493
  #
3908
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailMessage AWS API Documentation
4494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailMessage AWS API Documentation
4495
+ #
4496
+ class EmailMessage < Struct.new(
4497
+ :body,
4498
+ :feedback_forwarding_address,
4499
+ :from_address,
4500
+ :raw_email,
4501
+ :reply_to_addresses,
4502
+ :simple_email,
4503
+ :substitutions)
4504
+ include Aws::Structure
4505
+ end
4506
+
4507
+ # Specifies the content and settings for a message template that can be
4508
+ # used in messages that are sent through the email channel.
4509
+ #
4510
+ # @note When making an API call, you may pass EmailTemplateRequest
4511
+ # data as a hash:
4512
+ #
4513
+ # {
4514
+ # html_part: "__string",
4515
+ # subject: "__string",
4516
+ # tags: {
4517
+ # "__string" => "__string",
4518
+ # },
4519
+ # text_part: "__string",
4520
+ # }
4521
+ #
4522
+ # @!attribute [rw] html_part
4523
+ # The message body, in HTML format, to use in email messages that are
4524
+ # based on the message template. We recommend using HTML format for
4525
+ # email clients that support HTML. You can include links, formatted
4526
+ # text, and more in an HTML message.
4527
+ # @return [String]
4528
+ #
4529
+ # @!attribute [rw] subject
4530
+ # The subject line, or title, to use in email messages that are based
4531
+ # on the message template.
4532
+ # @return [String]
4533
+ #
4534
+ # @!attribute [rw] tags
4535
+ # A string-to-string map of key-value pairs that defines the tags to
4536
+ # associate with the message template. Each tag consists of a required
4537
+ # tag key and an associated tag value.
4538
+ # @return [Hash<String,String>]
4539
+ #
4540
+ # @!attribute [rw] text_part
4541
+ # The message body, in text format, to use in email messages that are
4542
+ # based on the message template. We recommend using text format for
4543
+ # email clients that don't support HTML and clients that are
4544
+ # connected to high-latency networks, such as mobile devices.
4545
+ # @return [String]
4546
+ #
4547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailTemplateRequest AWS API Documentation
4548
+ #
4549
+ class EmailTemplateRequest < Struct.new(
4550
+ :html_part,
4551
+ :subject,
4552
+ :tags,
4553
+ :text_part)
4554
+ include Aws::Structure
4555
+ end
4556
+
4557
+ # Provides information about the content and settings for a message
4558
+ # template that can be used in messages that are sent through the email
4559
+ # channel.
4560
+ #
4561
+ # @!attribute [rw] arn
4562
+ # @return [String]
4563
+ #
4564
+ # @!attribute [rw] creation_date
4565
+ # The date when the message template was created.
4566
+ # @return [String]
4567
+ #
4568
+ # @!attribute [rw] html_part
4569
+ # The message body, in HTML format, that's used in email messages
4570
+ # that are based on the message template.
4571
+ # @return [String]
4572
+ #
4573
+ # @!attribute [rw] last_modified_date
4574
+ # The date when the message template was last modified.
4575
+ # @return [String]
4576
+ #
4577
+ # @!attribute [rw] subject
4578
+ # The subject line, or title, that's used in email messages that are
4579
+ # based on the message template.
4580
+ # @return [String]
4581
+ #
4582
+ # @!attribute [rw] tags
4583
+ # A string-to-string map of key-value pairs that identifies the tags
4584
+ # that are associated with the message template. Each tag consists of
4585
+ # a required tag key and an associated tag value.
4586
+ # @return [Hash<String,String>]
4587
+ #
4588
+ # @!attribute [rw] template_name
4589
+ # The name of the message template.
4590
+ # @return [String]
4591
+ #
4592
+ # @!attribute [rw] template_type
4593
+ # The type of channel that the message template is designed for. For
4594
+ # an email template, this value is EMAIL.
4595
+ # @return [String]
4596
+ #
4597
+ # @!attribute [rw] text_part
4598
+ # The message body, in text format, that's used in email messages
4599
+ # that are based on the message template.
4600
+ # @return [String]
4601
+ #
4602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailTemplateResponse AWS API Documentation
3909
4603
  #
3910
- class EmailMessage < Struct.new(
3911
- :body,
3912
- :feedback_forwarding_address,
3913
- :from_address,
3914
- :raw_email,
3915
- :reply_to_addresses,
3916
- :simple_email,
3917
- :substitutions)
4604
+ class EmailTemplateResponse < Struct.new(
4605
+ :arn,
4606
+ :creation_date,
4607
+ :html_part,
4608
+ :last_modified_date,
4609
+ :subject,
4610
+ :tags,
4611
+ :template_name,
4612
+ :template_type,
4613
+ :text_part)
3918
4614
  include Aws::Structure
3919
4615
  end
3920
4616
 
@@ -4004,7 +4700,15 @@ module Aws::Pinpoint
4004
4700
  # @return [String]
4005
4701
  #
4006
4702
  # @!attribute [rw] endpoint_status
4007
- # Not used.
4703
+ # Specifies whether to send messages or push notifications to the
4704
+ # endpoint. Valid values are: ACTIVE, messages are sent to the
4705
+ # endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
4706
+ #
4707
+ # Amazon Pinpoint automatically sets this value to ACTIVE when you
4708
+ # create an endpoint or update an existing endpoint. Amazon Pinpoint
4709
+ # automatically sets this value to INACTIVE if you update another
4710
+ # endpoint that has the same address specified by the Address
4711
+ # property.
4008
4712
  # @return [String]
4009
4713
  #
4010
4714
  # @!attribute [rw] id
@@ -4312,8 +5016,8 @@ module Aws::Pinpoint
4312
5016
  #
4313
5017
  # @!attribute [rw] updated_token
4314
5018
  # For push notifications that are sent through the GCM channel,
4315
- # specifies whether the token was updated as part of delivering the
4316
- # message.
5019
+ # specifies whether the endpoint's device registration token was
5020
+ # updated as part of delivering the message.
4317
5021
  # @return [String]
4318
5022
  #
4319
5023
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointMessageResult AWS API Documentation
@@ -4411,7 +5115,15 @@ module Aws::Pinpoint
4411
5115
  # @return [String]
4412
5116
  #
4413
5117
  # @!attribute [rw] endpoint_status
4414
- # Not used.
5118
+ # Specifies whether to send messages or push notifications to the
5119
+ # endpoint. Valid values are: ACTIVE, messages are sent to the
5120
+ # endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
5121
+ #
5122
+ # Amazon Pinpoint automatically sets this value to ACTIVE when you
5123
+ # create an endpoint or update an existing endpoint. Amazon Pinpoint
5124
+ # automatically sets this value to INACTIVE if you update another
5125
+ # endpoint that has the same address specified by the Address
5126
+ # property.
4415
5127
  # @return [String]
4416
5128
  #
4417
5129
  # @!attribute [rw] location
@@ -4515,7 +5227,15 @@ module Aws::Pinpoint
4515
5227
  # @return [String]
4516
5228
  #
4517
5229
  # @!attribute [rw] endpoint_status
4518
- # Not used.
5230
+ # Specifies whether messages or push notifications are sent to the
5231
+ # endpoint. Possible values are: ACTIVE, messages are sent to the
5232
+ # endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
5233
+ #
5234
+ # Amazon Pinpoint automatically sets this value to ACTIVE when you
5235
+ # create an endpoint or update an existing endpoint. Amazon Pinpoint
5236
+ # automatically sets this value to INACTIVE if you update another
5237
+ # endpoint that has the same address specified by the Address
5238
+ # property.
4519
5239
  # @return [String]
4520
5240
  #
4521
5241
  # @!attribute [rw] id
@@ -5337,8 +6057,8 @@ module Aws::Pinpoint
5337
6057
  # }
5338
6058
  #
5339
6059
  # @!attribute [rw] api_key
5340
- # The API key, also referred to as a *server key*, that you received
5341
- # from Google to communicate with Google services.
6060
+ # The Web API Key, also referred to as an *API\_KEY* or *server key*,
6061
+ # that you received from Google to communicate with Google services.
5342
6062
  # @return [String]
5343
6063
  #
5344
6064
  # @!attribute [rw] enabled
@@ -5368,8 +6088,8 @@ module Aws::Pinpoint
5368
6088
  # @return [String]
5369
6089
  #
5370
6090
  # @!attribute [rw] credential
5371
- # The API key, also referred to as a *server key*, that you received
5372
- # from Google to communicate with Google services.
6091
+ # The Web API Key, also referred to as an *API\_KEY* or *server key*,
6092
+ # that you received from Google to communicate with Google services.
5373
6093
  # @return [String]
5374
6094
  #
5375
6095
  # @!attribute [rw] enabled
@@ -6300,6 +7020,36 @@ module Aws::Pinpoint
6300
7020
  include Aws::Structure
6301
7021
  end
6302
7022
 
7023
+ # @note When making an API call, you may pass GetEmailTemplateRequest
7024
+ # data as a hash:
7025
+ #
7026
+ # {
7027
+ # template_name: "__string", # required
7028
+ # }
7029
+ #
7030
+ # @!attribute [rw] template_name
7031
+ # @return [String]
7032
+ #
7033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailTemplateRequest AWS API Documentation
7034
+ #
7035
+ class GetEmailTemplateRequest < Struct.new(
7036
+ :template_name)
7037
+ include Aws::Structure
7038
+ end
7039
+
7040
+ # @!attribute [rw] email_template_response
7041
+ # Provides information about the content and settings for a message
7042
+ # template that can be used in messages that are sent through the
7043
+ # email channel.
7044
+ # @return [Types::EmailTemplateResponse]
7045
+ #
7046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailTemplateResponse AWS API Documentation
7047
+ #
7048
+ class GetEmailTemplateResponse < Struct.new(
7049
+ :email_template_response)
7050
+ include Aws::Structure
7051
+ end
7052
+
6303
7053
  # @note When making an API call, you may pass GetEndpointRequest
6304
7054
  # data as a hash:
6305
7055
  #
@@ -6549,6 +7299,36 @@ module Aws::Pinpoint
6549
7299
  include Aws::Structure
6550
7300
  end
6551
7301
 
7302
+ # @note When making an API call, you may pass GetPushTemplateRequest
7303
+ # data as a hash:
7304
+ #
7305
+ # {
7306
+ # template_name: "__string", # required
7307
+ # }
7308
+ #
7309
+ # @!attribute [rw] template_name
7310
+ # @return [String]
7311
+ #
7312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplateRequest AWS API Documentation
7313
+ #
7314
+ class GetPushTemplateRequest < Struct.new(
7315
+ :template_name)
7316
+ include Aws::Structure
7317
+ end
7318
+
7319
+ # @!attribute [rw] push_notification_template_response
7320
+ # Provides information about the content and settings for a message
7321
+ # template that can be used in messages that are sent through a push
7322
+ # notification channel.
7323
+ # @return [Types::PushNotificationTemplateResponse]
7324
+ #
7325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplateResponse AWS API Documentation
7326
+ #
7327
+ class GetPushTemplateResponse < Struct.new(
7328
+ :push_notification_template_response)
7329
+ include Aws::Structure
7330
+ end
7331
+
6552
7332
  # @note When making an API call, you may pass GetSegmentExportJobsRequest
6553
7333
  # data as a hash:
6554
7334
  #
@@ -6825,6 +7605,36 @@ module Aws::Pinpoint
6825
7605
  include Aws::Structure
6826
7606
  end
6827
7607
 
7608
+ # @note When making an API call, you may pass GetSmsTemplateRequest
7609
+ # data as a hash:
7610
+ #
7611
+ # {
7612
+ # template_name: "__string", # required
7613
+ # }
7614
+ #
7615
+ # @!attribute [rw] template_name
7616
+ # @return [String]
7617
+ #
7618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsTemplateRequest AWS API Documentation
7619
+ #
7620
+ class GetSmsTemplateRequest < Struct.new(
7621
+ :template_name)
7622
+ include Aws::Structure
7623
+ end
7624
+
7625
+ # @!attribute [rw] sms_template_response
7626
+ # Provides information about the content and settings for a message
7627
+ # template that can be used in text messages that are sent through the
7628
+ # SMS channel.
7629
+ # @return [Types::SMSTemplateResponse]
7630
+ #
7631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsTemplateResponse AWS API Documentation
7632
+ #
7633
+ class GetSmsTemplateResponse < Struct.new(
7634
+ :sms_template_response)
7635
+ include Aws::Structure
7636
+ end
7637
+
6828
7638
  # @note When making an API call, you may pass GetUserEndpointsRequest
6829
7639
  # data as a hash:
6830
7640
  #
@@ -7231,7 +8041,7 @@ module Aws::Pinpoint
7231
8041
 
7232
8042
  # @!attribute [rw] tags_model
7233
8043
  # Specifies the tags (keys and values) for an application, campaign,
7234
- # or segment.
8044
+ # message template, or segment.
7235
8045
  # @return [Types::TagsModel]
7236
8046
  #
7237
8047
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTagsForResourceResponse AWS API Documentation
@@ -7241,6 +8051,50 @@ module Aws::Pinpoint
7241
8051
  include Aws::Structure
7242
8052
  end
7243
8053
 
8054
+ # @note When making an API call, you may pass ListTemplatesRequest
8055
+ # data as a hash:
8056
+ #
8057
+ # {
8058
+ # next_token: "__string",
8059
+ # page_size: "__string",
8060
+ # prefix: "__string",
8061
+ # template_type: "__string",
8062
+ # }
8063
+ #
8064
+ # @!attribute [rw] next_token
8065
+ # @return [String]
8066
+ #
8067
+ # @!attribute [rw] page_size
8068
+ # @return [String]
8069
+ #
8070
+ # @!attribute [rw] prefix
8071
+ # @return [String]
8072
+ #
8073
+ # @!attribute [rw] template_type
8074
+ # @return [String]
8075
+ #
8076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplatesRequest AWS API Documentation
8077
+ #
8078
+ class ListTemplatesRequest < Struct.new(
8079
+ :next_token,
8080
+ :page_size,
8081
+ :prefix,
8082
+ :template_type)
8083
+ include Aws::Structure
8084
+ end
8085
+
8086
+ # @!attribute [rw] templates_response
8087
+ # Provides information about all the message templates that are
8088
+ # associated with your Amazon Pinpoint account.
8089
+ # @return [Types::TemplatesResponse]
8090
+ #
8091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplatesResponse AWS API Documentation
8092
+ #
8093
+ class ListTemplatesResponse < Struct.new(
8094
+ :templates_response)
8095
+ include Aws::Structure
8096
+ end
8097
+
7244
8098
  # Specifies the content and settings for a push notification that's
7245
8099
  # sent to recipients of a campaign.
7246
8100
  #
@@ -7706,6 +8560,17 @@ module Aws::Pinpoint
7706
8560
  # voice_id: "__string",
7707
8561
  # },
7708
8562
  # },
8563
+ # template_configuration: {
8564
+ # email_template: {
8565
+ # name: "__string",
8566
+ # },
8567
+ # push_template: {
8568
+ # name: "__string",
8569
+ # },
8570
+ # sms_template: {
8571
+ # name: "__string",
8572
+ # },
8573
+ # },
7709
8574
  # trace_id: "__string",
7710
8575
  # }
7711
8576
  #
@@ -7738,6 +8603,10 @@ module Aws::Pinpoint
7738
8603
  # the message.
7739
8604
  # @return [Types::DirectMessageConfiguration]
7740
8605
  #
8606
+ # @!attribute [rw] template_configuration
8607
+ # The message template to use for the message.
8608
+ # @return [Types::TemplateConfiguration]
8609
+ #
7741
8610
  # @!attribute [rw] trace_id
7742
8611
  # The unique identifier for tracing the message. This identifier is
7743
8612
  # visible to message recipients.
@@ -7750,6 +8619,7 @@ module Aws::Pinpoint
7750
8619
  :context,
7751
8620
  :endpoints,
7752
8621
  :message_configuration,
8622
+ :template_configuration,
7753
8623
  :trace_id)
7754
8624
  include Aws::Structure
7755
8625
  end
@@ -7836,8 +8706,8 @@ module Aws::Pinpoint
7836
8706
  #
7837
8707
  # @!attribute [rw] updated_token
7838
8708
  # For push notifications that are sent through the GCM channel,
7839
- # specifies whether the token was updated as part of delivering the
7840
- # message.
8709
+ # specifies whether the endpoint's device registration token was
8710
+ # updated as part of delivering the message.
7841
8711
  # @return [String]
7842
8712
  #
7843
8713
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageResult AWS API Documentation
@@ -8140,9 +9010,15 @@ module Aws::Pinpoint
8140
9010
  # @return [String]
8141
9011
  #
8142
9012
  # @!attribute [rw] endpoint_status
8143
- # The status of the update request for the endpoint. Possible values
8144
- # are: INACTIVE, the update failed; and, ACTIVE, the endpoint was
8145
- # updated successfully.
9013
+ # Specifies whether to send messages or push notifications to the
9014
+ # endpoint. Valid values are: ACTIVE, messages are sent to the
9015
+ # endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
9016
+ #
9017
+ # Amazon Pinpoint automatically sets this value to ACTIVE when you
9018
+ # create an endpoint or update an existing endpoint. Amazon Pinpoint
9019
+ # automatically sets this value to INACTIVE if you update another
9020
+ # endpoint that has the same address specified by the Address
9021
+ # property.
8146
9022
  # @return [String]
8147
9023
  #
8148
9024
  # @!attribute [rw] location
@@ -8190,6 +9066,192 @@ module Aws::Pinpoint
8190
9066
  include Aws::Structure
8191
9067
  end
8192
9068
 
9069
+ # Specifies the content and settings for a message template that can be
9070
+ # used in messages that are sent through a push notification channel.
9071
+ #
9072
+ # @note When making an API call, you may pass PushNotificationTemplateRequest
9073
+ # data as a hash:
9074
+ #
9075
+ # {
9076
+ # adm: {
9077
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
9078
+ # body: "__string",
9079
+ # image_icon_url: "__string",
9080
+ # image_url: "__string",
9081
+ # small_image_icon_url: "__string",
9082
+ # sound: "__string",
9083
+ # title: "__string",
9084
+ # url: "__string",
9085
+ # },
9086
+ # apns: {
9087
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
9088
+ # body: "__string",
9089
+ # media_url: "__string",
9090
+ # sound: "__string",
9091
+ # title: "__string",
9092
+ # url: "__string",
9093
+ # },
9094
+ # baidu: {
9095
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
9096
+ # body: "__string",
9097
+ # image_icon_url: "__string",
9098
+ # image_url: "__string",
9099
+ # small_image_icon_url: "__string",
9100
+ # sound: "__string",
9101
+ # title: "__string",
9102
+ # url: "__string",
9103
+ # },
9104
+ # default: {
9105
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
9106
+ # body: "__string",
9107
+ # sound: "__string",
9108
+ # title: "__string",
9109
+ # url: "__string",
9110
+ # },
9111
+ # gcm: {
9112
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
9113
+ # body: "__string",
9114
+ # image_icon_url: "__string",
9115
+ # image_url: "__string",
9116
+ # small_image_icon_url: "__string",
9117
+ # sound: "__string",
9118
+ # title: "__string",
9119
+ # url: "__string",
9120
+ # },
9121
+ # tags: {
9122
+ # "__string" => "__string",
9123
+ # },
9124
+ # }
9125
+ #
9126
+ # @!attribute [rw] adm
9127
+ # The message template to use for the ADM (Amazon Device Messaging)
9128
+ # channel. This message template overrides the default template for
9129
+ # push notification channels (DefaultPushNotificationTemplate).
9130
+ # @return [Types::AndroidPushNotificationTemplate]
9131
+ #
9132
+ # @!attribute [rw] apns
9133
+ # The message template to use for the APNs (Apple Push Notification
9134
+ # service) channel. This message template overrides the default
9135
+ # template for push notification channels
9136
+ # (DefaultPushNotificationTemplate).
9137
+ # @return [Types::APNSPushNotificationTemplate]
9138
+ #
9139
+ # @!attribute [rw] baidu
9140
+ # The message template to use for the Baidu (Baidu Cloud Push)
9141
+ # channel. This message template overrides the default template for
9142
+ # push notification channels (DefaultPushNotificationTemplate).
9143
+ # @return [Types::AndroidPushNotificationTemplate]
9144
+ #
9145
+ # @!attribute [rw] default
9146
+ # The default message template to use for push notification channels.
9147
+ # @return [Types::DefaultPushNotificationTemplate]
9148
+ #
9149
+ # @!attribute [rw] gcm
9150
+ # The message template to use for the GCM channel, which is used to
9151
+ # send notifications through the Firebase Cloud Messaging (FCM),
9152
+ # formerly Google Cloud Messaging (GCM), service. This message
9153
+ # template overrides the default template for push notification
9154
+ # channels (DefaultPushNotificationTemplate).
9155
+ # @return [Types::AndroidPushNotificationTemplate]
9156
+ #
9157
+ # @!attribute [rw] tags
9158
+ # A string-to-string map of key-value pairs that defines the tags to
9159
+ # associate with the message template. Each tag consists of a required
9160
+ # tag key and an associated tag value.
9161
+ # @return [Hash<String,String>]
9162
+ #
9163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PushNotificationTemplateRequest AWS API Documentation
9164
+ #
9165
+ class PushNotificationTemplateRequest < Struct.new(
9166
+ :adm,
9167
+ :apns,
9168
+ :baidu,
9169
+ :default,
9170
+ :gcm,
9171
+ :tags)
9172
+ include Aws::Structure
9173
+ end
9174
+
9175
+ # Provides information about the content and settings for a message
9176
+ # template that can be used in messages that are sent through a push
9177
+ # notification channel.
9178
+ #
9179
+ # @!attribute [rw] adm
9180
+ # The message template that's used for the ADM (Amazon Device
9181
+ # Messaging) channel. This message template overrides the default
9182
+ # template for push notification channels
9183
+ # (DefaultPushNotificationTemplate).
9184
+ # @return [Types::AndroidPushNotificationTemplate]
9185
+ #
9186
+ # @!attribute [rw] apns
9187
+ # The message template that's used for the APNs (Apple Push
9188
+ # Notification service) channel. This message template overrides the
9189
+ # default template for push notification channels
9190
+ # (DefaultPushNotificationTemplate).
9191
+ # @return [Types::APNSPushNotificationTemplate]
9192
+ #
9193
+ # @!attribute [rw] arn
9194
+ # @return [String]
9195
+ #
9196
+ # @!attribute [rw] baidu
9197
+ # The message template that's used for the Baidu (Baidu Cloud Push)
9198
+ # channel. This message template overrides the default template for
9199
+ # push notification channels (DefaultPushNotificationTemplate).
9200
+ # @return [Types::AndroidPushNotificationTemplate]
9201
+ #
9202
+ # @!attribute [rw] creation_date
9203
+ # The date when the message template was created.
9204
+ # @return [String]
9205
+ #
9206
+ # @!attribute [rw] default
9207
+ # The default message template that's used for push notification
9208
+ # channels.
9209
+ # @return [Types::DefaultPushNotificationTemplate]
9210
+ #
9211
+ # @!attribute [rw] gcm
9212
+ # The message template that's used for the GCM channel, which is used
9213
+ # to send notifications through the Firebase Cloud Messaging (FCM),
9214
+ # formerly Google Cloud Messaging (GCM), service. This message
9215
+ # template overrides the default template for push notification
9216
+ # channels (DefaultPushNotificationTemplate).
9217
+ # @return [Types::AndroidPushNotificationTemplate]
9218
+ #
9219
+ # @!attribute [rw] last_modified_date
9220
+ # The date when the message template was last modified.
9221
+ # @return [String]
9222
+ #
9223
+ # @!attribute [rw] tags
9224
+ # A string-to-string map of key-value pairs that identifies the tags
9225
+ # that are associated with the message template. Each tag consists of
9226
+ # a required tag key and an associated tag value.
9227
+ # @return [Hash<String,String>]
9228
+ #
9229
+ # @!attribute [rw] template_name
9230
+ # The name of the message template.
9231
+ # @return [String]
9232
+ #
9233
+ # @!attribute [rw] template_type
9234
+ # The type of channel that the message template is designed for. For a
9235
+ # push notification template, this value is PUSH.
9236
+ # @return [String]
9237
+ #
9238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PushNotificationTemplateResponse AWS API Documentation
9239
+ #
9240
+ class PushNotificationTemplateResponse < Struct.new(
9241
+ :adm,
9242
+ :apns,
9243
+ :arn,
9244
+ :baidu,
9245
+ :creation_date,
9246
+ :default,
9247
+ :gcm,
9248
+ :last_modified_date,
9249
+ :tags,
9250
+ :template_name,
9251
+ :template_type)
9252
+ include Aws::Structure
9253
+ end
9254
+
8193
9255
  # @note When making an API call, you may pass PutEventStreamRequest
8194
9256
  # data as a hash:
8195
9257
  #
@@ -8671,34 +9733,114 @@ module Aws::Pinpoint
8671
9733
  # not critical or time-sensitive, such as a marketing message.
8672
9734
  # @return [String]
8673
9735
  #
8674
- # @!attribute [rw] origination_number
8675
- # The number that the SMS message originates from. This should be one
8676
- # of the dedicated long codes or short codes that you requested from
8677
- # AWS Support and is assigned to your AWS account. If you don't
8678
- # specify a long or short code, Amazon Pinpoint assigns a random long
8679
- # code to the SMS message.
9736
+ # @!attribute [rw] origination_number
9737
+ # The number to send the SMS message from. This value should be one of
9738
+ # the dedicated long or short codes that's assigned to your AWS
9739
+ # account. If you don't specify a long or short code, Amazon Pinpoint
9740
+ # assigns a random long code to the SMS message and sends the message
9741
+ # from that code.
9742
+ # @return [String]
9743
+ #
9744
+ # @!attribute [rw] sender_id
9745
+ # The sender ID to display as the sender of the message on a
9746
+ # recipient's device. Support for sender IDs varies by country or
9747
+ # region.
9748
+ # @return [String]
9749
+ #
9750
+ # @!attribute [rw] substitutions
9751
+ # The message variables to use in the SMS message. You can override
9752
+ # the default variables with individual address variables.
9753
+ # @return [Hash<String,Array<String>>]
9754
+ #
9755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSMessage AWS API Documentation
9756
+ #
9757
+ class SMSMessage < Struct.new(
9758
+ :body,
9759
+ :keyword,
9760
+ :message_type,
9761
+ :origination_number,
9762
+ :sender_id,
9763
+ :substitutions)
9764
+ include Aws::Structure
9765
+ end
9766
+
9767
+ # Specifies the content and settings for a message template that can be
9768
+ # used in text messages that are sent through the SMS channel.
9769
+ #
9770
+ # @note When making an API call, you may pass SMSTemplateRequest
9771
+ # data as a hash:
9772
+ #
9773
+ # {
9774
+ # body: "__string",
9775
+ # tags: {
9776
+ # "__string" => "__string",
9777
+ # },
9778
+ # }
9779
+ #
9780
+ # @!attribute [rw] body
9781
+ # The message body to use in text messages that are based on the
9782
+ # message template.
9783
+ # @return [String]
9784
+ #
9785
+ # @!attribute [rw] tags
9786
+ # A string-to-string map of key-value pairs that defines the tags to
9787
+ # associate with the message template. Each tag consists of a required
9788
+ # tag key and an associated tag value.
9789
+ # @return [Hash<String,String>]
9790
+ #
9791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSTemplateRequest AWS API Documentation
9792
+ #
9793
+ class SMSTemplateRequest < Struct.new(
9794
+ :body,
9795
+ :tags)
9796
+ include Aws::Structure
9797
+ end
9798
+
9799
+ # Provides information about the content and settings for a message
9800
+ # template that can be used in text messages that are sent through the
9801
+ # SMS channel.
9802
+ #
9803
+ # @!attribute [rw] arn
9804
+ # @return [String]
9805
+ #
9806
+ # @!attribute [rw] body
9807
+ # The message body that's used in text messages that are based on the
9808
+ # message template.
9809
+ # @return [String]
9810
+ #
9811
+ # @!attribute [rw] creation_date
9812
+ # The date when the message template was created.
8680
9813
  # @return [String]
8681
9814
  #
8682
- # @!attribute [rw] sender_id
8683
- # The sender ID to display as the sender of the message on a
8684
- # recipient's device. Support for sender IDs varies by country or
8685
- # region.
9815
+ # @!attribute [rw] last_modified_date
9816
+ # The date when the message template was last modified.
8686
9817
  # @return [String]
8687
9818
  #
8688
- # @!attribute [rw] substitutions
8689
- # The message variables to use in the SMS message. You can override
8690
- # the default variables with individual address variables.
8691
- # @return [Hash<String,Array<String>>]
9819
+ # @!attribute [rw] tags
9820
+ # A string-to-string map of key-value pairs that identifies the tags
9821
+ # that are associated with the message template. Each tag consists of
9822
+ # a required tag key and an associated tag value.
9823
+ # @return [Hash<String,String>]
8692
9824
  #
8693
- # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSMessage AWS API Documentation
9825
+ # @!attribute [rw] template_name
9826
+ # The name of the message template.
9827
+ # @return [String]
8694
9828
  #
8695
- class SMSMessage < Struct.new(
9829
+ # @!attribute [rw] template_type
9830
+ # The type of channel that the message template is designed for. For
9831
+ # an SMS template, this value is SMS.
9832
+ # @return [String]
9833
+ #
9834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSTemplateResponse AWS API Documentation
9835
+ #
9836
+ class SMSTemplateResponse < Struct.new(
9837
+ :arn,
8696
9838
  :body,
8697
- :keyword,
8698
- :message_type,
8699
- :origination_number,
8700
- :sender_id,
8701
- :substitutions)
9839
+ :creation_date,
9840
+ :last_modified_date,
9841
+ :tags,
9842
+ :template_name,
9843
+ :template_type)
8702
9844
  include Aws::Structure
8703
9845
  end
8704
9846
 
@@ -9657,6 +10799,17 @@ module Aws::Pinpoint
9657
10799
  # voice_id: "__string",
9658
10800
  # },
9659
10801
  # },
10802
+ # template_configuration: {
10803
+ # email_template: {
10804
+ # name: "__string",
10805
+ # },
10806
+ # push_template: {
10807
+ # name: "__string",
10808
+ # },
10809
+ # sms_template: {
10810
+ # name: "__string",
10811
+ # },
10812
+ # },
9660
10813
  # trace_id: "__string",
9661
10814
  # },
9662
10815
  # }
@@ -9853,6 +11006,17 @@ module Aws::Pinpoint
9853
11006
  # voice_id: "__string",
9854
11007
  # },
9855
11008
  # },
11009
+ # template_configuration: {
11010
+ # email_template: {
11011
+ # name: "__string",
11012
+ # },
11013
+ # push_template: {
11014
+ # name: "__string",
11015
+ # },
11016
+ # sms_template: {
11017
+ # name: "__string",
11018
+ # },
11019
+ # },
9856
11020
  # trace_id: "__string",
9857
11021
  # users: { # required
9858
11022
  # "__string" => {
@@ -9882,6 +11046,10 @@ module Aws::Pinpoint
9882
11046
  # messages that you defined for specific channels.
9883
11047
  # @return [Types::DirectMessageConfiguration]
9884
11048
  #
11049
+ # @!attribute [rw] template_configuration
11050
+ # The message template to use for the message.
11051
+ # @return [Types::TemplateConfiguration]
11052
+ #
9885
11053
  # @!attribute [rw] trace_id
9886
11054
  # The unique identifier for tracing the message. This identifier is
9887
11055
  # visible to message recipients.
@@ -9899,6 +11067,7 @@ module Aws::Pinpoint
9899
11067
  class SendUsersMessageRequest < Struct.new(
9900
11068
  :context,
9901
11069
  :message_configuration,
11070
+ :template_configuration,
9902
11071
  :trace_id,
9903
11072
  :users)
9904
11073
  include Aws::Structure
@@ -10095,6 +11264,17 @@ module Aws::Pinpoint
10095
11264
  # voice_id: "__string",
10096
11265
  # },
10097
11266
  # },
11267
+ # template_configuration: {
11268
+ # email_template: {
11269
+ # name: "__string",
11270
+ # },
11271
+ # push_template: {
11272
+ # name: "__string",
11273
+ # },
11274
+ # sms_template: {
11275
+ # name: "__string",
11276
+ # },
11277
+ # },
10098
11278
  # trace_id: "__string",
10099
11279
  # users: { # required
10100
11280
  # "__string" => {
@@ -10209,7 +11389,7 @@ module Aws::Pinpoint
10209
11389
  include Aws::Structure
10210
11390
  end
10211
11391
 
10212
- # Specifies the content of an email message, composed of a subject, a
11392
+ # Specifies the contents of an email message, composed of a subject, a
10213
11393
  # text part, and an HTML part.
10214
11394
  #
10215
11395
  # @note When making an API call, you may pass SimpleEmail
@@ -10299,7 +11479,7 @@ module Aws::Pinpoint
10299
11479
  #
10300
11480
  # @!attribute [rw] tags_model
10301
11481
  # Specifies the tags (keys and values) for an application, campaign,
10302
- # or segment.
11482
+ # message template, or segment.
10303
11483
  # @return [Types::TagsModel]
10304
11484
  #
10305
11485
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TagResourceRequest AWS API Documentation
@@ -10310,8 +11490,8 @@ module Aws::Pinpoint
10310
11490
  include Aws::Structure
10311
11491
  end
10312
11492
 
10313
- # Specifies the tags (keys and values) for an application, campaign, or
10314
- # segment.
11493
+ # Specifies the tags (keys and values) for an application, campaign,
11494
+ # message template, or segment.
10315
11495
  #
10316
11496
  # @note When making an API call, you may pass TagsModel
10317
11497
  # data as a hash:
@@ -10324,8 +11504,9 @@ module Aws::Pinpoint
10324
11504
  #
10325
11505
  # @!attribute [rw] tags
10326
11506
  # A string-to-string map of key-value pairs that defines the tags for
10327
- # an application, campaign, or segment. A project, campaign, or
10328
- # segment can have a maximum of 50 tags.
11507
+ # an application, campaign, message template, or segment. Each
11508
+ # project, campaign, message template, or segment can have a maximum
11509
+ # of 50 tags.
10329
11510
  #
10330
11511
  # Each tag consists of a required tag key and an associated tag value.
10331
11512
  # The maximum length of a tag key is 128 characters. The maximum
@@ -10339,6 +11520,131 @@ module Aws::Pinpoint
10339
11520
  include Aws::Structure
10340
11521
  end
10341
11522
 
11523
+ # Specifies the name of the message template to use for the message.
11524
+ #
11525
+ # @note When making an API call, you may pass Template
11526
+ # data as a hash:
11527
+ #
11528
+ # {
11529
+ # name: "__string",
11530
+ # }
11531
+ #
11532
+ # @!attribute [rw] name
11533
+ # The name of the message template to use for the message. If
11534
+ # specified, this value must match the name of an existing message
11535
+ # template.
11536
+ # @return [String]
11537
+ #
11538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Template AWS API Documentation
11539
+ #
11540
+ class Template < Struct.new(
11541
+ :name)
11542
+ include Aws::Structure
11543
+ end
11544
+
11545
+ # Specifies the message template to use for the message, for each type
11546
+ # of channel.
11547
+ #
11548
+ # @note When making an API call, you may pass TemplateConfiguration
11549
+ # data as a hash:
11550
+ #
11551
+ # {
11552
+ # email_template: {
11553
+ # name: "__string",
11554
+ # },
11555
+ # push_template: {
11556
+ # name: "__string",
11557
+ # },
11558
+ # sms_template: {
11559
+ # name: "__string",
11560
+ # },
11561
+ # }
11562
+ #
11563
+ # @!attribute [rw] email_template
11564
+ # The email template to use for the message.
11565
+ # @return [Types::Template]
11566
+ #
11567
+ # @!attribute [rw] push_template
11568
+ # The push notification template to use for the message.
11569
+ # @return [Types::Template]
11570
+ #
11571
+ # @!attribute [rw] sms_template
11572
+ # The SMS template to use for the message.
11573
+ # @return [Types::Template]
11574
+ #
11575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateConfiguration AWS API Documentation
11576
+ #
11577
+ class TemplateConfiguration < Struct.new(
11578
+ :email_template,
11579
+ :push_template,
11580
+ :sms_template)
11581
+ include Aws::Structure
11582
+ end
11583
+
11584
+ # Provides information about a message template that's associated with
11585
+ # your Amazon Pinpoint account.
11586
+ #
11587
+ # @!attribute [rw] arn
11588
+ # The Amazon Resource Name (ARN) of the message template.
11589
+ # @return [String]
11590
+ #
11591
+ # @!attribute [rw] creation_date
11592
+ # The date when the message template was created.
11593
+ # @return [String]
11594
+ #
11595
+ # @!attribute [rw] last_modified_date
11596
+ # The date when the message template was last modified.
11597
+ # @return [String]
11598
+ #
11599
+ # @!attribute [rw] tags
11600
+ # A string-to-string map of key-value pairs that identifies the tags
11601
+ # that are associated with the message template. Each tag consists of
11602
+ # a required tag key and an associated tag value.
11603
+ # @return [Hash<String,String>]
11604
+ #
11605
+ # @!attribute [rw] template_name
11606
+ # The name of the message template.
11607
+ # @return [String]
11608
+ #
11609
+ # @!attribute [rw] template_type
11610
+ # The type of channel that the message template is designed for.
11611
+ # @return [String]
11612
+ #
11613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateResponse AWS API Documentation
11614
+ #
11615
+ class TemplateResponse < Struct.new(
11616
+ :arn,
11617
+ :creation_date,
11618
+ :last_modified_date,
11619
+ :tags,
11620
+ :template_name,
11621
+ :template_type)
11622
+ include Aws::Structure
11623
+ end
11624
+
11625
+ # Provides information about all the message templates that are
11626
+ # associated with your Amazon Pinpoint account.
11627
+ #
11628
+ # @!attribute [rw] item
11629
+ # An array of responses, one for each message template that's
11630
+ # associated with your Amazon Pinpoint account and meets any filter
11631
+ # criteria that you specified in the request.
11632
+ # @return [Array<Types::TemplateResponse>]
11633
+ #
11634
+ # @!attribute [rw] next_token
11635
+ # The string to use in a subsequent request to get the next page of
11636
+ # results in a paginated response. This value is null if there are no
11637
+ # additional pages.
11638
+ # @return [String]
11639
+ #
11640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplatesResponse AWS API Documentation
11641
+ #
11642
+ class TemplatesResponse < Struct.new(
11643
+ :item,
11644
+ :next_token)
11645
+ include Aws::Structure
11646
+ end
11647
+
10342
11648
  # Provides information about an API request or response.
10343
11649
  #
10344
11650
  # @!attribute [rw] message
@@ -10379,6 +11685,10 @@ module Aws::Pinpoint
10379
11685
  # The status of the treatment.
10380
11686
  # @return [Types::CampaignState]
10381
11687
  #
11688
+ # @!attribute [rw] template_configuration
11689
+ # The message template that’s used for the treatment.
11690
+ # @return [Types::TemplateConfiguration]
11691
+ #
10382
11692
  # @!attribute [rw] treatment_description
10383
11693
  # The custom description of the treatment.
10384
11694
  # @return [String]
@@ -10396,6 +11706,7 @@ module Aws::Pinpoint
10396
11706
  :schedule,
10397
11707
  :size_percent,
10398
11708
  :state,
11709
+ :template_configuration,
10399
11710
  :treatment_description,
10400
11711
  :treatment_name)
10401
11712
  include Aws::Structure
@@ -10887,6 +12198,17 @@ module Aws::Pinpoint
10887
12198
  # timezone: "__string",
10888
12199
  # },
10889
12200
  # size_percent: 1, # required
12201
+ # template_configuration: {
12202
+ # email_template: {
12203
+ # name: "__string",
12204
+ # },
12205
+ # push_template: {
12206
+ # name: "__string",
12207
+ # },
12208
+ # sms_template: {
12209
+ # name: "__string",
12210
+ # },
12211
+ # },
10890
12212
  # treatment_description: "__string",
10891
12213
  # treatment_name: "__string",
10892
12214
  # },
@@ -11026,6 +12348,17 @@ module Aws::Pinpoint
11026
12348
  # tags: {
11027
12349
  # "__string" => "__string",
11028
12350
  # },
12351
+ # template_configuration: {
12352
+ # email_template: {
12353
+ # name: "__string",
12354
+ # },
12355
+ # push_template: {
12356
+ # name: "__string",
12357
+ # },
12358
+ # sms_template: {
12359
+ # name: "__string",
12360
+ # },
12361
+ # },
11029
12362
  # treatment_description: "__string",
11030
12363
  # treatment_name: "__string",
11031
12364
  # },
@@ -11104,6 +12437,48 @@ module Aws::Pinpoint
11104
12437
  include Aws::Structure
11105
12438
  end
11106
12439
 
12440
+ # @note When making an API call, you may pass UpdateEmailTemplateRequest
12441
+ # data as a hash:
12442
+ #
12443
+ # {
12444
+ # email_template_request: { # required
12445
+ # html_part: "__string",
12446
+ # subject: "__string",
12447
+ # tags: {
12448
+ # "__string" => "__string",
12449
+ # },
12450
+ # text_part: "__string",
12451
+ # },
12452
+ # template_name: "__string", # required
12453
+ # }
12454
+ #
12455
+ # @!attribute [rw] email_template_request
12456
+ # Specifies the content and settings for a message template that can
12457
+ # be used in messages that are sent through the email channel.
12458
+ # @return [Types::EmailTemplateRequest]
12459
+ #
12460
+ # @!attribute [rw] template_name
12461
+ # @return [String]
12462
+ #
12463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailTemplateRequest AWS API Documentation
12464
+ #
12465
+ class UpdateEmailTemplateRequest < Struct.new(
12466
+ :email_template_request,
12467
+ :template_name)
12468
+ include Aws::Structure
12469
+ end
12470
+
12471
+ # @!attribute [rw] message_body
12472
+ # Provides information about an API request or response.
12473
+ # @return [Types::MessageBody]
12474
+ #
12475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailTemplateResponse AWS API Documentation
12476
+ #
12477
+ class UpdateEmailTemplateResponse < Struct.new(
12478
+ :message_body)
12479
+ include Aws::Structure
12480
+ end
12481
+
11107
12482
  # @note When making an API call, you may pass UpdateEndpointRequest
11108
12483
  # data as a hash:
11109
12484
  #
@@ -11300,6 +12675,91 @@ module Aws::Pinpoint
11300
12675
  include Aws::Structure
11301
12676
  end
11302
12677
 
12678
+ # @note When making an API call, you may pass UpdatePushTemplateRequest
12679
+ # data as a hash:
12680
+ #
12681
+ # {
12682
+ # push_notification_template_request: { # required
12683
+ # adm: {
12684
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
12685
+ # body: "__string",
12686
+ # image_icon_url: "__string",
12687
+ # image_url: "__string",
12688
+ # small_image_icon_url: "__string",
12689
+ # sound: "__string",
12690
+ # title: "__string",
12691
+ # url: "__string",
12692
+ # },
12693
+ # apns: {
12694
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
12695
+ # body: "__string",
12696
+ # media_url: "__string",
12697
+ # sound: "__string",
12698
+ # title: "__string",
12699
+ # url: "__string",
12700
+ # },
12701
+ # baidu: {
12702
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
12703
+ # body: "__string",
12704
+ # image_icon_url: "__string",
12705
+ # image_url: "__string",
12706
+ # small_image_icon_url: "__string",
12707
+ # sound: "__string",
12708
+ # title: "__string",
12709
+ # url: "__string",
12710
+ # },
12711
+ # default: {
12712
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
12713
+ # body: "__string",
12714
+ # sound: "__string",
12715
+ # title: "__string",
12716
+ # url: "__string",
12717
+ # },
12718
+ # gcm: {
12719
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
12720
+ # body: "__string",
12721
+ # image_icon_url: "__string",
12722
+ # image_url: "__string",
12723
+ # small_image_icon_url: "__string",
12724
+ # sound: "__string",
12725
+ # title: "__string",
12726
+ # url: "__string",
12727
+ # },
12728
+ # tags: {
12729
+ # "__string" => "__string",
12730
+ # },
12731
+ # },
12732
+ # template_name: "__string", # required
12733
+ # }
12734
+ #
12735
+ # @!attribute [rw] push_notification_template_request
12736
+ # Specifies the content and settings for a message template that can
12737
+ # be used in messages that are sent through a push notification
12738
+ # channel.
12739
+ # @return [Types::PushNotificationTemplateRequest]
12740
+ #
12741
+ # @!attribute [rw] template_name
12742
+ # @return [String]
12743
+ #
12744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdatePushTemplateRequest AWS API Documentation
12745
+ #
12746
+ class UpdatePushTemplateRequest < Struct.new(
12747
+ :push_notification_template_request,
12748
+ :template_name)
12749
+ include Aws::Structure
12750
+ end
12751
+
12752
+ # @!attribute [rw] message_body
12753
+ # Provides information about an API request or response.
12754
+ # @return [Types::MessageBody]
12755
+ #
12756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdatePushTemplateResponse AWS API Documentation
12757
+ #
12758
+ class UpdatePushTemplateResponse < Struct.new(
12759
+ :message_body)
12760
+ include Aws::Structure
12761
+ end
12762
+
11303
12763
  # @note When making an API call, you may pass UpdateSegmentRequest
11304
12764
  # data as a hash:
11305
12765
  #
@@ -11534,6 +12994,46 @@ module Aws::Pinpoint
11534
12994
  include Aws::Structure
11535
12995
  end
11536
12996
 
12997
+ # @note When making an API call, you may pass UpdateSmsTemplateRequest
12998
+ # data as a hash:
12999
+ #
13000
+ # {
13001
+ # sms_template_request: { # required
13002
+ # body: "__string",
13003
+ # tags: {
13004
+ # "__string" => "__string",
13005
+ # },
13006
+ # },
13007
+ # template_name: "__string", # required
13008
+ # }
13009
+ #
13010
+ # @!attribute [rw] sms_template_request
13011
+ # Specifies the content and settings for a message template that can
13012
+ # be used in text messages that are sent through the SMS channel.
13013
+ # @return [Types::SMSTemplateRequest]
13014
+ #
13015
+ # @!attribute [rw] template_name
13016
+ # @return [String]
13017
+ #
13018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsTemplateRequest AWS API Documentation
13019
+ #
13020
+ class UpdateSmsTemplateRequest < Struct.new(
13021
+ :sms_template_request,
13022
+ :template_name)
13023
+ include Aws::Structure
13024
+ end
13025
+
13026
+ # @!attribute [rw] message_body
13027
+ # Provides information about an API request or response.
13028
+ # @return [Types::MessageBody]
13029
+ #
13030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsTemplateResponse AWS API Documentation
13031
+ #
13032
+ class UpdateSmsTemplateResponse < Struct.new(
13033
+ :message_body)
13034
+ include Aws::Structure
13035
+ end
13036
+
11537
13037
  # @note When making an API call, you may pass UpdateVoiceChannelRequest
11538
13038
  # data as a hash:
11539
13039
  #
@@ -11689,10 +13189,11 @@ module Aws::Pinpoint
11689
13189
  # @return [String]
11690
13190
  #
11691
13191
  # @!attribute [rw] origination_number
11692
- # The phone number from the pool or messaging service to send the
11693
- # message from. Although it isn't required, we recommend that you
11694
- # specify the phone number in E.164 format to ensure prompt and
11695
- # accurate delivery.
13192
+ # The long code to send the voice message from. This value should be
13193
+ # one of the dedicated long codes that's assigned to your AWS
13194
+ # account. Although it isn't required, we recommend that you specify
13195
+ # the long code in E.164 format, for example +12065550100, to ensure
13196
+ # prompt and accurate delivery of the message.
11696
13197
  # @return [String]
11697
13198
  #
11698
13199
  # @!attribute [rw] substitutions
@@ -11925,6 +13426,17 @@ module Aws::Pinpoint
11925
13426
  # timezone: "__string",
11926
13427
  # },
11927
13428
  # size_percent: 1, # required
13429
+ # template_configuration: {
13430
+ # email_template: {
13431
+ # name: "__string",
13432
+ # },
13433
+ # push_template: {
13434
+ # name: "__string",
13435
+ # },
13436
+ # sms_template: {
13437
+ # name: "__string",
13438
+ # },
13439
+ # },
11928
13440
  # treatment_description: "__string",
11929
13441
  # treatment_name: "__string",
11930
13442
  # },
@@ -12064,6 +13576,17 @@ module Aws::Pinpoint
12064
13576
  # tags: {
12065
13577
  # "__string" => "__string",
12066
13578
  # },
13579
+ # template_configuration: {
13580
+ # email_template: {
13581
+ # name: "__string",
13582
+ # },
13583
+ # push_template: {
13584
+ # name: "__string",
13585
+ # },
13586
+ # sms_template: {
13587
+ # name: "__string",
13588
+ # },
13589
+ # },
12067
13590
  # treatment_description: "__string",
12068
13591
  # treatment_name: "__string",
12069
13592
  # }
@@ -12123,6 +13646,10 @@ module Aws::Pinpoint
12123
13646
  # and an associated tag value.
12124
13647
  # @return [Hash<String,String>]
12125
13648
  #
13649
+ # @!attribute [rw] template_configuration
13650
+ # The message template to use for the campaign.
13651
+ # @return [Types::TemplateConfiguration]
13652
+ #
12126
13653
  # @!attribute [rw] treatment_description
12127
13654
  # The custom description of a variation of the campaign to use for A/B
12128
13655
  # testing.
@@ -12148,6 +13675,7 @@ module Aws::Pinpoint
12148
13675
  :segment_id,
12149
13676
  :segment_version,
12150
13677
  :tags,
13678
+ :template_configuration,
12151
13679
  :treatment_description,
12152
13680
  :treatment_name)
12153
13681
  include Aws::Structure
@@ -12514,6 +14042,17 @@ module Aws::Pinpoint
12514
14042
  # timezone: "__string",
12515
14043
  # },
12516
14044
  # size_percent: 1, # required
14045
+ # template_configuration: {
14046
+ # email_template: {
14047
+ # name: "__string",
14048
+ # },
14049
+ # push_template: {
14050
+ # name: "__string",
14051
+ # },
14052
+ # sms_template: {
14053
+ # name: "__string",
14054
+ # },
14055
+ # },
12517
14056
  # treatment_description: "__string",
12518
14057
  # treatment_name: "__string",
12519
14058
  # }
@@ -12531,6 +14070,10 @@ module Aws::Pinpoint
12531
14070
  # treatment to.
12532
14071
  # @return [Integer]
12533
14072
  #
14073
+ # @!attribute [rw] template_configuration
14074
+ # The message template to use for the treatment.
14075
+ # @return [Types::TemplateConfiguration]
14076
+ #
12534
14077
  # @!attribute [rw] treatment_description
12535
14078
  # The custom description of the treatment.
12536
14079
  # @return [String]
@@ -12546,6 +14089,7 @@ module Aws::Pinpoint
12546
14089
  :message_configuration,
12547
14090
  :schedule,
12548
14091
  :size_percent,
14092
+ :template_configuration,
12549
14093
  :treatment_description,
12550
14094
  :treatment_name)
12551
14095
  include Aws::Structure