aws-sdk-qconnect 1.23.0 → 1.24.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 +1581 -29
- data/lib/aws-sdk-qconnect/client_api.rb +657 -0
- data/lib/aws-sdk-qconnect/types.rb +2016 -163
- data/lib/aws-sdk-qconnect.rb +2 -2
- data/sig/client.rbs +492 -0
- data/sig/types.rbs +461 -0
- metadata +2 -2
@@ -447,6 +447,51 @@ module Aws::QConnect
|
|
447
447
|
|
448
448
|
# @!group API Operations
|
449
449
|
|
450
|
+
# Activates a specific version of the Amazon Q in Connect message
|
451
|
+
# template. After the version is activated, the previous active version
|
452
|
+
# will be deactivated automatically. You can use the `$ACTIVE_VERSION`
|
453
|
+
# qualifier later to reference the version that is in active status.
|
454
|
+
#
|
455
|
+
# @option params [required, String] :knowledge_base_id
|
456
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
457
|
+
# URLs cannot contain the ARN.
|
458
|
+
#
|
459
|
+
# @option params [required, String] :message_template_id
|
460
|
+
# The identifier of the message template. Can be either the ID or the
|
461
|
+
# ARN. It cannot contain any qualifier.
|
462
|
+
#
|
463
|
+
# @option params [required, Integer] :version_number
|
464
|
+
# The version number of the message template version to activate.
|
465
|
+
#
|
466
|
+
# @return [Types::ActivateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
467
|
+
#
|
468
|
+
# * {Types::ActivateMessageTemplateResponse#message_template_arn #message_template_arn} => String
|
469
|
+
# * {Types::ActivateMessageTemplateResponse#message_template_id #message_template_id} => String
|
470
|
+
# * {Types::ActivateMessageTemplateResponse#version_number #version_number} => Integer
|
471
|
+
#
|
472
|
+
# @example Request syntax with placeholder values
|
473
|
+
#
|
474
|
+
# resp = client.activate_message_template({
|
475
|
+
# knowledge_base_id: "UuidOrArn", # required
|
476
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
477
|
+
# version_number: 1, # required
|
478
|
+
# })
|
479
|
+
#
|
480
|
+
# @example Response structure
|
481
|
+
#
|
482
|
+
# resp.message_template_arn #=> String
|
483
|
+
# resp.message_template_id #=> String
|
484
|
+
# resp.version_number #=> Integer
|
485
|
+
#
|
486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ActivateMessageTemplate AWS API Documentation
|
487
|
+
#
|
488
|
+
# @overload activate_message_template(params = {})
|
489
|
+
# @param [Hash] params ({})
|
490
|
+
def activate_message_template(params = {}, options = {})
|
491
|
+
req = build_request(:activate_message_template, params)
|
492
|
+
req.send_request(options)
|
493
|
+
end
|
494
|
+
|
450
495
|
# Creates an Amazon Q in Connect AI Agent.
|
451
496
|
#
|
452
497
|
# @option params [required, String] :assistant_id
|
@@ -455,9 +500,9 @@ module Aws::QConnect
|
|
455
500
|
#
|
456
501
|
# @option params [String] :client_token
|
457
502
|
# A unique, case-sensitive identifier that you provide to ensure the
|
458
|
-
# idempotency of the request. If not provided, the
|
459
|
-
# this field. For more information about idempotency, see
|
460
|
-
# retries safe with idempotent APIs][1]
|
503
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
504
|
+
# SDK populates this field. For more information about idempotency, see
|
505
|
+
# [Making retries safe with idempotent APIs][1]..
|
461
506
|
#
|
462
507
|
# **A suitable default value is auto-generated.** You should normally
|
463
508
|
# not need to pass this option.**
|
@@ -660,9 +705,9 @@ module Aws::QConnect
|
|
660
705
|
#
|
661
706
|
# @option params [String] :client_token
|
662
707
|
# A unique, case-sensitive identifier that you provide to ensure the
|
663
|
-
# idempotency of the request. If not provided, the
|
664
|
-
# this field. For more information about idempotency, see
|
665
|
-
# retries safe with idempotent APIs][1]
|
708
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
709
|
+
# SDK populates this field. For more information about idempotency, see
|
710
|
+
# [Making retries safe with idempotent APIs][1]..
|
666
711
|
#
|
667
712
|
# **A suitable default value is auto-generated.** You should normally
|
668
713
|
# not need to pass this option.**
|
@@ -766,9 +811,9 @@ module Aws::QConnect
|
|
766
811
|
#
|
767
812
|
# @option params [String] :client_token
|
768
813
|
# A unique, case-sensitive identifier that you provide to ensure the
|
769
|
-
# idempotency of the request. If not provided, the
|
770
|
-
# this field. For more information about idempotency, see
|
771
|
-
# retries safe with idempotent APIs][1]
|
814
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
815
|
+
# SDK populates this field. For more information about idempotency, see
|
816
|
+
# [Making retries safe with idempotent APIs][1]..
|
772
817
|
#
|
773
818
|
# **A suitable default value is auto-generated.** You should normally
|
774
819
|
# not need to pass this option.**
|
@@ -868,16 +913,16 @@ module Aws::QConnect
|
|
868
913
|
#
|
869
914
|
# @option params [String] :client_token
|
870
915
|
# A unique, case-sensitive identifier that you provide to ensure the
|
871
|
-
# idempotency of the request. If not provided, the
|
872
|
-
# this field. For more information about idempotency, see
|
873
|
-
# retries safe with idempotent APIs][1]
|
916
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
917
|
+
# SDK populates this field. For more information about idempotency, see
|
918
|
+
# [Making retries safe with idempotent APIs][1]..
|
874
919
|
#
|
875
920
|
# **A suitable default value is auto-generated.** You should normally
|
876
921
|
# not need to pass this option.**
|
877
922
|
#
|
878
923
|
#
|
879
924
|
#
|
880
|
-
# [1]: http://aws.amazon.com/
|
925
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
881
926
|
#
|
882
927
|
# @option params [Time,DateTime,Date,Integer,String] :modified_time
|
883
928
|
# The time the AI Prompt was last modified.
|
@@ -939,7 +984,7 @@ module Aws::QConnect
|
|
939
984
|
#
|
940
985
|
#
|
941
986
|
#
|
942
|
-
# [1]:
|
987
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
943
988
|
#
|
944
989
|
# @option params [String] :description
|
945
990
|
# The description of the assistant.
|
@@ -1042,7 +1087,7 @@ module Aws::QConnect
|
|
1042
1087
|
#
|
1043
1088
|
#
|
1044
1089
|
#
|
1045
|
-
# [1]:
|
1090
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1046
1091
|
#
|
1047
1092
|
# @option params [Hash<String,String>] :tags
|
1048
1093
|
# The tags used to organize, track, or control access for this resource.
|
@@ -1104,7 +1149,7 @@ module Aws::QConnect
|
|
1104
1149
|
#
|
1105
1150
|
#
|
1106
1151
|
#
|
1107
|
-
# [1]:
|
1152
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1108
1153
|
#
|
1109
1154
|
# @option params [required, String] :knowledge_base_id
|
1110
1155
|
# The identifier of the knowledge base. This should not be a
|
@@ -1237,7 +1282,7 @@ module Aws::QConnect
|
|
1237
1282
|
#
|
1238
1283
|
#
|
1239
1284
|
#
|
1240
|
-
# [1]:
|
1285
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1241
1286
|
#
|
1242
1287
|
# @option params [required, String] :content_id
|
1243
1288
|
# The identifier of the content.
|
@@ -1330,7 +1375,7 @@ module Aws::QConnect
|
|
1330
1375
|
#
|
1331
1376
|
#
|
1332
1377
|
#
|
1333
|
-
# [1]:
|
1378
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1334
1379
|
#
|
1335
1380
|
# @option params [String] :description
|
1336
1381
|
# The description.
|
@@ -1365,7 +1410,7 @@ module Aws::QConnect
|
|
1365
1410
|
#
|
1366
1411
|
# @option params [Types::SourceConfiguration] :source_configuration
|
1367
1412
|
# The source of the knowledge base content. Only set this argument for
|
1368
|
-
# EXTERNAL knowledge bases.
|
1413
|
+
# EXTERNAL or Managed knowledge bases.
|
1369
1414
|
#
|
1370
1415
|
# @option params [Hash<String,String>] :tags
|
1371
1416
|
# The tags used to organize, track, or control access for this resource.
|
@@ -1498,6 +1543,518 @@ module Aws::QConnect
|
|
1498
1543
|
req.send_request(options)
|
1499
1544
|
end
|
1500
1545
|
|
1546
|
+
# Creates an Amazon Q in Connect message template. The name of the
|
1547
|
+
# message template has to be unique for each knowledge base. The channel
|
1548
|
+
# subtype of the message template is immutable and cannot be modified
|
1549
|
+
# after creation. After the message template is created, you can use the
|
1550
|
+
# `$LATEST` qualifier to reference the created message template.
|
1551
|
+
#
|
1552
|
+
# @option params [required, String] :channel_subtype
|
1553
|
+
# The channel subtype this message template applies to.
|
1554
|
+
#
|
1555
|
+
# @option params [String] :client_token
|
1556
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1557
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1558
|
+
# SDK populates this field. For more information about idempotency, see
|
1559
|
+
# [Making retries safe with idempotent APIs][1].
|
1560
|
+
#
|
1561
|
+
# **A suitable default value is auto-generated.** You should normally
|
1562
|
+
# not need to pass this option.**
|
1563
|
+
#
|
1564
|
+
#
|
1565
|
+
#
|
1566
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1567
|
+
#
|
1568
|
+
# @option params [required, Types::MessageTemplateContentProvider] :content
|
1569
|
+
# The content of the message template.
|
1570
|
+
#
|
1571
|
+
# @option params [Types::MessageTemplateAttributes] :default_attributes
|
1572
|
+
# An object that specifies the default values to use for variables in
|
1573
|
+
# the message template. This object contains different categories of
|
1574
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
1575
|
+
# message template. The corresponding value defines the default value
|
1576
|
+
# for that variable.
|
1577
|
+
#
|
1578
|
+
# @option params [String] :description
|
1579
|
+
# The description of the message template.
|
1580
|
+
#
|
1581
|
+
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
1582
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
1583
|
+
# users.
|
1584
|
+
#
|
1585
|
+
# @option params [required, String] :knowledge_base_id
|
1586
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1587
|
+
# URLs cannot contain the ARN.
|
1588
|
+
#
|
1589
|
+
# @option params [String] :language
|
1590
|
+
# The language code value for the language in which the quick response
|
1591
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
1592
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
1593
|
+
# `zh_CN`, `zh_TW`
|
1594
|
+
#
|
1595
|
+
# @option params [required, String] :name
|
1596
|
+
# The name of the message template.
|
1597
|
+
#
|
1598
|
+
# @option params [Hash<String,String>] :tags
|
1599
|
+
# The tags used to organize, track, or control access for this resource.
|
1600
|
+
#
|
1601
|
+
# @return [Types::CreateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1602
|
+
#
|
1603
|
+
# * {Types::CreateMessageTemplateResponse#message_template #message_template} => Types::MessageTemplateData
|
1604
|
+
#
|
1605
|
+
# @example Request syntax with placeholder values
|
1606
|
+
#
|
1607
|
+
# resp = client.create_message_template({
|
1608
|
+
# channel_subtype: "EMAIL", # required, accepts EMAIL, SMS
|
1609
|
+
# client_token: "ClientToken",
|
1610
|
+
# content: { # required
|
1611
|
+
# email: {
|
1612
|
+
# body: {
|
1613
|
+
# html: {
|
1614
|
+
# content: "NonEmptyUnlimitedString",
|
1615
|
+
# },
|
1616
|
+
# plain_text: {
|
1617
|
+
# content: "NonEmptyUnlimitedString",
|
1618
|
+
# },
|
1619
|
+
# },
|
1620
|
+
# headers: [
|
1621
|
+
# {
|
1622
|
+
# name: "EmailHeaderKey",
|
1623
|
+
# value: "EmailHeaderValue",
|
1624
|
+
# },
|
1625
|
+
# ],
|
1626
|
+
# subject: "NonEmptyUnlimitedString",
|
1627
|
+
# },
|
1628
|
+
# sms: {
|
1629
|
+
# body: {
|
1630
|
+
# plain_text: {
|
1631
|
+
# content: "NonEmptyUnlimitedString",
|
1632
|
+
# },
|
1633
|
+
# },
|
1634
|
+
# },
|
1635
|
+
# },
|
1636
|
+
# default_attributes: {
|
1637
|
+
# agent_attributes: {
|
1638
|
+
# first_name: "MessageTemplateAttributeValue",
|
1639
|
+
# last_name: "MessageTemplateAttributeValue",
|
1640
|
+
# },
|
1641
|
+
# custom_attributes: {
|
1642
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
1643
|
+
# },
|
1644
|
+
# customer_profile_attributes: {
|
1645
|
+
# account_number: "MessageTemplateAttributeValue",
|
1646
|
+
# additional_information: "MessageTemplateAttributeValue",
|
1647
|
+
# address1: "MessageTemplateAttributeValue",
|
1648
|
+
# address2: "MessageTemplateAttributeValue",
|
1649
|
+
# address3: "MessageTemplateAttributeValue",
|
1650
|
+
# address4: "MessageTemplateAttributeValue",
|
1651
|
+
# billing_address_1: "MessageTemplateAttributeValue",
|
1652
|
+
# billing_address_2: "MessageTemplateAttributeValue",
|
1653
|
+
# billing_address_3: "MessageTemplateAttributeValue",
|
1654
|
+
# billing_address_4: "MessageTemplateAttributeValue",
|
1655
|
+
# billing_city: "MessageTemplateAttributeValue",
|
1656
|
+
# billing_country: "MessageTemplateAttributeValue",
|
1657
|
+
# billing_county: "MessageTemplateAttributeValue",
|
1658
|
+
# billing_postal_code: "MessageTemplateAttributeValue",
|
1659
|
+
# billing_province: "MessageTemplateAttributeValue",
|
1660
|
+
# billing_state: "MessageTemplateAttributeValue",
|
1661
|
+
# birth_date: "MessageTemplateAttributeValue",
|
1662
|
+
# business_email_address: "MessageTemplateAttributeValue",
|
1663
|
+
# business_name: "MessageTemplateAttributeValue",
|
1664
|
+
# business_phone_number: "MessageTemplateAttributeValue",
|
1665
|
+
# city: "MessageTemplateAttributeValue",
|
1666
|
+
# country: "MessageTemplateAttributeValue",
|
1667
|
+
# county: "MessageTemplateAttributeValue",
|
1668
|
+
# custom: {
|
1669
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
1670
|
+
# },
|
1671
|
+
# email_address: "MessageTemplateAttributeValue",
|
1672
|
+
# first_name: "MessageTemplateAttributeValue",
|
1673
|
+
# gender: "MessageTemplateAttributeValue",
|
1674
|
+
# home_phone_number: "MessageTemplateAttributeValue",
|
1675
|
+
# last_name: "MessageTemplateAttributeValue",
|
1676
|
+
# mailing_address_1: "MessageTemplateAttributeValue",
|
1677
|
+
# mailing_address_2: "MessageTemplateAttributeValue",
|
1678
|
+
# mailing_address_3: "MessageTemplateAttributeValue",
|
1679
|
+
# mailing_address_4: "MessageTemplateAttributeValue",
|
1680
|
+
# mailing_city: "MessageTemplateAttributeValue",
|
1681
|
+
# mailing_country: "MessageTemplateAttributeValue",
|
1682
|
+
# mailing_county: "MessageTemplateAttributeValue",
|
1683
|
+
# mailing_postal_code: "MessageTemplateAttributeValue",
|
1684
|
+
# mailing_province: "MessageTemplateAttributeValue",
|
1685
|
+
# mailing_state: "MessageTemplateAttributeValue",
|
1686
|
+
# middle_name: "MessageTemplateAttributeValue",
|
1687
|
+
# mobile_phone_number: "MessageTemplateAttributeValue",
|
1688
|
+
# party_type: "MessageTemplateAttributeValue",
|
1689
|
+
# phone_number: "MessageTemplateAttributeValue",
|
1690
|
+
# postal_code: "MessageTemplateAttributeValue",
|
1691
|
+
# profile_arn: "MessageTemplateAttributeValue",
|
1692
|
+
# profile_id: "MessageTemplateAttributeValue",
|
1693
|
+
# province: "MessageTemplateAttributeValue",
|
1694
|
+
# shipping_address_1: "MessageTemplateAttributeValue",
|
1695
|
+
# shipping_address_2: "MessageTemplateAttributeValue",
|
1696
|
+
# shipping_address_3: "MessageTemplateAttributeValue",
|
1697
|
+
# shipping_address_4: "MessageTemplateAttributeValue",
|
1698
|
+
# shipping_city: "MessageTemplateAttributeValue",
|
1699
|
+
# shipping_country: "MessageTemplateAttributeValue",
|
1700
|
+
# shipping_county: "MessageTemplateAttributeValue",
|
1701
|
+
# shipping_postal_code: "MessageTemplateAttributeValue",
|
1702
|
+
# shipping_province: "MessageTemplateAttributeValue",
|
1703
|
+
# shipping_state: "MessageTemplateAttributeValue",
|
1704
|
+
# state: "MessageTemplateAttributeValue",
|
1705
|
+
# },
|
1706
|
+
# system_attributes: {
|
1707
|
+
# customer_endpoint: {
|
1708
|
+
# address: "MessageTemplateAttributeValue",
|
1709
|
+
# },
|
1710
|
+
# name: "MessageTemplateAttributeValue",
|
1711
|
+
# system_endpoint: {
|
1712
|
+
# address: "MessageTemplateAttributeValue",
|
1713
|
+
# },
|
1714
|
+
# },
|
1715
|
+
# },
|
1716
|
+
# description: "Description",
|
1717
|
+
# grouping_configuration: {
|
1718
|
+
# criteria: "GroupingCriteria",
|
1719
|
+
# values: ["GroupingValue"],
|
1720
|
+
# },
|
1721
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1722
|
+
# language: "LanguageCode",
|
1723
|
+
# name: "Name", # required
|
1724
|
+
# tags: {
|
1725
|
+
# "TagKey" => "TagValue",
|
1726
|
+
# },
|
1727
|
+
# })
|
1728
|
+
#
|
1729
|
+
# @example Response structure
|
1730
|
+
#
|
1731
|
+
# resp.message_template.attribute_types #=> Array
|
1732
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
1733
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
1734
|
+
# resp.message_template.content.email.body.html.content #=> String
|
1735
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
1736
|
+
# resp.message_template.content.email.headers #=> Array
|
1737
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
1738
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
1739
|
+
# resp.message_template.content.email.subject #=> String
|
1740
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
1741
|
+
# resp.message_template.created_time #=> Time
|
1742
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
1743
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
1744
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
1745
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
1746
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
1747
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
1748
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
1749
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
1750
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
1751
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
1752
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
1753
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
1754
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
1755
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
1756
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
1757
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
1758
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
1759
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
1760
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
1761
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
1762
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
1763
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
1764
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
1765
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
1766
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
1767
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
1768
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
1769
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
1770
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
1771
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
1772
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
1773
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
1774
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
1775
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
1776
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
1777
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
1778
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
1779
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
1780
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
1781
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
1782
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
1783
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
1784
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
1785
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
1786
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
1787
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
1788
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
1789
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
1790
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
1791
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
1792
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
1793
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
1794
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
1795
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
1796
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
1797
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
1798
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
1799
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
1800
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
1801
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
1802
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
1803
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
1804
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
1805
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
1806
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
1807
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
1808
|
+
# resp.message_template.description #=> String
|
1809
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
1810
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
1811
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
1812
|
+
# resp.message_template.knowledge_base_arn #=> String
|
1813
|
+
# resp.message_template.knowledge_base_id #=> String
|
1814
|
+
# resp.message_template.language #=> String
|
1815
|
+
# resp.message_template.last_modified_by #=> String
|
1816
|
+
# resp.message_template.last_modified_time #=> Time
|
1817
|
+
# resp.message_template.message_template_arn #=> String
|
1818
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
1819
|
+
# resp.message_template.message_template_id #=> String
|
1820
|
+
# resp.message_template.name #=> String
|
1821
|
+
# resp.message_template.tags #=> Hash
|
1822
|
+
# resp.message_template.tags["TagKey"] #=> String
|
1823
|
+
#
|
1824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplate AWS API Documentation
|
1825
|
+
#
|
1826
|
+
# @overload create_message_template(params = {})
|
1827
|
+
# @param [Hash] params ({})
|
1828
|
+
def create_message_template(params = {}, options = {})
|
1829
|
+
req = build_request(:create_message_template, params)
|
1830
|
+
req.send_request(options)
|
1831
|
+
end
|
1832
|
+
|
1833
|
+
# Uploads an attachment file to the specified Amazon Q in Connect
|
1834
|
+
# message template. The name of the message template attachment has to
|
1835
|
+
# be unique for each message template referenced by the `$LATEST`
|
1836
|
+
# qualifier. The body of the attachment file should be encoded using
|
1837
|
+
# base64 encoding. After the file is uploaded, you can use the
|
1838
|
+
# pre-signed Amazon S3 URL returned in response to download the uploaded
|
1839
|
+
# file.
|
1840
|
+
#
|
1841
|
+
# @option params [required, String] :body
|
1842
|
+
# The body of the attachment file being uploaded. It should be encoded
|
1843
|
+
# using base64 encoding.
|
1844
|
+
#
|
1845
|
+
# @option params [String] :client_token
|
1846
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1847
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1848
|
+
# SDK populates this field. For more information about idempotency, see
|
1849
|
+
# [Making retries safe with idempotent APIs][1].
|
1850
|
+
#
|
1851
|
+
#
|
1852
|
+
#
|
1853
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1854
|
+
#
|
1855
|
+
# @option params [required, String] :content_disposition
|
1856
|
+
# The presentation information for the attachment file.
|
1857
|
+
#
|
1858
|
+
# @option params [required, String] :knowledge_base_id
|
1859
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1860
|
+
# URLs cannot contain the ARN.
|
1861
|
+
#
|
1862
|
+
# @option params [required, String] :message_template_id
|
1863
|
+
# The identifier of the message template. Can be either the ID or the
|
1864
|
+
# ARN. It cannot contain any qualifier.
|
1865
|
+
#
|
1866
|
+
# @option params [required, String] :name
|
1867
|
+
# The name of the attachment file being uploaded. The name should
|
1868
|
+
# include the file extension.
|
1869
|
+
#
|
1870
|
+
# @return [Types::CreateMessageTemplateAttachmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1871
|
+
#
|
1872
|
+
# * {Types::CreateMessageTemplateAttachmentResponse#attachment #attachment} => Types::MessageTemplateAttachment
|
1873
|
+
#
|
1874
|
+
# @example Request syntax with placeholder values
|
1875
|
+
#
|
1876
|
+
# resp = client.create_message_template_attachment({
|
1877
|
+
# body: "NonEmptyUnlimitedString", # required
|
1878
|
+
# client_token: "ClientToken",
|
1879
|
+
# content_disposition: "ATTACHMENT", # required, accepts ATTACHMENT
|
1880
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1881
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
1882
|
+
# name: "AttachmentFileName", # required
|
1883
|
+
# })
|
1884
|
+
#
|
1885
|
+
# @example Response structure
|
1886
|
+
#
|
1887
|
+
# resp.attachment.attachment_id #=> String
|
1888
|
+
# resp.attachment.content_disposition #=> String, one of "ATTACHMENT"
|
1889
|
+
# resp.attachment.name #=> String
|
1890
|
+
# resp.attachment.uploaded_time #=> Time
|
1891
|
+
# resp.attachment.url #=> String
|
1892
|
+
# resp.attachment.url_expiry #=> Time
|
1893
|
+
#
|
1894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateAttachment AWS API Documentation
|
1895
|
+
#
|
1896
|
+
# @overload create_message_template_attachment(params = {})
|
1897
|
+
# @param [Hash] params ({})
|
1898
|
+
def create_message_template_attachment(params = {}, options = {})
|
1899
|
+
req = build_request(:create_message_template_attachment, params)
|
1900
|
+
req.send_request(options)
|
1901
|
+
end
|
1902
|
+
|
1903
|
+
# Creates a new Amazon Q in Connect message template version from the
|
1904
|
+
# current content and configuration of a message template. Versions are
|
1905
|
+
# immutable and monotonically increasing. Once a version is created, you
|
1906
|
+
# can reference a specific version of the message template by passing in
|
1907
|
+
# `<message-template-id>:<versionNumber>` as the message template
|
1908
|
+
# identifier. An error is displayed if the supplied
|
1909
|
+
# `messageTemplateContentSha256` is different from the
|
1910
|
+
# `messageTemplateContentSha256` of the message template with `$LATEST`
|
1911
|
+
# qualifier. If multiple `CreateMessageTemplateVersion` requests are
|
1912
|
+
# made while the message template remains the same, only the first
|
1913
|
+
# invocation creates a new version and the succeeding requests will
|
1914
|
+
# return the same response as the first invocation.
|
1915
|
+
#
|
1916
|
+
# @option params [required, String] :knowledge_base_id
|
1917
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1918
|
+
# URLs cannot contain the ARN.
|
1919
|
+
#
|
1920
|
+
# @option params [String] :message_template_content_sha_256
|
1921
|
+
# The checksum value of the message template content that is referenced
|
1922
|
+
# by the `$LATEST` qualifier. It can be returned in
|
1923
|
+
# `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
|
1924
|
+
# calculated by content, language, `defaultAttributes` and `Attachments`
|
1925
|
+
# of the message template. If not supplied, the message template version
|
1926
|
+
# will be created based on the message template content that is
|
1927
|
+
# referenced by the `$LATEST` qualifier by default.
|
1928
|
+
#
|
1929
|
+
# @option params [required, String] :message_template_id
|
1930
|
+
# The identifier of the message template. Can be either the ID or the
|
1931
|
+
# ARN. It cannot contain any qualifier.
|
1932
|
+
#
|
1933
|
+
# @return [Types::CreateMessageTemplateVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1934
|
+
#
|
1935
|
+
# * {Types::CreateMessageTemplateVersionResponse#message_template #message_template} => Types::ExtendedMessageTemplateData
|
1936
|
+
#
|
1937
|
+
# @example Request syntax with placeholder values
|
1938
|
+
#
|
1939
|
+
# resp = client.create_message_template_version({
|
1940
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1941
|
+
# message_template_content_sha_256: "MessageTemplateContentSha256",
|
1942
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
1943
|
+
# })
|
1944
|
+
#
|
1945
|
+
# @example Response structure
|
1946
|
+
#
|
1947
|
+
# resp.message_template.attachments #=> Array
|
1948
|
+
# resp.message_template.attachments[0].attachment_id #=> String
|
1949
|
+
# resp.message_template.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
|
1950
|
+
# resp.message_template.attachments[0].name #=> String
|
1951
|
+
# resp.message_template.attachments[0].uploaded_time #=> Time
|
1952
|
+
# resp.message_template.attachments[0].url #=> String
|
1953
|
+
# resp.message_template.attachments[0].url_expiry #=> Time
|
1954
|
+
# resp.message_template.attribute_types #=> Array
|
1955
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
1956
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
1957
|
+
# resp.message_template.content.email.body.html.content #=> String
|
1958
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
1959
|
+
# resp.message_template.content.email.headers #=> Array
|
1960
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
1961
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
1962
|
+
# resp.message_template.content.email.subject #=> String
|
1963
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
1964
|
+
# resp.message_template.created_time #=> Time
|
1965
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
1966
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
1967
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
1968
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
1969
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
1970
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
1971
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
1972
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
1973
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
1974
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
1975
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
1976
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
1977
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
1978
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
1979
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
1980
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
1981
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
1982
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
1983
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
1984
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
1985
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
1986
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
1987
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
1988
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
1989
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
1990
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
1991
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
1992
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
1993
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
1994
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
1995
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
1996
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
1997
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
1998
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
1999
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
2000
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
2001
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
2002
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
2003
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
2004
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
2005
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
2006
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
2007
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
2008
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
2009
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
2010
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
2011
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
2012
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
2013
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
2014
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
2015
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
2016
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
2017
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
2018
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
2019
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
2020
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
2021
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
2022
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
2023
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
2024
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
2025
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
2026
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
2027
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
2028
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
2029
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
2030
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
2031
|
+
# resp.message_template.description #=> String
|
2032
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
2033
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
2034
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
2035
|
+
# resp.message_template.is_active #=> Boolean
|
2036
|
+
# resp.message_template.knowledge_base_arn #=> String
|
2037
|
+
# resp.message_template.knowledge_base_id #=> String
|
2038
|
+
# resp.message_template.language #=> String
|
2039
|
+
# resp.message_template.last_modified_by #=> String
|
2040
|
+
# resp.message_template.last_modified_time #=> Time
|
2041
|
+
# resp.message_template.message_template_arn #=> String
|
2042
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
2043
|
+
# resp.message_template.message_template_id #=> String
|
2044
|
+
# resp.message_template.name #=> String
|
2045
|
+
# resp.message_template.tags #=> Hash
|
2046
|
+
# resp.message_template.tags["TagKey"] #=> String
|
2047
|
+
# resp.message_template.version_number #=> Integer
|
2048
|
+
#
|
2049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateVersion AWS API Documentation
|
2050
|
+
#
|
2051
|
+
# @overload create_message_template_version(params = {})
|
2052
|
+
# @param [Hash] params ({})
|
2053
|
+
def create_message_template_version(params = {}, options = {})
|
2054
|
+
req = build_request(:create_message_template_version, params)
|
2055
|
+
req.send_request(options)
|
2056
|
+
end
|
2057
|
+
|
1501
2058
|
# Creates an Amazon Q in Connect quick response.
|
1502
2059
|
#
|
1503
2060
|
# @option params [Array<String>] :channels
|
@@ -1514,7 +2071,7 @@ module Aws::QConnect
|
|
1514
2071
|
#
|
1515
2072
|
#
|
1516
2073
|
#
|
1517
|
-
# [1]:
|
2074
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1518
2075
|
#
|
1519
2076
|
# @option params [required, Types::QuickResponseDataProvider] :content
|
1520
2077
|
# The content of the quick response.
|
@@ -1646,7 +2203,7 @@ module Aws::QConnect
|
|
1646
2203
|
#
|
1647
2204
|
#
|
1648
2205
|
#
|
1649
|
-
# [1]:
|
2206
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1650
2207
|
#
|
1651
2208
|
# @option params [String] :description
|
1652
2209
|
# The description.
|
@@ -1739,6 +2296,50 @@ module Aws::QConnect
|
|
1739
2296
|
req.send_request(options)
|
1740
2297
|
end
|
1741
2298
|
|
2299
|
+
# Deactivates a specific version of the Amazon Q in Connect message
|
2300
|
+
# template . After the version is deactivated, you can no longer use the
|
2301
|
+
# `$ACTIVE_VERSION` qualifier to reference the version in active status.
|
2302
|
+
#
|
2303
|
+
# @option params [required, String] :knowledge_base_id
|
2304
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2305
|
+
# URLs cannot contain the ARN.
|
2306
|
+
#
|
2307
|
+
# @option params [required, String] :message_template_id
|
2308
|
+
# The identifier of the message template. Can be either the ID or the
|
2309
|
+
# ARN. It cannot contain any qualifier.
|
2310
|
+
#
|
2311
|
+
# @option params [required, Integer] :version_number
|
2312
|
+
# The version number of the message template version to deactivate.
|
2313
|
+
#
|
2314
|
+
# @return [Types::DeactivateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2315
|
+
#
|
2316
|
+
# * {Types::DeactivateMessageTemplateResponse#message_template_arn #message_template_arn} => String
|
2317
|
+
# * {Types::DeactivateMessageTemplateResponse#message_template_id #message_template_id} => String
|
2318
|
+
# * {Types::DeactivateMessageTemplateResponse#version_number #version_number} => Integer
|
2319
|
+
#
|
2320
|
+
# @example Request syntax with placeholder values
|
2321
|
+
#
|
2322
|
+
# resp = client.deactivate_message_template({
|
2323
|
+
# knowledge_base_id: "UuidOrArn", # required
|
2324
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
2325
|
+
# version_number: 1, # required
|
2326
|
+
# })
|
2327
|
+
#
|
2328
|
+
# @example Response structure
|
2329
|
+
#
|
2330
|
+
# resp.message_template_arn #=> String
|
2331
|
+
# resp.message_template_id #=> String
|
2332
|
+
# resp.version_number #=> Integer
|
2333
|
+
#
|
2334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeactivateMessageTemplate AWS API Documentation
|
2335
|
+
#
|
2336
|
+
# @overload deactivate_message_template(params = {})
|
2337
|
+
# @param [Hash] params ({})
|
2338
|
+
def deactivate_message_template(params = {}, options = {})
|
2339
|
+
req = build_request(:deactivate_message_template, params)
|
2340
|
+
req.send_request(options)
|
2341
|
+
end
|
2342
|
+
|
1742
2343
|
# Deletes an Amazon Q in Connect AI Agent.
|
1743
2344
|
#
|
1744
2345
|
# @option params [required, String] :ai_agent_id
|
@@ -2041,6 +2642,73 @@ module Aws::QConnect
|
|
2041
2642
|
req.send_request(options)
|
2042
2643
|
end
|
2043
2644
|
|
2645
|
+
# Deletes an Amazon Q in Connect message template entirely or a specific
|
2646
|
+
# version of the message template if version is supplied in the request.
|
2647
|
+
# You can provide the message template identifier as
|
2648
|
+
# `<message-template-id>:<versionNumber>` to delete a specific version
|
2649
|
+
# of the message template. If it is not supplied, the message template
|
2650
|
+
# and all available versions will be deleted.
|
2651
|
+
#
|
2652
|
+
# @option params [required, String] :knowledge_base_id
|
2653
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2654
|
+
# URLs cannot contain the ARN.
|
2655
|
+
#
|
2656
|
+
# @option params [required, String] :message_template_id
|
2657
|
+
# The identifier of the message template. Can be either the ID or the
|
2658
|
+
# ARN.
|
2659
|
+
#
|
2660
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2661
|
+
#
|
2662
|
+
# @example Request syntax with placeholder values
|
2663
|
+
#
|
2664
|
+
# resp = client.delete_message_template({
|
2665
|
+
# knowledge_base_id: "UuidOrArn", # required
|
2666
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
2667
|
+
# })
|
2668
|
+
#
|
2669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplate AWS API Documentation
|
2670
|
+
#
|
2671
|
+
# @overload delete_message_template(params = {})
|
2672
|
+
# @param [Hash] params ({})
|
2673
|
+
def delete_message_template(params = {}, options = {})
|
2674
|
+
req = build_request(:delete_message_template, params)
|
2675
|
+
req.send_request(options)
|
2676
|
+
end
|
2677
|
+
|
2678
|
+
# Deletes the attachment file from the Amazon Q in Connect message
|
2679
|
+
# template that is referenced by `$LATEST` qualifier. Attachments on
|
2680
|
+
# available message template versions will remain unchanged.
|
2681
|
+
#
|
2682
|
+
# @option params [required, String] :attachment_id
|
2683
|
+
# The identifier of the attachment file.
|
2684
|
+
#
|
2685
|
+
# @option params [required, String] :knowledge_base_id
|
2686
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2687
|
+
# URLs cannot contain the ARN.
|
2688
|
+
#
|
2689
|
+
# @option params [required, String] :message_template_id
|
2690
|
+
# The identifier of the message template. Can be either the ID or the
|
2691
|
+
# ARN. It cannot contain any qualifier.
|
2692
|
+
#
|
2693
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2694
|
+
#
|
2695
|
+
# @example Request syntax with placeholder values
|
2696
|
+
#
|
2697
|
+
# resp = client.delete_message_template_attachment({
|
2698
|
+
# attachment_id: "Uuid", # required
|
2699
|
+
# knowledge_base_id: "UuidOrArn", # required
|
2700
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
2701
|
+
# })
|
2702
|
+
#
|
2703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateAttachment AWS API Documentation
|
2704
|
+
#
|
2705
|
+
# @overload delete_message_template_attachment(params = {})
|
2706
|
+
# @param [Hash] params ({})
|
2707
|
+
def delete_message_template_attachment(params = {}, options = {})
|
2708
|
+
req = build_request(:delete_message_template_attachment, params)
|
2709
|
+
req.send_request(options)
|
2710
|
+
end
|
2711
|
+
|
2044
2712
|
# Deletes a quick response.
|
2045
2713
|
#
|
2046
2714
|
# @option params [required, String] :knowledge_base_id
|
@@ -2548,6 +3216,145 @@ module Aws::QConnect
|
|
2548
3216
|
req.send_request(options)
|
2549
3217
|
end
|
2550
3218
|
|
3219
|
+
# Retrieves the Amazon Q in Connect message template. The message
|
3220
|
+
# template identifier can contain an optional qualifier, for example,
|
3221
|
+
# `<message-template-id>:<qualifier>`, which is either an actual version
|
3222
|
+
# number or an Amazon Q Connect managed qualifier `$ACTIVE_VERSION` \|
|
3223
|
+
# `$LATEST`. If it is not supplied, then `$LATEST` is assumed
|
3224
|
+
# implicitly.
|
3225
|
+
#
|
3226
|
+
# @option params [required, String] :knowledge_base_id
|
3227
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
3228
|
+
# URLs cannot contain the ARN.
|
3229
|
+
#
|
3230
|
+
# @option params [required, String] :message_template_id
|
3231
|
+
# The identifier of the message template. Can be either the ID or the
|
3232
|
+
# ARN.
|
3233
|
+
#
|
3234
|
+
# @return [Types::GetMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3235
|
+
#
|
3236
|
+
# * {Types::GetMessageTemplateResponse#message_template #message_template} => Types::ExtendedMessageTemplateData
|
3237
|
+
#
|
3238
|
+
# @example Request syntax with placeholder values
|
3239
|
+
#
|
3240
|
+
# resp = client.get_message_template({
|
3241
|
+
# knowledge_base_id: "UuidOrArn", # required
|
3242
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
3243
|
+
# })
|
3244
|
+
#
|
3245
|
+
# @example Response structure
|
3246
|
+
#
|
3247
|
+
# resp.message_template.attachments #=> Array
|
3248
|
+
# resp.message_template.attachments[0].attachment_id #=> String
|
3249
|
+
# resp.message_template.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
|
3250
|
+
# resp.message_template.attachments[0].name #=> String
|
3251
|
+
# resp.message_template.attachments[0].uploaded_time #=> Time
|
3252
|
+
# resp.message_template.attachments[0].url #=> String
|
3253
|
+
# resp.message_template.attachments[0].url_expiry #=> Time
|
3254
|
+
# resp.message_template.attribute_types #=> Array
|
3255
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
3256
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
3257
|
+
# resp.message_template.content.email.body.html.content #=> String
|
3258
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
3259
|
+
# resp.message_template.content.email.headers #=> Array
|
3260
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
3261
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
3262
|
+
# resp.message_template.content.email.subject #=> String
|
3263
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
3264
|
+
# resp.message_template.created_time #=> Time
|
3265
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
3266
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
3267
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
3268
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
3269
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
3270
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
3271
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
3272
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
3273
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
3274
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
3275
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
3276
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
3277
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
3278
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
3279
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
3280
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
3281
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
3282
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
3283
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
3284
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
3285
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
3286
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
3287
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
3288
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
3289
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
3290
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
3291
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
3292
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
3293
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
3294
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
3295
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
3296
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
3297
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
3298
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
3299
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
3300
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
3301
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
3302
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
3303
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
3304
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
3305
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
3306
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
3307
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
3308
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
3309
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
3310
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
3311
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
3312
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
3313
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
3314
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
3315
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
3316
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
3317
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
3318
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
3319
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
3320
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
3321
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
3322
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
3323
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
3324
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
3325
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
3326
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
3327
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
3328
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
3329
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
3330
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
3331
|
+
# resp.message_template.description #=> String
|
3332
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
3333
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
3334
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
3335
|
+
# resp.message_template.is_active #=> Boolean
|
3336
|
+
# resp.message_template.knowledge_base_arn #=> String
|
3337
|
+
# resp.message_template.knowledge_base_id #=> String
|
3338
|
+
# resp.message_template.language #=> String
|
3339
|
+
# resp.message_template.last_modified_by #=> String
|
3340
|
+
# resp.message_template.last_modified_time #=> Time
|
3341
|
+
# resp.message_template.message_template_arn #=> String
|
3342
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
3343
|
+
# resp.message_template.message_template_id #=> String
|
3344
|
+
# resp.message_template.name #=> String
|
3345
|
+
# resp.message_template.tags #=> Hash
|
3346
|
+
# resp.message_template.tags["TagKey"] #=> String
|
3347
|
+
# resp.message_template.version_number #=> Integer
|
3348
|
+
#
|
3349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetMessageTemplate AWS API Documentation
|
3350
|
+
#
|
3351
|
+
# @overload get_message_template(params = {})
|
3352
|
+
# @param [Hash] params ({})
|
3353
|
+
def get_message_template(params = {}, options = {})
|
3354
|
+
req = build_request(:get_message_template, params)
|
3355
|
+
req.send_request(options)
|
3356
|
+
end
|
3357
|
+
|
2551
3358
|
# Retrieves the quick response.
|
2552
3359
|
#
|
2553
3360
|
# @option params [required, String] :knowledge_base_id
|
@@ -3472,6 +4279,120 @@ module Aws::QConnect
|
|
3472
4279
|
req.send_request(options)
|
3473
4280
|
end
|
3474
4281
|
|
4282
|
+
# Lists all the available versions for the specified Amazon Q in Connect
|
4283
|
+
# message template.
|
4284
|
+
#
|
4285
|
+
# @option params [required, String] :knowledge_base_id
|
4286
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
4287
|
+
# URLs cannot contain the ARN.
|
4288
|
+
#
|
4289
|
+
# @option params [Integer] :max_results
|
4290
|
+
# The maximum number of results to return per page.
|
4291
|
+
#
|
4292
|
+
# @option params [required, String] :message_template_id
|
4293
|
+
# The identifier of the message template. Can be either the ID or the
|
4294
|
+
# ARN. It cannot contain any qualifier.
|
4295
|
+
#
|
4296
|
+
# @option params [String] :next_token
|
4297
|
+
# The token for the next set of results. Use the value returned in the
|
4298
|
+
# previous response in the next request to retrieve the next set of
|
4299
|
+
# results.
|
4300
|
+
#
|
4301
|
+
# @return [Types::ListMessageTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4302
|
+
#
|
4303
|
+
# * {Types::ListMessageTemplateVersionsResponse#message_template_version_summaries #message_template_version_summaries} => Array<Types::MessageTemplateVersionSummary>
|
4304
|
+
# * {Types::ListMessageTemplateVersionsResponse#next_token #next_token} => String
|
4305
|
+
#
|
4306
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4307
|
+
#
|
4308
|
+
# @example Request syntax with placeholder values
|
4309
|
+
#
|
4310
|
+
# resp = client.list_message_template_versions({
|
4311
|
+
# knowledge_base_id: "UuidOrArn", # required
|
4312
|
+
# max_results: 1,
|
4313
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
4314
|
+
# next_token: "NextToken",
|
4315
|
+
# })
|
4316
|
+
#
|
4317
|
+
# @example Response structure
|
4318
|
+
#
|
4319
|
+
# resp.message_template_version_summaries #=> Array
|
4320
|
+
# resp.message_template_version_summaries[0].channel_subtype #=> String, one of "EMAIL", "SMS"
|
4321
|
+
# resp.message_template_version_summaries[0].is_active #=> Boolean
|
4322
|
+
# resp.message_template_version_summaries[0].knowledge_base_arn #=> String
|
4323
|
+
# resp.message_template_version_summaries[0].knowledge_base_id #=> String
|
4324
|
+
# resp.message_template_version_summaries[0].message_template_arn #=> String
|
4325
|
+
# resp.message_template_version_summaries[0].message_template_id #=> String
|
4326
|
+
# resp.message_template_version_summaries[0].name #=> String
|
4327
|
+
# resp.message_template_version_summaries[0].version_number #=> Integer
|
4328
|
+
# resp.next_token #=> String
|
4329
|
+
#
|
4330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplateVersions AWS API Documentation
|
4331
|
+
#
|
4332
|
+
# @overload list_message_template_versions(params = {})
|
4333
|
+
# @param [Hash] params ({})
|
4334
|
+
def list_message_template_versions(params = {}, options = {})
|
4335
|
+
req = build_request(:list_message_template_versions, params)
|
4336
|
+
req.send_request(options)
|
4337
|
+
end
|
4338
|
+
|
4339
|
+
# Lists all the available Amazon Q in Connect message templates for the
|
4340
|
+
# specified knowledge base.
|
4341
|
+
#
|
4342
|
+
# @option params [required, String] :knowledge_base_id
|
4343
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
4344
|
+
# URLs cannot contain the ARN.
|
4345
|
+
#
|
4346
|
+
# @option params [Integer] :max_results
|
4347
|
+
# The maximum number of results to return per page.
|
4348
|
+
#
|
4349
|
+
# @option params [String] :next_token
|
4350
|
+
# The token for the next set of results. Use the value returned in the
|
4351
|
+
# previous response in the next request to retrieve the next set of
|
4352
|
+
# results.
|
4353
|
+
#
|
4354
|
+
# @return [Types::ListMessageTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4355
|
+
#
|
4356
|
+
# * {Types::ListMessageTemplatesResponse#message_template_summaries #message_template_summaries} => Array<Types::MessageTemplateSummary>
|
4357
|
+
# * {Types::ListMessageTemplatesResponse#next_token #next_token} => String
|
4358
|
+
#
|
4359
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4360
|
+
#
|
4361
|
+
# @example Request syntax with placeholder values
|
4362
|
+
#
|
4363
|
+
# resp = client.list_message_templates({
|
4364
|
+
# knowledge_base_id: "UuidOrArn", # required
|
4365
|
+
# max_results: 1,
|
4366
|
+
# next_token: "NextToken",
|
4367
|
+
# })
|
4368
|
+
#
|
4369
|
+
# @example Response structure
|
4370
|
+
#
|
4371
|
+
# resp.message_template_summaries #=> Array
|
4372
|
+
# resp.message_template_summaries[0].active_version_number #=> Integer
|
4373
|
+
# resp.message_template_summaries[0].channel_subtype #=> String, one of "EMAIL", "SMS"
|
4374
|
+
# resp.message_template_summaries[0].created_time #=> Time
|
4375
|
+
# resp.message_template_summaries[0].description #=> String
|
4376
|
+
# resp.message_template_summaries[0].knowledge_base_arn #=> String
|
4377
|
+
# resp.message_template_summaries[0].knowledge_base_id #=> String
|
4378
|
+
# resp.message_template_summaries[0].last_modified_by #=> String
|
4379
|
+
# resp.message_template_summaries[0].last_modified_time #=> Time
|
4380
|
+
# resp.message_template_summaries[0].message_template_arn #=> String
|
4381
|
+
# resp.message_template_summaries[0].message_template_id #=> String
|
4382
|
+
# resp.message_template_summaries[0].name #=> String
|
4383
|
+
# resp.message_template_summaries[0].tags #=> Hash
|
4384
|
+
# resp.message_template_summaries[0].tags["TagKey"] #=> String
|
4385
|
+
# resp.next_token #=> String
|
4386
|
+
#
|
4387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplates AWS API Documentation
|
4388
|
+
#
|
4389
|
+
# @overload list_message_templates(params = {})
|
4390
|
+
# @param [Hash] params ({})
|
4391
|
+
def list_message_templates(params = {}, options = {})
|
4392
|
+
req = build_request(:list_message_templates, params)
|
4393
|
+
req.send_request(options)
|
4394
|
+
end
|
4395
|
+
|
3475
4396
|
# Lists information about quick response.
|
3476
4397
|
#
|
3477
4398
|
# @option params [required, String] :knowledge_base_id
|
@@ -3863,6 +4784,150 @@ module Aws::QConnect
|
|
3863
4784
|
req.send_request(options)
|
3864
4785
|
end
|
3865
4786
|
|
4787
|
+
# Renders the Amazon Q in Connect message template based on the
|
4788
|
+
# attribute values provided and generates the message content. For any
|
4789
|
+
# variable present in the message template, if the attribute value is
|
4790
|
+
# neither provided in the attribute request parameter nor the default
|
4791
|
+
# attribute of the message template, the rendered message content will
|
4792
|
+
# keep the variable placeholder as it is and return the attribute keys
|
4793
|
+
# that are missing.
|
4794
|
+
#
|
4795
|
+
# @option params [required, Types::MessageTemplateAttributes] :attributes
|
4796
|
+
# An object that specifies the values to use for variables in the
|
4797
|
+
# message template. This object contains different categories of
|
4798
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
4799
|
+
# message template. The corresponding value defines the value for that
|
4800
|
+
# variable.
|
4801
|
+
#
|
4802
|
+
# @option params [required, String] :knowledge_base_id
|
4803
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
4804
|
+
# URLs cannot contain the ARN.
|
4805
|
+
#
|
4806
|
+
# @option params [required, String] :message_template_id
|
4807
|
+
# The identifier of the message template. Can be either the ID or the
|
4808
|
+
# ARN.
|
4809
|
+
#
|
4810
|
+
# @return [Types::RenderMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4811
|
+
#
|
4812
|
+
# * {Types::RenderMessageTemplateResponse#attachments #attachments} => Array<Types::MessageTemplateAttachment>
|
4813
|
+
# * {Types::RenderMessageTemplateResponse#attributes_not_interpolated #attributes_not_interpolated} => Array<String>
|
4814
|
+
# * {Types::RenderMessageTemplateResponse#content #content} => Types::MessageTemplateContentProvider
|
4815
|
+
#
|
4816
|
+
# @example Request syntax with placeholder values
|
4817
|
+
#
|
4818
|
+
# resp = client.render_message_template({
|
4819
|
+
# attributes: { # required
|
4820
|
+
# agent_attributes: {
|
4821
|
+
# first_name: "MessageTemplateAttributeValue",
|
4822
|
+
# last_name: "MessageTemplateAttributeValue",
|
4823
|
+
# },
|
4824
|
+
# custom_attributes: {
|
4825
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
4826
|
+
# },
|
4827
|
+
# customer_profile_attributes: {
|
4828
|
+
# account_number: "MessageTemplateAttributeValue",
|
4829
|
+
# additional_information: "MessageTemplateAttributeValue",
|
4830
|
+
# address1: "MessageTemplateAttributeValue",
|
4831
|
+
# address2: "MessageTemplateAttributeValue",
|
4832
|
+
# address3: "MessageTemplateAttributeValue",
|
4833
|
+
# address4: "MessageTemplateAttributeValue",
|
4834
|
+
# billing_address_1: "MessageTemplateAttributeValue",
|
4835
|
+
# billing_address_2: "MessageTemplateAttributeValue",
|
4836
|
+
# billing_address_3: "MessageTemplateAttributeValue",
|
4837
|
+
# billing_address_4: "MessageTemplateAttributeValue",
|
4838
|
+
# billing_city: "MessageTemplateAttributeValue",
|
4839
|
+
# billing_country: "MessageTemplateAttributeValue",
|
4840
|
+
# billing_county: "MessageTemplateAttributeValue",
|
4841
|
+
# billing_postal_code: "MessageTemplateAttributeValue",
|
4842
|
+
# billing_province: "MessageTemplateAttributeValue",
|
4843
|
+
# billing_state: "MessageTemplateAttributeValue",
|
4844
|
+
# birth_date: "MessageTemplateAttributeValue",
|
4845
|
+
# business_email_address: "MessageTemplateAttributeValue",
|
4846
|
+
# business_name: "MessageTemplateAttributeValue",
|
4847
|
+
# business_phone_number: "MessageTemplateAttributeValue",
|
4848
|
+
# city: "MessageTemplateAttributeValue",
|
4849
|
+
# country: "MessageTemplateAttributeValue",
|
4850
|
+
# county: "MessageTemplateAttributeValue",
|
4851
|
+
# custom: {
|
4852
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
4853
|
+
# },
|
4854
|
+
# email_address: "MessageTemplateAttributeValue",
|
4855
|
+
# first_name: "MessageTemplateAttributeValue",
|
4856
|
+
# gender: "MessageTemplateAttributeValue",
|
4857
|
+
# home_phone_number: "MessageTemplateAttributeValue",
|
4858
|
+
# last_name: "MessageTemplateAttributeValue",
|
4859
|
+
# mailing_address_1: "MessageTemplateAttributeValue",
|
4860
|
+
# mailing_address_2: "MessageTemplateAttributeValue",
|
4861
|
+
# mailing_address_3: "MessageTemplateAttributeValue",
|
4862
|
+
# mailing_address_4: "MessageTemplateAttributeValue",
|
4863
|
+
# mailing_city: "MessageTemplateAttributeValue",
|
4864
|
+
# mailing_country: "MessageTemplateAttributeValue",
|
4865
|
+
# mailing_county: "MessageTemplateAttributeValue",
|
4866
|
+
# mailing_postal_code: "MessageTemplateAttributeValue",
|
4867
|
+
# mailing_province: "MessageTemplateAttributeValue",
|
4868
|
+
# mailing_state: "MessageTemplateAttributeValue",
|
4869
|
+
# middle_name: "MessageTemplateAttributeValue",
|
4870
|
+
# mobile_phone_number: "MessageTemplateAttributeValue",
|
4871
|
+
# party_type: "MessageTemplateAttributeValue",
|
4872
|
+
# phone_number: "MessageTemplateAttributeValue",
|
4873
|
+
# postal_code: "MessageTemplateAttributeValue",
|
4874
|
+
# profile_arn: "MessageTemplateAttributeValue",
|
4875
|
+
# profile_id: "MessageTemplateAttributeValue",
|
4876
|
+
# province: "MessageTemplateAttributeValue",
|
4877
|
+
# shipping_address_1: "MessageTemplateAttributeValue",
|
4878
|
+
# shipping_address_2: "MessageTemplateAttributeValue",
|
4879
|
+
# shipping_address_3: "MessageTemplateAttributeValue",
|
4880
|
+
# shipping_address_4: "MessageTemplateAttributeValue",
|
4881
|
+
# shipping_city: "MessageTemplateAttributeValue",
|
4882
|
+
# shipping_country: "MessageTemplateAttributeValue",
|
4883
|
+
# shipping_county: "MessageTemplateAttributeValue",
|
4884
|
+
# shipping_postal_code: "MessageTemplateAttributeValue",
|
4885
|
+
# shipping_province: "MessageTemplateAttributeValue",
|
4886
|
+
# shipping_state: "MessageTemplateAttributeValue",
|
4887
|
+
# state: "MessageTemplateAttributeValue",
|
4888
|
+
# },
|
4889
|
+
# system_attributes: {
|
4890
|
+
# customer_endpoint: {
|
4891
|
+
# address: "MessageTemplateAttributeValue",
|
4892
|
+
# },
|
4893
|
+
# name: "MessageTemplateAttributeValue",
|
4894
|
+
# system_endpoint: {
|
4895
|
+
# address: "MessageTemplateAttributeValue",
|
4896
|
+
# },
|
4897
|
+
# },
|
4898
|
+
# },
|
4899
|
+
# knowledge_base_id: "UuidOrArn", # required
|
4900
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
4901
|
+
# })
|
4902
|
+
#
|
4903
|
+
# @example Response structure
|
4904
|
+
#
|
4905
|
+
# resp.attachments #=> Array
|
4906
|
+
# resp.attachments[0].attachment_id #=> String
|
4907
|
+
# resp.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
|
4908
|
+
# resp.attachments[0].name #=> String
|
4909
|
+
# resp.attachments[0].uploaded_time #=> Time
|
4910
|
+
# resp.attachments[0].url #=> String
|
4911
|
+
# resp.attachments[0].url_expiry #=> Time
|
4912
|
+
# resp.attributes_not_interpolated #=> Array
|
4913
|
+
# resp.attributes_not_interpolated[0] #=> String
|
4914
|
+
# resp.content.email.body.html.content #=> String
|
4915
|
+
# resp.content.email.body.plain_text.content #=> String
|
4916
|
+
# resp.content.email.headers #=> Array
|
4917
|
+
# resp.content.email.headers[0].name #=> String
|
4918
|
+
# resp.content.email.headers[0].value #=> String
|
4919
|
+
# resp.content.email.subject #=> String
|
4920
|
+
# resp.content.sms.body.plain_text.content #=> String
|
4921
|
+
#
|
4922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderMessageTemplate AWS API Documentation
|
4923
|
+
#
|
4924
|
+
# @overload render_message_template(params = {})
|
4925
|
+
# @param [Hash] params ({})
|
4926
|
+
def render_message_template(params = {}, options = {})
|
4927
|
+
req = build_request(:render_message_template, params)
|
4928
|
+
req.send_request(options)
|
4929
|
+
end
|
4930
|
+
|
3866
4931
|
# Searches for content in a specified knowledge base. Can be used to get
|
3867
4932
|
# a specific content resource by its name.
|
3868
4933
|
#
|
@@ -3933,6 +4998,94 @@ module Aws::QConnect
|
|
3933
4998
|
req.send_request(options)
|
3934
4999
|
end
|
3935
5000
|
|
5001
|
+
# Searches for Amazon Q in Connect message templates in the specified
|
5002
|
+
# knowledge base.
|
5003
|
+
#
|
5004
|
+
# @option params [required, String] :knowledge_base_id
|
5005
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
5006
|
+
# URLs cannot contain the ARN.
|
5007
|
+
#
|
5008
|
+
# @option params [Integer] :max_results
|
5009
|
+
# The maximum number of results to return per page.
|
5010
|
+
#
|
5011
|
+
# @option params [String] :next_token
|
5012
|
+
# The token for the next set of results. Use the value returned in the
|
5013
|
+
# previous response in the next request to retrieve the next set of
|
5014
|
+
# results.
|
5015
|
+
#
|
5016
|
+
# @option params [required, Types::MessageTemplateSearchExpression] :search_expression
|
5017
|
+
# The search expression for querying the message template.
|
5018
|
+
#
|
5019
|
+
# @return [Types::SearchMessageTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5020
|
+
#
|
5021
|
+
# * {Types::SearchMessageTemplatesResponse#next_token #next_token} => String
|
5022
|
+
# * {Types::SearchMessageTemplatesResponse#results #results} => Array<Types::MessageTemplateSearchResultData>
|
5023
|
+
#
|
5024
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5025
|
+
#
|
5026
|
+
# @example Request syntax with placeholder values
|
5027
|
+
#
|
5028
|
+
# resp = client.search_message_templates({
|
5029
|
+
# knowledge_base_id: "UuidOrArn", # required
|
5030
|
+
# max_results: 1,
|
5031
|
+
# next_token: "NextToken",
|
5032
|
+
# search_expression: { # required
|
5033
|
+
# filters: [
|
5034
|
+
# {
|
5035
|
+
# include_no_existence: false,
|
5036
|
+
# name: "NonEmptyString", # required
|
5037
|
+
# operator: "EQUALS", # required, accepts EQUALS, PREFIX
|
5038
|
+
# values: ["MessageTemplateFilterValue"],
|
5039
|
+
# },
|
5040
|
+
# ],
|
5041
|
+
# order_on_field: {
|
5042
|
+
# name: "NonEmptyString", # required
|
5043
|
+
# order: "ASC", # accepts ASC, DESC
|
5044
|
+
# },
|
5045
|
+
# queries: [
|
5046
|
+
# {
|
5047
|
+
# allow_fuzziness: false,
|
5048
|
+
# name: "NonEmptyString", # required
|
5049
|
+
# operator: "CONTAINS", # required, accepts CONTAINS, CONTAINS_AND_PREFIX
|
5050
|
+
# priority: "HIGH", # accepts HIGH, MEDIUM, LOW
|
5051
|
+
# values: ["MessageTemplateQueryValue"], # required
|
5052
|
+
# },
|
5053
|
+
# ],
|
5054
|
+
# },
|
5055
|
+
# })
|
5056
|
+
#
|
5057
|
+
# @example Response structure
|
5058
|
+
#
|
5059
|
+
# resp.next_token #=> String
|
5060
|
+
# resp.results #=> Array
|
5061
|
+
# resp.results[0].channel_subtype #=> String, one of "EMAIL", "SMS"
|
5062
|
+
# resp.results[0].created_time #=> Time
|
5063
|
+
# resp.results[0].description #=> String
|
5064
|
+
# resp.results[0].grouping_configuration.criteria #=> String
|
5065
|
+
# resp.results[0].grouping_configuration.values #=> Array
|
5066
|
+
# resp.results[0].grouping_configuration.values[0] #=> String
|
5067
|
+
# resp.results[0].is_active #=> Boolean
|
5068
|
+
# resp.results[0].knowledge_base_arn #=> String
|
5069
|
+
# resp.results[0].knowledge_base_id #=> String
|
5070
|
+
# resp.results[0].language #=> String
|
5071
|
+
# resp.results[0].last_modified_by #=> String
|
5072
|
+
# resp.results[0].last_modified_time #=> Time
|
5073
|
+
# resp.results[0].message_template_arn #=> String
|
5074
|
+
# resp.results[0].message_template_id #=> String
|
5075
|
+
# resp.results[0].name #=> String
|
5076
|
+
# resp.results[0].tags #=> Hash
|
5077
|
+
# resp.results[0].tags["TagKey"] #=> String
|
5078
|
+
# resp.results[0].version_number #=> Integer
|
5079
|
+
#
|
5080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchMessageTemplates AWS API Documentation
|
5081
|
+
#
|
5082
|
+
# @overload search_message_templates(params = {})
|
5083
|
+
# @param [Hash] params ({})
|
5084
|
+
def search_message_templates(params = {}, options = {})
|
5085
|
+
req = build_request(:search_message_templates, params)
|
5086
|
+
req.send_request(options)
|
5087
|
+
end
|
5088
|
+
|
3936
5089
|
# Searches existing Amazon Q in Connect quick responses in an Amazon Q
|
3937
5090
|
# in Connect knowledge base.
|
3938
5091
|
#
|
@@ -4327,9 +5480,9 @@ module Aws::QConnect
|
|
4327
5480
|
#
|
4328
5481
|
# @option params [String] :client_token
|
4329
5482
|
# A unique, case-sensitive identifier that you provide to ensure the
|
4330
|
-
# idempotency of the request. If not provided, the
|
4331
|
-
# this field. For more information about idempotency, see
|
4332
|
-
# retries safe with idempotent APIs][1]
|
5483
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
5484
|
+
# SDK populates this field. For more information about idempotency, see
|
5485
|
+
# [Making retries safe with idempotent APIs][1]..
|
4333
5486
|
#
|
4334
5487
|
# **A suitable default value is auto-generated.** You should normally
|
4335
5488
|
# not need to pass this option.**
|
@@ -4519,16 +5672,16 @@ module Aws::QConnect
|
|
4519
5672
|
#
|
4520
5673
|
# @option params [String] :client_token
|
4521
5674
|
# A unique, case-sensitive identifier that you provide to ensure the
|
4522
|
-
# idempotency of the request. If not provided, the
|
4523
|
-
# this field. For more information about idempotency, see
|
4524
|
-
# retries safe with idempotent APIs][1]
|
5675
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
5676
|
+
# SDK populates this field. For more information about idempotency, see
|
5677
|
+
# [Making retries safe with idempotent APIs][1]..
|
4525
5678
|
#
|
4526
5679
|
# **A suitable default value is auto-generated.** You should normally
|
4527
5680
|
# not need to pass this option.**
|
4528
5681
|
#
|
4529
5682
|
#
|
4530
5683
|
#
|
4531
|
-
# [1]: http://aws.amazon.com/
|
5684
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
4532
5685
|
#
|
4533
5686
|
# @option params [String] :description
|
4534
5687
|
# The description of the Amazon Q in Connect AI Prompt.
|
@@ -4806,6 +5959,405 @@ module Aws::QConnect
|
|
4806
5959
|
req.send_request(options)
|
4807
5960
|
end
|
4808
5961
|
|
5962
|
+
# Updates the Amazon Q in Connect message template. Partial update is
|
5963
|
+
# supported. If any field is not supplied, it will remain unchanged for
|
5964
|
+
# the message template that is referenced by the `$LATEST` qualifier.
|
5965
|
+
# Any modification will only apply to the message template that is
|
5966
|
+
# referenced by the `$LATEST` qualifier. The fields for all available
|
5967
|
+
# versions will remain unchanged.
|
5968
|
+
#
|
5969
|
+
# @option params [Types::MessageTemplateContentProvider] :content
|
5970
|
+
# The content of the message template.
|
5971
|
+
#
|
5972
|
+
# @option params [Types::MessageTemplateAttributes] :default_attributes
|
5973
|
+
# An object that specifies the default values to use for variables in
|
5974
|
+
# the message template. This object contains different categories of
|
5975
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
5976
|
+
# message template. The corresponding value defines the default value
|
5977
|
+
# for that variable.
|
5978
|
+
#
|
5979
|
+
# @option params [required, String] :knowledge_base_id
|
5980
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
5981
|
+
# URLs cannot contain the ARN.
|
5982
|
+
#
|
5983
|
+
# @option params [String] :language
|
5984
|
+
# The language code value for the language in which the quick response
|
5985
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
5986
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
5987
|
+
# `zh_CN`, `zh_TW`
|
5988
|
+
#
|
5989
|
+
# @option params [required, String] :message_template_id
|
5990
|
+
# The identifier of the message template. Can be either the ID or the
|
5991
|
+
# ARN. It cannot contain any qualifier.
|
5992
|
+
#
|
5993
|
+
# @return [Types::UpdateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5994
|
+
#
|
5995
|
+
# * {Types::UpdateMessageTemplateResponse#message_template #message_template} => Types::MessageTemplateData
|
5996
|
+
#
|
5997
|
+
# @example Request syntax with placeholder values
|
5998
|
+
#
|
5999
|
+
# resp = client.update_message_template({
|
6000
|
+
# content: {
|
6001
|
+
# email: {
|
6002
|
+
# body: {
|
6003
|
+
# html: {
|
6004
|
+
# content: "NonEmptyUnlimitedString",
|
6005
|
+
# },
|
6006
|
+
# plain_text: {
|
6007
|
+
# content: "NonEmptyUnlimitedString",
|
6008
|
+
# },
|
6009
|
+
# },
|
6010
|
+
# headers: [
|
6011
|
+
# {
|
6012
|
+
# name: "EmailHeaderKey",
|
6013
|
+
# value: "EmailHeaderValue",
|
6014
|
+
# },
|
6015
|
+
# ],
|
6016
|
+
# subject: "NonEmptyUnlimitedString",
|
6017
|
+
# },
|
6018
|
+
# sms: {
|
6019
|
+
# body: {
|
6020
|
+
# plain_text: {
|
6021
|
+
# content: "NonEmptyUnlimitedString",
|
6022
|
+
# },
|
6023
|
+
# },
|
6024
|
+
# },
|
6025
|
+
# },
|
6026
|
+
# default_attributes: {
|
6027
|
+
# agent_attributes: {
|
6028
|
+
# first_name: "MessageTemplateAttributeValue",
|
6029
|
+
# last_name: "MessageTemplateAttributeValue",
|
6030
|
+
# },
|
6031
|
+
# custom_attributes: {
|
6032
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
6033
|
+
# },
|
6034
|
+
# customer_profile_attributes: {
|
6035
|
+
# account_number: "MessageTemplateAttributeValue",
|
6036
|
+
# additional_information: "MessageTemplateAttributeValue",
|
6037
|
+
# address1: "MessageTemplateAttributeValue",
|
6038
|
+
# address2: "MessageTemplateAttributeValue",
|
6039
|
+
# address3: "MessageTemplateAttributeValue",
|
6040
|
+
# address4: "MessageTemplateAttributeValue",
|
6041
|
+
# billing_address_1: "MessageTemplateAttributeValue",
|
6042
|
+
# billing_address_2: "MessageTemplateAttributeValue",
|
6043
|
+
# billing_address_3: "MessageTemplateAttributeValue",
|
6044
|
+
# billing_address_4: "MessageTemplateAttributeValue",
|
6045
|
+
# billing_city: "MessageTemplateAttributeValue",
|
6046
|
+
# billing_country: "MessageTemplateAttributeValue",
|
6047
|
+
# billing_county: "MessageTemplateAttributeValue",
|
6048
|
+
# billing_postal_code: "MessageTemplateAttributeValue",
|
6049
|
+
# billing_province: "MessageTemplateAttributeValue",
|
6050
|
+
# billing_state: "MessageTemplateAttributeValue",
|
6051
|
+
# birth_date: "MessageTemplateAttributeValue",
|
6052
|
+
# business_email_address: "MessageTemplateAttributeValue",
|
6053
|
+
# business_name: "MessageTemplateAttributeValue",
|
6054
|
+
# business_phone_number: "MessageTemplateAttributeValue",
|
6055
|
+
# city: "MessageTemplateAttributeValue",
|
6056
|
+
# country: "MessageTemplateAttributeValue",
|
6057
|
+
# county: "MessageTemplateAttributeValue",
|
6058
|
+
# custom: {
|
6059
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
6060
|
+
# },
|
6061
|
+
# email_address: "MessageTemplateAttributeValue",
|
6062
|
+
# first_name: "MessageTemplateAttributeValue",
|
6063
|
+
# gender: "MessageTemplateAttributeValue",
|
6064
|
+
# home_phone_number: "MessageTemplateAttributeValue",
|
6065
|
+
# last_name: "MessageTemplateAttributeValue",
|
6066
|
+
# mailing_address_1: "MessageTemplateAttributeValue",
|
6067
|
+
# mailing_address_2: "MessageTemplateAttributeValue",
|
6068
|
+
# mailing_address_3: "MessageTemplateAttributeValue",
|
6069
|
+
# mailing_address_4: "MessageTemplateAttributeValue",
|
6070
|
+
# mailing_city: "MessageTemplateAttributeValue",
|
6071
|
+
# mailing_country: "MessageTemplateAttributeValue",
|
6072
|
+
# mailing_county: "MessageTemplateAttributeValue",
|
6073
|
+
# mailing_postal_code: "MessageTemplateAttributeValue",
|
6074
|
+
# mailing_province: "MessageTemplateAttributeValue",
|
6075
|
+
# mailing_state: "MessageTemplateAttributeValue",
|
6076
|
+
# middle_name: "MessageTemplateAttributeValue",
|
6077
|
+
# mobile_phone_number: "MessageTemplateAttributeValue",
|
6078
|
+
# party_type: "MessageTemplateAttributeValue",
|
6079
|
+
# phone_number: "MessageTemplateAttributeValue",
|
6080
|
+
# postal_code: "MessageTemplateAttributeValue",
|
6081
|
+
# profile_arn: "MessageTemplateAttributeValue",
|
6082
|
+
# profile_id: "MessageTemplateAttributeValue",
|
6083
|
+
# province: "MessageTemplateAttributeValue",
|
6084
|
+
# shipping_address_1: "MessageTemplateAttributeValue",
|
6085
|
+
# shipping_address_2: "MessageTemplateAttributeValue",
|
6086
|
+
# shipping_address_3: "MessageTemplateAttributeValue",
|
6087
|
+
# shipping_address_4: "MessageTemplateAttributeValue",
|
6088
|
+
# shipping_city: "MessageTemplateAttributeValue",
|
6089
|
+
# shipping_country: "MessageTemplateAttributeValue",
|
6090
|
+
# shipping_county: "MessageTemplateAttributeValue",
|
6091
|
+
# shipping_postal_code: "MessageTemplateAttributeValue",
|
6092
|
+
# shipping_province: "MessageTemplateAttributeValue",
|
6093
|
+
# shipping_state: "MessageTemplateAttributeValue",
|
6094
|
+
# state: "MessageTemplateAttributeValue",
|
6095
|
+
# },
|
6096
|
+
# system_attributes: {
|
6097
|
+
# customer_endpoint: {
|
6098
|
+
# address: "MessageTemplateAttributeValue",
|
6099
|
+
# },
|
6100
|
+
# name: "MessageTemplateAttributeValue",
|
6101
|
+
# system_endpoint: {
|
6102
|
+
# address: "MessageTemplateAttributeValue",
|
6103
|
+
# },
|
6104
|
+
# },
|
6105
|
+
# },
|
6106
|
+
# knowledge_base_id: "UuidOrArn", # required
|
6107
|
+
# language: "LanguageCode",
|
6108
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
6109
|
+
# })
|
6110
|
+
#
|
6111
|
+
# @example Response structure
|
6112
|
+
#
|
6113
|
+
# resp.message_template.attribute_types #=> Array
|
6114
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
6115
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
6116
|
+
# resp.message_template.content.email.body.html.content #=> String
|
6117
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
6118
|
+
# resp.message_template.content.email.headers #=> Array
|
6119
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
6120
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
6121
|
+
# resp.message_template.content.email.subject #=> String
|
6122
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
6123
|
+
# resp.message_template.created_time #=> Time
|
6124
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
6125
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
6126
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
6127
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
6128
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
6129
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
6130
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
6131
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
6132
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
6133
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
6134
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
6135
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
6136
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
6137
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
6138
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
6139
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
6140
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
6141
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
6142
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
6143
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
6144
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
6145
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
6146
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
6147
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
6148
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
6149
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
6150
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
6151
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
6152
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
6153
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
6154
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
6155
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
6156
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
6157
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
6158
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
6159
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
6160
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
6161
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
6162
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
6163
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
6164
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
6165
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
6166
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
6167
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
6168
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
6169
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
6170
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
6171
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
6172
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
6173
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
6174
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
6175
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
6176
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
6177
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
6178
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
6179
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
6180
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
6181
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
6182
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
6183
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
6184
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
6185
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
6186
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
6187
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
6188
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
6189
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
6190
|
+
# resp.message_template.description #=> String
|
6191
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
6192
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
6193
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
6194
|
+
# resp.message_template.knowledge_base_arn #=> String
|
6195
|
+
# resp.message_template.knowledge_base_id #=> String
|
6196
|
+
# resp.message_template.language #=> String
|
6197
|
+
# resp.message_template.last_modified_by #=> String
|
6198
|
+
# resp.message_template.last_modified_time #=> Time
|
6199
|
+
# resp.message_template.message_template_arn #=> String
|
6200
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
6201
|
+
# resp.message_template.message_template_id #=> String
|
6202
|
+
# resp.message_template.name #=> String
|
6203
|
+
# resp.message_template.tags #=> Hash
|
6204
|
+
# resp.message_template.tags["TagKey"] #=> String
|
6205
|
+
#
|
6206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplate AWS API Documentation
|
6207
|
+
#
|
6208
|
+
# @overload update_message_template(params = {})
|
6209
|
+
# @param [Hash] params ({})
|
6210
|
+
def update_message_template(params = {}, options = {})
|
6211
|
+
req = build_request(:update_message_template, params)
|
6212
|
+
req.send_request(options)
|
6213
|
+
end
|
6214
|
+
|
6215
|
+
# Updates the Amazon Q in Connect message template metadata. Note that
|
6216
|
+
# any modification to the message template’s name, description and
|
6217
|
+
# grouping configuration will applied to the message template pointed by
|
6218
|
+
# the `$LATEST` qualifier and all available versions. Partial update is
|
6219
|
+
# supported. If any field is not supplied, it will remain unchanged for
|
6220
|
+
# the message template.
|
6221
|
+
#
|
6222
|
+
# @option params [String] :description
|
6223
|
+
# The description of the message template.
|
6224
|
+
#
|
6225
|
+
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
6226
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
6227
|
+
# users.
|
6228
|
+
#
|
6229
|
+
# @option params [required, String] :knowledge_base_id
|
6230
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
6231
|
+
# URLs cannot contain the ARN.
|
6232
|
+
#
|
6233
|
+
# @option params [required, String] :message_template_id
|
6234
|
+
# The identifier of the message template. Can be either the ID or the
|
6235
|
+
# ARN. It cannot contain any qualifier.
|
6236
|
+
#
|
6237
|
+
# @option params [String] :name
|
6238
|
+
# The name of the message template.
|
6239
|
+
#
|
6240
|
+
# @return [Types::UpdateMessageTemplateMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6241
|
+
#
|
6242
|
+
# * {Types::UpdateMessageTemplateMetadataResponse#message_template #message_template} => Types::MessageTemplateData
|
6243
|
+
#
|
6244
|
+
# @example Request syntax with placeholder values
|
6245
|
+
#
|
6246
|
+
# resp = client.update_message_template_metadata({
|
6247
|
+
# description: "Description",
|
6248
|
+
# grouping_configuration: {
|
6249
|
+
# criteria: "GroupingCriteria",
|
6250
|
+
# values: ["GroupingValue"],
|
6251
|
+
# },
|
6252
|
+
# knowledge_base_id: "UuidOrArn", # required
|
6253
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
6254
|
+
# name: "Name",
|
6255
|
+
# })
|
6256
|
+
#
|
6257
|
+
# @example Response structure
|
6258
|
+
#
|
6259
|
+
# resp.message_template.attribute_types #=> Array
|
6260
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
6261
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
6262
|
+
# resp.message_template.content.email.body.html.content #=> String
|
6263
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
6264
|
+
# resp.message_template.content.email.headers #=> Array
|
6265
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
6266
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
6267
|
+
# resp.message_template.content.email.subject #=> String
|
6268
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
6269
|
+
# resp.message_template.created_time #=> Time
|
6270
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
6271
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
6272
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
6273
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
6274
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
6275
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
6276
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
6277
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
6278
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
6279
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
6280
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
6281
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
6282
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
6283
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
6284
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
6285
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
6286
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
6287
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
6288
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
6289
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
6290
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
6291
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
6292
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
6293
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
6294
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
6295
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
6296
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
6297
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
6298
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
6299
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
6300
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
6301
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
6302
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
6303
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
6304
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
6305
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
6306
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
6307
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
6308
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
6309
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
6310
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
6311
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
6312
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
6313
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
6314
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
6315
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
6316
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
6317
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
6318
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
6319
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
6320
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
6321
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
6322
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
6323
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
6324
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
6325
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
6326
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
6327
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
6328
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
6329
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
6330
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
6331
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
6332
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
6333
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
6334
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
6335
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
6336
|
+
# resp.message_template.description #=> String
|
6337
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
6338
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
6339
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
6340
|
+
# resp.message_template.knowledge_base_arn #=> String
|
6341
|
+
# resp.message_template.knowledge_base_id #=> String
|
6342
|
+
# resp.message_template.language #=> String
|
6343
|
+
# resp.message_template.last_modified_by #=> String
|
6344
|
+
# resp.message_template.last_modified_time #=> Time
|
6345
|
+
# resp.message_template.message_template_arn #=> String
|
6346
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
6347
|
+
# resp.message_template.message_template_id #=> String
|
6348
|
+
# resp.message_template.name #=> String
|
6349
|
+
# resp.message_template.tags #=> Hash
|
6350
|
+
# resp.message_template.tags["TagKey"] #=> String
|
6351
|
+
#
|
6352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateMetadata AWS API Documentation
|
6353
|
+
#
|
6354
|
+
# @overload update_message_template_metadata(params = {})
|
6355
|
+
# @param [Hash] params ({})
|
6356
|
+
def update_message_template_metadata(params = {}, options = {})
|
6357
|
+
req = build_request(:update_message_template_metadata, params)
|
6358
|
+
req.send_request(options)
|
6359
|
+
end
|
6360
|
+
|
4809
6361
|
# Updates an existing Amazon Q in Connect quick response.
|
4810
6362
|
#
|
4811
6363
|
# @option params [Array<String>] :channels
|
@@ -5100,7 +6652,7 @@ module Aws::QConnect
|
|
5100
6652
|
tracer: tracer
|
5101
6653
|
)
|
5102
6654
|
context[:gem_name] = 'aws-sdk-qconnect'
|
5103
|
-
context[:gem_version] = '1.
|
6655
|
+
context[:gem_version] = '1.24.0'
|
5104
6656
|
Seahorse::Client::Request.new(handlers, context)
|
5105
6657
|
end
|
5106
6658
|
|