aws-sdk-qbusiness 1.2.0 → 1.4.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-qbusiness/client.rb +374 -273
- data/lib/aws-sdk-qbusiness/client_api.rb +36 -5
- data/lib/aws-sdk-qbusiness/types.rb +709 -457
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +19 -5
- data/sig/types.rbs +34 -0
- metadata +4 -4
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
22
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
25
26
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
27
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
28
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
@@ -72,6 +73,7 @@ module Aws::QBusiness
|
|
72
73
|
add_plugin(Aws::Plugins::ResponsePaging)
|
73
74
|
add_plugin(Aws::Plugins::StubResponses)
|
74
75
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
76
|
+
add_plugin(Aws::Plugins::InvocationId)
|
75
77
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
79
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -196,10 +198,17 @@ module Aws::QBusiness
|
|
196
198
|
# When set to 'true' the request body will not be compressed
|
197
199
|
# for supported operations.
|
198
200
|
#
|
199
|
-
# @option options [String] :endpoint
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
201
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
202
|
+
# Normally you should not configure the `:endpoint` option
|
203
|
+
# directly. This is normally constructed from the `:region`
|
204
|
+
# option. Configuring `:endpoint` is normally reserved for
|
205
|
+
# connecting to test or custom endpoints. The endpoint should
|
206
|
+
# be a URI formatted like:
|
207
|
+
#
|
208
|
+
# 'http://example.com'
|
209
|
+
# 'https://example.com'
|
210
|
+
# 'http://example.com:123'
|
211
|
+
#
|
203
212
|
#
|
204
213
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
214
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -337,50 +346,65 @@ module Aws::QBusiness
|
|
337
346
|
# @option options [Aws::QBusiness::EndpointProvider] :endpoint_provider
|
338
347
|
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::QBusiness::EndpointParameters`
|
339
348
|
#
|
340
|
-
# @option options [
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
# @option options [Float] :
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
349
|
+
# @option options [Float] :http_continue_timeout (1)
|
350
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
351
|
+
# request body. This option has no effect unless the request has "Expect"
|
352
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
353
|
+
# behaviour. This value can safely be set per request on the session.
|
354
|
+
#
|
355
|
+
# @option options [Float] :http_idle_timeout (5)
|
356
|
+
# The number of seconds a connection is allowed to sit idle before it
|
357
|
+
# is considered stale. Stale connections are closed and removed from the
|
358
|
+
# pool before making a request.
|
359
|
+
#
|
360
|
+
# @option options [Float] :http_open_timeout (15)
|
361
|
+
# The default number of seconds to wait for response data.
|
362
|
+
# This value can safely be set per-request on the session.
|
363
|
+
#
|
364
|
+
# @option options [URI::HTTP,String] :http_proxy
|
365
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
366
|
+
#
|
367
|
+
# @option options [Float] :http_read_timeout (60)
|
368
|
+
# The default number of seconds to wait for response data.
|
369
|
+
# This value can safely be set per-request on the session.
|
370
|
+
#
|
371
|
+
# @option options [Boolean] :http_wire_trace (false)
|
372
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
373
|
+
#
|
374
|
+
# @option options [Proc] :on_chunk_received
|
375
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
376
|
+
# of the response body is received. It provides three arguments: the chunk,
|
377
|
+
# the number of bytes received, and the total number of
|
378
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
379
|
+
#
|
380
|
+
# @option options [Proc] :on_chunk_sent
|
381
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
382
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
383
|
+
# the number of bytes read from the body, and the total number of
|
384
|
+
# bytes in the body.
|
385
|
+
#
|
386
|
+
# @option options [Boolean] :raise_response_errors (true)
|
387
|
+
# When `true`, response errors are raised.
|
388
|
+
#
|
389
|
+
# @option options [String] :ssl_ca_bundle
|
390
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
391
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
392
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
393
|
+
#
|
394
|
+
# @option options [String] :ssl_ca_directory
|
395
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
396
|
+
# authority files for verifying peer certificates. If you do
|
397
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
398
|
+
# default will be used if available.
|
365
399
|
#
|
366
|
-
# @option options [
|
367
|
-
#
|
400
|
+
# @option options [String] :ssl_ca_store
|
401
|
+
# Sets the X509::Store to verify peer certificate.
|
368
402
|
#
|
369
|
-
# @option options [
|
370
|
-
#
|
371
|
-
# connection.
|
403
|
+
# @option options [Float] :ssl_timeout
|
404
|
+
# Sets the SSL timeout in seconds
|
372
405
|
#
|
373
|
-
# @option options [
|
374
|
-
#
|
375
|
-
# verifying peer certificates. If you do not pass
|
376
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
377
|
-
# will be used if available.
|
378
|
-
#
|
379
|
-
# @option options [String] :ssl_ca_directory Full path of the
|
380
|
-
# directory that contains the unbundled SSL certificate
|
381
|
-
# authority files for verifying peer certificates. If you do
|
382
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
383
|
-
# system default will be used if available.
|
406
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
407
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
384
408
|
#
|
385
409
|
def initialize(*args)
|
386
410
|
super
|
@@ -389,24 +413,24 @@ module Aws::QBusiness
|
|
389
413
|
# @!group API Operations
|
390
414
|
|
391
415
|
# Asynchronously deletes one or more documents added using the
|
392
|
-
# `BatchPutDocument` API from an Amazon Q index.
|
416
|
+
# `BatchPutDocument` API from an Amazon Q Business index.
|
393
417
|
#
|
394
418
|
# You can see the progress of the deletion, and any error messages
|
395
419
|
# related to the process, by using CloudWatch.
|
396
420
|
#
|
397
421
|
# @option params [required, String] :application_id
|
398
|
-
# The identifier of the Amazon Q application.
|
422
|
+
# The identifier of the Amazon Q Business application.
|
399
423
|
#
|
400
424
|
# @option params [String] :data_source_sync_id
|
401
425
|
# The identifier of the data source sync during which the documents were
|
402
426
|
# deleted.
|
403
427
|
#
|
404
428
|
# @option params [required, Array<Types::DeleteDocument>] :documents
|
405
|
-
# Documents deleted from the Amazon Q index.
|
429
|
+
# Documents deleted from the Amazon Q Business index.
|
406
430
|
#
|
407
431
|
# @option params [required, String] :index_id
|
408
|
-
# The identifier of the Amazon Q index that contains the
|
409
|
-
# delete.
|
432
|
+
# The identifier of the Amazon Q Business index that contains the
|
433
|
+
# documents to delete.
|
410
434
|
#
|
411
435
|
# @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
412
436
|
#
|
@@ -442,23 +466,23 @@ module Aws::QBusiness
|
|
442
466
|
req.send_request(options)
|
443
467
|
end
|
444
468
|
|
445
|
-
# Adds one or more documents to an Amazon Q index.
|
469
|
+
# Adds one or more documents to an Amazon Q Business index.
|
446
470
|
#
|
447
471
|
# You use this API to:
|
448
472
|
#
|
449
473
|
# * ingest your structured and unstructured documents and documents
|
450
|
-
# stored in an Amazon S3 bucket into an Amazon Q index.
|
474
|
+
# stored in an Amazon S3 bucket into an Amazon Q Business index.
|
451
475
|
#
|
452
|
-
# * add custom attributes to documents in an Amazon Q index.
|
476
|
+
# * add custom attributes to documents in an Amazon Q Business index.
|
453
477
|
#
|
454
478
|
# * attach an access control list to the documents added to an Amazon Q
|
455
|
-
# index.
|
479
|
+
# Business index.
|
456
480
|
#
|
457
481
|
# You can see the progress of the deletion, and any error messages
|
458
482
|
# related to the process, by using CloudWatch.
|
459
483
|
#
|
460
484
|
# @option params [required, String] :application_id
|
461
|
-
# The identifier of the Amazon Q application.
|
485
|
+
# The identifier of the Amazon Q Business application.
|
462
486
|
#
|
463
487
|
# @option params [String] :data_source_sync_id
|
464
488
|
# The identifier of the data source sync during which the documents were
|
@@ -468,7 +492,7 @@ module Aws::QBusiness
|
|
468
492
|
# One or more documents to add to the index.
|
469
493
|
#
|
470
494
|
# @option params [required, String] :index_id
|
471
|
-
# The identifier of the Amazon Q index to add the documents to.
|
495
|
+
# The identifier of the Amazon Q Business index to add the documents to.
|
472
496
|
#
|
473
497
|
# @option params [String] :role_arn
|
474
498
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
@@ -608,22 +632,50 @@ module Aws::QBusiness
|
|
608
632
|
req.send_request(options)
|
609
633
|
end
|
610
634
|
|
611
|
-
# Starts or continues a non-streaming Amazon Q conversation.
|
635
|
+
# Starts or continues a non-streaming Amazon Q Business conversation.
|
612
636
|
#
|
613
637
|
# @option params [Types::ActionExecution] :action_execution
|
614
|
-
# A request from an end user to perform an Amazon Q plugin
|
638
|
+
# A request from an end user to perform an Amazon Q Business plugin
|
639
|
+
# action.
|
615
640
|
#
|
616
641
|
# @option params [required, String] :application_id
|
617
|
-
# The identifier of the Amazon Q application linked to the
|
618
|
-
# conversation.
|
642
|
+
# The identifier of the Amazon Q Business application linked to the
|
643
|
+
# Amazon Q Business conversation.
|
619
644
|
#
|
620
645
|
# @option params [Array<Types::AttachmentInput>] :attachments
|
621
646
|
# A list of files uploaded directly during chat. You can upload a
|
622
647
|
# maximum of 5 files of upto 10 MB each.
|
623
648
|
#
|
624
649
|
# @option params [Types::AttributeFilter] :attribute_filter
|
625
|
-
# Enables filtering of Amazon Q web experience responses based
|
626
|
-
# document attributes or metadata fields.
|
650
|
+
# Enables filtering of Amazon Q Business web experience responses based
|
651
|
+
# on document attributes or metadata fields.
|
652
|
+
#
|
653
|
+
# @option params [String] :chat_mode
|
654
|
+
# The chat modes available in an Amazon Q Business web experience.
|
655
|
+
#
|
656
|
+
# * `RETRIEVAL_MODE` - The default chat mode for an Amazon Q Business
|
657
|
+
# application. When this mode is enabled, Amazon Q Business generates
|
658
|
+
# responses only from data sources connected to an Amazon Q Business
|
659
|
+
# application.
|
660
|
+
#
|
661
|
+
# * `CREATOR_MODE` - By selecting this mode, users can choose to
|
662
|
+
# generate responses only from the LLM knowledge, without consulting
|
663
|
+
# connected data sources, for a chat request.
|
664
|
+
#
|
665
|
+
# * `PLUGIN_MODE` - By selecting this mode, users can choose to use
|
666
|
+
# plugins in chat.
|
667
|
+
#
|
668
|
+
# For more information, see [Admin controls and guardrails][1],
|
669
|
+
# [Plugins][2], and [Conversation settings][3].
|
670
|
+
#
|
671
|
+
#
|
672
|
+
#
|
673
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
|
674
|
+
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html
|
675
|
+
# [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
|
676
|
+
#
|
677
|
+
# @option params [Types::ChatModeConfiguration] :chat_mode_configuration
|
678
|
+
# The chat mode configuration for an Amazon Q Business application.
|
627
679
|
#
|
628
680
|
# @option params [String] :client_token
|
629
681
|
# A token that you provide to identify a chat request.
|
@@ -632,7 +684,7 @@ module Aws::QBusiness
|
|
632
684
|
# not need to pass this option.**
|
633
685
|
#
|
634
686
|
# @option params [String] :conversation_id
|
635
|
-
# The identifier of the Amazon Q conversation.
|
687
|
+
# The identifier of the Amazon Q Business conversation.
|
636
688
|
#
|
637
689
|
# @option params [String] :parent_message_id
|
638
690
|
# The identifier of the previous end user text input message in a
|
@@ -641,7 +693,7 @@ module Aws::QBusiness
|
|
641
693
|
# @option params [Array<String>] :user_groups
|
642
694
|
# The groups that a user associated with the chat input belongs to.
|
643
695
|
#
|
644
|
-
# @option params [
|
696
|
+
# @option params [String] :user_id
|
645
697
|
# The identifier of the user attached to the chat input.
|
646
698
|
#
|
647
699
|
# @option params [String] :user_message
|
@@ -755,11 +807,17 @@ module Aws::QBusiness
|
|
755
807
|
# },
|
756
808
|
# ],
|
757
809
|
# },
|
810
|
+
# chat_mode: "RETRIEVAL_MODE", # accepts RETRIEVAL_MODE, CREATOR_MODE, PLUGIN_MODE
|
811
|
+
# chat_mode_configuration: {
|
812
|
+
# plugin_configuration: {
|
813
|
+
# plugin_id: "PluginId", # required
|
814
|
+
# },
|
815
|
+
# },
|
758
816
|
# client_token: "ClientToken",
|
759
817
|
# conversation_id: "ConversationId",
|
760
818
|
# parent_message_id: "MessageId",
|
761
819
|
# user_groups: ["String"],
|
762
|
-
# user_id: "UserId",
|
820
|
+
# user_id: "UserId",
|
763
821
|
# user_message: "UserMessage",
|
764
822
|
# })
|
765
823
|
#
|
@@ -802,27 +860,32 @@ module Aws::QBusiness
|
|
802
860
|
req.send_request(options)
|
803
861
|
end
|
804
862
|
|
805
|
-
# Creates an Amazon Q application.
|
863
|
+
# Creates an Amazon Q Business application.
|
806
864
|
#
|
807
865
|
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
808
866
|
# An option to allow end users to upload files directly during chat.
|
809
867
|
#
|
810
868
|
# @option params [String] :client_token
|
811
869
|
# A token that you provide to identify the request to create your Amazon
|
812
|
-
# Q application.
|
870
|
+
# Q Business application.
|
813
871
|
#
|
814
872
|
# **A suitable default value is auto-generated.** You should normally
|
815
873
|
# not need to pass this option.**
|
816
874
|
#
|
817
875
|
# @option params [String] :description
|
818
|
-
# A description for the Amazon Q application.
|
876
|
+
# A description for the Amazon Q Business application.
|
819
877
|
#
|
820
878
|
# @option params [required, String] :display_name
|
821
|
-
# A name for the Amazon Q application.
|
879
|
+
# A name for the Amazon Q Business application.
|
822
880
|
#
|
823
881
|
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
824
882
|
# The identifier of the KMS key that is used to encrypt your data.
|
825
|
-
# Amazon Q doesn't support asymmetric keys.
|
883
|
+
# Amazon Q Business doesn't support asymmetric keys.
|
884
|
+
#
|
885
|
+
# @option params [String] :identity_center_instance_arn
|
886
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance you
|
887
|
+
# are either creating for—or connecting to—your Amazon Q Business
|
888
|
+
# application.
|
826
889
|
#
|
827
890
|
# @option params [required, String] :role_arn
|
828
891
|
# The Amazon Resource Name (ARN) of an IAM role with permissions to
|
@@ -830,8 +893,8 @@ module Aws::QBusiness
|
|
830
893
|
#
|
831
894
|
# @option params [Array<Types::Tag>] :tags
|
832
895
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
833
|
-
# application. You can also use tags to help control access to
|
834
|
-
# application. Tag keys and values can consist of Unicode letters,
|
896
|
+
# Business application. You can also use tags to help control access to
|
897
|
+
# the application. Tag keys and values can consist of Unicode letters,
|
835
898
|
# digits, white space, and any of the following symbols: \_ . : / = + -
|
836
899
|
# @.
|
837
900
|
#
|
@@ -852,6 +915,7 @@ module Aws::QBusiness
|
|
852
915
|
# encryption_configuration: {
|
853
916
|
# kms_key_id: "KmsKeyId",
|
854
917
|
# },
|
918
|
+
# identity_center_instance_arn: "InstanceArn",
|
855
919
|
# role_arn: "RoleArn", # required
|
856
920
|
# tags: [
|
857
921
|
# {
|
@@ -875,15 +939,15 @@ module Aws::QBusiness
|
|
875
939
|
req.send_request(options)
|
876
940
|
end
|
877
941
|
|
878
|
-
# Creates a data source connector for an Amazon Q application.
|
942
|
+
# Creates a data source connector for an Amazon Q Business application.
|
879
943
|
#
|
880
944
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
881
945
|
# 200 if the data source was successfully created. Otherwise, an
|
882
946
|
# exception is raised.
|
883
947
|
#
|
884
948
|
# @option params [required, String] :application_id
|
885
|
-
# The identifier of the Amazon Q application the data source
|
886
|
-
# attached to.
|
949
|
+
# The identifier of the Amazon Q Business application the data source
|
950
|
+
# will be attached to.
|
887
951
|
#
|
888
952
|
# @option params [String] :client_token
|
889
953
|
# A token you provide to identify a request to create a data source
|
@@ -905,7 +969,7 @@ module Aws::QBusiness
|
|
905
969
|
#
|
906
970
|
#
|
907
971
|
#
|
908
|
-
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
|
972
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
|
909
973
|
#
|
910
974
|
# @option params [String] :description
|
911
975
|
# A description for the data source connector.
|
@@ -932,9 +996,9 @@ module Aws::QBusiness
|
|
932
996
|
# access the data source and required resources.
|
933
997
|
#
|
934
998
|
# @option params [String] :sync_schedule
|
935
|
-
# Sets the frequency for Amazon Q to check the documents in
|
936
|
-
# source repository and update your index. If you don't set a
|
937
|
-
# Amazon Q won't periodically update the index.
|
999
|
+
# Sets the frequency for Amazon Q Business to check the documents in
|
1000
|
+
# your data source repository and update your index. If you don't set a
|
1001
|
+
# schedule, Amazon Q Business won't periodically update the index.
|
938
1002
|
#
|
939
1003
|
# Specify a `cron-` format schedule string or an empty string to
|
940
1004
|
# indicate that the index is updated on demand. You can't specify the
|
@@ -951,7 +1015,7 @@ module Aws::QBusiness
|
|
951
1015
|
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
952
1016
|
# Configuration information for an Amazon VPC (Virtual Private Cloud) to
|
953
1017
|
# connect to your data source. For more information, see [Using Amazon
|
954
|
-
# VPC with Amazon Q connectors][1].
|
1018
|
+
# VPC with Amazon Q Business connectors][1].
|
955
1019
|
#
|
956
1020
|
#
|
957
1021
|
#
|
@@ -1057,7 +1121,7 @@ module Aws::QBusiness
|
|
1057
1121
|
req.send_request(options)
|
1058
1122
|
end
|
1059
1123
|
|
1060
|
-
# Creates an Amazon Q index.
|
1124
|
+
# Creates an Amazon Q Business index.
|
1061
1125
|
#
|
1062
1126
|
# To determine if index creation has completed, check the `Status` field
|
1063
1127
|
# returned from a call to `DescribeIndex`. The `Status` field is set to
|
@@ -1072,7 +1136,7 @@ module Aws::QBusiness
|
|
1072
1136
|
# [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html
|
1073
1137
|
#
|
1074
1138
|
# @option params [required, String] :application_id
|
1075
|
-
# The identifier of the Amazon Q application using the index.
|
1139
|
+
# The identifier of the Amazon Q Business application using the index.
|
1076
1140
|
#
|
1077
1141
|
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
1078
1142
|
# The capacity units you want to provision for your index. You can add
|
@@ -1087,10 +1151,10 @@ module Aws::QBusiness
|
|
1087
1151
|
# not need to pass this option.**
|
1088
1152
|
#
|
1089
1153
|
# @option params [String] :description
|
1090
|
-
# A description for the Amazon Q index.
|
1154
|
+
# A description for the Amazon Q Business index.
|
1091
1155
|
#
|
1092
1156
|
# @option params [required, String] :display_name
|
1093
|
-
# A name for the Amazon Q index.
|
1157
|
+
# A name for the Amazon Q Business index.
|
1094
1158
|
#
|
1095
1159
|
# @option params [Array<Types::Tag>] :tags
|
1096
1160
|
# A list of key-value pairs that identify or categorize the index. You
|
@@ -1135,17 +1199,18 @@ module Aws::QBusiness
|
|
1135
1199
|
req.send_request(options)
|
1136
1200
|
end
|
1137
1201
|
|
1138
|
-
# Creates an Amazon Q plugin.
|
1202
|
+
# Creates an Amazon Q Business plugin.
|
1139
1203
|
#
|
1140
1204
|
# @option params [required, String] :application_id
|
1141
1205
|
# The identifier of the application that will contain the plugin.
|
1142
1206
|
#
|
1143
1207
|
# @option params [required, Types::PluginAuthConfiguration] :auth_configuration
|
1144
|
-
# Authentication configuration information for an Amazon Q
|
1208
|
+
# Authentication configuration information for an Amazon Q Business
|
1209
|
+
# plugin.
|
1145
1210
|
#
|
1146
1211
|
# @option params [String] :client_token
|
1147
1212
|
# A token that you provide to identify the request to create your Amazon
|
1148
|
-
# Q plugin.
|
1213
|
+
# Q Business plugin.
|
1149
1214
|
#
|
1150
1215
|
# **A suitable default value is auto-generated.** You should normally
|
1151
1216
|
# not need to pass this option.**
|
@@ -1211,27 +1276,27 @@ module Aws::QBusiness
|
|
1211
1276
|
req.send_request(options)
|
1212
1277
|
end
|
1213
1278
|
|
1214
|
-
# Adds a retriever to your Amazon Q application.
|
1279
|
+
# Adds a retriever to your Amazon Q Business application.
|
1215
1280
|
#
|
1216
1281
|
# @option params [required, String] :application_id
|
1217
|
-
# The identifier of your Amazon Q application.
|
1282
|
+
# The identifier of your Amazon Q Business application.
|
1218
1283
|
#
|
1219
1284
|
# @option params [String] :client_token
|
1220
1285
|
# A token that you provide to identify the request to create your Amazon
|
1221
|
-
# Q application retriever.
|
1286
|
+
# Q Business application retriever.
|
1222
1287
|
#
|
1223
1288
|
# **A suitable default value is auto-generated.** You should normally
|
1224
1289
|
# not need to pass this option.**
|
1225
1290
|
#
|
1226
1291
|
# @option params [required, Types::RetrieverConfiguration] :configuration
|
1227
1292
|
# Provides information on how the retriever used for your Amazon Q
|
1228
|
-
# application is configured.
|
1293
|
+
# Business application is configured.
|
1229
1294
|
#
|
1230
1295
|
# @option params [required, String] :display_name
|
1231
1296
|
# The name of your retriever.
|
1232
1297
|
#
|
1233
1298
|
# @option params [String] :role_arn
|
1234
|
-
# The ARN of an IAM role used by Amazon Q to access the basic
|
1299
|
+
# The ARN of an IAM role used by Amazon Q Business to access the basic
|
1235
1300
|
# authentication credentials stored in a Secrets Manager secret.
|
1236
1301
|
#
|
1237
1302
|
# @option params [Array<Types::Tag>] :tags
|
@@ -1316,7 +1381,7 @@ module Aws::QBusiness
|
|
1316
1381
|
#
|
1317
1382
|
# @option params [String] :client_token
|
1318
1383
|
# A token that you provide to identify the request to create your Amazon
|
1319
|
-
# Q user mapping.
|
1384
|
+
# Q Business user mapping.
|
1320
1385
|
#
|
1321
1386
|
# **A suitable default value is auto-generated.** You should normally
|
1322
1387
|
# not need to pass this option.**
|
@@ -1353,38 +1418,42 @@ module Aws::QBusiness
|
|
1353
1418
|
req.send_request(options)
|
1354
1419
|
end
|
1355
1420
|
|
1356
|
-
# Creates an Amazon Q web experience.
|
1421
|
+
# Creates an Amazon Q Business web experience.
|
1357
1422
|
#
|
1358
1423
|
# @option params [required, String] :application_id
|
1359
|
-
# The identifier of the Amazon Q web experience.
|
1424
|
+
# The identifier of the Amazon Q Business web experience.
|
1360
1425
|
#
|
1361
1426
|
# @option params [String] :client_token
|
1362
|
-
# A token you provide to identify a request to create an Amazon Q
|
1363
|
-
# experience.
|
1427
|
+
# A token you provide to identify a request to create an Amazon Q
|
1428
|
+
# Business web experience.
|
1364
1429
|
#
|
1365
1430
|
# **A suitable default value is auto-generated.** You should normally
|
1366
1431
|
# not need to pass this option.**
|
1367
1432
|
#
|
1433
|
+
# @option params [String] :role_arn
|
1434
|
+
# The Amazon Resource Name (ARN) of the service role attached to your
|
1435
|
+
# web experience.
|
1436
|
+
#
|
1368
1437
|
# @option params [String] :sample_prompts_control_mode
|
1369
1438
|
# Determines whether sample prompts are enabled in the web experience
|
1370
1439
|
# for an end user.
|
1371
1440
|
#
|
1372
1441
|
# @option params [String] :subtitle
|
1373
|
-
# A subtitle to personalize your Amazon Q web experience.
|
1442
|
+
# A subtitle to personalize your Amazon Q Business web experience.
|
1374
1443
|
#
|
1375
1444
|
# @option params [Array<Types::Tag>] :tags
|
1376
1445
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
1377
|
-
# web experience. You can also use tags to help control access
|
1378
|
-
# web experience. Tag keys and values can consist of Unicode
|
1379
|
-
# digits, white space, and any of the following symbols: \_ . :
|
1380
|
-
# @.
|
1446
|
+
# Business web experience. You can also use tags to help control access
|
1447
|
+
# to the web experience. Tag keys and values can consist of Unicode
|
1448
|
+
# letters, digits, white space, and any of the following symbols: \_ . :
|
1449
|
+
# / = + - @.
|
1381
1450
|
#
|
1382
1451
|
# @option params [String] :title
|
1383
|
-
# The title for your Amazon Q web experience.
|
1452
|
+
# The title for your Amazon Q Business web experience.
|
1384
1453
|
#
|
1385
1454
|
# @option params [String] :welcome_message
|
1386
|
-
# The customized welcome message for end users of an Amazon Q
|
1387
|
-
# experience.
|
1455
|
+
# The customized welcome message for end users of an Amazon Q Business
|
1456
|
+
# web experience.
|
1388
1457
|
#
|
1389
1458
|
# @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1390
1459
|
#
|
@@ -1396,6 +1465,7 @@ module Aws::QBusiness
|
|
1396
1465
|
# resp = client.create_web_experience({
|
1397
1466
|
# application_id: "ApplicationId", # required
|
1398
1467
|
# client_token: "ClientToken",
|
1468
|
+
# role_arn: "RoleArn",
|
1399
1469
|
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1400
1470
|
# subtitle: "WebExperienceSubtitle",
|
1401
1471
|
# tags: [
|
@@ -1422,10 +1492,10 @@ module Aws::QBusiness
|
|
1422
1492
|
req.send_request(options)
|
1423
1493
|
end
|
1424
1494
|
|
1425
|
-
# Deletes an Amazon Q application.
|
1495
|
+
# Deletes an Amazon Q Business application.
|
1426
1496
|
#
|
1427
1497
|
# @option params [required, String] :application_id
|
1428
|
-
# The identifier of the Amazon Q application.
|
1498
|
+
# The identifier of the Amazon Q Business application.
|
1429
1499
|
#
|
1430
1500
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1431
1501
|
#
|
@@ -1444,7 +1514,8 @@ module Aws::QBusiness
|
|
1444
1514
|
req.send_request(options)
|
1445
1515
|
end
|
1446
1516
|
|
1447
|
-
# Deletes chat controls configured for an existing Amazon Q
|
1517
|
+
# Deletes chat controls configured for an existing Amazon Q Business
|
1518
|
+
# application.
|
1448
1519
|
#
|
1449
1520
|
# @option params [required, String] :application_id
|
1450
1521
|
# The identifier of the application the chat controls have been
|
@@ -1467,17 +1538,17 @@ module Aws::QBusiness
|
|
1467
1538
|
req.send_request(options)
|
1468
1539
|
end
|
1469
1540
|
|
1470
|
-
# Deletes an Amazon Q web experience conversation.
|
1541
|
+
# Deletes an Amazon Q Business web experience conversation.
|
1471
1542
|
#
|
1472
1543
|
# @option params [required, String] :application_id
|
1473
|
-
# The identifier of the Amazon Q application associated with
|
1474
|
-
# conversation.
|
1544
|
+
# The identifier of the Amazon Q Business application associated with
|
1545
|
+
# the conversation.
|
1475
1546
|
#
|
1476
1547
|
# @option params [required, String] :conversation_id
|
1477
|
-
# The identifier of the Amazon Q web experience conversation
|
1478
|
-
# deleted.
|
1548
|
+
# The identifier of the Amazon Q Business web experience conversation
|
1549
|
+
# being deleted.
|
1479
1550
|
#
|
1480
|
-
# @option params [
|
1551
|
+
# @option params [String] :user_id
|
1481
1552
|
# The identifier of the user who is deleting the conversation.
|
1482
1553
|
#
|
1483
1554
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -1487,7 +1558,7 @@ module Aws::QBusiness
|
|
1487
1558
|
# resp = client.delete_conversation({
|
1488
1559
|
# application_id: "ApplicationId", # required
|
1489
1560
|
# conversation_id: "ConversationId", # required
|
1490
|
-
# user_id: "UserId",
|
1561
|
+
# user_id: "UserId",
|
1491
1562
|
# })
|
1492
1563
|
#
|
1493
1564
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteConversation AWS API Documentation
|
@@ -1499,13 +1570,13 @@ module Aws::QBusiness
|
|
1499
1570
|
req.send_request(options)
|
1500
1571
|
end
|
1501
1572
|
|
1502
|
-
# Deletes an Amazon Q data source connector. While the data
|
1503
|
-
# being deleted, the `Status` field returned by a call to the
|
1573
|
+
# Deletes an Amazon Q Business data source connector. While the data
|
1574
|
+
# source is being deleted, the `Status` field returned by a call to the
|
1504
1575
|
# `DescribeDataSource` API is set to `DELETING`.
|
1505
1576
|
#
|
1506
1577
|
# @option params [required, String] :application_id
|
1507
|
-
# The identifier of the Amazon Q application used with the data
|
1508
|
-
# connector.
|
1578
|
+
# The identifier of the Amazon Q Business application used with the data
|
1579
|
+
# source connector.
|
1509
1580
|
#
|
1510
1581
|
# @option params [required, String] :data_source_id
|
1511
1582
|
# The identifier of the data source connector that you want to delete.
|
@@ -1586,14 +1657,14 @@ module Aws::QBusiness
|
|
1586
1657
|
req.send_request(options)
|
1587
1658
|
end
|
1588
1659
|
|
1589
|
-
# Deletes an Amazon Q index.
|
1660
|
+
# Deletes an Amazon Q Business index.
|
1590
1661
|
#
|
1591
1662
|
# @option params [required, String] :application_id
|
1592
|
-
# The identifier of the Amazon Q application the Amazon Q
|
1593
|
-
# linked to.
|
1663
|
+
# The identifier of the Amazon Q Business application the Amazon Q
|
1664
|
+
# Business index is linked to.
|
1594
1665
|
#
|
1595
1666
|
# @option params [required, String] :index_id
|
1596
|
-
# The identifier of the Amazon Q index.
|
1667
|
+
# The identifier of the Amazon Q Business index.
|
1597
1668
|
#
|
1598
1669
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1599
1670
|
#
|
@@ -1613,10 +1684,11 @@ module Aws::QBusiness
|
|
1613
1684
|
req.send_request(options)
|
1614
1685
|
end
|
1615
1686
|
|
1616
|
-
# Deletes an Amazon Q plugin.
|
1687
|
+
# Deletes an Amazon Q Business plugin.
|
1617
1688
|
#
|
1618
1689
|
# @option params [required, String] :application_id
|
1619
|
-
# The identifier the application attached to the Amazon Q
|
1690
|
+
# The identifier the application attached to the Amazon Q Business
|
1691
|
+
# plugin.
|
1620
1692
|
#
|
1621
1693
|
# @option params [required, String] :plugin_id
|
1622
1694
|
# The identifier of the plugin being deleted.
|
@@ -1639,10 +1711,11 @@ module Aws::QBusiness
|
|
1639
1711
|
req.send_request(options)
|
1640
1712
|
end
|
1641
1713
|
|
1642
|
-
# Deletes the retriever used by an Amazon Q application.
|
1714
|
+
# Deletes the retriever used by an Amazon Q Business application.
|
1643
1715
|
#
|
1644
1716
|
# @option params [required, String] :application_id
|
1645
|
-
# The identifier of the Amazon Q application using the
|
1717
|
+
# The identifier of the Amazon Q Business application using the
|
1718
|
+
# retriever.
|
1646
1719
|
#
|
1647
1720
|
# @option params [required, String] :retriever_id
|
1648
1721
|
# The identifier of the retriever being deleted.
|
@@ -1692,14 +1765,14 @@ module Aws::QBusiness
|
|
1692
1765
|
req.send_request(options)
|
1693
1766
|
end
|
1694
1767
|
|
1695
|
-
# Deletes an Amazon Q web experience.
|
1768
|
+
# Deletes an Amazon Q Business web experience.
|
1696
1769
|
#
|
1697
1770
|
# @option params [required, String] :application_id
|
1698
|
-
# The identifier of the Amazon Q application linked to the
|
1699
|
-
# experience.
|
1771
|
+
# The identifier of the Amazon Q Business application linked to the
|
1772
|
+
# Amazon Q Business web experience.
|
1700
1773
|
#
|
1701
1774
|
# @option params [required, String] :web_experience_id
|
1702
|
-
# The identifier of the Amazon Q web experience being deleted.
|
1775
|
+
# The identifier of the Amazon Q Business web experience being deleted.
|
1703
1776
|
#
|
1704
1777
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1705
1778
|
#
|
@@ -1719,10 +1792,10 @@ module Aws::QBusiness
|
|
1719
1792
|
req.send_request(options)
|
1720
1793
|
end
|
1721
1794
|
|
1722
|
-
# Gets information about an existing Amazon Q application.
|
1795
|
+
# Gets information about an existing Amazon Q Business application.
|
1723
1796
|
#
|
1724
1797
|
# @option params [required, String] :application_id
|
1725
|
-
# The identifier of the Amazon Q application.
|
1798
|
+
# The identifier of the Amazon Q Business application.
|
1726
1799
|
#
|
1727
1800
|
# @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1728
1801
|
#
|
@@ -1734,6 +1807,7 @@ module Aws::QBusiness
|
|
1734
1807
|
# * {Types::GetApplicationResponse#display_name #display_name} => String
|
1735
1808
|
# * {Types::GetApplicationResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
1736
1809
|
# * {Types::GetApplicationResponse#error #error} => Types::ErrorDetail
|
1810
|
+
# * {Types::GetApplicationResponse#identity_center_application_arn #identity_center_application_arn} => String
|
1737
1811
|
# * {Types::GetApplicationResponse#role_arn #role_arn} => String
|
1738
1812
|
# * {Types::GetApplicationResponse#status #status} => String
|
1739
1813
|
# * {Types::GetApplicationResponse#updated_at #updated_at} => Time
|
@@ -1755,6 +1829,7 @@ module Aws::QBusiness
|
|
1755
1829
|
# resp.encryption_configuration.kms_key_id #=> String
|
1756
1830
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
1757
1831
|
# resp.error.error_message #=> String
|
1832
|
+
# resp.identity_center_application_arn #=> String
|
1758
1833
|
# resp.role_arn #=> String
|
1759
1834
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
1760
1835
|
# resp.updated_at #=> Time
|
@@ -1769,7 +1844,7 @@ module Aws::QBusiness
|
|
1769
1844
|
end
|
1770
1845
|
|
1771
1846
|
# Gets information about an chat controls configured for an existing
|
1772
|
-
# Amazon Q application.
|
1847
|
+
# Amazon Q Business application.
|
1773
1848
|
#
|
1774
1849
|
# @option params [required, String] :application_id
|
1775
1850
|
# The identifier of the application for which the chat controls are
|
@@ -1780,13 +1855,14 @@ module Aws::QBusiness
|
|
1780
1855
|
#
|
1781
1856
|
# @option params [String] :next_token
|
1782
1857
|
# If the `maxResults` response was incomplete because there is more data
|
1783
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
1784
|
-
# can use this pagination token to retrieve the next set
|
1785
|
-
# chat controls configured.
|
1858
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
1859
|
+
# response. You can use this pagination token to retrieve the next set
|
1860
|
+
# of Amazon Q Business chat controls configured.
|
1786
1861
|
#
|
1787
1862
|
# @return [Types::GetChatControlsConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
1863
|
#
|
1789
1864
|
# * {Types::GetChatControlsConfigurationResponse#blocked_phrases #blocked_phrases} => Types::BlockedPhrasesConfiguration
|
1865
|
+
# * {Types::GetChatControlsConfigurationResponse#creator_mode_configuration #creator_mode_configuration} => Types::AppliedCreatorModeConfiguration
|
1790
1866
|
# * {Types::GetChatControlsConfigurationResponse#next_token #next_token} => String
|
1791
1867
|
# * {Types::GetChatControlsConfigurationResponse#response_scope #response_scope} => String
|
1792
1868
|
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
@@ -1806,6 +1882,7 @@ module Aws::QBusiness
|
|
1806
1882
|
# resp.blocked_phrases.blocked_phrases #=> Array
|
1807
1883
|
# resp.blocked_phrases.blocked_phrases[0] #=> String
|
1808
1884
|
# resp.blocked_phrases.system_message_override #=> String
|
1885
|
+
# resp.creator_mode_configuration.creator_mode_control #=> String, one of "ENABLED", "DISABLED"
|
1809
1886
|
# resp.next_token #=> String
|
1810
1887
|
# resp.response_scope #=> String, one of "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED"
|
1811
1888
|
# resp.topic_configurations #=> Array
|
@@ -1837,10 +1914,11 @@ module Aws::QBusiness
|
|
1837
1914
|
req.send_request(options)
|
1838
1915
|
end
|
1839
1916
|
|
1840
|
-
# Gets information about an existing Amazon Q data source
|
1917
|
+
# Gets information about an existing Amazon Q Business data source
|
1918
|
+
# connector.
|
1841
1919
|
#
|
1842
1920
|
# @option params [required, String] :application_id
|
1843
|
-
# The identifier of the Amazon Q application.
|
1921
|
+
# The identifier of the Amazon Q Business application.
|
1844
1922
|
#
|
1845
1923
|
# @option params [required, String] :data_source_id
|
1846
1924
|
# The identifier of the data source connector.
|
@@ -1990,13 +2068,14 @@ module Aws::QBusiness
|
|
1990
2068
|
req.send_request(options)
|
1991
2069
|
end
|
1992
2070
|
|
1993
|
-
# Gets information about an existing Amazon Q index.
|
2071
|
+
# Gets information about an existing Amazon Q Business index.
|
1994
2072
|
#
|
1995
2073
|
# @option params [required, String] :application_id
|
1996
|
-
# The identifier of the Amazon Q application connected to the
|
2074
|
+
# The identifier of the Amazon Q Business application connected to the
|
2075
|
+
# index.
|
1997
2076
|
#
|
1998
2077
|
# @option params [required, String] :index_id
|
1999
|
-
# The identifier of the Amazon Q index you want information on.
|
2078
|
+
# The identifier of the Amazon Q Business index you want information on.
|
2000
2079
|
#
|
2001
2080
|
# @return [Types::GetIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2002
2081
|
#
|
@@ -2049,7 +2128,7 @@ module Aws::QBusiness
|
|
2049
2128
|
req.send_request(options)
|
2050
2129
|
end
|
2051
2130
|
|
2052
|
-
# Gets information about an existing Amazon Q plugin.
|
2131
|
+
# Gets information about an existing Amazon Q Business plugin.
|
2053
2132
|
#
|
2054
2133
|
# @option params [required, String] :application_id
|
2055
2134
|
# The identifier of the application which contains the plugin.
|
@@ -2103,10 +2182,11 @@ module Aws::QBusiness
|
|
2103
2182
|
end
|
2104
2183
|
|
2105
2184
|
# Gets information about an existing retriever used by an Amazon Q
|
2106
|
-
# application.
|
2185
|
+
# Business application.
|
2107
2186
|
#
|
2108
2187
|
# @option params [required, String] :application_id
|
2109
|
-
# The identifier of the Amazon Q application using the
|
2188
|
+
# The identifier of the Amazon Q Business application using the
|
2189
|
+
# retriever.
|
2110
2190
|
#
|
2111
2191
|
# @option params [required, String] :retriever_id
|
2112
2192
|
# The identifier of the retriever.
|
@@ -2199,14 +2279,14 @@ module Aws::QBusiness
|
|
2199
2279
|
req.send_request(options)
|
2200
2280
|
end
|
2201
2281
|
|
2202
|
-
# Gets information about an existing Amazon Q web experience.
|
2282
|
+
# Gets information about an existing Amazon Q Business web experience.
|
2203
2283
|
#
|
2204
2284
|
# @option params [required, String] :application_id
|
2205
|
-
# The identifier of the Amazon Q application linked to the web
|
2285
|
+
# The identifier of the Amazon Q Business application linked to the web
|
2206
2286
|
# experience.
|
2207
2287
|
#
|
2208
2288
|
# @option params [required, String] :web_experience_id
|
2209
|
-
# The identifier of the Amazon Q web experience.
|
2289
|
+
# The identifier of the Amazon Q Business web experience.
|
2210
2290
|
#
|
2211
2291
|
# @return [Types::GetWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2212
2292
|
#
|
@@ -2215,6 +2295,7 @@ module Aws::QBusiness
|
|
2215
2295
|
# * {Types::GetWebExperienceResponse#created_at #created_at} => Time
|
2216
2296
|
# * {Types::GetWebExperienceResponse#default_endpoint #default_endpoint} => String
|
2217
2297
|
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
2298
|
+
# * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
|
2218
2299
|
# * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
|
2219
2300
|
# * {Types::GetWebExperienceResponse#status #status} => String
|
2220
2301
|
# * {Types::GetWebExperienceResponse#subtitle #subtitle} => String
|
@@ -2242,6 +2323,7 @@ module Aws::QBusiness
|
|
2242
2323
|
# resp.default_endpoint #=> String
|
2243
2324
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2244
2325
|
# resp.error.error_message #=> String
|
2326
|
+
# resp.role_arn #=> String
|
2245
2327
|
# resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
|
2246
2328
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "PENDING_AUTH_CONFIG"
|
2247
2329
|
# resp.subtitle #=> String
|
@@ -2260,16 +2342,16 @@ module Aws::QBusiness
|
|
2260
2342
|
req.send_request(options)
|
2261
2343
|
end
|
2262
2344
|
|
2263
|
-
# Lists Amazon Q applications.
|
2345
|
+
# Lists Amazon Q Business applications.
|
2264
2346
|
#
|
2265
2347
|
# @option params [Integer] :max_results
|
2266
|
-
# The maximum number of Amazon Q applications to return.
|
2348
|
+
# The maximum number of Amazon Q Business applications to return.
|
2267
2349
|
#
|
2268
2350
|
# @option params [String] :next_token
|
2269
2351
|
# If the `maxResults` response was incomplete because there is more data
|
2270
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2271
|
-
# can use this pagination token to retrieve the next set
|
2272
|
-
# applications.
|
2352
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2353
|
+
# response. You can use this pagination token to retrieve the next set
|
2354
|
+
# of Amazon Q Business applications.
|
2273
2355
|
#
|
2274
2356
|
# @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2275
2357
|
#
|
@@ -2304,23 +2386,23 @@ module Aws::QBusiness
|
|
2304
2386
|
req.send_request(options)
|
2305
2387
|
end
|
2306
2388
|
|
2307
|
-
# Lists one or more Amazon Q conversations.
|
2389
|
+
# Lists one or more Amazon Q Business conversations.
|
2308
2390
|
#
|
2309
2391
|
# @option params [required, String] :application_id
|
2310
|
-
# The identifier of the Amazon Q application.
|
2392
|
+
# The identifier of the Amazon Q Business application.
|
2311
2393
|
#
|
2312
2394
|
# @option params [Integer] :max_results
|
2313
|
-
# The maximum number of Amazon Q conversations to return.
|
2395
|
+
# The maximum number of Amazon Q Business conversations to return.
|
2314
2396
|
#
|
2315
2397
|
# @option params [String] :next_token
|
2316
2398
|
# If the `maxResults` response was incomplete because there is more data
|
2317
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2318
|
-
# can use this pagination token to retrieve the next set
|
2319
|
-
# conversations.
|
2399
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2400
|
+
# response. You can use this pagination token to retrieve the next set
|
2401
|
+
# of Amazon Q Business conversations.
|
2320
2402
|
#
|
2321
|
-
# @option params [
|
2322
|
-
# The identifier of the user involved in the Amazon Q web
|
2323
|
-
# conversation.
|
2403
|
+
# @option params [String] :user_id
|
2404
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2405
|
+
# experience conversation.
|
2324
2406
|
#
|
2325
2407
|
# @return [Types::ListConversationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2326
2408
|
#
|
@@ -2335,7 +2417,7 @@ module Aws::QBusiness
|
|
2335
2417
|
# application_id: "ApplicationId", # required
|
2336
2418
|
# max_results: 1,
|
2337
2419
|
# next_token: "NextToken",
|
2338
|
-
# user_id: "UserId",
|
2420
|
+
# user_id: "UserId",
|
2339
2421
|
# })
|
2340
2422
|
#
|
2341
2423
|
# @example Response structure
|
@@ -2355,12 +2437,12 @@ module Aws::QBusiness
|
|
2355
2437
|
req.send_request(options)
|
2356
2438
|
end
|
2357
2439
|
|
2358
|
-
# Get information about an Amazon Q data source connector
|
2440
|
+
# Get information about an Amazon Q Business data source connector
|
2359
2441
|
# synchronization.
|
2360
2442
|
#
|
2361
2443
|
# @option params [required, String] :application_id
|
2362
|
-
# The identifier of the Amazon Q application connected to the
|
2363
|
-
# source.
|
2444
|
+
# The identifier of the Amazon Q Business application connected to the
|
2445
|
+
# data source.
|
2364
2446
|
#
|
2365
2447
|
# @option params [required, String] :data_source_id
|
2366
2448
|
# The identifier of the data source connector.
|
@@ -2369,16 +2451,17 @@ module Aws::QBusiness
|
|
2369
2451
|
# The end time of the data source connector sync.
|
2370
2452
|
#
|
2371
2453
|
# @option params [required, String] :index_id
|
2372
|
-
# The identifier of the index used with the Amazon Q data
|
2373
|
-
# connector.
|
2454
|
+
# The identifier of the index used with the Amazon Q Business data
|
2455
|
+
# source connector.
|
2374
2456
|
#
|
2375
2457
|
# @option params [Integer] :max_results
|
2376
2458
|
# The maximum number of synchronization jobs to return in the response.
|
2377
2459
|
#
|
2378
2460
|
# @option params [String] :next_token
|
2379
2461
|
# If the `maxResults` response was incpmplete because there is more data
|
2380
|
-
# to retriever, Amazon Q returns a pagination token in the
|
2381
|
-
# can use this pagination token to retrieve the next set
|
2462
|
+
# to retriever, Amazon Q Business returns a pagination token in the
|
2463
|
+
# response. You can use this pagination token to retrieve the next set
|
2464
|
+
# of responses.
|
2382
2465
|
#
|
2383
2466
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
2384
2467
|
# The start time of the data source connector sync.
|
@@ -2433,11 +2516,12 @@ module Aws::QBusiness
|
|
2433
2516
|
req.send_request(options)
|
2434
2517
|
end
|
2435
2518
|
|
2436
|
-
# Lists the Amazon Q data source connectors that you have
|
2519
|
+
# Lists the Amazon Q Business data source connectors that you have
|
2520
|
+
# created.
|
2437
2521
|
#
|
2438
2522
|
# @option params [required, String] :application_id
|
2439
|
-
# The identifier of the Amazon Q application linked to the data
|
2440
|
-
# connectors.
|
2523
|
+
# The identifier of the Amazon Q Business application linked to the data
|
2524
|
+
# source connectors.
|
2441
2525
|
#
|
2442
2526
|
# @option params [required, String] :index_id
|
2443
2527
|
# The identifier of the index used with one or more data source
|
@@ -2448,9 +2532,9 @@ module Aws::QBusiness
|
|
2448
2532
|
#
|
2449
2533
|
# @option params [String] :next_token
|
2450
2534
|
# If the `maxResults` response was incomplete because there is more data
|
2451
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2452
|
-
# can use this pagination token to retrieve the next set
|
2453
|
-
# data source connectors.
|
2535
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2536
|
+
# response. You can use this pagination token to retrieve the next set
|
2537
|
+
# of Amazon Q Business data source connectors.
|
2454
2538
|
#
|
2455
2539
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2456
2540
|
#
|
@@ -2504,8 +2588,9 @@ module Aws::QBusiness
|
|
2504
2588
|
#
|
2505
2589
|
# @option params [String] :next_token
|
2506
2590
|
# If the `maxResults` response was incomplete because there is more data
|
2507
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2508
|
-
# can use this pagination token to retrieve the next set
|
2591
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2592
|
+
# response. You can use this pagination token to retrieve the next set
|
2593
|
+
# of documents.
|
2509
2594
|
#
|
2510
2595
|
# @return [Types::ListDocumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2511
2596
|
#
|
@@ -2563,9 +2648,9 @@ module Aws::QBusiness
|
|
2563
2648
|
#
|
2564
2649
|
# @option params [String] :next_token
|
2565
2650
|
# If the previous response was incomplete (because there is more data to
|
2566
|
-
# retrieve), Amazon Q returns a pagination token in the
|
2567
|
-
# can use this pagination token to retrieve the next set
|
2568
|
-
# are mapped to users.
|
2651
|
+
# retrieve), Amazon Q Business returns a pagination token in the
|
2652
|
+
# response. You can use this pagination token to retrieve the next set
|
2653
|
+
# of groups that are mapped to users.
|
2569
2654
|
#
|
2570
2655
|
# @option params [required, Time,DateTime,Date,Integer,String] :updated_earlier_than
|
2571
2656
|
# The timestamp identifier used for the latest `PUT` or `DELETE` action
|
@@ -2604,19 +2689,20 @@ module Aws::QBusiness
|
|
2604
2689
|
req.send_request(options)
|
2605
2690
|
end
|
2606
2691
|
|
2607
|
-
# Lists the Amazon Q indices you have created.
|
2692
|
+
# Lists the Amazon Q Business indices you have created.
|
2608
2693
|
#
|
2609
2694
|
# @option params [required, String] :application_id
|
2610
|
-
# The identifier of the Amazon Q application connected to the
|
2695
|
+
# The identifier of the Amazon Q Business application connected to the
|
2696
|
+
# index.
|
2611
2697
|
#
|
2612
2698
|
# @option params [Integer] :max_results
|
2613
2699
|
# The maximum number of indices to return.
|
2614
2700
|
#
|
2615
2701
|
# @option params [String] :next_token
|
2616
2702
|
# If the maxResults response was incomplete because there is more data
|
2617
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2618
|
-
# can use this pagination token to retrieve the next set
|
2619
|
-
# indices.
|
2703
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2704
|
+
# response. You can use this pagination token to retrieve the next set
|
2705
|
+
# of Amazon Q Business indices.
|
2620
2706
|
#
|
2621
2707
|
# @return [Types::ListIndicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2622
2708
|
#
|
@@ -2652,25 +2738,26 @@ module Aws::QBusiness
|
|
2652
2738
|
req.send_request(options)
|
2653
2739
|
end
|
2654
2740
|
|
2655
|
-
# Gets a list of messages associated with an Amazon Q web
|
2741
|
+
# Gets a list of messages associated with an Amazon Q Business web
|
2742
|
+
# experience.
|
2656
2743
|
#
|
2657
2744
|
# @option params [required, String] :application_id
|
2658
|
-
# The identifier for the Amazon Q application.
|
2745
|
+
# The identifier for the Amazon Q Business application.
|
2659
2746
|
#
|
2660
2747
|
# @option params [required, String] :conversation_id
|
2661
|
-
# The identifier of the Amazon Q web experience conversation.
|
2748
|
+
# The identifier of the Amazon Q Business web experience conversation.
|
2662
2749
|
#
|
2663
2750
|
# @option params [Integer] :max_results
|
2664
2751
|
# The maximum number of messages to return.
|
2665
2752
|
#
|
2666
2753
|
# @option params [String] :next_token
|
2667
2754
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2668
|
-
# returns a next token as a pagination token to retrieve the
|
2669
|
-
# messages.
|
2755
|
+
# Business returns a next token as a pagination token to retrieve the
|
2756
|
+
# next set of messages.
|
2670
2757
|
#
|
2671
|
-
# @option params [
|
2672
|
-
# The identifier of the user involved in the Amazon Q web
|
2673
|
-
# conversation.
|
2758
|
+
# @option params [String] :user_id
|
2759
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2760
|
+
# experience conversation.
|
2674
2761
|
#
|
2675
2762
|
# @return [Types::ListMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2676
2763
|
#
|
@@ -2686,7 +2773,7 @@ module Aws::QBusiness
|
|
2686
2773
|
# conversation_id: "ConversationId", # required
|
2687
2774
|
# max_results: 1,
|
2688
2775
|
# next_token: "NextToken",
|
2689
|
-
# user_id: "UserId",
|
2776
|
+
# user_id: "UserId",
|
2690
2777
|
# })
|
2691
2778
|
#
|
2692
2779
|
# @example Response structure
|
@@ -2733,7 +2820,7 @@ module Aws::QBusiness
|
|
2733
2820
|
req.send_request(options)
|
2734
2821
|
end
|
2735
2822
|
|
2736
|
-
# Lists configured Amazon Q plugins.
|
2823
|
+
# Lists configured Amazon Q Business plugins.
|
2737
2824
|
#
|
2738
2825
|
# @option params [required, String] :application_id
|
2739
2826
|
# The identifier of the application the plugin is attached to.
|
@@ -2743,8 +2830,9 @@ module Aws::QBusiness
|
|
2743
2830
|
#
|
2744
2831
|
# @option params [String] :next_token
|
2745
2832
|
# If the `maxResults` response was incomplete because there is more data
|
2746
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2747
|
-
# can use this pagination token to retrieve the next set
|
2833
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2834
|
+
# response. You can use this pagination token to retrieve the next set
|
2835
|
+
# of plugins.
|
2748
2836
|
#
|
2749
2837
|
# @return [Types::ListPluginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2750
2838
|
#
|
@@ -2782,18 +2870,19 @@ module Aws::QBusiness
|
|
2782
2870
|
req.send_request(options)
|
2783
2871
|
end
|
2784
2872
|
|
2785
|
-
# Lists the retriever used by an Amazon Q application.
|
2873
|
+
# Lists the retriever used by an Amazon Q Business application.
|
2786
2874
|
#
|
2787
2875
|
# @option params [required, String] :application_id
|
2788
|
-
# The identifier of the Amazon Q application using the
|
2876
|
+
# The identifier of the Amazon Q Business application using the
|
2877
|
+
# retriever.
|
2789
2878
|
#
|
2790
2879
|
# @option params [Integer] :max_results
|
2791
2880
|
# The maximum number of retrievers returned.
|
2792
2881
|
#
|
2793
2882
|
# @option params [String] :next_token
|
2794
2883
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2795
|
-
# returns a next token as a pagination token to retrieve the
|
2796
|
-
# retrievers.
|
2884
|
+
# Business returns a next token as a pagination token to retrieve the
|
2885
|
+
# next set of retrievers.
|
2797
2886
|
#
|
2798
2887
|
# @return [Types::ListRetrieversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2799
2888
|
#
|
@@ -2830,11 +2919,12 @@ module Aws::QBusiness
|
|
2830
2919
|
end
|
2831
2920
|
|
2832
2921
|
# Gets a list of tags associated with a specified resource. Amazon Q
|
2833
|
-
# applications and data sources can have tags associated with
|
2922
|
+
# Business applications and data sources can have tags associated with
|
2923
|
+
# them.
|
2834
2924
|
#
|
2835
2925
|
# @option params [required, String] :resource_arn
|
2836
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application or
|
2837
|
-
# source to get a list of tags for.
|
2926
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application or
|
2927
|
+
# data source to get a list of tags for.
|
2838
2928
|
#
|
2839
2929
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2840
2930
|
#
|
@@ -2861,20 +2951,20 @@ module Aws::QBusiness
|
|
2861
2951
|
req.send_request(options)
|
2862
2952
|
end
|
2863
2953
|
|
2864
|
-
# Lists one or more Amazon Q Web Experiences.
|
2954
|
+
# Lists one or more Amazon Q Business Web Experiences.
|
2865
2955
|
#
|
2866
2956
|
# @option params [required, String] :application_id
|
2867
|
-
# The identifier of the Amazon Q application linked to the
|
2868
|
-
# experiences.
|
2957
|
+
# The identifier of the Amazon Q Business application linked to the
|
2958
|
+
# listed web experiences.
|
2869
2959
|
#
|
2870
2960
|
# @option params [Integer] :max_results
|
2871
|
-
# The maximum number of Amazon Q Web Experiences to return.
|
2961
|
+
# The maximum number of Amazon Q Business Web Experiences to return.
|
2872
2962
|
#
|
2873
2963
|
# @option params [String] :next_token
|
2874
2964
|
# If the `maxResults` response was incomplete because there is more data
|
2875
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2876
|
-
# can use this pagination token to retrieve the next set
|
2877
|
-
# conversations.
|
2965
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2966
|
+
# response. You can use this pagination token to retrieve the next set
|
2967
|
+
# of Amazon Q Business conversations.
|
2878
2968
|
#
|
2879
2969
|
# @return [Types::ListWebExperiencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2880
2970
|
#
|
@@ -2910,7 +3000,7 @@ module Aws::QBusiness
|
|
2910
3000
|
req.send_request(options)
|
2911
3001
|
end
|
2912
3002
|
|
2913
|
-
# Enables your end user to
|
3003
|
+
# Enables your end user to provide feedback on their Amazon Q Business
|
2914
3004
|
# generated chat responses.
|
2915
3005
|
#
|
2916
3006
|
# @option params [required, String] :application_id
|
@@ -2928,7 +3018,7 @@ module Aws::QBusiness
|
|
2928
3018
|
# @option params [Types::MessageUsefulnessFeedback] :message_usefulness
|
2929
3019
|
# The feedback usefulness value given by the user to the chat message.
|
2930
3020
|
#
|
2931
|
-
# @option params [
|
3021
|
+
# @option params [String] :user_id
|
2932
3022
|
# The identifier of the user giving the feedback.
|
2933
3023
|
#
|
2934
3024
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2946,7 +3036,7 @@ module Aws::QBusiness
|
|
2946
3036
|
# submitted_at: Time.now, # required
|
2947
3037
|
# usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
|
2948
3038
|
# },
|
2949
|
-
# user_id: "UserId",
|
3039
|
+
# user_id: "UserId",
|
2950
3040
|
# })
|
2951
3041
|
#
|
2952
3042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutFeedback AWS API Documentation
|
@@ -2967,7 +3057,7 @@ module Aws::QBusiness
|
|
2967
3057
|
# list of users or people who work in these teams. Only users who work
|
2968
3058
|
# in research and engineering, and therefore belong in the intellectual
|
2969
3059
|
# property group, can see top-secret company documents in their Amazon Q
|
2970
|
-
# chat results.
|
3060
|
+
# Business chat results.
|
2971
3061
|
#
|
2972
3062
|
# @option params [required, String] :application_id
|
2973
3063
|
# The identifier of the application in which the user and group mapping
|
@@ -2985,8 +3075,8 @@ module Aws::QBusiness
|
|
2985
3075
|
#
|
2986
3076
|
# @option params [required, Types::GroupMembers] :group_members
|
2987
3077
|
# A list of users or sub groups that belong to a group. This is for
|
2988
|
-
# generating Amazon Q chat results only from document a user
|
2989
|
-
# to.
|
3078
|
+
# generating Amazon Q Business chat results only from document a user
|
3079
|
+
# has access to.
|
2990
3080
|
#
|
2991
3081
|
# @option params [required, String] :group_name
|
2992
3082
|
# The list that contains your users or sub groups that belong the same
|
@@ -3043,12 +3133,12 @@ module Aws::QBusiness
|
|
3043
3133
|
end
|
3044
3134
|
|
3045
3135
|
# Starts a data source connector synchronization job. If a
|
3046
|
-
# synchronization job is already in progress, Amazon Q returns
|
3047
|
-
# `ConflictException`.
|
3136
|
+
# synchronization job is already in progress, Amazon Q Business returns
|
3137
|
+
# a `ConflictException`.
|
3048
3138
|
#
|
3049
3139
|
# @option params [required, String] :application_id
|
3050
|
-
# The identifier of Amazon Q application the data source is
|
3051
|
-
# to.
|
3140
|
+
# The identifier of Amazon Q Business application the data source is
|
3141
|
+
# connected to.
|
3052
3142
|
#
|
3053
3143
|
# @option params [required, String] :data_source_id
|
3054
3144
|
# The identifier of the data source connector.
|
@@ -3081,19 +3171,19 @@ module Aws::QBusiness
|
|
3081
3171
|
req.send_request(options)
|
3082
3172
|
end
|
3083
3173
|
|
3084
|
-
# Stops an Amazon Q data source connector synchronization job
|
3085
|
-
# progress.
|
3174
|
+
# Stops an Amazon Q Business data source connector synchronization job
|
3175
|
+
# already in progress.
|
3086
3176
|
#
|
3087
3177
|
# @option params [required, String] :application_id
|
3088
|
-
# The identifier of the Amazon Q application that the data
|
3089
|
-
# connected to.
|
3178
|
+
# The identifier of the Amazon Q Business application that the data
|
3179
|
+
# source is connected to.
|
3090
3180
|
#
|
3091
3181
|
# @option params [required, String] :data_source_id
|
3092
3182
|
# The identifier of the data source connector.
|
3093
3183
|
#
|
3094
3184
|
# @option params [required, String] :index_id
|
3095
|
-
# The identifier of the index used with the Amazon Q data
|
3096
|
-
# connector.
|
3185
|
+
# The identifier of the index used with the Amazon Q Business data
|
3186
|
+
# source connector.
|
3097
3187
|
#
|
3098
3188
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3099
3189
|
#
|
@@ -3114,18 +3204,18 @@ module Aws::QBusiness
|
|
3114
3204
|
req.send_request(options)
|
3115
3205
|
end
|
3116
3206
|
|
3117
|
-
# Adds the specified tag to the specified Amazon Q application
|
3118
|
-
# source resource. If the tag already exists, the existing value
|
3119
|
-
# replaced with the new value.
|
3207
|
+
# Adds the specified tag to the specified Amazon Q Business application
|
3208
|
+
# or data source resource. If the tag already exists, the existing value
|
3209
|
+
# is replaced with the new value.
|
3120
3210
|
#
|
3121
3211
|
# @option params [required, String] :resource_arn
|
3122
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application or
|
3123
|
-
# source to tag.
|
3212
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application or
|
3213
|
+
# data source to tag.
|
3124
3214
|
#
|
3125
3215
|
# @option params [required, Array<Types::Tag>] :tags
|
3126
|
-
# A list of tag keys to add to the Amazon Q application or data
|
3127
|
-
# If a tag already exists, the existing value is replaced with
|
3128
|
-
# value.
|
3216
|
+
# A list of tag keys to add to the Amazon Q Business application or data
|
3217
|
+
# source. If a tag already exists, the existing value is replaced with
|
3218
|
+
# the new value.
|
3129
3219
|
#
|
3130
3220
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3131
3221
|
#
|
@@ -3150,15 +3240,16 @@ module Aws::QBusiness
|
|
3150
3240
|
req.send_request(options)
|
3151
3241
|
end
|
3152
3242
|
|
3153
|
-
# Removes a tag from an Amazon Q application or a data source.
|
3243
|
+
# Removes a tag from an Amazon Q Business application or a data source.
|
3154
3244
|
#
|
3155
3245
|
# @option params [required, String] :resource_arn
|
3156
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application,
|
3157
|
-
# source to remove the tag from.
|
3246
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application,
|
3247
|
+
# or data source to remove the tag from.
|
3158
3248
|
#
|
3159
3249
|
# @option params [required, Array<String>] :tag_keys
|
3160
|
-
# A list of tag keys to remove from the Amazon Q application or
|
3161
|
-
# source. If a tag key does not exist on the resource, it is
|
3250
|
+
# A list of tag keys to remove from the Amazon Q Business application or
|
3251
|
+
# data source. If a tag key does not exist on the resource, it is
|
3252
|
+
# ignored.
|
3162
3253
|
#
|
3163
3254
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3164
3255
|
#
|
@@ -3178,24 +3269,24 @@ module Aws::QBusiness
|
|
3178
3269
|
req.send_request(options)
|
3179
3270
|
end
|
3180
3271
|
|
3181
|
-
# Updates an existing Amazon Q application.
|
3272
|
+
# Updates an existing Amazon Q Business application.
|
3182
3273
|
#
|
3183
3274
|
# @option params [required, String] :application_id
|
3184
|
-
# The identifier of the Amazon Q application.
|
3275
|
+
# The identifier of the Amazon Q Business application.
|
3185
3276
|
#
|
3186
3277
|
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
3187
3278
|
# An option to allow end users to upload files directly during chat.
|
3188
3279
|
#
|
3189
3280
|
# @option params [String] :description
|
3190
|
-
# A description for the Amazon Q application.
|
3281
|
+
# A description for the Amazon Q Business application.
|
3191
3282
|
#
|
3192
3283
|
# @option params [String] :display_name
|
3193
|
-
# A name for the Amazon Q application.
|
3284
|
+
# A name for the Amazon Q Business application.
|
3194
3285
|
#
|
3195
3286
|
# @option params [String] :role_arn
|
3196
3287
|
# An Amazon Web Services Identity and Access Management (IAM) role that
|
3197
|
-
# gives Amazon Q permission to access Amazon CloudWatch logs
|
3198
|
-
# metrics.
|
3288
|
+
# gives Amazon Q Business permission to access Amazon CloudWatch logs
|
3289
|
+
# and metrics.
|
3199
3290
|
#
|
3200
3291
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3201
3292
|
#
|
@@ -3221,7 +3312,7 @@ module Aws::QBusiness
|
|
3221
3312
|
end
|
3222
3313
|
|
3223
3314
|
# Updates an set of chat controls configured for an existing Amazon Q
|
3224
|
-
# application.
|
3315
|
+
# Business application.
|
3225
3316
|
#
|
3226
3317
|
# @option params [required, String] :application_id
|
3227
3318
|
# The identifier of the application for which the chat controls are
|
@@ -3232,11 +3323,14 @@ module Aws::QBusiness
|
|
3232
3323
|
#
|
3233
3324
|
# @option params [String] :client_token
|
3234
3325
|
# A token that you provide to identify the request to update a Amazon Q
|
3235
|
-
# application chat configuration.
|
3326
|
+
# Business application chat configuration.
|
3236
3327
|
#
|
3237
3328
|
# **A suitable default value is auto-generated.** You should normally
|
3238
3329
|
# not need to pass this option.**
|
3239
3330
|
#
|
3331
|
+
# @option params [Types::CreatorModeConfiguration] :creator_mode_configuration
|
3332
|
+
# The configuration details for `CREATOR_MODE`.
|
3333
|
+
#
|
3240
3334
|
# @option params [String] :response_scope
|
3241
3335
|
# The response scope configured for your application. This determines
|
3242
3336
|
# whether your application uses its retrieval augmented generation (RAG)
|
@@ -3262,6 +3356,9 @@ module Aws::QBusiness
|
|
3262
3356
|
# system_message_override: "SystemMessageOverride",
|
3263
3357
|
# },
|
3264
3358
|
# client_token: "ClientToken",
|
3359
|
+
# creator_mode_configuration: {
|
3360
|
+
# creator_mode_control: "ENABLED", # required, accepts ENABLED, DISABLED
|
3361
|
+
# },
|
3265
3362
|
# response_scope: "ENTERPRISE_CONTENT_ONLY", # accepts ENTERPRISE_CONTENT_ONLY, EXTENDED_KNOWLEDGE_ENABLED
|
3266
3363
|
# topic_configurations_to_create_or_update: [
|
3267
3364
|
# {
|
@@ -3340,14 +3437,15 @@ module Aws::QBusiness
|
|
3340
3437
|
req.send_request(options)
|
3341
3438
|
end
|
3342
3439
|
|
3343
|
-
# Updates an existing Amazon Q data source connector.
|
3440
|
+
# Updates an existing Amazon Q Business data source connector.
|
3344
3441
|
#
|
3345
3442
|
# @option params [required, String] :application_id
|
3346
|
-
# The identifier of the Amazon Q application the data source is
|
3347
|
-
# to.
|
3443
|
+
# The identifier of the Amazon Q Business application the data source is
|
3444
|
+
# attached to.
|
3348
3445
|
#
|
3349
3446
|
# @option params [Hash,Array,String,Numeric,Boolean] :configuration
|
3350
|
-
# Provides the configuration information for an Amazon Q data
|
3447
|
+
# Provides the configuration information for an Amazon Q Business data
|
3448
|
+
# source.
|
3351
3449
|
#
|
3352
3450
|
# Document type used to carry open content
|
3353
3451
|
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
@@ -3473,20 +3571,22 @@ module Aws::QBusiness
|
|
3473
3571
|
req.send_request(options)
|
3474
3572
|
end
|
3475
3573
|
|
3476
|
-
# Updates an Amazon Q index.
|
3574
|
+
# Updates an Amazon Q Business index.
|
3477
3575
|
#
|
3478
3576
|
# @option params [required, String] :application_id
|
3479
|
-
# The identifier of the Amazon Q application connected to the
|
3577
|
+
# The identifier of the Amazon Q Business application connected to the
|
3578
|
+
# index.
|
3480
3579
|
#
|
3481
3580
|
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
3482
3581
|
# The storage capacity units you want to provision for your Amazon Q
|
3483
|
-
# index. You can add and remove capacity to fit your usage
|
3582
|
+
# Business index. You can add and remove capacity to fit your usage
|
3583
|
+
# needs.
|
3484
3584
|
#
|
3485
3585
|
# @option params [String] :description
|
3486
|
-
# The description of the Amazon Q index.
|
3586
|
+
# The description of the Amazon Q Business index.
|
3487
3587
|
#
|
3488
3588
|
# @option params [String] :display_name
|
3489
|
-
# The name of the Amazon Q index.
|
3589
|
+
# The name of the Amazon Q Business index.
|
3490
3590
|
#
|
3491
3591
|
# @option params [Array<Types::DocumentAttributeConfiguration>] :document_attribute_configurations
|
3492
3592
|
# Configuration information for document metadata or fields. Document
|
@@ -3499,7 +3599,7 @@ module Aws::QBusiness
|
|
3499
3599
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes
|
3500
3600
|
#
|
3501
3601
|
# @option params [required, String] :index_id
|
3502
|
-
# The identifier of the Amazon Q index.
|
3602
|
+
# The identifier of the Amazon Q Business index.
|
3503
3603
|
#
|
3504
3604
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3505
3605
|
#
|
@@ -3531,7 +3631,7 @@ module Aws::QBusiness
|
|
3531
3631
|
req.send_request(options)
|
3532
3632
|
end
|
3533
3633
|
|
3534
|
-
# Updates an Amazon Q plugin.
|
3634
|
+
# Updates an Amazon Q Business plugin.
|
3535
3635
|
#
|
3536
3636
|
# @option params [required, String] :application_id
|
3537
3637
|
# The identifier of the application the plugin is attached to.
|
@@ -3582,14 +3682,14 @@ module Aws::QBusiness
|
|
3582
3682
|
req.send_request(options)
|
3583
3683
|
end
|
3584
3684
|
|
3585
|
-
# Updates the retriever used for your Amazon Q application.
|
3685
|
+
# Updates the retriever used for your Amazon Q Business application.
|
3586
3686
|
#
|
3587
3687
|
# @option params [required, String] :application_id
|
3588
|
-
# The identifier of your Amazon Q application.
|
3688
|
+
# The identifier of your Amazon Q Business application.
|
3589
3689
|
#
|
3590
3690
|
# @option params [Types::RetrieverConfiguration] :configuration
|
3591
3691
|
# Provides information on how the retriever used for your Amazon Q
|
3592
|
-
# application is configured.
|
3692
|
+
# Business application is configured.
|
3593
3693
|
#
|
3594
3694
|
# @option params [String] :display_name
|
3595
3695
|
# The name of your retriever.
|
@@ -3715,31 +3815,32 @@ module Aws::QBusiness
|
|
3715
3815
|
req.send_request(options)
|
3716
3816
|
end
|
3717
3817
|
|
3718
|
-
# Updates an Amazon Q web experience.
|
3818
|
+
# Updates an Amazon Q Business web experience.
|
3719
3819
|
#
|
3720
3820
|
# @option params [required, String] :application_id
|
3721
|
-
# The identifier of the Amazon Q application attached to the
|
3722
|
-
# experience.
|
3821
|
+
# The identifier of the Amazon Q Business application attached to the
|
3822
|
+
# web experience.
|
3723
3823
|
#
|
3724
3824
|
# @option params [Types::WebExperienceAuthConfiguration] :authentication_configuration
|
3725
|
-
# The authentication configuration of the Amazon Q web
|
3825
|
+
# The authentication configuration of the Amazon Q Business web
|
3826
|
+
# experience.
|
3726
3827
|
#
|
3727
3828
|
# @option params [String] :sample_prompts_control_mode
|
3728
3829
|
# Determines whether sample prompts are enabled in the web experience
|
3729
3830
|
# for an end user.
|
3730
3831
|
#
|
3731
3832
|
# @option params [String] :subtitle
|
3732
|
-
# The subtitle of the Amazon Q web experience.
|
3833
|
+
# The subtitle of the Amazon Q Business web experience.
|
3733
3834
|
#
|
3734
3835
|
# @option params [String] :title
|
3735
|
-
# The title of the Amazon Q web experience.
|
3836
|
+
# The title of the Amazon Q Business web experience.
|
3736
3837
|
#
|
3737
3838
|
# @option params [required, String] :web_experience_id
|
3738
|
-
# The identifier of the Amazon Q web experience.
|
3839
|
+
# The identifier of the Amazon Q Business web experience.
|
3739
3840
|
#
|
3740
3841
|
# @option params [String] :welcome_message
|
3741
|
-
# A customized welcome message for an end user in an Amazon Q
|
3742
|
-
# experience.
|
3842
|
+
# A customized welcome message for an end user in an Amazon Q Business
|
3843
|
+
# web experience.
|
3743
3844
|
#
|
3744
3845
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3745
3846
|
#
|
@@ -3784,7 +3885,7 @@ module Aws::QBusiness
|
|
3784
3885
|
params: params,
|
3785
3886
|
config: config)
|
3786
3887
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
3787
|
-
context[:gem_version] = '1.
|
3888
|
+
context[:gem_version] = '1.4.0'
|
3788
3889
|
Seahorse::Client::Request.new(handlers, context)
|
3789
3890
|
end
|
3790
3891
|
|