aws-sdk-qbusiness 1.4.0 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +606 -0
- data/lib/aws-sdk-qbusiness/client.rb +941 -834
- data/lib/aws-sdk-qbusiness/client_api.rb +422 -247
- data/lib/aws-sdk-qbusiness/endpoints.rb +13 -0
- data/lib/aws-sdk-qbusiness/errors.rb +5 -5
- data/lib/aws-sdk-qbusiness/event_streams.rb +170 -0
- data/lib/aws-sdk-qbusiness/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-qbusiness/types.rb +1961 -1312
- data/lib/aws-sdk-qbusiness/waiters.rb +15 -0
- data/lib/aws-sdk-qbusiness.rb +4 -1
- data/sig/client.rbs +444 -388
- data/sig/errors.rbs +1 -1
- data/sig/resource.rbs +3 -0
- data/sig/types.rbs +411 -245
- metadata +5 -2
@@ -34,6 +34,7 @@ require 'aws-sdk-core/plugins/defaults_mode.rb'
|
|
34
34
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
35
35
|
require 'aws-sdk-core/plugins/sign.rb'
|
36
36
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
37
|
+
require 'aws-sdk-core/plugins/event_stream_configuration.rb'
|
37
38
|
|
38
39
|
Aws::Plugins::GlobalConfiguration.add_identifier(:qbusiness)
|
39
40
|
|
@@ -85,6 +86,7 @@ module Aws::QBusiness
|
|
85
86
|
add_plugin(Aws::Plugins::RecursionDetection)
|
86
87
|
add_plugin(Aws::Plugins::Sign)
|
87
88
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
89
|
+
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
88
90
|
add_plugin(Aws::QBusiness::Plugins::Endpoints)
|
89
91
|
|
90
92
|
# @overload initialize(options)
|
@@ -225,10 +227,16 @@ module Aws::QBusiness
|
|
225
227
|
# @option options [Boolean] :endpoint_discovery (false)
|
226
228
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
227
229
|
#
|
230
|
+
# @option options [Proc] :event_stream_handler
|
231
|
+
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
232
|
+
#
|
228
233
|
# @option options [Boolean] :ignore_configured_endpoint_urls
|
229
234
|
# Setting to true disables use of endpoint URLs provided via environment
|
230
235
|
# variables and the shared configuration file.
|
231
236
|
#
|
237
|
+
# @option options [Proc] :input_event_stream_handler
|
238
|
+
# When an EventStream or Proc object is provided, it can be used for sending events for the event stream.
|
239
|
+
#
|
232
240
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
233
241
|
# The log formatter.
|
234
242
|
#
|
@@ -245,6 +253,9 @@ module Aws::QBusiness
|
|
245
253
|
# setting this value to 5 will result in a request being retried up to
|
246
254
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
247
255
|
#
|
256
|
+
# @option options [Proc] :output_event_stream_handler
|
257
|
+
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
258
|
+
#
|
248
259
|
# @option options [String] :profile ("default")
|
249
260
|
# Used when loading credentials from the shared credentials file
|
250
261
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
@@ -421,16 +432,16 @@ module Aws::QBusiness
|
|
421
432
|
# @option params [required, String] :application_id
|
422
433
|
# The identifier of the Amazon Q Business application.
|
423
434
|
#
|
424
|
-
# @option params [String] :
|
425
|
-
# The identifier of the
|
426
|
-
#
|
435
|
+
# @option params [required, String] :index_id
|
436
|
+
# The identifier of the Amazon Q Business index that contains the
|
437
|
+
# documents to delete.
|
427
438
|
#
|
428
439
|
# @option params [required, Array<Types::DeleteDocument>] :documents
|
429
440
|
# Documents deleted from the Amazon Q Business index.
|
430
441
|
#
|
431
|
-
# @option params [
|
432
|
-
# The identifier of the
|
433
|
-
#
|
442
|
+
# @option params [String] :data_source_sync_id
|
443
|
+
# The identifier of the data source sync during which the documents were
|
444
|
+
# deleted.
|
434
445
|
#
|
435
446
|
# @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
436
447
|
#
|
@@ -440,22 +451,22 @@ module Aws::QBusiness
|
|
440
451
|
#
|
441
452
|
# resp = client.batch_delete_document({
|
442
453
|
# application_id: "ApplicationId", # required
|
443
|
-
#
|
454
|
+
# index_id: "IndexId", # required
|
444
455
|
# documents: [ # required
|
445
456
|
# {
|
446
457
|
# document_id: "DocumentId", # required
|
447
458
|
# },
|
448
459
|
# ],
|
449
|
-
#
|
460
|
+
# data_source_sync_id: "ExecutionId",
|
450
461
|
# })
|
451
462
|
#
|
452
463
|
# @example Response structure
|
453
464
|
#
|
454
465
|
# resp.failed_documents #=> Array
|
455
|
-
# resp.failed_documents[0].data_source_id #=> String
|
456
|
-
# resp.failed_documents[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
457
|
-
# resp.failed_documents[0].error.error_message #=> String
|
458
466
|
# resp.failed_documents[0].id #=> String
|
467
|
+
# resp.failed_documents[0].error.error_message #=> String
|
468
|
+
# resp.failed_documents[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
469
|
+
# resp.failed_documents[0].data_source_id #=> String
|
459
470
|
#
|
460
471
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchDeleteDocument AWS API Documentation
|
461
472
|
#
|
@@ -484,20 +495,20 @@ module Aws::QBusiness
|
|
484
495
|
# @option params [required, String] :application_id
|
485
496
|
# The identifier of the Amazon Q Business application.
|
486
497
|
#
|
487
|
-
# @option params [String] :
|
488
|
-
# The identifier of the
|
489
|
-
# added.
|
498
|
+
# @option params [required, String] :index_id
|
499
|
+
# The identifier of the Amazon Q Business index to add the documents to.
|
490
500
|
#
|
491
501
|
# @option params [required, Array<Types::Document>] :documents
|
492
502
|
# One or more documents to add to the index.
|
493
503
|
#
|
494
|
-
# @option params [required, String] :index_id
|
495
|
-
# The identifier of the Amazon Q Business index to add the documents to.
|
496
|
-
#
|
497
504
|
# @option params [String] :role_arn
|
498
505
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
499
506
|
# access your S3 bucket.
|
500
507
|
#
|
508
|
+
# @option params [String] :data_source_sync_id
|
509
|
+
# The identifier of the data source sync during which the documents were
|
510
|
+
# added.
|
511
|
+
#
|
501
512
|
# @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
502
513
|
#
|
503
514
|
# * {Types::BatchPutDocumentResponse#failed_documents #failed_documents} => Array<Types::FailedDocument>
|
@@ -506,50 +517,52 @@ module Aws::QBusiness
|
|
506
517
|
#
|
507
518
|
# resp = client.batch_put_document({
|
508
519
|
# application_id: "ApplicationId", # required
|
509
|
-
#
|
520
|
+
# index_id: "IndexId", # required
|
510
521
|
# documents: [ # required
|
511
522
|
# {
|
523
|
+
# id: "DocumentId", # required
|
524
|
+
# attributes: [
|
525
|
+
# {
|
526
|
+
# name: "DocumentAttributeKey", # required
|
527
|
+
# value: { # required
|
528
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
529
|
+
# string_list_value: ["String"],
|
530
|
+
# long_value: 1,
|
531
|
+
# date_value: Time.now,
|
532
|
+
# },
|
533
|
+
# },
|
534
|
+
# ],
|
535
|
+
# content: {
|
536
|
+
# blob: "data",
|
537
|
+
# s3: {
|
538
|
+
# bucket: "S3BucketName", # required
|
539
|
+
# key: "S3ObjectKey", # required
|
540
|
+
# },
|
541
|
+
# },
|
542
|
+
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT, RTF, XML, XSLT, MS_EXCEL, CSV, JSON, MD
|
543
|
+
# title: "Title",
|
512
544
|
# access_configuration: {
|
513
545
|
# access_controls: [ # required
|
514
546
|
# {
|
515
|
-
# member_relation: "AND", # accepts AND, OR
|
516
547
|
# principals: [ # required
|
517
548
|
# {
|
518
|
-
#
|
549
|
+
# user: {
|
550
|
+
# id: "UserId",
|
519
551
|
# access: "ALLOW", # required, accepts ALLOW, DENY
|
520
552
|
# membership_type: "INDEX", # accepts INDEX, DATASOURCE
|
521
|
-
# name: "GroupName",
|
522
553
|
# },
|
523
|
-
#
|
554
|
+
# group: {
|
555
|
+
# name: "GroupName",
|
524
556
|
# access: "ALLOW", # required, accepts ALLOW, DENY
|
525
|
-
# id: "UserId",
|
526
557
|
# membership_type: "INDEX", # accepts INDEX, DATASOURCE
|
527
558
|
# },
|
528
559
|
# },
|
529
560
|
# ],
|
561
|
+
# member_relation: "AND", # accepts AND, OR
|
530
562
|
# },
|
531
563
|
# ],
|
532
564
|
# member_relation: "AND", # accepts AND, OR
|
533
565
|
# },
|
534
|
-
# attributes: [
|
535
|
-
# {
|
536
|
-
# name: "DocumentAttributeKey", # required
|
537
|
-
# value: { # required
|
538
|
-
# date_value: Time.now,
|
539
|
-
# long_value: 1,
|
540
|
-
# string_list_value: ["String"],
|
541
|
-
# string_value: "DocumentAttributeValueStringValueString",
|
542
|
-
# },
|
543
|
-
# },
|
544
|
-
# ],
|
545
|
-
# content: {
|
546
|
-
# blob: "data",
|
547
|
-
# s3: {
|
548
|
-
# bucket: "S3BucketName", # required
|
549
|
-
# key: "S3ObjectKey", # required
|
550
|
-
# },
|
551
|
-
# },
|
552
|
-
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT, RTF, XML, XSLT, MS_EXCEL, CSV, JSON, MD
|
553
566
|
# document_enrichment_configuration: {
|
554
567
|
# inline_configurations: [
|
555
568
|
# {
|
@@ -557,71 +570,69 @@ module Aws::QBusiness
|
|
557
570
|
# key: "DocumentAttributeKey", # required
|
558
571
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
559
572
|
# value: {
|
560
|
-
# date_value: Time.now,
|
561
|
-
# long_value: 1,
|
562
|
-
# string_list_value: ["String"],
|
563
573
|
# string_value: "DocumentAttributeValueStringValueString",
|
574
|
+
# string_list_value: ["String"],
|
575
|
+
# long_value: 1,
|
576
|
+
# date_value: Time.now,
|
564
577
|
# },
|
565
578
|
# },
|
566
|
-
# document_content_operator: "DELETE", # accepts DELETE
|
567
579
|
# target: {
|
568
|
-
# attribute_value_operator: "DELETE", # accepts DELETE
|
569
580
|
# key: "DocumentAttributeKey", # required
|
570
581
|
# value: {
|
571
|
-
# date_value: Time.now,
|
572
|
-
# long_value: 1,
|
573
|
-
# string_list_value: ["String"],
|
574
582
|
# string_value: "DocumentAttributeValueStringValueString",
|
583
|
+
# string_list_value: ["String"],
|
584
|
+
# long_value: 1,
|
585
|
+
# date_value: Time.now,
|
575
586
|
# },
|
587
|
+
# attribute_value_operator: "DELETE", # accepts DELETE
|
576
588
|
# },
|
589
|
+
# document_content_operator: "DELETE", # accepts DELETE
|
577
590
|
# },
|
578
591
|
# ],
|
579
|
-
#
|
592
|
+
# pre_extraction_hook_configuration: {
|
580
593
|
# invocation_condition: {
|
581
594
|
# key: "DocumentAttributeKey", # required
|
582
595
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
583
596
|
# value: {
|
584
|
-
# date_value: Time.now,
|
585
|
-
# long_value: 1,
|
586
|
-
# string_list_value: ["String"],
|
587
597
|
# string_value: "DocumentAttributeValueStringValueString",
|
598
|
+
# string_list_value: ["String"],
|
599
|
+
# long_value: 1,
|
600
|
+
# date_value: Time.now,
|
588
601
|
# },
|
589
602
|
# },
|
590
603
|
# lambda_arn: "LambdaArn",
|
591
|
-
# role_arn: "RoleArn",
|
592
604
|
# s3_bucket_name: "S3BucketName",
|
605
|
+
# role_arn: "RoleArn",
|
593
606
|
# },
|
594
|
-
#
|
607
|
+
# post_extraction_hook_configuration: {
|
595
608
|
# invocation_condition: {
|
596
609
|
# key: "DocumentAttributeKey", # required
|
597
610
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
598
611
|
# value: {
|
599
|
-
# date_value: Time.now,
|
600
|
-
# long_value: 1,
|
601
|
-
# string_list_value: ["String"],
|
602
612
|
# string_value: "DocumentAttributeValueStringValueString",
|
613
|
+
# string_list_value: ["String"],
|
614
|
+
# long_value: 1,
|
615
|
+
# date_value: Time.now,
|
603
616
|
# },
|
604
617
|
# },
|
605
618
|
# lambda_arn: "LambdaArn",
|
606
|
-
# role_arn: "RoleArn",
|
607
619
|
# s3_bucket_name: "S3BucketName",
|
620
|
+
# role_arn: "RoleArn",
|
608
621
|
# },
|
609
622
|
# },
|
610
|
-
# id: "DocumentId", # required
|
611
|
-
# title: "Title",
|
612
623
|
# },
|
613
624
|
# ],
|
614
|
-
# index_id: "IndexId", # required
|
615
625
|
# role_arn: "RoleArn",
|
626
|
+
# data_source_sync_id: "ExecutionId",
|
616
627
|
# })
|
617
628
|
#
|
618
629
|
# @example Response structure
|
619
630
|
#
|
620
631
|
# resp.failed_documents #=> Array
|
621
|
-
# resp.failed_documents[0].data_source_id #=> String
|
622
|
-
# resp.failed_documents[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
623
|
-
# resp.failed_documents[0].error.error_message #=> String
|
624
632
|
# resp.failed_documents[0].id #=> String
|
633
|
+
# resp.failed_documents[0].error.error_message #=> String
|
634
|
+
# resp.failed_documents[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
635
|
+
# resp.failed_documents[0].data_source_id #=> String
|
625
636
|
#
|
626
637
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchPutDocument AWS API Documentation
|
627
638
|
#
|
@@ -634,24 +645,44 @@ module Aws::QBusiness
|
|
634
645
|
|
635
646
|
# Starts or continues a non-streaming Amazon Q Business conversation.
|
636
647
|
#
|
637
|
-
# @option params [Types::ActionExecution] :action_execution
|
638
|
-
# A request from an end user to perform an Amazon Q Business plugin
|
639
|
-
# action.
|
640
|
-
#
|
641
648
|
# @option params [required, String] :application_id
|
642
649
|
# The identifier of the Amazon Q Business application linked to the
|
643
650
|
# Amazon Q Business conversation.
|
644
651
|
#
|
652
|
+
# @option params [String] :user_id
|
653
|
+
# The identifier of the user attached to the chat input.
|
654
|
+
#
|
655
|
+
# @option params [Array<String>] :user_groups
|
656
|
+
# The groups that a user associated with the chat input belongs to.
|
657
|
+
#
|
658
|
+
# @option params [String] :user_message
|
659
|
+
# A end user message in a conversation.
|
660
|
+
#
|
645
661
|
# @option params [Array<Types::AttachmentInput>] :attachments
|
646
662
|
# A list of files uploaded directly during chat. You can upload a
|
647
663
|
# maximum of 5 files of upto 10 MB each.
|
648
664
|
#
|
665
|
+
# @option params [Types::ActionExecution] :action_execution
|
666
|
+
# A request from an end user to perform an Amazon Q Business plugin
|
667
|
+
# action.
|
668
|
+
#
|
669
|
+
# @option params [Types::AuthChallengeResponse] :auth_challenge_response
|
670
|
+
# An authentication verification event response by a third party
|
671
|
+
# authentication server to Amazon Q Business.
|
672
|
+
#
|
673
|
+
# @option params [String] :conversation_id
|
674
|
+
# The identifier of the Amazon Q Business conversation.
|
675
|
+
#
|
676
|
+
# @option params [String] :parent_message_id
|
677
|
+
# The identifier of the previous end user text input message in a
|
678
|
+
# conversation.
|
679
|
+
#
|
649
680
|
# @option params [Types::AttributeFilter] :attribute_filter
|
650
681
|
# Enables filtering of Amazon Q Business web experience responses based
|
651
682
|
# on document attributes or metadata fields.
|
652
683
|
#
|
653
684
|
# @option params [String] :chat_mode
|
654
|
-
# The chat modes available
|
685
|
+
# The chat modes available to an Amazon Q Business end user.
|
655
686
|
#
|
656
687
|
# * `RETRIEVAL_MODE` - The default chat mode for an Amazon Q Business
|
657
688
|
# application. When this mode is enabled, Amazon Q Business generates
|
@@ -683,36 +714,32 @@ module Aws::QBusiness
|
|
683
714
|
# **A suitable default value is auto-generated.** You should normally
|
684
715
|
# not need to pass this option.**
|
685
716
|
#
|
686
|
-
# @option params [String] :conversation_id
|
687
|
-
# The identifier of the Amazon Q Business conversation.
|
688
|
-
#
|
689
|
-
# @option params [String] :parent_message_id
|
690
|
-
# The identifier of the previous end user text input message in a
|
691
|
-
# conversation.
|
692
|
-
#
|
693
|
-
# @option params [Array<String>] :user_groups
|
694
|
-
# The groups that a user associated with the chat input belongs to.
|
695
|
-
#
|
696
|
-
# @option params [String] :user_id
|
697
|
-
# The identifier of the user attached to the chat input.
|
698
|
-
#
|
699
|
-
# @option params [String] :user_message
|
700
|
-
# A end user message in a conversation.
|
701
|
-
#
|
702
717
|
# @return [Types::ChatSyncOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
703
718
|
#
|
704
|
-
# * {Types::ChatSyncOutput#action_review #action_review} => Types::ActionReview
|
705
719
|
# * {Types::ChatSyncOutput#conversation_id #conversation_id} => String
|
706
|
-
# * {Types::ChatSyncOutput#failed_attachments #failed_attachments} => Array<Types::AttachmentOutput>
|
707
|
-
# * {Types::ChatSyncOutput#source_attributions #source_attributions} => Array<Types::SourceAttribution>
|
708
720
|
# * {Types::ChatSyncOutput#system_message #system_message} => String
|
709
721
|
# * {Types::ChatSyncOutput#system_message_id #system_message_id} => String
|
710
722
|
# * {Types::ChatSyncOutput#user_message_id #user_message_id} => String
|
723
|
+
# * {Types::ChatSyncOutput#action_review #action_review} => Types::ActionReview
|
724
|
+
# * {Types::ChatSyncOutput#auth_challenge_request #auth_challenge_request} => Types::AuthChallengeRequest
|
725
|
+
# * {Types::ChatSyncOutput#source_attributions #source_attributions} => Array<Types::SourceAttribution>
|
726
|
+
# * {Types::ChatSyncOutput#failed_attachments #failed_attachments} => Array<Types::AttachmentOutput>
|
711
727
|
#
|
712
728
|
# @example Request syntax with placeholder values
|
713
729
|
#
|
714
730
|
# resp = client.chat_sync({
|
731
|
+
# application_id: "ApplicationId", # required
|
732
|
+
# user_id: "UserId",
|
733
|
+
# user_groups: ["String"],
|
734
|
+
# user_message: "UserMessage",
|
735
|
+
# attachments: [
|
736
|
+
# {
|
737
|
+
# name: "AttachmentName", # required
|
738
|
+
# data: "data", # required
|
739
|
+
# },
|
740
|
+
# ],
|
715
741
|
# action_execution: {
|
742
|
+
# plugin_id: "PluginId", # required
|
716
743
|
# payload: { # required
|
717
744
|
# "ActionPayloadFieldKey" => {
|
718
745
|
# value: { # required
|
@@ -720,92 +747,91 @@ module Aws::QBusiness
|
|
720
747
|
# },
|
721
748
|
# },
|
722
749
|
# payload_field_name_separator: "ActionPayloadFieldNameSeparator", # required
|
723
|
-
# plugin_id: "PluginId", # required
|
724
750
|
# },
|
725
|
-
#
|
726
|
-
#
|
727
|
-
#
|
728
|
-
# data: "data", # required
|
729
|
-
# name: "AttachmentName", # required
|
751
|
+
# auth_challenge_response: {
|
752
|
+
# response_map: { # required
|
753
|
+
# "AuthResponseKey" => "AuthResponseValue",
|
730
754
|
# },
|
731
|
-
#
|
755
|
+
# },
|
756
|
+
# conversation_id: "ConversationId",
|
757
|
+
# parent_message_id: "MessageId",
|
732
758
|
# attribute_filter: {
|
733
759
|
# and_all_filters: [
|
734
760
|
# {
|
735
761
|
# # recursive AttributeFilter
|
736
762
|
# },
|
737
763
|
# ],
|
738
|
-
#
|
764
|
+
# or_all_filters: [
|
765
|
+
# {
|
766
|
+
# # recursive AttributeFilter
|
767
|
+
# },
|
768
|
+
# ],
|
769
|
+
# not_filter: {
|
770
|
+
# # recursive AttributeFilter
|
771
|
+
# },
|
772
|
+
# equals_to: {
|
739
773
|
# name: "DocumentAttributeKey", # required
|
740
774
|
# value: { # required
|
741
|
-
# date_value: Time.now,
|
742
|
-
# long_value: 1,
|
743
|
-
# string_list_value: ["String"],
|
744
775
|
# string_value: "DocumentAttributeValueStringValueString",
|
776
|
+
# string_list_value: ["String"],
|
777
|
+
# long_value: 1,
|
778
|
+
# date_value: Time.now,
|
745
779
|
# },
|
746
780
|
# },
|
747
|
-
#
|
781
|
+
# contains_all: {
|
748
782
|
# name: "DocumentAttributeKey", # required
|
749
783
|
# value: { # required
|
750
|
-
# date_value: Time.now,
|
751
|
-
# long_value: 1,
|
752
|
-
# string_list_value: ["String"],
|
753
784
|
# string_value: "DocumentAttributeValueStringValueString",
|
785
|
+
# string_list_value: ["String"],
|
786
|
+
# long_value: 1,
|
787
|
+
# date_value: Time.now,
|
754
788
|
# },
|
755
789
|
# },
|
756
|
-
#
|
790
|
+
# contains_any: {
|
757
791
|
# name: "DocumentAttributeKey", # required
|
758
792
|
# value: { # required
|
759
|
-
# date_value: Time.now,
|
760
|
-
# long_value: 1,
|
761
|
-
# string_list_value: ["String"],
|
762
793
|
# string_value: "DocumentAttributeValueStringValueString",
|
794
|
+
# string_list_value: ["String"],
|
795
|
+
# long_value: 1,
|
796
|
+
# date_value: Time.now,
|
763
797
|
# },
|
764
798
|
# },
|
765
799
|
# greater_than: {
|
766
800
|
# name: "DocumentAttributeKey", # required
|
767
801
|
# value: { # required
|
768
|
-
# date_value: Time.now,
|
769
|
-
# long_value: 1,
|
770
|
-
# string_list_value: ["String"],
|
771
802
|
# string_value: "DocumentAttributeValueStringValueString",
|
803
|
+
# string_list_value: ["String"],
|
804
|
+
# long_value: 1,
|
805
|
+
# date_value: Time.now,
|
772
806
|
# },
|
773
807
|
# },
|
774
808
|
# greater_than_or_equals: {
|
775
809
|
# name: "DocumentAttributeKey", # required
|
776
810
|
# value: { # required
|
777
|
-
# date_value: Time.now,
|
778
|
-
# long_value: 1,
|
779
|
-
# string_list_value: ["String"],
|
780
811
|
# string_value: "DocumentAttributeValueStringValueString",
|
812
|
+
# string_list_value: ["String"],
|
813
|
+
# long_value: 1,
|
814
|
+
# date_value: Time.now,
|
781
815
|
# },
|
782
816
|
# },
|
783
817
|
# less_than: {
|
784
818
|
# name: "DocumentAttributeKey", # required
|
785
819
|
# value: { # required
|
786
|
-
# date_value: Time.now,
|
787
|
-
# long_value: 1,
|
788
|
-
# string_list_value: ["String"],
|
789
820
|
# string_value: "DocumentAttributeValueStringValueString",
|
821
|
+
# string_list_value: ["String"],
|
822
|
+
# long_value: 1,
|
823
|
+
# date_value: Time.now,
|
790
824
|
# },
|
791
825
|
# },
|
792
826
|
# less_than_or_equals: {
|
793
827
|
# name: "DocumentAttributeKey", # required
|
794
828
|
# value: { # required
|
795
|
-
# date_value: Time.now,
|
796
|
-
# long_value: 1,
|
797
|
-
# string_list_value: ["String"],
|
798
829
|
# string_value: "DocumentAttributeValueStringValueString",
|
830
|
+
# string_list_value: ["String"],
|
831
|
+
# long_value: 1,
|
832
|
+
# date_value: Time.now,
|
799
833
|
# },
|
800
834
|
# },
|
801
|
-
# not_filter: {
|
802
|
-
# # recursive AttributeFilter
|
803
|
-
# },
|
804
|
-
# or_all_filters: [
|
805
|
-
# {
|
806
|
-
# # recursive AttributeFilter
|
807
|
-
# },
|
808
|
-
# ],
|
809
835
|
# },
|
810
836
|
# chat_mode: "RETRIEVAL_MODE", # accepts RETRIEVAL_MODE, CREATOR_MODE, PLUGIN_MODE
|
811
837
|
# chat_mode_configuration: {
|
@@ -814,42 +840,41 @@ module Aws::QBusiness
|
|
814
840
|
# },
|
815
841
|
# },
|
816
842
|
# client_token: "ClientToken",
|
817
|
-
# conversation_id: "ConversationId",
|
818
|
-
# parent_message_id: "MessageId",
|
819
|
-
# user_groups: ["String"],
|
820
|
-
# user_id: "UserId",
|
821
|
-
# user_message: "UserMessage",
|
822
843
|
# })
|
823
844
|
#
|
824
845
|
# @example Response structure
|
825
846
|
#
|
847
|
+
# resp.conversation_id #=> String
|
848
|
+
# resp.system_message #=> String
|
849
|
+
# resp.system_message_id #=> String
|
850
|
+
# resp.user_message_id #=> String
|
851
|
+
# resp.action_review.plugin_id #=> String
|
852
|
+
# resp.action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
826
853
|
# resp.action_review.payload #=> Hash
|
827
|
-
# resp.action_review.payload["ActionPayloadFieldKey"].allowed_values #=> Array
|
828
854
|
# resp.action_review.payload["ActionPayloadFieldKey"].display_name #=> String
|
829
855
|
# resp.action_review.payload["ActionPayloadFieldKey"].display_order #=> Integer
|
830
|
-
# resp.action_review.payload["ActionPayloadFieldKey"].
|
856
|
+
# resp.action_review.payload["ActionPayloadFieldKey"].display_description #=> String
|
831
857
|
# resp.action_review.payload["ActionPayloadFieldKey"].type #=> String, one of "STRING", "NUMBER", "ARRAY", "BOOLEAN"
|
858
|
+
# resp.action_review.payload["ActionPayloadFieldKey"].allowed_values #=> Array
|
859
|
+
# resp.action_review.payload["ActionPayloadFieldKey"].allowed_format #=> String
|
860
|
+
# resp.action_review.payload["ActionPayloadFieldKey"].required #=> Boolean
|
832
861
|
# resp.action_review.payload_field_name_separator #=> String
|
833
|
-
# resp.
|
834
|
-
# resp.action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK"
|
835
|
-
# resp.conversation_id #=> String
|
836
|
-
# resp.failed_attachments #=> Array
|
837
|
-
# resp.failed_attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
838
|
-
# resp.failed_attachments[0].error.error_message #=> String
|
839
|
-
# resp.failed_attachments[0].name #=> String
|
840
|
-
# resp.failed_attachments[0].status #=> String, one of "FAILED", "SUCCEEDED"
|
862
|
+
# resp.auth_challenge_request.authorization_url #=> String
|
841
863
|
# resp.source_attributions #=> Array
|
842
|
-
# resp.source_attributions[0].
|
864
|
+
# resp.source_attributions[0].title #=> String
|
843
865
|
# resp.source_attributions[0].snippet #=> String
|
866
|
+
# resp.source_attributions[0].url #=> String
|
867
|
+
# resp.source_attributions[0].citation_number #=> Integer
|
868
|
+
# resp.source_attributions[0].updated_at #=> Time
|
844
869
|
# resp.source_attributions[0].text_message_segments #=> Array
|
845
870
|
# resp.source_attributions[0].text_message_segments[0].begin_offset #=> Integer
|
846
871
|
# resp.source_attributions[0].text_message_segments[0].end_offset #=> Integer
|
847
|
-
# resp.source_attributions[0].
|
848
|
-
# resp.
|
849
|
-
# resp.
|
850
|
-
# resp.
|
851
|
-
# resp.
|
852
|
-
# resp.
|
872
|
+
# resp.source_attributions[0].text_message_segments[0].snippet_excerpt.text #=> String
|
873
|
+
# resp.failed_attachments #=> Array
|
874
|
+
# resp.failed_attachments[0].name #=> String
|
875
|
+
# resp.failed_attachments[0].status #=> String, one of "FAILED", "SUCCEEDED"
|
876
|
+
# resp.failed_attachments[0].error.error_message #=> String
|
877
|
+
# resp.failed_attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
853
878
|
#
|
854
879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatSync AWS API Documentation
|
855
880
|
#
|
@@ -862,34 +887,37 @@ module Aws::QBusiness
|
|
862
887
|
|
863
888
|
# Creates an Amazon Q Business application.
|
864
889
|
#
|
865
|
-
#
|
866
|
-
#
|
890
|
+
# <note markdown="1"> There are new tiers for Amazon Q Business. Not all features in Amazon
|
891
|
+
# Q Business Pro are also available in Amazon Q Business Lite. For
|
892
|
+
# information on what's included in Amazon Q Business Lite and what's
|
893
|
+
# included in Amazon Q Business Pro, see [Amazon Q Business tiers][1].
|
894
|
+
# You must use the Amazon Q Business console to assign subscription
|
895
|
+
# tiers to users.
|
867
896
|
#
|
868
|
-
#
|
869
|
-
# A token that you provide to identify the request to create your Amazon
|
870
|
-
# Q Business application.
|
897
|
+
# </note>
|
871
898
|
#
|
872
|
-
# **A suitable default value is auto-generated.** You should normally
|
873
|
-
# not need to pass this option.**
|
874
899
|
#
|
875
|
-
#
|
876
|
-
#
|
900
|
+
#
|
901
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers
|
877
902
|
#
|
878
903
|
# @option params [required, String] :display_name
|
879
904
|
# A name for the Amazon Q Business application.
|
880
905
|
#
|
881
|
-
# @option params [
|
882
|
-
# The
|
883
|
-
#
|
906
|
+
# @option params [String] :role_arn
|
907
|
+
# The Amazon Resource Name (ARN) of an IAM role with permissions to
|
908
|
+
# access your Amazon CloudWatch logs and metrics.
|
884
909
|
#
|
885
910
|
# @option params [String] :identity_center_instance_arn
|
886
911
|
# The Amazon Resource Name (ARN) of the IAM Identity Center instance you
|
887
912
|
# are either creating for—or connecting to—your Amazon Q Business
|
888
913
|
# application.
|
889
914
|
#
|
890
|
-
# @option params [
|
891
|
-
#
|
892
|
-
#
|
915
|
+
# @option params [String] :description
|
916
|
+
# A description for the Amazon Q Business application.
|
917
|
+
#
|
918
|
+
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
919
|
+
# The identifier of the KMS key that is used to encrypt your data.
|
920
|
+
# Amazon Q Business doesn't support asymmetric keys.
|
893
921
|
#
|
894
922
|
# @option params [Array<Types::Tag>] :tags
|
895
923
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
@@ -898,37 +926,47 @@ module Aws::QBusiness
|
|
898
926
|
# digits, white space, and any of the following symbols: \_ . : / = + -
|
899
927
|
# @.
|
900
928
|
#
|
929
|
+
# @option params [String] :client_token
|
930
|
+
# A token that you provide to identify the request to create your Amazon
|
931
|
+
# Q Business application.
|
932
|
+
#
|
933
|
+
# **A suitable default value is auto-generated.** You should normally
|
934
|
+
# not need to pass this option.**
|
935
|
+
#
|
936
|
+
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
937
|
+
# An option to allow end users to upload files directly during chat.
|
938
|
+
#
|
901
939
|
# @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
902
940
|
#
|
903
|
-
# * {Types::CreateApplicationResponse#application_arn #application_arn} => String
|
904
941
|
# * {Types::CreateApplicationResponse#application_id #application_id} => String
|
942
|
+
# * {Types::CreateApplicationResponse#application_arn #application_arn} => String
|
905
943
|
#
|
906
944
|
# @example Request syntax with placeholder values
|
907
945
|
#
|
908
946
|
# resp = client.create_application({
|
909
|
-
# attachments_configuration: {
|
910
|
-
# attachments_control_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
911
|
-
# },
|
912
|
-
# client_token: "ClientToken",
|
913
|
-
# description: "Description",
|
914
947
|
# display_name: "ApplicationName", # required
|
948
|
+
# role_arn: "RoleArn",
|
949
|
+
# identity_center_instance_arn: "InstanceArn",
|
950
|
+
# description: "Description",
|
915
951
|
# encryption_configuration: {
|
916
952
|
# kms_key_id: "KmsKeyId",
|
917
953
|
# },
|
918
|
-
# identity_center_instance_arn: "InstanceArn",
|
919
|
-
# role_arn: "RoleArn", # required
|
920
954
|
# tags: [
|
921
955
|
# {
|
922
956
|
# key: "TagKey", # required
|
923
957
|
# value: "TagValue", # required
|
924
958
|
# },
|
925
959
|
# ],
|
960
|
+
# client_token: "ClientToken",
|
961
|
+
# attachments_configuration: {
|
962
|
+
# attachments_control_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
963
|
+
# },
|
926
964
|
# })
|
927
965
|
#
|
928
966
|
# @example Response structure
|
929
967
|
#
|
930
|
-
# resp.application_arn #=> String
|
931
968
|
# resp.application_id #=> String
|
969
|
+
# resp.application_arn #=> String
|
932
970
|
#
|
933
971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplication AWS API Documentation
|
934
972
|
#
|
@@ -949,13 +987,12 @@ module Aws::QBusiness
|
|
949
987
|
# The identifier of the Amazon Q Business application the data source
|
950
988
|
# will be attached to.
|
951
989
|
#
|
952
|
-
# @option params [String] :
|
953
|
-
#
|
954
|
-
# connector.
|
955
|
-
# client token will create only one data source connector.
|
990
|
+
# @option params [required, String] :index_id
|
991
|
+
# The identifier of the index that you want to use with the data source
|
992
|
+
# connector.
|
956
993
|
#
|
957
|
-
#
|
958
|
-
#
|
994
|
+
# @option params [required, String] :display_name
|
995
|
+
# A name for the data source connector.
|
959
996
|
#
|
960
997
|
# @option params [required, Hash,Array,String,Numeric,Boolean] :configuration
|
961
998
|
# Configuration information to connect to your data source repository.
|
@@ -971,29 +1008,24 @@ module Aws::QBusiness
|
|
971
1008
|
#
|
972
1009
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
|
973
1010
|
#
|
974
|
-
# @option params [
|
975
|
-
#
|
976
|
-
#
|
977
|
-
#
|
978
|
-
# A name for the data source connector.
|
979
|
-
#
|
980
|
-
# @option params [Types::DocumentEnrichmentConfiguration] :document_enrichment_configuration
|
981
|
-
# Provides the configuration information for altering document metadata
|
982
|
-
# and content during the document ingestion process.
|
983
|
-
#
|
984
|
-
# For more information, see [Custom document enrichment][1].
|
1011
|
+
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
1012
|
+
# Configuration information for an Amazon VPC (Virtual Private Cloud) to
|
1013
|
+
# connect to your data source. For more information, see [Using Amazon
|
1014
|
+
# VPC with Amazon Q Business connectors][1].
|
985
1015
|
#
|
986
1016
|
#
|
987
1017
|
#
|
988
|
-
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/
|
1018
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html
|
989
1019
|
#
|
990
|
-
# @option params [
|
991
|
-
#
|
992
|
-
# connector.
|
1020
|
+
# @option params [String] :description
|
1021
|
+
# A description for the data source connector.
|
993
1022
|
#
|
994
|
-
# @option params [
|
995
|
-
#
|
996
|
-
#
|
1023
|
+
# @option params [Array<Types::Tag>] :tags
|
1024
|
+
# A list of key-value pairs that identify or categorize the data source
|
1025
|
+
# connector. You can also use tags to help control access to the data
|
1026
|
+
# source connector. Tag keys and values can consist of Unicode letters,
|
1027
|
+
# digits, white space, and any of the following symbols: \_ . : / = + -
|
1028
|
+
# @.
|
997
1029
|
#
|
998
1030
|
# @option params [String] :sync_schedule
|
999
1031
|
# Sets the frequency for Amazon Q Business to check the documents in
|
@@ -1005,36 +1037,55 @@ module Aws::QBusiness
|
|
1005
1037
|
# `Schedule` parameter when the `Type` parameter is set to `CUSTOM`. If
|
1006
1038
|
# you do, you receive a `ValidationException` exception.
|
1007
1039
|
#
|
1008
|
-
# @option params [
|
1009
|
-
#
|
1010
|
-
#
|
1011
|
-
# source connector. Tag keys and values can consist of Unicode letters,
|
1012
|
-
# digits, white space, and any of the following symbols: \_ . : / = + -
|
1013
|
-
# @.
|
1040
|
+
# @option params [String] :role_arn
|
1041
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
1042
|
+
# access the data source and required resources.
|
1014
1043
|
#
|
1015
|
-
# @option params [
|
1016
|
-
#
|
1017
|
-
#
|
1018
|
-
#
|
1044
|
+
# @option params [String] :client_token
|
1045
|
+
# A token you provide to identify a request to create a data source
|
1046
|
+
# connector. Multiple calls to the `CreateDataSource` API with the same
|
1047
|
+
# client token will create only one data source connector.
|
1019
1048
|
#
|
1049
|
+
# **A suitable default value is auto-generated.** You should normally
|
1050
|
+
# not need to pass this option.**
|
1051
|
+
#
|
1052
|
+
# @option params [Types::DocumentEnrichmentConfiguration] :document_enrichment_configuration
|
1053
|
+
# Provides the configuration information for altering document metadata
|
1054
|
+
# and content during the document ingestion process.
|
1055
|
+
#
|
1056
|
+
# For more information, see [Custom document enrichment][1].
|
1020
1057
|
#
|
1021
1058
|
#
|
1022
|
-
#
|
1059
|
+
#
|
1060
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
1023
1061
|
#
|
1024
1062
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1025
1063
|
#
|
1026
|
-
# * {Types::CreateDataSourceResponse#data_source_arn #data_source_arn} => String
|
1027
1064
|
# * {Types::CreateDataSourceResponse#data_source_id #data_source_id} => String
|
1065
|
+
# * {Types::CreateDataSourceResponse#data_source_arn #data_source_arn} => String
|
1028
1066
|
#
|
1029
1067
|
# @example Request syntax with placeholder values
|
1030
1068
|
#
|
1031
1069
|
# resp = client.create_data_source({
|
1032
1070
|
# application_id: "ApplicationId", # required
|
1033
|
-
#
|
1071
|
+
# index_id: "IndexId", # required
|
1072
|
+
# display_name: "DataSourceName", # required
|
1034
1073
|
# configuration: { # required
|
1035
1074
|
# },
|
1075
|
+
# vpc_configuration: {
|
1076
|
+
# subnet_ids: ["SubnetId"], # required
|
1077
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
1078
|
+
# },
|
1036
1079
|
# description: "Description",
|
1037
|
-
#
|
1080
|
+
# tags: [
|
1081
|
+
# {
|
1082
|
+
# key: "TagKey", # required
|
1083
|
+
# value: "TagValue", # required
|
1084
|
+
# },
|
1085
|
+
# ],
|
1086
|
+
# sync_schedule: "SyncSchedule",
|
1087
|
+
# role_arn: "RoleArn",
|
1088
|
+
# client_token: "ClientToken",
|
1038
1089
|
# document_enrichment_configuration: {
|
1039
1090
|
# inline_configurations: [
|
1040
1091
|
# {
|
@@ -1042,75 +1093,62 @@ module Aws::QBusiness
|
|
1042
1093
|
# key: "DocumentAttributeKey", # required
|
1043
1094
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
1044
1095
|
# value: {
|
1045
|
-
# date_value: Time.now,
|
1046
|
-
# long_value: 1,
|
1047
|
-
# string_list_value: ["String"],
|
1048
1096
|
# string_value: "DocumentAttributeValueStringValueString",
|
1097
|
+
# string_list_value: ["String"],
|
1098
|
+
# long_value: 1,
|
1099
|
+
# date_value: Time.now,
|
1049
1100
|
# },
|
1050
1101
|
# },
|
1051
|
-
# document_content_operator: "DELETE", # accepts DELETE
|
1052
1102
|
# target: {
|
1053
|
-
# attribute_value_operator: "DELETE", # accepts DELETE
|
1054
1103
|
# key: "DocumentAttributeKey", # required
|
1055
1104
|
# value: {
|
1056
|
-
# date_value: Time.now,
|
1057
|
-
# long_value: 1,
|
1058
|
-
# string_list_value: ["String"],
|
1059
1105
|
# string_value: "DocumentAttributeValueStringValueString",
|
1106
|
+
# string_list_value: ["String"],
|
1107
|
+
# long_value: 1,
|
1108
|
+
# date_value: Time.now,
|
1060
1109
|
# },
|
1110
|
+
# attribute_value_operator: "DELETE", # accepts DELETE
|
1061
1111
|
# },
|
1112
|
+
# document_content_operator: "DELETE", # accepts DELETE
|
1062
1113
|
# },
|
1063
1114
|
# ],
|
1064
|
-
#
|
1115
|
+
# pre_extraction_hook_configuration: {
|
1065
1116
|
# invocation_condition: {
|
1066
1117
|
# key: "DocumentAttributeKey", # required
|
1067
1118
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
1068
1119
|
# value: {
|
1069
|
-
# date_value: Time.now,
|
1070
|
-
# long_value: 1,
|
1071
|
-
# string_list_value: ["String"],
|
1072
1120
|
# string_value: "DocumentAttributeValueStringValueString",
|
1121
|
+
# string_list_value: ["String"],
|
1122
|
+
# long_value: 1,
|
1123
|
+
# date_value: Time.now,
|
1073
1124
|
# },
|
1074
1125
|
# },
|
1075
1126
|
# lambda_arn: "LambdaArn",
|
1076
|
-
# role_arn: "RoleArn",
|
1077
1127
|
# s3_bucket_name: "S3BucketName",
|
1128
|
+
# role_arn: "RoleArn",
|
1078
1129
|
# },
|
1079
|
-
#
|
1130
|
+
# post_extraction_hook_configuration: {
|
1080
1131
|
# invocation_condition: {
|
1081
1132
|
# key: "DocumentAttributeKey", # required
|
1082
1133
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
1083
1134
|
# value: {
|
1084
|
-
# date_value: Time.now,
|
1085
|
-
# long_value: 1,
|
1086
|
-
# string_list_value: ["String"],
|
1087
1135
|
# string_value: "DocumentAttributeValueStringValueString",
|
1136
|
+
# string_list_value: ["String"],
|
1137
|
+
# long_value: 1,
|
1138
|
+
# date_value: Time.now,
|
1088
1139
|
# },
|
1089
1140
|
# },
|
1090
1141
|
# lambda_arn: "LambdaArn",
|
1091
|
-
# role_arn: "RoleArn",
|
1092
1142
|
# s3_bucket_name: "S3BucketName",
|
1143
|
+
# role_arn: "RoleArn",
|
1093
1144
|
# },
|
1094
1145
|
# },
|
1095
|
-
# index_id: "IndexId", # required
|
1096
|
-
# role_arn: "RoleArn",
|
1097
|
-
# sync_schedule: "SyncSchedule",
|
1098
|
-
# tags: [
|
1099
|
-
# {
|
1100
|
-
# key: "TagKey", # required
|
1101
|
-
# value: "TagValue", # required
|
1102
|
-
# },
|
1103
|
-
# ],
|
1104
|
-
# vpc_configuration: {
|
1105
|
-
# security_group_ids: ["SecurityGroupId"], # required
|
1106
|
-
# subnet_ids: ["SubnetId"], # required
|
1107
|
-
# },
|
1108
1146
|
# })
|
1109
1147
|
#
|
1110
1148
|
# @example Response structure
|
1111
1149
|
#
|
1112
|
-
# resp.data_source_arn #=> String
|
1113
1150
|
# resp.data_source_id #=> String
|
1151
|
+
# resp.data_source_arn #=> String
|
1114
1152
|
#
|
1115
1153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateDataSource AWS API Documentation
|
1116
1154
|
#
|
@@ -1138,57 +1176,67 @@ module Aws::QBusiness
|
|
1138
1176
|
# @option params [required, String] :application_id
|
1139
1177
|
# The identifier of the Amazon Q Business application using the index.
|
1140
1178
|
#
|
1141
|
-
# @option params [
|
1142
|
-
#
|
1143
|
-
# and remove capacity to fit your usage needs.
|
1179
|
+
# @option params [required, String] :display_name
|
1180
|
+
# A name for the Amazon Q Business index.
|
1144
1181
|
#
|
1145
|
-
# @option params [String] :
|
1146
|
-
#
|
1147
|
-
#
|
1148
|
-
#
|
1182
|
+
# @option params [String] :type
|
1183
|
+
# The index type that's suitable for your needs. For more information
|
1184
|
+
# on what's included in each type of index or index tier, see [Amazon Q
|
1185
|
+
# Business tiers][1].
|
1149
1186
|
#
|
1150
|
-
#
|
1151
|
-
#
|
1187
|
+
#
|
1188
|
+
#
|
1189
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers
|
1152
1190
|
#
|
1153
1191
|
# @option params [String] :description
|
1154
1192
|
# A description for the Amazon Q Business index.
|
1155
1193
|
#
|
1156
|
-
# @option params [required, String] :display_name
|
1157
|
-
# A name for the Amazon Q Business index.
|
1158
|
-
#
|
1159
1194
|
# @option params [Array<Types::Tag>] :tags
|
1160
1195
|
# A list of key-value pairs that identify or categorize the index. You
|
1161
1196
|
# can also use tags to help control access to the index. Tag keys and
|
1162
1197
|
# values can consist of Unicode letters, digits, white space, and any of
|
1163
1198
|
# the following symbols: \_ . : / = + - @.
|
1164
1199
|
#
|
1200
|
+
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
1201
|
+
# The capacity units you want to provision for your index. You can add
|
1202
|
+
# and remove capacity to fit your usage needs.
|
1203
|
+
#
|
1204
|
+
# @option params [String] :client_token
|
1205
|
+
# A token that you provide to identify the request to create an index.
|
1206
|
+
# Multiple calls to the `CreateIndex` API with the same client token
|
1207
|
+
# will create only one index.
|
1208
|
+
#
|
1209
|
+
# **A suitable default value is auto-generated.** You should normally
|
1210
|
+
# not need to pass this option.**
|
1211
|
+
#
|
1165
1212
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1166
1213
|
#
|
1167
|
-
# * {Types::CreateIndexResponse#index_arn #index_arn} => String
|
1168
1214
|
# * {Types::CreateIndexResponse#index_id #index_id} => String
|
1215
|
+
# * {Types::CreateIndexResponse#index_arn #index_arn} => String
|
1169
1216
|
#
|
1170
1217
|
# @example Request syntax with placeholder values
|
1171
1218
|
#
|
1172
1219
|
# resp = client.create_index({
|
1173
1220
|
# application_id: "ApplicationId", # required
|
1174
|
-
# capacity_configuration: {
|
1175
|
-
# units: 1,
|
1176
|
-
# },
|
1177
|
-
# client_token: "ClientToken",
|
1178
|
-
# description: "Description",
|
1179
1221
|
# display_name: "IndexName", # required
|
1222
|
+
# type: "ENTERPRISE", # accepts ENTERPRISE, STARTER
|
1223
|
+
# description: "Description",
|
1180
1224
|
# tags: [
|
1181
1225
|
# {
|
1182
1226
|
# key: "TagKey", # required
|
1183
1227
|
# value: "TagValue", # required
|
1184
1228
|
# },
|
1185
1229
|
# ],
|
1230
|
+
# capacity_configuration: {
|
1231
|
+
# units: 1,
|
1232
|
+
# },
|
1233
|
+
# client_token: "ClientToken",
|
1186
1234
|
# })
|
1187
1235
|
#
|
1188
1236
|
# @example Response structure
|
1189
1237
|
#
|
1190
|
-
# resp.index_arn #=> String
|
1191
1238
|
# resp.index_id #=> String
|
1239
|
+
# resp.index_arn #=> String
|
1192
1240
|
#
|
1193
1241
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateIndex AWS API Documentation
|
1194
1242
|
#
|
@@ -1204,23 +1252,22 @@ module Aws::QBusiness
|
|
1204
1252
|
# @option params [required, String] :application_id
|
1205
1253
|
# The identifier of the application that will contain the plugin.
|
1206
1254
|
#
|
1255
|
+
# @option params [required, String] :display_name
|
1256
|
+
# A the name for your plugin.
|
1257
|
+
#
|
1258
|
+
# @option params [required, String] :type
|
1259
|
+
# The type of plugin you want to create.
|
1260
|
+
#
|
1207
1261
|
# @option params [required, Types::PluginAuthConfiguration] :auth_configuration
|
1208
1262
|
# Authentication configuration information for an Amazon Q Business
|
1209
1263
|
# plugin.
|
1210
1264
|
#
|
1211
|
-
# @option params [String] :
|
1212
|
-
# A token that you provide to identify the request to create your Amazon
|
1213
|
-
# Q Business plugin.
|
1214
|
-
#
|
1215
|
-
# **A suitable default value is auto-generated.** You should normally
|
1216
|
-
# not need to pass this option.**
|
1217
|
-
#
|
1218
|
-
# @option params [required, String] :display_name
|
1219
|
-
# A the name for your plugin.
|
1220
|
-
#
|
1221
|
-
# @option params [required, String] :server_url
|
1265
|
+
# @option params [String] :server_url
|
1222
1266
|
# The source URL used for plugin configuration.
|
1223
1267
|
#
|
1268
|
+
# @option params [Types::CustomPluginConfiguration] :custom_plugin_configuration
|
1269
|
+
# Contains configuration for a custom plugin.
|
1270
|
+
#
|
1224
1271
|
# @option params [Array<Types::Tag>] :tags
|
1225
1272
|
# A list of key-value pairs that identify or categorize the data source
|
1226
1273
|
# connector. You can also use tags to help control access to the data
|
@@ -1228,44 +1275,63 @@ module Aws::QBusiness
|
|
1228
1275
|
# digits, white space, and any of the following symbols: \_ . : / = + -
|
1229
1276
|
# @.
|
1230
1277
|
#
|
1231
|
-
# @option params [
|
1232
|
-
#
|
1278
|
+
# @option params [String] :client_token
|
1279
|
+
# A token that you provide to identify the request to create your Amazon
|
1280
|
+
# Q Business plugin.
|
1281
|
+
#
|
1282
|
+
# **A suitable default value is auto-generated.** You should normally
|
1283
|
+
# not need to pass this option.**
|
1233
1284
|
#
|
1234
1285
|
# @return [Types::CreatePluginResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1235
1286
|
#
|
1236
|
-
# * {Types::CreatePluginResponse#plugin_arn #plugin_arn} => String
|
1237
1287
|
# * {Types::CreatePluginResponse#plugin_id #plugin_id} => String
|
1288
|
+
# * {Types::CreatePluginResponse#plugin_arn #plugin_arn} => String
|
1289
|
+
# * {Types::CreatePluginResponse#build_status #build_status} => String
|
1238
1290
|
#
|
1239
1291
|
# @example Request syntax with placeholder values
|
1240
1292
|
#
|
1241
1293
|
# resp = client.create_plugin({
|
1242
1294
|
# application_id: "ApplicationId", # required
|
1295
|
+
# display_name: "PluginName", # required
|
1296
|
+
# type: "SERVICE_NOW", # required, accepts SERVICE_NOW, SALESFORCE, JIRA, ZENDESK, CUSTOM
|
1243
1297
|
# auth_configuration: { # required
|
1244
1298
|
# basic_auth_configuration: {
|
1245
|
-
# role_arn: "RoleArn", # required
|
1246
1299
|
# secret_arn: "SecretArn", # required
|
1300
|
+
# role_arn: "RoleArn", # required
|
1247
1301
|
# },
|
1248
1302
|
# o_auth_2_client_credential_configuration: {
|
1249
|
-
# role_arn: "RoleArn", # required
|
1250
1303
|
# secret_arn: "SecretArn", # required
|
1304
|
+
# role_arn: "RoleArn", # required
|
1305
|
+
# },
|
1306
|
+
# no_auth_configuration: {
|
1307
|
+
# },
|
1308
|
+
# },
|
1309
|
+
# server_url: "Url",
|
1310
|
+
# custom_plugin_configuration: {
|
1311
|
+
# description: "PluginDescription", # required
|
1312
|
+
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
1313
|
+
# api_schema: { # required
|
1314
|
+
# payload: "Payload",
|
1315
|
+
# s3: {
|
1316
|
+
# bucket: "S3BucketName", # required
|
1317
|
+
# key: "S3ObjectKey", # required
|
1318
|
+
# },
|
1251
1319
|
# },
|
1252
1320
|
# },
|
1253
|
-
# client_token: "ClientToken",
|
1254
|
-
# display_name: "PluginName", # required
|
1255
|
-
# server_url: "Url", # required
|
1256
1321
|
# tags: [
|
1257
1322
|
# {
|
1258
1323
|
# key: "TagKey", # required
|
1259
1324
|
# value: "TagValue", # required
|
1260
1325
|
# },
|
1261
1326
|
# ],
|
1262
|
-
#
|
1327
|
+
# client_token: "ClientToken",
|
1263
1328
|
# })
|
1264
1329
|
#
|
1265
1330
|
# @example Response structure
|
1266
1331
|
#
|
1267
|
-
# resp.plugin_arn #=> String
|
1268
1332
|
# resp.plugin_id #=> String
|
1333
|
+
# resp.plugin_arn #=> String
|
1334
|
+
# resp.build_status #=> String, one of "READY", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1269
1335
|
#
|
1270
1336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreatePlugin AWS API Documentation
|
1271
1337
|
#
|
@@ -1281,87 +1347,87 @@ module Aws::QBusiness
|
|
1281
1347
|
# @option params [required, String] :application_id
|
1282
1348
|
# The identifier of your Amazon Q Business application.
|
1283
1349
|
#
|
1284
|
-
# @option params [String] :
|
1285
|
-
#
|
1286
|
-
# Q Business application retriever.
|
1350
|
+
# @option params [required, String] :type
|
1351
|
+
# The type of retriever you are using.
|
1287
1352
|
#
|
1288
|
-
#
|
1289
|
-
#
|
1353
|
+
# @option params [required, String] :display_name
|
1354
|
+
# The name of your retriever.
|
1290
1355
|
#
|
1291
1356
|
# @option params [required, Types::RetrieverConfiguration] :configuration
|
1292
1357
|
# Provides information on how the retriever used for your Amazon Q
|
1293
1358
|
# Business application is configured.
|
1294
1359
|
#
|
1295
|
-
# @option params [required, String] :display_name
|
1296
|
-
# The name of your retriever.
|
1297
|
-
#
|
1298
1360
|
# @option params [String] :role_arn
|
1299
1361
|
# The ARN of an IAM role used by Amazon Q Business to access the basic
|
1300
1362
|
# authentication credentials stored in a Secrets Manager secret.
|
1301
1363
|
#
|
1364
|
+
# @option params [String] :client_token
|
1365
|
+
# A token that you provide to identify the request to create your Amazon
|
1366
|
+
# Q Business application retriever.
|
1367
|
+
#
|
1368
|
+
# **A suitable default value is auto-generated.** You should normally
|
1369
|
+
# not need to pass this option.**
|
1370
|
+
#
|
1302
1371
|
# @option params [Array<Types::Tag>] :tags
|
1303
1372
|
# A list of key-value pairs that identify or categorize the retriever.
|
1304
1373
|
# You can also use tags to help control access to the retriever. Tag
|
1305
1374
|
# keys and values can consist of Unicode letters, digits, white space,
|
1306
1375
|
# and any of the following symbols: \_ . : / = + - @.
|
1307
1376
|
#
|
1308
|
-
# @option params [required, String] :type
|
1309
|
-
# The type of retriever you are using.
|
1310
|
-
#
|
1311
1377
|
# @return [Types::CreateRetrieverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
1378
|
#
|
1313
|
-
# * {Types::CreateRetrieverResponse#retriever_arn #retriever_arn} => String
|
1314
1379
|
# * {Types::CreateRetrieverResponse#retriever_id #retriever_id} => String
|
1380
|
+
# * {Types::CreateRetrieverResponse#retriever_arn #retriever_arn} => String
|
1315
1381
|
#
|
1316
1382
|
# @example Request syntax with placeholder values
|
1317
1383
|
#
|
1318
1384
|
# resp = client.create_retriever({
|
1319
1385
|
# application_id: "ApplicationId", # required
|
1320
|
-
#
|
1386
|
+
# type: "NATIVE_INDEX", # required, accepts NATIVE_INDEX, KENDRA_INDEX
|
1387
|
+
# display_name: "RetrieverName", # required
|
1321
1388
|
# configuration: { # required
|
1322
|
-
# kendra_index_configuration: {
|
1323
|
-
# index_id: "KendraIndexId", # required
|
1324
|
-
# },
|
1325
1389
|
# native_index_configuration: {
|
1390
|
+
# index_id: "IndexId", # required
|
1326
1391
|
# boosting_override: {
|
1327
1392
|
# "DocumentAttributeKey" => {
|
1328
|
-
# date_configuration: {
|
1329
|
-
# boosting_duration_in_seconds: 1,
|
1330
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1331
|
-
# },
|
1332
1393
|
# number_configuration: {
|
1333
1394
|
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1334
1395
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
1335
1396
|
# },
|
1336
1397
|
# string_configuration: {
|
1398
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1337
1399
|
# attribute_value_boosting: {
|
1338
1400
|
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
1339
1401
|
# },
|
1402
|
+
# },
|
1403
|
+
# date_configuration: {
|
1340
1404
|
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1405
|
+
# boosting_duration_in_seconds: 1,
|
1341
1406
|
# },
|
1342
1407
|
# string_list_configuration: {
|
1343
1408
|
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1344
1409
|
# },
|
1345
1410
|
# },
|
1346
1411
|
# },
|
1347
|
-
#
|
1412
|
+
# },
|
1413
|
+
# kendra_index_configuration: {
|
1414
|
+
# index_id: "KendraIndexId", # required
|
1348
1415
|
# },
|
1349
1416
|
# },
|
1350
|
-
# display_name: "RetrieverName", # required
|
1351
1417
|
# role_arn: "RoleArn",
|
1418
|
+
# client_token: "ClientToken",
|
1352
1419
|
# tags: [
|
1353
1420
|
# {
|
1354
1421
|
# key: "TagKey", # required
|
1355
1422
|
# value: "TagValue", # required
|
1356
1423
|
# },
|
1357
1424
|
# ],
|
1358
|
-
# type: "NATIVE_INDEX", # required, accepts NATIVE_INDEX, KENDRA_INDEX
|
1359
1425
|
# })
|
1360
1426
|
#
|
1361
1427
|
# @example Response structure
|
1362
1428
|
#
|
1363
|
-
# resp.retriever_arn #=> String
|
1364
1429
|
# resp.retriever_id #=> String
|
1430
|
+
# resp.retriever_arn #=> String
|
1365
1431
|
#
|
1366
1432
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateRetriever AWS API Documentation
|
1367
1433
|
#
|
@@ -1379,6 +1445,12 @@ module Aws::QBusiness
|
|
1379
1445
|
# The identifier of the application for which the user mapping will be
|
1380
1446
|
# created.
|
1381
1447
|
#
|
1448
|
+
# @option params [required, String] :user_id
|
1449
|
+
# The user emails attached to a user mapping.
|
1450
|
+
#
|
1451
|
+
# @option params [Array<Types::UserAlias>] :user_aliases
|
1452
|
+
# The list of user aliases in the mapping.
|
1453
|
+
#
|
1382
1454
|
# @option params [String] :client_token
|
1383
1455
|
# A token that you provide to identify the request to create your Amazon
|
1384
1456
|
# Q Business user mapping.
|
@@ -1386,27 +1458,21 @@ module Aws::QBusiness
|
|
1386
1458
|
# **A suitable default value is auto-generated.** You should normally
|
1387
1459
|
# not need to pass this option.**
|
1388
1460
|
#
|
1389
|
-
# @option params [Array<Types::UserAlias>] :user_aliases
|
1390
|
-
# The list of user aliases in the mapping.
|
1391
|
-
#
|
1392
|
-
# @option params [required, String] :user_id
|
1393
|
-
# The user emails attached to a user mapping.
|
1394
|
-
#
|
1395
1461
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1396
1462
|
#
|
1397
1463
|
# @example Request syntax with placeholder values
|
1398
1464
|
#
|
1399
1465
|
# resp = client.create_user({
|
1400
1466
|
# application_id: "ApplicationId", # required
|
1401
|
-
#
|
1467
|
+
# user_id: "String", # required
|
1402
1468
|
# user_aliases: [
|
1403
1469
|
# {
|
1404
|
-
# data_source_id: "DataSourceId",
|
1405
1470
|
# index_id: "IndexId",
|
1471
|
+
# data_source_id: "DataSourceId",
|
1406
1472
|
# user_id: "String", # required
|
1407
1473
|
# },
|
1408
1474
|
# ],
|
1409
|
-
#
|
1475
|
+
# client_token: "ClientToken",
|
1410
1476
|
# })
|
1411
1477
|
#
|
1412
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateUser AWS API Documentation
|
@@ -1423,23 +1489,23 @@ module Aws::QBusiness
|
|
1423
1489
|
# @option params [required, String] :application_id
|
1424
1490
|
# The identifier of the Amazon Q Business web experience.
|
1425
1491
|
#
|
1426
|
-
# @option params [String] :
|
1427
|
-
#
|
1428
|
-
# Business web experience.
|
1429
|
-
#
|
1430
|
-
# **A suitable default value is auto-generated.** You should normally
|
1431
|
-
# not need to pass this option.**
|
1492
|
+
# @option params [String] :title
|
1493
|
+
# The title for your Amazon Q Business web experience.
|
1432
1494
|
#
|
1433
|
-
# @option params [String] :
|
1434
|
-
#
|
1495
|
+
# @option params [String] :subtitle
|
1496
|
+
# A subtitle to personalize your Amazon Q Business web experience.
|
1497
|
+
#
|
1498
|
+
# @option params [String] :welcome_message
|
1499
|
+
# The customized welcome message for end users of an Amazon Q Business
|
1435
1500
|
# web experience.
|
1436
1501
|
#
|
1437
1502
|
# @option params [String] :sample_prompts_control_mode
|
1438
1503
|
# Determines whether sample prompts are enabled in the web experience
|
1439
1504
|
# for an end user.
|
1440
1505
|
#
|
1441
|
-
# @option params [String] :
|
1442
|
-
#
|
1506
|
+
# @option params [String] :role_arn
|
1507
|
+
# The Amazon Resource Name (ARN) of the service role attached to your
|
1508
|
+
# web experience.
|
1443
1509
|
#
|
1444
1510
|
# @option params [Array<Types::Tag>] :tags
|
1445
1511
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
@@ -1448,40 +1514,40 @@ module Aws::QBusiness
|
|
1448
1514
|
# letters, digits, white space, and any of the following symbols: \_ . :
|
1449
1515
|
# / = + - @.
|
1450
1516
|
#
|
1451
|
-
# @option params [String] :
|
1452
|
-
#
|
1517
|
+
# @option params [String] :client_token
|
1518
|
+
# A token you provide to identify a request to create an Amazon Q
|
1519
|
+
# Business web experience.
|
1453
1520
|
#
|
1454
|
-
#
|
1455
|
-
#
|
1456
|
-
# web experience.
|
1521
|
+
# **A suitable default value is auto-generated.** You should normally
|
1522
|
+
# not need to pass this option.**
|
1457
1523
|
#
|
1458
1524
|
# @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1459
1525
|
#
|
1460
|
-
# * {Types::CreateWebExperienceResponse#web_experience_arn #web_experience_arn} => String
|
1461
1526
|
# * {Types::CreateWebExperienceResponse#web_experience_id #web_experience_id} => String
|
1527
|
+
# * {Types::CreateWebExperienceResponse#web_experience_arn #web_experience_arn} => String
|
1462
1528
|
#
|
1463
1529
|
# @example Request syntax with placeholder values
|
1464
1530
|
#
|
1465
1531
|
# resp = client.create_web_experience({
|
1466
1532
|
# application_id: "ApplicationId", # required
|
1467
|
-
#
|
1468
|
-
# role_arn: "RoleArn",
|
1469
|
-
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1533
|
+
# title: "WebExperienceTitle",
|
1470
1534
|
# subtitle: "WebExperienceSubtitle",
|
1535
|
+
# welcome_message: "WebExperienceWelcomeMessage",
|
1536
|
+
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1537
|
+
# role_arn: "RoleArn",
|
1471
1538
|
# tags: [
|
1472
1539
|
# {
|
1473
1540
|
# key: "TagKey", # required
|
1474
1541
|
# value: "TagValue", # required
|
1475
1542
|
# },
|
1476
1543
|
# ],
|
1477
|
-
#
|
1478
|
-
# welcome_message: "WebExperienceWelcomeMessage",
|
1544
|
+
# client_token: "ClientToken",
|
1479
1545
|
# })
|
1480
1546
|
#
|
1481
1547
|
# @example Response structure
|
1482
1548
|
#
|
1483
|
-
# resp.web_experience_arn #=> String
|
1484
1549
|
# resp.web_experience_id #=> String
|
1550
|
+
# resp.web_experience_arn #=> String
|
1485
1551
|
#
|
1486
1552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperience AWS API Documentation
|
1487
1553
|
#
|
@@ -1540,14 +1606,14 @@ module Aws::QBusiness
|
|
1540
1606
|
|
1541
1607
|
# Deletes an Amazon Q Business web experience conversation.
|
1542
1608
|
#
|
1543
|
-
# @option params [required, String] :application_id
|
1544
|
-
# The identifier of the Amazon Q Business application associated with
|
1545
|
-
# the conversation.
|
1546
|
-
#
|
1547
1609
|
# @option params [required, String] :conversation_id
|
1548
1610
|
# The identifier of the Amazon Q Business web experience conversation
|
1549
1611
|
# being deleted.
|
1550
1612
|
#
|
1613
|
+
# @option params [required, String] :application_id
|
1614
|
+
# The identifier of the Amazon Q Business application associated with
|
1615
|
+
# the conversation.
|
1616
|
+
#
|
1551
1617
|
# @option params [String] :user_id
|
1552
1618
|
# The identifier of the user who is deleting the conversation.
|
1553
1619
|
#
|
@@ -1556,8 +1622,8 @@ module Aws::QBusiness
|
|
1556
1622
|
# @example Request syntax with placeholder values
|
1557
1623
|
#
|
1558
1624
|
# resp = client.delete_conversation({
|
1559
|
-
# application_id: "ApplicationId", # required
|
1560
1625
|
# conversation_id: "ConversationId", # required
|
1626
|
+
# application_id: "ApplicationId", # required
|
1561
1627
|
# user_id: "UserId",
|
1562
1628
|
# })
|
1563
1629
|
#
|
@@ -1578,20 +1644,20 @@ module Aws::QBusiness
|
|
1578
1644
|
# The identifier of the Amazon Q Business application used with the data
|
1579
1645
|
# source connector.
|
1580
1646
|
#
|
1581
|
-
# @option params [required, String] :data_source_id
|
1582
|
-
# The identifier of the data source connector that you want to delete.
|
1583
|
-
#
|
1584
1647
|
# @option params [required, String] :index_id
|
1585
1648
|
# The identifier of the index used with the data source connector.
|
1586
1649
|
#
|
1650
|
+
# @option params [required, String] :data_source_id
|
1651
|
+
# The identifier of the data source connector that you want to delete.
|
1652
|
+
#
|
1587
1653
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1588
1654
|
#
|
1589
1655
|
# @example Request syntax with placeholder values
|
1590
1656
|
#
|
1591
1657
|
# resp = client.delete_data_source({
|
1592
1658
|
# application_id: "ApplicationId", # required
|
1593
|
-
# data_source_id: "DataSourceId", # required
|
1594
1659
|
# index_id: "IndexId", # required
|
1660
|
+
# data_source_id: "DataSourceId", # required
|
1595
1661
|
# })
|
1596
1662
|
#
|
1597
1663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteDataSource AWS API Documentation
|
@@ -1619,6 +1685,12 @@ module Aws::QBusiness
|
|
1619
1685
|
# @option params [required, String] :application_id
|
1620
1686
|
# The identifier of the application in which the group mapping belongs.
|
1621
1687
|
#
|
1688
|
+
# @option params [required, String] :index_id
|
1689
|
+
# The identifier of the index you want to delete the group from.
|
1690
|
+
#
|
1691
|
+
# @option params [required, String] :group_name
|
1692
|
+
# The name of the group you want to delete.
|
1693
|
+
#
|
1622
1694
|
# @option params [String] :data_source_id
|
1623
1695
|
# The identifier of the data source linked to the group
|
1624
1696
|
#
|
@@ -1631,21 +1703,15 @@ module Aws::QBusiness
|
|
1631
1703
|
# access customer-related documents stored in Salesforce. Only "Sales
|
1632
1704
|
# and Marketing" should access documents in the Salesforce data source.
|
1633
1705
|
#
|
1634
|
-
# @option params [required, String] :group_name
|
1635
|
-
# The name of the group you want to delete.
|
1636
|
-
#
|
1637
|
-
# @option params [required, String] :index_id
|
1638
|
-
# The identifier of the index you want to delete the group from.
|
1639
|
-
#
|
1640
1706
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1641
1707
|
#
|
1642
1708
|
# @example Request syntax with placeholder values
|
1643
1709
|
#
|
1644
1710
|
# resp = client.delete_group({
|
1645
1711
|
# application_id: "ApplicationId", # required
|
1646
|
-
# data_source_id: "DataSourceId",
|
1647
|
-
# group_name: "GroupName", # required
|
1648
1712
|
# index_id: "IndexId", # required
|
1713
|
+
# group_name: "GroupName", # required
|
1714
|
+
# data_source_id: "DataSourceId",
|
1649
1715
|
# })
|
1650
1716
|
#
|
1651
1717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteGroup AWS API Documentation
|
@@ -1799,18 +1865,18 @@ module Aws::QBusiness
|
|
1799
1865
|
#
|
1800
1866
|
# @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1801
1867
|
#
|
1802
|
-
# * {Types::GetApplicationResponse#application_arn #application_arn} => String
|
1803
|
-
# * {Types::GetApplicationResponse#application_id #application_id} => String
|
1804
|
-
# * {Types::GetApplicationResponse#attachments_configuration #attachments_configuration} => Types::AppliedAttachmentsConfiguration
|
1805
|
-
# * {Types::GetApplicationResponse#created_at #created_at} => Time
|
1806
|
-
# * {Types::GetApplicationResponse#description #description} => String
|
1807
1868
|
# * {Types::GetApplicationResponse#display_name #display_name} => String
|
1808
|
-
# * {Types::GetApplicationResponse#
|
1809
|
-
# * {Types::GetApplicationResponse#
|
1869
|
+
# * {Types::GetApplicationResponse#application_id #application_id} => String
|
1870
|
+
# * {Types::GetApplicationResponse#application_arn #application_arn} => String
|
1810
1871
|
# * {Types::GetApplicationResponse#identity_center_application_arn #identity_center_application_arn} => String
|
1811
1872
|
# * {Types::GetApplicationResponse#role_arn #role_arn} => String
|
1812
1873
|
# * {Types::GetApplicationResponse#status #status} => String
|
1874
|
+
# * {Types::GetApplicationResponse#description #description} => String
|
1875
|
+
# * {Types::GetApplicationResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
1876
|
+
# * {Types::GetApplicationResponse#created_at #created_at} => Time
|
1813
1877
|
# * {Types::GetApplicationResponse#updated_at #updated_at} => Time
|
1878
|
+
# * {Types::GetApplicationResponse#error #error} => Types::ErrorDetail
|
1879
|
+
# * {Types::GetApplicationResponse#attachments_configuration #attachments_configuration} => Types::AppliedAttachmentsConfiguration
|
1814
1880
|
#
|
1815
1881
|
# @example Request syntax with placeholder values
|
1816
1882
|
#
|
@@ -1820,19 +1886,19 @@ module Aws::QBusiness
|
|
1820
1886
|
#
|
1821
1887
|
# @example Response structure
|
1822
1888
|
#
|
1823
|
-
# resp.application_arn #=> String
|
1824
|
-
# resp.application_id #=> String
|
1825
|
-
# resp.attachments_configuration.attachments_control_mode #=> String, one of "ENABLED", "DISABLED"
|
1826
|
-
# resp.created_at #=> Time
|
1827
|
-
# resp.description #=> String
|
1828
1889
|
# resp.display_name #=> String
|
1829
|
-
# resp.
|
1830
|
-
# resp.
|
1831
|
-
# resp.error.error_message #=> String
|
1890
|
+
# resp.application_id #=> String
|
1891
|
+
# resp.application_arn #=> String
|
1832
1892
|
# resp.identity_center_application_arn #=> String
|
1833
1893
|
# resp.role_arn #=> String
|
1834
1894
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
1895
|
+
# resp.description #=> String
|
1896
|
+
# resp.encryption_configuration.kms_key_id #=> String
|
1897
|
+
# resp.created_at #=> Time
|
1835
1898
|
# resp.updated_at #=> Time
|
1899
|
+
# resp.error.error_message #=> String
|
1900
|
+
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
1901
|
+
# resp.attachments_configuration.attachments_control_mode #=> String, one of "ENABLED", "DISABLED"
|
1836
1902
|
#
|
1837
1903
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplication AWS API Documentation
|
1838
1904
|
#
|
@@ -1861,11 +1927,11 @@ module Aws::QBusiness
|
|
1861
1927
|
#
|
1862
1928
|
# @return [Types::GetChatControlsConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1863
1929
|
#
|
1930
|
+
# * {Types::GetChatControlsConfigurationResponse#response_scope #response_scope} => String
|
1864
1931
|
# * {Types::GetChatControlsConfigurationResponse#blocked_phrases #blocked_phrases} => Types::BlockedPhrasesConfiguration
|
1932
|
+
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
1865
1933
|
# * {Types::GetChatControlsConfigurationResponse#creator_mode_configuration #creator_mode_configuration} => Types::AppliedCreatorModeConfiguration
|
1866
1934
|
# * {Types::GetChatControlsConfigurationResponse#next_token #next_token} => String
|
1867
|
-
# * {Types::GetChatControlsConfigurationResponse#response_scope #response_scope} => String
|
1868
|
-
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
1869
1935
|
#
|
1870
1936
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1871
1937
|
#
|
@@ -1879,31 +1945,31 @@ module Aws::QBusiness
|
|
1879
1945
|
#
|
1880
1946
|
# @example Response structure
|
1881
1947
|
#
|
1948
|
+
# resp.response_scope #=> String, one of "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED"
|
1882
1949
|
# resp.blocked_phrases.blocked_phrases #=> Array
|
1883
1950
|
# resp.blocked_phrases.blocked_phrases[0] #=> String
|
1884
1951
|
# resp.blocked_phrases.system_message_override #=> String
|
1885
|
-
# resp.creator_mode_configuration.creator_mode_control #=> String, one of "ENABLED", "DISABLED"
|
1886
|
-
# resp.next_token #=> String
|
1887
|
-
# resp.response_scope #=> String, one of "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED"
|
1888
1952
|
# resp.topic_configurations #=> Array
|
1953
|
+
# resp.topic_configurations[0].name #=> String
|
1889
1954
|
# resp.topic_configurations[0].description #=> String
|
1890
1955
|
# resp.topic_configurations[0].example_chat_messages #=> Array
|
1891
1956
|
# resp.topic_configurations[0].example_chat_messages[0] #=> String
|
1892
|
-
# resp.topic_configurations[0].name #=> String
|
1893
1957
|
# resp.topic_configurations[0].rules #=> Array
|
1894
|
-
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_groups #=> Array
|
1895
|
-
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_groups[0] #=> String
|
1896
|
-
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_ids #=> Array
|
1897
|
-
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_ids[0] #=> String
|
1898
|
-
# resp.topic_configurations[0].rules[0].included_users_and_groups.user_groups #=> Array
|
1899
|
-
# resp.topic_configurations[0].rules[0].included_users_and_groups.user_groups[0] #=> String
|
1900
1958
|
# resp.topic_configurations[0].rules[0].included_users_and_groups.user_ids #=> Array
|
1901
1959
|
# resp.topic_configurations[0].rules[0].included_users_and_groups.user_ids[0] #=> String
|
1960
|
+
# resp.topic_configurations[0].rules[0].included_users_and_groups.user_groups #=> Array
|
1961
|
+
# resp.topic_configurations[0].rules[0].included_users_and_groups.user_groups[0] #=> String
|
1962
|
+
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_ids #=> Array
|
1963
|
+
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_ids[0] #=> String
|
1964
|
+
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_groups #=> Array
|
1965
|
+
# resp.topic_configurations[0].rules[0].excluded_users_and_groups.user_groups[0] #=> String
|
1966
|
+
# resp.topic_configurations[0].rules[0].rule_type #=> String, one of "CONTENT_BLOCKER_RULE", "CONTENT_RETRIEVAL_RULE"
|
1902
1967
|
# resp.topic_configurations[0].rules[0].rule_configuration.content_blocker_rule.system_message_override #=> String
|
1903
1968
|
# resp.topic_configurations[0].rules[0].rule_configuration.content_retrieval_rule.eligible_data_sources #=> Array
|
1904
|
-
# resp.topic_configurations[0].rules[0].rule_configuration.content_retrieval_rule.eligible_data_sources[0].data_source_id #=> String
|
1905
1969
|
# resp.topic_configurations[0].rules[0].rule_configuration.content_retrieval_rule.eligible_data_sources[0].index_id #=> String
|
1906
|
-
# resp.topic_configurations[0].rules[0].
|
1970
|
+
# resp.topic_configurations[0].rules[0].rule_configuration.content_retrieval_rule.eligible_data_sources[0].data_source_id #=> String
|
1971
|
+
# resp.creator_mode_configuration.creator_mode_control #=> String, one of "ENABLED", "DISABLED"
|
1972
|
+
# resp.next_token #=> String
|
1907
1973
|
#
|
1908
1974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfiguration AWS API Documentation
|
1909
1975
|
#
|
@@ -1920,95 +1986,95 @@ module Aws::QBusiness
|
|
1920
1986
|
# @option params [required, String] :application_id
|
1921
1987
|
# The identifier of the Amazon Q Business application.
|
1922
1988
|
#
|
1923
|
-
# @option params [required, String] :data_source_id
|
1924
|
-
# The identifier of the data source connector.
|
1925
|
-
#
|
1926
1989
|
# @option params [required, String] :index_id
|
1927
1990
|
# The identfier of the index used with the data source connector.
|
1928
1991
|
#
|
1992
|
+
# @option params [required, String] :data_source_id
|
1993
|
+
# The identifier of the data source connector.
|
1994
|
+
#
|
1929
1995
|
# @return [Types::GetDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1930
1996
|
#
|
1931
1997
|
# * {Types::GetDataSourceResponse#application_id #application_id} => String
|
1998
|
+
# * {Types::GetDataSourceResponse#index_id #index_id} => String
|
1999
|
+
# * {Types::GetDataSourceResponse#data_source_id #data_source_id} => String
|
2000
|
+
# * {Types::GetDataSourceResponse#data_source_arn #data_source_arn} => String
|
2001
|
+
# * {Types::GetDataSourceResponse#display_name #display_name} => String
|
2002
|
+
# * {Types::GetDataSourceResponse#type #type} => String
|
1932
2003
|
# * {Types::GetDataSourceResponse#configuration #configuration} => Hash,Array,String,Numeric,Boolean
|
2004
|
+
# * {Types::GetDataSourceResponse#vpc_configuration #vpc_configuration} => Types::DataSourceVpcConfiguration
|
1933
2005
|
# * {Types::GetDataSourceResponse#created_at #created_at} => Time
|
1934
|
-
# * {Types::GetDataSourceResponse#
|
1935
|
-
# * {Types::GetDataSourceResponse#data_source_id #data_source_id} => String
|
2006
|
+
# * {Types::GetDataSourceResponse#updated_at #updated_at} => Time
|
1936
2007
|
# * {Types::GetDataSourceResponse#description #description} => String
|
1937
|
-
# * {Types::GetDataSourceResponse#display_name #display_name} => String
|
1938
|
-
# * {Types::GetDataSourceResponse#document_enrichment_configuration #document_enrichment_configuration} => Types::DocumentEnrichmentConfiguration
|
1939
|
-
# * {Types::GetDataSourceResponse#error #error} => Types::ErrorDetail
|
1940
|
-
# * {Types::GetDataSourceResponse#index_id #index_id} => String
|
1941
|
-
# * {Types::GetDataSourceResponse#role_arn #role_arn} => String
|
1942
2008
|
# * {Types::GetDataSourceResponse#status #status} => String
|
1943
2009
|
# * {Types::GetDataSourceResponse#sync_schedule #sync_schedule} => String
|
1944
|
-
# * {Types::GetDataSourceResponse#
|
1945
|
-
# * {Types::GetDataSourceResponse#
|
1946
|
-
# * {Types::GetDataSourceResponse#
|
2010
|
+
# * {Types::GetDataSourceResponse#role_arn #role_arn} => String
|
2011
|
+
# * {Types::GetDataSourceResponse#error #error} => Types::ErrorDetail
|
2012
|
+
# * {Types::GetDataSourceResponse#document_enrichment_configuration #document_enrichment_configuration} => Types::DocumentEnrichmentConfiguration
|
1947
2013
|
#
|
1948
2014
|
# @example Request syntax with placeholder values
|
1949
2015
|
#
|
1950
2016
|
# resp = client.get_data_source({
|
1951
2017
|
# application_id: "ApplicationId", # required
|
1952
|
-
# data_source_id: "DataSourceId", # required
|
1953
2018
|
# index_id: "IndexId", # required
|
2019
|
+
# data_source_id: "DataSourceId", # required
|
1954
2020
|
# })
|
1955
2021
|
#
|
1956
2022
|
# @example Response structure
|
1957
2023
|
#
|
1958
2024
|
# resp.application_id #=> String
|
1959
|
-
# resp.
|
1960
|
-
# resp.data_source_arn #=> String
|
2025
|
+
# resp.index_id #=> String
|
1961
2026
|
# resp.data_source_id #=> String
|
1962
|
-
# resp.
|
2027
|
+
# resp.data_source_arn #=> String
|
1963
2028
|
# resp.display_name #=> String
|
2029
|
+
# resp.type #=> String
|
2030
|
+
# resp.vpc_configuration.subnet_ids #=> Array
|
2031
|
+
# resp.vpc_configuration.subnet_ids[0] #=> String
|
2032
|
+
# resp.vpc_configuration.security_group_ids #=> Array
|
2033
|
+
# resp.vpc_configuration.security_group_ids[0] #=> String
|
2034
|
+
# resp.created_at #=> Time
|
2035
|
+
# resp.updated_at #=> Time
|
2036
|
+
# resp.description #=> String
|
2037
|
+
# resp.status #=> String, one of "PENDING_CREATION", "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2038
|
+
# resp.sync_schedule #=> String
|
2039
|
+
# resp.role_arn #=> String
|
2040
|
+
# resp.error.error_message #=> String
|
2041
|
+
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
1964
2042
|
# resp.document_enrichment_configuration.inline_configurations #=> Array
|
1965
2043
|
# resp.document_enrichment_configuration.inline_configurations[0].condition.key #=> String
|
1966
2044
|
# resp.document_enrichment_configuration.inline_configurations[0].condition.operator #=> String, one of "GREATER_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN", "LESS_THAN_OR_EQUALS", "EQUALS", "NOT_EQUALS", "CONTAINS", "NOT_CONTAINS", "EXISTS", "NOT_EXISTS", "BEGINS_WITH"
|
1967
|
-
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.
|
1968
|
-
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.long_value #=> Integer
|
2045
|
+
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.string_value #=> String
|
1969
2046
|
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.string_list_value #=> Array
|
1970
2047
|
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.string_list_value[0] #=> String
|
1971
|
-
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.
|
1972
|
-
# resp.document_enrichment_configuration.inline_configurations[0].
|
1973
|
-
# resp.document_enrichment_configuration.inline_configurations[0].target.attribute_value_operator #=> String, one of "DELETE"
|
2048
|
+
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.long_value #=> Integer
|
2049
|
+
# resp.document_enrichment_configuration.inline_configurations[0].condition.value.date_value #=> Time
|
1974
2050
|
# resp.document_enrichment_configuration.inline_configurations[0].target.key #=> String
|
1975
|
-
# resp.document_enrichment_configuration.inline_configurations[0].target.value.
|
1976
|
-
# resp.document_enrichment_configuration.inline_configurations[0].target.value.long_value #=> Integer
|
2051
|
+
# resp.document_enrichment_configuration.inline_configurations[0].target.value.string_value #=> String
|
1977
2052
|
# resp.document_enrichment_configuration.inline_configurations[0].target.value.string_list_value #=> Array
|
1978
2053
|
# resp.document_enrichment_configuration.inline_configurations[0].target.value.string_list_value[0] #=> String
|
1979
|
-
# resp.document_enrichment_configuration.inline_configurations[0].target.value.
|
1980
|
-
# resp.document_enrichment_configuration.
|
1981
|
-
# resp.document_enrichment_configuration.
|
1982
|
-
# resp.document_enrichment_configuration.
|
1983
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.long_value #=> Integer
|
1984
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_list_value #=> Array
|
1985
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_list_value[0] #=> String
|
1986
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_value #=> String
|
1987
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn #=> String
|
1988
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.role_arn #=> String
|
1989
|
-
# resp.document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket_name #=> String
|
2054
|
+
# resp.document_enrichment_configuration.inline_configurations[0].target.value.long_value #=> Integer
|
2055
|
+
# resp.document_enrichment_configuration.inline_configurations[0].target.value.date_value #=> Time
|
2056
|
+
# resp.document_enrichment_configuration.inline_configurations[0].target.attribute_value_operator #=> String, one of "DELETE"
|
2057
|
+
# resp.document_enrichment_configuration.inline_configurations[0].document_content_operator #=> String, one of "DELETE"
|
1990
2058
|
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.key #=> String
|
1991
2059
|
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.operator #=> String, one of "GREATER_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN", "LESS_THAN_OR_EQUALS", "EQUALS", "NOT_EQUALS", "CONTAINS", "NOT_CONTAINS", "EXISTS", "NOT_EXISTS", "BEGINS_WITH"
|
1992
|
-
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.
|
1993
|
-
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.long_value #=> Integer
|
2060
|
+
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.string_value #=> String
|
1994
2061
|
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.string_list_value #=> Array
|
1995
2062
|
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.string_list_value[0] #=> String
|
1996
|
-
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.
|
2063
|
+
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.long_value #=> Integer
|
2064
|
+
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.date_value #=> Time
|
1997
2065
|
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.lambda_arn #=> String
|
1998
|
-
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.role_arn #=> String
|
1999
2066
|
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.s3_bucket_name #=> String
|
2000
|
-
# resp.
|
2001
|
-
# resp.
|
2002
|
-
# resp.
|
2003
|
-
# resp.
|
2004
|
-
# resp.
|
2005
|
-
# resp.
|
2006
|
-
# resp.
|
2007
|
-
# resp.
|
2008
|
-
# resp.
|
2009
|
-
# resp.
|
2010
|
-
# resp.
|
2011
|
-
# resp.vpc_configuration.subnet_ids[0] #=> String
|
2067
|
+
# resp.document_enrichment_configuration.pre_extraction_hook_configuration.role_arn #=> String
|
2068
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.key #=> String
|
2069
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.operator #=> String, one of "GREATER_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN", "LESS_THAN_OR_EQUALS", "EQUALS", "NOT_EQUALS", "CONTAINS", "NOT_CONTAINS", "EXISTS", "NOT_EXISTS", "BEGINS_WITH"
|
2070
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_value #=> String
|
2071
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_list_value #=> Array
|
2072
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_list_value[0] #=> String
|
2073
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.long_value #=> Integer
|
2074
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.date_value #=> Time
|
2075
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn #=> String
|
2076
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket_name #=> String
|
2077
|
+
# resp.document_enrichment_configuration.post_extraction_hook_configuration.role_arn #=> String
|
2012
2078
|
#
|
2013
2079
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSource AWS API Documentation
|
2014
2080
|
#
|
@@ -2024,14 +2090,14 @@ module Aws::QBusiness
|
|
2024
2090
|
# @option params [required, String] :application_id
|
2025
2091
|
# The identifier of the application id the group is attached to.
|
2026
2092
|
#
|
2027
|
-
# @option params [String] :
|
2028
|
-
# The identifier of the
|
2093
|
+
# @option params [required, String] :index_id
|
2094
|
+
# The identifier of the index the group is attached to.
|
2029
2095
|
#
|
2030
2096
|
# @option params [required, String] :group_name
|
2031
2097
|
# The name of the group.
|
2032
2098
|
#
|
2033
|
-
# @option params [
|
2034
|
-
# The identifier of the
|
2099
|
+
# @option params [String] :data_source_id
|
2100
|
+
# The identifier of the data source the group is attached to.
|
2035
2101
|
#
|
2036
2102
|
# @return [Types::GetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2037
2103
|
#
|
@@ -2042,22 +2108,22 @@ module Aws::QBusiness
|
|
2042
2108
|
#
|
2043
2109
|
# resp = client.get_group({
|
2044
2110
|
# application_id: "ApplicationId", # required
|
2045
|
-
# data_source_id: "DataSourceId",
|
2046
|
-
# group_name: "GroupName", # required
|
2047
2111
|
# index_id: "IndexId", # required
|
2112
|
+
# group_name: "GroupName", # required
|
2113
|
+
# data_source_id: "DataSourceId",
|
2048
2114
|
# })
|
2049
2115
|
#
|
2050
2116
|
# @example Response structure
|
2051
2117
|
#
|
2052
|
-
# resp.status.error_detail.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2053
|
-
# resp.status.error_detail.error_message #=> String
|
2054
|
-
# resp.status.last_updated_at #=> Time
|
2055
2118
|
# resp.status.status #=> String, one of "FAILED", "SUCCEEDED", "PROCESSING", "DELETING", "DELETED"
|
2119
|
+
# resp.status.last_updated_at #=> Time
|
2120
|
+
# resp.status.error_detail.error_message #=> String
|
2121
|
+
# resp.status.error_detail.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2056
2122
|
# resp.status_history #=> Array
|
2057
|
-
# resp.status_history[0].error_detail.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2058
|
-
# resp.status_history[0].error_detail.error_message #=> String
|
2059
|
-
# resp.status_history[0].last_updated_at #=> Time
|
2060
2123
|
# resp.status_history[0].status #=> String, one of "FAILED", "SUCCEEDED", "PROCESSING", "DELETING", "DELETED"
|
2124
|
+
# resp.status_history[0].last_updated_at #=> Time
|
2125
|
+
# resp.status_history[0].error_detail.error_message #=> String
|
2126
|
+
# resp.status_history[0].error_detail.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2061
2127
|
#
|
2062
2128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetGroup AWS API Documentation
|
2063
2129
|
#
|
@@ -2080,17 +2146,18 @@ module Aws::QBusiness
|
|
2080
2146
|
# @return [Types::GetIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2081
2147
|
#
|
2082
2148
|
# * {Types::GetIndexResponse#application_id #application_id} => String
|
2083
|
-
# * {Types::GetIndexResponse#
|
2084
|
-
# * {Types::GetIndexResponse#
|
2149
|
+
# * {Types::GetIndexResponse#index_id #index_id} => String
|
2150
|
+
# * {Types::GetIndexResponse#display_name #display_name} => String
|
2151
|
+
# * {Types::GetIndexResponse#type #type} => String
|
2152
|
+
# * {Types::GetIndexResponse#index_arn #index_arn} => String
|
2153
|
+
# * {Types::GetIndexResponse#status #status} => String
|
2085
2154
|
# * {Types::GetIndexResponse#description #description} => String
|
2086
|
-
# * {Types::GetIndexResponse#
|
2155
|
+
# * {Types::GetIndexResponse#created_at #created_at} => Time
|
2156
|
+
# * {Types::GetIndexResponse#updated_at #updated_at} => Time
|
2157
|
+
# * {Types::GetIndexResponse#capacity_configuration #capacity_configuration} => Types::IndexCapacityConfiguration
|
2087
2158
|
# * {Types::GetIndexResponse#document_attribute_configurations #document_attribute_configurations} => Array<Types::DocumentAttributeConfiguration>
|
2088
2159
|
# * {Types::GetIndexResponse#error #error} => Types::ErrorDetail
|
2089
|
-
# * {Types::GetIndexResponse#index_arn #index_arn} => String
|
2090
|
-
# * {Types::GetIndexResponse#index_id #index_id} => String
|
2091
2160
|
# * {Types::GetIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
2092
|
-
# * {Types::GetIndexResponse#status #status} => String
|
2093
|
-
# * {Types::GetIndexResponse#updated_at #updated_at} => Time
|
2094
2161
|
#
|
2095
2162
|
# @example Request syntax with placeholder values
|
2096
2163
|
#
|
@@ -2102,22 +2169,23 @@ module Aws::QBusiness
|
|
2102
2169
|
# @example Response structure
|
2103
2170
|
#
|
2104
2171
|
# resp.application_id #=> String
|
2105
|
-
# resp.
|
2106
|
-
# resp.created_at #=> Time
|
2107
|
-
# resp.description #=> String
|
2172
|
+
# resp.index_id #=> String
|
2108
2173
|
# resp.display_name #=> String
|
2174
|
+
# resp.type #=> String, one of "ENTERPRISE", "STARTER"
|
2175
|
+
# resp.index_arn #=> String
|
2176
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2177
|
+
# resp.description #=> String
|
2178
|
+
# resp.created_at #=> Time
|
2179
|
+
# resp.updated_at #=> Time
|
2180
|
+
# resp.capacity_configuration.units #=> Integer
|
2109
2181
|
# resp.document_attribute_configurations #=> Array
|
2110
2182
|
# resp.document_attribute_configurations[0].name #=> String
|
2111
|
-
# resp.document_attribute_configurations[0].search #=> String, one of "ENABLED", "DISABLED"
|
2112
2183
|
# resp.document_attribute_configurations[0].type #=> String, one of "STRING", "STRING_LIST", "NUMBER", "DATE"
|
2113
|
-
# resp.
|
2184
|
+
# resp.document_attribute_configurations[0].search #=> String, one of "ENABLED", "DISABLED"
|
2114
2185
|
# resp.error.error_message #=> String
|
2115
|
-
# resp.
|
2116
|
-
# resp.index_id #=> String
|
2186
|
+
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2117
2187
|
# resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
|
2118
2188
|
# resp.index_statistics.text_document_statistics.indexed_text_document_count #=> Integer
|
2119
|
-
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2120
|
-
# resp.updated_at #=> Time
|
2121
2189
|
#
|
2122
2190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndex AWS API Documentation
|
2123
2191
|
#
|
@@ -2139,14 +2207,16 @@ module Aws::QBusiness
|
|
2139
2207
|
# @return [Types::GetPluginResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2140
2208
|
#
|
2141
2209
|
# * {Types::GetPluginResponse#application_id #application_id} => String
|
2142
|
-
# * {Types::GetPluginResponse#auth_configuration #auth_configuration} => Types::PluginAuthConfiguration
|
2143
|
-
# * {Types::GetPluginResponse#created_at #created_at} => Time
|
2144
|
-
# * {Types::GetPluginResponse#display_name #display_name} => String
|
2145
|
-
# * {Types::GetPluginResponse#plugin_arn #plugin_arn} => String
|
2146
2210
|
# * {Types::GetPluginResponse#plugin_id #plugin_id} => String
|
2211
|
+
# * {Types::GetPluginResponse#display_name #display_name} => String
|
2212
|
+
# * {Types::GetPluginResponse#type #type} => String
|
2147
2213
|
# * {Types::GetPluginResponse#server_url #server_url} => String
|
2214
|
+
# * {Types::GetPluginResponse#auth_configuration #auth_configuration} => Types::PluginAuthConfiguration
|
2215
|
+
# * {Types::GetPluginResponse#custom_plugin_configuration #custom_plugin_configuration} => Types::CustomPluginConfiguration
|
2216
|
+
# * {Types::GetPluginResponse#build_status #build_status} => String
|
2217
|
+
# * {Types::GetPluginResponse#plugin_arn #plugin_arn} => String
|
2148
2218
|
# * {Types::GetPluginResponse#state #state} => String
|
2149
|
-
# * {Types::GetPluginResponse#
|
2219
|
+
# * {Types::GetPluginResponse#created_at #created_at} => Time
|
2150
2220
|
# * {Types::GetPluginResponse#updated_at #updated_at} => Time
|
2151
2221
|
#
|
2152
2222
|
# @example Request syntax with placeholder values
|
@@ -2159,17 +2229,23 @@ module Aws::QBusiness
|
|
2159
2229
|
# @example Response structure
|
2160
2230
|
#
|
2161
2231
|
# resp.application_id #=> String
|
2162
|
-
# resp.
|
2232
|
+
# resp.plugin_id #=> String
|
2233
|
+
# resp.display_name #=> String
|
2234
|
+
# resp.type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
2235
|
+
# resp.server_url #=> String
|
2163
2236
|
# resp.auth_configuration.basic_auth_configuration.secret_arn #=> String
|
2164
|
-
# resp.auth_configuration.
|
2237
|
+
# resp.auth_configuration.basic_auth_configuration.role_arn #=> String
|
2165
2238
|
# resp.auth_configuration.o_auth_2_client_credential_configuration.secret_arn #=> String
|
2166
|
-
# resp.
|
2167
|
-
# resp.
|
2239
|
+
# resp.auth_configuration.o_auth_2_client_credential_configuration.role_arn #=> String
|
2240
|
+
# resp.custom_plugin_configuration.description #=> String
|
2241
|
+
# resp.custom_plugin_configuration.api_schema_type #=> String, one of "OPEN_API_V3"
|
2242
|
+
# resp.custom_plugin_configuration.api_schema.payload #=> String
|
2243
|
+
# resp.custom_plugin_configuration.api_schema.s3.bucket #=> String
|
2244
|
+
# resp.custom_plugin_configuration.api_schema.s3.key #=> String
|
2245
|
+
# resp.build_status #=> String, one of "READY", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
2168
2246
|
# resp.plugin_arn #=> String
|
2169
|
-
# resp.plugin_id #=> String
|
2170
|
-
# resp.server_url #=> String
|
2171
2247
|
# resp.state #=> String, one of "ENABLED", "DISABLED"
|
2172
|
-
# resp.
|
2248
|
+
# resp.created_at #=> Time
|
2173
2249
|
# resp.updated_at #=> Time
|
2174
2250
|
#
|
2175
2251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPlugin AWS API Documentation
|
@@ -2194,14 +2270,14 @@ module Aws::QBusiness
|
|
2194
2270
|
# @return [Types::GetRetrieverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2195
2271
|
#
|
2196
2272
|
# * {Types::GetRetrieverResponse#application_id #application_id} => String
|
2197
|
-
# * {Types::GetRetrieverResponse#configuration #configuration} => Types::RetrieverConfiguration
|
2198
|
-
# * {Types::GetRetrieverResponse#created_at #created_at} => Time
|
2199
|
-
# * {Types::GetRetrieverResponse#display_name #display_name} => String
|
2200
|
-
# * {Types::GetRetrieverResponse#retriever_arn #retriever_arn} => String
|
2201
2273
|
# * {Types::GetRetrieverResponse#retriever_id #retriever_id} => String
|
2202
|
-
# * {Types::GetRetrieverResponse#
|
2203
|
-
# * {Types::GetRetrieverResponse#status #status} => String
|
2274
|
+
# * {Types::GetRetrieverResponse#retriever_arn #retriever_arn} => String
|
2204
2275
|
# * {Types::GetRetrieverResponse#type #type} => String
|
2276
|
+
# * {Types::GetRetrieverResponse#status #status} => String
|
2277
|
+
# * {Types::GetRetrieverResponse#display_name #display_name} => String
|
2278
|
+
# * {Types::GetRetrieverResponse#configuration #configuration} => Types::RetrieverConfiguration
|
2279
|
+
# * {Types::GetRetrieverResponse#role_arn #role_arn} => String
|
2280
|
+
# * {Types::GetRetrieverResponse#created_at #created_at} => Time
|
2205
2281
|
# * {Types::GetRetrieverResponse#updated_at #updated_at} => Time
|
2206
2282
|
#
|
2207
2283
|
# @example Request syntax with placeholder values
|
@@ -2214,24 +2290,24 @@ module Aws::QBusiness
|
|
2214
2290
|
# @example Response structure
|
2215
2291
|
#
|
2216
2292
|
# resp.application_id #=> String
|
2217
|
-
# resp.
|
2293
|
+
# resp.retriever_id #=> String
|
2294
|
+
# resp.retriever_arn #=> String
|
2295
|
+
# resp.type #=> String, one of "NATIVE_INDEX", "KENDRA_INDEX"
|
2296
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "FAILED"
|
2297
|
+
# resp.display_name #=> String
|
2298
|
+
# resp.configuration.native_index_configuration.index_id #=> String
|
2218
2299
|
# resp.configuration.native_index_configuration.boosting_override #=> Hash
|
2219
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
|
2220
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2221
2300
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2222
2301
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_type #=> String, one of "PRIORITIZE_LARGER_VALUES", "PRIORITIZE_SMALLER_VALUES"
|
2302
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2223
2303
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting #=> Hash
|
2224
2304
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2225
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].
|
2305
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2306
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
|
2226
2307
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_list_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2227
|
-
# resp.configuration.
|
2228
|
-
# resp.created_at #=> Time
|
2229
|
-
# resp.display_name #=> String
|
2230
|
-
# resp.retriever_arn #=> String
|
2231
|
-
# resp.retriever_id #=> String
|
2308
|
+
# resp.configuration.kendra_index_configuration.index_id #=> String
|
2232
2309
|
# resp.role_arn #=> String
|
2233
|
-
# resp.
|
2234
|
-
# resp.type #=> String, one of "NATIVE_INDEX", "KENDRA_INDEX"
|
2310
|
+
# resp.created_at #=> Time
|
2235
2311
|
# resp.updated_at #=> Time
|
2236
2312
|
#
|
2237
2313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetRetriever AWS API Documentation
|
@@ -2266,8 +2342,8 @@ module Aws::QBusiness
|
|
2266
2342
|
# @example Response structure
|
2267
2343
|
#
|
2268
2344
|
# resp.user_aliases #=> Array
|
2269
|
-
# resp.user_aliases[0].data_source_id #=> String
|
2270
2345
|
# resp.user_aliases[0].index_id #=> String
|
2346
|
+
# resp.user_aliases[0].data_source_id #=> String
|
2271
2347
|
# resp.user_aliases[0].user_id #=> String
|
2272
2348
|
#
|
2273
2349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetUser AWS API Documentation
|
@@ -2291,19 +2367,19 @@ module Aws::QBusiness
|
|
2291
2367
|
# @return [Types::GetWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2292
2368
|
#
|
2293
2369
|
# * {Types::GetWebExperienceResponse#application_id #application_id} => String
|
2294
|
-
# * {Types::GetWebExperienceResponse#
|
2295
|
-
# * {Types::GetWebExperienceResponse#
|
2370
|
+
# * {Types::GetWebExperienceResponse#web_experience_id #web_experience_id} => String
|
2371
|
+
# * {Types::GetWebExperienceResponse#web_experience_arn #web_experience_arn} => String
|
2296
2372
|
# * {Types::GetWebExperienceResponse#default_endpoint #default_endpoint} => String
|
2297
|
-
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
2298
|
-
# * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
|
2299
|
-
# * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
|
2300
2373
|
# * {Types::GetWebExperienceResponse#status #status} => String
|
2301
|
-
# * {Types::GetWebExperienceResponse#
|
2302
|
-
# * {Types::GetWebExperienceResponse#title #title} => String
|
2374
|
+
# * {Types::GetWebExperienceResponse#created_at #created_at} => Time
|
2303
2375
|
# * {Types::GetWebExperienceResponse#updated_at #updated_at} => Time
|
2304
|
-
# * {Types::GetWebExperienceResponse#
|
2305
|
-
# * {Types::GetWebExperienceResponse#
|
2376
|
+
# * {Types::GetWebExperienceResponse#title #title} => String
|
2377
|
+
# * {Types::GetWebExperienceResponse#subtitle #subtitle} => String
|
2306
2378
|
# * {Types::GetWebExperienceResponse#welcome_message #welcome_message} => String
|
2379
|
+
# * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
|
2380
|
+
# * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
|
2381
|
+
# * {Types::GetWebExperienceResponse#authentication_configuration #authentication_configuration} => Types::WebExperienceAuthConfiguration
|
2382
|
+
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
2307
2383
|
#
|
2308
2384
|
# @example Request syntax with placeholder values
|
2309
2385
|
#
|
@@ -2315,23 +2391,23 @@ module Aws::QBusiness
|
|
2315
2391
|
# @example Response structure
|
2316
2392
|
#
|
2317
2393
|
# resp.application_id #=> String
|
2318
|
-
# resp.
|
2319
|
-
# resp.
|
2320
|
-
# resp.authentication_configuration.saml_configuration.user_group_attribute #=> String
|
2321
|
-
# resp.authentication_configuration.saml_configuration.user_id_attribute #=> String
|
2322
|
-
# resp.created_at #=> Time
|
2394
|
+
# resp.web_experience_id #=> String
|
2395
|
+
# resp.web_experience_arn #=> String
|
2323
2396
|
# resp.default_endpoint #=> String
|
2324
|
-
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2325
|
-
# resp.error.error_message #=> String
|
2326
|
-
# resp.role_arn #=> String
|
2327
|
-
# resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
|
2328
2397
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "PENDING_AUTH_CONFIG"
|
2329
|
-
# resp.
|
2330
|
-
# resp.title #=> String
|
2398
|
+
# resp.created_at #=> Time
|
2331
2399
|
# resp.updated_at #=> Time
|
2332
|
-
# resp.
|
2333
|
-
# resp.
|
2400
|
+
# resp.title #=> String
|
2401
|
+
# resp.subtitle #=> String
|
2334
2402
|
# resp.welcome_message #=> String
|
2403
|
+
# resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
|
2404
|
+
# resp.role_arn #=> String
|
2405
|
+
# resp.authentication_configuration.saml_configuration.metadata_xml #=> String
|
2406
|
+
# resp.authentication_configuration.saml_configuration.role_arn #=> String
|
2407
|
+
# resp.authentication_configuration.saml_configuration.user_id_attribute #=> String
|
2408
|
+
# resp.authentication_configuration.saml_configuration.user_group_attribute #=> String
|
2409
|
+
# resp.error.error_message #=> String
|
2410
|
+
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2335
2411
|
#
|
2336
2412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperience AWS API Documentation
|
2337
2413
|
#
|
@@ -2344,38 +2420,38 @@ module Aws::QBusiness
|
|
2344
2420
|
|
2345
2421
|
# Lists Amazon Q Business applications.
|
2346
2422
|
#
|
2347
|
-
# @option params [Integer] :max_results
|
2348
|
-
# The maximum number of Amazon Q Business applications to return.
|
2349
|
-
#
|
2350
2423
|
# @option params [String] :next_token
|
2351
2424
|
# If the `maxResults` response was incomplete because there is more data
|
2352
2425
|
# to retrieve, Amazon Q Business returns a pagination token in the
|
2353
2426
|
# response. You can use this pagination token to retrieve the next set
|
2354
2427
|
# of Amazon Q Business applications.
|
2355
2428
|
#
|
2429
|
+
# @option params [Integer] :max_results
|
2430
|
+
# The maximum number of Amazon Q Business applications to return.
|
2431
|
+
#
|
2356
2432
|
# @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2357
2433
|
#
|
2358
|
-
# * {Types::ListApplicationsResponse#applications #applications} => Array<Types::Application>
|
2359
2434
|
# * {Types::ListApplicationsResponse#next_token #next_token} => String
|
2435
|
+
# * {Types::ListApplicationsResponse#applications #applications} => Array<Types::Application>
|
2360
2436
|
#
|
2361
2437
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2362
2438
|
#
|
2363
2439
|
# @example Request syntax with placeholder values
|
2364
2440
|
#
|
2365
2441
|
# resp = client.list_applications({
|
2366
|
-
# max_results: 1,
|
2367
2442
|
# next_token: "NextToken",
|
2443
|
+
# max_results: 1,
|
2368
2444
|
# })
|
2369
2445
|
#
|
2370
2446
|
# @example Response structure
|
2371
2447
|
#
|
2448
|
+
# resp.next_token #=> String
|
2372
2449
|
# resp.applications #=> Array
|
2450
|
+
# resp.applications[0].display_name #=> String
|
2373
2451
|
# resp.applications[0].application_id #=> String
|
2374
2452
|
# resp.applications[0].created_at #=> Time
|
2375
|
-
# resp.applications[0].display_name #=> String
|
2376
|
-
# resp.applications[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2377
2453
|
# resp.applications[0].updated_at #=> Time
|
2378
|
-
# resp.
|
2454
|
+
# resp.applications[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2379
2455
|
#
|
2380
2456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplications AWS API Documentation
|
2381
2457
|
#
|
@@ -2391,8 +2467,9 @@ module Aws::QBusiness
|
|
2391
2467
|
# @option params [required, String] :application_id
|
2392
2468
|
# The identifier of the Amazon Q Business application.
|
2393
2469
|
#
|
2394
|
-
# @option params [
|
2395
|
-
# The
|
2470
|
+
# @option params [String] :user_id
|
2471
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2472
|
+
# experience conversation.
|
2396
2473
|
#
|
2397
2474
|
# @option params [String] :next_token
|
2398
2475
|
# If the `maxResults` response was incomplete because there is more data
|
@@ -2400,14 +2477,13 @@ module Aws::QBusiness
|
|
2400
2477
|
# response. You can use this pagination token to retrieve the next set
|
2401
2478
|
# of Amazon Q Business conversations.
|
2402
2479
|
#
|
2403
|
-
# @option params [
|
2404
|
-
# The
|
2405
|
-
# experience conversation.
|
2480
|
+
# @option params [Integer] :max_results
|
2481
|
+
# The maximum number of Amazon Q Business conversations to return.
|
2406
2482
|
#
|
2407
2483
|
# @return [Types::ListConversationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2408
2484
|
#
|
2409
|
-
# * {Types::ListConversationsResponse#conversations #conversations} => Array<Types::Conversation>
|
2410
2485
|
# * {Types::ListConversationsResponse#next_token #next_token} => String
|
2486
|
+
# * {Types::ListConversationsResponse#conversations #conversations} => Array<Types::Conversation>
|
2411
2487
|
#
|
2412
2488
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2413
2489
|
#
|
@@ -2415,18 +2491,18 @@ module Aws::QBusiness
|
|
2415
2491
|
#
|
2416
2492
|
# resp = client.list_conversations({
|
2417
2493
|
# application_id: "ApplicationId", # required
|
2418
|
-
# max_results: 1,
|
2419
|
-
# next_token: "NextToken",
|
2420
2494
|
# user_id: "UserId",
|
2495
|
+
# next_token: "NextToken",
|
2496
|
+
# max_results: 1,
|
2421
2497
|
# })
|
2422
2498
|
#
|
2423
2499
|
# @example Response structure
|
2424
2500
|
#
|
2501
|
+
# resp.next_token #=> String
|
2425
2502
|
# resp.conversations #=> Array
|
2426
2503
|
# resp.conversations[0].conversation_id #=> String
|
2427
|
-
# resp.conversations[0].start_time #=> Time
|
2428
2504
|
# resp.conversations[0].title #=> String
|
2429
|
-
# resp.
|
2505
|
+
# resp.conversations[0].start_time #=> Time
|
2430
2506
|
#
|
2431
2507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversations AWS API Documentation
|
2432
2508
|
#
|
@@ -2440,32 +2516,32 @@ module Aws::QBusiness
|
|
2440
2516
|
# Get information about an Amazon Q Business data source connector
|
2441
2517
|
# synchronization.
|
2442
2518
|
#
|
2443
|
-
# @option params [required, String] :application_id
|
2444
|
-
# The identifier of the Amazon Q Business application connected to the
|
2445
|
-
# data source.
|
2446
|
-
#
|
2447
2519
|
# @option params [required, String] :data_source_id
|
2448
2520
|
# The identifier of the data source connector.
|
2449
2521
|
#
|
2450
|
-
# @option params [
|
2451
|
-
# The
|
2522
|
+
# @option params [required, String] :application_id
|
2523
|
+
# The identifier of the Amazon Q Business application connected to the
|
2524
|
+
# data source.
|
2452
2525
|
#
|
2453
2526
|
# @option params [required, String] :index_id
|
2454
2527
|
# The identifier of the index used with the Amazon Q Business data
|
2455
2528
|
# source connector.
|
2456
2529
|
#
|
2457
|
-
# @option params [Integer] :max_results
|
2458
|
-
# The maximum number of synchronization jobs to return in the response.
|
2459
|
-
#
|
2460
2530
|
# @option params [String] :next_token
|
2461
2531
|
# If the `maxResults` response was incpmplete because there is more data
|
2462
2532
|
# to retriever, Amazon Q Business returns a pagination token in the
|
2463
2533
|
# response. You can use this pagination token to retrieve the next set
|
2464
2534
|
# of responses.
|
2465
2535
|
#
|
2536
|
+
# @option params [Integer] :max_results
|
2537
|
+
# The maximum number of synchronization jobs to return in the response.
|
2538
|
+
#
|
2466
2539
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
2467
2540
|
# The start time of the data source connector sync.
|
2468
2541
|
#
|
2542
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
2543
|
+
# The end time of the data source connector sync.
|
2544
|
+
#
|
2469
2545
|
# @option params [String] :status_filter
|
2470
2546
|
# Only returns synchronization jobs with the `Status` field equal to the
|
2471
2547
|
# specified status.
|
@@ -2480,31 +2556,31 @@ module Aws::QBusiness
|
|
2480
2556
|
# @example Request syntax with placeholder values
|
2481
2557
|
#
|
2482
2558
|
# resp = client.list_data_source_sync_jobs({
|
2483
|
-
# application_id: "ApplicationId", # required
|
2484
2559
|
# data_source_id: "DataSourceId", # required
|
2485
|
-
#
|
2560
|
+
# application_id: "ApplicationId", # required
|
2486
2561
|
# index_id: "IndexId", # required
|
2487
|
-
# max_results: 1,
|
2488
2562
|
# next_token: "NextToken",
|
2563
|
+
# max_results: 1,
|
2489
2564
|
# start_time: Time.now,
|
2565
|
+
# end_time: Time.now,
|
2490
2566
|
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
|
2491
2567
|
# })
|
2492
2568
|
#
|
2493
2569
|
# @example Response structure
|
2494
2570
|
#
|
2495
2571
|
# resp.history #=> Array
|
2496
|
-
# resp.history[0].
|
2572
|
+
# resp.history[0].execution_id #=> String
|
2573
|
+
# resp.history[0].start_time #=> Time
|
2497
2574
|
# resp.history[0].end_time #=> Time
|
2498
|
-
# resp.history[0].
|
2575
|
+
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
|
2499
2576
|
# resp.history[0].error.error_message #=> String
|
2500
|
-
# resp.history[0].
|
2577
|
+
# resp.history[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2578
|
+
# resp.history[0].data_source_error_code #=> String
|
2501
2579
|
# resp.history[0].metrics.documents_added #=> String
|
2580
|
+
# resp.history[0].metrics.documents_modified #=> String
|
2502
2581
|
# resp.history[0].metrics.documents_deleted #=> String
|
2503
2582
|
# resp.history[0].metrics.documents_failed #=> String
|
2504
|
-
# resp.history[0].metrics.documents_modified #=> String
|
2505
2583
|
# resp.history[0].metrics.documents_scanned #=> String
|
2506
|
-
# resp.history[0].start_time #=> Time
|
2507
|
-
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
|
2508
2584
|
# resp.next_token #=> String
|
2509
2585
|
#
|
2510
2586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourceSyncJobs AWS API Documentation
|
@@ -2527,15 +2603,15 @@ module Aws::QBusiness
|
|
2527
2603
|
# The identifier of the index used with one or more data source
|
2528
2604
|
# connectors.
|
2529
2605
|
#
|
2530
|
-
# @option params [Integer] :max_results
|
2531
|
-
# The maximum number of data source connectors to return.
|
2532
|
-
#
|
2533
2606
|
# @option params [String] :next_token
|
2534
2607
|
# If the `maxResults` response was incomplete because there is more data
|
2535
2608
|
# to retrieve, Amazon Q Business returns a pagination token in the
|
2536
2609
|
# response. You can use this pagination token to retrieve the next set
|
2537
2610
|
# of Amazon Q Business data source connectors.
|
2538
2611
|
#
|
2612
|
+
# @option params [Integer] :max_results
|
2613
|
+
# The maximum number of data source connectors to return.
|
2614
|
+
#
|
2539
2615
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2540
2616
|
#
|
2541
2617
|
# * {Types::ListDataSourcesResponse#data_sources #data_sources} => Array<Types::DataSource>
|
@@ -2548,19 +2624,19 @@ module Aws::QBusiness
|
|
2548
2624
|
# resp = client.list_data_sources({
|
2549
2625
|
# application_id: "ApplicationId", # required
|
2550
2626
|
# index_id: "IndexId", # required
|
2551
|
-
# max_results: 1,
|
2552
2627
|
# next_token: "NextToken",
|
2628
|
+
# max_results: 1,
|
2553
2629
|
# })
|
2554
2630
|
#
|
2555
2631
|
# @example Response structure
|
2556
2632
|
#
|
2557
2633
|
# resp.data_sources #=> Array
|
2558
|
-
# resp.data_sources[0].created_at #=> Time
|
2559
|
-
# resp.data_sources[0].data_source_id #=> String
|
2560
2634
|
# resp.data_sources[0].display_name #=> String
|
2561
|
-
# resp.data_sources[0].
|
2635
|
+
# resp.data_sources[0].data_source_id #=> String
|
2562
2636
|
# resp.data_sources[0].type #=> String
|
2637
|
+
# resp.data_sources[0].created_at #=> Time
|
2563
2638
|
# resp.data_sources[0].updated_at #=> Time
|
2639
|
+
# resp.data_sources[0].status #=> String, one of "PENDING_CREATION", "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2564
2640
|
# resp.next_token #=> String
|
2565
2641
|
#
|
2566
2642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSources AWS API Documentation
|
@@ -2577,14 +2653,11 @@ module Aws::QBusiness
|
|
2577
2653
|
# @option params [required, String] :application_id
|
2578
2654
|
# The identifier of the application id the documents are attached to.
|
2579
2655
|
#
|
2580
|
-
# @option params [Array<String>] :data_source_ids
|
2581
|
-
# The identifier of the data sources the documents are attached to.
|
2582
|
-
#
|
2583
2656
|
# @option params [required, String] :index_id
|
2584
2657
|
# The identifier of the index the documents are attached to.
|
2585
2658
|
#
|
2586
|
-
# @option params [
|
2587
|
-
# The
|
2659
|
+
# @option params [Array<String>] :data_source_ids
|
2660
|
+
# The identifier of the data sources the documents are attached to.
|
2588
2661
|
#
|
2589
2662
|
# @option params [String] :next_token
|
2590
2663
|
# If the `maxResults` response was incomplete because there is more data
|
@@ -2592,6 +2665,9 @@ module Aws::QBusiness
|
|
2592
2665
|
# response. You can use this pagination token to retrieve the next set
|
2593
2666
|
# of documents.
|
2594
2667
|
#
|
2668
|
+
# @option params [Integer] :max_results
|
2669
|
+
# The maximum number of documents to return.
|
2670
|
+
#
|
2595
2671
|
# @return [Types::ListDocumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2596
2672
|
#
|
2597
2673
|
# * {Types::ListDocumentsResponse#document_detail_list #document_detail_list} => Array<Types::DocumentDetails>
|
@@ -2603,20 +2679,20 @@ module Aws::QBusiness
|
|
2603
2679
|
#
|
2604
2680
|
# resp = client.list_documents({
|
2605
2681
|
# application_id: "ApplicationId", # required
|
2606
|
-
# data_source_ids: ["DataSourceId"],
|
2607
2682
|
# index_id: "IndexId", # required
|
2608
|
-
#
|
2683
|
+
# data_source_ids: ["DataSourceId"],
|
2609
2684
|
# next_token: "NextToken",
|
2685
|
+
# max_results: 1,
|
2610
2686
|
# })
|
2611
2687
|
#
|
2612
2688
|
# @example Response structure
|
2613
2689
|
#
|
2614
2690
|
# resp.document_detail_list #=> Array
|
2615
|
-
# resp.document_detail_list[0].created_at #=> Time
|
2616
2691
|
# resp.document_detail_list[0].document_id #=> String
|
2617
|
-
# resp.document_detail_list[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2618
|
-
# resp.document_detail_list[0].error.error_message #=> String
|
2619
2692
|
# resp.document_detail_list[0].status #=> String, one of "RECEIVED", "PROCESSING", "INDEXED", "UPDATED", "FAILED", "DELETING", "DELETED", "DOCUMENT_FAILED_TO_INDEX"
|
2693
|
+
# resp.document_detail_list[0].error.error_message #=> String
|
2694
|
+
# resp.document_detail_list[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2695
|
+
# resp.document_detail_list[0].created_at #=> Time
|
2620
2696
|
# resp.document_detail_list[0].updated_at #=> Time
|
2621
2697
|
# resp.next_token #=> String
|
2622
2698
|
#
|
@@ -2635,16 +2711,17 @@ module Aws::QBusiness
|
|
2635
2711
|
# The identifier of the application for getting a list of groups mapped
|
2636
2712
|
# to users.
|
2637
2713
|
#
|
2638
|
-
# @option params [String] :data_source_id
|
2639
|
-
# The identifier of the data source for getting a list of groups mapped
|
2640
|
-
# to users.
|
2641
|
-
#
|
2642
2714
|
# @option params [required, String] :index_id
|
2643
2715
|
# The identifier of the index for getting a list of groups mapped to
|
2644
2716
|
# users.
|
2645
2717
|
#
|
2646
|
-
# @option params [Integer] :
|
2647
|
-
# The
|
2718
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :updated_earlier_than
|
2719
|
+
# The timestamp identifier used for the latest `PUT` or `DELETE` action
|
2720
|
+
# for mapping users to their groups.
|
2721
|
+
#
|
2722
|
+
# @option params [String] :data_source_id
|
2723
|
+
# The identifier of the data source for getting a list of groups mapped
|
2724
|
+
# to users.
|
2648
2725
|
#
|
2649
2726
|
# @option params [String] :next_token
|
2650
2727
|
# If the previous response was incomplete (because there is more data to
|
@@ -2652,14 +2729,13 @@ module Aws::QBusiness
|
|
2652
2729
|
# response. You can use this pagination token to retrieve the next set
|
2653
2730
|
# of groups that are mapped to users.
|
2654
2731
|
#
|
2655
|
-
# @option params [
|
2656
|
-
# The
|
2657
|
-
# for mapping users to their groups.
|
2732
|
+
# @option params [Integer] :max_results
|
2733
|
+
# The maximum number of returned groups that are mapped to users.
|
2658
2734
|
#
|
2659
2735
|
# @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2660
2736
|
#
|
2661
|
-
# * {Types::ListGroupsResponse#items #items} => Array<Types::GroupSummary>
|
2662
2737
|
# * {Types::ListGroupsResponse#next_token #next_token} => String
|
2738
|
+
# * {Types::ListGroupsResponse#items #items} => Array<Types::GroupSummary>
|
2663
2739
|
#
|
2664
2740
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2665
2741
|
#
|
@@ -2667,18 +2743,18 @@ module Aws::QBusiness
|
|
2667
2743
|
#
|
2668
2744
|
# resp = client.list_groups({
|
2669
2745
|
# application_id: "ApplicationId", # required
|
2746
|
+
# index_id: "IndexId", # required
|
2747
|
+
# updated_earlier_than: Time.now, # required
|
2670
2748
|
# data_source_id: "DataSourceId",
|
2671
|
-
# index_id: "IndexId", # required
|
2672
|
-
# max_results: 1,
|
2673
2749
|
# next_token: "NextToken",
|
2674
|
-
#
|
2750
|
+
# max_results: 1,
|
2675
2751
|
# })
|
2676
2752
|
#
|
2677
2753
|
# @example Response structure
|
2678
2754
|
#
|
2755
|
+
# resp.next_token #=> String
|
2679
2756
|
# resp.items #=> Array
|
2680
2757
|
# resp.items[0].group_name #=> String
|
2681
|
-
# resp.next_token #=> String
|
2682
2758
|
#
|
2683
2759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroups AWS API Documentation
|
2684
2760
|
#
|
@@ -2695,19 +2771,19 @@ module Aws::QBusiness
|
|
2695
2771
|
# The identifier of the Amazon Q Business application connected to the
|
2696
2772
|
# index.
|
2697
2773
|
#
|
2698
|
-
# @option params [Integer] :max_results
|
2699
|
-
# The maximum number of indices to return.
|
2700
|
-
#
|
2701
2774
|
# @option params [String] :next_token
|
2702
2775
|
# If the maxResults response was incomplete because there is more data
|
2703
2776
|
# to retrieve, Amazon Q Business returns a pagination token in the
|
2704
2777
|
# response. You can use this pagination token to retrieve the next set
|
2705
2778
|
# of Amazon Q Business indices.
|
2706
2779
|
#
|
2780
|
+
# @option params [Integer] :max_results
|
2781
|
+
# The maximum number of indices to return.
|
2782
|
+
#
|
2707
2783
|
# @return [Types::ListIndicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2708
2784
|
#
|
2709
|
-
# * {Types::ListIndicesResponse#indices #indices} => Array<Types::Index>
|
2710
2785
|
# * {Types::ListIndicesResponse#next_token #next_token} => String
|
2786
|
+
# * {Types::ListIndicesResponse#indices #indices} => Array<Types::Index>
|
2711
2787
|
#
|
2712
2788
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2713
2789
|
#
|
@@ -2715,19 +2791,19 @@ module Aws::QBusiness
|
|
2715
2791
|
#
|
2716
2792
|
# resp = client.list_indices({
|
2717
2793
|
# application_id: "ApplicationId", # required
|
2718
|
-
# max_results: 1,
|
2719
2794
|
# next_token: "NextToken",
|
2795
|
+
# max_results: 1,
|
2720
2796
|
# })
|
2721
2797
|
#
|
2722
2798
|
# @example Response structure
|
2723
2799
|
#
|
2800
|
+
# resp.next_token #=> String
|
2724
2801
|
# resp.indices #=> Array
|
2725
|
-
# resp.indices[0].created_at #=> Time
|
2726
2802
|
# resp.indices[0].display_name #=> String
|
2727
2803
|
# resp.indices[0].index_id #=> String
|
2728
|
-
# resp.indices[0].
|
2804
|
+
# resp.indices[0].created_at #=> Time
|
2729
2805
|
# resp.indices[0].updated_at #=> Time
|
2730
|
-
# resp.
|
2806
|
+
# resp.indices[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2731
2807
|
#
|
2732
2808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndices AWS API Documentation
|
2733
2809
|
#
|
@@ -2741,23 +2817,23 @@ module Aws::QBusiness
|
|
2741
2817
|
# Gets a list of messages associated with an Amazon Q Business web
|
2742
2818
|
# experience.
|
2743
2819
|
#
|
2744
|
-
# @option params [required, String] :application_id
|
2745
|
-
# The identifier for the Amazon Q Business application.
|
2746
|
-
#
|
2747
2820
|
# @option params [required, String] :conversation_id
|
2748
2821
|
# The identifier of the Amazon Q Business web experience conversation.
|
2749
2822
|
#
|
2750
|
-
# @option params [
|
2751
|
-
# The
|
2823
|
+
# @option params [required, String] :application_id
|
2824
|
+
# The identifier for the Amazon Q Business application.
|
2825
|
+
#
|
2826
|
+
# @option params [String] :user_id
|
2827
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2828
|
+
# experience conversation.
|
2752
2829
|
#
|
2753
2830
|
# @option params [String] :next_token
|
2754
2831
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2755
2832
|
# Business returns a next token as a pagination token to retrieve the
|
2756
2833
|
# next set of messages.
|
2757
2834
|
#
|
2758
|
-
# @option params [
|
2759
|
-
# The
|
2760
|
-
# experience conversation.
|
2835
|
+
# @option params [Integer] :max_results
|
2836
|
+
# The maximum number of messages to return.
|
2761
2837
|
#
|
2762
2838
|
# @return [Types::ListMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2763
2839
|
#
|
@@ -2769,46 +2845,49 @@ module Aws::QBusiness
|
|
2769
2845
|
# @example Request syntax with placeholder values
|
2770
2846
|
#
|
2771
2847
|
# resp = client.list_messages({
|
2772
|
-
# application_id: "ApplicationId", # required
|
2773
2848
|
# conversation_id: "ConversationId", # required
|
2774
|
-
#
|
2775
|
-
# next_token: "NextToken",
|
2849
|
+
# application_id: "ApplicationId", # required
|
2776
2850
|
# user_id: "UserId",
|
2851
|
+
# next_token: "NextToken",
|
2852
|
+
# max_results: 1,
|
2777
2853
|
# })
|
2778
2854
|
#
|
2779
2855
|
# @example Response structure
|
2780
2856
|
#
|
2781
2857
|
# resp.messages #=> Array
|
2782
|
-
# resp.messages[0].
|
2783
|
-
# resp.messages[0].
|
2784
|
-
# resp.messages[0].
|
2785
|
-
# resp.messages[0].
|
2786
|
-
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].allowed_values #=> Array
|
2787
|
-
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_name #=> String
|
2788
|
-
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_order #=> Integer
|
2789
|
-
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].required #=> Boolean
|
2790
|
-
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].type #=> String, one of "STRING", "NUMBER", "ARRAY", "BOOLEAN"
|
2791
|
-
# resp.messages[0].action_review.payload_field_name_separator #=> String
|
2792
|
-
# resp.messages[0].action_review.plugin_id #=> String
|
2793
|
-
# resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK"
|
2858
|
+
# resp.messages[0].message_id #=> String
|
2859
|
+
# resp.messages[0].body #=> String
|
2860
|
+
# resp.messages[0].time #=> Time
|
2861
|
+
# resp.messages[0].type #=> String, one of "USER", "SYSTEM"
|
2794
2862
|
# resp.messages[0].attachments #=> Array
|
2795
|
-
# resp.messages[0].attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2796
|
-
# resp.messages[0].attachments[0].error.error_message #=> String
|
2797
2863
|
# resp.messages[0].attachments[0].name #=> String
|
2798
2864
|
# resp.messages[0].attachments[0].status #=> String, one of "FAILED", "SUCCEEDED"
|
2799
|
-
# resp.messages[0].
|
2800
|
-
# resp.messages[0].
|
2865
|
+
# resp.messages[0].attachments[0].error.error_message #=> String
|
2866
|
+
# resp.messages[0].attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2801
2867
|
# resp.messages[0].source_attribution #=> Array
|
2802
|
-
# resp.messages[0].source_attribution[0].
|
2868
|
+
# resp.messages[0].source_attribution[0].title #=> String
|
2803
2869
|
# resp.messages[0].source_attribution[0].snippet #=> String
|
2870
|
+
# resp.messages[0].source_attribution[0].url #=> String
|
2871
|
+
# resp.messages[0].source_attribution[0].citation_number #=> Integer
|
2872
|
+
# resp.messages[0].source_attribution[0].updated_at #=> Time
|
2804
2873
|
# resp.messages[0].source_attribution[0].text_message_segments #=> Array
|
2805
2874
|
# resp.messages[0].source_attribution[0].text_message_segments[0].begin_offset #=> Integer
|
2806
2875
|
# resp.messages[0].source_attribution[0].text_message_segments[0].end_offset #=> Integer
|
2807
|
-
# resp.messages[0].source_attribution[0].
|
2808
|
-
# resp.messages[0].
|
2809
|
-
# resp.messages[0].
|
2810
|
-
# resp.messages[0].
|
2811
|
-
# resp.messages[0].
|
2876
|
+
# resp.messages[0].source_attribution[0].text_message_segments[0].snippet_excerpt.text #=> String
|
2877
|
+
# resp.messages[0].action_review.plugin_id #=> String
|
2878
|
+
# resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
2879
|
+
# resp.messages[0].action_review.payload #=> Hash
|
2880
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_name #=> String
|
2881
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_order #=> Integer
|
2882
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_description #=> String
|
2883
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].type #=> String, one of "STRING", "NUMBER", "ARRAY", "BOOLEAN"
|
2884
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].allowed_values #=> Array
|
2885
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].allowed_format #=> String
|
2886
|
+
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].required #=> Boolean
|
2887
|
+
# resp.messages[0].action_review.payload_field_name_separator #=> String
|
2888
|
+
# resp.messages[0].action_execution.plugin_id #=> String
|
2889
|
+
# resp.messages[0].action_execution.payload #=> Hash
|
2890
|
+
# resp.messages[0].action_execution.payload_field_name_separator #=> String
|
2812
2891
|
# resp.next_token #=> String
|
2813
2892
|
#
|
2814
2893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessages AWS API Documentation
|
@@ -2825,15 +2904,15 @@ module Aws::QBusiness
|
|
2825
2904
|
# @option params [required, String] :application_id
|
2826
2905
|
# The identifier of the application the plugin is attached to.
|
2827
2906
|
#
|
2828
|
-
# @option params [Integer] :max_results
|
2829
|
-
# The maximum number of documents to return.
|
2830
|
-
#
|
2831
2907
|
# @option params [String] :next_token
|
2832
2908
|
# If the `maxResults` response was incomplete because there is more data
|
2833
2909
|
# to retrieve, Amazon Q Business returns a pagination token in the
|
2834
2910
|
# response. You can use this pagination token to retrieve the next set
|
2835
2911
|
# of plugins.
|
2836
2912
|
#
|
2913
|
+
# @option params [Integer] :max_results
|
2914
|
+
# The maximum number of documents to return.
|
2915
|
+
#
|
2837
2916
|
# @return [Types::ListPluginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2838
2917
|
#
|
2839
2918
|
# * {Types::ListPluginsResponse#next_token #next_token} => String
|
@@ -2845,20 +2924,21 @@ module Aws::QBusiness
|
|
2845
2924
|
#
|
2846
2925
|
# resp = client.list_plugins({
|
2847
2926
|
# application_id: "ApplicationId", # required
|
2848
|
-
# max_results: 1,
|
2849
2927
|
# next_token: "NextToken",
|
2928
|
+
# max_results: 1,
|
2850
2929
|
# })
|
2851
2930
|
#
|
2852
2931
|
# @example Response structure
|
2853
2932
|
#
|
2854
2933
|
# resp.next_token #=> String
|
2855
2934
|
# resp.plugins #=> Array
|
2856
|
-
# resp.plugins[0].created_at #=> Time
|
2857
|
-
# resp.plugins[0].display_name #=> String
|
2858
2935
|
# resp.plugins[0].plugin_id #=> String
|
2936
|
+
# resp.plugins[0].display_name #=> String
|
2937
|
+
# resp.plugins[0].type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
2859
2938
|
# resp.plugins[0].server_url #=> String
|
2860
2939
|
# resp.plugins[0].state #=> String, one of "ENABLED", "DISABLED"
|
2861
|
-
# resp.plugins[0].
|
2940
|
+
# resp.plugins[0].build_status #=> String, one of "READY", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
2941
|
+
# resp.plugins[0].created_at #=> Time
|
2862
2942
|
# resp.plugins[0].updated_at #=> Time
|
2863
2943
|
#
|
2864
2944
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPlugins AWS API Documentation
|
@@ -2876,18 +2956,18 @@ module Aws::QBusiness
|
|
2876
2956
|
# The identifier of the Amazon Q Business application using the
|
2877
2957
|
# retriever.
|
2878
2958
|
#
|
2879
|
-
# @option params [Integer] :max_results
|
2880
|
-
# The maximum number of retrievers returned.
|
2881
|
-
#
|
2882
2959
|
# @option params [String] :next_token
|
2883
2960
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2884
2961
|
# Business returns a next token as a pagination token to retrieve the
|
2885
2962
|
# next set of retrievers.
|
2886
2963
|
#
|
2964
|
+
# @option params [Integer] :max_results
|
2965
|
+
# The maximum number of retrievers returned.
|
2966
|
+
#
|
2887
2967
|
# @return [Types::ListRetrieversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2888
2968
|
#
|
2889
|
-
# * {Types::ListRetrieversResponse#next_token #next_token} => String
|
2890
2969
|
# * {Types::ListRetrieversResponse#retrievers #retrievers} => Array<Types::Retriever>
|
2970
|
+
# * {Types::ListRetrieversResponse#next_token #next_token} => String
|
2891
2971
|
#
|
2892
2972
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2893
2973
|
#
|
@@ -2895,19 +2975,19 @@ module Aws::QBusiness
|
|
2895
2975
|
#
|
2896
2976
|
# resp = client.list_retrievers({
|
2897
2977
|
# application_id: "ApplicationId", # required
|
2898
|
-
# max_results: 1,
|
2899
2978
|
# next_token: "NextToken",
|
2979
|
+
# max_results: 1,
|
2900
2980
|
# })
|
2901
2981
|
#
|
2902
2982
|
# @example Response structure
|
2903
2983
|
#
|
2904
|
-
# resp.next_token #=> String
|
2905
2984
|
# resp.retrievers #=> Array
|
2906
2985
|
# resp.retrievers[0].application_id #=> String
|
2907
|
-
# resp.retrievers[0].display_name #=> String
|
2908
2986
|
# resp.retrievers[0].retriever_id #=> String
|
2909
|
-
# resp.retrievers[0].status #=> String, one of "CREATING", "ACTIVE", "FAILED"
|
2910
2987
|
# resp.retrievers[0].type #=> String, one of "NATIVE_INDEX", "KENDRA_INDEX"
|
2988
|
+
# resp.retrievers[0].status #=> String, one of "CREATING", "ACTIVE", "FAILED"
|
2989
|
+
# resp.retrievers[0].display_name #=> String
|
2990
|
+
# resp.next_token #=> String
|
2911
2991
|
#
|
2912
2992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListRetrievers AWS API Documentation
|
2913
2993
|
#
|
@@ -2957,19 +3037,19 @@ module Aws::QBusiness
|
|
2957
3037
|
# The identifier of the Amazon Q Business application linked to the
|
2958
3038
|
# listed web experiences.
|
2959
3039
|
#
|
2960
|
-
# @option params [Integer] :max_results
|
2961
|
-
# The maximum number of Amazon Q Business Web Experiences to return.
|
2962
|
-
#
|
2963
3040
|
# @option params [String] :next_token
|
2964
3041
|
# If the `maxResults` response was incomplete because there is more data
|
2965
3042
|
# to retrieve, Amazon Q Business returns a pagination token in the
|
2966
3043
|
# response. You can use this pagination token to retrieve the next set
|
2967
3044
|
# of Amazon Q Business conversations.
|
2968
3045
|
#
|
3046
|
+
# @option params [Integer] :max_results
|
3047
|
+
# The maximum number of Amazon Q Business Web Experiences to return.
|
3048
|
+
#
|
2969
3049
|
# @return [Types::ListWebExperiencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2970
3050
|
#
|
2971
|
-
# * {Types::ListWebExperiencesResponse#next_token #next_token} => String
|
2972
3051
|
# * {Types::ListWebExperiencesResponse#web_experiences #web_experiences} => Array<Types::WebExperience>
|
3052
|
+
# * {Types::ListWebExperiencesResponse#next_token #next_token} => String
|
2973
3053
|
#
|
2974
3054
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2975
3055
|
#
|
@@ -2977,19 +3057,19 @@ module Aws::QBusiness
|
|
2977
3057
|
#
|
2978
3058
|
# resp = client.list_web_experiences({
|
2979
3059
|
# application_id: "ApplicationId", # required
|
2980
|
-
# max_results: 1,
|
2981
3060
|
# next_token: "NextToken",
|
3061
|
+
# max_results: 1,
|
2982
3062
|
# })
|
2983
3063
|
#
|
2984
3064
|
# @example Response structure
|
2985
3065
|
#
|
2986
|
-
# resp.next_token #=> String
|
2987
3066
|
# resp.web_experiences #=> Array
|
3067
|
+
# resp.web_experiences[0].web_experience_id #=> String
|
2988
3068
|
# resp.web_experiences[0].created_at #=> Time
|
3069
|
+
# resp.web_experiences[0].updated_at #=> Time
|
2989
3070
|
# resp.web_experiences[0].default_endpoint #=> String
|
2990
3071
|
# resp.web_experiences[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "PENDING_AUTH_CONFIG"
|
2991
|
-
# resp.
|
2992
|
-
# resp.web_experiences[0].web_experience_id #=> String
|
3072
|
+
# resp.next_token #=> String
|
2993
3073
|
#
|
2994
3074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListWebExperiences AWS API Documentation
|
2995
3075
|
#
|
@@ -3006,37 +3086,37 @@ module Aws::QBusiness
|
|
3006
3086
|
# @option params [required, String] :application_id
|
3007
3087
|
# The identifier of the application associated with the feedback.
|
3008
3088
|
#
|
3089
|
+
# @option params [String] :user_id
|
3090
|
+
# The identifier of the user giving the feedback.
|
3091
|
+
#
|
3009
3092
|
# @option params [required, String] :conversation_id
|
3010
3093
|
# The identifier of the conversation the feedback is attached to.
|
3011
3094
|
#
|
3012
|
-
# @option params [Time,DateTime,Date,Integer,String] :message_copied_at
|
3013
|
-
# The timestamp for when the feedback was recorded.
|
3014
|
-
#
|
3015
3095
|
# @option params [required, String] :message_id
|
3016
3096
|
# The identifier of the chat message that the feedback was given for.
|
3017
3097
|
#
|
3098
|
+
# @option params [Time,DateTime,Date,Integer,String] :message_copied_at
|
3099
|
+
# The timestamp for when the feedback was recorded.
|
3100
|
+
#
|
3018
3101
|
# @option params [Types::MessageUsefulnessFeedback] :message_usefulness
|
3019
3102
|
# The feedback usefulness value given by the user to the chat message.
|
3020
3103
|
#
|
3021
|
-
# @option params [String] :user_id
|
3022
|
-
# The identifier of the user giving the feedback.
|
3023
|
-
#
|
3024
3104
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3025
3105
|
#
|
3026
3106
|
# @example Request syntax with placeholder values
|
3027
3107
|
#
|
3028
3108
|
# resp = client.put_feedback({
|
3029
3109
|
# application_id: "ApplicationId", # required
|
3110
|
+
# user_id: "UserId",
|
3030
3111
|
# conversation_id: "ConversationId", # required
|
3031
|
-
# message_copied_at: Time.now,
|
3032
3112
|
# message_id: "SystemMessageId", # required
|
3113
|
+
# message_copied_at: Time.now,
|
3033
3114
|
# message_usefulness: {
|
3034
|
-
#
|
3115
|
+
# usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
|
3035
3116
|
# reason: "NOT_FACTUALLY_CORRECT", # accepts NOT_FACTUALLY_CORRECT, HARMFUL_OR_UNSAFE, INCORRECT_OR_MISSING_SOURCES, NOT_HELPFUL, FACTUALLY_CORRECT, COMPLETE, RELEVANT_SOURCES, HELPFUL, NOT_BASED_ON_DOCUMENTS, NOT_COMPLETE, NOT_CONCISE, OTHER
|
3117
|
+
# comment: "MessageUsefulnessComment",
|
3036
3118
|
# submitted_at: Time.now, # required
|
3037
|
-
# usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
|
3038
3119
|
# },
|
3039
|
-
# user_id: "UserId",
|
3040
3120
|
# })
|
3041
3121
|
#
|
3042
3122
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutFeedback AWS API Documentation
|
@@ -3063,20 +3143,9 @@ module Aws::QBusiness
|
|
3063
3143
|
# The identifier of the application in which the user and group mapping
|
3064
3144
|
# belongs.
|
3065
3145
|
#
|
3066
|
-
# @option params [String] :
|
3067
|
-
# The identifier of the
|
3068
|
-
#
|
3069
|
-
# sources, but you only want the group to access documents of a certain
|
3070
|
-
# data source. For example, the groups "Research", "Engineering",
|
3071
|
-
# and "Sales and Marketing" are all tied to the company's documents
|
3072
|
-
# stored in the data sources Confluence and Salesforce. However, "Sales
|
3073
|
-
# and Marketing" team only needs access to customer-related documents
|
3074
|
-
# stored in Salesforce.
|
3075
|
-
#
|
3076
|
-
# @option params [required, Types::GroupMembers] :group_members
|
3077
|
-
# A list of users or sub groups that belong to a group. This is for
|
3078
|
-
# generating Amazon Q Business chat results only from document a user
|
3079
|
-
# has access to.
|
3146
|
+
# @option params [required, String] :index_id
|
3147
|
+
# The identifier of the index in which you want to map users to their
|
3148
|
+
# groups.
|
3080
3149
|
#
|
3081
3150
|
# @option params [required, String] :group_name
|
3082
3151
|
# The list that contains your users or sub groups that belong the same
|
@@ -3090,20 +3159,34 @@ module Aws::QBusiness
|
|
3090
3159
|
# users, but the list of sub groups that belong to a group (and/or
|
3091
3160
|
# users) must be no more than 1000.
|
3092
3161
|
#
|
3093
|
-
# @option params [
|
3094
|
-
# The identifier of the
|
3095
|
-
# groups.
|
3162
|
+
# @option params [String] :data_source_id
|
3163
|
+
# The identifier of the data source for which you want to map users to
|
3164
|
+
# their groups. This is useful if a group is tied to multiple data
|
3165
|
+
# sources, but you only want the group to access documents of a certain
|
3166
|
+
# data source. For example, the groups "Research", "Engineering",
|
3167
|
+
# and "Sales and Marketing" are all tied to the company's documents
|
3168
|
+
# stored in the data sources Confluence and Salesforce. However, "Sales
|
3169
|
+
# and Marketing" team only needs access to customer-related documents
|
3170
|
+
# stored in Salesforce.
|
3096
3171
|
#
|
3097
3172
|
# @option params [required, String] :type
|
3098
3173
|
# The type of the group.
|
3099
3174
|
#
|
3175
|
+
# @option params [required, Types::GroupMembers] :group_members
|
3176
|
+
# A list of users or sub groups that belong to a group. This is for
|
3177
|
+
# generating Amazon Q Business chat results only from document a user
|
3178
|
+
# has access to.
|
3179
|
+
#
|
3100
3180
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3101
3181
|
#
|
3102
3182
|
# @example Request syntax with placeholder values
|
3103
3183
|
#
|
3104
3184
|
# resp = client.put_group({
|
3105
3185
|
# application_id: "ApplicationId", # required
|
3186
|
+
# index_id: "IndexId", # required
|
3187
|
+
# group_name: "GroupName", # required
|
3106
3188
|
# data_source_id: "DataSourceId",
|
3189
|
+
# type: "INDEX", # required, accepts INDEX, DATASOURCE
|
3107
3190
|
# group_members: { # required
|
3108
3191
|
# member_groups: [
|
3109
3192
|
# {
|
@@ -3113,14 +3196,11 @@ module Aws::QBusiness
|
|
3113
3196
|
# ],
|
3114
3197
|
# member_users: [
|
3115
3198
|
# {
|
3116
|
-
# type: "INDEX", # accepts INDEX, DATASOURCE
|
3117
3199
|
# user_id: "DataSourceUserId", # required
|
3200
|
+
# type: "INDEX", # accepts INDEX, DATASOURCE
|
3118
3201
|
# },
|
3119
3202
|
# ],
|
3120
3203
|
# },
|
3121
|
-
# group_name: "GroupName", # required
|
3122
|
-
# index_id: "IndexId", # required
|
3123
|
-
# type: "INDEX", # required, accepts INDEX, DATASOURCE
|
3124
3204
|
# })
|
3125
3205
|
#
|
3126
3206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroup AWS API Documentation
|
@@ -3136,13 +3216,13 @@ module Aws::QBusiness
|
|
3136
3216
|
# synchronization job is already in progress, Amazon Q Business returns
|
3137
3217
|
# a `ConflictException`.
|
3138
3218
|
#
|
3219
|
+
# @option params [required, String] :data_source_id
|
3220
|
+
# The identifier of the data source connector.
|
3221
|
+
#
|
3139
3222
|
# @option params [required, String] :application_id
|
3140
3223
|
# The identifier of Amazon Q Business application the data source is
|
3141
3224
|
# connected to.
|
3142
3225
|
#
|
3143
|
-
# @option params [required, String] :data_source_id
|
3144
|
-
# The identifier of the data source connector.
|
3145
|
-
#
|
3146
3226
|
# @option params [required, String] :index_id
|
3147
3227
|
# The identifier of the index used with the data source connector.
|
3148
3228
|
#
|
@@ -3153,8 +3233,8 @@ module Aws::QBusiness
|
|
3153
3233
|
# @example Request syntax with placeholder values
|
3154
3234
|
#
|
3155
3235
|
# resp = client.start_data_source_sync_job({
|
3156
|
-
# application_id: "ApplicationId", # required
|
3157
3236
|
# data_source_id: "DataSourceId", # required
|
3237
|
+
# application_id: "ApplicationId", # required
|
3158
3238
|
# index_id: "IndexId", # required
|
3159
3239
|
# })
|
3160
3240
|
#
|
@@ -3174,13 +3254,13 @@ module Aws::QBusiness
|
|
3174
3254
|
# Stops an Amazon Q Business data source connector synchronization job
|
3175
3255
|
# already in progress.
|
3176
3256
|
#
|
3257
|
+
# @option params [required, String] :data_source_id
|
3258
|
+
# The identifier of the data source connector.
|
3259
|
+
#
|
3177
3260
|
# @option params [required, String] :application_id
|
3178
3261
|
# The identifier of the Amazon Q Business application that the data
|
3179
3262
|
# source is connected to.
|
3180
3263
|
#
|
3181
|
-
# @option params [required, String] :data_source_id
|
3182
|
-
# The identifier of the data source connector.
|
3183
|
-
#
|
3184
3264
|
# @option params [required, String] :index_id
|
3185
3265
|
# The identifier of the index used with the Amazon Q Business data
|
3186
3266
|
# source connector.
|
@@ -3190,8 +3270,8 @@ module Aws::QBusiness
|
|
3190
3270
|
# @example Request syntax with placeholder values
|
3191
3271
|
#
|
3192
3272
|
# resp = client.stop_data_source_sync_job({
|
3193
|
-
# application_id: "ApplicationId", # required
|
3194
3273
|
# data_source_id: "DataSourceId", # required
|
3274
|
+
# application_id: "ApplicationId", # required
|
3195
3275
|
# index_id: "IndexId", # required
|
3196
3276
|
# })
|
3197
3277
|
#
|
@@ -3274,32 +3354,38 @@ module Aws::QBusiness
|
|
3274
3354
|
# @option params [required, String] :application_id
|
3275
3355
|
# The identifier of the Amazon Q Business application.
|
3276
3356
|
#
|
3277
|
-
# @option params [
|
3278
|
-
#
|
3279
|
-
#
|
3280
|
-
#
|
3281
|
-
# A description for the Amazon Q Business application.
|
3357
|
+
# @option params [String] :identity_center_instance_arn
|
3358
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance you
|
3359
|
+
# are either creating for—or connecting to—your Amazon Q Business
|
3360
|
+
# application.
|
3282
3361
|
#
|
3283
3362
|
# @option params [String] :display_name
|
3284
3363
|
# A name for the Amazon Q Business application.
|
3285
3364
|
#
|
3365
|
+
# @option params [String] :description
|
3366
|
+
# A description for the Amazon Q Business application.
|
3367
|
+
#
|
3286
3368
|
# @option params [String] :role_arn
|
3287
3369
|
# An Amazon Web Services Identity and Access Management (IAM) role that
|
3288
3370
|
# gives Amazon Q Business permission to access Amazon CloudWatch logs
|
3289
3371
|
# and metrics.
|
3290
3372
|
#
|
3373
|
+
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
3374
|
+
# An option to allow end users to upload files directly during chat.
|
3375
|
+
#
|
3291
3376
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3292
3377
|
#
|
3293
3378
|
# @example Request syntax with placeholder values
|
3294
3379
|
#
|
3295
3380
|
# resp = client.update_application({
|
3296
3381
|
# application_id: "ApplicationId", # required
|
3382
|
+
# identity_center_instance_arn: "InstanceArn",
|
3383
|
+
# display_name: "ApplicationName",
|
3384
|
+
# description: "Description",
|
3385
|
+
# role_arn: "RoleArn",
|
3297
3386
|
# attachments_configuration: {
|
3298
3387
|
# attachments_control_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
3299
3388
|
# },
|
3300
|
-
# description: "Description",
|
3301
|
-
# display_name: "ApplicationName",
|
3302
|
-
# role_arn: "RoleArn",
|
3303
3389
|
# })
|
3304
3390
|
#
|
3305
3391
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplication AWS API Documentation
|
@@ -3318,9 +3404,6 @@ module Aws::QBusiness
|
|
3318
3404
|
# The identifier of the application for which the chat controls are
|
3319
3405
|
# configured.
|
3320
3406
|
#
|
3321
|
-
# @option params [Types::BlockedPhrasesConfigurationUpdate] :blocked_phrases_configuration_update
|
3322
|
-
# The phrases blocked from chat by your chat control configuration.
|
3323
|
-
#
|
3324
3407
|
# @option params [String] :client_token
|
3325
3408
|
# A token that you provide to identify the request to update a Amazon Q
|
3326
3409
|
# Business application chat configuration.
|
@@ -3328,9 +3411,6 @@ module Aws::QBusiness
|
|
3328
3411
|
# **A suitable default value is auto-generated.** You should normally
|
3329
3412
|
# not need to pass this option.**
|
3330
3413
|
#
|
3331
|
-
# @option params [Types::CreatorModeConfiguration] :creator_mode_configuration
|
3332
|
-
# The configuration details for `CREATOR_MODE`.
|
3333
|
-
#
|
3334
3414
|
# @option params [String] :response_scope
|
3335
3415
|
# The response scope configured for your application. This determines
|
3336
3416
|
# whether your application uses its retrieval augmented generation (RAG)
|
@@ -3338,43 +3418,47 @@ module Aws::QBusiness
|
|
3338
3418
|
# uses the large language models (LLM) knowledge to respons to end user
|
3339
3419
|
# questions in chat.
|
3340
3420
|
#
|
3421
|
+
# @option params [Types::BlockedPhrasesConfigurationUpdate] :blocked_phrases_configuration_update
|
3422
|
+
# The phrases blocked from chat by your chat control configuration.
|
3423
|
+
#
|
3341
3424
|
# @option params [Array<Types::TopicConfiguration>] :topic_configurations_to_create_or_update
|
3342
3425
|
# The configured topic specific chat controls you want to update.
|
3343
3426
|
#
|
3344
3427
|
# @option params [Array<Types::TopicConfiguration>] :topic_configurations_to_delete
|
3345
3428
|
# The configured topic specific chat controls you want to delete.
|
3346
3429
|
#
|
3430
|
+
# @option params [Types::CreatorModeConfiguration] :creator_mode_configuration
|
3431
|
+
# The configuration details for `CREATOR_MODE`.
|
3432
|
+
#
|
3347
3433
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3348
3434
|
#
|
3349
3435
|
# @example Request syntax with placeholder values
|
3350
3436
|
#
|
3351
3437
|
# resp = client.update_chat_controls_configuration({
|
3352
3438
|
# application_id: "ApplicationId", # required
|
3439
|
+
# client_token: "ClientToken",
|
3440
|
+
# response_scope: "ENTERPRISE_CONTENT_ONLY", # accepts ENTERPRISE_CONTENT_ONLY, EXTENDED_KNOWLEDGE_ENABLED
|
3353
3441
|
# blocked_phrases_configuration_update: {
|
3354
3442
|
# blocked_phrases_to_create_or_update: ["BlockedPhrase"],
|
3355
3443
|
# blocked_phrases_to_delete: ["BlockedPhrase"],
|
3356
3444
|
# system_message_override: "SystemMessageOverride",
|
3357
3445
|
# },
|
3358
|
-
# client_token: "ClientToken",
|
3359
|
-
# creator_mode_configuration: {
|
3360
|
-
# creator_mode_control: "ENABLED", # required, accepts ENABLED, DISABLED
|
3361
|
-
# },
|
3362
|
-
# response_scope: "ENTERPRISE_CONTENT_ONLY", # accepts ENTERPRISE_CONTENT_ONLY, EXTENDED_KNOWLEDGE_ENABLED
|
3363
3446
|
# topic_configurations_to_create_or_update: [
|
3364
3447
|
# {
|
3448
|
+
# name: "TopicConfigurationName", # required
|
3365
3449
|
# description: "TopicDescription",
|
3366
3450
|
# example_chat_messages: ["ExampleChatMessage"],
|
3367
|
-
# name: "TopicConfigurationName", # required
|
3368
3451
|
# rules: [ # required
|
3369
|
-
# {
|
3370
|
-
# excluded_users_and_groups: {
|
3371
|
-
# user_groups: ["String"],
|
3372
|
-
# user_ids: ["String"],
|
3373
|
-
# },
|
3452
|
+
# {
|
3374
3453
|
# included_users_and_groups: {
|
3454
|
+
# user_ids: ["String"],
|
3375
3455
|
# user_groups: ["String"],
|
3456
|
+
# },
|
3457
|
+
# excluded_users_and_groups: {
|
3376
3458
|
# user_ids: ["String"],
|
3459
|
+
# user_groups: ["String"],
|
3377
3460
|
# },
|
3461
|
+
# rule_type: "CONTENT_BLOCKER_RULE", # required, accepts CONTENT_BLOCKER_RULE, CONTENT_RETRIEVAL_RULE
|
3378
3462
|
# rule_configuration: {
|
3379
3463
|
# content_blocker_rule: {
|
3380
3464
|
# system_message_override: "SystemMessageOverride",
|
@@ -3382,32 +3466,32 @@ module Aws::QBusiness
|
|
3382
3466
|
# content_retrieval_rule: {
|
3383
3467
|
# eligible_data_sources: [
|
3384
3468
|
# {
|
3385
|
-
# data_source_id: "DataSourceId",
|
3386
3469
|
# index_id: "IndexId",
|
3470
|
+
# data_source_id: "DataSourceId",
|
3387
3471
|
# },
|
3388
3472
|
# ],
|
3389
3473
|
# },
|
3390
3474
|
# },
|
3391
|
-
# rule_type: "CONTENT_BLOCKER_RULE", # required, accepts CONTENT_BLOCKER_RULE, CONTENT_RETRIEVAL_RULE
|
3392
3475
|
# },
|
3393
3476
|
# ],
|
3394
3477
|
# },
|
3395
3478
|
# ],
|
3396
3479
|
# topic_configurations_to_delete: [
|
3397
3480
|
# {
|
3481
|
+
# name: "TopicConfigurationName", # required
|
3398
3482
|
# description: "TopicDescription",
|
3399
3483
|
# example_chat_messages: ["ExampleChatMessage"],
|
3400
|
-
# name: "TopicConfigurationName", # required
|
3401
3484
|
# rules: [ # required
|
3402
3485
|
# {
|
3403
|
-
# excluded_users_and_groups: {
|
3404
|
-
# user_groups: ["String"],
|
3405
|
-
# user_ids: ["String"],
|
3406
|
-
# },
|
3407
3486
|
# included_users_and_groups: {
|
3487
|
+
# user_ids: ["String"],
|
3408
3488
|
# user_groups: ["String"],
|
3489
|
+
# },
|
3490
|
+
# excluded_users_and_groups: {
|
3409
3491
|
# user_ids: ["String"],
|
3492
|
+
# user_groups: ["String"],
|
3410
3493
|
# },
|
3494
|
+
# rule_type: "CONTENT_BLOCKER_RULE", # required, accepts CONTENT_BLOCKER_RULE, CONTENT_RETRIEVAL_RULE
|
3411
3495
|
# rule_configuration: {
|
3412
3496
|
# content_blocker_rule: {
|
3413
3497
|
# system_message_override: "SystemMessageOverride",
|
@@ -3415,17 +3499,19 @@ module Aws::QBusiness
|
|
3415
3499
|
# content_retrieval_rule: {
|
3416
3500
|
# eligible_data_sources: [
|
3417
3501
|
# {
|
3418
|
-
# data_source_id: "DataSourceId",
|
3419
3502
|
# index_id: "IndexId",
|
3503
|
+
# data_source_id: "DataSourceId",
|
3420
3504
|
# },
|
3421
3505
|
# ],
|
3422
3506
|
# },
|
3423
3507
|
# },
|
3424
|
-
# rule_type: "CONTENT_BLOCKER_RULE", # required, accepts CONTENT_BLOCKER_RULE, CONTENT_RETRIEVAL_RULE
|
3425
3508
|
# },
|
3426
3509
|
# ],
|
3427
3510
|
# },
|
3428
3511
|
# ],
|
3512
|
+
# creator_mode_configuration: {
|
3513
|
+
# creator_mode_control: "ENABLED", # required, accepts ENABLED, DISABLED
|
3514
|
+
# },
|
3429
3515
|
# })
|
3430
3516
|
#
|
3431
3517
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatControlsConfiguration AWS API Documentation
|
@@ -3443,6 +3529,15 @@ module Aws::QBusiness
|
|
3443
3529
|
# The identifier of the Amazon Q Business application the data source is
|
3444
3530
|
# attached to.
|
3445
3531
|
#
|
3532
|
+
# @option params [required, String] :index_id
|
3533
|
+
# The identifier of the index attached to the data source connector.
|
3534
|
+
#
|
3535
|
+
# @option params [required, String] :data_source_id
|
3536
|
+
# The identifier of the data source connector.
|
3537
|
+
#
|
3538
|
+
# @option params [String] :display_name
|
3539
|
+
# A name of the data source connector.
|
3540
|
+
#
|
3446
3541
|
# @option params [Hash,Array,String,Numeric,Boolean] :configuration
|
3447
3542
|
# Provides the configuration information for an Amazon Q Business data
|
3448
3543
|
# source.
|
@@ -3452,14 +3547,19 @@ module Aws::QBusiness
|
|
3452
3547
|
# serialized using the same format as its surroundings and requires no
|
3453
3548
|
# additional encoding or escaping.
|
3454
3549
|
#
|
3455
|
-
# @option params [
|
3456
|
-
#
|
3550
|
+
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
3551
|
+
# Provides configuration information needed to connect to an Amazon VPC
|
3552
|
+
# (Virtual Private Cloud).
|
3457
3553
|
#
|
3458
3554
|
# @option params [String] :description
|
3459
3555
|
# The description of the data source connector.
|
3460
3556
|
#
|
3461
|
-
# @option params [String] :
|
3462
|
-
#
|
3557
|
+
# @option params [String] :sync_schedule
|
3558
|
+
# The chosen update frequency for your data source.
|
3559
|
+
#
|
3560
|
+
# @option params [String] :role_arn
|
3561
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
3562
|
+
# access the data source and required resources.
|
3463
3563
|
#
|
3464
3564
|
# @option params [Types::DocumentEnrichmentConfiguration] :document_enrichment_configuration
|
3465
3565
|
# Provides the configuration information for altering document metadata
|
@@ -3471,31 +3571,24 @@ module Aws::QBusiness
|
|
3471
3571
|
#
|
3472
3572
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
3473
3573
|
#
|
3474
|
-
# @option params [required, String] :index_id
|
3475
|
-
# The identifier of the index attached to the data source connector.
|
3476
|
-
#
|
3477
|
-
# @option params [String] :role_arn
|
3478
|
-
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
3479
|
-
# access the data source and required resources.
|
3480
|
-
#
|
3481
|
-
# @option params [String] :sync_schedule
|
3482
|
-
# The chosen update frequency for your data source.
|
3483
|
-
#
|
3484
|
-
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
3485
|
-
# Provides configuration information needed to connect to an Amazon VPC
|
3486
|
-
# (Virtual Private Cloud).
|
3487
|
-
#
|
3488
3574
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3489
3575
|
#
|
3490
3576
|
# @example Request syntax with placeholder values
|
3491
3577
|
#
|
3492
3578
|
# resp = client.update_data_source({
|
3493
3579
|
# application_id: "ApplicationId", # required
|
3580
|
+
# index_id: "IndexId", # required
|
3581
|
+
# data_source_id: "DataSourceId", # required
|
3582
|
+
# display_name: "DataSourceName",
|
3494
3583
|
# configuration: {
|
3495
3584
|
# },
|
3496
|
-
#
|
3585
|
+
# vpc_configuration: {
|
3586
|
+
# subnet_ids: ["SubnetId"], # required
|
3587
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
3588
|
+
# },
|
3497
3589
|
# description: "Description",
|
3498
|
-
#
|
3590
|
+
# sync_schedule: "SyncSchedule",
|
3591
|
+
# role_arn: "RoleArn",
|
3499
3592
|
# document_enrichment_configuration: {
|
3500
3593
|
# inline_configurations: [
|
3501
3594
|
# {
|
@@ -3503,63 +3596,56 @@ module Aws::QBusiness
|
|
3503
3596
|
# key: "DocumentAttributeKey", # required
|
3504
3597
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
3505
3598
|
# value: {
|
3506
|
-
# date_value: Time.now,
|
3507
|
-
# long_value: 1,
|
3508
|
-
# string_list_value: ["String"],
|
3509
3599
|
# string_value: "DocumentAttributeValueStringValueString",
|
3600
|
+
# string_list_value: ["String"],
|
3601
|
+
# long_value: 1,
|
3602
|
+
# date_value: Time.now,
|
3510
3603
|
# },
|
3511
3604
|
# },
|
3512
|
-
# document_content_operator: "DELETE", # accepts DELETE
|
3513
3605
|
# target: {
|
3514
|
-
# attribute_value_operator: "DELETE", # accepts DELETE
|
3515
3606
|
# key: "DocumentAttributeKey", # required
|
3516
3607
|
# value: {
|
3517
|
-
# date_value: Time.now,
|
3518
|
-
# long_value: 1,
|
3519
|
-
# string_list_value: ["String"],
|
3520
3608
|
# string_value: "DocumentAttributeValueStringValueString",
|
3609
|
+
# string_list_value: ["String"],
|
3610
|
+
# long_value: 1,
|
3611
|
+
# date_value: Time.now,
|
3521
3612
|
# },
|
3613
|
+
# attribute_value_operator: "DELETE", # accepts DELETE
|
3522
3614
|
# },
|
3615
|
+
# document_content_operator: "DELETE", # accepts DELETE
|
3523
3616
|
# },
|
3524
3617
|
# ],
|
3525
|
-
#
|
3618
|
+
# pre_extraction_hook_configuration: {
|
3526
3619
|
# invocation_condition: {
|
3527
3620
|
# key: "DocumentAttributeKey", # required
|
3528
3621
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
3529
3622
|
# value: {
|
3530
|
-
# date_value: Time.now,
|
3531
|
-
# long_value: 1,
|
3532
|
-
# string_list_value: ["String"],
|
3533
3623
|
# string_value: "DocumentAttributeValueStringValueString",
|
3624
|
+
# string_list_value: ["String"],
|
3625
|
+
# long_value: 1,
|
3626
|
+
# date_value: Time.now,
|
3534
3627
|
# },
|
3535
3628
|
# },
|
3536
3629
|
# lambda_arn: "LambdaArn",
|
3537
|
-
# role_arn: "RoleArn",
|
3538
3630
|
# s3_bucket_name: "S3BucketName",
|
3631
|
+
# role_arn: "RoleArn",
|
3539
3632
|
# },
|
3540
|
-
#
|
3633
|
+
# post_extraction_hook_configuration: {
|
3541
3634
|
# invocation_condition: {
|
3542
3635
|
# key: "DocumentAttributeKey", # required
|
3543
3636
|
# operator: "GREATER_THAN", # required, accepts GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, EXISTS, NOT_EXISTS, BEGINS_WITH
|
3544
3637
|
# value: {
|
3545
|
-
# date_value: Time.now,
|
3546
|
-
# long_value: 1,
|
3547
|
-
# string_list_value: ["String"],
|
3548
3638
|
# string_value: "DocumentAttributeValueStringValueString",
|
3639
|
+
# string_list_value: ["String"],
|
3640
|
+
# long_value: 1,
|
3641
|
+
# date_value: Time.now,
|
3549
3642
|
# },
|
3550
3643
|
# },
|
3551
3644
|
# lambda_arn: "LambdaArn",
|
3552
|
-
# role_arn: "RoleArn",
|
3553
3645
|
# s3_bucket_name: "S3BucketName",
|
3646
|
+
# role_arn: "RoleArn",
|
3554
3647
|
# },
|
3555
3648
|
# },
|
3556
|
-
# index_id: "IndexId", # required
|
3557
|
-
# role_arn: "RoleArn",
|
3558
|
-
# sync_schedule: "SyncSchedule",
|
3559
|
-
# vpc_configuration: {
|
3560
|
-
# security_group_ids: ["SecurityGroupId"], # required
|
3561
|
-
# subnet_ids: ["SubnetId"], # required
|
3562
|
-
# },
|
3563
3649
|
# })
|
3564
3650
|
#
|
3565
3651
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSource AWS API Documentation
|
@@ -3577,16 +3663,19 @@ module Aws::QBusiness
|
|
3577
3663
|
# The identifier of the Amazon Q Business application connected to the
|
3578
3664
|
# index.
|
3579
3665
|
#
|
3580
|
-
# @option params [
|
3581
|
-
# The
|
3582
|
-
#
|
3583
|
-
#
|
3666
|
+
# @option params [required, String] :index_id
|
3667
|
+
# The identifier of the Amazon Q Business index.
|
3668
|
+
#
|
3669
|
+
# @option params [String] :display_name
|
3670
|
+
# The name of the Amazon Q Business index.
|
3584
3671
|
#
|
3585
3672
|
# @option params [String] :description
|
3586
3673
|
# The description of the Amazon Q Business index.
|
3587
3674
|
#
|
3588
|
-
# @option params [
|
3589
|
-
# The
|
3675
|
+
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
3676
|
+
# The storage capacity units you want to provision for your Amazon Q
|
3677
|
+
# Business index. You can add and remove capacity to fit your usage
|
3678
|
+
# needs.
|
3590
3679
|
#
|
3591
3680
|
# @option params [Array<Types::DocumentAttributeConfiguration>] :document_attribute_configurations
|
3592
3681
|
# Configuration information for document metadata or fields. Document
|
@@ -3598,28 +3687,25 @@ module Aws::QBusiness
|
|
3598
3687
|
#
|
3599
3688
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes
|
3600
3689
|
#
|
3601
|
-
# @option params [required, String] :index_id
|
3602
|
-
# The identifier of the Amazon Q Business index.
|
3603
|
-
#
|
3604
3690
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3605
3691
|
#
|
3606
3692
|
# @example Request syntax with placeholder values
|
3607
3693
|
#
|
3608
3694
|
# resp = client.update_index({
|
3609
3695
|
# application_id: "ApplicationId", # required
|
3696
|
+
# index_id: "IndexId", # required
|
3697
|
+
# display_name: "ApplicationName",
|
3698
|
+
# description: "Description",
|
3610
3699
|
# capacity_configuration: {
|
3611
3700
|
# units: 1,
|
3612
3701
|
# },
|
3613
|
-
# description: "Description",
|
3614
|
-
# display_name: "ApplicationName",
|
3615
3702
|
# document_attribute_configurations: [
|
3616
3703
|
# {
|
3617
|
-
# name: "
|
3618
|
-
# search: "ENABLED", # accepts ENABLED, DISABLED
|
3704
|
+
# name: "DocumentMetadataConfigurationName",
|
3619
3705
|
# type: "STRING", # accepts STRING, STRING_LIST, NUMBER, DATE
|
3706
|
+
# search: "ENABLED", # accepts ENABLED, DISABLED
|
3620
3707
|
# },
|
3621
3708
|
# ],
|
3622
|
-
# index_id: "IndexId", # required
|
3623
3709
|
# })
|
3624
3710
|
#
|
3625
3711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndex AWS API Documentation
|
@@ -3636,20 +3722,23 @@ module Aws::QBusiness
|
|
3636
3722
|
# @option params [required, String] :application_id
|
3637
3723
|
# The identifier of the application the plugin is attached to.
|
3638
3724
|
#
|
3639
|
-
# @option params [
|
3640
|
-
# The
|
3725
|
+
# @option params [required, String] :plugin_id
|
3726
|
+
# The identifier of the plugin.
|
3641
3727
|
#
|
3642
3728
|
# @option params [String] :display_name
|
3643
3729
|
# The name of the plugin.
|
3644
3730
|
#
|
3645
|
-
# @option params [
|
3646
|
-
# The
|
3731
|
+
# @option params [String] :state
|
3732
|
+
# The status of the plugin.
|
3647
3733
|
#
|
3648
3734
|
# @option params [String] :server_url
|
3649
3735
|
# The source URL used for plugin configuration.
|
3650
3736
|
#
|
3651
|
-
# @option params [
|
3652
|
-
# The
|
3737
|
+
# @option params [Types::CustomPluginConfiguration] :custom_plugin_configuration
|
3738
|
+
# The configuration for a custom plugin.
|
3739
|
+
#
|
3740
|
+
# @option params [Types::PluginAuthConfiguration] :auth_configuration
|
3741
|
+
# The authentication configuration the plugin is using.
|
3653
3742
|
#
|
3654
3743
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3655
3744
|
#
|
@@ -3657,20 +3746,33 @@ module Aws::QBusiness
|
|
3657
3746
|
#
|
3658
3747
|
# resp = client.update_plugin({
|
3659
3748
|
# application_id: "ApplicationId", # required
|
3749
|
+
# plugin_id: "PluginId", # required
|
3750
|
+
# display_name: "PluginName",
|
3751
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3752
|
+
# server_url: "Url",
|
3753
|
+
# custom_plugin_configuration: {
|
3754
|
+
# description: "PluginDescription", # required
|
3755
|
+
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
3756
|
+
# api_schema: { # required
|
3757
|
+
# payload: "Payload",
|
3758
|
+
# s3: {
|
3759
|
+
# bucket: "S3BucketName", # required
|
3760
|
+
# key: "S3ObjectKey", # required
|
3761
|
+
# },
|
3762
|
+
# },
|
3763
|
+
# },
|
3660
3764
|
# auth_configuration: {
|
3661
3765
|
# basic_auth_configuration: {
|
3662
|
-
# role_arn: "RoleArn", # required
|
3663
3766
|
# secret_arn: "SecretArn", # required
|
3767
|
+
# role_arn: "RoleArn", # required
|
3664
3768
|
# },
|
3665
3769
|
# o_auth_2_client_credential_configuration: {
|
3666
|
-
# role_arn: "RoleArn", # required
|
3667
3770
|
# secret_arn: "SecretArn", # required
|
3771
|
+
# role_arn: "RoleArn", # required
|
3772
|
+
# },
|
3773
|
+
# no_auth_configuration: {
|
3668
3774
|
# },
|
3669
3775
|
# },
|
3670
|
-
# display_name: "PluginName",
|
3671
|
-
# plugin_id: "PluginId", # required
|
3672
|
-
# server_url: "Url",
|
3673
|
-
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3674
3776
|
# })
|
3675
3777
|
#
|
3676
3778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdatePlugin AWS API Documentation
|
@@ -3687,6 +3789,9 @@ module Aws::QBusiness
|
|
3687
3789
|
# @option params [required, String] :application_id
|
3688
3790
|
# The identifier of your Amazon Q Business application.
|
3689
3791
|
#
|
3792
|
+
# @option params [required, String] :retriever_id
|
3793
|
+
# The identifier of your retriever.
|
3794
|
+
#
|
3690
3795
|
# @option params [Types::RetrieverConfiguration] :configuration
|
3691
3796
|
# Provides information on how the retriever used for your Amazon Q
|
3692
3797
|
# Business application is configured.
|
@@ -3694,9 +3799,6 @@ module Aws::QBusiness
|
|
3694
3799
|
# @option params [String] :display_name
|
3695
3800
|
# The name of your retriever.
|
3696
3801
|
#
|
3697
|
-
# @option params [required, String] :retriever_id
|
3698
|
-
# The identifier of your retriever.
|
3699
|
-
#
|
3700
3802
|
# @option params [String] :role_arn
|
3701
3803
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
3702
3804
|
# access the retriever and required resources.
|
@@ -3707,37 +3809,37 @@ module Aws::QBusiness
|
|
3707
3809
|
#
|
3708
3810
|
# resp = client.update_retriever({
|
3709
3811
|
# application_id: "ApplicationId", # required
|
3812
|
+
# retriever_id: "RetrieverId", # required
|
3710
3813
|
# configuration: {
|
3711
|
-
# kendra_index_configuration: {
|
3712
|
-
# index_id: "KendraIndexId", # required
|
3713
|
-
# },
|
3714
3814
|
# native_index_configuration: {
|
3815
|
+
# index_id: "IndexId", # required
|
3715
3816
|
# boosting_override: {
|
3716
3817
|
# "DocumentAttributeKey" => {
|
3717
|
-
# date_configuration: {
|
3718
|
-
# boosting_duration_in_seconds: 1,
|
3719
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3720
|
-
# },
|
3721
3818
|
# number_configuration: {
|
3722
3819
|
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3723
3820
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
3724
3821
|
# },
|
3725
3822
|
# string_configuration: {
|
3823
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3726
3824
|
# attribute_value_boosting: {
|
3727
3825
|
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
3728
3826
|
# },
|
3827
|
+
# },
|
3828
|
+
# date_configuration: {
|
3729
3829
|
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3830
|
+
# boosting_duration_in_seconds: 1,
|
3730
3831
|
# },
|
3731
3832
|
# string_list_configuration: {
|
3732
3833
|
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3733
3834
|
# },
|
3734
3835
|
# },
|
3735
3836
|
# },
|
3736
|
-
#
|
3837
|
+
# },
|
3838
|
+
# kendra_index_configuration: {
|
3839
|
+
# index_id: "KendraIndexId", # required
|
3737
3840
|
# },
|
3738
3841
|
# },
|
3739
3842
|
# display_name: "RetrieverName",
|
3740
|
-
# retriever_id: "RetrieverId", # required
|
3741
3843
|
# role_arn: "RoleArn",
|
3742
3844
|
# })
|
3743
3845
|
#
|
@@ -3755,56 +3857,56 @@ module Aws::QBusiness
|
|
3755
3857
|
# @option params [required, String] :application_id
|
3756
3858
|
# The identifier of the application the user is attached to.
|
3757
3859
|
#
|
3758
|
-
# @option params [
|
3759
|
-
# The
|
3860
|
+
# @option params [required, String] :user_id
|
3861
|
+
# The email id attached to the user.
|
3760
3862
|
#
|
3761
3863
|
# @option params [Array<Types::UserAlias>] :user_aliases_to_update
|
3762
3864
|
# The user aliases attached to the user id that are to be updated.
|
3763
3865
|
#
|
3764
|
-
# @option params [
|
3765
|
-
# The
|
3866
|
+
# @option params [Array<Types::UserAlias>] :user_aliases_to_delete
|
3867
|
+
# The user aliases attached to the user id that are to be deleted.
|
3766
3868
|
#
|
3767
3869
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3768
3870
|
#
|
3769
3871
|
# * {Types::UpdateUserResponse#user_aliases_added #user_aliases_added} => Array<Types::UserAlias>
|
3770
|
-
# * {Types::UpdateUserResponse#user_aliases_deleted #user_aliases_deleted} => Array<Types::UserAlias>
|
3771
3872
|
# * {Types::UpdateUserResponse#user_aliases_updated #user_aliases_updated} => Array<Types::UserAlias>
|
3873
|
+
# * {Types::UpdateUserResponse#user_aliases_deleted #user_aliases_deleted} => Array<Types::UserAlias>
|
3772
3874
|
#
|
3773
3875
|
# @example Request syntax with placeholder values
|
3774
3876
|
#
|
3775
3877
|
# resp = client.update_user({
|
3776
3878
|
# application_id: "ApplicationId", # required
|
3777
|
-
#
|
3879
|
+
# user_id: "String", # required
|
3880
|
+
# user_aliases_to_update: [
|
3778
3881
|
# {
|
3779
|
-
# data_source_id: "DataSourceId",
|
3780
3882
|
# index_id: "IndexId",
|
3883
|
+
# data_source_id: "DataSourceId",
|
3781
3884
|
# user_id: "String", # required
|
3782
3885
|
# },
|
3783
3886
|
# ],
|
3784
|
-
#
|
3887
|
+
# user_aliases_to_delete: [
|
3785
3888
|
# {
|
3786
|
-
# data_source_id: "DataSourceId",
|
3787
3889
|
# index_id: "IndexId",
|
3890
|
+
# data_source_id: "DataSourceId",
|
3788
3891
|
# user_id: "String", # required
|
3789
3892
|
# },
|
3790
3893
|
# ],
|
3791
|
-
# user_id: "String", # required
|
3792
3894
|
# })
|
3793
3895
|
#
|
3794
3896
|
# @example Response structure
|
3795
3897
|
#
|
3796
3898
|
# resp.user_aliases_added #=> Array
|
3797
|
-
# resp.user_aliases_added[0].data_source_id #=> String
|
3798
3899
|
# resp.user_aliases_added[0].index_id #=> String
|
3900
|
+
# resp.user_aliases_added[0].data_source_id #=> String
|
3799
3901
|
# resp.user_aliases_added[0].user_id #=> String
|
3800
|
-
# resp.user_aliases_deleted #=> Array
|
3801
|
-
# resp.user_aliases_deleted[0].data_source_id #=> String
|
3802
|
-
# resp.user_aliases_deleted[0].index_id #=> String
|
3803
|
-
# resp.user_aliases_deleted[0].user_id #=> String
|
3804
3902
|
# resp.user_aliases_updated #=> Array
|
3805
|
-
# resp.user_aliases_updated[0].data_source_id #=> String
|
3806
3903
|
# resp.user_aliases_updated[0].index_id #=> String
|
3904
|
+
# resp.user_aliases_updated[0].data_source_id #=> String
|
3807
3905
|
# resp.user_aliases_updated[0].user_id #=> String
|
3906
|
+
# resp.user_aliases_deleted #=> Array
|
3907
|
+
# resp.user_aliases_deleted[0].index_id #=> String
|
3908
|
+
# resp.user_aliases_deleted[0].data_source_id #=> String
|
3909
|
+
# resp.user_aliases_deleted[0].user_id #=> String
|
3808
3910
|
#
|
3809
3911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateUser AWS API Documentation
|
3810
3912
|
#
|
@@ -3821,46 +3923,51 @@ module Aws::QBusiness
|
|
3821
3923
|
# The identifier of the Amazon Q Business application attached to the
|
3822
3924
|
# web experience.
|
3823
3925
|
#
|
3926
|
+
# @option params [required, String] :web_experience_id
|
3927
|
+
# The identifier of the Amazon Q Business web experience.
|
3928
|
+
#
|
3929
|
+
# @option params [String] :role_arn
|
3930
|
+
# The Amazon Resource Name (ARN) of the role with permission to access
|
3931
|
+
# the Amazon Q Business web experience and required resources.
|
3932
|
+
#
|
3824
3933
|
# @option params [Types::WebExperienceAuthConfiguration] :authentication_configuration
|
3825
3934
|
# The authentication configuration of the Amazon Q Business web
|
3826
3935
|
# experience.
|
3827
3936
|
#
|
3828
|
-
# @option params [String] :sample_prompts_control_mode
|
3829
|
-
# Determines whether sample prompts are enabled in the web experience
|
3830
|
-
# for an end user.
|
3831
|
-
#
|
3832
|
-
# @option params [String] :subtitle
|
3833
|
-
# The subtitle of the Amazon Q Business web experience.
|
3834
|
-
#
|
3835
3937
|
# @option params [String] :title
|
3836
3938
|
# The title of the Amazon Q Business web experience.
|
3837
3939
|
#
|
3838
|
-
# @option params [
|
3839
|
-
# The
|
3940
|
+
# @option params [String] :subtitle
|
3941
|
+
# The subtitle of the Amazon Q Business web experience.
|
3840
3942
|
#
|
3841
3943
|
# @option params [String] :welcome_message
|
3842
3944
|
# A customized welcome message for an end user in an Amazon Q Business
|
3843
3945
|
# web experience.
|
3844
3946
|
#
|
3947
|
+
# @option params [String] :sample_prompts_control_mode
|
3948
|
+
# Determines whether sample prompts are enabled in the web experience
|
3949
|
+
# for an end user.
|
3950
|
+
#
|
3845
3951
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3846
3952
|
#
|
3847
3953
|
# @example Request syntax with placeholder values
|
3848
3954
|
#
|
3849
3955
|
# resp = client.update_web_experience({
|
3850
3956
|
# application_id: "ApplicationId", # required
|
3957
|
+
# web_experience_id: "WebExperienceId", # required
|
3958
|
+
# role_arn: "RoleArn",
|
3851
3959
|
# authentication_configuration: {
|
3852
3960
|
# saml_configuration: {
|
3853
3961
|
# metadata_xml: "SamlMetadataXML", # required
|
3854
3962
|
# role_arn: "RoleArn", # required
|
3855
|
-
# user_group_attribute: "SamlAttribute",
|
3856
3963
|
# user_id_attribute: "SamlAttribute", # required
|
3964
|
+
# user_group_attribute: "SamlAttribute",
|
3857
3965
|
# },
|
3858
3966
|
# },
|
3859
|
-
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
3860
|
-
# subtitle: "WebExperienceSubtitle",
|
3861
3967
|
# title: "WebExperienceTitle",
|
3862
|
-
#
|
3968
|
+
# subtitle: "WebExperienceSubtitle",
|
3863
3969
|
# welcome_message: "WebExperienceWelcomeMessage",
|
3970
|
+
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
3864
3971
|
# })
|
3865
3972
|
#
|
3866
3973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience AWS API Documentation
|
@@ -3885,7 +3992,7 @@ module Aws::QBusiness
|
|
3885
3992
|
params: params,
|
3886
3993
|
config: config)
|
3887
3994
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
3888
|
-
context[:gem_version] = '1.
|
3995
|
+
context[:gem_version] = '1.5.0'
|
3889
3996
|
Seahorse::Client::Request.new(handlers, context)
|
3890
3997
|
end
|
3891
3998
|
|