Skip to content

Commit 45e207b

Browse files
author
awstools
committed
feat(client-qbusiness): Amazon Q Business now supports capabilities to extract insights and answer questions from visual elements embedded within documents, a browser extension for Google Chrome, Mozilla Firefox, and Microsoft Edge, and attachments across conversations.
1 parent 2af53c3 commit 45e207b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1875
-171
lines changed

‎clients/client-qbusiness/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,14 @@ GetIndex
448448

449449
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/GetIndexCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetIndexCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetIndexCommandOutput/)
450450

451+
</details>
452+
<details>
453+
<summary>
454+
GetMedia
455+
</summary>
456+
457+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/GetMediaCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetMediaCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetMediaCommandOutput/)
458+
451459
</details>
452460
<details>
453461
<summary>
@@ -488,6 +496,14 @@ ListApplications
488496

489497
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/ListApplicationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ListApplicationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ListApplicationsCommandOutput/)
490498

499+
</details>
500+
<details>
501+
<summary>
502+
ListAttachments
503+
</summary>
504+
505+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/ListAttachmentsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ListAttachmentsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ListAttachmentsCommandOutput/)
506+
491507
</details>
492508
<details>
493509
<summary>

‎clients/client-qbusiness/src/QBusiness.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ import {
9696
} from "./commands/GetDataSourceCommand";
9797
import { GetGroupCommand, GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
9898
import { GetIndexCommand, GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
99+
import { GetMediaCommand, GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
99100
import { GetPluginCommand, GetPluginCommandInput, GetPluginCommandOutput } from "./commands/GetPluginCommand";
100101
import {
101102
GetRetrieverCommand,
@@ -113,6 +114,11 @@ import {
113114
ListApplicationsCommandInput,
114115
ListApplicationsCommandOutput,
115116
} from "./commands/ListApplicationsCommand";
117+
import {
118+
ListAttachmentsCommand,
119+
ListAttachmentsCommandInput,
120+
ListAttachmentsCommandOutput,
121+
} from "./commands/ListAttachmentsCommand";
116122
import {
117123
ListConversationsCommand,
118124
ListConversationsCommandInput,
@@ -235,11 +241,13 @@ const commands = {
235241
GetDataSourceCommand,
236242
GetGroupCommand,
237243
GetIndexCommand,
244+
GetMediaCommand,
238245
GetPluginCommand,
239246
GetRetrieverCommand,
240247
GetUserCommand,
241248
GetWebExperienceCommand,
242249
ListApplicationsCommand,
250+
ListAttachmentsCommand,
243251
ListConversationsCommand,
244252
ListDataSourcesCommand,
245253
ListDataSourceSyncJobsCommand,
@@ -625,6 +633,17 @@ export interface QBusiness {
625633
cb: (err: any, data?: GetIndexCommandOutput) => void
626634
): void;
627635

636+
/**
637+
* @see {@link GetMediaCommand}
638+
*/
639+
getMedia(args: GetMediaCommandInput, options?: __HttpHandlerOptions): Promise<GetMediaCommandOutput>;
640+
getMedia(args: GetMediaCommandInput, cb: (err: any, data?: GetMediaCommandOutput) => void): void;
641+
getMedia(
642+
args: GetMediaCommandInput,
643+
options: __HttpHandlerOptions,
644+
cb: (err: any, data?: GetMediaCommandOutput) => void
645+
): void;
646+
628647
/**
629648
* @see {@link GetPluginCommand}
630649
*/
@@ -693,6 +712,20 @@ export interface QBusiness {
693712
cb: (err: any, data?: ListApplicationsCommandOutput) => void
694713
): void;
695714

715+
/**
716+
* @see {@link ListAttachmentsCommand}
717+
*/
718+
listAttachments(
719+
args: ListAttachmentsCommandInput,
720+
options?: __HttpHandlerOptions
721+
): Promise<ListAttachmentsCommandOutput>;
722+
listAttachments(args: ListAttachmentsCommandInput, cb: (err: any, data?: ListAttachmentsCommandOutput) => void): void;
723+
listAttachments(
724+
args: ListAttachmentsCommandInput,
725+
options: __HttpHandlerOptions,
726+
cb: (err: any, data?: ListAttachmentsCommandOutput) => void
727+
): void;
728+
696729
/**
697730
* @see {@link ListConversationsCommand}
698731
*/

‎clients/client-qbusiness/src/QBusinessClient.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,13 @@ import {
106106
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
107107
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
108108
import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
109+
import { GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
109110
import { GetPluginCommandInput, GetPluginCommandOutput } from "./commands/GetPluginCommand";
110111
import { GetRetrieverCommandInput, GetRetrieverCommandOutput } from "./commands/GetRetrieverCommand";
111112
import { GetUserCommandInput, GetUserCommandOutput } from "./commands/GetUserCommand";
112113
import { GetWebExperienceCommandInput, GetWebExperienceCommandOutput } from "./commands/GetWebExperienceCommand";
113114
import { ListApplicationsCommandInput, ListApplicationsCommandOutput } from "./commands/ListApplicationsCommand";
115+
import { ListAttachmentsCommandInput, ListAttachmentsCommandOutput } from "./commands/ListAttachmentsCommand";
114116
import { ListConversationsCommandInput, ListConversationsCommandOutput } from "./commands/ListConversationsCommand";
115117
import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
116118
import {
@@ -195,11 +197,13 @@ export type ServiceInputTypes =
195197
| GetDataSourceCommandInput
196198
| GetGroupCommandInput
197199
| GetIndexCommandInput
200+
| GetMediaCommandInput
198201
| GetPluginCommandInput
199202
| GetRetrieverCommandInput
200203
| GetUserCommandInput
201204
| GetWebExperienceCommandInput
202205
| ListApplicationsCommandInput
206+
| ListAttachmentsCommandInput
203207
| ListConversationsCommandInput
204208
| ListDataSourceSyncJobsCommandInput
205209
| ListDataSourcesCommandInput
@@ -256,11 +260,13 @@ export type ServiceOutputTypes =
256260
| GetDataSourceCommandOutput
257261
| GetGroupCommandOutput
258262
| GetIndexCommandOutput
263+
| GetMediaCommandOutput
259264
| GetPluginCommandOutput
260265
| GetRetrieverCommandOutput
261266
| GetUserCommandOutput
262267
| GetWebExperienceCommandOutput
263268
| ListApplicationsCommandOutput
269+
| ListAttachmentsCommandOutput
264270
| ListConversationsCommandOutput
265271
| ListDataSourceSyncJobsCommandOutput
266272
| ListDataSourcesCommandOutput

‎clients/client-qbusiness/src/commands/BatchDeleteDocumentCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
7777
*
7878
* @throws {@link ConflictException} (client fault)
7979
* <p>You are trying to perform an action that conflicts with the current status of your
80-
* resource. Fix any inconsistences with your resources and try again.</p>
80+
* resource. Fix any inconsistencies with your resources and try again.</p>
8181
*
8282
* @throws {@link InternalServerException} (server fault)
8383
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/BatchPutDocumentCommand.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,11 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
152152
* roleArn: "STRING_VALUE",
153153
* },
154154
* },
155+
* mediaExtractionConfiguration: { // MediaExtractionConfiguration
156+
* imageExtractionConfiguration: { // ImageExtractionConfiguration
157+
* imageExtractionStatus: "ENABLED" || "DISABLED", // required
158+
* },
159+
* },
155160
* },
156161
* ],
157162
* roleArn: "STRING_VALUE",
@@ -186,7 +191,7 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
186191
*
187192
* @throws {@link ConflictException} (client fault)
188193
* <p>You are trying to perform an action that conflicts with the current status of your
189-
* resource. Fix any inconsistences with your resources and try again.</p>
194+
* resource. Fix any inconsistencies with your resources and try again.</p>
190195
*
191196
* @throws {@link InternalServerException} (server fault)
192197
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/ChatCommand.ts

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,14 @@ export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {}
140140
* },
141141
* attachmentEvent: { // AttachmentInputEvent
142142
* attachment: { // AttachmentInput
143-
* name: "STRING_VALUE", // required
144-
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
143+
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
144+
* name: "STRING_VALUE",
145+
* copyFrom: { // CopyFromSource Union: only one key present
146+
* conversation: { // ConversationSource
147+
* conversationId: "STRING_VALUE", // required
148+
* attachmentId: "STRING_VALUE", // required
149+
* },
150+
* },
145151
* },
146152
* },
147153
* actionExecutionEvent: { // ActionExecutionEvent
@@ -189,6 +195,8 @@ export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {}
189195
* // snippetExcerpt: { // SnippetExcerpt
190196
* // text: "STRING_VALUE",
191197
* // },
198+
* // mediaId: "STRING_VALUE",
199+
* // mediaMimeType: "STRING_VALUE",
192200
* // },
193201
* // ],
194202
* // },
@@ -227,11 +235,13 @@ export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {}
227235
* // systemMessageId: "STRING_VALUE",
228236
* // attachment: { // AttachmentOutput
229237
* // name: "STRING_VALUE",
230-
* // status: "FAILED" || "SUCCEEDED",
238+
* // status: "FAILED" || "SUCCESS",
231239
* // error: { // ErrorDetail
232240
* // errorMessage: "STRING_VALUE",
233241
* // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
234242
* // },
243+
* // attachmentId: "STRING_VALUE",
244+
* // conversationId: "STRING_VALUE",
235245
* // },
236246
* // },
237247
* // authChallengeRequestEvent: { // AuthChallengeRequestEvent
@@ -254,7 +264,12 @@ export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {}
254264
*
255265
* @throws {@link ConflictException} (client fault)
256266
* <p>You are trying to perform an action that conflicts with the current status of your
257-
* resource. Fix any inconsistences with your resources and try again.</p>
267+
* resource. Fix any inconsistencies with your resources and try again.</p>
268+
*
269+
* @throws {@link ExternalResourceException} (client fault)
270+
* <p>An external resource that you configured with your application is returning errors and
271+
* preventing this operation from succeeding. Fix those errors and try again.
272+
* </p>
258273
*
259274
* @throws {@link InternalServerException} (server fault)
260275
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/ChatSyncCommand.ts

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,14 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
4444
* userMessage: "STRING_VALUE",
4545
* attachments: [ // AttachmentsInput
4646
* { // AttachmentInput
47-
* name: "STRING_VALUE", // required
48-
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
47+
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
48+
* name: "STRING_VALUE",
49+
* copyFrom: { // CopyFromSource Union: only one key present
50+
* conversation: { // ConversationSource
51+
* conversationId: "STRING_VALUE", // required
52+
* attachmentId: "STRING_VALUE", // required
53+
* },
54+
* },
4955
* },
5056
* ],
5157
* actionExecution: { // ActionExecution
@@ -200,18 +206,22 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
200206
* // snippetExcerpt: { // SnippetExcerpt
201207
* // text: "STRING_VALUE",
202208
* // },
209+
* // mediaId: "STRING_VALUE",
210+
* // mediaMimeType: "STRING_VALUE",
203211
* // },
204212
* // ],
205213
* // },
206214
* // ],
207215
* // failedAttachments: [ // AttachmentsOutput
208216
* // { // AttachmentOutput
209217
* // name: "STRING_VALUE",
210-
* // status: "FAILED" || "SUCCEEDED",
218+
* // status: "FAILED" || "SUCCESS",
211219
* // error: { // ErrorDetail
212220
* // errorMessage: "STRING_VALUE",
213221
* // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
214222
* // },
223+
* // attachmentId: "STRING_VALUE",
224+
* // conversationId: "STRING_VALUE",
215225
* // },
216226
* // ],
217227
* // };
@@ -230,7 +240,12 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
230240
*
231241
* @throws {@link ConflictException} (client fault)
232242
* <p>You are trying to perform an action that conflicts with the current status of your
233-
* resource. Fix any inconsistences with your resources and try again.</p>
243+
* resource. Fix any inconsistencies with your resources and try again.</p>
244+
*
245+
* @throws {@link ExternalResourceException} (client fault)
246+
* <p>An external resource that you configured with your application is returning errors and
247+
* preventing this operation from succeeding. Fix those errors and try again.
248+
* </p>
234249
*
235250
* @throws {@link InternalServerException} (server fault)
236251
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/CreateApplicationCommand.ts

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,15 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
3737
* <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are
3838
* also available in Amazon Q Business Lite. For information on what's included in
3939
* Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign
40-
* subscription tiers to users.
41-
* </p>
42-
* <p>
43-
* A Amazon Q Apps service linked role will be created if it's absent in the
44-
* Amazon Web Services account when the QAppsConfiguration is enabled in the request.
45-
* For more information, see
46-
* <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html">
47-
* Using service-linked roles for Q Apps
48-
* </a>
49-
* </p>
40+
* subscription tiers to users. </p>
41+
* <p>An Amazon Q Apps service linked role will be created if it's absent in the
42+
* Amazon Web Services account when <code>QAppsConfiguration</code> is enabled in
43+
* the request. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html"> Using
44+
* service-linked roles for Q Apps</a>.</p>
45+
* <p>When you create an application, Amazon Q Business may securely transmit data for
46+
* processing from your selected Amazon Web Services region, but within your geography.
47+
* For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html">Cross region
48+
* inference in Amazon Q Business</a>.</p>
5049
* </note>
5150
* @example
5251
* Use a bare-bones client and the command you need to make an API call.
@@ -105,7 +104,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
105104
*
106105
* @throws {@link ConflictException} (client fault)
107106
* <p>You are trying to perform an action that conflicts with the current status of your
108-
* resource. Fix any inconsistences with your resources and try again.</p>
107+
* resource. Fix any inconsistencies with your resources and try again.</p>
109108
*
110109
* @throws {@link InternalServerException} (server fault)
111110
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/CreateDataSourceCommand.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,11 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
126126
* roleArn: "STRING_VALUE",
127127
* },
128128
* },
129+
* mediaExtractionConfiguration: { // MediaExtractionConfiguration
130+
* imageExtractionConfiguration: { // ImageExtractionConfiguration
131+
* imageExtractionStatus: "ENABLED" || "DISABLED", // required
132+
* },
133+
* },
129134
* };
130135
* const command = new CreateDataSourceCommand(input);
131136
* const response = await client.send(command);
@@ -148,7 +153,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
148153
*
149154
* @throws {@link ConflictException} (client fault)
150155
* <p>You are trying to perform an action that conflicts with the current status of your
151-
* resource. Fix any inconsistences with your resources and try again.</p>
156+
* resource. Fix any inconsistencies with your resources and try again.</p>
152157
*
153158
* @throws {@link InternalServerException} (server fault)
154159
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/CreateIndexCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
4646
* const input = { // CreateIndexRequest
4747
* applicationId: "STRING_VALUE", // required
4848
* displayName: "STRING_VALUE", // required
49-
* type: "ENTERPRISE" || "STARTER",
5049
* description: "STRING_VALUE",
50+
* type: "ENTERPRISE" || "STARTER",
5151
* tags: [ // Tags
5252
* { // Tag
5353
* key: "STRING_VALUE", // required
@@ -80,7 +80,7 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
8080
*
8181
* @throws {@link ConflictException} (client fault)
8282
* <p>You are trying to perform an action that conflicts with the current status of your
83-
* resource. Fix any inconsistences with your resources and try again.</p>
83+
* resource. Fix any inconsistencies with your resources and try again.</p>
8484
*
8585
* @throws {@link InternalServerException} (server fault)
8686
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/CreatePluginCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ export interface CreatePluginCommandOutput extends CreatePluginResponse, __Metad
9292
*
9393
* @throws {@link ConflictException} (client fault)
9494
* <p>You are trying to perform an action that conflicts with the current status of your
95-
* resource. Fix any inconsistences with your resources and try again.</p>
95+
* resource. Fix any inconsistencies with your resources and try again.</p>
9696
*
9797
* @throws {@link InternalServerException} (server fault)
9898
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/CreateRetrieverCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ export interface CreateRetrieverCommandOutput extends CreateRetrieverResponse, _
9898
*
9999
* @throws {@link ConflictException} (client fault)
100100
* <p>You are trying to perform an action that conflicts with the current status of your
101-
* resource. Fix any inconsistences with your resources and try again.</p>
101+
* resource. Fix any inconsistencies with your resources and try again.</p>
102102
*
103103
* @throws {@link InternalServerException} (server fault)
104104
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

‎clients/client-qbusiness/src/commands/CreateUserCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
6666
*
6767
* @throws {@link ConflictException} (client fault)
6868
* <p>You are trying to perform an action that conflicts with the current status of your
69-
* resource. Fix any inconsistences with your resources and try again.</p>
69+
* resource. Fix any inconsistencies with your resources and try again.</p>
7070
*
7171
* @throws {@link InternalServerException} (server fault)
7272
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait

0 commit comments

Comments
 (0)