aws-sdk-qconnect 1.23.0 → 1.25.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +2715 -89
- data/lib/aws-sdk-qconnect/client_api.rb +1161 -0
- data/lib/aws-sdk-qconnect/types.rb +3572 -260
- data/lib/aws-sdk-qconnect.rb +2 -2
- data/sig/client.rbs +866 -6
- data/sig/types.rbs +809 -13
- 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.**
|
|
@@ -495,6 +540,7 @@ module Aws::QConnect
|
|
|
495
540
|
# client_token: "ClientToken",
|
|
496
541
|
# configuration: { # required
|
|
497
542
|
# answer_recommendation_ai_agent_configuration: {
|
|
543
|
+
# answer_generation_ai_guardrail_id: "UuidWithQualifier",
|
|
498
544
|
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
499
545
|
# association_configurations: [
|
|
500
546
|
# {
|
|
@@ -538,6 +584,7 @@ module Aws::QConnect
|
|
|
538
584
|
# query_reformulation_ai_prompt_id: "UuidWithQualifier",
|
|
539
585
|
# },
|
|
540
586
|
# manual_search_ai_agent_configuration: {
|
|
587
|
+
# answer_generation_ai_guardrail_id: "UuidWithQualifier",
|
|
541
588
|
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
542
589
|
# association_configurations: [
|
|
543
590
|
# {
|
|
@@ -578,13 +625,56 @@ module Aws::QConnect
|
|
|
578
625
|
# },
|
|
579
626
|
# ],
|
|
580
627
|
# },
|
|
628
|
+
# self_service_ai_agent_configuration: {
|
|
629
|
+
# association_configurations: [
|
|
630
|
+
# {
|
|
631
|
+
# association_configuration_data: {
|
|
632
|
+
# knowledge_base_association_configuration_data: {
|
|
633
|
+
# content_tag_filter: {
|
|
634
|
+
# and_conditions: [
|
|
635
|
+
# {
|
|
636
|
+
# key: "TagKey", # required
|
|
637
|
+
# value: "TagValue",
|
|
638
|
+
# },
|
|
639
|
+
# ],
|
|
640
|
+
# or_conditions: [
|
|
641
|
+
# {
|
|
642
|
+
# and_conditions: [
|
|
643
|
+
# {
|
|
644
|
+
# key: "TagKey", # required
|
|
645
|
+
# value: "TagValue",
|
|
646
|
+
# },
|
|
647
|
+
# ],
|
|
648
|
+
# tag_condition: {
|
|
649
|
+
# key: "TagKey", # required
|
|
650
|
+
# value: "TagValue",
|
|
651
|
+
# },
|
|
652
|
+
# },
|
|
653
|
+
# ],
|
|
654
|
+
# tag_condition: {
|
|
655
|
+
# key: "TagKey", # required
|
|
656
|
+
# value: "TagValue",
|
|
657
|
+
# },
|
|
658
|
+
# },
|
|
659
|
+
# max_results: 1,
|
|
660
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
661
|
+
# },
|
|
662
|
+
# },
|
|
663
|
+
# association_id: "Uuid",
|
|
664
|
+
# association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
|
|
665
|
+
# },
|
|
666
|
+
# ],
|
|
667
|
+
# self_service_ai_guardrail_id: "UuidWithQualifier",
|
|
668
|
+
# self_service_answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
669
|
+
# self_service_pre_processing_ai_prompt_id: "UuidWithQualifier",
|
|
670
|
+
# },
|
|
581
671
|
# },
|
|
582
672
|
# description: "Description",
|
|
583
673
|
# name: "Name", # required
|
|
584
674
|
# tags: {
|
|
585
675
|
# "TagKey" => "TagValue",
|
|
586
676
|
# },
|
|
587
|
-
# type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION
|
|
677
|
+
# type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION, SELF_SERVICE
|
|
588
678
|
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
589
679
|
# })
|
|
590
680
|
#
|
|
@@ -594,6 +684,7 @@ module Aws::QConnect
|
|
|
594
684
|
# resp.ai_agent.ai_agent_id #=> String
|
|
595
685
|
# resp.ai_agent.assistant_arn #=> String
|
|
596
686
|
# resp.ai_agent.assistant_id #=> String
|
|
687
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
597
688
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
598
689
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
599
690
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -613,6 +704,7 @@ module Aws::QConnect
|
|
|
613
704
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
614
705
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
615
706
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
707
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
616
708
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
617
709
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
618
710
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -630,6 +722,25 @@ module Aws::QConnect
|
|
|
630
722
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
631
723
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
632
724
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
725
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
|
|
726
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
727
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
728
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
729
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
730
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
731
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
732
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
733
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
734
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
735
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
736
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
737
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
738
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
739
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
740
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
741
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
|
|
742
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
|
|
743
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
|
|
633
744
|
# resp.ai_agent.description #=> String
|
|
634
745
|
# resp.ai_agent.modified_time #=> Time
|
|
635
746
|
# resp.ai_agent.name #=> String
|
|
@@ -637,7 +748,7 @@ module Aws::QConnect
|
|
|
637
748
|
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
638
749
|
# resp.ai_agent.tags #=> Hash
|
|
639
750
|
# resp.ai_agent.tags["TagKey"] #=> String
|
|
640
|
-
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
751
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
|
|
641
752
|
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
642
753
|
#
|
|
643
754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIAgent AWS API Documentation
|
|
@@ -660,9 +771,9 @@ module Aws::QConnect
|
|
|
660
771
|
#
|
|
661
772
|
# @option params [String] :client_token
|
|
662
773
|
# 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]
|
|
774
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
775
|
+
# SDK populates this field. For more information about idempotency, see
|
|
776
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
666
777
|
#
|
|
667
778
|
# **A suitable default value is auto-generated.** You should normally
|
|
668
779
|
# not need to pass this option.**
|
|
@@ -699,6 +810,7 @@ module Aws::QConnect
|
|
|
699
810
|
# resp.ai_agent.ai_agent_id #=> String
|
|
700
811
|
# resp.ai_agent.assistant_arn #=> String
|
|
701
812
|
# resp.ai_agent.assistant_id #=> String
|
|
813
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
702
814
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
703
815
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
704
816
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -718,6 +830,7 @@ module Aws::QConnect
|
|
|
718
830
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
719
831
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
720
832
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
833
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
721
834
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
722
835
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
723
836
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -735,6 +848,25 @@ module Aws::QConnect
|
|
|
735
848
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
736
849
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
737
850
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
851
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
|
|
852
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
853
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
854
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
855
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
856
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
857
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
858
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
859
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
860
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
861
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
862
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
863
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
864
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
865
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
866
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
867
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
|
|
868
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
|
|
869
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
|
|
738
870
|
# resp.ai_agent.description #=> String
|
|
739
871
|
# resp.ai_agent.modified_time #=> Time
|
|
740
872
|
# resp.ai_agent.name #=> String
|
|
@@ -742,7 +874,7 @@ module Aws::QConnect
|
|
|
742
874
|
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
743
875
|
# resp.ai_agent.tags #=> Hash
|
|
744
876
|
# resp.ai_agent.tags["TagKey"] #=> String
|
|
745
|
-
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
877
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
|
|
746
878
|
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
747
879
|
# resp.version_number #=> Integer
|
|
748
880
|
#
|
|
@@ -755,6 +887,273 @@ module Aws::QConnect
|
|
|
755
887
|
req.send_request(options)
|
|
756
888
|
end
|
|
757
889
|
|
|
890
|
+
# Creates an Amazon Q in Connect AI Guardrail.
|
|
891
|
+
#
|
|
892
|
+
# @option params [required, String] :assistant_id
|
|
893
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
894
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
895
|
+
#
|
|
896
|
+
# @option params [required, String] :blocked_input_messaging
|
|
897
|
+
# The message to return when the AI Guardrail blocks a prompt.
|
|
898
|
+
#
|
|
899
|
+
# @option params [required, String] :blocked_outputs_messaging
|
|
900
|
+
# The message to return when the AI Guardrail blocks a model response.
|
|
901
|
+
#
|
|
902
|
+
# @option params [String] :client_token
|
|
903
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
904
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
905
|
+
# SDK populates this field. For more information about idempotency, see
|
|
906
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
907
|
+
#
|
|
908
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
909
|
+
# not need to pass this option.**
|
|
910
|
+
#
|
|
911
|
+
#
|
|
912
|
+
#
|
|
913
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
914
|
+
#
|
|
915
|
+
# @option params [Types::AIGuardrailContentPolicyConfig] :content_policy_config
|
|
916
|
+
# The content filter policies to configure for the AI Guardrail.
|
|
917
|
+
#
|
|
918
|
+
# @option params [Types::AIGuardrailContextualGroundingPolicyConfig] :contextual_grounding_policy_config
|
|
919
|
+
# The contextual grounding policy configuration used to create an AI
|
|
920
|
+
# Guardrail.
|
|
921
|
+
#
|
|
922
|
+
# @option params [String] :description
|
|
923
|
+
# A description of the AI Guardrail.
|
|
924
|
+
#
|
|
925
|
+
# @option params [required, String] :name
|
|
926
|
+
# The name of the AI Guardrail.
|
|
927
|
+
#
|
|
928
|
+
# @option params [Types::AIGuardrailSensitiveInformationPolicyConfig] :sensitive_information_policy_config
|
|
929
|
+
# The sensitive information policy to configure for the AI Guardrail.
|
|
930
|
+
#
|
|
931
|
+
# @option params [Hash<String,String>] :tags
|
|
932
|
+
# The tags used to organize, track, or control access for this resource.
|
|
933
|
+
#
|
|
934
|
+
# @option params [Types::AIGuardrailTopicPolicyConfig] :topic_policy_config
|
|
935
|
+
# The topic policies to configure for the AI Guardrail.
|
|
936
|
+
#
|
|
937
|
+
# @option params [required, String] :visibility_status
|
|
938
|
+
# The visibility status of the AI Guardrail.
|
|
939
|
+
#
|
|
940
|
+
# @option params [Types::AIGuardrailWordPolicyConfig] :word_policy_config
|
|
941
|
+
# The word policy you configure for the AI Guardrail.
|
|
942
|
+
#
|
|
943
|
+
# @return [Types::CreateAIGuardrailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
944
|
+
#
|
|
945
|
+
# * {Types::CreateAIGuardrailResponse#ai_guardrail #ai_guardrail} => Types::AIGuardrailData
|
|
946
|
+
#
|
|
947
|
+
# @example Request syntax with placeholder values
|
|
948
|
+
#
|
|
949
|
+
# resp = client.create_ai_guardrail({
|
|
950
|
+
# assistant_id: "UuidOrArn", # required
|
|
951
|
+
# blocked_input_messaging: "AIGuardrailBlockedMessaging", # required
|
|
952
|
+
# blocked_outputs_messaging: "AIGuardrailBlockedMessaging", # required
|
|
953
|
+
# client_token: "ClientToken",
|
|
954
|
+
# content_policy_config: {
|
|
955
|
+
# filters_config: [ # required
|
|
956
|
+
# {
|
|
957
|
+
# input_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
|
|
958
|
+
# output_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
|
|
959
|
+
# type: "SEXUAL", # required, accepts SEXUAL, VIOLENCE, HATE, INSULTS, MISCONDUCT, PROMPT_ATTACK
|
|
960
|
+
# },
|
|
961
|
+
# ],
|
|
962
|
+
# },
|
|
963
|
+
# contextual_grounding_policy_config: {
|
|
964
|
+
# filters_config: [ # required
|
|
965
|
+
# {
|
|
966
|
+
# threshold: 1.0, # required
|
|
967
|
+
# type: "GROUNDING", # required, accepts GROUNDING, RELEVANCE
|
|
968
|
+
# },
|
|
969
|
+
# ],
|
|
970
|
+
# },
|
|
971
|
+
# description: "AIGuardrailDescription",
|
|
972
|
+
# name: "Name", # required
|
|
973
|
+
# sensitive_information_policy_config: {
|
|
974
|
+
# pii_entities_config: [
|
|
975
|
+
# {
|
|
976
|
+
# action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
|
|
977
|
+
# type: "ADDRESS", # required, accepts ADDRESS, AGE, AWS_ACCESS_KEY, AWS_SECRET_KEY, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, DRIVER_ID, EMAIL, INTERNATIONAL_BANK_ACCOUNT_NUMBER, IP_ADDRESS, LICENSE_PLATE, MAC_ADDRESS, NAME, PASSWORD, PHONE, PIN, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, URL, USERNAME, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, VEHICLE_IDENTIFICATION_NUMBER
|
|
978
|
+
# },
|
|
979
|
+
# ],
|
|
980
|
+
# regexes_config: [
|
|
981
|
+
# {
|
|
982
|
+
# action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
|
|
983
|
+
# description: "GuardrailRegexDescription",
|
|
984
|
+
# name: "GuardrailRegexName", # required
|
|
985
|
+
# pattern: "GuardrailRegexPattern", # required
|
|
986
|
+
# },
|
|
987
|
+
# ],
|
|
988
|
+
# },
|
|
989
|
+
# tags: {
|
|
990
|
+
# "TagKey" => "TagValue",
|
|
991
|
+
# },
|
|
992
|
+
# topic_policy_config: {
|
|
993
|
+
# topics_config: [ # required
|
|
994
|
+
# {
|
|
995
|
+
# definition: "GuardrailTopicDefinition", # required
|
|
996
|
+
# examples: ["GuardrailTopicExample"],
|
|
997
|
+
# name: "GuardrailTopicName", # required
|
|
998
|
+
# type: "DENY", # required, accepts DENY
|
|
999
|
+
# },
|
|
1000
|
+
# ],
|
|
1001
|
+
# },
|
|
1002
|
+
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
1003
|
+
# word_policy_config: {
|
|
1004
|
+
# managed_word_lists_config: [
|
|
1005
|
+
# {
|
|
1006
|
+
# type: "PROFANITY", # required, accepts PROFANITY
|
|
1007
|
+
# },
|
|
1008
|
+
# ],
|
|
1009
|
+
# words_config: [
|
|
1010
|
+
# {
|
|
1011
|
+
# text: "GuardrailWordText", # required
|
|
1012
|
+
# },
|
|
1013
|
+
# ],
|
|
1014
|
+
# },
|
|
1015
|
+
# })
|
|
1016
|
+
#
|
|
1017
|
+
# @example Response structure
|
|
1018
|
+
#
|
|
1019
|
+
# resp.ai_guardrail.ai_guardrail_arn #=> String
|
|
1020
|
+
# resp.ai_guardrail.ai_guardrail_id #=> String
|
|
1021
|
+
# resp.ai_guardrail.assistant_arn #=> String
|
|
1022
|
+
# resp.ai_guardrail.assistant_id #=> String
|
|
1023
|
+
# resp.ai_guardrail.blocked_input_messaging #=> String
|
|
1024
|
+
# resp.ai_guardrail.blocked_outputs_messaging #=> String
|
|
1025
|
+
# resp.ai_guardrail.content_policy_config.filters_config #=> Array
|
|
1026
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
1027
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
1028
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
|
|
1029
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
|
|
1030
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
|
|
1031
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
|
|
1032
|
+
# resp.ai_guardrail.description #=> String
|
|
1033
|
+
# resp.ai_guardrail.modified_time #=> Time
|
|
1034
|
+
# resp.ai_guardrail.name #=> String
|
|
1035
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
|
|
1036
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
1037
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
|
|
1038
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
|
|
1039
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
1040
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
|
|
1041
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
|
|
1042
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
|
|
1043
|
+
# resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
1044
|
+
# resp.ai_guardrail.tags #=> Hash
|
|
1045
|
+
# resp.ai_guardrail.tags["TagKey"] #=> String
|
|
1046
|
+
# resp.ai_guardrail.topic_policy_config.topics_config #=> Array
|
|
1047
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
|
|
1048
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
|
|
1049
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
|
|
1050
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
|
|
1051
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
|
|
1052
|
+
# resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
1053
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
|
|
1054
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
|
|
1055
|
+
# resp.ai_guardrail.word_policy_config.words_config #=> Array
|
|
1056
|
+
# resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
|
|
1057
|
+
#
|
|
1058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrail AWS API Documentation
|
|
1059
|
+
#
|
|
1060
|
+
# @overload create_ai_guardrail(params = {})
|
|
1061
|
+
# @param [Hash] params ({})
|
|
1062
|
+
def create_ai_guardrail(params = {}, options = {})
|
|
1063
|
+
req = build_request(:create_ai_guardrail, params)
|
|
1064
|
+
req.send_request(options)
|
|
1065
|
+
end
|
|
1066
|
+
|
|
1067
|
+
# Creates an Amazon Q in Connect AI Guardrail version.
|
|
1068
|
+
#
|
|
1069
|
+
# @option params [required, String] :ai_guardrail_id
|
|
1070
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
|
1071
|
+
#
|
|
1072
|
+
# @option params [required, String] :assistant_id
|
|
1073
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
1074
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
1075
|
+
#
|
|
1076
|
+
# @option params [String] :client_token
|
|
1077
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
1078
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
1079
|
+
# SDK populates this field. For more information about idempotency, see
|
|
1080
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
1081
|
+
#
|
|
1082
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1083
|
+
# not need to pass this option.**
|
|
1084
|
+
#
|
|
1085
|
+
#
|
|
1086
|
+
#
|
|
1087
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1088
|
+
#
|
|
1089
|
+
# @option params [Time,DateTime,Date,Integer,String] :modified_time
|
|
1090
|
+
# The time the AI Guardrail was last modified.
|
|
1091
|
+
#
|
|
1092
|
+
# @return [Types::CreateAIGuardrailVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1093
|
+
#
|
|
1094
|
+
# * {Types::CreateAIGuardrailVersionResponse#ai_guardrail #ai_guardrail} => Types::AIGuardrailData
|
|
1095
|
+
# * {Types::CreateAIGuardrailVersionResponse#version_number #version_number} => Integer
|
|
1096
|
+
#
|
|
1097
|
+
# @example Request syntax with placeholder values
|
|
1098
|
+
#
|
|
1099
|
+
# resp = client.create_ai_guardrail_version({
|
|
1100
|
+
# ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
1101
|
+
# assistant_id: "UuidOrArn", # required
|
|
1102
|
+
# client_token: "ClientToken",
|
|
1103
|
+
# modified_time: Time.now,
|
|
1104
|
+
# })
|
|
1105
|
+
#
|
|
1106
|
+
# @example Response structure
|
|
1107
|
+
#
|
|
1108
|
+
# resp.ai_guardrail.ai_guardrail_arn #=> String
|
|
1109
|
+
# resp.ai_guardrail.ai_guardrail_id #=> String
|
|
1110
|
+
# resp.ai_guardrail.assistant_arn #=> String
|
|
1111
|
+
# resp.ai_guardrail.assistant_id #=> String
|
|
1112
|
+
# resp.ai_guardrail.blocked_input_messaging #=> String
|
|
1113
|
+
# resp.ai_guardrail.blocked_outputs_messaging #=> String
|
|
1114
|
+
# resp.ai_guardrail.content_policy_config.filters_config #=> Array
|
|
1115
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
1116
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
1117
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
|
|
1118
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
|
|
1119
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
|
|
1120
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
|
|
1121
|
+
# resp.ai_guardrail.description #=> String
|
|
1122
|
+
# resp.ai_guardrail.modified_time #=> Time
|
|
1123
|
+
# resp.ai_guardrail.name #=> String
|
|
1124
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
|
|
1125
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
1126
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
|
|
1127
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
|
|
1128
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
1129
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
|
|
1130
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
|
|
1131
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
|
|
1132
|
+
# resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
1133
|
+
# resp.ai_guardrail.tags #=> Hash
|
|
1134
|
+
# resp.ai_guardrail.tags["TagKey"] #=> String
|
|
1135
|
+
# resp.ai_guardrail.topic_policy_config.topics_config #=> Array
|
|
1136
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
|
|
1137
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
|
|
1138
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
|
|
1139
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
|
|
1140
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
|
|
1141
|
+
# resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
1142
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
|
|
1143
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
|
|
1144
|
+
# resp.ai_guardrail.word_policy_config.words_config #=> Array
|
|
1145
|
+
# resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
|
|
1146
|
+
# resp.version_number #=> Integer
|
|
1147
|
+
#
|
|
1148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersion AWS API Documentation
|
|
1149
|
+
#
|
|
1150
|
+
# @overload create_ai_guardrail_version(params = {})
|
|
1151
|
+
# @param [Hash] params ({})
|
|
1152
|
+
def create_ai_guardrail_version(params = {}, options = {})
|
|
1153
|
+
req = build_request(:create_ai_guardrail_version, params)
|
|
1154
|
+
req.send_request(options)
|
|
1155
|
+
end
|
|
1156
|
+
|
|
758
1157
|
# Creates an Amazon Q in Connect AI Prompt.
|
|
759
1158
|
#
|
|
760
1159
|
# @option params [required, String] :api_format
|
|
@@ -766,9 +1165,9 @@ module Aws::QConnect
|
|
|
766
1165
|
#
|
|
767
1166
|
# @option params [String] :client_token
|
|
768
1167
|
# 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]
|
|
1168
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
1169
|
+
# SDK populates this field. For more information about idempotency, see
|
|
1170
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
772
1171
|
#
|
|
773
1172
|
# **A suitable default value is auto-generated.** You should normally
|
|
774
1173
|
# not need to pass this option.**
|
|
@@ -824,7 +1223,7 @@ module Aws::QConnect
|
|
|
824
1223
|
# },
|
|
825
1224
|
# },
|
|
826
1225
|
# template_type: "TEXT", # required, accepts TEXT
|
|
827
|
-
# type: "ANSWER_GENERATION", # required, accepts ANSWER_GENERATION, INTENT_LABELING_GENERATION, QUERY_REFORMULATION
|
|
1226
|
+
# type: "ANSWER_GENERATION", # required, accepts ANSWER_GENERATION, INTENT_LABELING_GENERATION, QUERY_REFORMULATION, SELF_SERVICE_PRE_PROCESSING, SELF_SERVICE_ANSWER_GENERATION
|
|
828
1227
|
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
829
1228
|
# })
|
|
830
1229
|
#
|
|
@@ -845,7 +1244,7 @@ module Aws::QConnect
|
|
|
845
1244
|
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
846
1245
|
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
847
1246
|
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
848
|
-
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
1247
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
|
|
849
1248
|
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
850
1249
|
#
|
|
851
1250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPrompt AWS API Documentation
|
|
@@ -868,16 +1267,16 @@ module Aws::QConnect
|
|
|
868
1267
|
#
|
|
869
1268
|
# @option params [String] :client_token
|
|
870
1269
|
# 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]
|
|
1270
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
1271
|
+
# SDK populates this field. For more information about idempotency, see
|
|
1272
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
874
1273
|
#
|
|
875
1274
|
# **A suitable default value is auto-generated.** You should normally
|
|
876
1275
|
# not need to pass this option.**
|
|
877
1276
|
#
|
|
878
1277
|
#
|
|
879
1278
|
#
|
|
880
|
-
# [1]: http://aws.amazon.com/
|
|
1279
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
881
1280
|
#
|
|
882
1281
|
# @option params [Time,DateTime,Date,Integer,String] :modified_time
|
|
883
1282
|
# The time the AI Prompt was last modified.
|
|
@@ -913,7 +1312,7 @@ module Aws::QConnect
|
|
|
913
1312
|
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
914
1313
|
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
915
1314
|
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
916
|
-
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
1315
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
|
|
917
1316
|
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
918
1317
|
# resp.version_number #=> Integer
|
|
919
1318
|
#
|
|
@@ -939,7 +1338,7 @@ module Aws::QConnect
|
|
|
939
1338
|
#
|
|
940
1339
|
#
|
|
941
1340
|
#
|
|
942
|
-
# [1]:
|
|
1341
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
943
1342
|
#
|
|
944
1343
|
# @option params [String] :description
|
|
945
1344
|
# The description of the assistant.
|
|
@@ -1042,7 +1441,7 @@ module Aws::QConnect
|
|
|
1042
1441
|
#
|
|
1043
1442
|
#
|
|
1044
1443
|
#
|
|
1045
|
-
# [1]:
|
|
1444
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1046
1445
|
#
|
|
1047
1446
|
# @option params [Hash<String,String>] :tags
|
|
1048
1447
|
# The tags used to organize, track, or control access for this resource.
|
|
@@ -1104,7 +1503,7 @@ module Aws::QConnect
|
|
|
1104
1503
|
#
|
|
1105
1504
|
#
|
|
1106
1505
|
#
|
|
1107
|
-
# [1]:
|
|
1506
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1108
1507
|
#
|
|
1109
1508
|
# @option params [required, String] :knowledge_base_id
|
|
1110
1509
|
# The identifier of the knowledge base. This should not be a
|
|
@@ -1237,7 +1636,7 @@ module Aws::QConnect
|
|
|
1237
1636
|
#
|
|
1238
1637
|
#
|
|
1239
1638
|
#
|
|
1240
|
-
# [1]:
|
|
1639
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1241
1640
|
#
|
|
1242
1641
|
# @option params [required, String] :content_id
|
|
1243
1642
|
# The identifier of the content.
|
|
@@ -1330,7 +1729,7 @@ module Aws::QConnect
|
|
|
1330
1729
|
#
|
|
1331
1730
|
#
|
|
1332
1731
|
#
|
|
1333
|
-
# [1]:
|
|
1732
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1334
1733
|
#
|
|
1335
1734
|
# @option params [String] :description
|
|
1336
1735
|
# The description.
|
|
@@ -1365,7 +1764,7 @@ module Aws::QConnect
|
|
|
1365
1764
|
#
|
|
1366
1765
|
# @option params [Types::SourceConfiguration] :source_configuration
|
|
1367
1766
|
# The source of the knowledge base content. Only set this argument for
|
|
1368
|
-
# EXTERNAL knowledge bases.
|
|
1767
|
+
# EXTERNAL or Managed knowledge bases.
|
|
1369
1768
|
#
|
|
1370
1769
|
# @option params [Hash<String,String>] :tags
|
|
1371
1770
|
# The tags used to organize, track, or control access for this resource.
|
|
@@ -1498,10 +1897,14 @@ module Aws::QConnect
|
|
|
1498
1897
|
req.send_request(options)
|
|
1499
1898
|
end
|
|
1500
1899
|
|
|
1501
|
-
# Creates an Amazon Q in Connect
|
|
1900
|
+
# Creates an Amazon Q in Connect message template. The name of the
|
|
1901
|
+
# message template has to be unique for each knowledge base. The channel
|
|
1902
|
+
# subtype of the message template is immutable and cannot be modified
|
|
1903
|
+
# after creation. After the message template is created, you can use the
|
|
1904
|
+
# `$LATEST` qualifier to reference the created message template.
|
|
1502
1905
|
#
|
|
1503
|
-
# @option params [
|
|
1504
|
-
# The
|
|
1906
|
+
# @option params [required, String] :channel_subtype
|
|
1907
|
+
# The channel subtype this message template applies to.
|
|
1505
1908
|
#
|
|
1506
1909
|
# @option params [String] :client_token
|
|
1507
1910
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
@@ -1514,29 +1917,24 @@ module Aws::QConnect
|
|
|
1514
1917
|
#
|
|
1515
1918
|
#
|
|
1516
1919
|
#
|
|
1517
|
-
# [1]:
|
|
1518
|
-
#
|
|
1519
|
-
# @option params [required, Types::QuickResponseDataProvider] :content
|
|
1520
|
-
# The content of the quick response.
|
|
1521
|
-
#
|
|
1522
|
-
# @option params [String] :content_type
|
|
1523
|
-
# The media type of the quick response content.
|
|
1920
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1524
1921
|
#
|
|
1525
|
-
#
|
|
1526
|
-
#
|
|
1922
|
+
# @option params [required, Types::MessageTemplateContentProvider] :content
|
|
1923
|
+
# The content of the message template.
|
|
1527
1924
|
#
|
|
1528
|
-
#
|
|
1529
|
-
#
|
|
1925
|
+
# @option params [Types::MessageTemplateAttributes] :default_attributes
|
|
1926
|
+
# An object that specifies the default values to use for variables in
|
|
1927
|
+
# the message template. This object contains different categories of
|
|
1928
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
|
1929
|
+
# message template. The corresponding value defines the default value
|
|
1930
|
+
# for that variable.
|
|
1530
1931
|
#
|
|
1531
1932
|
# @option params [String] :description
|
|
1532
|
-
# The description of the
|
|
1933
|
+
# The description of the message template.
|
|
1533
1934
|
#
|
|
1534
1935
|
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
|
1535
|
-
# The configuration information of the
|
|
1536
|
-
#
|
|
1537
|
-
#
|
|
1538
|
-
# @option params [Boolean] :is_active
|
|
1539
|
-
# Whether the quick response is active.
|
|
1936
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
|
1937
|
+
# users.
|
|
1540
1938
|
#
|
|
1541
1939
|
# @option params [required, String] :knowledge_base_id
|
|
1542
1940
|
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
@@ -1549,38 +1947,134 @@ module Aws::QConnect
|
|
|
1549
1947
|
# `zh_CN`, `zh_TW`
|
|
1550
1948
|
#
|
|
1551
1949
|
# @option params [required, String] :name
|
|
1552
|
-
# The name of the
|
|
1553
|
-
#
|
|
1554
|
-
# @option params [String] :shortcut_key
|
|
1555
|
-
# The shortcut key of the quick response. The value should be unique
|
|
1556
|
-
# across the knowledge base.
|
|
1950
|
+
# The name of the message template.
|
|
1557
1951
|
#
|
|
1558
1952
|
# @option params [Hash<String,String>] :tags
|
|
1559
1953
|
# The tags used to organize, track, or control access for this resource.
|
|
1560
1954
|
#
|
|
1561
|
-
# @return [Types::
|
|
1955
|
+
# @return [Types::CreateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1562
1956
|
#
|
|
1563
|
-
# * {Types::
|
|
1957
|
+
# * {Types::CreateMessageTemplateResponse#message_template #message_template} => Types::MessageTemplateData
|
|
1564
1958
|
#
|
|
1565
1959
|
# @example Request syntax with placeholder values
|
|
1566
1960
|
#
|
|
1567
|
-
# resp = client.
|
|
1568
|
-
#
|
|
1569
|
-
# client_token: "
|
|
1961
|
+
# resp = client.create_message_template({
|
|
1962
|
+
# channel_subtype: "EMAIL", # required, accepts EMAIL, SMS
|
|
1963
|
+
# client_token: "ClientToken",
|
|
1570
1964
|
# content: { # required
|
|
1571
|
-
#
|
|
1965
|
+
# email: {
|
|
1966
|
+
# body: {
|
|
1967
|
+
# html: {
|
|
1968
|
+
# content: "NonEmptyUnlimitedString",
|
|
1969
|
+
# },
|
|
1970
|
+
# plain_text: {
|
|
1971
|
+
# content: "NonEmptyUnlimitedString",
|
|
1972
|
+
# },
|
|
1973
|
+
# },
|
|
1974
|
+
# headers: [
|
|
1975
|
+
# {
|
|
1976
|
+
# name: "EmailHeaderKey",
|
|
1977
|
+
# value: "EmailHeaderValue",
|
|
1978
|
+
# },
|
|
1979
|
+
# ],
|
|
1980
|
+
# subject: "NonEmptyUnlimitedString",
|
|
1981
|
+
# },
|
|
1982
|
+
# sms: {
|
|
1983
|
+
# body: {
|
|
1984
|
+
# plain_text: {
|
|
1985
|
+
# content: "NonEmptyUnlimitedString",
|
|
1986
|
+
# },
|
|
1987
|
+
# },
|
|
1988
|
+
# },
|
|
1572
1989
|
# },
|
|
1573
|
-
#
|
|
1574
|
-
#
|
|
1990
|
+
# default_attributes: {
|
|
1991
|
+
# agent_attributes: {
|
|
1992
|
+
# first_name: "MessageTemplateAttributeValue",
|
|
1993
|
+
# last_name: "MessageTemplateAttributeValue",
|
|
1994
|
+
# },
|
|
1995
|
+
# custom_attributes: {
|
|
1996
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
|
1997
|
+
# },
|
|
1998
|
+
# customer_profile_attributes: {
|
|
1999
|
+
# account_number: "MessageTemplateAttributeValue",
|
|
2000
|
+
# additional_information: "MessageTemplateAttributeValue",
|
|
2001
|
+
# address1: "MessageTemplateAttributeValue",
|
|
2002
|
+
# address2: "MessageTemplateAttributeValue",
|
|
2003
|
+
# address3: "MessageTemplateAttributeValue",
|
|
2004
|
+
# address4: "MessageTemplateAttributeValue",
|
|
2005
|
+
# billing_address_1: "MessageTemplateAttributeValue",
|
|
2006
|
+
# billing_address_2: "MessageTemplateAttributeValue",
|
|
2007
|
+
# billing_address_3: "MessageTemplateAttributeValue",
|
|
2008
|
+
# billing_address_4: "MessageTemplateAttributeValue",
|
|
2009
|
+
# billing_city: "MessageTemplateAttributeValue",
|
|
2010
|
+
# billing_country: "MessageTemplateAttributeValue",
|
|
2011
|
+
# billing_county: "MessageTemplateAttributeValue",
|
|
2012
|
+
# billing_postal_code: "MessageTemplateAttributeValue",
|
|
2013
|
+
# billing_province: "MessageTemplateAttributeValue",
|
|
2014
|
+
# billing_state: "MessageTemplateAttributeValue",
|
|
2015
|
+
# birth_date: "MessageTemplateAttributeValue",
|
|
2016
|
+
# business_email_address: "MessageTemplateAttributeValue",
|
|
2017
|
+
# business_name: "MessageTemplateAttributeValue",
|
|
2018
|
+
# business_phone_number: "MessageTemplateAttributeValue",
|
|
2019
|
+
# city: "MessageTemplateAttributeValue",
|
|
2020
|
+
# country: "MessageTemplateAttributeValue",
|
|
2021
|
+
# county: "MessageTemplateAttributeValue",
|
|
2022
|
+
# custom: {
|
|
2023
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
|
2024
|
+
# },
|
|
2025
|
+
# email_address: "MessageTemplateAttributeValue",
|
|
2026
|
+
# first_name: "MessageTemplateAttributeValue",
|
|
2027
|
+
# gender: "MessageTemplateAttributeValue",
|
|
2028
|
+
# home_phone_number: "MessageTemplateAttributeValue",
|
|
2029
|
+
# last_name: "MessageTemplateAttributeValue",
|
|
2030
|
+
# mailing_address_1: "MessageTemplateAttributeValue",
|
|
2031
|
+
# mailing_address_2: "MessageTemplateAttributeValue",
|
|
2032
|
+
# mailing_address_3: "MessageTemplateAttributeValue",
|
|
2033
|
+
# mailing_address_4: "MessageTemplateAttributeValue",
|
|
2034
|
+
# mailing_city: "MessageTemplateAttributeValue",
|
|
2035
|
+
# mailing_country: "MessageTemplateAttributeValue",
|
|
2036
|
+
# mailing_county: "MessageTemplateAttributeValue",
|
|
2037
|
+
# mailing_postal_code: "MessageTemplateAttributeValue",
|
|
2038
|
+
# mailing_province: "MessageTemplateAttributeValue",
|
|
2039
|
+
# mailing_state: "MessageTemplateAttributeValue",
|
|
2040
|
+
# middle_name: "MessageTemplateAttributeValue",
|
|
2041
|
+
# mobile_phone_number: "MessageTemplateAttributeValue",
|
|
2042
|
+
# party_type: "MessageTemplateAttributeValue",
|
|
2043
|
+
# phone_number: "MessageTemplateAttributeValue",
|
|
2044
|
+
# postal_code: "MessageTemplateAttributeValue",
|
|
2045
|
+
# profile_arn: "MessageTemplateAttributeValue",
|
|
2046
|
+
# profile_id: "MessageTemplateAttributeValue",
|
|
2047
|
+
# province: "MessageTemplateAttributeValue",
|
|
2048
|
+
# shipping_address_1: "MessageTemplateAttributeValue",
|
|
2049
|
+
# shipping_address_2: "MessageTemplateAttributeValue",
|
|
2050
|
+
# shipping_address_3: "MessageTemplateAttributeValue",
|
|
2051
|
+
# shipping_address_4: "MessageTemplateAttributeValue",
|
|
2052
|
+
# shipping_city: "MessageTemplateAttributeValue",
|
|
2053
|
+
# shipping_country: "MessageTemplateAttributeValue",
|
|
2054
|
+
# shipping_county: "MessageTemplateAttributeValue",
|
|
2055
|
+
# shipping_postal_code: "MessageTemplateAttributeValue",
|
|
2056
|
+
# shipping_province: "MessageTemplateAttributeValue",
|
|
2057
|
+
# shipping_state: "MessageTemplateAttributeValue",
|
|
2058
|
+
# state: "MessageTemplateAttributeValue",
|
|
2059
|
+
# },
|
|
2060
|
+
# system_attributes: {
|
|
2061
|
+
# customer_endpoint: {
|
|
2062
|
+
# address: "MessageTemplateAttributeValue",
|
|
2063
|
+
# },
|
|
2064
|
+
# name: "MessageTemplateAttributeValue",
|
|
2065
|
+
# system_endpoint: {
|
|
2066
|
+
# address: "MessageTemplateAttributeValue",
|
|
2067
|
+
# },
|
|
2068
|
+
# },
|
|
2069
|
+
# },
|
|
2070
|
+
# description: "Description",
|
|
1575
2071
|
# grouping_configuration: {
|
|
1576
2072
|
# criteria: "GroupingCriteria",
|
|
1577
2073
|
# values: ["GroupingValue"],
|
|
1578
2074
|
# },
|
|
1579
|
-
# is_active: false,
|
|
1580
2075
|
# knowledge_base_id: "UuidOrArn", # required
|
|
1581
2076
|
# language: "LanguageCode",
|
|
1582
|
-
# name: "
|
|
1583
|
-
# shortcut_key: "ShortCutKey",
|
|
2077
|
+
# name: "Name", # required
|
|
1584
2078
|
# tags: {
|
|
1585
2079
|
# "TagKey" => "TagValue",
|
|
1586
2080
|
# },
|
|
@@ -1588,7 +2082,424 @@ module Aws::QConnect
|
|
|
1588
2082
|
#
|
|
1589
2083
|
# @example Response structure
|
|
1590
2084
|
#
|
|
1591
|
-
# resp.
|
|
2085
|
+
# resp.message_template.attribute_types #=> Array
|
|
2086
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
|
2087
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
2088
|
+
# resp.message_template.content.email.body.html.content #=> String
|
|
2089
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
|
2090
|
+
# resp.message_template.content.email.headers #=> Array
|
|
2091
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
|
2092
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
|
2093
|
+
# resp.message_template.content.email.subject #=> String
|
|
2094
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
|
2095
|
+
# resp.message_template.created_time #=> Time
|
|
2096
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
|
2097
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
|
2098
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
|
2099
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
|
2100
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
|
2101
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
|
2102
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
|
2103
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
|
2104
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
|
2105
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
|
2106
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
|
2107
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
|
2108
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
|
2109
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
|
2110
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
|
2111
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
|
2112
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
|
2113
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
|
2114
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
|
2115
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
|
2116
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
|
2117
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
|
2118
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
|
2119
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
|
2120
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
|
2121
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
|
2122
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
|
2123
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
|
2124
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
|
2125
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
|
2126
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
|
2127
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
|
2128
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
|
2129
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
|
2130
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
|
2131
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
|
2132
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
|
2133
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
|
2134
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
|
2135
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
|
2136
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
|
2137
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
|
2138
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
|
2139
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
|
2140
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
|
2141
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
|
2142
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
|
2143
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
|
2144
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
|
2145
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
|
2146
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
|
2147
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
|
2148
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
|
2149
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
|
2150
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
|
2151
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
|
2152
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
|
2153
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
|
2154
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
|
2155
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
|
2156
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
|
2157
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
|
2158
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
|
2159
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
|
2160
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
|
2161
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
|
2162
|
+
# resp.message_template.description #=> String
|
|
2163
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
|
2164
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
|
2165
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
|
2166
|
+
# resp.message_template.knowledge_base_arn #=> String
|
|
2167
|
+
# resp.message_template.knowledge_base_id #=> String
|
|
2168
|
+
# resp.message_template.language #=> String
|
|
2169
|
+
# resp.message_template.last_modified_by #=> String
|
|
2170
|
+
# resp.message_template.last_modified_time #=> Time
|
|
2171
|
+
# resp.message_template.message_template_arn #=> String
|
|
2172
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
|
2173
|
+
# resp.message_template.message_template_id #=> String
|
|
2174
|
+
# resp.message_template.name #=> String
|
|
2175
|
+
# resp.message_template.tags #=> Hash
|
|
2176
|
+
# resp.message_template.tags["TagKey"] #=> String
|
|
2177
|
+
#
|
|
2178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplate AWS API Documentation
|
|
2179
|
+
#
|
|
2180
|
+
# @overload create_message_template(params = {})
|
|
2181
|
+
# @param [Hash] params ({})
|
|
2182
|
+
def create_message_template(params = {}, options = {})
|
|
2183
|
+
req = build_request(:create_message_template, params)
|
|
2184
|
+
req.send_request(options)
|
|
2185
|
+
end
|
|
2186
|
+
|
|
2187
|
+
# Uploads an attachment file to the specified Amazon Q in Connect
|
|
2188
|
+
# message template. The name of the message template attachment has to
|
|
2189
|
+
# be unique for each message template referenced by the `$LATEST`
|
|
2190
|
+
# qualifier. The body of the attachment file should be encoded using
|
|
2191
|
+
# base64 encoding. After the file is uploaded, you can use the
|
|
2192
|
+
# pre-signed Amazon S3 URL returned in response to download the uploaded
|
|
2193
|
+
# file.
|
|
2194
|
+
#
|
|
2195
|
+
# @option params [required, String] :body
|
|
2196
|
+
# The body of the attachment file being uploaded. It should be encoded
|
|
2197
|
+
# using base64 encoding.
|
|
2198
|
+
#
|
|
2199
|
+
# @option params [String] :client_token
|
|
2200
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
2201
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
2202
|
+
# SDK populates this field. For more information about idempotency, see
|
|
2203
|
+
# [Making retries safe with idempotent APIs][1].
|
|
2204
|
+
#
|
|
2205
|
+
#
|
|
2206
|
+
#
|
|
2207
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
2208
|
+
#
|
|
2209
|
+
# @option params [required, String] :content_disposition
|
|
2210
|
+
# The presentation information for the attachment file.
|
|
2211
|
+
#
|
|
2212
|
+
# @option params [required, String] :knowledge_base_id
|
|
2213
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
2214
|
+
# URLs cannot contain the ARN.
|
|
2215
|
+
#
|
|
2216
|
+
# @option params [required, String] :message_template_id
|
|
2217
|
+
# The identifier of the message template. Can be either the ID or the
|
|
2218
|
+
# ARN. It cannot contain any qualifier.
|
|
2219
|
+
#
|
|
2220
|
+
# @option params [required, String] :name
|
|
2221
|
+
# The name of the attachment file being uploaded. The name should
|
|
2222
|
+
# include the file extension.
|
|
2223
|
+
#
|
|
2224
|
+
# @return [Types::CreateMessageTemplateAttachmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2225
|
+
#
|
|
2226
|
+
# * {Types::CreateMessageTemplateAttachmentResponse#attachment #attachment} => Types::MessageTemplateAttachment
|
|
2227
|
+
#
|
|
2228
|
+
# @example Request syntax with placeholder values
|
|
2229
|
+
#
|
|
2230
|
+
# resp = client.create_message_template_attachment({
|
|
2231
|
+
# body: "NonEmptyUnlimitedString", # required
|
|
2232
|
+
# client_token: "ClientToken",
|
|
2233
|
+
# content_disposition: "ATTACHMENT", # required, accepts ATTACHMENT
|
|
2234
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
2235
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2236
|
+
# name: "AttachmentFileName", # required
|
|
2237
|
+
# })
|
|
2238
|
+
#
|
|
2239
|
+
# @example Response structure
|
|
2240
|
+
#
|
|
2241
|
+
# resp.attachment.attachment_id #=> String
|
|
2242
|
+
# resp.attachment.content_disposition #=> String, one of "ATTACHMENT"
|
|
2243
|
+
# resp.attachment.name #=> String
|
|
2244
|
+
# resp.attachment.uploaded_time #=> Time
|
|
2245
|
+
# resp.attachment.url #=> String
|
|
2246
|
+
# resp.attachment.url_expiry #=> Time
|
|
2247
|
+
#
|
|
2248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateAttachment AWS API Documentation
|
|
2249
|
+
#
|
|
2250
|
+
# @overload create_message_template_attachment(params = {})
|
|
2251
|
+
# @param [Hash] params ({})
|
|
2252
|
+
def create_message_template_attachment(params = {}, options = {})
|
|
2253
|
+
req = build_request(:create_message_template_attachment, params)
|
|
2254
|
+
req.send_request(options)
|
|
2255
|
+
end
|
|
2256
|
+
|
|
2257
|
+
# Creates a new Amazon Q in Connect message template version from the
|
|
2258
|
+
# current content and configuration of a message template. Versions are
|
|
2259
|
+
# immutable and monotonically increasing. Once a version is created, you
|
|
2260
|
+
# can reference a specific version of the message template by passing in
|
|
2261
|
+
# `<message-template-id>:<versionNumber>` as the message template
|
|
2262
|
+
# identifier. An error is displayed if the supplied
|
|
2263
|
+
# `messageTemplateContentSha256` is different from the
|
|
2264
|
+
# `messageTemplateContentSha256` of the message template with `$LATEST`
|
|
2265
|
+
# qualifier. If multiple `CreateMessageTemplateVersion` requests are
|
|
2266
|
+
# made while the message template remains the same, only the first
|
|
2267
|
+
# invocation creates a new version and the succeeding requests will
|
|
2268
|
+
# return the same response as the first invocation.
|
|
2269
|
+
#
|
|
2270
|
+
# @option params [required, String] :knowledge_base_id
|
|
2271
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
2272
|
+
# URLs cannot contain the ARN.
|
|
2273
|
+
#
|
|
2274
|
+
# @option params [String] :message_template_content_sha_256
|
|
2275
|
+
# The checksum value of the message template content that is referenced
|
|
2276
|
+
# by the `$LATEST` qualifier. It can be returned in
|
|
2277
|
+
# `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
|
|
2278
|
+
# calculated by content, language, `defaultAttributes` and `Attachments`
|
|
2279
|
+
# of the message template. If not supplied, the message template version
|
|
2280
|
+
# will be created based on the message template content that is
|
|
2281
|
+
# referenced by the `$LATEST` qualifier by default.
|
|
2282
|
+
#
|
|
2283
|
+
# @option params [required, String] :message_template_id
|
|
2284
|
+
# The identifier of the message template. Can be either the ID or the
|
|
2285
|
+
# ARN. It cannot contain any qualifier.
|
|
2286
|
+
#
|
|
2287
|
+
# @return [Types::CreateMessageTemplateVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2288
|
+
#
|
|
2289
|
+
# * {Types::CreateMessageTemplateVersionResponse#message_template #message_template} => Types::ExtendedMessageTemplateData
|
|
2290
|
+
#
|
|
2291
|
+
# @example Request syntax with placeholder values
|
|
2292
|
+
#
|
|
2293
|
+
# resp = client.create_message_template_version({
|
|
2294
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
2295
|
+
# message_template_content_sha_256: "MessageTemplateContentSha256",
|
|
2296
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2297
|
+
# })
|
|
2298
|
+
#
|
|
2299
|
+
# @example Response structure
|
|
2300
|
+
#
|
|
2301
|
+
# resp.message_template.attachments #=> Array
|
|
2302
|
+
# resp.message_template.attachments[0].attachment_id #=> String
|
|
2303
|
+
# resp.message_template.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
|
|
2304
|
+
# resp.message_template.attachments[0].name #=> String
|
|
2305
|
+
# resp.message_template.attachments[0].uploaded_time #=> Time
|
|
2306
|
+
# resp.message_template.attachments[0].url #=> String
|
|
2307
|
+
# resp.message_template.attachments[0].url_expiry #=> Time
|
|
2308
|
+
# resp.message_template.attribute_types #=> Array
|
|
2309
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
|
2310
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
2311
|
+
# resp.message_template.content.email.body.html.content #=> String
|
|
2312
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
|
2313
|
+
# resp.message_template.content.email.headers #=> Array
|
|
2314
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
|
2315
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
|
2316
|
+
# resp.message_template.content.email.subject #=> String
|
|
2317
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
|
2318
|
+
# resp.message_template.created_time #=> Time
|
|
2319
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
|
2320
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
|
2321
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
|
2322
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
|
2323
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
|
2324
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
|
2325
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
|
2326
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
|
2327
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
|
2328
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
|
2329
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
|
2330
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
|
2331
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
|
2332
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
|
2333
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
|
2334
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
|
2335
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
|
2336
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
|
2337
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
|
2338
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
|
2339
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
|
2340
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
|
2341
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
|
2342
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
|
2343
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
|
2344
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
|
2345
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
|
2346
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
|
2347
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
|
2348
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
|
2349
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
|
2350
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
|
2351
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
|
2352
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
|
2353
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
|
2354
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
|
2355
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
|
2356
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
|
2357
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
|
2358
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
|
2359
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
|
2360
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
|
2361
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
|
2362
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
|
2363
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
|
2364
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
|
2365
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
|
2366
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
|
2367
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
|
2368
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
|
2369
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
|
2370
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
|
2371
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
|
2372
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
|
2373
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
|
2374
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
|
2375
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
|
2376
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
|
2377
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
|
2378
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
|
2379
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
|
2380
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
|
2381
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
|
2382
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
|
2383
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
|
2384
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
|
2385
|
+
# resp.message_template.description #=> String
|
|
2386
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
|
2387
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
|
2388
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
|
2389
|
+
# resp.message_template.is_active #=> Boolean
|
|
2390
|
+
# resp.message_template.knowledge_base_arn #=> String
|
|
2391
|
+
# resp.message_template.knowledge_base_id #=> String
|
|
2392
|
+
# resp.message_template.language #=> String
|
|
2393
|
+
# resp.message_template.last_modified_by #=> String
|
|
2394
|
+
# resp.message_template.last_modified_time #=> Time
|
|
2395
|
+
# resp.message_template.message_template_arn #=> String
|
|
2396
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
|
2397
|
+
# resp.message_template.message_template_id #=> String
|
|
2398
|
+
# resp.message_template.name #=> String
|
|
2399
|
+
# resp.message_template.tags #=> Hash
|
|
2400
|
+
# resp.message_template.tags["TagKey"] #=> String
|
|
2401
|
+
# resp.message_template.version_number #=> Integer
|
|
2402
|
+
#
|
|
2403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateVersion AWS API Documentation
|
|
2404
|
+
#
|
|
2405
|
+
# @overload create_message_template_version(params = {})
|
|
2406
|
+
# @param [Hash] params ({})
|
|
2407
|
+
def create_message_template_version(params = {}, options = {})
|
|
2408
|
+
req = build_request(:create_message_template_version, params)
|
|
2409
|
+
req.send_request(options)
|
|
2410
|
+
end
|
|
2411
|
+
|
|
2412
|
+
# Creates an Amazon Q in Connect quick response.
|
|
2413
|
+
#
|
|
2414
|
+
# @option params [Array<String>] :channels
|
|
2415
|
+
# The Amazon Connect channels this quick response applies to.
|
|
2416
|
+
#
|
|
2417
|
+
# @option params [String] :client_token
|
|
2418
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
2419
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
2420
|
+
# SDK populates this field. For more information about idempotency, see
|
|
2421
|
+
# [Making retries safe with idempotent APIs][1].
|
|
2422
|
+
#
|
|
2423
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2424
|
+
# not need to pass this option.**
|
|
2425
|
+
#
|
|
2426
|
+
#
|
|
2427
|
+
#
|
|
2428
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
2429
|
+
#
|
|
2430
|
+
# @option params [required, Types::QuickResponseDataProvider] :content
|
|
2431
|
+
# The content of the quick response.
|
|
2432
|
+
#
|
|
2433
|
+
# @option params [String] :content_type
|
|
2434
|
+
# The media type of the quick response content.
|
|
2435
|
+
#
|
|
2436
|
+
# * Use `application/x.quickresponse;format=plain` for a quick response
|
|
2437
|
+
# written in plain text.
|
|
2438
|
+
#
|
|
2439
|
+
# * Use `application/x.quickresponse;format=markdown` for a quick
|
|
2440
|
+
# response written in richtext.
|
|
2441
|
+
#
|
|
2442
|
+
# @option params [String] :description
|
|
2443
|
+
# The description of the quick response.
|
|
2444
|
+
#
|
|
2445
|
+
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
|
2446
|
+
# The configuration information of the user groups that the quick
|
|
2447
|
+
# response is accessible to.
|
|
2448
|
+
#
|
|
2449
|
+
# @option params [Boolean] :is_active
|
|
2450
|
+
# Whether the quick response is active.
|
|
2451
|
+
#
|
|
2452
|
+
# @option params [required, String] :knowledge_base_id
|
|
2453
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
2454
|
+
# URLs cannot contain the ARN.
|
|
2455
|
+
#
|
|
2456
|
+
# @option params [String] :language
|
|
2457
|
+
# The language code value for the language in which the quick response
|
|
2458
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
|
2459
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
|
2460
|
+
# `zh_CN`, `zh_TW`
|
|
2461
|
+
#
|
|
2462
|
+
# @option params [required, String] :name
|
|
2463
|
+
# The name of the quick response.
|
|
2464
|
+
#
|
|
2465
|
+
# @option params [String] :shortcut_key
|
|
2466
|
+
# The shortcut key of the quick response. The value should be unique
|
|
2467
|
+
# across the knowledge base.
|
|
2468
|
+
#
|
|
2469
|
+
# @option params [Hash<String,String>] :tags
|
|
2470
|
+
# The tags used to organize, track, or control access for this resource.
|
|
2471
|
+
#
|
|
2472
|
+
# @return [Types::CreateQuickResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2473
|
+
#
|
|
2474
|
+
# * {Types::CreateQuickResponseResponse#quick_response #quick_response} => Types::QuickResponseData
|
|
2475
|
+
#
|
|
2476
|
+
# @example Request syntax with placeholder values
|
|
2477
|
+
#
|
|
2478
|
+
# resp = client.create_quick_response({
|
|
2479
|
+
# channels: ["Channel"],
|
|
2480
|
+
# client_token: "NonEmptyString",
|
|
2481
|
+
# content: { # required
|
|
2482
|
+
# content: "QuickResponseContent",
|
|
2483
|
+
# },
|
|
2484
|
+
# content_type: "QuickResponseType",
|
|
2485
|
+
# description: "QuickResponseDescription",
|
|
2486
|
+
# grouping_configuration: {
|
|
2487
|
+
# criteria: "GroupingCriteria",
|
|
2488
|
+
# values: ["GroupingValue"],
|
|
2489
|
+
# },
|
|
2490
|
+
# is_active: false,
|
|
2491
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
2492
|
+
# language: "LanguageCode",
|
|
2493
|
+
# name: "QuickResponseName", # required
|
|
2494
|
+
# shortcut_key: "ShortCutKey",
|
|
2495
|
+
# tags: {
|
|
2496
|
+
# "TagKey" => "TagValue",
|
|
2497
|
+
# },
|
|
2498
|
+
# })
|
|
2499
|
+
#
|
|
2500
|
+
# @example Response structure
|
|
2501
|
+
#
|
|
2502
|
+
# resp.quick_response.channels #=> Array
|
|
1592
2503
|
# resp.quick_response.channels[0] #=> String
|
|
1593
2504
|
# resp.quick_response.content_type #=> String
|
|
1594
2505
|
# resp.quick_response.contents.markdown.content #=> String
|
|
@@ -1646,7 +2557,7 @@ module Aws::QConnect
|
|
|
1646
2557
|
#
|
|
1647
2558
|
#
|
|
1648
2559
|
#
|
|
1649
|
-
# [1]:
|
|
2560
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
1650
2561
|
#
|
|
1651
2562
|
# @option params [String] :description
|
|
1652
2563
|
# The description.
|
|
@@ -1739,6 +2650,50 @@ module Aws::QConnect
|
|
|
1739
2650
|
req.send_request(options)
|
|
1740
2651
|
end
|
|
1741
2652
|
|
|
2653
|
+
# Deactivates a specific version of the Amazon Q in Connect message
|
|
2654
|
+
# template . After the version is deactivated, you can no longer use the
|
|
2655
|
+
# `$ACTIVE_VERSION` qualifier to reference the version in active status.
|
|
2656
|
+
#
|
|
2657
|
+
# @option params [required, String] :knowledge_base_id
|
|
2658
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
2659
|
+
# URLs cannot contain the ARN.
|
|
2660
|
+
#
|
|
2661
|
+
# @option params [required, String] :message_template_id
|
|
2662
|
+
# The identifier of the message template. Can be either the ID or the
|
|
2663
|
+
# ARN. It cannot contain any qualifier.
|
|
2664
|
+
#
|
|
2665
|
+
# @option params [required, Integer] :version_number
|
|
2666
|
+
# The version number of the message template version to deactivate.
|
|
2667
|
+
#
|
|
2668
|
+
# @return [Types::DeactivateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2669
|
+
#
|
|
2670
|
+
# * {Types::DeactivateMessageTemplateResponse#message_template_arn #message_template_arn} => String
|
|
2671
|
+
# * {Types::DeactivateMessageTemplateResponse#message_template_id #message_template_id} => String
|
|
2672
|
+
# * {Types::DeactivateMessageTemplateResponse#version_number #version_number} => Integer
|
|
2673
|
+
#
|
|
2674
|
+
# @example Request syntax with placeholder values
|
|
2675
|
+
#
|
|
2676
|
+
# resp = client.deactivate_message_template({
|
|
2677
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
2678
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2679
|
+
# version_number: 1, # required
|
|
2680
|
+
# })
|
|
2681
|
+
#
|
|
2682
|
+
# @example Response structure
|
|
2683
|
+
#
|
|
2684
|
+
# resp.message_template_arn #=> String
|
|
2685
|
+
# resp.message_template_id #=> String
|
|
2686
|
+
# resp.version_number #=> Integer
|
|
2687
|
+
#
|
|
2688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeactivateMessageTemplate AWS API Documentation
|
|
2689
|
+
#
|
|
2690
|
+
# @overload deactivate_message_template(params = {})
|
|
2691
|
+
# @param [Hash] params ({})
|
|
2692
|
+
def deactivate_message_template(params = {}, options = {})
|
|
2693
|
+
req = build_request(:deactivate_message_template, params)
|
|
2694
|
+
req.send_request(options)
|
|
2695
|
+
end
|
|
2696
|
+
|
|
1742
2697
|
# Deletes an Amazon Q in Connect AI Agent.
|
|
1743
2698
|
#
|
|
1744
2699
|
# @option params [required, String] :ai_agent_id
|
|
@@ -1799,6 +2754,65 @@ module Aws::QConnect
|
|
|
1799
2754
|
req.send_request(options)
|
|
1800
2755
|
end
|
|
1801
2756
|
|
|
2757
|
+
# Deletes an Amazon Q in Connect AI Guardrail.
|
|
2758
|
+
#
|
|
2759
|
+
# @option params [required, String] :ai_guardrail_id
|
|
2760
|
+
# The identifier of the Amazon Q in Connect AI Guardrail. Can be either
|
|
2761
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
|
2762
|
+
#
|
|
2763
|
+
# @option params [required, String] :assistant_id
|
|
2764
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2765
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2766
|
+
#
|
|
2767
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2768
|
+
#
|
|
2769
|
+
# @example Request syntax with placeholder values
|
|
2770
|
+
#
|
|
2771
|
+
# resp = client.delete_ai_guardrail({
|
|
2772
|
+
# ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2773
|
+
# assistant_id: "UuidOrArn", # required
|
|
2774
|
+
# })
|
|
2775
|
+
#
|
|
2776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrail AWS API Documentation
|
|
2777
|
+
#
|
|
2778
|
+
# @overload delete_ai_guardrail(params = {})
|
|
2779
|
+
# @param [Hash] params ({})
|
|
2780
|
+
def delete_ai_guardrail(params = {}, options = {})
|
|
2781
|
+
req = build_request(:delete_ai_guardrail, params)
|
|
2782
|
+
req.send_request(options)
|
|
2783
|
+
end
|
|
2784
|
+
|
|
2785
|
+
# Delete and Amazon Q in Connect AI Guardrail version.
|
|
2786
|
+
#
|
|
2787
|
+
# @option params [required, String] :ai_guardrail_id
|
|
2788
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
|
2789
|
+
#
|
|
2790
|
+
# @option params [required, String] :assistant_id
|
|
2791
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
2792
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
2793
|
+
#
|
|
2794
|
+
# @option params [required, Integer] :version_number
|
|
2795
|
+
# The version number of the AI Guardrail version to be deleted.
|
|
2796
|
+
#
|
|
2797
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2798
|
+
#
|
|
2799
|
+
# @example Request syntax with placeholder values
|
|
2800
|
+
#
|
|
2801
|
+
# resp = client.delete_ai_guardrail_version({
|
|
2802
|
+
# ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
2803
|
+
# assistant_id: "UuidOrArn", # required
|
|
2804
|
+
# version_number: 1, # required
|
|
2805
|
+
# })
|
|
2806
|
+
#
|
|
2807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailVersion AWS API Documentation
|
|
2808
|
+
#
|
|
2809
|
+
# @overload delete_ai_guardrail_version(params = {})
|
|
2810
|
+
# @param [Hash] params ({})
|
|
2811
|
+
def delete_ai_guardrail_version(params = {}, options = {})
|
|
2812
|
+
req = build_request(:delete_ai_guardrail_version, params)
|
|
2813
|
+
req.send_request(options)
|
|
2814
|
+
end
|
|
2815
|
+
|
|
1802
2816
|
# Deletes an Amazon Q in Connect AI Prompt.
|
|
1803
2817
|
#
|
|
1804
2818
|
# @option params [required, String] :ai_prompt_id
|
|
@@ -2041,6 +3055,73 @@ module Aws::QConnect
|
|
|
2041
3055
|
req.send_request(options)
|
|
2042
3056
|
end
|
|
2043
3057
|
|
|
3058
|
+
# Deletes an Amazon Q in Connect message template entirely or a specific
|
|
3059
|
+
# version of the message template if version is supplied in the request.
|
|
3060
|
+
# You can provide the message template identifier as
|
|
3061
|
+
# `<message-template-id>:<versionNumber>` to delete a specific version
|
|
3062
|
+
# of the message template. If it is not supplied, the message template
|
|
3063
|
+
# and all available versions will be deleted.
|
|
3064
|
+
#
|
|
3065
|
+
# @option params [required, String] :knowledge_base_id
|
|
3066
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
3067
|
+
# URLs cannot contain the ARN.
|
|
3068
|
+
#
|
|
3069
|
+
# @option params [required, String] :message_template_id
|
|
3070
|
+
# The identifier of the message template. Can be either the ID or the
|
|
3071
|
+
# ARN.
|
|
3072
|
+
#
|
|
3073
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3074
|
+
#
|
|
3075
|
+
# @example Request syntax with placeholder values
|
|
3076
|
+
#
|
|
3077
|
+
# resp = client.delete_message_template({
|
|
3078
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
3079
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
3080
|
+
# })
|
|
3081
|
+
#
|
|
3082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplate AWS API Documentation
|
|
3083
|
+
#
|
|
3084
|
+
# @overload delete_message_template(params = {})
|
|
3085
|
+
# @param [Hash] params ({})
|
|
3086
|
+
def delete_message_template(params = {}, options = {})
|
|
3087
|
+
req = build_request(:delete_message_template, params)
|
|
3088
|
+
req.send_request(options)
|
|
3089
|
+
end
|
|
3090
|
+
|
|
3091
|
+
# Deletes the attachment file from the Amazon Q in Connect message
|
|
3092
|
+
# template that is referenced by `$LATEST` qualifier. Attachments on
|
|
3093
|
+
# available message template versions will remain unchanged.
|
|
3094
|
+
#
|
|
3095
|
+
# @option params [required, String] :attachment_id
|
|
3096
|
+
# The identifier of the attachment file.
|
|
3097
|
+
#
|
|
3098
|
+
# @option params [required, String] :knowledge_base_id
|
|
3099
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
3100
|
+
# URLs cannot contain the ARN.
|
|
3101
|
+
#
|
|
3102
|
+
# @option params [required, String] :message_template_id
|
|
3103
|
+
# The identifier of the message template. Can be either the ID or the
|
|
3104
|
+
# ARN. It cannot contain any qualifier.
|
|
3105
|
+
#
|
|
3106
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3107
|
+
#
|
|
3108
|
+
# @example Request syntax with placeholder values
|
|
3109
|
+
#
|
|
3110
|
+
# resp = client.delete_message_template_attachment({
|
|
3111
|
+
# attachment_id: "Uuid", # required
|
|
3112
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
3113
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
3114
|
+
# })
|
|
3115
|
+
#
|
|
3116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateAttachment AWS API Documentation
|
|
3117
|
+
#
|
|
3118
|
+
# @overload delete_message_template_attachment(params = {})
|
|
3119
|
+
# @param [Hash] params ({})
|
|
3120
|
+
def delete_message_template_attachment(params = {}, options = {})
|
|
3121
|
+
req = build_request(:delete_message_template_attachment, params)
|
|
3122
|
+
req.send_request(options)
|
|
3123
|
+
end
|
|
3124
|
+
|
|
2044
3125
|
# Deletes a quick response.
|
|
2045
3126
|
#
|
|
2046
3127
|
# @option params [required, String] :knowledge_base_id
|
|
@@ -2097,6 +3178,7 @@ module Aws::QConnect
|
|
|
2097
3178
|
# resp.ai_agent.ai_agent_id #=> String
|
|
2098
3179
|
# resp.ai_agent.assistant_arn #=> String
|
|
2099
3180
|
# resp.ai_agent.assistant_id #=> String
|
|
3181
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
2100
3182
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2101
3183
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
2102
3184
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -2116,6 +3198,7 @@ module Aws::QConnect
|
|
|
2116
3198
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2117
3199
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
2118
3200
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
3201
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
2119
3202
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2120
3203
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
2121
3204
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -2133,6 +3216,25 @@ module Aws::QConnect
|
|
|
2133
3216
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2134
3217
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2135
3218
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
3219
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
|
|
3220
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
3221
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
3222
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
3223
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
3224
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
3225
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
3226
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
3227
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
3228
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
3229
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
3230
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
3231
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
3232
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
3233
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
3234
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
3235
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
|
|
3236
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
|
|
3237
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
|
|
2136
3238
|
# resp.ai_agent.description #=> String
|
|
2137
3239
|
# resp.ai_agent.modified_time #=> Time
|
|
2138
3240
|
# resp.ai_agent.name #=> String
|
|
@@ -2140,7 +3242,7 @@ module Aws::QConnect
|
|
|
2140
3242
|
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2141
3243
|
# resp.ai_agent.tags #=> Hash
|
|
2142
3244
|
# resp.ai_agent.tags["TagKey"] #=> String
|
|
2143
|
-
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
3245
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
|
|
2144
3246
|
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2145
3247
|
# resp.version_number #=> Integer
|
|
2146
3248
|
#
|
|
@@ -2153,6 +3255,78 @@ module Aws::QConnect
|
|
|
2153
3255
|
req.send_request(options)
|
|
2154
3256
|
end
|
|
2155
3257
|
|
|
3258
|
+
# Gets the Amazon Q in Connect AI Guardrail.
|
|
3259
|
+
#
|
|
3260
|
+
# @option params [required, String] :ai_guardrail_id
|
|
3261
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
|
3262
|
+
#
|
|
3263
|
+
# @option params [required, String] :assistant_id
|
|
3264
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
3265
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
3266
|
+
#
|
|
3267
|
+
# @return [Types::GetAIGuardrailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3268
|
+
#
|
|
3269
|
+
# * {Types::GetAIGuardrailResponse#ai_guardrail #ai_guardrail} => Types::AIGuardrailData
|
|
3270
|
+
# * {Types::GetAIGuardrailResponse#version_number #version_number} => Integer
|
|
3271
|
+
#
|
|
3272
|
+
# @example Request syntax with placeholder values
|
|
3273
|
+
#
|
|
3274
|
+
# resp = client.get_ai_guardrail({
|
|
3275
|
+
# ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
3276
|
+
# assistant_id: "UuidOrArn", # required
|
|
3277
|
+
# })
|
|
3278
|
+
#
|
|
3279
|
+
# @example Response structure
|
|
3280
|
+
#
|
|
3281
|
+
# resp.ai_guardrail.ai_guardrail_arn #=> String
|
|
3282
|
+
# resp.ai_guardrail.ai_guardrail_id #=> String
|
|
3283
|
+
# resp.ai_guardrail.assistant_arn #=> String
|
|
3284
|
+
# resp.ai_guardrail.assistant_id #=> String
|
|
3285
|
+
# resp.ai_guardrail.blocked_input_messaging #=> String
|
|
3286
|
+
# resp.ai_guardrail.blocked_outputs_messaging #=> String
|
|
3287
|
+
# resp.ai_guardrail.content_policy_config.filters_config #=> Array
|
|
3288
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
3289
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
3290
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
|
|
3291
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
|
|
3292
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
|
|
3293
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
|
|
3294
|
+
# resp.ai_guardrail.description #=> String
|
|
3295
|
+
# resp.ai_guardrail.modified_time #=> Time
|
|
3296
|
+
# resp.ai_guardrail.name #=> String
|
|
3297
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
|
|
3298
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
3299
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
|
|
3300
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
|
|
3301
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
3302
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
|
|
3303
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
|
|
3304
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
|
|
3305
|
+
# resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
3306
|
+
# resp.ai_guardrail.tags #=> Hash
|
|
3307
|
+
# resp.ai_guardrail.tags["TagKey"] #=> String
|
|
3308
|
+
# resp.ai_guardrail.topic_policy_config.topics_config #=> Array
|
|
3309
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
|
|
3310
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
|
|
3311
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
|
|
3312
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
|
|
3313
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
|
|
3314
|
+
# resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
3315
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
|
|
3316
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
|
|
3317
|
+
# resp.ai_guardrail.word_policy_config.words_config #=> Array
|
|
3318
|
+
# resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
|
|
3319
|
+
# resp.version_number #=> Integer
|
|
3320
|
+
#
|
|
3321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIGuardrail AWS API Documentation
|
|
3322
|
+
#
|
|
3323
|
+
# @overload get_ai_guardrail(params = {})
|
|
3324
|
+
# @param [Hash] params ({})
|
|
3325
|
+
def get_ai_guardrail(params = {}, options = {})
|
|
3326
|
+
req = build_request(:get_ai_guardrail, params)
|
|
3327
|
+
req.send_request(options)
|
|
3328
|
+
end
|
|
3329
|
+
|
|
2156
3330
|
# Gets and Amazon Q in Connect AI Prompt.
|
|
2157
3331
|
#
|
|
2158
3332
|
# @option params [required, String] :ai_prompt_id
|
|
@@ -2191,7 +3365,7 @@ module Aws::QConnect
|
|
|
2191
3365
|
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
2192
3366
|
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
2193
3367
|
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
2194
|
-
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
3368
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
|
|
2195
3369
|
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2196
3370
|
# resp.version_number #=> Integer
|
|
2197
3371
|
#
|
|
@@ -2539,12 +3713,205 @@ module Aws::QConnect
|
|
|
2539
3713
|
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
|
|
2540
3714
|
# resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
|
|
2541
3715
|
#
|
|
2542
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBase AWS API Documentation
|
|
3716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBase AWS API Documentation
|
|
3717
|
+
#
|
|
3718
|
+
# @overload get_knowledge_base(params = {})
|
|
3719
|
+
# @param [Hash] params ({})
|
|
3720
|
+
def get_knowledge_base(params = {}, options = {})
|
|
3721
|
+
req = build_request(:get_knowledge_base, params)
|
|
3722
|
+
req.send_request(options)
|
|
3723
|
+
end
|
|
3724
|
+
|
|
3725
|
+
# Retrieves the Amazon Q in Connect message template. The message
|
|
3726
|
+
# template identifier can contain an optional qualifier, for example,
|
|
3727
|
+
# `<message-template-id>:<qualifier>`, which is either an actual version
|
|
3728
|
+
# number or an Amazon Q Connect managed qualifier `$ACTIVE_VERSION` \|
|
|
3729
|
+
# `$LATEST`. If it is not supplied, then `$LATEST` is assumed
|
|
3730
|
+
# implicitly.
|
|
3731
|
+
#
|
|
3732
|
+
# @option params [required, String] :knowledge_base_id
|
|
3733
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
3734
|
+
# URLs cannot contain the ARN.
|
|
3735
|
+
#
|
|
3736
|
+
# @option params [required, String] :message_template_id
|
|
3737
|
+
# The identifier of the message template. Can be either the ID or the
|
|
3738
|
+
# ARN.
|
|
3739
|
+
#
|
|
3740
|
+
# @return [Types::GetMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3741
|
+
#
|
|
3742
|
+
# * {Types::GetMessageTemplateResponse#message_template #message_template} => Types::ExtendedMessageTemplateData
|
|
3743
|
+
#
|
|
3744
|
+
# @example Request syntax with placeholder values
|
|
3745
|
+
#
|
|
3746
|
+
# resp = client.get_message_template({
|
|
3747
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
3748
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
3749
|
+
# })
|
|
3750
|
+
#
|
|
3751
|
+
# @example Response structure
|
|
3752
|
+
#
|
|
3753
|
+
# resp.message_template.attachments #=> Array
|
|
3754
|
+
# resp.message_template.attachments[0].attachment_id #=> String
|
|
3755
|
+
# resp.message_template.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
|
|
3756
|
+
# resp.message_template.attachments[0].name #=> String
|
|
3757
|
+
# resp.message_template.attachments[0].uploaded_time #=> Time
|
|
3758
|
+
# resp.message_template.attachments[0].url #=> String
|
|
3759
|
+
# resp.message_template.attachments[0].url_expiry #=> Time
|
|
3760
|
+
# resp.message_template.attribute_types #=> Array
|
|
3761
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
|
3762
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
3763
|
+
# resp.message_template.content.email.body.html.content #=> String
|
|
3764
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
|
3765
|
+
# resp.message_template.content.email.headers #=> Array
|
|
3766
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
|
3767
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
|
3768
|
+
# resp.message_template.content.email.subject #=> String
|
|
3769
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
|
3770
|
+
# resp.message_template.created_time #=> Time
|
|
3771
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
|
3772
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
|
3773
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
|
3774
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
|
3775
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
|
3776
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
|
3777
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
|
3778
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
|
3779
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
|
3780
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
|
3781
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
|
3782
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
|
3783
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
|
3784
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
|
3785
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
|
3786
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
|
3787
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
|
3788
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
|
3789
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
|
3790
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
|
3791
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
|
3792
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
|
3793
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
|
3794
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
|
3795
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
|
3796
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
|
3797
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
|
3798
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
|
3799
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
|
3800
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
|
3801
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
|
3802
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
|
3803
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
|
3804
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
|
3805
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
|
3806
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
|
3807
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
|
3808
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
|
3809
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
|
3810
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
|
3811
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
|
3812
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
|
3813
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
|
3814
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
|
3815
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
|
3816
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
|
3817
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
|
3818
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
|
3819
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
|
3820
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
|
3821
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
|
3822
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
|
3823
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
|
3824
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
|
3825
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
|
3826
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
|
3827
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
|
3828
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
|
3829
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
|
3830
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
|
3831
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
|
3832
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
|
3833
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
|
3834
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
|
3835
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
|
3836
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
|
3837
|
+
# resp.message_template.description #=> String
|
|
3838
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
|
3839
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
|
3840
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
|
3841
|
+
# resp.message_template.is_active #=> Boolean
|
|
3842
|
+
# resp.message_template.knowledge_base_arn #=> String
|
|
3843
|
+
# resp.message_template.knowledge_base_id #=> String
|
|
3844
|
+
# resp.message_template.language #=> String
|
|
3845
|
+
# resp.message_template.last_modified_by #=> String
|
|
3846
|
+
# resp.message_template.last_modified_time #=> Time
|
|
3847
|
+
# resp.message_template.message_template_arn #=> String
|
|
3848
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
|
3849
|
+
# resp.message_template.message_template_id #=> String
|
|
3850
|
+
# resp.message_template.name #=> String
|
|
3851
|
+
# resp.message_template.tags #=> Hash
|
|
3852
|
+
# resp.message_template.tags["TagKey"] #=> String
|
|
3853
|
+
# resp.message_template.version_number #=> Integer
|
|
3854
|
+
#
|
|
3855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetMessageTemplate AWS API Documentation
|
|
3856
|
+
#
|
|
3857
|
+
# @overload get_message_template(params = {})
|
|
3858
|
+
# @param [Hash] params ({})
|
|
3859
|
+
def get_message_template(params = {}, options = {})
|
|
3860
|
+
req = build_request(:get_message_template, params)
|
|
3861
|
+
req.send_request(options)
|
|
3862
|
+
end
|
|
3863
|
+
|
|
3864
|
+
# Retrieves next message on an Amazon Q in Connect session.
|
|
3865
|
+
#
|
|
3866
|
+
# @option params [required, String] :assistant_id
|
|
3867
|
+
# The identifier of the Amazon Q in Connect assistant.
|
|
3868
|
+
#
|
|
3869
|
+
# @option params [required, String] :next_message_token
|
|
3870
|
+
# The token for the next message. Use the value returned in the
|
|
3871
|
+
# SendMessage or previous response in the next request to retrieve the
|
|
3872
|
+
# next message.
|
|
3873
|
+
#
|
|
3874
|
+
# @option params [required, String] :session_id
|
|
3875
|
+
# The identifier of the Amazon Q in Connect session.
|
|
3876
|
+
#
|
|
3877
|
+
# @return [Types::GetNextMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3878
|
+
#
|
|
3879
|
+
# * {Types::GetNextMessageResponse#conversation_session_data #conversation_session_data} => Array<Types::RuntimeSessionData>
|
|
3880
|
+
# * {Types::GetNextMessageResponse#conversation_state #conversation_state} => Types::ConversationState
|
|
3881
|
+
# * {Types::GetNextMessageResponse#next_message_token #next_message_token} => String
|
|
3882
|
+
# * {Types::GetNextMessageResponse#request_message_id #request_message_id} => String
|
|
3883
|
+
# * {Types::GetNextMessageResponse#response #response} => Types::MessageOutput
|
|
3884
|
+
# * {Types::GetNextMessageResponse#type #type} => String
|
|
3885
|
+
#
|
|
3886
|
+
# @example Request syntax with placeholder values
|
|
3887
|
+
#
|
|
3888
|
+
# resp = client.get_next_message({
|
|
3889
|
+
# assistant_id: "UuidOrArn", # required
|
|
3890
|
+
# next_message_token: "NextToken", # required
|
|
3891
|
+
# session_id: "UuidOrArn", # required
|
|
3892
|
+
# })
|
|
3893
|
+
#
|
|
3894
|
+
# @example Response structure
|
|
2543
3895
|
#
|
|
2544
|
-
#
|
|
3896
|
+
# resp.conversation_session_data #=> Array
|
|
3897
|
+
# resp.conversation_session_data[0].key #=> String
|
|
3898
|
+
# resp.conversation_session_data[0].value.string_value #=> String
|
|
3899
|
+
# resp.conversation_state.reason #=> String, one of "SUCCESS", "FAILED", "REJECTED"
|
|
3900
|
+
# resp.conversation_state.status #=> String, one of "CLOSED", "READY", "PROCESSING"
|
|
3901
|
+
# resp.next_message_token #=> String
|
|
3902
|
+
# resp.request_message_id #=> String
|
|
3903
|
+
# resp.response.message_id #=> String
|
|
3904
|
+
# resp.response.participant #=> String, one of "CUSTOMER", "AGENT", "BOT"
|
|
3905
|
+
# resp.response.timestamp #=> Time
|
|
3906
|
+
# resp.response.value.text.value #=> String
|
|
3907
|
+
# resp.type #=> String, one of "TEXT"
|
|
3908
|
+
#
|
|
3909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessage AWS API Documentation
|
|
3910
|
+
#
|
|
3911
|
+
# @overload get_next_message(params = {})
|
|
2545
3912
|
# @param [Hash] params ({})
|
|
2546
|
-
def
|
|
2547
|
-
req = build_request(:
|
|
3913
|
+
def get_next_message(params = {}, options = {})
|
|
3914
|
+
req = build_request(:get_next_message, params)
|
|
2548
3915
|
req.send_request(options)
|
|
2549
3916
|
end
|
|
2550
3917
|
|
|
@@ -2831,6 +4198,7 @@ module Aws::QConnect
|
|
|
2831
4198
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.ai_agent_id #=> String
|
|
2832
4199
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.assistant_arn #=> String
|
|
2833
4200
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.assistant_id #=> String
|
|
4201
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
2834
4202
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2835
4203
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
2836
4204
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -2850,6 +4218,7 @@ module Aws::QConnect
|
|
|
2850
4218
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2851
4219
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
2852
4220
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
4221
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
2853
4222
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2854
4223
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
2855
4224
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -2867,6 +4236,25 @@ module Aws::QConnect
|
|
|
2867
4236
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2868
4237
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2869
4238
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4239
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
|
|
4240
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
4241
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
4242
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
4243
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
4244
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
4245
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
4246
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
4247
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
4248
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
4249
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
4250
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
4251
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
4252
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
4253
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
4254
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4255
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
|
|
4256
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
|
|
4257
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
|
|
2870
4258
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.description #=> String
|
|
2871
4259
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.modified_time #=> Time
|
|
2872
4260
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.name #=> String
|
|
@@ -2874,7 +4262,7 @@ module Aws::QConnect
|
|
|
2874
4262
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2875
4263
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.tags #=> Hash
|
|
2876
4264
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.tags["TagKey"] #=> String
|
|
2877
|
-
# resp.ai_agent_version_summaries[0].ai_agent_summary.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
4265
|
+
# resp.ai_agent_version_summaries[0].ai_agent_summary.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
|
|
2878
4266
|
# resp.ai_agent_version_summaries[0].ai_agent_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2879
4267
|
# resp.ai_agent_version_summaries[0].version_number #=> Integer
|
|
2880
4268
|
# resp.next_token #=> String
|
|
@@ -2930,6 +4318,7 @@ module Aws::QConnect
|
|
|
2930
4318
|
# resp.ai_agent_summaries[0].ai_agent_id #=> String
|
|
2931
4319
|
# resp.ai_agent_summaries[0].assistant_arn #=> String
|
|
2932
4320
|
# resp.ai_agent_summaries[0].assistant_id #=> String
|
|
4321
|
+
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
2933
4322
|
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2934
4323
|
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
2935
4324
|
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -2949,6 +4338,7 @@ module Aws::QConnect
|
|
|
2949
4338
|
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
2950
4339
|
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
2951
4340
|
# resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
4341
|
+
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
2952
4342
|
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
2953
4343
|
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
2954
4344
|
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -2966,6 +4356,25 @@ module Aws::QConnect
|
|
|
2966
4356
|
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
2967
4357
|
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
2968
4358
|
# resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4359
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations #=> Array
|
|
4360
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
4361
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
4362
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
4363
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
4364
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
4365
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
4366
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
4367
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
4368
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
4369
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
4370
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
4371
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
4372
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
4373
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
4374
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4375
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
|
|
4376
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
|
|
4377
|
+
# resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
|
|
2969
4378
|
# resp.ai_agent_summaries[0].description #=> String
|
|
2970
4379
|
# resp.ai_agent_summaries[0].modified_time #=> Time
|
|
2971
4380
|
# resp.ai_agent_summaries[0].name #=> String
|
|
@@ -2973,7 +4382,7 @@ module Aws::QConnect
|
|
|
2973
4382
|
# resp.ai_agent_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
2974
4383
|
# resp.ai_agent_summaries[0].tags #=> Hash
|
|
2975
4384
|
# resp.ai_agent_summaries[0].tags["TagKey"] #=> String
|
|
2976
|
-
# resp.ai_agent_summaries[0].type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
4385
|
+
# resp.ai_agent_summaries[0].type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
|
|
2977
4386
|
# resp.ai_agent_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
2978
4387
|
# resp.next_token #=> String
|
|
2979
4388
|
#
|
|
@@ -2986,6 +4395,121 @@ module Aws::QConnect
|
|
|
2986
4395
|
req.send_request(options)
|
|
2987
4396
|
end
|
|
2988
4397
|
|
|
4398
|
+
# Lists AI Guardrail versions.
|
|
4399
|
+
#
|
|
4400
|
+
# @option params [required, String] :ai_guardrail_id
|
|
4401
|
+
# The identifier of the Amazon Q in Connect AI Guardrail for which
|
|
4402
|
+
# versions are to be listed.
|
|
4403
|
+
#
|
|
4404
|
+
# @option params [required, String] :assistant_id
|
|
4405
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
4406
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
4407
|
+
#
|
|
4408
|
+
# @option params [Integer] :max_results
|
|
4409
|
+
# The maximum number of results to return per page.
|
|
4410
|
+
#
|
|
4411
|
+
# @option params [String] :next_token
|
|
4412
|
+
# The token for the next set of results. Use the value returned in the
|
|
4413
|
+
# previous response in the next request to retrieve the next set of
|
|
4414
|
+
# results.
|
|
4415
|
+
#
|
|
4416
|
+
# @return [Types::ListAIGuardrailVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4417
|
+
#
|
|
4418
|
+
# * {Types::ListAIGuardrailVersionsResponse#ai_guardrail_version_summaries #ai_guardrail_version_summaries} => Array<Types::AIGuardrailVersionSummary>
|
|
4419
|
+
# * {Types::ListAIGuardrailVersionsResponse#next_token #next_token} => String
|
|
4420
|
+
#
|
|
4421
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4422
|
+
#
|
|
4423
|
+
# @example Request syntax with placeholder values
|
|
4424
|
+
#
|
|
4425
|
+
# resp = client.list_ai_guardrail_versions({
|
|
4426
|
+
# ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
4427
|
+
# assistant_id: "UuidOrArn", # required
|
|
4428
|
+
# max_results: 1,
|
|
4429
|
+
# next_token: "NextToken",
|
|
4430
|
+
# })
|
|
4431
|
+
#
|
|
4432
|
+
# @example Response structure
|
|
4433
|
+
#
|
|
4434
|
+
# resp.ai_guardrail_version_summaries #=> Array
|
|
4435
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.ai_guardrail_arn #=> String
|
|
4436
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.ai_guardrail_id #=> String
|
|
4437
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.assistant_arn #=> String
|
|
4438
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.assistant_id #=> String
|
|
4439
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.description #=> String
|
|
4440
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.modified_time #=> Time
|
|
4441
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.name #=> String
|
|
4442
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
4443
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.tags #=> Hash
|
|
4444
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.tags["TagKey"] #=> String
|
|
4445
|
+
# resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
4446
|
+
# resp.ai_guardrail_version_summaries[0].version_number #=> Integer
|
|
4447
|
+
# resp.next_token #=> String
|
|
4448
|
+
#
|
|
4449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersions AWS API Documentation
|
|
4450
|
+
#
|
|
4451
|
+
# @overload list_ai_guardrail_versions(params = {})
|
|
4452
|
+
# @param [Hash] params ({})
|
|
4453
|
+
def list_ai_guardrail_versions(params = {}, options = {})
|
|
4454
|
+
req = build_request(:list_ai_guardrail_versions, params)
|
|
4455
|
+
req.send_request(options)
|
|
4456
|
+
end
|
|
4457
|
+
|
|
4458
|
+
# Lists the AI Guardrails available on the Amazon Q in Connect
|
|
4459
|
+
# assistant.
|
|
4460
|
+
#
|
|
4461
|
+
# @option params [required, String] :assistant_id
|
|
4462
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
4463
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
4464
|
+
#
|
|
4465
|
+
# @option params [Integer] :max_results
|
|
4466
|
+
# The maximum number of results to return per page.
|
|
4467
|
+
#
|
|
4468
|
+
# @option params [String] :next_token
|
|
4469
|
+
# The token for the next set of results. Use the value returned in the
|
|
4470
|
+
# previous response in the next request to retrieve the next set of
|
|
4471
|
+
# results.
|
|
4472
|
+
#
|
|
4473
|
+
# @return [Types::ListAIGuardrailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4474
|
+
#
|
|
4475
|
+
# * {Types::ListAIGuardrailsResponse#ai_guardrail_summaries #ai_guardrail_summaries} => Array<Types::AIGuardrailSummary>
|
|
4476
|
+
# * {Types::ListAIGuardrailsResponse#next_token #next_token} => String
|
|
4477
|
+
#
|
|
4478
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4479
|
+
#
|
|
4480
|
+
# @example Request syntax with placeholder values
|
|
4481
|
+
#
|
|
4482
|
+
# resp = client.list_ai_guardrails({
|
|
4483
|
+
# assistant_id: "UuidOrArn", # required
|
|
4484
|
+
# max_results: 1,
|
|
4485
|
+
# next_token: "NextToken",
|
|
4486
|
+
# })
|
|
4487
|
+
#
|
|
4488
|
+
# @example Response structure
|
|
4489
|
+
#
|
|
4490
|
+
# resp.ai_guardrail_summaries #=> Array
|
|
4491
|
+
# resp.ai_guardrail_summaries[0].ai_guardrail_arn #=> String
|
|
4492
|
+
# resp.ai_guardrail_summaries[0].ai_guardrail_id #=> String
|
|
4493
|
+
# resp.ai_guardrail_summaries[0].assistant_arn #=> String
|
|
4494
|
+
# resp.ai_guardrail_summaries[0].assistant_id #=> String
|
|
4495
|
+
# resp.ai_guardrail_summaries[0].description #=> String
|
|
4496
|
+
# resp.ai_guardrail_summaries[0].modified_time #=> Time
|
|
4497
|
+
# resp.ai_guardrail_summaries[0].name #=> String
|
|
4498
|
+
# resp.ai_guardrail_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
4499
|
+
# resp.ai_guardrail_summaries[0].tags #=> Hash
|
|
4500
|
+
# resp.ai_guardrail_summaries[0].tags["TagKey"] #=> String
|
|
4501
|
+
# resp.ai_guardrail_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
4502
|
+
# resp.next_token #=> String
|
|
4503
|
+
#
|
|
4504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrails AWS API Documentation
|
|
4505
|
+
#
|
|
4506
|
+
# @overload list_ai_guardrails(params = {})
|
|
4507
|
+
# @param [Hash] params ({})
|
|
4508
|
+
def list_ai_guardrails(params = {}, options = {})
|
|
4509
|
+
req = build_request(:list_ai_guardrails, params)
|
|
4510
|
+
req.send_request(options)
|
|
4511
|
+
end
|
|
4512
|
+
|
|
2989
4513
|
# Lists AI Prompt versions.
|
|
2990
4514
|
#
|
|
2991
4515
|
# @option params [required, String] :ai_prompt_id
|
|
@@ -3043,7 +4567,7 @@ module Aws::QConnect
|
|
|
3043
4567
|
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.tags #=> Hash
|
|
3044
4568
|
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.tags["TagKey"] #=> String
|
|
3045
4569
|
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.template_type #=> String, one of "TEXT"
|
|
3046
|
-
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
4570
|
+
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
|
|
3047
4571
|
# resp.ai_prompt_version_summaries[0].ai_prompt_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
3048
4572
|
# resp.ai_prompt_version_summaries[0].version_number #=> Integer
|
|
3049
4573
|
# resp.next_token #=> String
|
|
@@ -3109,7 +4633,7 @@ module Aws::QConnect
|
|
|
3109
4633
|
# resp.ai_prompt_summaries[0].tags #=> Hash
|
|
3110
4634
|
# resp.ai_prompt_summaries[0].tags["TagKey"] #=> String
|
|
3111
4635
|
# resp.ai_prompt_summaries[0].template_type #=> String, one of "TEXT"
|
|
3112
|
-
# resp.ai_prompt_summaries[0].type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
4636
|
+
# resp.ai_prompt_summaries[0].type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
|
|
3113
4637
|
# resp.ai_prompt_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
3114
4638
|
# resp.next_token #=> String
|
|
3115
4639
|
#
|
|
@@ -3472,6 +4996,170 @@ module Aws::QConnect
|
|
|
3472
4996
|
req.send_request(options)
|
|
3473
4997
|
end
|
|
3474
4998
|
|
|
4999
|
+
# Lists all the available versions for the specified Amazon Q in Connect
|
|
5000
|
+
# message template.
|
|
5001
|
+
#
|
|
5002
|
+
# @option params [required, String] :knowledge_base_id
|
|
5003
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
5004
|
+
# URLs cannot contain the ARN.
|
|
5005
|
+
#
|
|
5006
|
+
# @option params [Integer] :max_results
|
|
5007
|
+
# The maximum number of results to return per page.
|
|
5008
|
+
#
|
|
5009
|
+
# @option params [required, String] :message_template_id
|
|
5010
|
+
# The identifier of the message template. Can be either the ID or the
|
|
5011
|
+
# ARN. It cannot contain any qualifier.
|
|
5012
|
+
#
|
|
5013
|
+
# @option params [String] :next_token
|
|
5014
|
+
# The token for the next set of results. Use the value returned in the
|
|
5015
|
+
# previous response in the next request to retrieve the next set of
|
|
5016
|
+
# results.
|
|
5017
|
+
#
|
|
5018
|
+
# @return [Types::ListMessageTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5019
|
+
#
|
|
5020
|
+
# * {Types::ListMessageTemplateVersionsResponse#message_template_version_summaries #message_template_version_summaries} => Array<Types::MessageTemplateVersionSummary>
|
|
5021
|
+
# * {Types::ListMessageTemplateVersionsResponse#next_token #next_token} => String
|
|
5022
|
+
#
|
|
5023
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5024
|
+
#
|
|
5025
|
+
# @example Request syntax with placeholder values
|
|
5026
|
+
#
|
|
5027
|
+
# resp = client.list_message_template_versions({
|
|
5028
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
5029
|
+
# max_results: 1,
|
|
5030
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
5031
|
+
# next_token: "NextToken",
|
|
5032
|
+
# })
|
|
5033
|
+
#
|
|
5034
|
+
# @example Response structure
|
|
5035
|
+
#
|
|
5036
|
+
# resp.message_template_version_summaries #=> Array
|
|
5037
|
+
# resp.message_template_version_summaries[0].channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
5038
|
+
# resp.message_template_version_summaries[0].is_active #=> Boolean
|
|
5039
|
+
# resp.message_template_version_summaries[0].knowledge_base_arn #=> String
|
|
5040
|
+
# resp.message_template_version_summaries[0].knowledge_base_id #=> String
|
|
5041
|
+
# resp.message_template_version_summaries[0].message_template_arn #=> String
|
|
5042
|
+
# resp.message_template_version_summaries[0].message_template_id #=> String
|
|
5043
|
+
# resp.message_template_version_summaries[0].name #=> String
|
|
5044
|
+
# resp.message_template_version_summaries[0].version_number #=> Integer
|
|
5045
|
+
# resp.next_token #=> String
|
|
5046
|
+
#
|
|
5047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplateVersions AWS API Documentation
|
|
5048
|
+
#
|
|
5049
|
+
# @overload list_message_template_versions(params = {})
|
|
5050
|
+
# @param [Hash] params ({})
|
|
5051
|
+
def list_message_template_versions(params = {}, options = {})
|
|
5052
|
+
req = build_request(:list_message_template_versions, params)
|
|
5053
|
+
req.send_request(options)
|
|
5054
|
+
end
|
|
5055
|
+
|
|
5056
|
+
# Lists all the available Amazon Q in Connect message templates for the
|
|
5057
|
+
# specified knowledge base.
|
|
5058
|
+
#
|
|
5059
|
+
# @option params [required, String] :knowledge_base_id
|
|
5060
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
5061
|
+
# URLs cannot contain the ARN.
|
|
5062
|
+
#
|
|
5063
|
+
# @option params [Integer] :max_results
|
|
5064
|
+
# The maximum number of results to return per page.
|
|
5065
|
+
#
|
|
5066
|
+
# @option params [String] :next_token
|
|
5067
|
+
# The token for the next set of results. Use the value returned in the
|
|
5068
|
+
# previous response in the next request to retrieve the next set of
|
|
5069
|
+
# results.
|
|
5070
|
+
#
|
|
5071
|
+
# @return [Types::ListMessageTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5072
|
+
#
|
|
5073
|
+
# * {Types::ListMessageTemplatesResponse#message_template_summaries #message_template_summaries} => Array<Types::MessageTemplateSummary>
|
|
5074
|
+
# * {Types::ListMessageTemplatesResponse#next_token #next_token} => String
|
|
5075
|
+
#
|
|
5076
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5077
|
+
#
|
|
5078
|
+
# @example Request syntax with placeholder values
|
|
5079
|
+
#
|
|
5080
|
+
# resp = client.list_message_templates({
|
|
5081
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
5082
|
+
# max_results: 1,
|
|
5083
|
+
# next_token: "NextToken",
|
|
5084
|
+
# })
|
|
5085
|
+
#
|
|
5086
|
+
# @example Response structure
|
|
5087
|
+
#
|
|
5088
|
+
# resp.message_template_summaries #=> Array
|
|
5089
|
+
# resp.message_template_summaries[0].active_version_number #=> Integer
|
|
5090
|
+
# resp.message_template_summaries[0].channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
5091
|
+
# resp.message_template_summaries[0].created_time #=> Time
|
|
5092
|
+
# resp.message_template_summaries[0].description #=> String
|
|
5093
|
+
# resp.message_template_summaries[0].knowledge_base_arn #=> String
|
|
5094
|
+
# resp.message_template_summaries[0].knowledge_base_id #=> String
|
|
5095
|
+
# resp.message_template_summaries[0].last_modified_by #=> String
|
|
5096
|
+
# resp.message_template_summaries[0].last_modified_time #=> Time
|
|
5097
|
+
# resp.message_template_summaries[0].message_template_arn #=> String
|
|
5098
|
+
# resp.message_template_summaries[0].message_template_id #=> String
|
|
5099
|
+
# resp.message_template_summaries[0].name #=> String
|
|
5100
|
+
# resp.message_template_summaries[0].tags #=> Hash
|
|
5101
|
+
# resp.message_template_summaries[0].tags["TagKey"] #=> String
|
|
5102
|
+
# resp.next_token #=> String
|
|
5103
|
+
#
|
|
5104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplates AWS API Documentation
|
|
5105
|
+
#
|
|
5106
|
+
# @overload list_message_templates(params = {})
|
|
5107
|
+
# @param [Hash] params ({})
|
|
5108
|
+
def list_message_templates(params = {}, options = {})
|
|
5109
|
+
req = build_request(:list_message_templates, params)
|
|
5110
|
+
req.send_request(options)
|
|
5111
|
+
end
|
|
5112
|
+
|
|
5113
|
+
# Lists messages on an Amazon Q in Connect session.
|
|
5114
|
+
#
|
|
5115
|
+
# @option params [required, String] :assistant_id
|
|
5116
|
+
# The identifier of the Amazon Q in Connect assistant.
|
|
5117
|
+
#
|
|
5118
|
+
# @option params [Integer] :max_results
|
|
5119
|
+
# The maximum number of results to return per page.
|
|
5120
|
+
#
|
|
5121
|
+
# @option params [String] :next_token
|
|
5122
|
+
# The token for the next set of results. Use the value returned in the
|
|
5123
|
+
# previous response in the next request to retrieve the next set of
|
|
5124
|
+
# results.
|
|
5125
|
+
#
|
|
5126
|
+
# @option params [required, String] :session_id
|
|
5127
|
+
# The identifier of the Amazon Q in Connect session.
|
|
5128
|
+
#
|
|
5129
|
+
# @return [Types::ListMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5130
|
+
#
|
|
5131
|
+
# * {Types::ListMessagesResponse#messages #messages} => Array<Types::MessageOutput>
|
|
5132
|
+
# * {Types::ListMessagesResponse#next_token #next_token} => String
|
|
5133
|
+
#
|
|
5134
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5135
|
+
#
|
|
5136
|
+
# @example Request syntax with placeholder values
|
|
5137
|
+
#
|
|
5138
|
+
# resp = client.list_messages({
|
|
5139
|
+
# assistant_id: "UuidOrArn", # required
|
|
5140
|
+
# max_results: 1,
|
|
5141
|
+
# next_token: "NextToken",
|
|
5142
|
+
# session_id: "UuidOrArn", # required
|
|
5143
|
+
# })
|
|
5144
|
+
#
|
|
5145
|
+
# @example Response structure
|
|
5146
|
+
#
|
|
5147
|
+
# resp.messages #=> Array
|
|
5148
|
+
# resp.messages[0].message_id #=> String
|
|
5149
|
+
# resp.messages[0].participant #=> String, one of "CUSTOMER", "AGENT", "BOT"
|
|
5150
|
+
# resp.messages[0].timestamp #=> Time
|
|
5151
|
+
# resp.messages[0].value.text.value #=> String
|
|
5152
|
+
# resp.next_token #=> String
|
|
5153
|
+
#
|
|
5154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessages AWS API Documentation
|
|
5155
|
+
#
|
|
5156
|
+
# @overload list_messages(params = {})
|
|
5157
|
+
# @param [Hash] params ({})
|
|
5158
|
+
def list_messages(params = {}, options = {})
|
|
5159
|
+
req = build_request(:list_messages, params)
|
|
5160
|
+
req.send_request(options)
|
|
5161
|
+
end
|
|
5162
|
+
|
|
3475
5163
|
# Lists information about quick response.
|
|
3476
5164
|
#
|
|
3477
5165
|
# @option params [required, String] :knowledge_base_id
|
|
@@ -3827,7 +5515,7 @@ module Aws::QConnect
|
|
|
3827
5515
|
# @example Request syntax with placeholder values
|
|
3828
5516
|
#
|
|
3829
5517
|
# resp = client.remove_assistant_ai_agent({
|
|
3830
|
-
# ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION
|
|
5518
|
+
# ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION, SELF_SERVICE
|
|
3831
5519
|
# assistant_id: "UuidOrArn", # required
|
|
3832
5520
|
# })
|
|
3833
5521
|
#
|
|
@@ -3863,6 +5551,150 @@ module Aws::QConnect
|
|
|
3863
5551
|
req.send_request(options)
|
|
3864
5552
|
end
|
|
3865
5553
|
|
|
5554
|
+
# Renders the Amazon Q in Connect message template based on the
|
|
5555
|
+
# attribute values provided and generates the message content. For any
|
|
5556
|
+
# variable present in the message template, if the attribute value is
|
|
5557
|
+
# neither provided in the attribute request parameter nor the default
|
|
5558
|
+
# attribute of the message template, the rendered message content will
|
|
5559
|
+
# keep the variable placeholder as it is and return the attribute keys
|
|
5560
|
+
# that are missing.
|
|
5561
|
+
#
|
|
5562
|
+
# @option params [required, Types::MessageTemplateAttributes] :attributes
|
|
5563
|
+
# An object that specifies the values to use for variables in the
|
|
5564
|
+
# message template. This object contains different categories of
|
|
5565
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
|
5566
|
+
# message template. The corresponding value defines the value for that
|
|
5567
|
+
# variable.
|
|
5568
|
+
#
|
|
5569
|
+
# @option params [required, String] :knowledge_base_id
|
|
5570
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
5571
|
+
# URLs cannot contain the ARN.
|
|
5572
|
+
#
|
|
5573
|
+
# @option params [required, String] :message_template_id
|
|
5574
|
+
# The identifier of the message template. Can be either the ID or the
|
|
5575
|
+
# ARN.
|
|
5576
|
+
#
|
|
5577
|
+
# @return [Types::RenderMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5578
|
+
#
|
|
5579
|
+
# * {Types::RenderMessageTemplateResponse#attachments #attachments} => Array<Types::MessageTemplateAttachment>
|
|
5580
|
+
# * {Types::RenderMessageTemplateResponse#attributes_not_interpolated #attributes_not_interpolated} => Array<String>
|
|
5581
|
+
# * {Types::RenderMessageTemplateResponse#content #content} => Types::MessageTemplateContentProvider
|
|
5582
|
+
#
|
|
5583
|
+
# @example Request syntax with placeholder values
|
|
5584
|
+
#
|
|
5585
|
+
# resp = client.render_message_template({
|
|
5586
|
+
# attributes: { # required
|
|
5587
|
+
# agent_attributes: {
|
|
5588
|
+
# first_name: "MessageTemplateAttributeValue",
|
|
5589
|
+
# last_name: "MessageTemplateAttributeValue",
|
|
5590
|
+
# },
|
|
5591
|
+
# custom_attributes: {
|
|
5592
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
|
5593
|
+
# },
|
|
5594
|
+
# customer_profile_attributes: {
|
|
5595
|
+
# account_number: "MessageTemplateAttributeValue",
|
|
5596
|
+
# additional_information: "MessageTemplateAttributeValue",
|
|
5597
|
+
# address1: "MessageTemplateAttributeValue",
|
|
5598
|
+
# address2: "MessageTemplateAttributeValue",
|
|
5599
|
+
# address3: "MessageTemplateAttributeValue",
|
|
5600
|
+
# address4: "MessageTemplateAttributeValue",
|
|
5601
|
+
# billing_address_1: "MessageTemplateAttributeValue",
|
|
5602
|
+
# billing_address_2: "MessageTemplateAttributeValue",
|
|
5603
|
+
# billing_address_3: "MessageTemplateAttributeValue",
|
|
5604
|
+
# billing_address_4: "MessageTemplateAttributeValue",
|
|
5605
|
+
# billing_city: "MessageTemplateAttributeValue",
|
|
5606
|
+
# billing_country: "MessageTemplateAttributeValue",
|
|
5607
|
+
# billing_county: "MessageTemplateAttributeValue",
|
|
5608
|
+
# billing_postal_code: "MessageTemplateAttributeValue",
|
|
5609
|
+
# billing_province: "MessageTemplateAttributeValue",
|
|
5610
|
+
# billing_state: "MessageTemplateAttributeValue",
|
|
5611
|
+
# birth_date: "MessageTemplateAttributeValue",
|
|
5612
|
+
# business_email_address: "MessageTemplateAttributeValue",
|
|
5613
|
+
# business_name: "MessageTemplateAttributeValue",
|
|
5614
|
+
# business_phone_number: "MessageTemplateAttributeValue",
|
|
5615
|
+
# city: "MessageTemplateAttributeValue",
|
|
5616
|
+
# country: "MessageTemplateAttributeValue",
|
|
5617
|
+
# county: "MessageTemplateAttributeValue",
|
|
5618
|
+
# custom: {
|
|
5619
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
|
5620
|
+
# },
|
|
5621
|
+
# email_address: "MessageTemplateAttributeValue",
|
|
5622
|
+
# first_name: "MessageTemplateAttributeValue",
|
|
5623
|
+
# gender: "MessageTemplateAttributeValue",
|
|
5624
|
+
# home_phone_number: "MessageTemplateAttributeValue",
|
|
5625
|
+
# last_name: "MessageTemplateAttributeValue",
|
|
5626
|
+
# mailing_address_1: "MessageTemplateAttributeValue",
|
|
5627
|
+
# mailing_address_2: "MessageTemplateAttributeValue",
|
|
5628
|
+
# mailing_address_3: "MessageTemplateAttributeValue",
|
|
5629
|
+
# mailing_address_4: "MessageTemplateAttributeValue",
|
|
5630
|
+
# mailing_city: "MessageTemplateAttributeValue",
|
|
5631
|
+
# mailing_country: "MessageTemplateAttributeValue",
|
|
5632
|
+
# mailing_county: "MessageTemplateAttributeValue",
|
|
5633
|
+
# mailing_postal_code: "MessageTemplateAttributeValue",
|
|
5634
|
+
# mailing_province: "MessageTemplateAttributeValue",
|
|
5635
|
+
# mailing_state: "MessageTemplateAttributeValue",
|
|
5636
|
+
# middle_name: "MessageTemplateAttributeValue",
|
|
5637
|
+
# mobile_phone_number: "MessageTemplateAttributeValue",
|
|
5638
|
+
# party_type: "MessageTemplateAttributeValue",
|
|
5639
|
+
# phone_number: "MessageTemplateAttributeValue",
|
|
5640
|
+
# postal_code: "MessageTemplateAttributeValue",
|
|
5641
|
+
# profile_arn: "MessageTemplateAttributeValue",
|
|
5642
|
+
# profile_id: "MessageTemplateAttributeValue",
|
|
5643
|
+
# province: "MessageTemplateAttributeValue",
|
|
5644
|
+
# shipping_address_1: "MessageTemplateAttributeValue",
|
|
5645
|
+
# shipping_address_2: "MessageTemplateAttributeValue",
|
|
5646
|
+
# shipping_address_3: "MessageTemplateAttributeValue",
|
|
5647
|
+
# shipping_address_4: "MessageTemplateAttributeValue",
|
|
5648
|
+
# shipping_city: "MessageTemplateAttributeValue",
|
|
5649
|
+
# shipping_country: "MessageTemplateAttributeValue",
|
|
5650
|
+
# shipping_county: "MessageTemplateAttributeValue",
|
|
5651
|
+
# shipping_postal_code: "MessageTemplateAttributeValue",
|
|
5652
|
+
# shipping_province: "MessageTemplateAttributeValue",
|
|
5653
|
+
# shipping_state: "MessageTemplateAttributeValue",
|
|
5654
|
+
# state: "MessageTemplateAttributeValue",
|
|
5655
|
+
# },
|
|
5656
|
+
# system_attributes: {
|
|
5657
|
+
# customer_endpoint: {
|
|
5658
|
+
# address: "MessageTemplateAttributeValue",
|
|
5659
|
+
# },
|
|
5660
|
+
# name: "MessageTemplateAttributeValue",
|
|
5661
|
+
# system_endpoint: {
|
|
5662
|
+
# address: "MessageTemplateAttributeValue",
|
|
5663
|
+
# },
|
|
5664
|
+
# },
|
|
5665
|
+
# },
|
|
5666
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
5667
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
5668
|
+
# })
|
|
5669
|
+
#
|
|
5670
|
+
# @example Response structure
|
|
5671
|
+
#
|
|
5672
|
+
# resp.attachments #=> Array
|
|
5673
|
+
# resp.attachments[0].attachment_id #=> String
|
|
5674
|
+
# resp.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
|
|
5675
|
+
# resp.attachments[0].name #=> String
|
|
5676
|
+
# resp.attachments[0].uploaded_time #=> Time
|
|
5677
|
+
# resp.attachments[0].url #=> String
|
|
5678
|
+
# resp.attachments[0].url_expiry #=> Time
|
|
5679
|
+
# resp.attributes_not_interpolated #=> Array
|
|
5680
|
+
# resp.attributes_not_interpolated[0] #=> String
|
|
5681
|
+
# resp.content.email.body.html.content #=> String
|
|
5682
|
+
# resp.content.email.body.plain_text.content #=> String
|
|
5683
|
+
# resp.content.email.headers #=> Array
|
|
5684
|
+
# resp.content.email.headers[0].name #=> String
|
|
5685
|
+
# resp.content.email.headers[0].value #=> String
|
|
5686
|
+
# resp.content.email.subject #=> String
|
|
5687
|
+
# resp.content.sms.body.plain_text.content #=> String
|
|
5688
|
+
#
|
|
5689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderMessageTemplate AWS API Documentation
|
|
5690
|
+
#
|
|
5691
|
+
# @overload render_message_template(params = {})
|
|
5692
|
+
# @param [Hash] params ({})
|
|
5693
|
+
def render_message_template(params = {}, options = {})
|
|
5694
|
+
req = build_request(:render_message_template, params)
|
|
5695
|
+
req.send_request(options)
|
|
5696
|
+
end
|
|
5697
|
+
|
|
3866
5698
|
# Searches for content in a specified knowledge base. Can be used to get
|
|
3867
5699
|
# a specific content resource by its name.
|
|
3868
5700
|
#
|
|
@@ -3924,12 +5756,100 @@ module Aws::QConnect
|
|
|
3924
5756
|
# resp.content_summaries[0].title #=> String
|
|
3925
5757
|
# resp.next_token #=> String
|
|
3926
5758
|
#
|
|
3927
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchContent AWS API Documentation
|
|
5759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchContent AWS API Documentation
|
|
5760
|
+
#
|
|
5761
|
+
# @overload search_content(params = {})
|
|
5762
|
+
# @param [Hash] params ({})
|
|
5763
|
+
def search_content(params = {}, options = {})
|
|
5764
|
+
req = build_request(:search_content, params)
|
|
5765
|
+
req.send_request(options)
|
|
5766
|
+
end
|
|
5767
|
+
|
|
5768
|
+
# Searches for Amazon Q in Connect message templates in the specified
|
|
5769
|
+
# knowledge base.
|
|
5770
|
+
#
|
|
5771
|
+
# @option params [required, String] :knowledge_base_id
|
|
5772
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
5773
|
+
# URLs cannot contain the ARN.
|
|
5774
|
+
#
|
|
5775
|
+
# @option params [Integer] :max_results
|
|
5776
|
+
# The maximum number of results to return per page.
|
|
5777
|
+
#
|
|
5778
|
+
# @option params [String] :next_token
|
|
5779
|
+
# The token for the next set of results. Use the value returned in the
|
|
5780
|
+
# previous response in the next request to retrieve the next set of
|
|
5781
|
+
# results.
|
|
5782
|
+
#
|
|
5783
|
+
# @option params [required, Types::MessageTemplateSearchExpression] :search_expression
|
|
5784
|
+
# The search expression for querying the message template.
|
|
5785
|
+
#
|
|
5786
|
+
# @return [Types::SearchMessageTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5787
|
+
#
|
|
5788
|
+
# * {Types::SearchMessageTemplatesResponse#next_token #next_token} => String
|
|
5789
|
+
# * {Types::SearchMessageTemplatesResponse#results #results} => Array<Types::MessageTemplateSearchResultData>
|
|
5790
|
+
#
|
|
5791
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5792
|
+
#
|
|
5793
|
+
# @example Request syntax with placeholder values
|
|
5794
|
+
#
|
|
5795
|
+
# resp = client.search_message_templates({
|
|
5796
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
5797
|
+
# max_results: 1,
|
|
5798
|
+
# next_token: "NextToken",
|
|
5799
|
+
# search_expression: { # required
|
|
5800
|
+
# filters: [
|
|
5801
|
+
# {
|
|
5802
|
+
# include_no_existence: false,
|
|
5803
|
+
# name: "NonEmptyString", # required
|
|
5804
|
+
# operator: "EQUALS", # required, accepts EQUALS, PREFIX
|
|
5805
|
+
# values: ["MessageTemplateFilterValue"],
|
|
5806
|
+
# },
|
|
5807
|
+
# ],
|
|
5808
|
+
# order_on_field: {
|
|
5809
|
+
# name: "NonEmptyString", # required
|
|
5810
|
+
# order: "ASC", # accepts ASC, DESC
|
|
5811
|
+
# },
|
|
5812
|
+
# queries: [
|
|
5813
|
+
# {
|
|
5814
|
+
# allow_fuzziness: false,
|
|
5815
|
+
# name: "NonEmptyString", # required
|
|
5816
|
+
# operator: "CONTAINS", # required, accepts CONTAINS, CONTAINS_AND_PREFIX
|
|
5817
|
+
# priority: "HIGH", # accepts HIGH, MEDIUM, LOW
|
|
5818
|
+
# values: ["MessageTemplateQueryValue"], # required
|
|
5819
|
+
# },
|
|
5820
|
+
# ],
|
|
5821
|
+
# },
|
|
5822
|
+
# })
|
|
5823
|
+
#
|
|
5824
|
+
# @example Response structure
|
|
5825
|
+
#
|
|
5826
|
+
# resp.next_token #=> String
|
|
5827
|
+
# resp.results #=> Array
|
|
5828
|
+
# resp.results[0].channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
5829
|
+
# resp.results[0].created_time #=> Time
|
|
5830
|
+
# resp.results[0].description #=> String
|
|
5831
|
+
# resp.results[0].grouping_configuration.criteria #=> String
|
|
5832
|
+
# resp.results[0].grouping_configuration.values #=> Array
|
|
5833
|
+
# resp.results[0].grouping_configuration.values[0] #=> String
|
|
5834
|
+
# resp.results[0].is_active #=> Boolean
|
|
5835
|
+
# resp.results[0].knowledge_base_arn #=> String
|
|
5836
|
+
# resp.results[0].knowledge_base_id #=> String
|
|
5837
|
+
# resp.results[0].language #=> String
|
|
5838
|
+
# resp.results[0].last_modified_by #=> String
|
|
5839
|
+
# resp.results[0].last_modified_time #=> Time
|
|
5840
|
+
# resp.results[0].message_template_arn #=> String
|
|
5841
|
+
# resp.results[0].message_template_id #=> String
|
|
5842
|
+
# resp.results[0].name #=> String
|
|
5843
|
+
# resp.results[0].tags #=> Hash
|
|
5844
|
+
# resp.results[0].tags["TagKey"] #=> String
|
|
5845
|
+
# resp.results[0].version_number #=> Integer
|
|
5846
|
+
#
|
|
5847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchMessageTemplates AWS API Documentation
|
|
3928
5848
|
#
|
|
3929
|
-
# @overload
|
|
5849
|
+
# @overload search_message_templates(params = {})
|
|
3930
5850
|
# @param [Hash] params ({})
|
|
3931
|
-
def
|
|
3932
|
-
req = build_request(:
|
|
5851
|
+
def search_message_templates(params = {}, options = {})
|
|
5852
|
+
req = build_request(:search_message_templates, params)
|
|
3933
5853
|
req.send_request(options)
|
|
3934
5854
|
end
|
|
3935
5855
|
|
|
@@ -4101,6 +6021,76 @@ module Aws::QConnect
|
|
|
4101
6021
|
req.send_request(options)
|
|
4102
6022
|
end
|
|
4103
6023
|
|
|
6024
|
+
# Submits a message to the Amazon Q in Connect session.
|
|
6025
|
+
#
|
|
6026
|
+
# @option params [required, String] :assistant_id
|
|
6027
|
+
# The identifier of the Amazon Q in Connect assistant.
|
|
6028
|
+
#
|
|
6029
|
+
# @option params [String] :client_token
|
|
6030
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
6031
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
|
6032
|
+
# this field.For more information about idempotency, see Making retries
|
|
6033
|
+
# safe with idempotent APIs.
|
|
6034
|
+
#
|
|
6035
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
6036
|
+
# not need to pass this option.**
|
|
6037
|
+
#
|
|
6038
|
+
# @option params [Types::ConversationContext] :conversation_context
|
|
6039
|
+
# The conversation context before the Amazon Q in Connect session.
|
|
6040
|
+
#
|
|
6041
|
+
# @option params [required, Types::MessageInput] :message
|
|
6042
|
+
# The message data to submit to the Amazon Q in Connect session.
|
|
6043
|
+
#
|
|
6044
|
+
# @option params [required, String] :session_id
|
|
6045
|
+
# The identifier of the Amazon Q in Connect session.
|
|
6046
|
+
#
|
|
6047
|
+
# @option params [required, String] :type
|
|
6048
|
+
# The message type.
|
|
6049
|
+
#
|
|
6050
|
+
# @return [Types::SendMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6051
|
+
#
|
|
6052
|
+
# * {Types::SendMessageResponse#next_message_token #next_message_token} => String
|
|
6053
|
+
# * {Types::SendMessageResponse#request_message_id #request_message_id} => String
|
|
6054
|
+
#
|
|
6055
|
+
# @example Request syntax with placeholder values
|
|
6056
|
+
#
|
|
6057
|
+
# resp = client.send_message({
|
|
6058
|
+
# assistant_id: "UuidOrArn", # required
|
|
6059
|
+
# client_token: "ClientToken",
|
|
6060
|
+
# conversation_context: {
|
|
6061
|
+
# self_service_conversation_history: [ # required
|
|
6062
|
+
# {
|
|
6063
|
+
# bot_response: "SensitiveString",
|
|
6064
|
+
# input_transcript: "SensitiveString",
|
|
6065
|
+
# turn_number: 1, # required
|
|
6066
|
+
# },
|
|
6067
|
+
# ],
|
|
6068
|
+
# },
|
|
6069
|
+
# message: { # required
|
|
6070
|
+
# value: { # required
|
|
6071
|
+
# text: {
|
|
6072
|
+
# value: "TextMessageValueString",
|
|
6073
|
+
# },
|
|
6074
|
+
# },
|
|
6075
|
+
# },
|
|
6076
|
+
# session_id: "UuidOrArn", # required
|
|
6077
|
+
# type: "TEXT", # required, accepts TEXT
|
|
6078
|
+
# })
|
|
6079
|
+
#
|
|
6080
|
+
# @example Response structure
|
|
6081
|
+
#
|
|
6082
|
+
# resp.next_message_token #=> String
|
|
6083
|
+
# resp.request_message_id #=> String
|
|
6084
|
+
#
|
|
6085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessage AWS API Documentation
|
|
6086
|
+
#
|
|
6087
|
+
# @overload send_message(params = {})
|
|
6088
|
+
# @param [Hash] params ({})
|
|
6089
|
+
def send_message(params = {}, options = {})
|
|
6090
|
+
req = build_request(:send_message, params)
|
|
6091
|
+
req.send_request(options)
|
|
6092
|
+
end
|
|
6093
|
+
|
|
4104
6094
|
# Get a URL to upload content to a knowledge base. To upload content,
|
|
4105
6095
|
# first make a PUT request to the returned URL with your file, making
|
|
4106
6096
|
# sure to include the required headers. Then use [CreateContent][1] to
|
|
@@ -4327,9 +6317,9 @@ module Aws::QConnect
|
|
|
4327
6317
|
#
|
|
4328
6318
|
# @option params [String] :client_token
|
|
4329
6319
|
# 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]
|
|
6320
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
6321
|
+
# SDK populates this field. For more information about idempotency, see
|
|
6322
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
4333
6323
|
#
|
|
4334
6324
|
# **A suitable default value is auto-generated.** You should normally
|
|
4335
6325
|
# not need to pass this option.**
|
|
@@ -4359,6 +6349,7 @@ module Aws::QConnect
|
|
|
4359
6349
|
# client_token: "ClientToken",
|
|
4360
6350
|
# configuration: {
|
|
4361
6351
|
# answer_recommendation_ai_agent_configuration: {
|
|
6352
|
+
# answer_generation_ai_guardrail_id: "UuidWithQualifier",
|
|
4362
6353
|
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
4363
6354
|
# association_configurations: [
|
|
4364
6355
|
# {
|
|
@@ -4402,6 +6393,7 @@ module Aws::QConnect
|
|
|
4402
6393
|
# query_reformulation_ai_prompt_id: "UuidWithQualifier",
|
|
4403
6394
|
# },
|
|
4404
6395
|
# manual_search_ai_agent_configuration: {
|
|
6396
|
+
# answer_generation_ai_guardrail_id: "UuidWithQualifier",
|
|
4405
6397
|
# answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
4406
6398
|
# association_configurations: [
|
|
4407
6399
|
# {
|
|
@@ -4442,6 +6434,49 @@ module Aws::QConnect
|
|
|
4442
6434
|
# },
|
|
4443
6435
|
# ],
|
|
4444
6436
|
# },
|
|
6437
|
+
# self_service_ai_agent_configuration: {
|
|
6438
|
+
# association_configurations: [
|
|
6439
|
+
# {
|
|
6440
|
+
# association_configuration_data: {
|
|
6441
|
+
# knowledge_base_association_configuration_data: {
|
|
6442
|
+
# content_tag_filter: {
|
|
6443
|
+
# and_conditions: [
|
|
6444
|
+
# {
|
|
6445
|
+
# key: "TagKey", # required
|
|
6446
|
+
# value: "TagValue",
|
|
6447
|
+
# },
|
|
6448
|
+
# ],
|
|
6449
|
+
# or_conditions: [
|
|
6450
|
+
# {
|
|
6451
|
+
# and_conditions: [
|
|
6452
|
+
# {
|
|
6453
|
+
# key: "TagKey", # required
|
|
6454
|
+
# value: "TagValue",
|
|
6455
|
+
# },
|
|
6456
|
+
# ],
|
|
6457
|
+
# tag_condition: {
|
|
6458
|
+
# key: "TagKey", # required
|
|
6459
|
+
# value: "TagValue",
|
|
6460
|
+
# },
|
|
6461
|
+
# },
|
|
6462
|
+
# ],
|
|
6463
|
+
# tag_condition: {
|
|
6464
|
+
# key: "TagKey", # required
|
|
6465
|
+
# value: "TagValue",
|
|
6466
|
+
# },
|
|
6467
|
+
# },
|
|
6468
|
+
# max_results: 1,
|
|
6469
|
+
# override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
6470
|
+
# },
|
|
6471
|
+
# },
|
|
6472
|
+
# association_id: "Uuid",
|
|
6473
|
+
# association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
|
|
6474
|
+
# },
|
|
6475
|
+
# ],
|
|
6476
|
+
# self_service_ai_guardrail_id: "UuidWithQualifier",
|
|
6477
|
+
# self_service_answer_generation_ai_prompt_id: "UuidWithQualifier",
|
|
6478
|
+
# self_service_pre_processing_ai_prompt_id: "UuidWithQualifier",
|
|
6479
|
+
# },
|
|
4445
6480
|
# },
|
|
4446
6481
|
# description: "Description",
|
|
4447
6482
|
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
@@ -4453,6 +6488,7 @@ module Aws::QConnect
|
|
|
4453
6488
|
# resp.ai_agent.ai_agent_id #=> String
|
|
4454
6489
|
# resp.ai_agent.assistant_arn #=> String
|
|
4455
6490
|
# resp.ai_agent.assistant_id #=> String
|
|
6491
|
+
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
4456
6492
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
4457
6493
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
|
|
4458
6494
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -4472,6 +6508,7 @@ module Aws::QConnect
|
|
|
4472
6508
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
4473
6509
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
|
|
4474
6510
|
# resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
|
|
6511
|
+
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
|
|
4475
6512
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
|
|
4476
6513
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
|
|
4477
6514
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
@@ -4489,6 +6526,25 @@ module Aws::QConnect
|
|
|
4489
6526
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
4490
6527
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
4491
6528
|
# resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
6529
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
|
|
6530
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
|
|
6531
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
|
|
6532
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
|
|
6533
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
|
|
6534
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
|
|
6535
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
|
6536
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
|
6537
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
|
|
6538
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
|
|
6539
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
|
|
6540
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
|
|
6541
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
|
|
6542
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
|
|
6543
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
|
|
6544
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
|
|
6545
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
|
|
6546
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
|
|
6547
|
+
# resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
|
|
4492
6548
|
# resp.ai_agent.description #=> String
|
|
4493
6549
|
# resp.ai_agent.modified_time #=> Time
|
|
4494
6550
|
# resp.ai_agent.name #=> String
|
|
@@ -4496,7 +6552,7 @@ module Aws::QConnect
|
|
|
4496
6552
|
# resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
4497
6553
|
# resp.ai_agent.tags #=> Hash
|
|
4498
6554
|
# resp.ai_agent.tags["TagKey"] #=> String
|
|
4499
|
-
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION"
|
|
6555
|
+
# resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
|
|
4500
6556
|
# resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
4501
6557
|
#
|
|
4502
6558
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIAgent AWS API Documentation
|
|
@@ -4508,6 +6564,177 @@ module Aws::QConnect
|
|
|
4508
6564
|
req.send_request(options)
|
|
4509
6565
|
end
|
|
4510
6566
|
|
|
6567
|
+
# Updates an AI Guardrail.
|
|
6568
|
+
#
|
|
6569
|
+
# @option params [required, String] :ai_guardrail_id
|
|
6570
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
|
6571
|
+
#
|
|
6572
|
+
# @option params [required, String] :assistant_id
|
|
6573
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
6574
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
|
6575
|
+
#
|
|
6576
|
+
# @option params [required, String] :blocked_input_messaging
|
|
6577
|
+
# The message to return when the AI Guardrail blocks a prompt.
|
|
6578
|
+
#
|
|
6579
|
+
# @option params [required, String] :blocked_outputs_messaging
|
|
6580
|
+
# The message to return when the AI Guardrail blocks a model response.
|
|
6581
|
+
#
|
|
6582
|
+
# @option params [String] :client_token
|
|
6583
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
6584
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
6585
|
+
# SDK populates this field. For more information about idempotency, see
|
|
6586
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
6587
|
+
#
|
|
6588
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
6589
|
+
# not need to pass this option.**
|
|
6590
|
+
#
|
|
6591
|
+
#
|
|
6592
|
+
#
|
|
6593
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
6594
|
+
#
|
|
6595
|
+
# @option params [Types::AIGuardrailContentPolicyConfig] :content_policy_config
|
|
6596
|
+
# The content filter policies to configure for the AI Guardrail.
|
|
6597
|
+
#
|
|
6598
|
+
# @option params [Types::AIGuardrailContextualGroundingPolicyConfig] :contextual_grounding_policy_config
|
|
6599
|
+
# The contextual grounding policy configuration used to create an AI
|
|
6600
|
+
# Guardrail.
|
|
6601
|
+
#
|
|
6602
|
+
# @option params [String] :description
|
|
6603
|
+
# A description of the AI Guardrail.
|
|
6604
|
+
#
|
|
6605
|
+
# @option params [Types::AIGuardrailSensitiveInformationPolicyConfig] :sensitive_information_policy_config
|
|
6606
|
+
# The sensitive information policy to configure for the AI Guardrail.
|
|
6607
|
+
#
|
|
6608
|
+
# @option params [Types::AIGuardrailTopicPolicyConfig] :topic_policy_config
|
|
6609
|
+
# The topic policies to configure for the AI Guardrail.
|
|
6610
|
+
#
|
|
6611
|
+
# @option params [required, String] :visibility_status
|
|
6612
|
+
# The visibility status of the Amazon Q in Connect AI Guardrail.
|
|
6613
|
+
#
|
|
6614
|
+
# @option params [Types::AIGuardrailWordPolicyConfig] :word_policy_config
|
|
6615
|
+
# The word policy you configure for the AI Guardrail.
|
|
6616
|
+
#
|
|
6617
|
+
# @return [Types::UpdateAIGuardrailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6618
|
+
#
|
|
6619
|
+
# * {Types::UpdateAIGuardrailResponse#ai_guardrail #ai_guardrail} => Types::AIGuardrailData
|
|
6620
|
+
#
|
|
6621
|
+
# @example Request syntax with placeholder values
|
|
6622
|
+
#
|
|
6623
|
+
# resp = client.update_ai_guardrail({
|
|
6624
|
+
# ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
6625
|
+
# assistant_id: "UuidOrArn", # required
|
|
6626
|
+
# blocked_input_messaging: "AIGuardrailBlockedMessaging", # required
|
|
6627
|
+
# blocked_outputs_messaging: "AIGuardrailBlockedMessaging", # required
|
|
6628
|
+
# client_token: "ClientToken",
|
|
6629
|
+
# content_policy_config: {
|
|
6630
|
+
# filters_config: [ # required
|
|
6631
|
+
# {
|
|
6632
|
+
# input_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
|
|
6633
|
+
# output_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
|
|
6634
|
+
# type: "SEXUAL", # required, accepts SEXUAL, VIOLENCE, HATE, INSULTS, MISCONDUCT, PROMPT_ATTACK
|
|
6635
|
+
# },
|
|
6636
|
+
# ],
|
|
6637
|
+
# },
|
|
6638
|
+
# contextual_grounding_policy_config: {
|
|
6639
|
+
# filters_config: [ # required
|
|
6640
|
+
# {
|
|
6641
|
+
# threshold: 1.0, # required
|
|
6642
|
+
# type: "GROUNDING", # required, accepts GROUNDING, RELEVANCE
|
|
6643
|
+
# },
|
|
6644
|
+
# ],
|
|
6645
|
+
# },
|
|
6646
|
+
# description: "AIGuardrailDescription",
|
|
6647
|
+
# sensitive_information_policy_config: {
|
|
6648
|
+
# pii_entities_config: [
|
|
6649
|
+
# {
|
|
6650
|
+
# action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
|
|
6651
|
+
# type: "ADDRESS", # required, accepts ADDRESS, AGE, AWS_ACCESS_KEY, AWS_SECRET_KEY, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, DRIVER_ID, EMAIL, INTERNATIONAL_BANK_ACCOUNT_NUMBER, IP_ADDRESS, LICENSE_PLATE, MAC_ADDRESS, NAME, PASSWORD, PHONE, PIN, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, URL, USERNAME, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, VEHICLE_IDENTIFICATION_NUMBER
|
|
6652
|
+
# },
|
|
6653
|
+
# ],
|
|
6654
|
+
# regexes_config: [
|
|
6655
|
+
# {
|
|
6656
|
+
# action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
|
|
6657
|
+
# description: "GuardrailRegexDescription",
|
|
6658
|
+
# name: "GuardrailRegexName", # required
|
|
6659
|
+
# pattern: "GuardrailRegexPattern", # required
|
|
6660
|
+
# },
|
|
6661
|
+
# ],
|
|
6662
|
+
# },
|
|
6663
|
+
# topic_policy_config: {
|
|
6664
|
+
# topics_config: [ # required
|
|
6665
|
+
# {
|
|
6666
|
+
# definition: "GuardrailTopicDefinition", # required
|
|
6667
|
+
# examples: ["GuardrailTopicExample"],
|
|
6668
|
+
# name: "GuardrailTopicName", # required
|
|
6669
|
+
# type: "DENY", # required, accepts DENY
|
|
6670
|
+
# },
|
|
6671
|
+
# ],
|
|
6672
|
+
# },
|
|
6673
|
+
# visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
|
|
6674
|
+
# word_policy_config: {
|
|
6675
|
+
# managed_word_lists_config: [
|
|
6676
|
+
# {
|
|
6677
|
+
# type: "PROFANITY", # required, accepts PROFANITY
|
|
6678
|
+
# },
|
|
6679
|
+
# ],
|
|
6680
|
+
# words_config: [
|
|
6681
|
+
# {
|
|
6682
|
+
# text: "GuardrailWordText", # required
|
|
6683
|
+
# },
|
|
6684
|
+
# ],
|
|
6685
|
+
# },
|
|
6686
|
+
# })
|
|
6687
|
+
#
|
|
6688
|
+
# @example Response structure
|
|
6689
|
+
#
|
|
6690
|
+
# resp.ai_guardrail.ai_guardrail_arn #=> String
|
|
6691
|
+
# resp.ai_guardrail.ai_guardrail_id #=> String
|
|
6692
|
+
# resp.ai_guardrail.assistant_arn #=> String
|
|
6693
|
+
# resp.ai_guardrail.assistant_id #=> String
|
|
6694
|
+
# resp.ai_guardrail.blocked_input_messaging #=> String
|
|
6695
|
+
# resp.ai_guardrail.blocked_outputs_messaging #=> String
|
|
6696
|
+
# resp.ai_guardrail.content_policy_config.filters_config #=> Array
|
|
6697
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
6698
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
|
|
6699
|
+
# resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
|
|
6700
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
|
|
6701
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
|
|
6702
|
+
# resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
|
|
6703
|
+
# resp.ai_guardrail.description #=> String
|
|
6704
|
+
# resp.ai_guardrail.modified_time #=> Time
|
|
6705
|
+
# resp.ai_guardrail.name #=> String
|
|
6706
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
|
|
6707
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
6708
|
+
# resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
|
|
6709
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
|
|
6710
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
|
|
6711
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
|
|
6712
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
|
|
6713
|
+
# resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
|
|
6714
|
+
# resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
|
6715
|
+
# resp.ai_guardrail.tags #=> Hash
|
|
6716
|
+
# resp.ai_guardrail.tags["TagKey"] #=> String
|
|
6717
|
+
# resp.ai_guardrail.topic_policy_config.topics_config #=> Array
|
|
6718
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
|
|
6719
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
|
|
6720
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
|
|
6721
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
|
|
6722
|
+
# resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
|
|
6723
|
+
# resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
6724
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
|
|
6725
|
+
# resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
|
|
6726
|
+
# resp.ai_guardrail.word_policy_config.words_config #=> Array
|
|
6727
|
+
# resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
|
|
6728
|
+
#
|
|
6729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIGuardrail AWS API Documentation
|
|
6730
|
+
#
|
|
6731
|
+
# @overload update_ai_guardrail(params = {})
|
|
6732
|
+
# @param [Hash] params ({})
|
|
6733
|
+
def update_ai_guardrail(params = {}, options = {})
|
|
6734
|
+
req = build_request(:update_ai_guardrail, params)
|
|
6735
|
+
req.send_request(options)
|
|
6736
|
+
end
|
|
6737
|
+
|
|
4511
6738
|
# Updates an AI Prompt.
|
|
4512
6739
|
#
|
|
4513
6740
|
# @option params [required, String] :ai_prompt_id
|
|
@@ -4519,16 +6746,16 @@ module Aws::QConnect
|
|
|
4519
6746
|
#
|
|
4520
6747
|
# @option params [String] :client_token
|
|
4521
6748
|
# 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]
|
|
6749
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
6750
|
+
# SDK populates this field. For more information about idempotency, see
|
|
6751
|
+
# [Making retries safe with idempotent APIs][1]..
|
|
4525
6752
|
#
|
|
4526
6753
|
# **A suitable default value is auto-generated.** You should normally
|
|
4527
6754
|
# not need to pass this option.**
|
|
4528
6755
|
#
|
|
4529
6756
|
#
|
|
4530
6757
|
#
|
|
4531
|
-
# [1]: http://aws.amazon.com/
|
|
6758
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
4532
6759
|
#
|
|
4533
6760
|
# @option params [String] :description
|
|
4534
6761
|
# The description of the Amazon Q in Connect AI Prompt.
|
|
@@ -4575,7 +6802,7 @@ module Aws::QConnect
|
|
|
4575
6802
|
# resp.ai_prompt.tags["TagKey"] #=> String
|
|
4576
6803
|
# resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
|
|
4577
6804
|
# resp.ai_prompt.template_type #=> String, one of "TEXT"
|
|
4578
|
-
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION"
|
|
6805
|
+
# resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
|
|
4579
6806
|
# resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
|
|
4580
6807
|
#
|
|
4581
6808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIPrompt AWS API Documentation
|
|
@@ -4609,7 +6836,7 @@ module Aws::QConnect
|
|
|
4609
6836
|
# @example Request syntax with placeholder values
|
|
4610
6837
|
#
|
|
4611
6838
|
# resp = client.update_assistant_ai_agent({
|
|
4612
|
-
# ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION
|
|
6839
|
+
# ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION, SELF_SERVICE
|
|
4613
6840
|
# assistant_id: "UuidOrArn", # required
|
|
4614
6841
|
# configuration: { # required
|
|
4615
6842
|
# ai_agent_id: "UuidWithQualifier", # required
|
|
@@ -4806,6 +7033,405 @@ module Aws::QConnect
|
|
|
4806
7033
|
req.send_request(options)
|
|
4807
7034
|
end
|
|
4808
7035
|
|
|
7036
|
+
# Updates the Amazon Q in Connect message template. Partial update is
|
|
7037
|
+
# supported. If any field is not supplied, it will remain unchanged for
|
|
7038
|
+
# the message template that is referenced by the `$LATEST` qualifier.
|
|
7039
|
+
# Any modification will only apply to the message template that is
|
|
7040
|
+
# referenced by the `$LATEST` qualifier. The fields for all available
|
|
7041
|
+
# versions will remain unchanged.
|
|
7042
|
+
#
|
|
7043
|
+
# @option params [Types::MessageTemplateContentProvider] :content
|
|
7044
|
+
# The content of the message template.
|
|
7045
|
+
#
|
|
7046
|
+
# @option params [Types::MessageTemplateAttributes] :default_attributes
|
|
7047
|
+
# An object that specifies the default values to use for variables in
|
|
7048
|
+
# the message template. This object contains different categories of
|
|
7049
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
|
7050
|
+
# message template. The corresponding value defines the default value
|
|
7051
|
+
# for that variable.
|
|
7052
|
+
#
|
|
7053
|
+
# @option params [required, String] :knowledge_base_id
|
|
7054
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
7055
|
+
# URLs cannot contain the ARN.
|
|
7056
|
+
#
|
|
7057
|
+
# @option params [String] :language
|
|
7058
|
+
# The language code value for the language in which the quick response
|
|
7059
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
|
7060
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
|
7061
|
+
# `zh_CN`, `zh_TW`
|
|
7062
|
+
#
|
|
7063
|
+
# @option params [required, String] :message_template_id
|
|
7064
|
+
# The identifier of the message template. Can be either the ID or the
|
|
7065
|
+
# ARN. It cannot contain any qualifier.
|
|
7066
|
+
#
|
|
7067
|
+
# @return [Types::UpdateMessageTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7068
|
+
#
|
|
7069
|
+
# * {Types::UpdateMessageTemplateResponse#message_template #message_template} => Types::MessageTemplateData
|
|
7070
|
+
#
|
|
7071
|
+
# @example Request syntax with placeholder values
|
|
7072
|
+
#
|
|
7073
|
+
# resp = client.update_message_template({
|
|
7074
|
+
# content: {
|
|
7075
|
+
# email: {
|
|
7076
|
+
# body: {
|
|
7077
|
+
# html: {
|
|
7078
|
+
# content: "NonEmptyUnlimitedString",
|
|
7079
|
+
# },
|
|
7080
|
+
# plain_text: {
|
|
7081
|
+
# content: "NonEmptyUnlimitedString",
|
|
7082
|
+
# },
|
|
7083
|
+
# },
|
|
7084
|
+
# headers: [
|
|
7085
|
+
# {
|
|
7086
|
+
# name: "EmailHeaderKey",
|
|
7087
|
+
# value: "EmailHeaderValue",
|
|
7088
|
+
# },
|
|
7089
|
+
# ],
|
|
7090
|
+
# subject: "NonEmptyUnlimitedString",
|
|
7091
|
+
# },
|
|
7092
|
+
# sms: {
|
|
7093
|
+
# body: {
|
|
7094
|
+
# plain_text: {
|
|
7095
|
+
# content: "NonEmptyUnlimitedString",
|
|
7096
|
+
# },
|
|
7097
|
+
# },
|
|
7098
|
+
# },
|
|
7099
|
+
# },
|
|
7100
|
+
# default_attributes: {
|
|
7101
|
+
# agent_attributes: {
|
|
7102
|
+
# first_name: "MessageTemplateAttributeValue",
|
|
7103
|
+
# last_name: "MessageTemplateAttributeValue",
|
|
7104
|
+
# },
|
|
7105
|
+
# custom_attributes: {
|
|
7106
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
|
7107
|
+
# },
|
|
7108
|
+
# customer_profile_attributes: {
|
|
7109
|
+
# account_number: "MessageTemplateAttributeValue",
|
|
7110
|
+
# additional_information: "MessageTemplateAttributeValue",
|
|
7111
|
+
# address1: "MessageTemplateAttributeValue",
|
|
7112
|
+
# address2: "MessageTemplateAttributeValue",
|
|
7113
|
+
# address3: "MessageTemplateAttributeValue",
|
|
7114
|
+
# address4: "MessageTemplateAttributeValue",
|
|
7115
|
+
# billing_address_1: "MessageTemplateAttributeValue",
|
|
7116
|
+
# billing_address_2: "MessageTemplateAttributeValue",
|
|
7117
|
+
# billing_address_3: "MessageTemplateAttributeValue",
|
|
7118
|
+
# billing_address_4: "MessageTemplateAttributeValue",
|
|
7119
|
+
# billing_city: "MessageTemplateAttributeValue",
|
|
7120
|
+
# billing_country: "MessageTemplateAttributeValue",
|
|
7121
|
+
# billing_county: "MessageTemplateAttributeValue",
|
|
7122
|
+
# billing_postal_code: "MessageTemplateAttributeValue",
|
|
7123
|
+
# billing_province: "MessageTemplateAttributeValue",
|
|
7124
|
+
# billing_state: "MessageTemplateAttributeValue",
|
|
7125
|
+
# birth_date: "MessageTemplateAttributeValue",
|
|
7126
|
+
# business_email_address: "MessageTemplateAttributeValue",
|
|
7127
|
+
# business_name: "MessageTemplateAttributeValue",
|
|
7128
|
+
# business_phone_number: "MessageTemplateAttributeValue",
|
|
7129
|
+
# city: "MessageTemplateAttributeValue",
|
|
7130
|
+
# country: "MessageTemplateAttributeValue",
|
|
7131
|
+
# county: "MessageTemplateAttributeValue",
|
|
7132
|
+
# custom: {
|
|
7133
|
+
# "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
|
|
7134
|
+
# },
|
|
7135
|
+
# email_address: "MessageTemplateAttributeValue",
|
|
7136
|
+
# first_name: "MessageTemplateAttributeValue",
|
|
7137
|
+
# gender: "MessageTemplateAttributeValue",
|
|
7138
|
+
# home_phone_number: "MessageTemplateAttributeValue",
|
|
7139
|
+
# last_name: "MessageTemplateAttributeValue",
|
|
7140
|
+
# mailing_address_1: "MessageTemplateAttributeValue",
|
|
7141
|
+
# mailing_address_2: "MessageTemplateAttributeValue",
|
|
7142
|
+
# mailing_address_3: "MessageTemplateAttributeValue",
|
|
7143
|
+
# mailing_address_4: "MessageTemplateAttributeValue",
|
|
7144
|
+
# mailing_city: "MessageTemplateAttributeValue",
|
|
7145
|
+
# mailing_country: "MessageTemplateAttributeValue",
|
|
7146
|
+
# mailing_county: "MessageTemplateAttributeValue",
|
|
7147
|
+
# mailing_postal_code: "MessageTemplateAttributeValue",
|
|
7148
|
+
# mailing_province: "MessageTemplateAttributeValue",
|
|
7149
|
+
# mailing_state: "MessageTemplateAttributeValue",
|
|
7150
|
+
# middle_name: "MessageTemplateAttributeValue",
|
|
7151
|
+
# mobile_phone_number: "MessageTemplateAttributeValue",
|
|
7152
|
+
# party_type: "MessageTemplateAttributeValue",
|
|
7153
|
+
# phone_number: "MessageTemplateAttributeValue",
|
|
7154
|
+
# postal_code: "MessageTemplateAttributeValue",
|
|
7155
|
+
# profile_arn: "MessageTemplateAttributeValue",
|
|
7156
|
+
# profile_id: "MessageTemplateAttributeValue",
|
|
7157
|
+
# province: "MessageTemplateAttributeValue",
|
|
7158
|
+
# shipping_address_1: "MessageTemplateAttributeValue",
|
|
7159
|
+
# shipping_address_2: "MessageTemplateAttributeValue",
|
|
7160
|
+
# shipping_address_3: "MessageTemplateAttributeValue",
|
|
7161
|
+
# shipping_address_4: "MessageTemplateAttributeValue",
|
|
7162
|
+
# shipping_city: "MessageTemplateAttributeValue",
|
|
7163
|
+
# shipping_country: "MessageTemplateAttributeValue",
|
|
7164
|
+
# shipping_county: "MessageTemplateAttributeValue",
|
|
7165
|
+
# shipping_postal_code: "MessageTemplateAttributeValue",
|
|
7166
|
+
# shipping_province: "MessageTemplateAttributeValue",
|
|
7167
|
+
# shipping_state: "MessageTemplateAttributeValue",
|
|
7168
|
+
# state: "MessageTemplateAttributeValue",
|
|
7169
|
+
# },
|
|
7170
|
+
# system_attributes: {
|
|
7171
|
+
# customer_endpoint: {
|
|
7172
|
+
# address: "MessageTemplateAttributeValue",
|
|
7173
|
+
# },
|
|
7174
|
+
# name: "MessageTemplateAttributeValue",
|
|
7175
|
+
# system_endpoint: {
|
|
7176
|
+
# address: "MessageTemplateAttributeValue",
|
|
7177
|
+
# },
|
|
7178
|
+
# },
|
|
7179
|
+
# },
|
|
7180
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
7181
|
+
# language: "LanguageCode",
|
|
7182
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
7183
|
+
# })
|
|
7184
|
+
#
|
|
7185
|
+
# @example Response structure
|
|
7186
|
+
#
|
|
7187
|
+
# resp.message_template.attribute_types #=> Array
|
|
7188
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
|
7189
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
7190
|
+
# resp.message_template.content.email.body.html.content #=> String
|
|
7191
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
|
7192
|
+
# resp.message_template.content.email.headers #=> Array
|
|
7193
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
|
7194
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
|
7195
|
+
# resp.message_template.content.email.subject #=> String
|
|
7196
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
|
7197
|
+
# resp.message_template.created_time #=> Time
|
|
7198
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
|
7199
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
|
7200
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
|
7201
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
|
7202
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
|
7203
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
|
7204
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
|
7205
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
|
7206
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
|
7207
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
|
7208
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
|
7209
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
|
7210
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
|
7211
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
|
7212
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
|
7213
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
|
7214
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
|
7215
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
|
7216
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
|
7217
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
|
7218
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
|
7219
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
|
7220
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
|
7221
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
|
7222
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
|
7223
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
|
7224
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
|
7225
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
|
7226
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
|
7227
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
|
7228
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
|
7229
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
|
7230
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
|
7231
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
|
7232
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
|
7233
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
|
7234
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
|
7235
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
|
7236
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
|
7237
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
|
7238
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
|
7239
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
|
7240
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
|
7241
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
|
7242
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
|
7243
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
|
7244
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
|
7245
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
|
7246
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
|
7247
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
|
7248
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
|
7249
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
|
7250
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
|
7251
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
|
7252
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
|
7253
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
|
7254
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
|
7255
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
|
7256
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
|
7257
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
|
7258
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
|
7259
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
|
7260
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
|
7261
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
|
7262
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
|
7263
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
|
7264
|
+
# resp.message_template.description #=> String
|
|
7265
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
|
7266
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
|
7267
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
|
7268
|
+
# resp.message_template.knowledge_base_arn #=> String
|
|
7269
|
+
# resp.message_template.knowledge_base_id #=> String
|
|
7270
|
+
# resp.message_template.language #=> String
|
|
7271
|
+
# resp.message_template.last_modified_by #=> String
|
|
7272
|
+
# resp.message_template.last_modified_time #=> Time
|
|
7273
|
+
# resp.message_template.message_template_arn #=> String
|
|
7274
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
|
7275
|
+
# resp.message_template.message_template_id #=> String
|
|
7276
|
+
# resp.message_template.name #=> String
|
|
7277
|
+
# resp.message_template.tags #=> Hash
|
|
7278
|
+
# resp.message_template.tags["TagKey"] #=> String
|
|
7279
|
+
#
|
|
7280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplate AWS API Documentation
|
|
7281
|
+
#
|
|
7282
|
+
# @overload update_message_template(params = {})
|
|
7283
|
+
# @param [Hash] params ({})
|
|
7284
|
+
def update_message_template(params = {}, options = {})
|
|
7285
|
+
req = build_request(:update_message_template, params)
|
|
7286
|
+
req.send_request(options)
|
|
7287
|
+
end
|
|
7288
|
+
|
|
7289
|
+
# Updates the Amazon Q in Connect message template metadata. Note that
|
|
7290
|
+
# any modification to the message template’s name, description and
|
|
7291
|
+
# grouping configuration will applied to the message template pointed by
|
|
7292
|
+
# the `$LATEST` qualifier and all available versions. Partial update is
|
|
7293
|
+
# supported. If any field is not supplied, it will remain unchanged for
|
|
7294
|
+
# the message template.
|
|
7295
|
+
#
|
|
7296
|
+
# @option params [String] :description
|
|
7297
|
+
# The description of the message template.
|
|
7298
|
+
#
|
|
7299
|
+
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
|
7300
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
|
7301
|
+
# users.
|
|
7302
|
+
#
|
|
7303
|
+
# @option params [required, String] :knowledge_base_id
|
|
7304
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
|
7305
|
+
# URLs cannot contain the ARN.
|
|
7306
|
+
#
|
|
7307
|
+
# @option params [required, String] :message_template_id
|
|
7308
|
+
# The identifier of the message template. Can be either the ID or the
|
|
7309
|
+
# ARN. It cannot contain any qualifier.
|
|
7310
|
+
#
|
|
7311
|
+
# @option params [String] :name
|
|
7312
|
+
# The name of the message template.
|
|
7313
|
+
#
|
|
7314
|
+
# @return [Types::UpdateMessageTemplateMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7315
|
+
#
|
|
7316
|
+
# * {Types::UpdateMessageTemplateMetadataResponse#message_template #message_template} => Types::MessageTemplateData
|
|
7317
|
+
#
|
|
7318
|
+
# @example Request syntax with placeholder values
|
|
7319
|
+
#
|
|
7320
|
+
# resp = client.update_message_template_metadata({
|
|
7321
|
+
# description: "Description",
|
|
7322
|
+
# grouping_configuration: {
|
|
7323
|
+
# criteria: "GroupingCriteria",
|
|
7324
|
+
# values: ["GroupingValue"],
|
|
7325
|
+
# },
|
|
7326
|
+
# knowledge_base_id: "UuidOrArn", # required
|
|
7327
|
+
# message_template_id: "UuidOrArnOrEitherWithQualifier", # required
|
|
7328
|
+
# name: "Name",
|
|
7329
|
+
# })
|
|
7330
|
+
#
|
|
7331
|
+
# @example Response structure
|
|
7332
|
+
#
|
|
7333
|
+
# resp.message_template.attribute_types #=> Array
|
|
7334
|
+
# resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
|
|
7335
|
+
# resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
|
|
7336
|
+
# resp.message_template.content.email.body.html.content #=> String
|
|
7337
|
+
# resp.message_template.content.email.body.plain_text.content #=> String
|
|
7338
|
+
# resp.message_template.content.email.headers #=> Array
|
|
7339
|
+
# resp.message_template.content.email.headers[0].name #=> String
|
|
7340
|
+
# resp.message_template.content.email.headers[0].value #=> String
|
|
7341
|
+
# resp.message_template.content.email.subject #=> String
|
|
7342
|
+
# resp.message_template.content.sms.body.plain_text.content #=> String
|
|
7343
|
+
# resp.message_template.created_time #=> Time
|
|
7344
|
+
# resp.message_template.default_attributes.agent_attributes.first_name #=> String
|
|
7345
|
+
# resp.message_template.default_attributes.agent_attributes.last_name #=> String
|
|
7346
|
+
# resp.message_template.default_attributes.custom_attributes #=> Hash
|
|
7347
|
+
# resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
|
|
7348
|
+
# resp.message_template.default_attributes.customer_profile_attributes.account_number #=> String
|
|
7349
|
+
# resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
|
|
7350
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
|
|
7351
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
|
|
7352
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
|
|
7353
|
+
# resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
|
|
7354
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
|
|
7355
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
|
|
7356
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
|
|
7357
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
|
|
7358
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
|
|
7359
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
|
|
7360
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
|
|
7361
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
|
|
7362
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
|
|
7363
|
+
# resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
|
|
7364
|
+
# resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
|
|
7365
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
|
|
7366
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
|
|
7367
|
+
# resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
|
|
7368
|
+
# resp.message_template.default_attributes.customer_profile_attributes.city #=> String
|
|
7369
|
+
# resp.message_template.default_attributes.customer_profile_attributes.country #=> String
|
|
7370
|
+
# resp.message_template.default_attributes.customer_profile_attributes.county #=> String
|
|
7371
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
|
|
7372
|
+
# resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
|
|
7373
|
+
# resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
|
|
7374
|
+
# resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
|
|
7375
|
+
# resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
|
|
7376
|
+
# resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
|
|
7377
|
+
# resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
|
|
7378
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
|
|
7379
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
|
|
7380
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
|
|
7381
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
|
|
7382
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
|
|
7383
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
|
|
7384
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
|
|
7385
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
|
|
7386
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
|
|
7387
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
|
|
7388
|
+
# resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
|
|
7389
|
+
# resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
|
|
7390
|
+
# resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
|
|
7391
|
+
# resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
|
|
7392
|
+
# resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
|
|
7393
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
|
|
7394
|
+
# resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
|
|
7395
|
+
# resp.message_template.default_attributes.customer_profile_attributes.province #=> String
|
|
7396
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
|
|
7397
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
|
|
7398
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
|
|
7399
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
|
|
7400
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
|
|
7401
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
|
|
7402
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
|
|
7403
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
|
|
7404
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
|
|
7405
|
+
# resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
|
|
7406
|
+
# resp.message_template.default_attributes.customer_profile_attributes.state #=> String
|
|
7407
|
+
# resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
|
|
7408
|
+
# resp.message_template.default_attributes.system_attributes.name #=> String
|
|
7409
|
+
# resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
|
|
7410
|
+
# resp.message_template.description #=> String
|
|
7411
|
+
# resp.message_template.grouping_configuration.criteria #=> String
|
|
7412
|
+
# resp.message_template.grouping_configuration.values #=> Array
|
|
7413
|
+
# resp.message_template.grouping_configuration.values[0] #=> String
|
|
7414
|
+
# resp.message_template.knowledge_base_arn #=> String
|
|
7415
|
+
# resp.message_template.knowledge_base_id #=> String
|
|
7416
|
+
# resp.message_template.language #=> String
|
|
7417
|
+
# resp.message_template.last_modified_by #=> String
|
|
7418
|
+
# resp.message_template.last_modified_time #=> Time
|
|
7419
|
+
# resp.message_template.message_template_arn #=> String
|
|
7420
|
+
# resp.message_template.message_template_content_sha_256 #=> String
|
|
7421
|
+
# resp.message_template.message_template_id #=> String
|
|
7422
|
+
# resp.message_template.name #=> String
|
|
7423
|
+
# resp.message_template.tags #=> Hash
|
|
7424
|
+
# resp.message_template.tags["TagKey"] #=> String
|
|
7425
|
+
#
|
|
7426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateMetadata AWS API Documentation
|
|
7427
|
+
#
|
|
7428
|
+
# @overload update_message_template_metadata(params = {})
|
|
7429
|
+
# @param [Hash] params ({})
|
|
7430
|
+
def update_message_template_metadata(params = {}, options = {})
|
|
7431
|
+
req = build_request(:update_message_template_metadata, params)
|
|
7432
|
+
req.send_request(options)
|
|
7433
|
+
end
|
|
7434
|
+
|
|
4809
7435
|
# Updates an existing Amazon Q in Connect quick response.
|
|
4810
7436
|
#
|
|
4811
7437
|
# @option params [Array<String>] :channels
|
|
@@ -5100,7 +7726,7 @@ module Aws::QConnect
|
|
|
5100
7726
|
tracer: tracer
|
|
5101
7727
|
)
|
|
5102
7728
|
context[:gem_name] = 'aws-sdk-qconnect'
|
|
5103
|
-
context[:gem_version] = '1.
|
|
7729
|
+
context[:gem_version] = '1.25.0'
|
|
5104
7730
|
Seahorse::Client::Request.new(handlers, context)
|
|
5105
7731
|
end
|
|
5106
7732
|
|