aws-sdk-qconnect 1.42.0 → 1.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +441 -14
- data/lib/aws-sdk-qconnect/client_api.rb +119 -5
- data/lib/aws-sdk-qconnect/types.rb +559 -4
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +144 -3
- data/sig/types.rbs +131 -10
- metadata +3 -3
|
@@ -2854,6 +2854,11 @@ module Aws::QConnect
|
|
|
2854
2854
|
# `zh_CN`, `zh_TW`
|
|
2855
2855
|
# @return [String]
|
|
2856
2856
|
#
|
|
2857
|
+
# @!attribute [rw] source_configuration
|
|
2858
|
+
# The source configuration of the message template. Only set this
|
|
2859
|
+
# argument for WHATSAPP channel subtype.
|
|
2860
|
+
# @return [Types::MessageTemplateSourceConfiguration]
|
|
2861
|
+
#
|
|
2857
2862
|
# @!attribute [rw] default_attributes
|
|
2858
2863
|
# An object that specifies the default values to use for variables in
|
|
2859
2864
|
# the message template. This object contains different categories of
|
|
@@ -2895,6 +2900,7 @@ module Aws::QConnect
|
|
|
2895
2900
|
:description,
|
|
2896
2901
|
:channel_subtype,
|
|
2897
2902
|
:language,
|
|
2903
|
+
:source_configuration,
|
|
2898
2904
|
:default_attributes,
|
|
2899
2905
|
:grouping_configuration,
|
|
2900
2906
|
:client_token,
|
|
@@ -4258,6 +4264,10 @@ module Aws::QConnect
|
|
|
4258
4264
|
# The name of the message template.
|
|
4259
4265
|
# @return [String]
|
|
4260
4266
|
#
|
|
4267
|
+
# @!attribute [rw] channel
|
|
4268
|
+
# The channel of the message template.
|
|
4269
|
+
# @return [String]
|
|
4270
|
+
#
|
|
4261
4271
|
# @!attribute [rw] channel_subtype
|
|
4262
4272
|
# The channel subtype this message template applies to.
|
|
4263
4273
|
# @return [String]
|
|
@@ -4290,6 +4300,10 @@ module Aws::QConnect
|
|
|
4290
4300
|
# `zh_CN`, `zh_TW`
|
|
4291
4301
|
# @return [String]
|
|
4292
4302
|
#
|
|
4303
|
+
# @!attribute [rw] source_configuration_summary
|
|
4304
|
+
# The source configuration summary of the message template.
|
|
4305
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
4306
|
+
#
|
|
4293
4307
|
# @!attribute [rw] grouping_configuration
|
|
4294
4308
|
# The configuration information of the grouping of Amazon Q in Connect
|
|
4295
4309
|
# users.
|
|
@@ -4340,6 +4354,7 @@ module Aws::QConnect
|
|
|
4340
4354
|
:knowledge_base_arn,
|
|
4341
4355
|
:knowledge_base_id,
|
|
4342
4356
|
:name,
|
|
4357
|
+
:channel,
|
|
4343
4358
|
:channel_subtype,
|
|
4344
4359
|
:created_time,
|
|
4345
4360
|
:last_modified_time,
|
|
@@ -4347,6 +4362,7 @@ module Aws::QConnect
|
|
|
4347
4362
|
:content,
|
|
4348
4363
|
:description,
|
|
4349
4364
|
:language,
|
|
4365
|
+
:source_configuration_summary,
|
|
4350
4366
|
:grouping_configuration,
|
|
4351
4367
|
:default_attributes,
|
|
4352
4368
|
:attribute_types,
|
|
@@ -4355,7 +4371,7 @@ module Aws::QConnect
|
|
|
4355
4371
|
:version_number,
|
|
4356
4372
|
:message_template_content_sha_256,
|
|
4357
4373
|
:tags)
|
|
4358
|
-
SENSITIVE = []
|
|
4374
|
+
SENSITIVE = [:channel]
|
|
4359
4375
|
include Aws::Structure
|
|
4360
4376
|
end
|
|
4361
4377
|
|
|
@@ -6981,11 +6997,23 @@ module Aws::QConnect
|
|
|
6981
6997
|
# subtype.
|
|
6982
6998
|
# @return [Types::SMSMessageTemplateContent]
|
|
6983
6999
|
#
|
|
7000
|
+
# @!attribute [rw] whats_app
|
|
7001
|
+
# The content of the message template that applies to the WHATSAPP
|
|
7002
|
+
# channel subtype.
|
|
7003
|
+
# @return [Types::WhatsAppMessageTemplateContent]
|
|
7004
|
+
#
|
|
7005
|
+
# @!attribute [rw] push
|
|
7006
|
+
# The content of the message template that applies to the push channel
|
|
7007
|
+
# subtype.
|
|
7008
|
+
# @return [Types::PushMessageTemplateContent]
|
|
7009
|
+
#
|
|
6984
7010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateContentProvider AWS API Documentation
|
|
6985
7011
|
#
|
|
6986
7012
|
class MessageTemplateContentProvider < Struct.new(
|
|
6987
7013
|
:email,
|
|
6988
7014
|
:sms,
|
|
7015
|
+
:whats_app,
|
|
7016
|
+
:push,
|
|
6989
7017
|
:unknown)
|
|
6990
7018
|
SENSITIVE = []
|
|
6991
7019
|
include Aws::Structure
|
|
@@ -6993,6 +7021,8 @@ module Aws::QConnect
|
|
|
6993
7021
|
|
|
6994
7022
|
class Email < MessageTemplateContentProvider; end
|
|
6995
7023
|
class Sms < MessageTemplateContentProvider; end
|
|
7024
|
+
class WhatsApp < MessageTemplateContentProvider; end
|
|
7025
|
+
class Push < MessageTemplateContentProvider; end
|
|
6996
7026
|
class Unknown < MessageTemplateContentProvider; end
|
|
6997
7027
|
end
|
|
6998
7028
|
|
|
@@ -7018,6 +7048,10 @@ module Aws::QConnect
|
|
|
7018
7048
|
# The name of the message template.
|
|
7019
7049
|
# @return [String]
|
|
7020
7050
|
#
|
|
7051
|
+
# @!attribute [rw] channel
|
|
7052
|
+
# The channel of the message template.
|
|
7053
|
+
# @return [String]
|
|
7054
|
+
#
|
|
7021
7055
|
# @!attribute [rw] channel_subtype
|
|
7022
7056
|
# The channel subtype this message template applies to.
|
|
7023
7057
|
# @return [String]
|
|
@@ -7050,6 +7084,10 @@ module Aws::QConnect
|
|
|
7050
7084
|
# `zh_CN`, `zh_TW`
|
|
7051
7085
|
# @return [String]
|
|
7052
7086
|
#
|
|
7087
|
+
# @!attribute [rw] source_configuration_summary
|
|
7088
|
+
# The source configuration summary of the message template.
|
|
7089
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
7090
|
+
#
|
|
7053
7091
|
# @!attribute [rw] grouping_configuration
|
|
7054
7092
|
# The configuration information of the grouping of Amazon Q in Connect
|
|
7055
7093
|
# users.
|
|
@@ -7088,6 +7126,7 @@ module Aws::QConnect
|
|
|
7088
7126
|
:knowledge_base_arn,
|
|
7089
7127
|
:knowledge_base_id,
|
|
7090
7128
|
:name,
|
|
7129
|
+
:channel,
|
|
7091
7130
|
:channel_subtype,
|
|
7092
7131
|
:created_time,
|
|
7093
7132
|
:last_modified_time,
|
|
@@ -7095,12 +7134,13 @@ module Aws::QConnect
|
|
|
7095
7134
|
:content,
|
|
7096
7135
|
:description,
|
|
7097
7136
|
:language,
|
|
7137
|
+
:source_configuration_summary,
|
|
7098
7138
|
:grouping_configuration,
|
|
7099
7139
|
:default_attributes,
|
|
7100
7140
|
:attribute_types,
|
|
7101
7141
|
:message_template_content_sha_256,
|
|
7102
7142
|
:tags)
|
|
7103
|
-
SENSITIVE = []
|
|
7143
|
+
SENSITIVE = [:channel]
|
|
7104
7144
|
include Aws::Structure
|
|
7105
7145
|
end
|
|
7106
7146
|
|
|
@@ -7290,6 +7330,10 @@ module Aws::QConnect
|
|
|
7290
7330
|
# The name of the message template.
|
|
7291
7331
|
# @return [String]
|
|
7292
7332
|
#
|
|
7333
|
+
# @!attribute [rw] channel
|
|
7334
|
+
# The channel of the message template.
|
|
7335
|
+
# @return [String]
|
|
7336
|
+
#
|
|
7293
7337
|
# @!attribute [rw] channel_subtype
|
|
7294
7338
|
# The channel subtype this message template applies to.
|
|
7295
7339
|
# @return [String]
|
|
@@ -7319,6 +7363,10 @@ module Aws::QConnect
|
|
|
7319
7363
|
# The description of the message template.
|
|
7320
7364
|
# @return [String]
|
|
7321
7365
|
#
|
|
7366
|
+
# @!attribute [rw] source_configuration_summary
|
|
7367
|
+
# The source configuration summary of the message template.
|
|
7368
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
7369
|
+
#
|
|
7322
7370
|
# @!attribute [rw] grouping_configuration
|
|
7323
7371
|
# The configuration information of the grouping of Amazon Q in Connect
|
|
7324
7372
|
# users.
|
|
@@ -7344,6 +7392,7 @@ module Aws::QConnect
|
|
|
7344
7392
|
:knowledge_base_arn,
|
|
7345
7393
|
:knowledge_base_id,
|
|
7346
7394
|
:name,
|
|
7395
|
+
:channel,
|
|
7347
7396
|
:channel_subtype,
|
|
7348
7397
|
:created_time,
|
|
7349
7398
|
:last_modified_time,
|
|
@@ -7351,11 +7400,58 @@ module Aws::QConnect
|
|
|
7351
7400
|
:is_active,
|
|
7352
7401
|
:version_number,
|
|
7353
7402
|
:description,
|
|
7403
|
+
:source_configuration_summary,
|
|
7354
7404
|
:grouping_configuration,
|
|
7355
7405
|
:language,
|
|
7356
7406
|
:tags)
|
|
7407
|
+
SENSITIVE = [:channel]
|
|
7408
|
+
include Aws::Structure
|
|
7409
|
+
end
|
|
7410
|
+
|
|
7411
|
+
# The container of message template source configuration.
|
|
7412
|
+
#
|
|
7413
|
+
# @note MessageTemplateSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
|
|
7414
|
+
#
|
|
7415
|
+
# @note MessageTemplateSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateSourceConfiguration corresponding to the set member.
|
|
7416
|
+
#
|
|
7417
|
+
# @!attribute [rw] whats_app
|
|
7418
|
+
# The sourceConfiguration of the message template that applies to the
|
|
7419
|
+
# WHATSAPP channel subtype.
|
|
7420
|
+
# @return [Types::WhatsAppMessageTemplateSourceConfiguration]
|
|
7421
|
+
#
|
|
7422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSourceConfiguration AWS API Documentation
|
|
7423
|
+
#
|
|
7424
|
+
class MessageTemplateSourceConfiguration < Struct.new(
|
|
7425
|
+
:whats_app,
|
|
7426
|
+
:unknown)
|
|
7427
|
+
SENSITIVE = []
|
|
7428
|
+
include Aws::Structure
|
|
7429
|
+
include Aws::Structure::Union
|
|
7430
|
+
|
|
7431
|
+
class WhatsApp < MessageTemplateSourceConfiguration; end
|
|
7432
|
+
class Unknown < MessageTemplateSourceConfiguration; end
|
|
7433
|
+
end
|
|
7434
|
+
|
|
7435
|
+
# The container of message template source configuration summary.
|
|
7436
|
+
#
|
|
7437
|
+
# @note MessageTemplateSourceConfigurationSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateSourceConfigurationSummary corresponding to the set member.
|
|
7438
|
+
#
|
|
7439
|
+
# @!attribute [rw] whats_app
|
|
7440
|
+
# The sourceConfiguration summary of the message template that applies
|
|
7441
|
+
# to the WHATSAPP channel subtype.
|
|
7442
|
+
# @return [Types::WhatsAppMessageTemplateSourceConfigurationSummary]
|
|
7443
|
+
#
|
|
7444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSourceConfigurationSummary AWS API Documentation
|
|
7445
|
+
#
|
|
7446
|
+
class MessageTemplateSourceConfigurationSummary < Struct.new(
|
|
7447
|
+
:whats_app,
|
|
7448
|
+
:unknown)
|
|
7357
7449
|
SENSITIVE = []
|
|
7358
7450
|
include Aws::Structure
|
|
7451
|
+
include Aws::Structure::Union
|
|
7452
|
+
|
|
7453
|
+
class WhatsApp < MessageTemplateSourceConfigurationSummary; end
|
|
7454
|
+
class Unknown < MessageTemplateSourceConfigurationSummary; end
|
|
7359
7455
|
end
|
|
7360
7456
|
|
|
7361
7457
|
# The summary of the message template.
|
|
@@ -7380,6 +7476,10 @@ module Aws::QConnect
|
|
|
7380
7476
|
# The name of the message template.
|
|
7381
7477
|
# @return [String]
|
|
7382
7478
|
#
|
|
7479
|
+
# @!attribute [rw] channel
|
|
7480
|
+
# The channel this message template applies to.
|
|
7481
|
+
# @return [String]
|
|
7482
|
+
#
|
|
7383
7483
|
# @!attribute [rw] channel_subtype
|
|
7384
7484
|
# The channel subtype this message template applies to.
|
|
7385
7485
|
# @return [String]
|
|
@@ -7397,6 +7497,10 @@ module Aws::QConnect
|
|
|
7397
7497
|
# message template data.
|
|
7398
7498
|
# @return [String]
|
|
7399
7499
|
#
|
|
7500
|
+
# @!attribute [rw] source_configuration
|
|
7501
|
+
# The container of message template source configuration.
|
|
7502
|
+
# @return [Types::MessageTemplateSourceConfiguration]
|
|
7503
|
+
#
|
|
7400
7504
|
# @!attribute [rw] active_version_number
|
|
7401
7505
|
# The version number of the message template version that is
|
|
7402
7506
|
# activated.
|
|
@@ -7419,14 +7523,16 @@ module Aws::QConnect
|
|
|
7419
7523
|
:knowledge_base_arn,
|
|
7420
7524
|
:knowledge_base_id,
|
|
7421
7525
|
:name,
|
|
7526
|
+
:channel,
|
|
7422
7527
|
:channel_subtype,
|
|
7423
7528
|
:created_time,
|
|
7424
7529
|
:last_modified_time,
|
|
7425
7530
|
:last_modified_by,
|
|
7531
|
+
:source_configuration,
|
|
7426
7532
|
:active_version_number,
|
|
7427
7533
|
:description,
|
|
7428
7534
|
:tags)
|
|
7429
|
-
SENSITIVE = []
|
|
7535
|
+
SENSITIVE = [:channel]
|
|
7430
7536
|
include Aws::Structure
|
|
7431
7537
|
end
|
|
7432
7538
|
|
|
@@ -7452,6 +7558,10 @@ module Aws::QConnect
|
|
|
7452
7558
|
# The name of the message template.
|
|
7453
7559
|
# @return [String]
|
|
7454
7560
|
#
|
|
7561
|
+
# @!attribute [rw] channel
|
|
7562
|
+
# The channel of the message template.
|
|
7563
|
+
# @return [String]
|
|
7564
|
+
#
|
|
7455
7565
|
# @!attribute [rw] channel_subtype
|
|
7456
7566
|
# The channel subtype this message template applies to.
|
|
7457
7567
|
# @return [String]
|
|
@@ -7472,10 +7582,11 @@ module Aws::QConnect
|
|
|
7472
7582
|
:knowledge_base_arn,
|
|
7473
7583
|
:knowledge_base_id,
|
|
7474
7584
|
:name,
|
|
7585
|
+
:channel,
|
|
7475
7586
|
:channel_subtype,
|
|
7476
7587
|
:is_active,
|
|
7477
7588
|
:version_number)
|
|
7478
|
-
SENSITIVE = []
|
|
7589
|
+
SENSITIVE = [:channel]
|
|
7479
7590
|
include Aws::Structure
|
|
7480
7591
|
end
|
|
7481
7592
|
|
|
@@ -7622,6 +7733,352 @@ module Aws::QConnect
|
|
|
7622
7733
|
include Aws::Structure
|
|
7623
7734
|
end
|
|
7624
7735
|
|
|
7736
|
+
# The content of the push message template that applies to ADM (Amazon
|
|
7737
|
+
# Device Messaging) notification service.
|
|
7738
|
+
#
|
|
7739
|
+
# @!attribute [rw] title
|
|
7740
|
+
# The title to use in a push notification that's based on the message
|
|
7741
|
+
# template. This title appears above the notification message on a
|
|
7742
|
+
# recipient's device.
|
|
7743
|
+
# @return [String]
|
|
7744
|
+
#
|
|
7745
|
+
# @!attribute [rw] body
|
|
7746
|
+
# The message body to use in a push notification that is based on the
|
|
7747
|
+
# message template.
|
|
7748
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7749
|
+
#
|
|
7750
|
+
# @!attribute [rw] action
|
|
7751
|
+
# The action to occur if a recipient taps a push notification that is
|
|
7752
|
+
# based on the message template. Valid values are:
|
|
7753
|
+
#
|
|
7754
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
7755
|
+
# was sent to the background. This is the default action.
|
|
7756
|
+
#
|
|
7757
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
7758
|
+
# interface in the app. This action uses the deep-linking features
|
|
7759
|
+
# of the Android platform.
|
|
7760
|
+
#
|
|
7761
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
7762
|
+
# opens and loads the web page at a URL that you specify.
|
|
7763
|
+
# @return [String]
|
|
7764
|
+
#
|
|
7765
|
+
# @!attribute [rw] sound
|
|
7766
|
+
# The sound to play when a recipient receives a push notification
|
|
7767
|
+
# that's based on the message template. You can use the default
|
|
7768
|
+
# stream or specify the file name of a sound resource that's bundled
|
|
7769
|
+
# in your app. On an Android platform, the sound file must reside in
|
|
7770
|
+
# `/res/raw/`.
|
|
7771
|
+
# @return [String]
|
|
7772
|
+
#
|
|
7773
|
+
# @!attribute [rw] url
|
|
7774
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
7775
|
+
# recipient taps a push notification that's based on the message
|
|
7776
|
+
# template and the value of the `action` property is `URL`.
|
|
7777
|
+
# @return [String]
|
|
7778
|
+
#
|
|
7779
|
+
# @!attribute [rw] image_url
|
|
7780
|
+
# The URL of an image to display in a push notification that's based
|
|
7781
|
+
# on the message template.
|
|
7782
|
+
# @return [String]
|
|
7783
|
+
#
|
|
7784
|
+
# @!attribute [rw] image_icon_url
|
|
7785
|
+
# The URL of the large icon image to display in the content view of a
|
|
7786
|
+
# push notification that's based on the message template.
|
|
7787
|
+
# @return [String]
|
|
7788
|
+
#
|
|
7789
|
+
# @!attribute [rw] small_image_icon_url
|
|
7790
|
+
# The URL of the small icon image to display in the status bar and the
|
|
7791
|
+
# content view of a push notification that's based on the message
|
|
7792
|
+
# template.
|
|
7793
|
+
# @return [String]
|
|
7794
|
+
#
|
|
7795
|
+
# @!attribute [rw] raw_content
|
|
7796
|
+
# The URL of the small icon image to display in the status bar and the
|
|
7797
|
+
# content view of a push notification that's based on the message
|
|
7798
|
+
# template.
|
|
7799
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7800
|
+
#
|
|
7801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushADMMessageTemplateContent AWS API Documentation
|
|
7802
|
+
#
|
|
7803
|
+
class PushADMMessageTemplateContent < Struct.new(
|
|
7804
|
+
:title,
|
|
7805
|
+
:body,
|
|
7806
|
+
:action,
|
|
7807
|
+
:sound,
|
|
7808
|
+
:url,
|
|
7809
|
+
:image_url,
|
|
7810
|
+
:image_icon_url,
|
|
7811
|
+
:small_image_icon_url,
|
|
7812
|
+
:raw_content)
|
|
7813
|
+
SENSITIVE = [:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]
|
|
7814
|
+
include Aws::Structure
|
|
7815
|
+
end
|
|
7816
|
+
|
|
7817
|
+
# The content of the push message template that applies to APNS (Apple
|
|
7818
|
+
# Push Notification service) notification service.
|
|
7819
|
+
#
|
|
7820
|
+
# @!attribute [rw] title
|
|
7821
|
+
# The title to use in a push notification that's based on the message
|
|
7822
|
+
# template. This title appears above the notification message on a
|
|
7823
|
+
# recipient's device.
|
|
7824
|
+
# @return [String]
|
|
7825
|
+
#
|
|
7826
|
+
# @!attribute [rw] body
|
|
7827
|
+
# The message body to use in a push notification that is based on the
|
|
7828
|
+
# message template.
|
|
7829
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7830
|
+
#
|
|
7831
|
+
# @!attribute [rw] action
|
|
7832
|
+
# The action to occur if a recipient taps a push notification that is
|
|
7833
|
+
# based on the message template. Valid values are:
|
|
7834
|
+
#
|
|
7835
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
7836
|
+
# was sent to the background. This is the default action.
|
|
7837
|
+
#
|
|
7838
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
7839
|
+
# interface in the app. This action uses the deep-linking features
|
|
7840
|
+
# of the iOS platform.
|
|
7841
|
+
#
|
|
7842
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
7843
|
+
# opens and loads the web page at a URL that you specify.
|
|
7844
|
+
# @return [String]
|
|
7845
|
+
#
|
|
7846
|
+
# @!attribute [rw] sound
|
|
7847
|
+
# The key for the sound to play when the recipient receives a push
|
|
7848
|
+
# notification that's based on the message template. The value for
|
|
7849
|
+
# this key is the name of a sound file in your app's main bundle or
|
|
7850
|
+
# the `Library/Sounds` folder in your app's data container. If the
|
|
7851
|
+
# sound file can't be found or you specify `default` for the value,
|
|
7852
|
+
# the system plays the default alert sound.
|
|
7853
|
+
# @return [String]
|
|
7854
|
+
#
|
|
7855
|
+
# @!attribute [rw] url
|
|
7856
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
7857
|
+
# recipient taps a push notification that's based on the message
|
|
7858
|
+
# template and the value of the `action` property is `URL`.
|
|
7859
|
+
# @return [String]
|
|
7860
|
+
#
|
|
7861
|
+
# @!attribute [rw] media_url
|
|
7862
|
+
# The URL of an image or video to display in push notifications that
|
|
7863
|
+
# are based on the message template.
|
|
7864
|
+
# @return [String]
|
|
7865
|
+
#
|
|
7866
|
+
# @!attribute [rw] raw_content
|
|
7867
|
+
# The raw, JSON-formatted string to use as the payload for a push
|
|
7868
|
+
# notification that's based on the message template. If specified,
|
|
7869
|
+
# this value overrides all other content for the message template.
|
|
7870
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7871
|
+
#
|
|
7872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushAPNSMessageTemplateContent AWS API Documentation
|
|
7873
|
+
#
|
|
7874
|
+
class PushAPNSMessageTemplateContent < Struct.new(
|
|
7875
|
+
:title,
|
|
7876
|
+
:body,
|
|
7877
|
+
:action,
|
|
7878
|
+
:sound,
|
|
7879
|
+
:url,
|
|
7880
|
+
:media_url,
|
|
7881
|
+
:raw_content)
|
|
7882
|
+
SENSITIVE = [:title, :sound, :url, :media_url]
|
|
7883
|
+
include Aws::Structure
|
|
7884
|
+
end
|
|
7885
|
+
|
|
7886
|
+
# The content of the push message template that applies to Baidu
|
|
7887
|
+
# notification service.
|
|
7888
|
+
#
|
|
7889
|
+
# @!attribute [rw] title
|
|
7890
|
+
# The title to use in a push notification that's based on the message
|
|
7891
|
+
# template. This title appears above the notification message on a
|
|
7892
|
+
# recipient's device.
|
|
7893
|
+
# @return [String]
|
|
7894
|
+
#
|
|
7895
|
+
# @!attribute [rw] body
|
|
7896
|
+
# The message body to use in a push notification that is based on the
|
|
7897
|
+
# message template.
|
|
7898
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7899
|
+
#
|
|
7900
|
+
# @!attribute [rw] action
|
|
7901
|
+
# The action to occur if a recipient taps a push notification that is
|
|
7902
|
+
# based on the message template. Valid values are:
|
|
7903
|
+
#
|
|
7904
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
7905
|
+
# was sent to the background. This is the default action.
|
|
7906
|
+
#
|
|
7907
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
7908
|
+
# interface in the app. This action uses the deep-linking features
|
|
7909
|
+
# of the Android platform.
|
|
7910
|
+
#
|
|
7911
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
7912
|
+
# opens and loads the web page at a URL that you specify.
|
|
7913
|
+
# @return [String]
|
|
7914
|
+
#
|
|
7915
|
+
# @!attribute [rw] sound
|
|
7916
|
+
# The sound to play when a recipient receives a push notification
|
|
7917
|
+
# that's based on the message template. You can use the default
|
|
7918
|
+
# stream or specify the file name of a sound resource that's bundled
|
|
7919
|
+
# in your app. On an Android platform, the sound file must reside in
|
|
7920
|
+
# `/res/raw/`.
|
|
7921
|
+
# @return [String]
|
|
7922
|
+
#
|
|
7923
|
+
# @!attribute [rw] url
|
|
7924
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
7925
|
+
# recipient taps a push notification that's based on the message
|
|
7926
|
+
# template and the value of the `action` property is `URL`.
|
|
7927
|
+
# @return [String]
|
|
7928
|
+
#
|
|
7929
|
+
# @!attribute [rw] image_url
|
|
7930
|
+
# The URL of an image to display in a push notification that's based
|
|
7931
|
+
# on the message template.
|
|
7932
|
+
# @return [String]
|
|
7933
|
+
#
|
|
7934
|
+
# @!attribute [rw] image_icon_url
|
|
7935
|
+
# The URL of the large icon image to display in the content view of a
|
|
7936
|
+
# push notification that's based on the message template.
|
|
7937
|
+
# @return [String]
|
|
7938
|
+
#
|
|
7939
|
+
# @!attribute [rw] small_image_icon_url
|
|
7940
|
+
# The URL of the small icon image to display in the status bar and the
|
|
7941
|
+
# content view of a push notification that's based on the message
|
|
7942
|
+
# template.
|
|
7943
|
+
# @return [String]
|
|
7944
|
+
#
|
|
7945
|
+
# @!attribute [rw] raw_content
|
|
7946
|
+
# The URL of the small icon image to display in the status bar and the
|
|
7947
|
+
# content view of a push notification that's based on the message
|
|
7948
|
+
# template.
|
|
7949
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7950
|
+
#
|
|
7951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushBaiduMessageTemplateContent AWS API Documentation
|
|
7952
|
+
#
|
|
7953
|
+
class PushBaiduMessageTemplateContent < Struct.new(
|
|
7954
|
+
:title,
|
|
7955
|
+
:body,
|
|
7956
|
+
:action,
|
|
7957
|
+
:sound,
|
|
7958
|
+
:url,
|
|
7959
|
+
:image_url,
|
|
7960
|
+
:image_icon_url,
|
|
7961
|
+
:small_image_icon_url,
|
|
7962
|
+
:raw_content)
|
|
7963
|
+
SENSITIVE = [:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]
|
|
7964
|
+
include Aws::Structure
|
|
7965
|
+
end
|
|
7966
|
+
|
|
7967
|
+
# The content of the push message template that applies to FCM (Firebase
|
|
7968
|
+
# Cloud Messaging) notification service.
|
|
7969
|
+
#
|
|
7970
|
+
# @!attribute [rw] title
|
|
7971
|
+
# The title to use in a push notification that's based on the message
|
|
7972
|
+
# template. This title appears above the notification message on a
|
|
7973
|
+
# recipient's device.
|
|
7974
|
+
# @return [String]
|
|
7975
|
+
#
|
|
7976
|
+
# @!attribute [rw] body
|
|
7977
|
+
# The message body to use in a push notification that is based on the
|
|
7978
|
+
# message template.
|
|
7979
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
7980
|
+
#
|
|
7981
|
+
# @!attribute [rw] action
|
|
7982
|
+
# The action to occur if a recipient taps a push notification that is
|
|
7983
|
+
# based on the message template. Valid values are:
|
|
7984
|
+
#
|
|
7985
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
7986
|
+
# was sent to the background. This is the default action.
|
|
7987
|
+
#
|
|
7988
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
7989
|
+
# interface in the app. This action uses the deep-linking features
|
|
7990
|
+
# of the Android platform.
|
|
7991
|
+
#
|
|
7992
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
7993
|
+
# opens and loads the web page at a URL that you specify.
|
|
7994
|
+
# @return [String]
|
|
7995
|
+
#
|
|
7996
|
+
# @!attribute [rw] sound
|
|
7997
|
+
# The sound to play when a recipient receives a push notification
|
|
7998
|
+
# that's based on the message template. You can use the default
|
|
7999
|
+
# stream or specify the file name of a sound resource that's bundled
|
|
8000
|
+
# in your app. On an Android platform, the sound file must reside in
|
|
8001
|
+
# `/res/raw/`.
|
|
8002
|
+
# @return [String]
|
|
8003
|
+
#
|
|
8004
|
+
# @!attribute [rw] url
|
|
8005
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
8006
|
+
# recipient taps a push notification that's based on the message
|
|
8007
|
+
# template and the value of the `action` property is `URL`.
|
|
8008
|
+
# @return [String]
|
|
8009
|
+
#
|
|
8010
|
+
# @!attribute [rw] image_url
|
|
8011
|
+
# The URL of an image to display in a push notification that's based
|
|
8012
|
+
# on the message template.
|
|
8013
|
+
# @return [String]
|
|
8014
|
+
#
|
|
8015
|
+
# @!attribute [rw] image_icon_url
|
|
8016
|
+
# The URL of the large icon image to display in the content view of a
|
|
8017
|
+
# push notification that's based on the message template.
|
|
8018
|
+
# @return [String]
|
|
8019
|
+
#
|
|
8020
|
+
# @!attribute [rw] small_image_icon_url
|
|
8021
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8022
|
+
# content view of a push notification that's based on the message
|
|
8023
|
+
# template.
|
|
8024
|
+
# @return [String]
|
|
8025
|
+
#
|
|
8026
|
+
# @!attribute [rw] raw_content
|
|
8027
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8028
|
+
# content view of a push notification that's based on the message
|
|
8029
|
+
# template.
|
|
8030
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8031
|
+
#
|
|
8032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushFCMMessageTemplateContent AWS API Documentation
|
|
8033
|
+
#
|
|
8034
|
+
class PushFCMMessageTemplateContent < Struct.new(
|
|
8035
|
+
:title,
|
|
8036
|
+
:body,
|
|
8037
|
+
:action,
|
|
8038
|
+
:sound,
|
|
8039
|
+
:url,
|
|
8040
|
+
:image_url,
|
|
8041
|
+
:image_icon_url,
|
|
8042
|
+
:small_image_icon_url,
|
|
8043
|
+
:raw_content)
|
|
8044
|
+
SENSITIVE = [:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]
|
|
8045
|
+
include Aws::Structure
|
|
8046
|
+
end
|
|
8047
|
+
|
|
8048
|
+
# The content of the message template that applies to the push channel
|
|
8049
|
+
# subtype.
|
|
8050
|
+
#
|
|
8051
|
+
# @!attribute [rw] adm
|
|
8052
|
+
# The content of the message template that applies to ADM (Amazon
|
|
8053
|
+
# Device Messaging) notification service.
|
|
8054
|
+
# @return [Types::PushADMMessageTemplateContent]
|
|
8055
|
+
#
|
|
8056
|
+
# @!attribute [rw] apns
|
|
8057
|
+
# The content of the message template that applies to APNS(Apple Push
|
|
8058
|
+
# Notification service) notification service.
|
|
8059
|
+
# @return [Types::PushAPNSMessageTemplateContent]
|
|
8060
|
+
#
|
|
8061
|
+
# @!attribute [rw] fcm
|
|
8062
|
+
# The content of the message template that applies to FCM (Firebase
|
|
8063
|
+
# Cloud Messaging) notification service.
|
|
8064
|
+
# @return [Types::PushFCMMessageTemplateContent]
|
|
8065
|
+
#
|
|
8066
|
+
# @!attribute [rw] baidu
|
|
8067
|
+
# The content of the message template that applies to Baidu
|
|
8068
|
+
# notification service.
|
|
8069
|
+
# @return [Types::PushBaiduMessageTemplateContent]
|
|
8070
|
+
#
|
|
8071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushMessageTemplateContent AWS API Documentation
|
|
8072
|
+
#
|
|
8073
|
+
class PushMessageTemplateContent < Struct.new(
|
|
8074
|
+
:adm,
|
|
8075
|
+
:apns,
|
|
8076
|
+
:fcm,
|
|
8077
|
+
:baidu)
|
|
8078
|
+
SENSITIVE = []
|
|
8079
|
+
include Aws::Structure
|
|
8080
|
+
end
|
|
8081
|
+
|
|
7625
8082
|
# @!attribute [rw] assistant_id
|
|
7626
8083
|
# The identifier of the Amazon Q in Connect assistant.
|
|
7627
8084
|
# @return [String]
|
|
@@ -8611,6 +9068,10 @@ module Aws::QConnect
|
|
|
8611
9068
|
# The content of the message template.
|
|
8612
9069
|
# @return [Types::MessageTemplateContentProvider]
|
|
8613
9070
|
#
|
|
9071
|
+
# @!attribute [rw] source_configuration_summary
|
|
9072
|
+
# The source configuration of the message template.
|
|
9073
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
9074
|
+
#
|
|
8614
9075
|
# @!attribute [rw] attributes_not_interpolated
|
|
8615
9076
|
# The attribute keys that are not resolved.
|
|
8616
9077
|
# @return [Array<String>]
|
|
@@ -8623,6 +9084,7 @@ module Aws::QConnect
|
|
|
8623
9084
|
#
|
|
8624
9085
|
class RenderMessageTemplateResponse < Struct.new(
|
|
8625
9086
|
:content,
|
|
9087
|
+
:source_configuration_summary,
|
|
8626
9088
|
:attributes_not_interpolated,
|
|
8627
9089
|
:attachments)
|
|
8628
9090
|
SENSITIVE = [:attributes_not_interpolated]
|
|
@@ -10199,6 +10661,11 @@ module Aws::QConnect
|
|
|
10199
10661
|
# `zh_CN`, `zh_TW`
|
|
10200
10662
|
# @return [String]
|
|
10201
10663
|
#
|
|
10664
|
+
# @!attribute [rw] source_configuration
|
|
10665
|
+
# The source configuration of the message template. Only set this
|
|
10666
|
+
# argument for WHATSAPP channel subtype.
|
|
10667
|
+
# @return [Types::MessageTemplateSourceConfiguration]
|
|
10668
|
+
#
|
|
10202
10669
|
# @!attribute [rw] default_attributes
|
|
10203
10670
|
# An object that specifies the default values to use for variables in
|
|
10204
10671
|
# the message template. This object contains different categories of
|
|
@@ -10214,6 +10681,7 @@ module Aws::QConnect
|
|
|
10214
10681
|
:message_template_id,
|
|
10215
10682
|
:content,
|
|
10216
10683
|
:language,
|
|
10684
|
+
:source_configuration,
|
|
10217
10685
|
:default_attributes)
|
|
10218
10686
|
SENSITIVE = []
|
|
10219
10687
|
include Aws::Structure
|
|
@@ -10548,6 +11016,93 @@ module Aws::QConnect
|
|
|
10548
11016
|
include Aws::Structure
|
|
10549
11017
|
end
|
|
10550
11018
|
|
|
11019
|
+
# The content of the message template that applies to the WHATSAPP
|
|
11020
|
+
# channel subtype.
|
|
11021
|
+
#
|
|
11022
|
+
# @!attribute [rw] data
|
|
11023
|
+
# The data.
|
|
11024
|
+
# @return [String]
|
|
11025
|
+
#
|
|
11026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WhatsAppMessageTemplateContent AWS API Documentation
|
|
11027
|
+
#
|
|
11028
|
+
class WhatsAppMessageTemplateContent < Struct.new(
|
|
11029
|
+
:data)
|
|
11030
|
+
SENSITIVE = []
|
|
11031
|
+
include Aws::Structure
|
|
11032
|
+
end
|
|
11033
|
+
|
|
11034
|
+
# Configuration information about the external data source.
|
|
11035
|
+
#
|
|
11036
|
+
# @!attribute [rw] business_account_id
|
|
11037
|
+
# The ID of the End User Messaging WhatsApp Business Account to
|
|
11038
|
+
# associate with this template.
|
|
11039
|
+
# @return [String]
|
|
11040
|
+
#
|
|
11041
|
+
# @!attribute [rw] template_id
|
|
11042
|
+
# The WhatsApp template ID.
|
|
11043
|
+
# @return [String]
|
|
11044
|
+
#
|
|
11045
|
+
# @!attribute [rw] components
|
|
11046
|
+
# The list of component mapping from WhatsApp template parameters to
|
|
11047
|
+
# Message Template attributes.
|
|
11048
|
+
# @return [Array<String>]
|
|
11049
|
+
#
|
|
11050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfiguration AWS API Documentation
|
|
11051
|
+
#
|
|
11052
|
+
class WhatsAppMessageTemplateSourceConfiguration < Struct.new(
|
|
11053
|
+
:business_account_id,
|
|
11054
|
+
:template_id,
|
|
11055
|
+
:components)
|
|
11056
|
+
SENSITIVE = []
|
|
11057
|
+
include Aws::Structure
|
|
11058
|
+
end
|
|
11059
|
+
|
|
11060
|
+
# Configuration information about the external data source.
|
|
11061
|
+
#
|
|
11062
|
+
# @!attribute [rw] business_account_id
|
|
11063
|
+
# The ID of the End User Messaging WhatsApp Business Account to
|
|
11064
|
+
# associate with this template.
|
|
11065
|
+
# @return [String]
|
|
11066
|
+
#
|
|
11067
|
+
# @!attribute [rw] template_id
|
|
11068
|
+
# The ID of WhatsApp template.
|
|
11069
|
+
# @return [String]
|
|
11070
|
+
#
|
|
11071
|
+
# @!attribute [rw] name
|
|
11072
|
+
# The name of the WhatsApp template.
|
|
11073
|
+
# @return [String]
|
|
11074
|
+
#
|
|
11075
|
+
# @!attribute [rw] language
|
|
11076
|
+
# The language of the WhatsApp template.
|
|
11077
|
+
# @return [String]
|
|
11078
|
+
#
|
|
11079
|
+
# @!attribute [rw] components
|
|
11080
|
+
# The list of component mapping from WhatsApp template parameters to
|
|
11081
|
+
# Message Template attributes.
|
|
11082
|
+
# @return [Array<String>]
|
|
11083
|
+
#
|
|
11084
|
+
# @!attribute [rw] status
|
|
11085
|
+
# The status of the message template.
|
|
11086
|
+
# @return [String]
|
|
11087
|
+
#
|
|
11088
|
+
# @!attribute [rw] status_reason
|
|
11089
|
+
# The status reason of the message template.
|
|
11090
|
+
# @return [String]
|
|
11091
|
+
#
|
|
11092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfigurationSummary AWS API Documentation
|
|
11093
|
+
#
|
|
11094
|
+
class WhatsAppMessageTemplateSourceConfigurationSummary < Struct.new(
|
|
11095
|
+
:business_account_id,
|
|
11096
|
+
:template_id,
|
|
11097
|
+
:name,
|
|
11098
|
+
:language,
|
|
11099
|
+
:components,
|
|
11100
|
+
:status,
|
|
11101
|
+
:status_reason)
|
|
11102
|
+
SENSITIVE = [:status_reason]
|
|
11103
|
+
include Aws::Structure
|
|
11104
|
+
end
|
|
11105
|
+
|
|
10551
11106
|
end
|
|
10552
11107
|
end
|
|
10553
11108
|
|