aws-sdk-qbusiness 1.3.0 → 1.5.0

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