@aws-sdk/client-qbusiness 3.787.0 → 3.796.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 +9 -39
- package/dist-cjs/index.js +55 -5
- package/dist-es/QBusiness.js +2 -0
- package/dist-es/commands/CheckDocumentAccessCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +0 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +32 -0
- package/dist-types/QBusiness.d.ts +8 -39
- package/dist-types/QBusinessClient.d.ts +4 -41
- package/dist-types/commands/AssociatePermissionCommand.d.ts +7 -15
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +7 -16
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -29
- package/dist-types/commands/CancelSubscriptionCommand.d.ts +6 -13
- package/dist-types/commands/ChatCommand.d.ts +8 -17
- package/dist-types/commands/ChatSyncCommand.d.ts +8 -17
- package/dist-types/commands/CheckDocumentAccessCommand.d.ts +145 -0
- package/dist-types/commands/CreateApplicationCommand.d.ts +7 -27
- package/dist-types/commands/CreateDataAccessorCommand.d.ts +7 -18
- package/dist-types/commands/CreateDataSourceCommand.d.ts +7 -16
- package/dist-types/commands/CreateIndexCommand.d.ts +7 -21
- package/dist-types/commands/CreatePluginCommand.d.ts +6 -12
- package/dist-types/commands/CreateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/CreateSubscriptionCommand.d.ts +7 -18
- package/dist-types/commands/CreateUserCommand.d.ts +7 -14
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DeleteApplicationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteAttachmentCommand.d.ts +6 -12
- package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +5 -10
- package/dist-types/commands/DeleteConversationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteDataAccessorCommand.d.ts +7 -14
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -15
- package/dist-types/commands/DeleteGroupCommand.d.ts +7 -21
- package/dist-types/commands/DeleteIndexCommand.d.ts +6 -12
- package/dist-types/commands/DeletePluginCommand.d.ts +6 -12
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/DeleteUserCommand.d.ts +6 -12
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DisassociatePermissionCommand.d.ts +7 -14
- package/dist-types/commands/GetApplicationCommand.d.ts +5 -10
- package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +6 -12
- package/dist-types/commands/GetDataAccessorCommand.d.ts +6 -14
- package/dist-types/commands/GetDataSourceCommand.d.ts +5 -10
- package/dist-types/commands/GetGroupCommand.d.ts +6 -12
- package/dist-types/commands/GetIndexCommand.d.ts +5 -10
- package/dist-types/commands/GetMediaCommand.d.ts +7 -16
- package/dist-types/commands/GetPluginCommand.d.ts +5 -10
- package/dist-types/commands/GetPolicyCommand.d.ts +6 -12
- package/dist-types/commands/GetRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/GetUserCommand.d.ts +7 -14
- package/dist-types/commands/GetWebExperienceCommand.d.ts +5 -10
- package/dist-types/commands/ListApplicationsCommand.d.ts +5 -15
- package/dist-types/commands/ListAttachmentsCommand.d.ts +6 -12
- package/dist-types/commands/ListConversationsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataAccessorsCommand.d.ts +6 -13
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataSourcesCommand.d.ts +5 -10
- package/dist-types/commands/ListDocumentsCommand.d.ts +7 -11
- package/dist-types/commands/ListGroupsCommand.d.ts +7 -13
- package/dist-types/commands/ListIndicesCommand.d.ts +5 -10
- package/dist-types/commands/ListMessagesCommand.d.ts +7 -13
- package/dist-types/commands/ListPluginActionsCommand.d.ts +6 -12
- package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +5 -10
- package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +4 -8
- package/dist-types/commands/ListPluginsCommand.d.ts +5 -10
- package/dist-types/commands/ListRetrieversCommand.d.ts +5 -10
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +6 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -12
- package/dist-types/commands/ListWebExperiencesCommand.d.ts +5 -10
- package/dist-types/commands/PutFeedbackCommand.d.ts +6 -12
- package/dist-types/commands/PutGroupCommand.d.ts +7 -23
- package/dist-types/commands/SearchRelevantContentCommand.d.ts +7 -18
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/TagResourceCommand.d.ts +7 -15
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -10
- package/dist-types/commands/UpdateApplicationCommand.d.ts +7 -25
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +7 -14
- package/dist-types/commands/UpdateDataAccessorCommand.d.ts +7 -15
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -12
- package/dist-types/commands/UpdateIndexCommand.d.ts +6 -12
- package/dist-types/commands/UpdatePluginCommand.d.ts +6 -12
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/UpdateSubscriptionCommand.d.ts +7 -16
- package/dist-types/commands/UpdateUserCommand.d.ts +6 -12
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -39
- package/dist-types/models/models_0.d.ts +500 -1228
- package/dist-types/models/models_1.d.ts +257 -181
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QBusiness.d.ts +17 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CheckDocumentAccessCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDocumentsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +42 -51
- package/dist-types/ts3.4/models/models_1.d.ts +55 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
|
@@ -82,31 +82,25 @@ declare const UpdateRetrieverCommand_base: {
|
|
|
82
82
|
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link AccessDeniedException} (client fault)
|
|
85
|
-
* <p> You don't have access to perform this action. Make sure you have the required
|
|
86
|
-
* permission policies and user accounts and try again.</p>
|
|
85
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
87
86
|
*
|
|
88
87
|
* @throws {@link ConflictException} (client fault)
|
|
89
|
-
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
90
|
-
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
88
|
+
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
91
89
|
*
|
|
92
90
|
* @throws {@link InternalServerException} (server fault)
|
|
93
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
94
|
-
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
91
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
95
92
|
*
|
|
96
93
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
97
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
98
|
-
* provided the correct resource and try again.</p>
|
|
94
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
99
95
|
*
|
|
100
96
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
101
97
|
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
|
|
102
98
|
*
|
|
103
99
|
* @throws {@link ThrottlingException} (client fault)
|
|
104
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
105
|
-
* again.</p>
|
|
100
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
106
101
|
*
|
|
107
102
|
* @throws {@link ValidationException} (client fault)
|
|
108
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
109
|
-
* correct input and try again.</p>
|
|
103
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
110
104
|
*
|
|
111
105
|
* @throws {@link QBusinessServiceException}
|
|
112
106
|
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
@@ -27,10 +27,7 @@ declare const UpdateSubscriptionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant.
|
|
31
|
-
* Downgrades apply at the start of the next month. Subscription tier determines feature
|
|
32
|
-
* access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business
|
|
33
|
-
* pricing</a>.</p>
|
|
30
|
+
* <p>Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -63,28 +60,22 @@ declare const UpdateSubscriptionCommand_base: {
|
|
|
63
60
|
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
64
61
|
*
|
|
65
62
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
* <p> You don't have access to perform this action. Make sure you have the required
|
|
67
|
-
* permission policies and user accounts and try again.</p>
|
|
63
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
68
64
|
*
|
|
69
65
|
* @throws {@link ConflictException} (client fault)
|
|
70
|
-
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
71
|
-
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
66
|
+
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
72
67
|
*
|
|
73
68
|
* @throws {@link InternalServerException} (server fault)
|
|
74
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
75
|
-
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
69
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
76
70
|
*
|
|
77
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
78
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
79
|
-
* provided the correct resource and try again.</p>
|
|
72
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
80
73
|
*
|
|
81
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
83
|
-
* again.</p>
|
|
75
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
84
76
|
*
|
|
85
77
|
* @throws {@link ValidationException} (client fault)
|
|
86
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
87
|
-
* correct input and try again.</p>
|
|
78
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
88
79
|
*
|
|
89
80
|
* @throws {@link QBusinessServiceException}
|
|
90
81
|
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
@@ -87,31 +87,25 @@ declare const UpdateUserCommand_base: {
|
|
|
87
87
|
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link AccessDeniedException} (client fault)
|
|
90
|
-
* <p> You don't have access to perform this action. Make sure you have the required
|
|
91
|
-
* permission policies and user accounts and try again.</p>
|
|
90
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
92
91
|
*
|
|
93
92
|
* @throws {@link ConflictException} (client fault)
|
|
94
|
-
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
95
|
-
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
93
|
+
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
96
94
|
*
|
|
97
95
|
* @throws {@link InternalServerException} (server fault)
|
|
98
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
99
|
-
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
96
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
100
97
|
*
|
|
101
98
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
102
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
103
|
-
* provided the correct resource and try again.</p>
|
|
99
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
104
100
|
*
|
|
105
101
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
106
102
|
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
|
|
107
103
|
*
|
|
108
104
|
* @throws {@link ThrottlingException} (client fault)
|
|
109
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
110
|
-
* again.</p>
|
|
105
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
111
106
|
*
|
|
112
107
|
* @throws {@link ValidationException} (client fault)
|
|
113
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
114
|
-
* correct input and try again.</p>
|
|
108
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
115
109
|
*
|
|
116
110
|
* @throws {@link QBusinessServiceException}
|
|
117
111
|
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
@@ -87,28 +87,22 @@ declare const UpdateWebExperienceCommand_base: {
|
|
|
87
87
|
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link AccessDeniedException} (client fault)
|
|
90
|
-
* <p> You don't have access to perform this action. Make sure you have the required
|
|
91
|
-
* permission policies and user accounts and try again.</p>
|
|
90
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
92
91
|
*
|
|
93
92
|
* @throws {@link ConflictException} (client fault)
|
|
94
|
-
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
95
|
-
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
93
|
+
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
96
94
|
*
|
|
97
95
|
* @throws {@link InternalServerException} (server fault)
|
|
98
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
99
|
-
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
96
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
100
97
|
*
|
|
101
98
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
102
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
103
|
-
* provided the correct resource and try again.</p>
|
|
99
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
104
100
|
*
|
|
105
101
|
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
107
|
-
* again.</p>
|
|
102
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
108
103
|
*
|
|
109
104
|
* @throws {@link ValidationException} (client fault)
|
|
110
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
111
|
-
* correct input and try again.</p>
|
|
105
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
112
106
|
*
|
|
113
107
|
* @throws {@link QBusinessServiceException}
|
|
114
108
|
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
@@ -4,6 +4,7 @@ export * from "./BatchPutDocumentCommand";
|
|
|
4
4
|
export * from "./CancelSubscriptionCommand";
|
|
5
5
|
export * from "./ChatCommand";
|
|
6
6
|
export * from "./ChatSyncCommand";
|
|
7
|
+
export * from "./CheckDocumentAccessCommand";
|
|
7
8
|
export * from "./CreateApplicationCommand";
|
|
8
9
|
export * from "./CreateDataAccessorCommand";
|
|
9
10
|
export * from "./CreateDataSourceCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,43 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
|
|
3
|
-
* managed, generative-AI powered enterprise chat assistant that you can deploy within your
|
|
4
|
-
* organization. Amazon Q Business enhances employee productivity by supporting key tasks such
|
|
5
|
-
* as question-answering, knowledge discovery, writing email messages, summarizing text,
|
|
6
|
-
* drafting document outlines, and brainstorming ideas. Users ask questions of
|
|
7
|
-
* Amazon Q Business and get answers that are presented in a conversational manner. For an
|
|
8
|
-
* introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
|
|
9
|
-
* <i>Amazon Q Business User Guide</i>
|
|
10
|
-
* </a>.</p>
|
|
11
|
-
* <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
|
|
12
|
-
* <p>For information about the IAM access control permissions you need to
|
|
13
|
-
* use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
|
|
14
|
-
* <i>Amazon Q Business User Guide</i>.</p>
|
|
15
|
-
* <p>The following resources provide additional information about using the Amazon Q Business
|
|
16
|
-
* API:</p>
|
|
17
|
-
* <ul>
|
|
18
|
-
* <li>
|
|
19
|
-
* <p>
|
|
20
|
-
* <i>
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
|
|
22
|
-
* Amazon Q Business</a>
|
|
23
|
-
* </i>
|
|
24
|
-
* </p>
|
|
25
|
-
* </li>
|
|
26
|
-
* <li>
|
|
27
|
-
* <p>
|
|
28
|
-
* <i>
|
|
29
|
-
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
|
|
30
|
-
* </i>
|
|
31
|
-
* </p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>
|
|
35
|
-
* <i>
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
|
|
37
|
-
* </i>
|
|
38
|
-
* </p>
|
|
39
|
-
* </li>
|
|
40
|
-
* </ul>
|
|
2
|
+
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html"> <i>Amazon Q Business User Guide</i> </a>.</p> <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p> <p>For information about the IAM access control permissions you need to use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <p>The following resources provide additional information about using the Amazon Q Business API:</p> <ul> <li> <p> <i> <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for Amazon Q Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
|
|
41
3
|
*
|
|
42
4
|
* @packageDocumentation
|
|
43
5
|
*/
|