aws-sdk 2.1609.0 → 2.1610.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/apis/chime-sdk-voice-2022-08-03.min.json +6 -2
- package/apis/fms-2018-01-01.min.json +59 -58
- package/apis/omics-2022-11-28.min.json +36 -22
- package/apis/opensearch-2021-01-01.min.json +93 -92
- package/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +521 -99
- package/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +6 -0
- package/apis/qbusiness-2023-11-27.examples.json +2 -3
- package/apis/qbusiness-2023-11-27.min.json +778 -693
- package/apis/qbusiness-2023-11-27.paginators.json +1 -1
- package/apis/qbusiness-2023-11-27.waiters2.json +5 -0
- package/apis/quicksight-2018-04-01.min.json +557 -494
- package/apis/route53resolver-2018-04-01.min.json +58 -52
- package/apis/sagemaker-2017-07-24.min.json +330 -319
- package/apis/signer-2017-08-25.min.json +3 -0
- package/clients/chimesdkvoice.d.ts +9 -9
- package/clients/codeartifact.d.ts +27 -27
- package/clients/fms.d.ts +8 -3
- package/clients/omics.d.ts +89 -53
- package/clients/opensearch.d.ts +8 -3
- package/clients/pinpointsmsvoicev2.d.ts +514 -8
- package/clients/qbusiness.d.ts +818 -700
- package/clients/qbusiness.js +1 -0
- package/clients/quicksight.d.ts +91 -12
- package/clients/route53resolver.d.ts +18 -5
- package/clients/sagemaker.d.ts +12 -1
- package/clients/signer.d.ts +3 -3
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +100 -93
- package/dist/aws-sdk.js +3 -3
- package/dist/aws-sdk.min.js +2 -2
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/qbusiness.d.ts
CHANGED
@@ -36,11 +36,11 @@ declare class QBusiness extends Service {
|
|
36
36
|
*/
|
37
37
|
chatSync(callback?: (err: AWSError, data: QBusiness.Types.ChatSyncOutput) => void): Request<QBusiness.Types.ChatSyncOutput, AWSError>;
|
38
38
|
/**
|
39
|
-
* Creates an Amazon Q Business application.
|
39
|
+
* Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
|
40
40
|
*/
|
41
41
|
createApplication(params: QBusiness.Types.CreateApplicationRequest, callback?: (err: AWSError, data: QBusiness.Types.CreateApplicationResponse) => void): Request<QBusiness.Types.CreateApplicationResponse, AWSError>;
|
42
42
|
/**
|
43
|
-
* Creates an Amazon Q Business application.
|
43
|
+
* Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
|
44
44
|
*/
|
45
45
|
createApplication(callback?: (err: AWSError, data: QBusiness.Types.CreateApplicationResponse) => void): Request<QBusiness.Types.CreateApplicationResponse, AWSError>;
|
46
46
|
/**
|
@@ -453,6 +453,17 @@ declare class QBusiness extends Service {
|
|
453
453
|
updateWebExperience(callback?: (err: AWSError, data: QBusiness.Types.UpdateWebExperienceResponse) => void): Request<QBusiness.Types.UpdateWebExperienceResponse, AWSError>;
|
454
454
|
}
|
455
455
|
declare namespace QBusiness {
|
456
|
+
export interface APISchema {
|
457
|
+
/**
|
458
|
+
* The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
|
459
|
+
*/
|
460
|
+
payload?: Payload;
|
461
|
+
/**
|
462
|
+
* Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
|
463
|
+
*/
|
464
|
+
s3?: S3;
|
465
|
+
}
|
466
|
+
export type APISchemaType = "OPEN_API_V3"|string;
|
456
467
|
export interface AccessConfiguration {
|
457
468
|
/**
|
458
469
|
* A list of AccessControlList objects.
|
@@ -464,17 +475,21 @@ declare namespace QBusiness {
|
|
464
475
|
memberRelation?: MemberRelation;
|
465
476
|
}
|
466
477
|
export interface AccessControl {
|
467
|
-
/**
|
468
|
-
* Describes the member relation within a principal list.
|
469
|
-
*/
|
470
|
-
memberRelation?: MemberRelation;
|
471
478
|
/**
|
472
479
|
* Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.
|
473
480
|
*/
|
474
481
|
principals: Principals;
|
482
|
+
/**
|
483
|
+
* Describes the member relation within a principal list.
|
484
|
+
*/
|
485
|
+
memberRelation?: MemberRelation;
|
475
486
|
}
|
476
487
|
export type AccessControls = AccessControl[];
|
477
488
|
export interface ActionExecution {
|
489
|
+
/**
|
490
|
+
* The identifier of the plugin the action is attached to.
|
491
|
+
*/
|
492
|
+
pluginId: PluginId;
|
478
493
|
/**
|
479
494
|
* A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
|
480
495
|
*/
|
@@ -483,10 +498,6 @@ declare namespace QBusiness {
|
|
483
498
|
* A string used to retain information about the hierarchical contexts within an action execution event payload.
|
484
499
|
*/
|
485
500
|
payloadFieldNameSeparator: ActionPayloadFieldNameSeparator;
|
486
|
-
/**
|
487
|
-
* The identifier of the plugin the action is attached to.
|
488
|
-
*/
|
489
|
-
pluginId: PluginId;
|
490
501
|
}
|
491
502
|
export type ActionExecutionPayload = {[key: string]: ActionExecutionPayloadField};
|
492
503
|
export interface ActionExecutionPayloadField {
|
@@ -501,14 +512,6 @@ declare namespace QBusiness {
|
|
501
512
|
export interface ActionPayloadFieldValue {
|
502
513
|
}
|
503
514
|
export interface ActionReview {
|
504
|
-
/**
|
505
|
-
* Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
|
506
|
-
*/
|
507
|
-
payload?: ActionReviewPayload;
|
508
|
-
/**
|
509
|
-
* A string used to retain information about the hierarchical contexts within an action review payload.
|
510
|
-
*/
|
511
|
-
payloadFieldNameSeparator?: ActionPayloadFieldNameSeparator;
|
512
515
|
/**
|
513
516
|
* The identifier of the plugin associated with the action review.
|
514
517
|
*/
|
@@ -517,13 +520,17 @@ declare namespace QBusiness {
|
|
517
520
|
* The type of plugin.
|
518
521
|
*/
|
519
522
|
pluginType?: PluginType;
|
523
|
+
/**
|
524
|
+
* Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
|
525
|
+
*/
|
526
|
+
payload?: ActionReviewPayload;
|
527
|
+
/**
|
528
|
+
* A string used to retain information about the hierarchical contexts within an action review payload.
|
529
|
+
*/
|
530
|
+
payloadFieldNameSeparator?: ActionPayloadFieldNameSeparator;
|
520
531
|
}
|
521
532
|
export type ActionReviewPayload = {[key: string]: ActionReviewPayloadField};
|
522
533
|
export interface ActionReviewPayloadField {
|
523
|
-
/**
|
524
|
-
* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
|
525
|
-
*/
|
526
|
-
allowedValues?: ActionReviewPayloadFieldAllowedValues;
|
527
534
|
/**
|
528
535
|
* The name of the field.
|
529
536
|
*/
|
@@ -533,9 +540,9 @@ declare namespace QBusiness {
|
|
533
540
|
*/
|
534
541
|
displayOrder?: Integer;
|
535
542
|
/**
|
536
|
-
*
|
543
|
+
* The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.
|
537
544
|
*/
|
538
|
-
|
545
|
+
displayDescription?: String;
|
539
546
|
/**
|
540
547
|
* The type of field.
|
541
548
|
*/
|
@@ -544,20 +551,36 @@ declare namespace QBusiness {
|
|
544
551
|
* The field value.
|
545
552
|
*/
|
546
553
|
value?: ActionPayloadFieldValue;
|
547
|
-
}
|
548
|
-
export interface ActionReviewPayloadFieldAllowedValue {
|
549
554
|
/**
|
550
|
-
*
|
555
|
+
* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
|
551
556
|
*/
|
552
|
-
|
557
|
+
allowedValues?: ActionReviewPayloadFieldAllowedValues;
|
558
|
+
/**
|
559
|
+
* The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.
|
560
|
+
*/
|
561
|
+
allowedFormat?: String;
|
562
|
+
/**
|
563
|
+
* Information about whether the field is required.
|
564
|
+
*/
|
565
|
+
required?: Boolean;
|
566
|
+
}
|
567
|
+
export interface ActionReviewPayloadFieldAllowedValue {
|
553
568
|
/**
|
554
569
|
* The field value.
|
555
570
|
*/
|
556
571
|
value?: ActionPayloadFieldValue;
|
572
|
+
/**
|
573
|
+
* The name of the field.
|
574
|
+
*/
|
575
|
+
displayValue?: ActionPayloadFieldValue;
|
557
576
|
}
|
558
577
|
export type ActionReviewPayloadFieldAllowedValues = ActionReviewPayloadFieldAllowedValue[];
|
559
578
|
export type AmazonResourceName = string;
|
560
579
|
export interface Application {
|
580
|
+
/**
|
581
|
+
* The name of the Amazon Q Business application.
|
582
|
+
*/
|
583
|
+
displayName?: ApplicationName;
|
561
584
|
/**
|
562
585
|
* The identifier for the Amazon Q Business application.
|
563
586
|
*/
|
@@ -567,17 +590,13 @@ declare namespace QBusiness {
|
|
567
590
|
*/
|
568
591
|
createdAt?: Timestamp;
|
569
592
|
/**
|
570
|
-
* The
|
593
|
+
* The Unix timestamp when the Amazon Q Business application was last updated.
|
571
594
|
*/
|
572
|
-
|
595
|
+
updatedAt?: Timestamp;
|
573
596
|
/**
|
574
597
|
* The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.
|
575
598
|
*/
|
576
599
|
status?: ApplicationStatus;
|
577
|
-
/**
|
578
|
-
* The Unix timestamp when the Amazon Q Business application was last updated.
|
579
|
-
*/
|
580
|
-
updatedAt?: Timestamp;
|
581
600
|
}
|
582
601
|
export type ApplicationArn = string;
|
583
602
|
export type ApplicationId = string;
|
@@ -597,21 +616,17 @@ declare namespace QBusiness {
|
|
597
616
|
creatorModeControl: CreatorModeControl;
|
598
617
|
}
|
599
618
|
export interface AttachmentInput {
|
600
|
-
/**
|
601
|
-
* The data contained within the uploaded file.
|
602
|
-
*/
|
603
|
-
data: _Blob;
|
604
619
|
/**
|
605
620
|
* The name of the file.
|
606
621
|
*/
|
607
622
|
name: AttachmentName;
|
623
|
+
/**
|
624
|
+
* The data contained within the uploaded file.
|
625
|
+
*/
|
626
|
+
data: _Blob;
|
608
627
|
}
|
609
628
|
export type AttachmentName = string;
|
610
629
|
export interface AttachmentOutput {
|
611
|
-
/**
|
612
|
-
* An error associated with a file uploaded during chat.
|
613
|
-
*/
|
614
|
-
error?: ErrorDetail;
|
615
630
|
/**
|
616
631
|
* The name of a file uploaded during chat.
|
617
632
|
*/
|
@@ -620,6 +635,10 @@ declare namespace QBusiness {
|
|
620
635
|
* The status of a file uploaded during chat.
|
621
636
|
*/
|
622
637
|
status?: AttachmentStatus;
|
638
|
+
/**
|
639
|
+
* An error associated with a file uploaded during chat.
|
640
|
+
*/
|
641
|
+
error?: ErrorDetail;
|
623
642
|
}
|
624
643
|
export type AttachmentStatus = "FAILED"|"SUCCEEDED"|string;
|
625
644
|
export interface AttachmentsConfiguration {
|
@@ -637,17 +656,25 @@ declare namespace QBusiness {
|
|
637
656
|
*/
|
638
657
|
andAllFilters?: AttributeFilters;
|
639
658
|
/**
|
640
|
-
*
|
659
|
+
* Performs a logical OR operation on all supplied filters.
|
641
660
|
*/
|
642
|
-
|
661
|
+
orAllFilters?: AttributeFilters;
|
643
662
|
/**
|
644
|
-
*
|
663
|
+
* Performs a logical NOT operation on all supplied filters.
|
645
664
|
*/
|
646
|
-
|
665
|
+
notFilter?: AttributeFilter;
|
647
666
|
/**
|
648
667
|
* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
|
649
668
|
*/
|
650
669
|
equalsTo?: DocumentAttribute;
|
670
|
+
/**
|
671
|
+
* Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
|
672
|
+
*/
|
673
|
+
containsAll?: DocumentAttribute;
|
674
|
+
/**
|
675
|
+
* Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
|
676
|
+
*/
|
677
|
+
containsAny?: DocumentAttribute;
|
651
678
|
/**
|
652
679
|
* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
|
653
680
|
*/
|
@@ -664,27 +691,34 @@ declare namespace QBusiness {
|
|
664
691
|
* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
|
665
692
|
*/
|
666
693
|
lessThanOrEquals?: DocumentAttribute;
|
667
|
-
/**
|
668
|
-
* Performs a logical NOT operation on all supplied filters.
|
669
|
-
*/
|
670
|
-
notFilter?: AttributeFilter;
|
671
|
-
/**
|
672
|
-
* Performs a logical OR operation on all supplied filters.
|
673
|
-
*/
|
674
|
-
orAllFilters?: AttributeFilters;
|
675
694
|
}
|
676
695
|
export type AttributeFilters = AttributeFilter[];
|
677
696
|
export type AttributeType = "STRING"|"STRING_LIST"|"NUMBER"|"DATE"|string;
|
678
697
|
export type AttributeValueOperator = "DELETE"|string;
|
679
|
-
export interface
|
698
|
+
export interface AuthChallengeRequest {
|
680
699
|
/**
|
681
|
-
* The
|
700
|
+
* The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.
|
682
701
|
*/
|
683
|
-
|
702
|
+
authorizationUrl: Url;
|
703
|
+
}
|
704
|
+
export interface AuthChallengeResponse {
|
705
|
+
/**
|
706
|
+
* The mapping of key-value pairs in an authentication challenge response.
|
707
|
+
*/
|
708
|
+
responseMap: AuthorizationResponseMap;
|
709
|
+
}
|
710
|
+
export type AuthResponseKey = string;
|
711
|
+
export type AuthResponseValue = string;
|
712
|
+
export type AuthorizationResponseMap = {[key: string]: AuthResponseValue};
|
713
|
+
export interface BasicAuthConfiguration {
|
684
714
|
/**
|
685
715
|
* The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
|
686
716
|
*/
|
687
717
|
secretArn: SecretArn;
|
718
|
+
/**
|
719
|
+
* The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
|
720
|
+
*/
|
721
|
+
roleArn: RoleArn;
|
688
722
|
}
|
689
723
|
export interface BatchDeleteDocumentRequest {
|
690
724
|
/**
|
@@ -692,17 +726,17 @@ declare namespace QBusiness {
|
|
692
726
|
*/
|
693
727
|
applicationId: ApplicationId;
|
694
728
|
/**
|
695
|
-
* The identifier of the
|
729
|
+
* The identifier of the Amazon Q Business index that contains the documents to delete.
|
696
730
|
*/
|
697
|
-
|
731
|
+
indexId: IndexId;
|
698
732
|
/**
|
699
733
|
* Documents deleted from the Amazon Q Business index.
|
700
734
|
*/
|
701
735
|
documents: DeleteDocuments;
|
702
736
|
/**
|
703
|
-
* The identifier of the
|
737
|
+
* The identifier of the data source sync during which the documents were deleted.
|
704
738
|
*/
|
705
|
-
|
739
|
+
dataSourceSyncId?: ExecutionId;
|
706
740
|
}
|
707
741
|
export interface BatchDeleteDocumentResponse {
|
708
742
|
/**
|
@@ -716,21 +750,21 @@ declare namespace QBusiness {
|
|
716
750
|
*/
|
717
751
|
applicationId: ApplicationId;
|
718
752
|
/**
|
719
|
-
* The identifier of the
|
753
|
+
* The identifier of the Amazon Q Business index to add the documents to.
|
720
754
|
*/
|
721
|
-
|
755
|
+
indexId: IndexId;
|
722
756
|
/**
|
723
757
|
* One or more documents to add to the index.
|
724
758
|
*/
|
725
759
|
documents: Documents;
|
726
|
-
/**
|
727
|
-
* The identifier of the Amazon Q Business index to add the documents to.
|
728
|
-
*/
|
729
|
-
indexId: IndexId;
|
730
760
|
/**
|
731
761
|
* The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
|
732
762
|
*/
|
733
763
|
roleArn?: RoleArn;
|
764
|
+
/**
|
765
|
+
* The identifier of the data source sync during which the documents were added.
|
766
|
+
*/
|
767
|
+
dataSourceSyncId?: ExecutionId;
|
734
768
|
}
|
735
769
|
export interface BatchPutDocumentResponse {
|
736
770
|
/**
|
@@ -775,34 +809,34 @@ declare namespace QBusiness {
|
|
775
809
|
pluginConfiguration?: PluginConfiguration;
|
776
810
|
}
|
777
811
|
export interface ChatSyncInput {
|
778
|
-
/**
|
779
|
-
* A request from an end user to perform an Amazon Q Business plugin action.
|
780
|
-
*/
|
781
|
-
actionExecution?: ActionExecution;
|
782
812
|
/**
|
783
813
|
* The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
|
784
814
|
*/
|
785
815
|
applicationId: ApplicationId;
|
786
816
|
/**
|
787
|
-
*
|
817
|
+
* The identifier of the user attached to the chat input.
|
788
818
|
*/
|
789
|
-
|
819
|
+
userId?: UserId;
|
790
820
|
/**
|
791
|
-
*
|
821
|
+
* The groups that a user associated with the chat input belongs to.
|
792
822
|
*/
|
793
|
-
|
823
|
+
userGroups?: UserGroups;
|
794
824
|
/**
|
795
|
-
*
|
825
|
+
* A end user message in a conversation.
|
796
826
|
*/
|
797
|
-
|
827
|
+
userMessage?: UserMessage;
|
798
828
|
/**
|
799
|
-
*
|
829
|
+
* A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
|
800
830
|
*/
|
801
|
-
|
831
|
+
attachments?: AttachmentsInput;
|
802
832
|
/**
|
803
|
-
* A
|
833
|
+
* A request from an end user to perform an Amazon Q Business plugin action.
|
804
834
|
*/
|
805
|
-
|
835
|
+
actionExecution?: ActionExecution;
|
836
|
+
/**
|
837
|
+
* An authentication verification event response by a third party authentication server to Amazon Q Business.
|
838
|
+
*/
|
839
|
+
authChallengeResponse?: AuthChallengeResponse;
|
806
840
|
/**
|
807
841
|
* The identifier of the Amazon Q Business conversation.
|
808
842
|
*/
|
@@ -812,35 +846,27 @@ declare namespace QBusiness {
|
|
812
846
|
*/
|
813
847
|
parentMessageId?: MessageId;
|
814
848
|
/**
|
815
|
-
*
|
849
|
+
* Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
|
816
850
|
*/
|
817
|
-
|
851
|
+
attributeFilter?: AttributeFilter;
|
818
852
|
/**
|
819
|
-
* The
|
853
|
+
* The chat modes available to an Amazon Q Business end user. RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application. CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request. PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat. For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
|
820
854
|
*/
|
821
|
-
|
855
|
+
chatMode?: ChatMode;
|
822
856
|
/**
|
823
|
-
*
|
857
|
+
* The chat mode configuration for an Amazon Q Business application.
|
824
858
|
*/
|
825
|
-
|
826
|
-
}
|
827
|
-
export interface ChatSyncOutput {
|
859
|
+
chatModeConfiguration?: ChatModeConfiguration;
|
828
860
|
/**
|
829
|
-
* A
|
861
|
+
* A token that you provide to identify a chat request.
|
830
862
|
*/
|
831
|
-
|
863
|
+
clientToken?: ClientToken;
|
864
|
+
}
|
865
|
+
export interface ChatSyncOutput {
|
832
866
|
/**
|
833
867
|
* The identifier of the Amazon Q Business conversation.
|
834
868
|
*/
|
835
869
|
conversationId?: ConversationId;
|
836
|
-
/**
|
837
|
-
* A list of files which failed to upload during chat.
|
838
|
-
*/
|
839
|
-
failedAttachments?: AttachmentsOutput;
|
840
|
-
/**
|
841
|
-
* The source documents used to generate the conversation response.
|
842
|
-
*/
|
843
|
-
sourceAttributions?: SourceAttributions;
|
844
870
|
/**
|
845
871
|
* An AI-generated message in a conversation.
|
846
872
|
*/
|
@@ -853,6 +879,22 @@ declare namespace QBusiness {
|
|
853
879
|
* The identifier of an Amazon Q Business end user text input message within the conversation.
|
854
880
|
*/
|
855
881
|
userMessageId?: MessageId;
|
882
|
+
/**
|
883
|
+
* A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
|
884
|
+
*/
|
885
|
+
actionReview?: ActionReview;
|
886
|
+
/**
|
887
|
+
* An authentication verification event activated by an end user request to use a custom plugin.
|
888
|
+
*/
|
889
|
+
authChallengeRequest?: AuthChallengeRequest;
|
890
|
+
/**
|
891
|
+
* The source documents used to generate the conversation response.
|
892
|
+
*/
|
893
|
+
sourceAttributions?: SourceAttributions;
|
894
|
+
/**
|
895
|
+
* A list of files which failed to upload during chat.
|
896
|
+
*/
|
897
|
+
failedAttachments?: AttachmentsOutput;
|
856
898
|
}
|
857
899
|
export type ClientToken = string;
|
858
900
|
export interface ContentBlockerRule {
|
@@ -873,61 +915,61 @@ declare namespace QBusiness {
|
|
873
915
|
* The identifier of the Amazon Q Business conversation.
|
874
916
|
*/
|
875
917
|
conversationId?: ConversationId;
|
876
|
-
/**
|
877
|
-
* The start time of the conversation.
|
878
|
-
*/
|
879
|
-
startTime?: Timestamp;
|
880
918
|
/**
|
881
919
|
* The title of the conversation.
|
882
920
|
*/
|
883
921
|
title?: ConversationTitle;
|
922
|
+
/**
|
923
|
+
* The start time of the conversation.
|
924
|
+
*/
|
925
|
+
startTime?: Timestamp;
|
884
926
|
}
|
885
927
|
export type ConversationId = string;
|
886
928
|
export type ConversationTitle = string;
|
887
929
|
export type Conversations = Conversation[];
|
888
930
|
export interface CreateApplicationRequest {
|
889
931
|
/**
|
890
|
-
*
|
932
|
+
* A name for the Amazon Q Business application.
|
891
933
|
*/
|
892
|
-
|
934
|
+
displayName: ApplicationName;
|
893
935
|
/**
|
894
|
-
*
|
936
|
+
* The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
|
895
937
|
*/
|
896
|
-
|
938
|
+
roleArn?: RoleArn;
|
897
939
|
/**
|
898
|
-
*
|
940
|
+
* The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
|
899
941
|
*/
|
900
|
-
|
942
|
+
identityCenterInstanceArn?: InstanceArn;
|
901
943
|
/**
|
902
|
-
* A
|
944
|
+
* A description for the Amazon Q Business application.
|
903
945
|
*/
|
904
|
-
|
946
|
+
description?: Description;
|
905
947
|
/**
|
906
948
|
* The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
|
907
949
|
*/
|
908
950
|
encryptionConfiguration?: EncryptionConfiguration;
|
909
951
|
/**
|
910
|
-
*
|
952
|
+
* A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
911
953
|
*/
|
912
|
-
|
954
|
+
tags?: Tags;
|
913
955
|
/**
|
914
|
-
*
|
956
|
+
* A token that you provide to identify the request to create your Amazon Q Business application.
|
915
957
|
*/
|
916
|
-
|
958
|
+
clientToken?: ClientToken;
|
917
959
|
/**
|
918
|
-
*
|
960
|
+
* An option to allow end users to upload files directly during chat.
|
919
961
|
*/
|
920
|
-
|
962
|
+
attachmentsConfiguration?: AttachmentsConfiguration;
|
921
963
|
}
|
922
964
|
export interface CreateApplicationResponse {
|
923
|
-
/**
|
924
|
-
* The Amazon Resource Name (ARN) of the Amazon Q Business application.
|
925
|
-
*/
|
926
|
-
applicationArn?: ApplicationArn;
|
927
965
|
/**
|
928
966
|
* The identifier of the Amazon Q Business application.
|
929
967
|
*/
|
930
968
|
applicationId?: ApplicationId;
|
969
|
+
/**
|
970
|
+
* The Amazon Resource Name (ARN) of the Amazon Q Business application.
|
971
|
+
*/
|
972
|
+
applicationArn?: ApplicationArn;
|
931
973
|
}
|
932
974
|
export interface CreateDataSourceRequest {
|
933
975
|
/**
|
@@ -935,52 +977,52 @@ declare namespace QBusiness {
|
|
935
977
|
*/
|
936
978
|
applicationId: ApplicationId;
|
937
979
|
/**
|
938
|
-
*
|
980
|
+
* The identifier of the index that you want to use with the data source connector.
|
939
981
|
*/
|
940
|
-
|
982
|
+
indexId: IndexId;
|
941
983
|
/**
|
942
|
-
*
|
984
|
+
* A name for the data source connector.
|
943
985
|
*/
|
944
|
-
|
986
|
+
displayName: DataSourceName;
|
945
987
|
/**
|
946
|
-
*
|
988
|
+
* Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
|
947
989
|
*/
|
948
|
-
|
990
|
+
configuration: DataSourceConfiguration;
|
949
991
|
/**
|
950
|
-
*
|
992
|
+
* Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
|
951
993
|
*/
|
952
|
-
|
953
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
994
|
+
vpcConfiguration?: DataSourceVpcConfiguration;
|
954
995
|
/**
|
955
|
-
*
|
996
|
+
* A description for the data source connector.
|
956
997
|
*/
|
957
|
-
|
998
|
+
description?: Description;
|
958
999
|
/**
|
959
|
-
*
|
1000
|
+
* A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
960
1001
|
*/
|
961
|
-
|
1002
|
+
tags?: Tags;
|
962
1003
|
/**
|
963
1004
|
* Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
|
964
1005
|
*/
|
965
1006
|
syncSchedule?: SyncSchedule;
|
966
1007
|
/**
|
967
|
-
*
|
1008
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
|
968
1009
|
*/
|
969
|
-
|
1010
|
+
roleArn?: RoleArn;
|
970
1011
|
/**
|
971
|
-
*
|
1012
|
+
* A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
|
972
1013
|
*/
|
973
|
-
|
1014
|
+
clientToken?: ClientToken;
|
1015
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
974
1016
|
}
|
975
1017
|
export interface CreateDataSourceResponse {
|
976
|
-
/**
|
977
|
-
* The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
|
978
|
-
*/
|
979
|
-
dataSourceArn?: DataSourceArn;
|
980
1018
|
/**
|
981
1019
|
* The identifier of the data source connector.
|
982
1020
|
*/
|
983
1021
|
dataSourceId?: DataSourceId;
|
1022
|
+
/**
|
1023
|
+
* The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
|
1024
|
+
*/
|
1025
|
+
dataSourceArn?: DataSourceArn;
|
984
1026
|
}
|
985
1027
|
export interface CreateIndexRequest {
|
986
1028
|
/**
|
@@ -988,72 +1030,84 @@ declare namespace QBusiness {
|
|
988
1030
|
*/
|
989
1031
|
applicationId: ApplicationId;
|
990
1032
|
/**
|
991
|
-
*
|
1033
|
+
* A name for the Amazon Q Business index.
|
992
1034
|
*/
|
993
|
-
|
1035
|
+
displayName: IndexName;
|
994
1036
|
/**
|
995
|
-
*
|
1037
|
+
* The index type that's suitable for your needs. For more information on what's included in each type of index or index tier, see Amazon Q Business tiers.
|
996
1038
|
*/
|
997
|
-
|
1039
|
+
type?: IndexType;
|
998
1040
|
/**
|
999
1041
|
* A description for the Amazon Q Business index.
|
1000
1042
|
*/
|
1001
1043
|
description?: Description;
|
1002
|
-
/**
|
1003
|
-
* A name for the Amazon Q Business index.
|
1004
|
-
*/
|
1005
|
-
displayName: IndexName;
|
1006
1044
|
/**
|
1007
1045
|
* A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
1008
1046
|
*/
|
1009
1047
|
tags?: Tags;
|
1010
|
-
}
|
1011
|
-
export interface CreateIndexResponse {
|
1012
1048
|
/**
|
1013
|
-
*
|
1049
|
+
* The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
|
1014
1050
|
*/
|
1015
|
-
|
1051
|
+
capacityConfiguration?: IndexCapacityConfiguration;
|
1052
|
+
/**
|
1053
|
+
* A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.
|
1054
|
+
*/
|
1055
|
+
clientToken?: ClientToken;
|
1056
|
+
}
|
1057
|
+
export interface CreateIndexResponse {
|
1016
1058
|
/**
|
1017
1059
|
* The identifier for the Amazon Q Business index.
|
1018
1060
|
*/
|
1019
1061
|
indexId?: IndexId;
|
1062
|
+
/**
|
1063
|
+
* The Amazon Resource Name (ARN) of an Amazon Q Business index.
|
1064
|
+
*/
|
1065
|
+
indexArn?: IndexArn;
|
1020
1066
|
}
|
1021
1067
|
export interface CreatePluginRequest {
|
1022
1068
|
/**
|
1023
1069
|
* The identifier of the application that will contain the plugin.
|
1024
1070
|
*/
|
1025
1071
|
applicationId: ApplicationId;
|
1026
|
-
authConfiguration: PluginAuthConfiguration;
|
1027
|
-
/**
|
1028
|
-
* A token that you provide to identify the request to create your Amazon Q Business plugin.
|
1029
|
-
*/
|
1030
|
-
clientToken?: ClientToken;
|
1031
1072
|
/**
|
1032
1073
|
* A the name for your plugin.
|
1033
1074
|
*/
|
1034
1075
|
displayName: PluginName;
|
1076
|
+
/**
|
1077
|
+
* The type of plugin you want to create.
|
1078
|
+
*/
|
1079
|
+
type: PluginType;
|
1080
|
+
authConfiguration: PluginAuthConfiguration;
|
1035
1081
|
/**
|
1036
1082
|
* The source URL used for plugin configuration.
|
1037
1083
|
*/
|
1038
|
-
serverUrl
|
1084
|
+
serverUrl?: Url;
|
1085
|
+
/**
|
1086
|
+
* Contains configuration for a custom plugin.
|
1087
|
+
*/
|
1088
|
+
customPluginConfiguration?: CustomPluginConfiguration;
|
1039
1089
|
/**
|
1040
1090
|
* A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
1041
1091
|
*/
|
1042
1092
|
tags?: Tags;
|
1043
1093
|
/**
|
1044
|
-
*
|
1094
|
+
* A token that you provide to identify the request to create your Amazon Q Business plugin.
|
1045
1095
|
*/
|
1046
|
-
|
1096
|
+
clientToken?: ClientToken;
|
1047
1097
|
}
|
1048
1098
|
export interface CreatePluginResponse {
|
1099
|
+
/**
|
1100
|
+
* The identifier of the plugin created.
|
1101
|
+
*/
|
1102
|
+
pluginId?: PluginId;
|
1049
1103
|
/**
|
1050
1104
|
* The Amazon Resource Name (ARN) of a plugin.
|
1051
1105
|
*/
|
1052
1106
|
pluginArn?: PluginArn;
|
1053
1107
|
/**
|
1054
|
-
* The
|
1108
|
+
* The current status of a plugin. A plugin is modified asynchronously.
|
1055
1109
|
*/
|
1056
|
-
|
1110
|
+
buildStatus?: PluginBuildStatus;
|
1057
1111
|
}
|
1058
1112
|
export interface CreateRetrieverRequest {
|
1059
1113
|
/**
|
@@ -1061,36 +1115,36 @@ declare namespace QBusiness {
|
|
1061
1115
|
*/
|
1062
1116
|
applicationId: ApplicationId;
|
1063
1117
|
/**
|
1064
|
-
*
|
1118
|
+
* The type of retriever you are using.
|
1065
1119
|
*/
|
1066
|
-
|
1067
|
-
configuration: RetrieverConfiguration;
|
1120
|
+
type: RetrieverType;
|
1068
1121
|
/**
|
1069
1122
|
* The name of your retriever.
|
1070
1123
|
*/
|
1071
1124
|
displayName: RetrieverName;
|
1125
|
+
configuration: RetrieverConfiguration;
|
1072
1126
|
/**
|
1073
1127
|
* The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
|
1074
1128
|
*/
|
1075
1129
|
roleArn?: RoleArn;
|
1076
1130
|
/**
|
1077
|
-
* A
|
1131
|
+
* A token that you provide to identify the request to create your Amazon Q Business application retriever.
|
1078
1132
|
*/
|
1079
|
-
|
1133
|
+
clientToken?: ClientToken;
|
1080
1134
|
/**
|
1081
|
-
*
|
1135
|
+
* A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
1082
1136
|
*/
|
1083
|
-
|
1137
|
+
tags?: Tags;
|
1084
1138
|
}
|
1085
1139
|
export interface CreateRetrieverResponse {
|
1086
|
-
/**
|
1087
|
-
* The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
|
1088
|
-
*/
|
1089
|
-
retrieverArn?: RetrieverArn;
|
1090
1140
|
/**
|
1091
1141
|
* The identifier of the retriever you are using.
|
1092
1142
|
*/
|
1093
1143
|
retrieverId?: RetrieverId;
|
1144
|
+
/**
|
1145
|
+
* The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
|
1146
|
+
*/
|
1147
|
+
retrieverArn?: RetrieverArn;
|
1094
1148
|
}
|
1095
1149
|
export interface CreateUserRequest {
|
1096
1150
|
/**
|
@@ -1098,17 +1152,17 @@ declare namespace QBusiness {
|
|
1098
1152
|
*/
|
1099
1153
|
applicationId: ApplicationId;
|
1100
1154
|
/**
|
1101
|
-
*
|
1155
|
+
* The user emails attached to a user mapping.
|
1102
1156
|
*/
|
1103
|
-
|
1157
|
+
userId: String;
|
1104
1158
|
/**
|
1105
1159
|
* The list of user aliases in the mapping.
|
1106
1160
|
*/
|
1107
1161
|
userAliases?: CreateUserRequestUserAliasesList;
|
1108
1162
|
/**
|
1109
|
-
*
|
1163
|
+
* A token that you provide to identify the request to create your Amazon Q Business user mapping.
|
1110
1164
|
*/
|
1111
|
-
|
1165
|
+
clientToken?: ClientToken;
|
1112
1166
|
}
|
1113
1167
|
export type CreateUserRequestUserAliasesList = UserAlias[];
|
1114
1168
|
export interface CreateUserResponse {
|
@@ -1119,43 +1173,43 @@ declare namespace QBusiness {
|
|
1119
1173
|
*/
|
1120
1174
|
applicationId: ApplicationId;
|
1121
1175
|
/**
|
1122
|
-
*
|
1176
|
+
* The title for your Amazon Q Business web experience.
|
1123
1177
|
*/
|
1124
|
-
|
1178
|
+
title?: WebExperienceTitle;
|
1125
1179
|
/**
|
1126
|
-
*
|
1180
|
+
* A subtitle to personalize your Amazon Q Business web experience.
|
1127
1181
|
*/
|
1128
|
-
|
1182
|
+
subtitle?: WebExperienceSubtitle;
|
1183
|
+
/**
|
1184
|
+
* The customized welcome message for end users of an Amazon Q Business web experience.
|
1185
|
+
*/
|
1186
|
+
welcomeMessage?: WebExperienceWelcomeMessage;
|
1129
1187
|
/**
|
1130
1188
|
* Determines whether sample prompts are enabled in the web experience for an end user.
|
1131
1189
|
*/
|
1132
1190
|
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
1133
1191
|
/**
|
1134
|
-
*
|
1192
|
+
* The Amazon Resource Name (ARN) of the service role attached to your web experience.
|
1135
1193
|
*/
|
1136
|
-
|
1194
|
+
roleArn?: RoleArn;
|
1137
1195
|
/**
|
1138
1196
|
* A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
1139
1197
|
*/
|
1140
1198
|
tags?: Tags;
|
1141
1199
|
/**
|
1142
|
-
*
|
1143
|
-
*/
|
1144
|
-
title?: WebExperienceTitle;
|
1145
|
-
/**
|
1146
|
-
* The customized welcome message for end users of an Amazon Q Business web experience.
|
1200
|
+
* A token you provide to identify a request to create an Amazon Q Business web experience.
|
1147
1201
|
*/
|
1148
|
-
|
1202
|
+
clientToken?: ClientToken;
|
1149
1203
|
}
|
1150
1204
|
export interface CreateWebExperienceResponse {
|
1151
|
-
/**
|
1152
|
-
* The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
|
1153
|
-
*/
|
1154
|
-
webExperienceArn?: WebExperienceArn;
|
1155
1205
|
/**
|
1156
1206
|
* The identifier of the Amazon Q Business web experience.
|
1157
1207
|
*/
|
1158
1208
|
webExperienceId?: WebExperienceId;
|
1209
|
+
/**
|
1210
|
+
* The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
|
1211
|
+
*/
|
1212
|
+
webExperienceArn?: WebExperienceArn;
|
1159
1213
|
}
|
1160
1214
|
export interface CreatorModeConfiguration {
|
1161
1215
|
/**
|
@@ -1164,31 +1218,45 @@ declare namespace QBusiness {
|
|
1164
1218
|
creatorModeControl: CreatorModeControl;
|
1165
1219
|
}
|
1166
1220
|
export type CreatorModeControl = "ENABLED"|"DISABLED"|string;
|
1167
|
-
export interface
|
1221
|
+
export interface CustomPluginConfiguration {
|
1168
1222
|
/**
|
1169
|
-
*
|
1223
|
+
* A description for your custom plugin configuration.
|
1170
1224
|
*/
|
1171
|
-
|
1225
|
+
description: PluginDescription;
|
1172
1226
|
/**
|
1173
|
-
* The
|
1227
|
+
* The type of OpenAPI schema to use.
|
1174
1228
|
*/
|
1175
|
-
|
1229
|
+
apiSchemaType: APISchemaType;
|
1230
|
+
/**
|
1231
|
+
* Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
1232
|
+
*/
|
1233
|
+
apiSchema: APISchema;
|
1234
|
+
}
|
1235
|
+
export interface DataSource {
|
1176
1236
|
/**
|
1177
1237
|
* The name of the Amazon Q Business data source.
|
1178
1238
|
*/
|
1179
1239
|
displayName?: DataSourceName;
|
1180
1240
|
/**
|
1181
|
-
* The
|
1241
|
+
* The identifier of the Amazon Q Business data source.
|
1182
1242
|
*/
|
1183
|
-
|
1243
|
+
dataSourceId?: DataSourceId;
|
1184
1244
|
/**
|
1185
1245
|
* The type of the Amazon Q Business data source.
|
1186
1246
|
*/
|
1187
1247
|
type?: String;
|
1248
|
+
/**
|
1249
|
+
* The Unix timestamp when the Amazon Q Business data source was created.
|
1250
|
+
*/
|
1251
|
+
createdAt?: Timestamp;
|
1188
1252
|
/**
|
1189
1253
|
* The Unix timestamp when the Amazon Q Business data source was last updated.
|
1190
1254
|
*/
|
1191
1255
|
updatedAt?: Timestamp;
|
1256
|
+
/**
|
1257
|
+
* The status of the Amazon Q Business data source.
|
1258
|
+
*/
|
1259
|
+
status?: DataSourceStatus;
|
1192
1260
|
}
|
1193
1261
|
export type DataSourceArn = string;
|
1194
1262
|
export interface DataSourceConfiguration {
|
@@ -1199,39 +1267,43 @@ declare namespace QBusiness {
|
|
1199
1267
|
export type DataSourceStatus = "PENDING_CREATION"|"CREATING"|"ACTIVE"|"DELETING"|"FAILED"|"UPDATING"|string;
|
1200
1268
|
export interface DataSourceSyncJob {
|
1201
1269
|
/**
|
1202
|
-
*
|
1270
|
+
* The identifier of a data source synchronization job.
|
1203
1271
|
*/
|
1204
|
-
|
1272
|
+
executionId?: ExecutionId;
|
1273
|
+
/**
|
1274
|
+
* The Unix time stamp when the data source synchronization job started.
|
1275
|
+
*/
|
1276
|
+
startTime?: Timestamp;
|
1205
1277
|
/**
|
1206
1278
|
* The Unix timestamp when the synchronization job completed.
|
1207
1279
|
*/
|
1208
1280
|
endTime?: Timestamp;
|
1281
|
+
/**
|
1282
|
+
* The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
|
1283
|
+
*/
|
1284
|
+
status?: DataSourceSyncJobStatus;
|
1209
1285
|
/**
|
1210
1286
|
* If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
|
1211
1287
|
*/
|
1212
1288
|
error?: ErrorDetail;
|
1213
1289
|
/**
|
1214
|
-
*
|
1290
|
+
* If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
|
1215
1291
|
*/
|
1216
|
-
|
1292
|
+
dataSourceErrorCode?: String;
|
1217
1293
|
/**
|
1218
1294
|
* Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
|
1219
1295
|
*/
|
1220
1296
|
metrics?: DataSourceSyncJobMetrics;
|
1221
|
-
/**
|
1222
|
-
* The Unix time stamp when the data source synchronization job started.
|
1223
|
-
*/
|
1224
|
-
startTime?: Timestamp;
|
1225
|
-
/**
|
1226
|
-
* The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
|
1227
|
-
*/
|
1228
|
-
status?: DataSourceSyncJobStatus;
|
1229
1297
|
}
|
1230
1298
|
export interface DataSourceSyncJobMetrics {
|
1231
1299
|
/**
|
1232
1300
|
* The current count of documents added from the data source during the data source sync.
|
1233
1301
|
*/
|
1234
1302
|
documentsAdded?: MetricValue;
|
1303
|
+
/**
|
1304
|
+
* The current count of documents modified in the data source during the data source sync.
|
1305
|
+
*/
|
1306
|
+
documentsModified?: MetricValue;
|
1235
1307
|
/**
|
1236
1308
|
* The current count of documents deleted from the data source during the data source sync.
|
1237
1309
|
*/
|
@@ -1240,10 +1312,6 @@ declare namespace QBusiness {
|
|
1240
1312
|
* The current count of documents that failed to sync from the data source during the data source sync.
|
1241
1313
|
*/
|
1242
1314
|
documentsFailed?: MetricValue;
|
1243
|
-
/**
|
1244
|
-
* The current count of documents modified in the data source during the data source sync.
|
1245
|
-
*/
|
1246
|
-
documentsModified?: MetricValue;
|
1247
1315
|
/**
|
1248
1316
|
* The current count of documents crawled by the ongoing sync job in the data source.
|
1249
1317
|
*/
|
@@ -1253,25 +1321,25 @@ declare namespace QBusiness {
|
|
1253
1321
|
export type DataSourceSyncJobs = DataSourceSyncJob[];
|
1254
1322
|
export type DataSourceUserId = string;
|
1255
1323
|
export interface DataSourceVpcConfiguration {
|
1256
|
-
/**
|
1257
|
-
* A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
|
1258
|
-
*/
|
1259
|
-
securityGroupIds: SecurityGroupIds;
|
1260
1324
|
/**
|
1261
1325
|
* A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
|
1262
1326
|
*/
|
1263
1327
|
subnetIds: SubnetIds;
|
1328
|
+
/**
|
1329
|
+
* A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
|
1330
|
+
*/
|
1331
|
+
securityGroupIds: SecurityGroupIds;
|
1264
1332
|
}
|
1265
1333
|
export type DataSources = DataSource[];
|
1266
1334
|
export interface DateAttributeBoostingConfiguration {
|
1267
|
-
/**
|
1268
|
-
* Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
|
1269
|
-
*/
|
1270
|
-
boostingDurationInSeconds?: BoostingDurationInSeconds;
|
1271
1335
|
/**
|
1272
1336
|
* Specifies how much a document attribute is boosted.
|
1273
1337
|
*/
|
1274
1338
|
boostingLevel: DocumentAttributeBoostingLevel;
|
1339
|
+
/**
|
1340
|
+
* Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
|
1341
|
+
*/
|
1342
|
+
boostingDurationInSeconds?: BoostingDurationInSeconds;
|
1275
1343
|
}
|
1276
1344
|
export interface DeleteApplicationRequest {
|
1277
1345
|
/**
|
@@ -1290,14 +1358,14 @@ declare namespace QBusiness {
|
|
1290
1358
|
export interface DeleteChatControlsConfigurationResponse {
|
1291
1359
|
}
|
1292
1360
|
export interface DeleteConversationRequest {
|
1293
|
-
/**
|
1294
|
-
* The identifier of the Amazon Q Business application associated with the conversation.
|
1295
|
-
*/
|
1296
|
-
applicationId: ApplicationId;
|
1297
1361
|
/**
|
1298
1362
|
* The identifier of the Amazon Q Business web experience conversation being deleted.
|
1299
1363
|
*/
|
1300
1364
|
conversationId: ConversationId;
|
1365
|
+
/**
|
1366
|
+
* The identifier of the Amazon Q Business application associated with the conversation.
|
1367
|
+
*/
|
1368
|
+
applicationId: ApplicationId;
|
1301
1369
|
/**
|
1302
1370
|
* The identifier of the user who is deleting the conversation.
|
1303
1371
|
*/
|
@@ -1310,14 +1378,14 @@ declare namespace QBusiness {
|
|
1310
1378
|
* The identifier of the Amazon Q Business application used with the data source connector.
|
1311
1379
|
*/
|
1312
1380
|
applicationId: ApplicationId;
|
1313
|
-
/**
|
1314
|
-
* The identifier of the data source connector that you want to delete.
|
1315
|
-
*/
|
1316
|
-
dataSourceId: DataSourceId;
|
1317
1381
|
/**
|
1318
1382
|
* The identifier of the index used with the data source connector.
|
1319
1383
|
*/
|
1320
1384
|
indexId: IndexId;
|
1385
|
+
/**
|
1386
|
+
* The identifier of the data source connector that you want to delete.
|
1387
|
+
*/
|
1388
|
+
dataSourceId: DataSourceId;
|
1321
1389
|
}
|
1322
1390
|
export interface DeleteDataSourceResponse {
|
1323
1391
|
}
|
@@ -1334,17 +1402,17 @@ declare namespace QBusiness {
|
|
1334
1402
|
*/
|
1335
1403
|
applicationId: ApplicationId;
|
1336
1404
|
/**
|
1337
|
-
* The identifier of the
|
1405
|
+
* The identifier of the index you want to delete the group from.
|
1338
1406
|
*/
|
1339
|
-
|
1407
|
+
indexId: IndexId;
|
1340
1408
|
/**
|
1341
1409
|
* The name of the group you want to delete.
|
1342
1410
|
*/
|
1343
1411
|
groupName: GroupName;
|
1344
1412
|
/**
|
1345
|
-
* The identifier of the
|
1413
|
+
* The identifier of the data source linked to the group A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.
|
1346
1414
|
*/
|
1347
|
-
|
1415
|
+
dataSourceId?: DataSourceId;
|
1348
1416
|
}
|
1349
1417
|
export interface DeleteGroupResponse {
|
1350
1418
|
}
|
@@ -1411,9 +1479,9 @@ declare namespace QBusiness {
|
|
1411
1479
|
export type Description = string;
|
1412
1480
|
export interface Document {
|
1413
1481
|
/**
|
1414
|
-
*
|
1482
|
+
* The identifier of the document.
|
1415
1483
|
*/
|
1416
|
-
|
1484
|
+
id: DocumentId;
|
1417
1485
|
/**
|
1418
1486
|
* Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
|
1419
1487
|
*/
|
@@ -1427,17 +1495,17 @@ declare namespace QBusiness {
|
|
1427
1495
|
*/
|
1428
1496
|
contentType?: ContentType;
|
1429
1497
|
/**
|
1430
|
-
* The
|
1498
|
+
* The title of the document.
|
1431
1499
|
*/
|
1432
|
-
|
1500
|
+
title?: Title;
|
1433
1501
|
/**
|
1434
|
-
*
|
1502
|
+
* Configuration information for access permission to a document.
|
1435
1503
|
*/
|
1436
|
-
|
1504
|
+
accessConfiguration?: AccessConfiguration;
|
1437
1505
|
/**
|
1438
|
-
* The
|
1506
|
+
* The configuration information for altering document metadata and content during the document ingestion process.
|
1439
1507
|
*/
|
1440
|
-
|
1508
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
1441
1509
|
}
|
1442
1510
|
export interface DocumentAttribute {
|
1443
1511
|
/**
|
@@ -1450,10 +1518,6 @@ declare namespace QBusiness {
|
|
1450
1518
|
value: DocumentAttributeValue;
|
1451
1519
|
}
|
1452
1520
|
export interface DocumentAttributeBoostingConfiguration {
|
1453
|
-
/**
|
1454
|
-
* Provides information on boosting DATE type document attributes.
|
1455
|
-
*/
|
1456
|
-
dateConfiguration?: DateAttributeBoostingConfiguration;
|
1457
1521
|
/**
|
1458
1522
|
* Provides information on boosting NUMBER type document attributes.
|
1459
1523
|
*/
|
@@ -1462,6 +1526,10 @@ declare namespace QBusiness {
|
|
1462
1526
|
* Provides information on boosting STRING type document attributes.
|
1463
1527
|
*/
|
1464
1528
|
stringConfiguration?: StringAttributeBoostingConfiguration;
|
1529
|
+
/**
|
1530
|
+
* Provides information on boosting DATE type document attributes.
|
1531
|
+
*/
|
1532
|
+
dateConfiguration?: DateAttributeBoostingConfiguration;
|
1465
1533
|
/**
|
1466
1534
|
* Provides information on boosting STRING_LIST type document attributes.
|
1467
1535
|
*/
|
@@ -1475,7 +1543,7 @@ declare namespace QBusiness {
|
|
1475
1543
|
*/
|
1476
1544
|
key: DocumentAttributeKey;
|
1477
1545
|
/**
|
1478
|
-
* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon
|
1546
|
+
* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
|
1479
1547
|
*/
|
1480
1548
|
operator: DocumentEnrichmentConditionOperator;
|
1481
1549
|
value?: DocumentAttributeValue;
|
@@ -1484,47 +1552,47 @@ declare namespace QBusiness {
|
|
1484
1552
|
/**
|
1485
1553
|
* The name of the document attribute.
|
1486
1554
|
*/
|
1487
|
-
name?:
|
1488
|
-
/**
|
1489
|
-
* Information about whether the document attribute can be used by an end user to search for information on their web experience.
|
1490
|
-
*/
|
1491
|
-
search?: Status;
|
1555
|
+
name?: DocumentMetadataConfigurationName;
|
1492
1556
|
/**
|
1493
1557
|
* The type of document attribute.
|
1494
1558
|
*/
|
1495
1559
|
type?: AttributeType;
|
1560
|
+
/**
|
1561
|
+
* Information about whether the document attribute can be used by an end user to search for information on their web experience.
|
1562
|
+
*/
|
1563
|
+
search?: Status;
|
1496
1564
|
}
|
1497
1565
|
export type DocumentAttributeConfigurations = DocumentAttributeConfiguration[];
|
1498
1566
|
export type DocumentAttributeKey = string;
|
1499
1567
|
export type DocumentAttributeStringListValue = String[];
|
1500
1568
|
export interface DocumentAttributeTarget {
|
1501
|
-
/**
|
1502
|
-
* TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.
|
1503
|
-
*/
|
1504
|
-
attributeValueOperator?: AttributeValueOperator;
|
1505
1569
|
/**
|
1506
1570
|
* The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
|
1507
1571
|
*/
|
1508
1572
|
key: DocumentAttributeKey;
|
1509
1573
|
value?: DocumentAttributeValue;
|
1510
|
-
}
|
1511
|
-
export interface DocumentAttributeValue {
|
1512
1574
|
/**
|
1513
|
-
*
|
1575
|
+
* TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.
|
1514
1576
|
*/
|
1515
|
-
|
1577
|
+
attributeValueOperator?: AttributeValueOperator;
|
1578
|
+
}
|
1579
|
+
export interface DocumentAttributeValue {
|
1516
1580
|
/**
|
1517
|
-
* A
|
1581
|
+
* A string.
|
1518
1582
|
*/
|
1519
|
-
|
1583
|
+
stringValue?: DocumentAttributeValueStringValueString;
|
1520
1584
|
/**
|
1521
1585
|
* A list of strings.
|
1522
1586
|
*/
|
1523
1587
|
stringListValue?: DocumentAttributeStringListValue;
|
1524
1588
|
/**
|
1525
|
-
* A
|
1589
|
+
* A long integer value.
|
1526
1590
|
*/
|
1527
|
-
|
1591
|
+
longValue?: Long;
|
1592
|
+
/**
|
1593
|
+
* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
|
1594
|
+
*/
|
1595
|
+
dateValue?: Timestamp;
|
1528
1596
|
}
|
1529
1597
|
export type DocumentAttributeValueStringValueString = string;
|
1530
1598
|
export type DocumentAttributes = DocumentAttribute[];
|
@@ -1541,22 +1609,22 @@ declare namespace QBusiness {
|
|
1541
1609
|
export type DocumentContentOperator = "DELETE"|string;
|
1542
1610
|
export type DocumentDetailList = DocumentDetails[];
|
1543
1611
|
export interface DocumentDetails {
|
1544
|
-
/**
|
1545
|
-
* The timestamp for when the document was created.
|
1546
|
-
*/
|
1547
|
-
createdAt?: Timestamp;
|
1548
1612
|
/**
|
1549
1613
|
* The identifier of the document.
|
1550
1614
|
*/
|
1551
1615
|
documentId?: DocumentId;
|
1616
|
+
/**
|
1617
|
+
* The current status of the document.
|
1618
|
+
*/
|
1619
|
+
status?: DocumentStatus;
|
1552
1620
|
/**
|
1553
1621
|
* An error message associated with the document.
|
1554
1622
|
*/
|
1555
1623
|
error?: ErrorDetail;
|
1556
1624
|
/**
|
1557
|
-
* The
|
1625
|
+
* The timestamp for when the document was created.
|
1558
1626
|
*/
|
1559
|
-
|
1627
|
+
createdAt?: Timestamp;
|
1560
1628
|
/**
|
1561
1629
|
* The timestamp for when the document was last updated.
|
1562
1630
|
*/
|
@@ -1568,21 +1636,22 @@ declare namespace QBusiness {
|
|
1568
1636
|
* Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
|
1569
1637
|
*/
|
1570
1638
|
inlineConfigurations?: InlineDocumentEnrichmentConfigurations;
|
1571
|
-
postExtractionHookConfiguration?: HookConfiguration;
|
1572
1639
|
preExtractionHookConfiguration?: HookConfiguration;
|
1640
|
+
postExtractionHookConfiguration?: HookConfiguration;
|
1573
1641
|
}
|
1574
1642
|
export type DocumentId = string;
|
1643
|
+
export type DocumentMetadataConfigurationName = string;
|
1575
1644
|
export type DocumentStatus = "RECEIVED"|"PROCESSING"|"INDEXED"|"UPDATED"|"FAILED"|"DELETING"|"DELETED"|"DOCUMENT_FAILED_TO_INDEX"|string;
|
1576
1645
|
export type Documents = Document[];
|
1577
1646
|
export interface EligibleDataSource {
|
1578
|
-
/**
|
1579
|
-
* The identifier of the data source.
|
1580
|
-
*/
|
1581
|
-
dataSourceId?: DataSourceId;
|
1582
1647
|
/**
|
1583
1648
|
* The identifier of the index the data source is attached to.
|
1584
1649
|
*/
|
1585
1650
|
indexId?: IndexId;
|
1651
|
+
/**
|
1652
|
+
* The identifier of the data source.
|
1653
|
+
*/
|
1654
|
+
dataSourceId?: DataSourceId;
|
1586
1655
|
}
|
1587
1656
|
export type EligibleDataSources = EligibleDataSource[];
|
1588
1657
|
export interface EncryptionConfiguration {
|
@@ -1593,14 +1662,14 @@ declare namespace QBusiness {
|
|
1593
1662
|
}
|
1594
1663
|
export type ErrorCode = "InternalError"|"InvalidRequest"|"ResourceInactive"|"ResourceNotFound"|string;
|
1595
1664
|
export interface ErrorDetail {
|
1596
|
-
/**
|
1597
|
-
* The code associated with the data source sync error.
|
1598
|
-
*/
|
1599
|
-
errorCode?: ErrorCode;
|
1600
1665
|
/**
|
1601
1666
|
* The message explaining the data source sync error.
|
1602
1667
|
*/
|
1603
1668
|
errorMessage?: ErrorMessage;
|
1669
|
+
/**
|
1670
|
+
* The code associated with the data source sync error.
|
1671
|
+
*/
|
1672
|
+
errorCode?: ErrorCode;
|
1604
1673
|
}
|
1605
1674
|
export type ErrorMessage = string;
|
1606
1675
|
export type ExampleChatMessage = string;
|
@@ -1608,17 +1677,17 @@ declare namespace QBusiness {
|
|
1608
1677
|
export type ExecutionId = string;
|
1609
1678
|
export interface FailedDocument {
|
1610
1679
|
/**
|
1611
|
-
* The identifier of the
|
1680
|
+
* The identifier of the document that couldn't be removed from the Amazon Q Business index.
|
1612
1681
|
*/
|
1613
|
-
|
1682
|
+
id?: DocumentId;
|
1614
1683
|
/**
|
1615
1684
|
* An explanation for why the document couldn't be removed from the index.
|
1616
1685
|
*/
|
1617
1686
|
error?: ErrorDetail;
|
1618
1687
|
/**
|
1619
|
-
* The identifier of the
|
1688
|
+
* The identifier of the Amazon Q Business data source connector that contains the failed document.
|
1620
1689
|
*/
|
1621
|
-
|
1690
|
+
dataSourceId?: DataSourceId;
|
1622
1691
|
}
|
1623
1692
|
export type FailedDocuments = FailedDocument[];
|
1624
1693
|
export interface GetApplicationRequest {
|
@@ -1629,53 +1698,53 @@ declare namespace QBusiness {
|
|
1629
1698
|
}
|
1630
1699
|
export interface GetApplicationResponse {
|
1631
1700
|
/**
|
1632
|
-
* The
|
1701
|
+
* The name of the Amazon Q Business application.
|
1633
1702
|
*/
|
1634
|
-
|
1703
|
+
displayName?: ApplicationName;
|
1635
1704
|
/**
|
1636
1705
|
* The identifier of the Amazon Q Business application.
|
1637
1706
|
*/
|
1638
1707
|
applicationId?: ApplicationId;
|
1639
1708
|
/**
|
1640
|
-
*
|
1709
|
+
* The Amazon Resource Name (ARN) of the Amazon Q Business application.
|
1641
1710
|
*/
|
1642
|
-
|
1711
|
+
applicationArn?: ApplicationArn;
|
1643
1712
|
/**
|
1644
|
-
* The
|
1713
|
+
* The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
|
1645
1714
|
*/
|
1646
|
-
|
1715
|
+
identityCenterApplicationArn?: IdcApplicationArn;
|
1647
1716
|
/**
|
1648
|
-
*
|
1717
|
+
* The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
|
1649
1718
|
*/
|
1650
|
-
|
1719
|
+
roleArn?: RoleArn;
|
1651
1720
|
/**
|
1652
|
-
* The
|
1721
|
+
* The status of the Amazon Q Business application.
|
1653
1722
|
*/
|
1654
|
-
|
1723
|
+
status?: ApplicationStatus;
|
1655
1724
|
/**
|
1656
|
-
*
|
1725
|
+
* A description for the Amazon Q Business application.
|
1657
1726
|
*/
|
1658
|
-
|
1727
|
+
description?: Description;
|
1659
1728
|
/**
|
1660
|
-
*
|
1729
|
+
* The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
|
1661
1730
|
*/
|
1662
|
-
|
1731
|
+
encryptionConfiguration?: EncryptionConfiguration;
|
1663
1732
|
/**
|
1664
|
-
* The
|
1733
|
+
* The Unix timestamp when the Amazon Q Business application was last updated.
|
1665
1734
|
*/
|
1666
|
-
|
1735
|
+
createdAt?: Timestamp;
|
1667
1736
|
/**
|
1668
|
-
* The
|
1737
|
+
* The Unix timestamp when the Amazon Q Business application was last updated.
|
1669
1738
|
*/
|
1670
|
-
|
1739
|
+
updatedAt?: Timestamp;
|
1671
1740
|
/**
|
1672
|
-
*
|
1741
|
+
* If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
|
1673
1742
|
*/
|
1674
|
-
|
1743
|
+
error?: ErrorDetail;
|
1675
1744
|
/**
|
1676
|
-
*
|
1745
|
+
* Settings for whether end users can upload files directly during chat.
|
1677
1746
|
*/
|
1678
|
-
|
1747
|
+
attachmentsConfiguration?: AppliedAttachmentsConfiguration;
|
1679
1748
|
}
|
1680
1749
|
export interface GetChatControlsConfigurationRequest {
|
1681
1750
|
/**
|
@@ -1692,10 +1761,18 @@ declare namespace QBusiness {
|
|
1692
1761
|
nextToken?: NextToken;
|
1693
1762
|
}
|
1694
1763
|
export interface GetChatControlsConfigurationResponse {
|
1764
|
+
/**
|
1765
|
+
* The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
|
1766
|
+
*/
|
1767
|
+
responseScope?: ResponseScope;
|
1695
1768
|
/**
|
1696
1769
|
* The phrases blocked from chat by your chat control configuration.
|
1697
1770
|
*/
|
1698
1771
|
blockedPhrases?: BlockedPhrasesConfiguration;
|
1772
|
+
/**
|
1773
|
+
* The topic specific controls configured for a Amazon Q Business application.
|
1774
|
+
*/
|
1775
|
+
topicConfigurations?: TopicConfigurations;
|
1699
1776
|
/**
|
1700
1777
|
* The configuration details for CREATOR_MODE.
|
1701
1778
|
*/
|
@@ -1704,28 +1781,20 @@ declare namespace QBusiness {
|
|
1704
1781
|
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
|
1705
1782
|
*/
|
1706
1783
|
nextToken?: NextToken;
|
1707
|
-
/**
|
1708
|
-
* The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
|
1709
|
-
*/
|
1710
|
-
responseScope?: ResponseScope;
|
1711
|
-
/**
|
1712
|
-
* The topic specific controls configured for a Amazon Q Business application.
|
1713
|
-
*/
|
1714
|
-
topicConfigurations?: TopicConfigurations;
|
1715
1784
|
}
|
1716
1785
|
export interface GetDataSourceRequest {
|
1717
1786
|
/**
|
1718
1787
|
* The identifier of the Amazon Q Business application.
|
1719
1788
|
*/
|
1720
1789
|
applicationId: ApplicationId;
|
1721
|
-
/**
|
1722
|
-
* The identifier of the data source connector.
|
1723
|
-
*/
|
1724
|
-
dataSourceId: DataSourceId;
|
1725
1790
|
/**
|
1726
1791
|
* The identfier of the index used with the data source connector.
|
1727
1792
|
*/
|
1728
1793
|
indexId: IndexId;
|
1794
|
+
/**
|
1795
|
+
* The identifier of the data source connector.
|
1796
|
+
*/
|
1797
|
+
dataSourceId: DataSourceId;
|
1729
1798
|
}
|
1730
1799
|
export interface GetDataSourceResponse {
|
1731
1800
|
/**
|
@@ -1733,42 +1802,45 @@ declare namespace QBusiness {
|
|
1733
1802
|
*/
|
1734
1803
|
applicationId?: ApplicationId;
|
1735
1804
|
/**
|
1736
|
-
* The
|
1805
|
+
* The identifier of the index linked to the data source connector.
|
1737
1806
|
*/
|
1738
|
-
|
1807
|
+
indexId?: IndexId;
|
1739
1808
|
/**
|
1740
|
-
* The
|
1809
|
+
* The identifier of the data source connector.
|
1741
1810
|
*/
|
1742
|
-
|
1811
|
+
dataSourceId?: DataSourceId;
|
1743
1812
|
/**
|
1744
1813
|
* The Amazon Resource Name (ARN) of the data source.
|
1745
1814
|
*/
|
1746
1815
|
dataSourceArn?: DataSourceArn;
|
1747
1816
|
/**
|
1748
|
-
* The
|
1817
|
+
* The name for the data source connector.
|
1749
1818
|
*/
|
1750
|
-
|
1819
|
+
displayName?: DataSourceName;
|
1751
1820
|
/**
|
1752
|
-
* The
|
1821
|
+
* The type of the data source connector. For example, S3.
|
1753
1822
|
*/
|
1754
|
-
|
1823
|
+
type?: String;
|
1755
1824
|
/**
|
1756
|
-
* The
|
1825
|
+
* The details of how the data source connector is configured.
|
1757
1826
|
*/
|
1758
|
-
|
1759
|
-
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
1827
|
+
configuration?: DataSourceConfiguration;
|
1760
1828
|
/**
|
1761
|
-
*
|
1829
|
+
* Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
|
1762
1830
|
*/
|
1763
|
-
|
1831
|
+
vpcConfiguration?: DataSourceVpcConfiguration;
|
1764
1832
|
/**
|
1765
|
-
* The
|
1833
|
+
* The Unix timestamp when the data source connector was created.
|
1766
1834
|
*/
|
1767
|
-
|
1835
|
+
createdAt?: Timestamp;
|
1768
1836
|
/**
|
1769
|
-
* The
|
1837
|
+
* The Unix timestamp when the data source connector was last updated.
|
1770
1838
|
*/
|
1771
|
-
|
1839
|
+
updatedAt?: Timestamp;
|
1840
|
+
/**
|
1841
|
+
* The description for the data source connector.
|
1842
|
+
*/
|
1843
|
+
description?: Description;
|
1772
1844
|
/**
|
1773
1845
|
* The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
|
1774
1846
|
*/
|
@@ -1778,17 +1850,14 @@ declare namespace QBusiness {
|
|
1778
1850
|
*/
|
1779
1851
|
syncSchedule?: SyncSchedule;
|
1780
1852
|
/**
|
1781
|
-
* The
|
1782
|
-
*/
|
1783
|
-
type?: String;
|
1784
|
-
/**
|
1785
|
-
* The Unix timestamp when the data source connector was last updated.
|
1853
|
+
* The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
|
1786
1854
|
*/
|
1787
|
-
|
1855
|
+
roleArn?: RoleArn;
|
1788
1856
|
/**
|
1789
|
-
*
|
1857
|
+
* When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
|
1790
1858
|
*/
|
1791
|
-
|
1859
|
+
error?: ErrorDetail;
|
1860
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
1792
1861
|
}
|
1793
1862
|
export interface GetGroupRequest {
|
1794
1863
|
/**
|
@@ -1796,17 +1865,17 @@ declare namespace QBusiness {
|
|
1796
1865
|
*/
|
1797
1866
|
applicationId: ApplicationId;
|
1798
1867
|
/**
|
1799
|
-
* The identifier of the
|
1868
|
+
* The identifier of the index the group is attached to.
|
1800
1869
|
*/
|
1801
|
-
|
1870
|
+
indexId: IndexId;
|
1802
1871
|
/**
|
1803
1872
|
* The name of the group.
|
1804
1873
|
*/
|
1805
1874
|
groupName: GroupName;
|
1806
1875
|
/**
|
1807
|
-
* The identifier of the
|
1876
|
+
* The identifier of the data source the group is attached to.
|
1808
1877
|
*/
|
1809
|
-
|
1878
|
+
dataSourceId?: DataSourceId;
|
1810
1879
|
}
|
1811
1880
|
export interface GetGroupResponse {
|
1812
1881
|
/**
|
@@ -1834,49 +1903,53 @@ declare namespace QBusiness {
|
|
1834
1903
|
*/
|
1835
1904
|
applicationId?: ApplicationId;
|
1836
1905
|
/**
|
1837
|
-
* The
|
1838
|
-
*/
|
1839
|
-
capacityConfiguration?: IndexCapacityConfiguration;
|
1840
|
-
/**
|
1841
|
-
* The Unix timestamp when the Amazon Q Business index was created.
|
1842
|
-
*/
|
1843
|
-
createdAt?: Timestamp;
|
1844
|
-
/**
|
1845
|
-
* The description for the Amazon Q Business index.
|
1906
|
+
* The identifier of the Amazon Q Business index.
|
1846
1907
|
*/
|
1847
|
-
|
1908
|
+
indexId?: IndexId;
|
1848
1909
|
/**
|
1849
1910
|
* The name of the Amazon Q Business index.
|
1850
1911
|
*/
|
1851
1912
|
displayName?: IndexName;
|
1852
1913
|
/**
|
1853
|
-
*
|
1914
|
+
* The type of index attached to your Amazon Q Business application.
|
1854
1915
|
*/
|
1855
|
-
|
1856
|
-
/**
|
1857
|
-
* When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
|
1858
|
-
*/
|
1859
|
-
error?: ErrorDetail;
|
1916
|
+
type?: IndexType;
|
1860
1917
|
/**
|
1861
1918
|
* The Amazon Resource Name (ARN) of the Amazon Q Business index.
|
1862
1919
|
*/
|
1863
1920
|
indexArn?: IndexArn;
|
1864
1921
|
/**
|
1865
|
-
* The
|
1922
|
+
* The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
|
1866
1923
|
*/
|
1867
|
-
|
1924
|
+
status?: IndexStatus;
|
1868
1925
|
/**
|
1869
|
-
*
|
1926
|
+
* The description for the Amazon Q Business index.
|
1870
1927
|
*/
|
1871
|
-
|
1928
|
+
description?: Description;
|
1872
1929
|
/**
|
1873
|
-
* The
|
1930
|
+
* The Unix timestamp when the Amazon Q Business index was created.
|
1874
1931
|
*/
|
1875
|
-
|
1932
|
+
createdAt?: Timestamp;
|
1876
1933
|
/**
|
1877
1934
|
* The Unix timestamp when the Amazon Q Business index was last updated.
|
1878
1935
|
*/
|
1879
1936
|
updatedAt?: Timestamp;
|
1937
|
+
/**
|
1938
|
+
* The storage capacity units chosen for your Amazon Q Business index.
|
1939
|
+
*/
|
1940
|
+
capacityConfiguration?: IndexCapacityConfiguration;
|
1941
|
+
/**
|
1942
|
+
* Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
|
1943
|
+
*/
|
1944
|
+
documentAttributeConfigurations?: DocumentAttributeConfigurations;
|
1945
|
+
/**
|
1946
|
+
* When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
|
1947
|
+
*/
|
1948
|
+
error?: ErrorDetail;
|
1949
|
+
/**
|
1950
|
+
* Provides information about the number of documents indexed.
|
1951
|
+
*/
|
1952
|
+
indexStatistics?: IndexStatistics;
|
1880
1953
|
}
|
1881
1954
|
export interface GetPluginRequest {
|
1882
1955
|
/**
|
@@ -1893,35 +1966,43 @@ declare namespace QBusiness {
|
|
1893
1966
|
* The identifier of the application which contains the plugin.
|
1894
1967
|
*/
|
1895
1968
|
applicationId?: ApplicationId;
|
1896
|
-
authConfiguration?: PluginAuthConfiguration;
|
1897
1969
|
/**
|
1898
|
-
* The
|
1970
|
+
* The identifier of the plugin.
|
1899
1971
|
*/
|
1900
|
-
|
1972
|
+
pluginId?: PluginId;
|
1901
1973
|
/**
|
1902
1974
|
* The name of the plugin.
|
1903
1975
|
*/
|
1904
1976
|
displayName?: PluginName;
|
1905
1977
|
/**
|
1906
|
-
* The
|
1907
|
-
*/
|
1908
|
-
pluginArn?: PluginArn;
|
1909
|
-
/**
|
1910
|
-
* The identifier of the plugin.
|
1978
|
+
* The type of the plugin.
|
1911
1979
|
*/
|
1912
|
-
|
1980
|
+
type?: PluginType;
|
1913
1981
|
/**
|
1914
1982
|
* The source URL used for plugin configuration.
|
1915
1983
|
*/
|
1916
1984
|
serverUrl?: Url;
|
1985
|
+
authConfiguration?: PluginAuthConfiguration;
|
1986
|
+
/**
|
1987
|
+
* Configuration information required to create a custom plugin.
|
1988
|
+
*/
|
1989
|
+
customPluginConfiguration?: CustomPluginConfiguration;
|
1990
|
+
/**
|
1991
|
+
* The current status of a plugin. A plugin is modified asynchronously.
|
1992
|
+
*/
|
1993
|
+
buildStatus?: PluginBuildStatus;
|
1994
|
+
/**
|
1995
|
+
* The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
|
1996
|
+
*/
|
1997
|
+
pluginArn?: PluginArn;
|
1917
1998
|
/**
|
1918
1999
|
* The current state of the plugin.
|
1919
2000
|
*/
|
1920
2001
|
state?: PluginState;
|
1921
2002
|
/**
|
1922
|
-
* The
|
2003
|
+
* The timestamp for when the plugin was created.
|
1923
2004
|
*/
|
1924
|
-
|
2005
|
+
createdAt?: Timestamp;
|
1925
2006
|
/**
|
1926
2007
|
* The timestamp for when the plugin was last updated.
|
1927
2008
|
*/
|
@@ -1942,35 +2023,35 @@ declare namespace QBusiness {
|
|
1942
2023
|
* The identifier of the Amazon Q Business application using the retriever.
|
1943
2024
|
*/
|
1944
2025
|
applicationId?: ApplicationId;
|
1945
|
-
configuration?: RetrieverConfiguration;
|
1946
2026
|
/**
|
1947
|
-
* The
|
1948
|
-
*/
|
1949
|
-
createdAt?: Timestamp;
|
1950
|
-
/**
|
1951
|
-
* The name of the retriever.
|
2027
|
+
* The identifier of the retriever.
|
1952
2028
|
*/
|
1953
|
-
|
2029
|
+
retrieverId?: RetrieverId;
|
1954
2030
|
/**
|
1955
2031
|
* The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
|
1956
2032
|
*/
|
1957
2033
|
retrieverArn?: RetrieverArn;
|
1958
2034
|
/**
|
1959
|
-
* The
|
1960
|
-
*/
|
1961
|
-
retrieverId?: RetrieverId;
|
1962
|
-
/**
|
1963
|
-
* The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
|
2035
|
+
* The type of the retriever.
|
1964
2036
|
*/
|
1965
|
-
|
2037
|
+
type?: RetrieverType;
|
1966
2038
|
/**
|
1967
2039
|
* The status of the retriever.
|
1968
2040
|
*/
|
1969
2041
|
status?: RetrieverStatus;
|
1970
2042
|
/**
|
1971
|
-
* The
|
2043
|
+
* The name of the retriever.
|
1972
2044
|
*/
|
1973
|
-
|
2045
|
+
displayName?: RetrieverName;
|
2046
|
+
configuration?: RetrieverConfiguration;
|
2047
|
+
/**
|
2048
|
+
* The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
|
2049
|
+
*/
|
2050
|
+
roleArn?: RoleArn;
|
2051
|
+
/**
|
2052
|
+
* The Unix timestamp when the retriever was created.
|
2053
|
+
*/
|
2054
|
+
createdAt?: Timestamp;
|
1974
2055
|
/**
|
1975
2056
|
* The Unix timestamp when the retriever was last updated.
|
1976
2057
|
*/
|
@@ -2008,57 +2089,57 @@ declare namespace QBusiness {
|
|
2008
2089
|
*/
|
2009
2090
|
applicationId?: ApplicationId;
|
2010
2091
|
/**
|
2011
|
-
* The
|
2092
|
+
* The identifier of the Amazon Q Business web experience.
|
2012
2093
|
*/
|
2013
|
-
|
2094
|
+
webExperienceId?: WebExperienceId;
|
2014
2095
|
/**
|
2015
|
-
* The
|
2096
|
+
* The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
|
2016
2097
|
*/
|
2017
|
-
|
2098
|
+
webExperienceArn?: WebExperienceArn;
|
2018
2099
|
/**
|
2019
2100
|
* The endpoint of your Amazon Q Business web experience.
|
2020
2101
|
*/
|
2021
2102
|
defaultEndpoint?: Url;
|
2022
2103
|
/**
|
2023
|
-
* When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
|
2104
|
+
* The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
|
2024
2105
|
*/
|
2025
|
-
|
2106
|
+
status?: WebExperienceStatus;
|
2026
2107
|
/**
|
2027
|
-
*
|
2108
|
+
* The Unix timestamp when the Amazon Q Business web experience was last created.
|
2028
2109
|
*/
|
2029
|
-
|
2110
|
+
createdAt?: Timestamp;
|
2030
2111
|
/**
|
2031
|
-
*
|
2112
|
+
* The Unix timestamp when the Amazon Q Business web experience was last updated.
|
2032
2113
|
*/
|
2033
|
-
|
2114
|
+
updatedAt?: Timestamp;
|
2034
2115
|
/**
|
2035
|
-
* The
|
2116
|
+
* The title for your Amazon Q Business web experience.
|
2036
2117
|
*/
|
2037
|
-
|
2118
|
+
title?: WebExperienceTitle;
|
2038
2119
|
/**
|
2039
2120
|
* The subtitle for your Amazon Q Business web experience.
|
2040
2121
|
*/
|
2041
2122
|
subtitle?: WebExperienceSubtitle;
|
2042
2123
|
/**
|
2043
|
-
* The
|
2124
|
+
* The customized welcome message for end users of an Amazon Q Business web experience.
|
2044
2125
|
*/
|
2045
|
-
|
2126
|
+
welcomeMessage?: WebExperienceWelcomeMessage;
|
2046
2127
|
/**
|
2047
|
-
*
|
2128
|
+
* Determines whether sample prompts are enabled in the web experience for an end user.
|
2048
2129
|
*/
|
2049
|
-
|
2130
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
2050
2131
|
/**
|
2051
|
-
*
|
2132
|
+
* The Amazon Resource Name (ARN) of the service role attached to your web experience.
|
2052
2133
|
*/
|
2053
|
-
|
2134
|
+
roleArn?: RoleArn;
|
2054
2135
|
/**
|
2055
|
-
* The
|
2136
|
+
* The authentication configuration information for your Amazon Q Business web experience.
|
2056
2137
|
*/
|
2057
|
-
|
2138
|
+
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
2058
2139
|
/**
|
2059
|
-
*
|
2140
|
+
* When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
|
2060
2141
|
*/
|
2061
|
-
|
2142
|
+
error?: ErrorDetail;
|
2062
2143
|
}
|
2063
2144
|
export interface GroupMembers {
|
2064
2145
|
/**
|
@@ -2074,17 +2155,17 @@ declare namespace QBusiness {
|
|
2074
2155
|
export type GroupStatus = "FAILED"|"SUCCEEDED"|"PROCESSING"|"DELETING"|"DELETED"|string;
|
2075
2156
|
export interface GroupStatusDetail {
|
2076
2157
|
/**
|
2077
|
-
* The
|
2158
|
+
* The status of a group.
|
2078
2159
|
*/
|
2079
|
-
|
2160
|
+
status?: GroupStatus;
|
2080
2161
|
/**
|
2081
2162
|
* The Unix timestamp when the Amazon Q Business application was last updated.
|
2082
2163
|
*/
|
2083
2164
|
lastUpdatedAt?: Timestamp;
|
2084
2165
|
/**
|
2085
|
-
* The
|
2166
|
+
* The details of an error associated a group status.
|
2086
2167
|
*/
|
2087
|
-
|
2168
|
+
errorDetail?: ErrorDetail;
|
2088
2169
|
}
|
2089
2170
|
export type GroupStatusDetails = GroupStatusDetail[];
|
2090
2171
|
export interface GroupSummary {
|
@@ -2103,21 +2184,17 @@ declare namespace QBusiness {
|
|
2103
2184
|
* The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
|
2104
2185
|
*/
|
2105
2186
|
lambdaArn?: LambdaArn;
|
2106
|
-
/**
|
2107
|
-
* The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
|
2108
|
-
*/
|
2109
|
-
roleArn?: RoleArn;
|
2110
2187
|
/**
|
2111
2188
|
* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
|
2112
2189
|
*/
|
2113
2190
|
s3BucketName?: S3BucketName;
|
2191
|
+
/**
|
2192
|
+
* The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
|
2193
|
+
*/
|
2194
|
+
roleArn?: RoleArn;
|
2114
2195
|
}
|
2115
2196
|
export type IdcApplicationArn = string;
|
2116
2197
|
export interface Index {
|
2117
|
-
/**
|
2118
|
-
* The Unix timestamp when the index was created.
|
2119
|
-
*/
|
2120
|
-
createdAt?: Timestamp;
|
2121
2198
|
/**
|
2122
2199
|
* The name of the index.
|
2123
2200
|
*/
|
@@ -2127,13 +2204,17 @@ declare namespace QBusiness {
|
|
2127
2204
|
*/
|
2128
2205
|
indexId?: IndexId;
|
2129
2206
|
/**
|
2130
|
-
* The
|
2207
|
+
* The Unix timestamp when the index was created.
|
2131
2208
|
*/
|
2132
|
-
|
2209
|
+
createdAt?: Timestamp;
|
2133
2210
|
/**
|
2134
2211
|
* The Unix timestamp when the index was last updated.
|
2135
2212
|
*/
|
2136
2213
|
updatedAt?: Timestamp;
|
2214
|
+
/**
|
2215
|
+
* The current status of the index. When the status is ACTIVE, the index is ready.
|
2216
|
+
*/
|
2217
|
+
status?: IndexStatus;
|
2137
2218
|
}
|
2138
2219
|
export type IndexArn = string;
|
2139
2220
|
export interface IndexCapacityConfiguration {
|
@@ -2152,16 +2233,17 @@ declare namespace QBusiness {
|
|
2152
2233
|
textDocumentStatistics?: TextDocumentStatistics;
|
2153
2234
|
}
|
2154
2235
|
export type IndexStatus = "CREATING"|"ACTIVE"|"DELETING"|"FAILED"|"UPDATING"|string;
|
2236
|
+
export type IndexType = "ENTERPRISE"|"STARTER"|string;
|
2155
2237
|
export type IndexedTextBytes = number;
|
2156
2238
|
export type IndexedTextDocument = number;
|
2157
2239
|
export type Indices = Index[];
|
2158
2240
|
export interface InlineDocumentEnrichmentConfiguration {
|
2159
2241
|
condition?: DocumentAttributeCondition;
|
2242
|
+
target?: DocumentAttributeTarget;
|
2160
2243
|
/**
|
2161
2244
|
* TRUE to delete content if the condition used for the target attribute is met.
|
2162
2245
|
*/
|
2163
2246
|
documentContentOperator?: DocumentContentOperator;
|
2164
|
-
target?: DocumentAttributeTarget;
|
2165
2247
|
}
|
2166
2248
|
export type InlineDocumentEnrichmentConfigurations = InlineDocumentEnrichmentConfiguration[];
|
2167
2249
|
export type InstanceArn = string;
|
@@ -2176,24 +2258,24 @@ declare namespace QBusiness {
|
|
2176
2258
|
export type KmsKeyId = string;
|
2177
2259
|
export type LambdaArn = string;
|
2178
2260
|
export interface ListApplicationsRequest {
|
2261
|
+
/**
|
2262
|
+
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.
|
2263
|
+
*/
|
2264
|
+
nextToken?: NextToken;
|
2179
2265
|
/**
|
2180
2266
|
* The maximum number of Amazon Q Business applications to return.
|
2181
2267
|
*/
|
2182
2268
|
maxResults?: MaxResultsIntegerForListApplications;
|
2269
|
+
}
|
2270
|
+
export interface ListApplicationsResponse {
|
2183
2271
|
/**
|
2184
|
-
* If the
|
2272
|
+
* If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
|
2185
2273
|
*/
|
2186
2274
|
nextToken?: NextToken;
|
2187
|
-
}
|
2188
|
-
export interface ListApplicationsResponse {
|
2189
2275
|
/**
|
2190
2276
|
* An array of summary information on the configuration of one or more Amazon Q Business applications.
|
2191
2277
|
*/
|
2192
2278
|
applications?: Applications;
|
2193
|
-
/**
|
2194
|
-
* If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
|
2195
|
-
*/
|
2196
|
-
nextToken?: NextToken;
|
2197
2279
|
}
|
2198
2280
|
export interface ListConversationsRequest {
|
2199
2281
|
/**
|
@@ -2201,57 +2283,57 @@ declare namespace QBusiness {
|
|
2201
2283
|
*/
|
2202
2284
|
applicationId: ApplicationId;
|
2203
2285
|
/**
|
2204
|
-
* The
|
2286
|
+
* The identifier of the user involved in the Amazon Q Business web experience conversation.
|
2205
2287
|
*/
|
2206
|
-
|
2288
|
+
userId?: UserId;
|
2207
2289
|
/**
|
2208
2290
|
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.
|
2209
2291
|
*/
|
2210
2292
|
nextToken?: NextToken;
|
2211
2293
|
/**
|
2212
|
-
* The
|
2294
|
+
* The maximum number of Amazon Q Business conversations to return.
|
2213
2295
|
*/
|
2214
|
-
|
2296
|
+
maxResults?: MaxResultsIntegerForListConversations;
|
2215
2297
|
}
|
2216
2298
|
export interface ListConversationsResponse {
|
2217
|
-
/**
|
2218
|
-
* An array of summary information on the configuration of one or more Amazon Q Business web experiences.
|
2219
|
-
*/
|
2220
|
-
conversations?: Conversations;
|
2221
2299
|
/**
|
2222
2300
|
* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
|
2223
2301
|
*/
|
2224
2302
|
nextToken?: NextToken;
|
2225
|
-
}
|
2226
|
-
export interface ListDataSourceSyncJobsRequest {
|
2227
2303
|
/**
|
2228
|
-
*
|
2304
|
+
* An array of summary information on the configuration of one or more Amazon Q Business web experiences.
|
2229
2305
|
*/
|
2230
|
-
|
2306
|
+
conversations?: Conversations;
|
2307
|
+
}
|
2308
|
+
export interface ListDataSourceSyncJobsRequest {
|
2231
2309
|
/**
|
2232
2310
|
* The identifier of the data source connector.
|
2233
2311
|
*/
|
2234
2312
|
dataSourceId: DataSourceId;
|
2235
2313
|
/**
|
2236
|
-
*
|
2314
|
+
* The identifier of the Amazon Q Business application connected to the data source.
|
2237
2315
|
*/
|
2238
|
-
|
2316
|
+
applicationId: ApplicationId;
|
2239
2317
|
/**
|
2240
2318
|
* The identifier of the index used with the Amazon Q Business data source connector.
|
2241
2319
|
*/
|
2242
2320
|
indexId: IndexId;
|
2243
|
-
/**
|
2244
|
-
* The maximum number of synchronization jobs to return in the response.
|
2245
|
-
*/
|
2246
|
-
maxResults?: MaxResultsIntegerForListDataSourcesSyncJobs;
|
2247
2321
|
/**
|
2248
2322
|
* If the maxResults response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.
|
2249
2323
|
*/
|
2250
2324
|
nextToken?: NextToken;
|
2325
|
+
/**
|
2326
|
+
* The maximum number of synchronization jobs to return in the response.
|
2327
|
+
*/
|
2328
|
+
maxResults?: MaxResultsIntegerForListDataSourcesSyncJobs;
|
2251
2329
|
/**
|
2252
2330
|
* The start time of the data source connector sync.
|
2253
2331
|
*/
|
2254
2332
|
startTime?: Timestamp;
|
2333
|
+
/**
|
2334
|
+
* The end time of the data source connector sync.
|
2335
|
+
*/
|
2336
|
+
endTime?: Timestamp;
|
2255
2337
|
/**
|
2256
2338
|
* Only returns synchronization jobs with the Status field equal to the specified status.
|
2257
2339
|
*/
|
@@ -2276,14 +2358,14 @@ declare namespace QBusiness {
|
|
2276
2358
|
* The identifier of the index used with one or more data source connectors.
|
2277
2359
|
*/
|
2278
2360
|
indexId: IndexId;
|
2279
|
-
/**
|
2280
|
-
* The maximum number of data source connectors to return.
|
2281
|
-
*/
|
2282
|
-
maxResults?: MaxResultsIntegerForListDataSources;
|
2283
2361
|
/**
|
2284
2362
|
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.
|
2285
2363
|
*/
|
2286
2364
|
nextToken?: NextToken;
|
2365
|
+
/**
|
2366
|
+
* The maximum number of data source connectors to return.
|
2367
|
+
*/
|
2368
|
+
maxResults?: MaxResultsIntegerForListDataSources;
|
2287
2369
|
}
|
2288
2370
|
export interface ListDataSourcesResponse {
|
2289
2371
|
/**
|
@@ -2300,22 +2382,22 @@ declare namespace QBusiness {
|
|
2300
2382
|
* The identifier of the application id the documents are attached to.
|
2301
2383
|
*/
|
2302
2384
|
applicationId: ApplicationId;
|
2303
|
-
/**
|
2304
|
-
* The identifier of the data sources the documents are attached to.
|
2305
|
-
*/
|
2306
|
-
dataSourceIds?: DataSourceIds;
|
2307
2385
|
/**
|
2308
2386
|
* The identifier of the index the documents are attached to.
|
2309
2387
|
*/
|
2310
2388
|
indexId: IndexId;
|
2311
2389
|
/**
|
2312
|
-
* The
|
2390
|
+
* The identifier of the data sources the documents are attached to.
|
2313
2391
|
*/
|
2314
|
-
|
2392
|
+
dataSourceIds?: DataSourceIds;
|
2315
2393
|
/**
|
2316
2394
|
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
|
2317
2395
|
*/
|
2318
2396
|
nextToken?: NextToken;
|
2397
|
+
/**
|
2398
|
+
* The maximum number of documents to return.
|
2399
|
+
*/
|
2400
|
+
maxResults?: MaxResultsIntegerForListDocuments;
|
2319
2401
|
}
|
2320
2402
|
export interface ListDocumentsResponse {
|
2321
2403
|
/**
|
@@ -2332,82 +2414,82 @@ declare namespace QBusiness {
|
|
2332
2414
|
* The identifier of the application for getting a list of groups mapped to users.
|
2333
2415
|
*/
|
2334
2416
|
applicationId: ApplicationId;
|
2335
|
-
/**
|
2336
|
-
* The identifier of the data source for getting a list of groups mapped to users.
|
2337
|
-
*/
|
2338
|
-
dataSourceId?: DataSourceId;
|
2339
2417
|
/**
|
2340
2418
|
* The identifier of the index for getting a list of groups mapped to users.
|
2341
2419
|
*/
|
2342
2420
|
indexId: IndexId;
|
2343
2421
|
/**
|
2344
|
-
* The
|
2422
|
+
* The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
|
2345
2423
|
*/
|
2346
|
-
|
2424
|
+
updatedEarlierThan: Timestamp;
|
2425
|
+
/**
|
2426
|
+
* The identifier of the data source for getting a list of groups mapped to users.
|
2427
|
+
*/
|
2428
|
+
dataSourceId?: DataSourceId;
|
2347
2429
|
/**
|
2348
2430
|
* If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
|
2349
2431
|
*/
|
2350
2432
|
nextToken?: NextToken;
|
2351
2433
|
/**
|
2352
|
-
* The
|
2434
|
+
* The maximum number of returned groups that are mapped to users.
|
2353
2435
|
*/
|
2354
|
-
|
2436
|
+
maxResults?: MaxResultsIntegerForListGroupsRequest;
|
2355
2437
|
}
|
2356
2438
|
export interface ListGroupsResponse {
|
2357
|
-
/**
|
2358
|
-
* Summary information for list of groups that are mapped to users.
|
2359
|
-
*/
|
2360
|
-
items?: GroupSummaryList;
|
2361
2439
|
/**
|
2362
2440
|
* If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
|
2363
2441
|
*/
|
2364
2442
|
nextToken?: NextToken;
|
2443
|
+
/**
|
2444
|
+
* Summary information for list of groups that are mapped to users.
|
2445
|
+
*/
|
2446
|
+
items?: GroupSummaryList;
|
2365
2447
|
}
|
2366
2448
|
export interface ListIndicesRequest {
|
2367
2449
|
/**
|
2368
2450
|
* The identifier of the Amazon Q Business application connected to the index.
|
2369
2451
|
*/
|
2370
2452
|
applicationId: ApplicationId;
|
2453
|
+
/**
|
2454
|
+
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.
|
2455
|
+
*/
|
2456
|
+
nextToken?: NextToken;
|
2371
2457
|
/**
|
2372
2458
|
* The maximum number of indices to return.
|
2373
2459
|
*/
|
2374
2460
|
maxResults?: MaxResultsIntegerForListIndices;
|
2461
|
+
}
|
2462
|
+
export interface ListIndicesResponse {
|
2375
2463
|
/**
|
2376
|
-
* If the
|
2464
|
+
* If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.
|
2377
2465
|
*/
|
2378
2466
|
nextToken?: NextToken;
|
2379
|
-
}
|
2380
|
-
export interface ListIndicesResponse {
|
2381
2467
|
/**
|
2382
2468
|
* An array of information on the items in one or more indexes.
|
2383
2469
|
*/
|
2384
2470
|
indices?: Indices;
|
2385
|
-
/**
|
2386
|
-
* If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.
|
2387
|
-
*/
|
2388
|
-
nextToken?: NextToken;
|
2389
2471
|
}
|
2390
2472
|
export interface ListMessagesRequest {
|
2391
|
-
/**
|
2392
|
-
* The identifier for the Amazon Q Business application.
|
2393
|
-
*/
|
2394
|
-
applicationId: ApplicationId;
|
2395
2473
|
/**
|
2396
2474
|
* The identifier of the Amazon Q Business web experience conversation.
|
2397
2475
|
*/
|
2398
2476
|
conversationId: ConversationId;
|
2399
2477
|
/**
|
2400
|
-
* The
|
2478
|
+
* The identifier for the Amazon Q Business application.
|
2401
2479
|
*/
|
2402
|
-
|
2480
|
+
applicationId: ApplicationId;
|
2481
|
+
/**
|
2482
|
+
* The identifier of the user involved in the Amazon Q Business web experience conversation.
|
2483
|
+
*/
|
2484
|
+
userId?: UserId;
|
2403
2485
|
/**
|
2404
2486
|
* If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
|
2405
2487
|
*/
|
2406
2488
|
nextToken?: NextToken;
|
2407
2489
|
/**
|
2408
|
-
* The
|
2490
|
+
* The maximum number of messages to return.
|
2409
2491
|
*/
|
2410
|
-
|
2492
|
+
maxResults?: MaxResultsIntegerForListMessages;
|
2411
2493
|
}
|
2412
2494
|
export interface ListMessagesResponse {
|
2413
2495
|
/**
|
@@ -2424,14 +2506,14 @@ declare namespace QBusiness {
|
|
2424
2506
|
* The identifier of the application the plugin is attached to.
|
2425
2507
|
*/
|
2426
2508
|
applicationId: ApplicationId;
|
2427
|
-
/**
|
2428
|
-
* The maximum number of documents to return.
|
2429
|
-
*/
|
2430
|
-
maxResults?: MaxResultsIntegerForListPlugins;
|
2431
2509
|
/**
|
2432
2510
|
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
|
2433
2511
|
*/
|
2434
2512
|
nextToken?: NextToken;
|
2513
|
+
/**
|
2514
|
+
* The maximum number of documents to return.
|
2515
|
+
*/
|
2516
|
+
maxResults?: MaxResultsIntegerForListPlugins;
|
2435
2517
|
}
|
2436
2518
|
export interface ListPluginsResponse {
|
2437
2519
|
/**
|
@@ -2448,24 +2530,24 @@ declare namespace QBusiness {
|
|
2448
2530
|
* The identifier of the Amazon Q Business application using the retriever.
|
2449
2531
|
*/
|
2450
2532
|
applicationId: ApplicationId;
|
2451
|
-
/**
|
2452
|
-
* The maximum number of retrievers returned.
|
2453
|
-
*/
|
2454
|
-
maxResults?: MaxResultsIntegerForListRetrieversRequest;
|
2455
2533
|
/**
|
2456
2534
|
* If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.
|
2457
2535
|
*/
|
2458
2536
|
nextToken?: NextToken;
|
2459
|
-
}
|
2460
|
-
export interface ListRetrieversResponse {
|
2461
2537
|
/**
|
2462
|
-
*
|
2538
|
+
* The maximum number of retrievers returned.
|
2463
2539
|
*/
|
2464
|
-
|
2540
|
+
maxResults?: MaxResultsIntegerForListRetrieversRequest;
|
2541
|
+
}
|
2542
|
+
export interface ListRetrieversResponse {
|
2465
2543
|
/**
|
2466
2544
|
* An array of summary information for one or more retrievers.
|
2467
2545
|
*/
|
2468
2546
|
retrievers?: Retrievers;
|
2547
|
+
/**
|
2548
|
+
* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.
|
2549
|
+
*/
|
2550
|
+
nextToken?: NextToken;
|
2469
2551
|
}
|
2470
2552
|
export interface ListTagsForResourceRequest {
|
2471
2553
|
/**
|
@@ -2484,24 +2566,24 @@ declare namespace QBusiness {
|
|
2484
2566
|
* The identifier of the Amazon Q Business application linked to the listed web experiences.
|
2485
2567
|
*/
|
2486
2568
|
applicationId: ApplicationId;
|
2487
|
-
/**
|
2488
|
-
* The maximum number of Amazon Q Business Web Experiences to return.
|
2489
|
-
*/
|
2490
|
-
maxResults?: MaxResultsIntegerForListWebExperiencesRequest;
|
2491
2569
|
/**
|
2492
2570
|
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.
|
2493
2571
|
*/
|
2494
2572
|
nextToken?: NextToken;
|
2495
|
-
}
|
2496
|
-
export interface ListWebExperiencesResponse {
|
2497
2573
|
/**
|
2498
|
-
*
|
2574
|
+
* The maximum number of Amazon Q Business Web Experiences to return.
|
2499
2575
|
*/
|
2500
|
-
|
2576
|
+
maxResults?: MaxResultsIntegerForListWebExperiencesRequest;
|
2577
|
+
}
|
2578
|
+
export interface ListWebExperiencesResponse {
|
2501
2579
|
/**
|
2502
2580
|
* An array of summary information for one or more Amazon Q Business experiences.
|
2503
2581
|
*/
|
2504
2582
|
webExperiences?: WebExperiences;
|
2583
|
+
/**
|
2584
|
+
* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
|
2585
|
+
*/
|
2586
|
+
nextToken?: NextToken;
|
2505
2587
|
}
|
2506
2588
|
export type Long = number;
|
2507
2589
|
export type MaxResultsIntegerForGetTopicConfigurations = number;
|
@@ -2529,36 +2611,26 @@ declare namespace QBusiness {
|
|
2529
2611
|
export type MemberGroups = MemberGroup[];
|
2530
2612
|
export type MemberRelation = "AND"|"OR"|string;
|
2531
2613
|
export interface MemberUser {
|
2532
|
-
/**
|
2533
|
-
* The type of the user.
|
2534
|
-
*/
|
2535
|
-
type?: MembershipType;
|
2536
2614
|
/**
|
2537
2615
|
* The identifier of the user you want to map to a group.
|
2538
2616
|
*/
|
2539
2617
|
userId: DataSourceUserId;
|
2618
|
+
/**
|
2619
|
+
* The type of the user.
|
2620
|
+
*/
|
2621
|
+
type?: MembershipType;
|
2540
2622
|
}
|
2541
2623
|
export type MemberUsers = MemberUser[];
|
2542
2624
|
export type MembershipType = "INDEX"|"DATASOURCE"|string;
|
2543
2625
|
export interface Message {
|
2544
|
-
actionExecution?: ActionExecution;
|
2545
|
-
actionReview?: ActionReview;
|
2546
|
-
/**
|
2547
|
-
* A file directly uploaded into an Amazon Q Business web experience chat.
|
2548
|
-
*/
|
2549
|
-
attachments?: AttachmentsOutput;
|
2550
|
-
/**
|
2551
|
-
* The content of the Amazon Q Business web experience message.
|
2552
|
-
*/
|
2553
|
-
body?: MessageBody;
|
2554
2626
|
/**
|
2555
2627
|
* The identifier of the Amazon Q Business web experience message.
|
2556
2628
|
*/
|
2557
2629
|
messageId?: String;
|
2558
2630
|
/**
|
2559
|
-
* The
|
2631
|
+
* The content of the Amazon Q Business web experience message.
|
2560
2632
|
*/
|
2561
|
-
|
2633
|
+
body?: MessageBody;
|
2562
2634
|
/**
|
2563
2635
|
* The timestamp of the first Amazon Q Business web experience message.
|
2564
2636
|
*/
|
@@ -2567,6 +2639,16 @@ declare namespace QBusiness {
|
|
2567
2639
|
* The type of Amazon Q Business message, whether HUMAN or AI generated.
|
2568
2640
|
*/
|
2569
2641
|
type?: MessageType;
|
2642
|
+
/**
|
2643
|
+
* A file directly uploaded into an Amazon Q Business web experience chat.
|
2644
|
+
*/
|
2645
|
+
attachments?: AttachmentsOutput;
|
2646
|
+
/**
|
2647
|
+
* The source documents used to generate Amazon Q Business web experience message.
|
2648
|
+
*/
|
2649
|
+
sourceAttribution?: SourceAttributions;
|
2650
|
+
actionReview?: ActionReview;
|
2651
|
+
actionExecution?: ActionExecution;
|
2570
2652
|
}
|
2571
2653
|
export type MessageBody = string;
|
2572
2654
|
export type MessageId = string;
|
@@ -2575,36 +2657,38 @@ declare namespace QBusiness {
|
|
2575
2657
|
export type MessageUsefulnessComment = string;
|
2576
2658
|
export interface MessageUsefulnessFeedback {
|
2577
2659
|
/**
|
2578
|
-
*
|
2660
|
+
* The usefulness value assigned by an end user to a message.
|
2579
2661
|
*/
|
2580
|
-
|
2662
|
+
usefulness: MessageUsefulness;
|
2581
2663
|
/**
|
2582
2664
|
* The reason for a usefulness rating.
|
2583
2665
|
*/
|
2584
2666
|
reason?: MessageUsefulnessReason;
|
2585
2667
|
/**
|
2586
|
-
*
|
2668
|
+
* A comment given by an end user on the usefulness of an AI-generated chat message.
|
2587
2669
|
*/
|
2588
|
-
|
2670
|
+
comment?: MessageUsefulnessComment;
|
2589
2671
|
/**
|
2590
|
-
* The
|
2672
|
+
* The timestamp for when the feedback was submitted.
|
2591
2673
|
*/
|
2592
|
-
|
2674
|
+
submittedAt: Timestamp;
|
2593
2675
|
}
|
2594
2676
|
export type MessageUsefulnessReason = "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"|string;
|
2595
2677
|
export type Messages = Message[];
|
2596
2678
|
export type MetricValue = string;
|
2597
2679
|
export interface NativeIndexConfiguration {
|
2598
|
-
/**
|
2599
|
-
* Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
|
2600
|
-
*/
|
2601
|
-
boostingOverride?: DocumentAttributeBoostingOverrideMap;
|
2602
2680
|
/**
|
2603
2681
|
* The identifier for the Amazon Q Business index.
|
2604
2682
|
*/
|
2605
2683
|
indexId: IndexId;
|
2684
|
+
/**
|
2685
|
+
* Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
|
2686
|
+
*/
|
2687
|
+
boostingOverride?: DocumentAttributeBoostingOverrideMap;
|
2606
2688
|
}
|
2607
2689
|
export type NextToken = string;
|
2690
|
+
export interface NoAuthConfiguration {
|
2691
|
+
}
|
2608
2692
|
export interface NumberAttributeBoostingConfiguration {
|
2609
2693
|
/**
|
2610
2694
|
* Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.
|
@@ -2617,28 +2701,29 @@ declare namespace QBusiness {
|
|
2617
2701
|
}
|
2618
2702
|
export type NumberAttributeBoostingType = "PRIORITIZE_LARGER_VALUES"|"PRIORITIZE_SMALLER_VALUES"|string;
|
2619
2703
|
export interface OAuth2ClientCredentialConfiguration {
|
2620
|
-
/**
|
2621
|
-
* The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
|
2622
|
-
*/
|
2623
|
-
roleArn: RoleArn;
|
2624
2704
|
/**
|
2625
2705
|
* The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
|
2626
2706
|
*/
|
2627
2707
|
secretArn: SecretArn;
|
2708
|
+
/**
|
2709
|
+
* The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
|
2710
|
+
*/
|
2711
|
+
roleArn: RoleArn;
|
2628
2712
|
}
|
2713
|
+
export type Payload = string;
|
2629
2714
|
export interface Plugin {
|
2630
2715
|
/**
|
2631
|
-
* The
|
2716
|
+
* The identifier of the plugin.
|
2632
2717
|
*/
|
2633
|
-
|
2718
|
+
pluginId?: PluginId;
|
2634
2719
|
/**
|
2635
2720
|
* The name of the plugin.
|
2636
2721
|
*/
|
2637
2722
|
displayName?: PluginName;
|
2638
2723
|
/**
|
2639
|
-
* The
|
2724
|
+
* The type of the plugin.
|
2640
2725
|
*/
|
2641
|
-
|
2726
|
+
type?: PluginType;
|
2642
2727
|
/**
|
2643
2728
|
* The plugin server URL used for configuration.
|
2644
2729
|
*/
|
@@ -2648,9 +2733,13 @@ declare namespace QBusiness {
|
|
2648
2733
|
*/
|
2649
2734
|
state?: PluginState;
|
2650
2735
|
/**
|
2651
|
-
* The
|
2736
|
+
* The status of the plugin.
|
2652
2737
|
*/
|
2653
|
-
|
2738
|
+
buildStatus?: PluginBuildStatus;
|
2739
|
+
/**
|
2740
|
+
* The timestamp for when the plugin was created.
|
2741
|
+
*/
|
2742
|
+
createdAt?: Timestamp;
|
2654
2743
|
/**
|
2655
2744
|
* The timestamp for when the plugin was last updated.
|
2656
2745
|
*/
|
@@ -2666,29 +2755,39 @@ declare namespace QBusiness {
|
|
2666
2755
|
* Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
|
2667
2756
|
*/
|
2668
2757
|
oAuth2ClientCredentialConfiguration?: OAuth2ClientCredentialConfiguration;
|
2758
|
+
/**
|
2759
|
+
* Information about invoking a custom plugin without any authentication.
|
2760
|
+
*/
|
2761
|
+
noAuthConfiguration?: NoAuthConfiguration;
|
2669
2762
|
}
|
2763
|
+
export type PluginBuildStatus = "READY"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|string;
|
2670
2764
|
export interface PluginConfiguration {
|
2671
2765
|
/**
|
2672
2766
|
* The identifier of the plugin you want to use.
|
2673
2767
|
*/
|
2674
2768
|
pluginId: PluginId;
|
2675
2769
|
}
|
2770
|
+
export type PluginDescription = string;
|
2676
2771
|
export type PluginId = string;
|
2677
2772
|
export type PluginName = string;
|
2678
2773
|
export type PluginState = "ENABLED"|"DISABLED"|string;
|
2679
|
-
export type PluginType = "SERVICE_NOW"|"SALESFORCE"|"JIRA"|"ZENDESK"|string;
|
2774
|
+
export type PluginType = "SERVICE_NOW"|"SALESFORCE"|"JIRA"|"ZENDESK"|"CUSTOM"|string;
|
2680
2775
|
export type Plugins = Plugin[];
|
2681
2776
|
export interface Principal {
|
2682
|
-
/**
|
2683
|
-
* The group associated with the principal.
|
2684
|
-
*/
|
2685
|
-
group?: PrincipalGroup;
|
2686
2777
|
/**
|
2687
2778
|
* The user associated with the principal.
|
2688
2779
|
*/
|
2689
2780
|
user?: PrincipalUser;
|
2781
|
+
/**
|
2782
|
+
* The group associated with the principal.
|
2783
|
+
*/
|
2784
|
+
group?: PrincipalGroup;
|
2690
2785
|
}
|
2691
2786
|
export interface PrincipalGroup {
|
2787
|
+
/**
|
2788
|
+
* The name of the group.
|
2789
|
+
*/
|
2790
|
+
name?: GroupName;
|
2692
2791
|
/**
|
2693
2792
|
* Provides information about whether to allow or deny access to the principal.
|
2694
2793
|
*/
|
@@ -2697,20 +2796,16 @@ declare namespace QBusiness {
|
|
2697
2796
|
* The type of group.
|
2698
2797
|
*/
|
2699
2798
|
membershipType?: MembershipType;
|
2700
|
-
/**
|
2701
|
-
* The name of the group.
|
2702
|
-
*/
|
2703
|
-
name?: GroupName;
|
2704
2799
|
}
|
2705
2800
|
export interface PrincipalUser {
|
2706
|
-
/**
|
2707
|
-
* Provides information about whether to allow or deny access to the principal.
|
2708
|
-
*/
|
2709
|
-
access: ReadAccessType;
|
2710
2801
|
/**
|
2711
2802
|
* The identifier of the user.
|
2712
2803
|
*/
|
2713
2804
|
id?: UserId;
|
2805
|
+
/**
|
2806
|
+
* Provides information about whether to allow or deny access to the principal.
|
2807
|
+
*/
|
2808
|
+
access: ReadAccessType;
|
2714
2809
|
/**
|
2715
2810
|
* The type of group.
|
2716
2811
|
*/
|
@@ -2723,25 +2818,25 @@ declare namespace QBusiness {
|
|
2723
2818
|
*/
|
2724
2819
|
applicationId: ApplicationId;
|
2725
2820
|
/**
|
2726
|
-
* The identifier of the
|
2821
|
+
* The identifier of the user giving the feedback.
|
2727
2822
|
*/
|
2728
|
-
|
2823
|
+
userId?: UserId;
|
2729
2824
|
/**
|
2730
|
-
* The
|
2825
|
+
* The identifier of the conversation the feedback is attached to.
|
2731
2826
|
*/
|
2732
|
-
|
2827
|
+
conversationId: ConversationId;
|
2733
2828
|
/**
|
2734
2829
|
* The identifier of the chat message that the feedback was given for.
|
2735
2830
|
*/
|
2736
2831
|
messageId: SystemMessageId;
|
2737
2832
|
/**
|
2738
|
-
* The
|
2833
|
+
* The timestamp for when the feedback was recorded.
|
2739
2834
|
*/
|
2740
|
-
|
2835
|
+
messageCopiedAt?: Timestamp;
|
2741
2836
|
/**
|
2742
|
-
* The
|
2837
|
+
* The feedback usefulness value given by the user to the chat message.
|
2743
2838
|
*/
|
2744
|
-
|
2839
|
+
messageUsefulness?: MessageUsefulnessFeedback;
|
2745
2840
|
}
|
2746
2841
|
export interface PutGroupRequest {
|
2747
2842
|
/**
|
@@ -2749,22 +2844,22 @@ declare namespace QBusiness {
|
|
2749
2844
|
*/
|
2750
2845
|
applicationId: ApplicationId;
|
2751
2846
|
/**
|
2752
|
-
* The identifier of the
|
2847
|
+
* The identifier of the index in which you want to map users to their groups.
|
2753
2848
|
*/
|
2754
|
-
|
2755
|
-
groupMembers: GroupMembers;
|
2849
|
+
indexId: IndexId;
|
2756
2850
|
/**
|
2757
2851
|
* The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing". If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
|
2758
2852
|
*/
|
2759
2853
|
groupName: GroupName;
|
2760
2854
|
/**
|
2761
|
-
* The identifier of the
|
2855
|
+
* The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.
|
2762
2856
|
*/
|
2763
|
-
|
2857
|
+
dataSourceId?: DataSourceId;
|
2764
2858
|
/**
|
2765
2859
|
* The type of the group.
|
2766
2860
|
*/
|
2767
2861
|
type: MembershipType;
|
2862
|
+
groupMembers: GroupMembers;
|
2768
2863
|
}
|
2769
2864
|
export interface PutGroupResponse {
|
2770
2865
|
}
|
@@ -2775,33 +2870,33 @@ declare namespace QBusiness {
|
|
2775
2870
|
* The identifier of the Amazon Q Business application using the retriever.
|
2776
2871
|
*/
|
2777
2872
|
applicationId?: ApplicationId;
|
2778
|
-
/**
|
2779
|
-
* The name of your retriever.
|
2780
|
-
*/
|
2781
|
-
displayName?: RetrieverName;
|
2782
2873
|
/**
|
2783
2874
|
* The identifier of the retriever used by your Amazon Q Business application.
|
2784
2875
|
*/
|
2785
2876
|
retrieverId?: RetrieverId;
|
2877
|
+
/**
|
2878
|
+
* The type of your retriever.
|
2879
|
+
*/
|
2880
|
+
type?: RetrieverType;
|
2786
2881
|
/**
|
2787
2882
|
* The status of your retriever.
|
2788
2883
|
*/
|
2789
2884
|
status?: RetrieverStatus;
|
2790
2885
|
/**
|
2791
|
-
* The
|
2886
|
+
* The name of your retriever.
|
2792
2887
|
*/
|
2793
|
-
|
2888
|
+
displayName?: RetrieverName;
|
2794
2889
|
}
|
2795
2890
|
export type RetrieverArn = string;
|
2796
2891
|
export interface RetrieverConfiguration {
|
2797
|
-
/**
|
2798
|
-
* Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
|
2799
|
-
*/
|
2800
|
-
kendraIndexConfiguration?: KendraIndexConfiguration;
|
2801
2892
|
/**
|
2802
2893
|
* Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
|
2803
2894
|
*/
|
2804
2895
|
nativeIndexConfiguration?: NativeIndexConfiguration;
|
2896
|
+
/**
|
2897
|
+
* Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
|
2898
|
+
*/
|
2899
|
+
kendraIndexConfiguration?: KendraIndexConfiguration;
|
2805
2900
|
}
|
2806
2901
|
export type RetrieverId = string;
|
2807
2902
|
export type RetrieverName = string;
|
@@ -2810,22 +2905,22 @@ declare namespace QBusiness {
|
|
2810
2905
|
export type Retrievers = Retriever[];
|
2811
2906
|
export type RoleArn = string;
|
2812
2907
|
export interface Rule {
|
2813
|
-
/**
|
2814
|
-
* Users and groups to be excluded from a rule.
|
2815
|
-
*/
|
2816
|
-
excludedUsersAndGroups?: UsersAndGroups;
|
2817
2908
|
/**
|
2818
2909
|
* Users and groups to be included in a rule.
|
2819
2910
|
*/
|
2820
2911
|
includedUsersAndGroups?: UsersAndGroups;
|
2821
2912
|
/**
|
2822
|
-
*
|
2913
|
+
* Users and groups to be excluded from a rule.
|
2823
2914
|
*/
|
2824
|
-
|
2915
|
+
excludedUsersAndGroups?: UsersAndGroups;
|
2825
2916
|
/**
|
2826
2917
|
* The type of rule.
|
2827
2918
|
*/
|
2828
2919
|
ruleType: RuleType;
|
2920
|
+
/**
|
2921
|
+
* The configuration information for a rule.
|
2922
|
+
*/
|
2923
|
+
ruleConfiguration?: RuleConfiguration;
|
2829
2924
|
}
|
2830
2925
|
export interface RuleConfiguration {
|
2831
2926
|
/**
|
@@ -2858,55 +2953,62 @@ declare namespace QBusiness {
|
|
2858
2953
|
* The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
|
2859
2954
|
*/
|
2860
2955
|
roleArn: RoleArn;
|
2861
|
-
/**
|
2862
|
-
* The group attribute name in your IdP that maps to user groups.
|
2863
|
-
*/
|
2864
|
-
userGroupAttribute?: SamlAttribute;
|
2865
2956
|
/**
|
2866
2957
|
* The user attribute name in your IdP that maps to the user email.
|
2867
2958
|
*/
|
2868
2959
|
userIdAttribute: SamlAttribute;
|
2960
|
+
/**
|
2961
|
+
* The group attribute name in your IdP that maps to user groups.
|
2962
|
+
*/
|
2963
|
+
userGroupAttribute?: SamlAttribute;
|
2869
2964
|
}
|
2870
2965
|
export type SamlMetadataXML = string;
|
2871
2966
|
export type SecretArn = string;
|
2872
2967
|
export type SecurityGroupId = string;
|
2873
2968
|
export type SecurityGroupIds = SecurityGroupId[];
|
2969
|
+
export interface SnippetExcerpt {
|
2970
|
+
/**
|
2971
|
+
* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
|
2972
|
+
*/
|
2973
|
+
text?: SnippetExcerptText;
|
2974
|
+
}
|
2975
|
+
export type SnippetExcerptText = string;
|
2874
2976
|
export interface SourceAttribution {
|
2875
2977
|
/**
|
2876
|
-
* The
|
2978
|
+
* The title of the document which is the source for the Amazon Q Business generated response.
|
2877
2979
|
*/
|
2878
|
-
|
2980
|
+
title?: String;
|
2879
2981
|
/**
|
2880
2982
|
* The content extract from the document on which the generated response is based.
|
2881
2983
|
*/
|
2882
2984
|
snippet?: String;
|
2883
2985
|
/**
|
2884
|
-
*
|
2986
|
+
* The URL of the document which is the source for the Amazon Q Business generated response.
|
2885
2987
|
*/
|
2886
|
-
|
2988
|
+
url?: String;
|
2887
2989
|
/**
|
2888
|
-
* The
|
2990
|
+
* The number attached to a citation in an Amazon Q Business generated response.
|
2889
2991
|
*/
|
2890
|
-
|
2992
|
+
citationNumber?: Integer;
|
2891
2993
|
/**
|
2892
2994
|
* The Unix timestamp when the Amazon Q Business application was last updated.
|
2893
2995
|
*/
|
2894
2996
|
updatedAt?: Timestamp;
|
2895
2997
|
/**
|
2896
|
-
*
|
2998
|
+
* A text extract from a source document that is used for source attribution.
|
2897
2999
|
*/
|
2898
|
-
|
3000
|
+
textMessageSegments?: TextSegmentList;
|
2899
3001
|
}
|
2900
3002
|
export type SourceAttributions = SourceAttribution[];
|
2901
3003
|
export interface StartDataSourceSyncJobRequest {
|
2902
|
-
/**
|
2903
|
-
* The identifier of Amazon Q Business application the data source is connected to.
|
2904
|
-
*/
|
2905
|
-
applicationId: ApplicationId;
|
2906
3004
|
/**
|
2907
3005
|
* The identifier of the data source connector.
|
2908
3006
|
*/
|
2909
3007
|
dataSourceId: DataSourceId;
|
3008
|
+
/**
|
3009
|
+
* The identifier of Amazon Q Business application the data source is connected to.
|
3010
|
+
*/
|
3011
|
+
applicationId: ApplicationId;
|
2910
3012
|
/**
|
2911
3013
|
* The identifier of the index used with the data source connector.
|
2912
3014
|
*/
|
@@ -2920,14 +3022,14 @@ declare namespace QBusiness {
|
|
2920
3022
|
}
|
2921
3023
|
export type Status = "ENABLED"|"DISABLED"|string;
|
2922
3024
|
export interface StopDataSourceSyncJobRequest {
|
2923
|
-
/**
|
2924
|
-
* The identifier of the Amazon Q Business application that the data source is connected to.
|
2925
|
-
*/
|
2926
|
-
applicationId: ApplicationId;
|
2927
3025
|
/**
|
2928
3026
|
* The identifier of the data source connector.
|
2929
3027
|
*/
|
2930
3028
|
dataSourceId: DataSourceId;
|
3029
|
+
/**
|
3030
|
+
* The identifier of the Amazon Q Business application that the data source is connected to.
|
3031
|
+
*/
|
3032
|
+
applicationId: ApplicationId;
|
2931
3033
|
/**
|
2932
3034
|
* The identifier of the index used with the Amazon Q Business data source connector.
|
2933
3035
|
*/
|
@@ -2937,14 +3039,14 @@ declare namespace QBusiness {
|
|
2937
3039
|
}
|
2938
3040
|
export type String = string;
|
2939
3041
|
export interface StringAttributeBoostingConfiguration {
|
2940
|
-
/**
|
2941
|
-
* Specifies specific values of a STRING type document attribute being boosted.
|
2942
|
-
*/
|
2943
|
-
attributeValueBoosting?: StringAttributeValueBoosting;
|
2944
3042
|
/**
|
2945
3043
|
* Specifies how much a document attribute is boosted.
|
2946
3044
|
*/
|
2947
3045
|
boostingLevel: DocumentAttributeBoostingLevel;
|
3046
|
+
/**
|
3047
|
+
* Specifies specific values of a STRING type document attribute being boosted.
|
3048
|
+
*/
|
3049
|
+
attributeValueBoosting?: StringAttributeValueBoosting;
|
2948
3050
|
}
|
2949
3051
|
export type StringAttributeValueBoosting = {[key: string]: StringAttributeValueBoostingLevel};
|
2950
3052
|
export type StringAttributeValueBoostingLevel = "LOW"|"MEDIUM"|"HIGH"|"VERY_HIGH"|string;
|
@@ -3004,11 +3106,19 @@ declare namespace QBusiness {
|
|
3004
3106
|
* The zero-based location in the response string where the source attribution ends.
|
3005
3107
|
*/
|
3006
3108
|
endOffset?: Integer;
|
3109
|
+
/**
|
3110
|
+
* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
|
3111
|
+
*/
|
3112
|
+
snippetExcerpt?: SnippetExcerpt;
|
3007
3113
|
}
|
3008
3114
|
export type TextSegmentList = TextSegment[];
|
3009
3115
|
export type Timestamp = Date;
|
3010
3116
|
export type Title = string;
|
3011
3117
|
export interface TopicConfiguration {
|
3118
|
+
/**
|
3119
|
+
* A name for your topic control configuration.
|
3120
|
+
*/
|
3121
|
+
name: TopicConfigurationName;
|
3012
3122
|
/**
|
3013
3123
|
* A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
|
3014
3124
|
*/
|
@@ -3017,10 +3127,6 @@ declare namespace QBusiness {
|
|
3017
3127
|
* A list of example phrases that you expect the end user to use in relation to the topic.
|
3018
3128
|
*/
|
3019
3129
|
exampleChatMessages?: ExampleChatMessages;
|
3020
|
-
/**
|
3021
|
-
* A name for your topic control configuration.
|
3022
|
-
*/
|
3023
|
-
name: TopicConfigurationName;
|
3024
3130
|
/**
|
3025
3131
|
* Rules defined for a topic configuration.
|
3026
3132
|
*/
|
@@ -3047,21 +3153,25 @@ declare namespace QBusiness {
|
|
3047
3153
|
*/
|
3048
3154
|
applicationId: ApplicationId;
|
3049
3155
|
/**
|
3050
|
-
*
|
3051
|
-
*/
|
3052
|
-
attachmentsConfiguration?: AttachmentsConfiguration;
|
3053
|
-
/**
|
3054
|
-
* A description for the Amazon Q Business application.
|
3156
|
+
* The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
|
3055
3157
|
*/
|
3056
|
-
|
3158
|
+
identityCenterInstanceArn?: InstanceArn;
|
3057
3159
|
/**
|
3058
3160
|
* A name for the Amazon Q Business application.
|
3059
3161
|
*/
|
3060
3162
|
displayName?: ApplicationName;
|
3163
|
+
/**
|
3164
|
+
* A description for the Amazon Q Business application.
|
3165
|
+
*/
|
3166
|
+
description?: Description;
|
3061
3167
|
/**
|
3062
3168
|
* An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
|
3063
3169
|
*/
|
3064
3170
|
roleArn?: RoleArn;
|
3171
|
+
/**
|
3172
|
+
* An option to allow end users to upload files directly during chat.
|
3173
|
+
*/
|
3174
|
+
attachmentsConfiguration?: AttachmentsConfiguration;
|
3065
3175
|
}
|
3066
3176
|
export interface UpdateApplicationResponse {
|
3067
3177
|
}
|
@@ -3070,22 +3180,18 @@ declare namespace QBusiness {
|
|
3070
3180
|
* The identifier of the application for which the chat controls are configured.
|
3071
3181
|
*/
|
3072
3182
|
applicationId: ApplicationId;
|
3073
|
-
/**
|
3074
|
-
* The phrases blocked from chat by your chat control configuration.
|
3075
|
-
*/
|
3076
|
-
blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate;
|
3077
3183
|
/**
|
3078
3184
|
* A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
|
3079
3185
|
*/
|
3080
3186
|
clientToken?: ClientToken;
|
3081
|
-
/**
|
3082
|
-
* The configuration details for CREATOR_MODE.
|
3083
|
-
*/
|
3084
|
-
creatorModeConfiguration?: CreatorModeConfiguration;
|
3085
3187
|
/**
|
3086
3188
|
* The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
|
3087
3189
|
*/
|
3088
3190
|
responseScope?: ResponseScope;
|
3191
|
+
/**
|
3192
|
+
* The phrases blocked from chat by your chat control configuration.
|
3193
|
+
*/
|
3194
|
+
blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate;
|
3089
3195
|
/**
|
3090
3196
|
* The configured topic specific chat controls you want to update.
|
3091
3197
|
*/
|
@@ -3094,6 +3200,10 @@ declare namespace QBusiness {
|
|
3094
3200
|
* The configured topic specific chat controls you want to delete.
|
3095
3201
|
*/
|
3096
3202
|
topicConfigurationsToDelete?: TopicConfigurations;
|
3203
|
+
/**
|
3204
|
+
* The configuration details for CREATOR_MODE.
|
3205
|
+
*/
|
3206
|
+
creatorModeConfiguration?: CreatorModeConfiguration;
|
3097
3207
|
}
|
3098
3208
|
export interface UpdateChatControlsConfigurationResponse {
|
3099
3209
|
}
|
@@ -3102,33 +3212,33 @@ declare namespace QBusiness {
|
|
3102
3212
|
* The identifier of the Amazon Q Business application the data source is attached to.
|
3103
3213
|
*/
|
3104
3214
|
applicationId: ApplicationId;
|
3105
|
-
configuration?: DataSourceConfiguration;
|
3106
3215
|
/**
|
3107
|
-
* The identifier of the data source connector.
|
3216
|
+
* The identifier of the index attached to the data source connector.
|
3108
3217
|
*/
|
3109
|
-
|
3218
|
+
indexId: IndexId;
|
3110
3219
|
/**
|
3111
|
-
* The
|
3220
|
+
* The identifier of the data source connector.
|
3112
3221
|
*/
|
3113
|
-
|
3222
|
+
dataSourceId: DataSourceId;
|
3114
3223
|
/**
|
3115
3224
|
* A name of the data source connector.
|
3116
3225
|
*/
|
3117
3226
|
displayName?: DataSourceName;
|
3118
|
-
|
3119
|
-
|
3120
|
-
* The identifier of the index attached to the data source connector.
|
3121
|
-
*/
|
3122
|
-
indexId: IndexId;
|
3227
|
+
configuration?: DataSourceConfiguration;
|
3228
|
+
vpcConfiguration?: DataSourceVpcConfiguration;
|
3123
3229
|
/**
|
3124
|
-
* The
|
3230
|
+
* The description of the data source connector.
|
3125
3231
|
*/
|
3126
|
-
|
3232
|
+
description?: Description;
|
3127
3233
|
/**
|
3128
3234
|
* The chosen update frequency for your data source.
|
3129
3235
|
*/
|
3130
3236
|
syncSchedule?: SyncSchedule;
|
3131
|
-
|
3237
|
+
/**
|
3238
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
|
3239
|
+
*/
|
3240
|
+
roleArn?: RoleArn;
|
3241
|
+
documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
|
3132
3242
|
}
|
3133
3243
|
export interface UpdateDataSourceResponse {
|
3134
3244
|
}
|
@@ -3138,25 +3248,25 @@ declare namespace QBusiness {
|
|
3138
3248
|
*/
|
3139
3249
|
applicationId: ApplicationId;
|
3140
3250
|
/**
|
3141
|
-
* The
|
3251
|
+
* The identifier of the Amazon Q Business index.
|
3142
3252
|
*/
|
3143
|
-
|
3253
|
+
indexId: IndexId;
|
3254
|
+
/**
|
3255
|
+
* The name of the Amazon Q Business index.
|
3256
|
+
*/
|
3257
|
+
displayName?: ApplicationName;
|
3144
3258
|
/**
|
3145
3259
|
* The description of the Amazon Q Business index.
|
3146
3260
|
*/
|
3147
3261
|
description?: Description;
|
3148
3262
|
/**
|
3149
|
-
* The
|
3263
|
+
* The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
|
3150
3264
|
*/
|
3151
|
-
|
3265
|
+
capacityConfiguration?: IndexCapacityConfiguration;
|
3152
3266
|
/**
|
3153
3267
|
* Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
|
3154
3268
|
*/
|
3155
3269
|
documentAttributeConfigurations?: DocumentAttributeConfigurations;
|
3156
|
-
/**
|
3157
|
-
* The identifier of the Amazon Q Business index.
|
3158
|
-
*/
|
3159
|
-
indexId: IndexId;
|
3160
3270
|
}
|
3161
3271
|
export interface UpdateIndexResponse {
|
3162
3272
|
}
|
@@ -3166,25 +3276,29 @@ declare namespace QBusiness {
|
|
3166
3276
|
*/
|
3167
3277
|
applicationId: ApplicationId;
|
3168
3278
|
/**
|
3169
|
-
* The
|
3279
|
+
* The identifier of the plugin.
|
3170
3280
|
*/
|
3171
|
-
|
3281
|
+
pluginId: PluginId;
|
3172
3282
|
/**
|
3173
3283
|
* The name of the plugin.
|
3174
3284
|
*/
|
3175
3285
|
displayName?: PluginName;
|
3176
3286
|
/**
|
3177
|
-
* The
|
3287
|
+
* The status of the plugin.
|
3178
3288
|
*/
|
3179
|
-
|
3289
|
+
state?: PluginState;
|
3180
3290
|
/**
|
3181
3291
|
* The source URL used for plugin configuration.
|
3182
3292
|
*/
|
3183
3293
|
serverUrl?: Url;
|
3184
3294
|
/**
|
3185
|
-
* The
|
3295
|
+
* The configuration for a custom plugin.
|
3186
3296
|
*/
|
3187
|
-
|
3297
|
+
customPluginConfiguration?: CustomPluginConfiguration;
|
3298
|
+
/**
|
3299
|
+
* The authentication configuration the plugin is using.
|
3300
|
+
*/
|
3301
|
+
authConfiguration?: PluginAuthConfiguration;
|
3188
3302
|
}
|
3189
3303
|
export interface UpdatePluginResponse {
|
3190
3304
|
}
|
@@ -3193,15 +3307,15 @@ declare namespace QBusiness {
|
|
3193
3307
|
* The identifier of your Amazon Q Business application.
|
3194
3308
|
*/
|
3195
3309
|
applicationId: ApplicationId;
|
3310
|
+
/**
|
3311
|
+
* The identifier of your retriever.
|
3312
|
+
*/
|
3313
|
+
retrieverId: RetrieverId;
|
3196
3314
|
configuration?: RetrieverConfiguration;
|
3197
3315
|
/**
|
3198
3316
|
* The name of your retriever.
|
3199
3317
|
*/
|
3200
3318
|
displayName?: RetrieverName;
|
3201
|
-
/**
|
3202
|
-
* The identifier of your retriever.
|
3203
|
-
*/
|
3204
|
-
retrieverId: RetrieverId;
|
3205
3319
|
/**
|
3206
3320
|
* The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
|
3207
3321
|
*/
|
@@ -3215,31 +3329,31 @@ declare namespace QBusiness {
|
|
3215
3329
|
*/
|
3216
3330
|
applicationId: ApplicationId;
|
3217
3331
|
/**
|
3218
|
-
* The
|
3332
|
+
* The email id attached to the user.
|
3219
3333
|
*/
|
3220
|
-
|
3334
|
+
userId: String;
|
3221
3335
|
/**
|
3222
3336
|
* The user aliases attached to the user id that are to be updated.
|
3223
3337
|
*/
|
3224
3338
|
userAliasesToUpdate?: UserAliases;
|
3225
3339
|
/**
|
3226
|
-
* The
|
3340
|
+
* The user aliases attached to the user id that are to be deleted.
|
3227
3341
|
*/
|
3228
|
-
|
3342
|
+
userAliasesToDelete?: UserAliases;
|
3229
3343
|
}
|
3230
3344
|
export interface UpdateUserResponse {
|
3231
3345
|
/**
|
3232
3346
|
* The user aliases that have been to be added to a user id.
|
3233
3347
|
*/
|
3234
3348
|
userAliasesAdded?: UserAliases;
|
3235
|
-
/**
|
3236
|
-
* The user aliases that have been deleted from a user id.
|
3237
|
-
*/
|
3238
|
-
userAliasesDeleted?: UserAliases;
|
3239
3349
|
/**
|
3240
3350
|
* The user aliases attached to a user id that have been updated.
|
3241
3351
|
*/
|
3242
3352
|
userAliasesUpdated?: UserAliases;
|
3353
|
+
/**
|
3354
|
+
* The user aliases that have been deleted from a user id.
|
3355
|
+
*/
|
3356
|
+
userAliasesDeleted?: UserAliases;
|
3243
3357
|
}
|
3244
3358
|
export interface UpdateWebExperienceRequest {
|
3245
3359
|
/**
|
@@ -3247,42 +3361,46 @@ declare namespace QBusiness {
|
|
3247
3361
|
*/
|
3248
3362
|
applicationId: ApplicationId;
|
3249
3363
|
/**
|
3250
|
-
* The
|
3364
|
+
* The identifier of the Amazon Q Business web experience.
|
3251
3365
|
*/
|
3252
|
-
|
3366
|
+
webExperienceId: WebExperienceId;
|
3253
3367
|
/**
|
3254
|
-
*
|
3368
|
+
* The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
|
3255
3369
|
*/
|
3256
|
-
|
3370
|
+
roleArn?: RoleArn;
|
3257
3371
|
/**
|
3258
|
-
* The
|
3372
|
+
* The authentication configuration of the Amazon Q Business web experience.
|
3259
3373
|
*/
|
3260
|
-
|
3374
|
+
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
3261
3375
|
/**
|
3262
3376
|
* The title of the Amazon Q Business web experience.
|
3263
3377
|
*/
|
3264
3378
|
title?: WebExperienceTitle;
|
3265
3379
|
/**
|
3266
|
-
* The
|
3380
|
+
* The subtitle of the Amazon Q Business web experience.
|
3267
3381
|
*/
|
3268
|
-
|
3382
|
+
subtitle?: WebExperienceSubtitle;
|
3269
3383
|
/**
|
3270
3384
|
* A customized welcome message for an end user in an Amazon Q Business web experience.
|
3271
3385
|
*/
|
3272
3386
|
welcomeMessage?: WebExperienceWelcomeMessage;
|
3387
|
+
/**
|
3388
|
+
* Determines whether sample prompts are enabled in the web experience for an end user.
|
3389
|
+
*/
|
3390
|
+
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
3273
3391
|
}
|
3274
3392
|
export interface UpdateWebExperienceResponse {
|
3275
3393
|
}
|
3276
3394
|
export type Url = string;
|
3277
3395
|
export interface UserAlias {
|
3278
|
-
/**
|
3279
|
-
* The identifier of the data source that the user aliases are associated with.
|
3280
|
-
*/
|
3281
|
-
dataSourceId?: DataSourceId;
|
3282
3396
|
/**
|
3283
3397
|
* The identifier of the index that the user aliases are associated with.
|
3284
3398
|
*/
|
3285
3399
|
indexId?: IndexId;
|
3400
|
+
/**
|
3401
|
+
* The identifier of the data source that the user aliases are associated with.
|
3402
|
+
*/
|
3403
|
+
dataSourceId?: DataSourceId;
|
3286
3404
|
/**
|
3287
3405
|
* The identifier of the user id associated with the user aliases.
|
3288
3406
|
*/
|
@@ -3294,20 +3412,28 @@ declare namespace QBusiness {
|
|
3294
3412
|
export type UserIds = String[];
|
3295
3413
|
export type UserMessage = string;
|
3296
3414
|
export interface UsersAndGroups {
|
3297
|
-
/**
|
3298
|
-
* The user groups associated with a topic control rule.
|
3299
|
-
*/
|
3300
|
-
userGroups?: UserGroups;
|
3301
3415
|
/**
|
3302
3416
|
* The user ids associated with a topic control rule.
|
3303
3417
|
*/
|
3304
3418
|
userIds?: UserIds;
|
3419
|
+
/**
|
3420
|
+
* The user groups associated with a topic control rule.
|
3421
|
+
*/
|
3422
|
+
userGroups?: UserGroups;
|
3305
3423
|
}
|
3306
3424
|
export interface WebExperience {
|
3425
|
+
/**
|
3426
|
+
* The identifier of your Amazon Q Business web experience.
|
3427
|
+
*/
|
3428
|
+
webExperienceId?: WebExperienceId;
|
3307
3429
|
/**
|
3308
3430
|
* The Unix timestamp when the Amazon Q Business application was last updated.
|
3309
3431
|
*/
|
3310
3432
|
createdAt?: Timestamp;
|
3433
|
+
/**
|
3434
|
+
* The Unix timestamp when your Amazon Q Business web experience was updated.
|
3435
|
+
*/
|
3436
|
+
updatedAt?: Timestamp;
|
3311
3437
|
/**
|
3312
3438
|
* The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
|
3313
3439
|
*/
|
@@ -3316,14 +3442,6 @@ declare namespace QBusiness {
|
|
3316
3442
|
* The status of your Amazon Q Business web experience.
|
3317
3443
|
*/
|
3318
3444
|
status?: WebExperienceStatus;
|
3319
|
-
/**
|
3320
|
-
* The Unix timestamp when your Amazon Q Business web experience was updated.
|
3321
|
-
*/
|
3322
|
-
updatedAt?: Timestamp;
|
3323
|
-
/**
|
3324
|
-
* The identifier of your Amazon Q Business web experience.
|
3325
|
-
*/
|
3326
|
-
webExperienceId?: WebExperienceId;
|
3327
3445
|
}
|
3328
3446
|
export type WebExperienceArn = string;
|
3329
3447
|
export interface WebExperienceAuthConfiguration {
|