@aws-sdk/client-qbusiness 3.699.0 → 3.703.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 +16 -0
- package/dist-cjs/index.js +218 -1
- package/dist-es/QBusiness.js +4 -0
- package/dist-es/commands/GetMediaCommand.js +22 -0
- package/dist-es/commands/ListAttachmentsCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +41 -1
- package/dist-es/pagination/ListAttachmentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +120 -1
- package/dist-types/QBusiness.d.ts +14 -0
- package/dist-types/QBusinessClient.d.ts +4 -2
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +1 -1
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +6 -1
- package/dist-types/commands/ChatCommand.d.ts +19 -4
- package/dist-types/commands/ChatSyncCommand.d.ts +19 -4
- package/dist-types/commands/CreateApplicationCommand.d.ts +10 -11
- package/dist-types/commands/CreateDataSourceCommand.d.ts +6 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
- package/dist-types/commands/CreatePluginCommand.d.ts +1 -1
- package/dist-types/commands/CreateRetrieverCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +6 -1
- package/dist-types/commands/DeleteApplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeletePluginCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +1 -1
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +1 -1
- package/dist-types/commands/GetDataSourceCommand.d.ts +5 -0
- package/dist-types/commands/GetGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetIndexCommand.d.ts +1 -1
- package/dist-types/commands/GetMediaCommand.d.ts +105 -0
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/GetWebExperienceCommand.d.ts +5 -0
- package/dist-types/commands/ListApplicationsCommand.d.ts +6 -0
- package/dist-types/commands/ListAttachmentsCommand.d.ts +121 -0
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +4 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessagesCommand.d.ts +5 -1
- package/dist-types/commands/PutGroupCommand.d.ts +1 -1
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +4 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationCommand.d.ts +11 -8
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -1
- package/dist-types/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePluginCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +1 -1
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +6 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +410 -37
- package/dist-types/pagination/ListAttachmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/QBusiness.d.ts +34 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetMediaCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAttachmentsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +111 -9
- package/dist-types/ts3.4/pagination/ListAttachmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -65,7 +65,7 @@ declare const CreateUserCommand_base: {
|
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ConflictException} (client fault)
|
|
67
67
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
68
|
-
* resource. Fix any
|
|
68
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link InternalServerException} (server fault)
|
|
71
71
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -60,6 +60,11 @@ declare const CreateWebExperienceCommand_base: {
|
|
|
60
60
|
* secretsRole: "STRING_VALUE", // required
|
|
61
61
|
* },
|
|
62
62
|
* },
|
|
63
|
+
* browserExtensionConfiguration: { // BrowserExtensionConfiguration
|
|
64
|
+
* enabledBrowserExtensions: [ // BrowserExtensionList // required
|
|
65
|
+
* "STRING_VALUE",
|
|
66
|
+
* ],
|
|
67
|
+
* },
|
|
63
68
|
* };
|
|
64
69
|
* const command = new CreateWebExperienceCommand(input);
|
|
65
70
|
* const response = await client.send(command);
|
|
@@ -82,7 +87,7 @@ declare const CreateWebExperienceCommand_base: {
|
|
|
82
87
|
*
|
|
83
88
|
* @throws {@link ConflictException} (client fault)
|
|
84
89
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
85
|
-
* resource. Fix any
|
|
90
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
86
91
|
*
|
|
87
92
|
* @throws {@link InternalServerException} (server fault)
|
|
88
93
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -55,7 +55,7 @@ declare const DeleteApplicationCommand_base: {
|
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ConflictException} (client fault)
|
|
57
57
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
58
|
-
* resource. Fix any
|
|
58
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link InternalServerException} (server fault)
|
|
61
61
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -59,7 +59,7 @@ declare const DeleteDataSourceCommand_base: {
|
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConflictException} (client fault)
|
|
61
61
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
62
|
-
* resource. Fix any
|
|
62
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link InternalServerException} (server fault)
|
|
65
65
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -66,7 +66,7 @@ declare const DeleteGroupCommand_base: {
|
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ConflictException} (client fault)
|
|
68
68
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
69
|
-
* resource. Fix any
|
|
69
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link InternalServerException} (server fault)
|
|
72
72
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -56,7 +56,7 @@ declare const DeleteIndexCommand_base: {
|
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
58
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
59
|
-
* resource. Fix any
|
|
59
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
62
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -56,7 +56,7 @@ declare const DeletePluginCommand_base: {
|
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
58
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
59
|
-
* resource. Fix any
|
|
59
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
62
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -56,7 +56,7 @@ declare const DeleteRetrieverCommand_base: {
|
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
58
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
59
|
-
* resource. Fix any
|
|
59
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
62
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -56,7 +56,7 @@ declare const DeleteUserCommand_base: {
|
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
58
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
59
|
-
* resource. Fix any
|
|
59
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
62
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -56,7 +56,7 @@ declare const DeleteWebExperienceCommand_base: {
|
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
58
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
59
|
-
* resource. Fix any
|
|
59
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
62
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -132,6 +132,11 @@ declare const GetDataSourceCommand_base: {
|
|
|
132
132
|
* // roleArn: "STRING_VALUE",
|
|
133
133
|
* // },
|
|
134
134
|
* // },
|
|
135
|
+
* // mediaExtractionConfiguration: { // MediaExtractionConfiguration
|
|
136
|
+
* // imageExtractionConfiguration: { // ImageExtractionConfiguration
|
|
137
|
+
* // imageExtractionStatus: "ENABLED" || "DISABLED", // required
|
|
138
|
+
* // },
|
|
139
|
+
* // },
|
|
135
140
|
* // };
|
|
136
141
|
*
|
|
137
142
|
* ```
|
|
@@ -77,7 +77,7 @@ declare const GetGroupCommand_base: {
|
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link ConflictException} (client fault)
|
|
79
79
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
80
|
-
* resource. Fix any
|
|
80
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
81
81
|
*
|
|
82
82
|
* @throws {@link InternalServerException} (server fault)
|
|
83
83
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -44,9 +44,9 @@ declare const GetIndexCommand_base: {
|
|
|
44
44
|
* // applicationId: "STRING_VALUE",
|
|
45
45
|
* // indexId: "STRING_VALUE",
|
|
46
46
|
* // displayName: "STRING_VALUE",
|
|
47
|
-
* // type: "ENTERPRISE" || "STARTER",
|
|
48
47
|
* // indexArn: "STRING_VALUE",
|
|
49
48
|
* // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
|
|
49
|
+
* // type: "ENTERPRISE" || "STARTER",
|
|
50
50
|
* // description: "STRING_VALUE",
|
|
51
51
|
* // createdAt: new Date("TIMESTAMP"),
|
|
52
52
|
* // updatedAt: new Date("TIMESTAMP"),
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetMediaRequest, GetMediaResponse } from "../models/models_0";
|
|
4
|
+
import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetMediaCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetMediaCommandInput extends GetMediaRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetMediaCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetMediaCommandOutput extends GetMediaResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetMediaCommand_base: {
|
|
25
|
+
new (input: GetMediaCommandInput): import("@smithy/smithy-client").CommandImpl<GetMediaCommandInput, GetMediaCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetMediaCommandInput): import("@smithy/smithy-client").CommandImpl<GetMediaCommandInput, GetMediaCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and
|
|
31
|
+
* have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download
|
|
32
|
+
* the images so you can show them in your UI with responses.</p>
|
|
33
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html">Extracting semantic meaning from images and visuals</a>.</p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { QBusinessClient, GetMediaCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
38
|
+
* // const { QBusinessClient, GetMediaCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
39
|
+
* const client = new QBusinessClient(config);
|
|
40
|
+
* const input = { // GetMediaRequest
|
|
41
|
+
* applicationId: "STRING_VALUE", // required
|
|
42
|
+
* conversationId: "STRING_VALUE", // required
|
|
43
|
+
* messageId: "STRING_VALUE", // required
|
|
44
|
+
* mediaId: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new GetMediaCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // GetMediaResponse
|
|
49
|
+
* // mediaBytes: new Uint8Array(),
|
|
50
|
+
* // mediaMimeType: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetMediaCommandInput - {@link GetMediaCommandInput}
|
|
56
|
+
* @returns {@link GetMediaCommandOutput}
|
|
57
|
+
* @see {@link GetMediaCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetMediaCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p> You don't have access to perform this action. Make sure you have the required
|
|
63
|
+
* permission policies and user accounts and try again.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
67
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link LicenseNotFoundException} (client fault)
|
|
70
|
+
* <p>You don't have permissions to perform the action because your license is inactive. Ask
|
|
71
|
+
* your admin to activate your license and try again after your licence is active.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link MediaTooLargeException} (client fault)
|
|
74
|
+
* <p>The requested media object is too large to be returned.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The resource you want to use doesn’t exist. Make sure you have provided the correct
|
|
78
|
+
* resource and try again.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
81
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
82
|
+
* again.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
86
|
+
* correct input and try again.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link QBusinessServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class GetMediaCommand extends GetMediaCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: GetMediaRequest;
|
|
98
|
+
output: GetMediaResponse;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: GetMediaCommandInput;
|
|
102
|
+
output: GetMediaCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -65,7 +65,7 @@ declare const GetUserCommand_base: {
|
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ConflictException} (client fault)
|
|
67
67
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
68
|
-
* resource. Fix any
|
|
68
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link InternalServerException} (server fault)
|
|
71
71
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -77,6 +77,11 @@ declare const GetWebExperienceCommand_base: {
|
|
|
77
77
|
* // errorMessage: "STRING_VALUE",
|
|
78
78
|
* // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
|
|
79
79
|
* // },
|
|
80
|
+
* // browserExtensionConfiguration: { // BrowserExtensionConfiguration
|
|
81
|
+
* // enabledBrowserExtensions: [ // BrowserExtensionList // required
|
|
82
|
+
* // "STRING_VALUE",
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
80
85
|
* // };
|
|
81
86
|
*
|
|
82
87
|
* ```
|
|
@@ -28,6 +28,12 @@ declare const ListApplicationsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists Amazon Q Business applications.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Amazon Q Business applications may securely transmit data for processing across
|
|
33
|
+
* Amazon Web Services Regions within your geography. For more information, see
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html">Cross region
|
|
35
|
+
* inference in Amazon Q Business</a>.</p>
|
|
36
|
+
* </note>
|
|
31
37
|
* @example
|
|
32
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
39
|
* ```javascript
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListAttachmentsRequest, ListAttachmentsResponse } from "../models/models_0";
|
|
4
|
+
import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAttachmentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAttachmentsCommandInput extends ListAttachmentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAttachmentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAttachmentsCommandOutput extends ListAttachmentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAttachmentsCommand_base: {
|
|
25
|
+
new (input: ListAttachmentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAttachmentsCommandInput, ListAttachmentsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListAttachmentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAttachmentsCommandInput, ListAttachmentsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QBusinessClient, ListAttachmentsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
35
|
+
* // const { QBusinessClient, ListAttachmentsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
36
|
+
* const client = new QBusinessClient(config);
|
|
37
|
+
* const input = { // ListAttachmentsRequest
|
|
38
|
+
* applicationId: "STRING_VALUE", // required
|
|
39
|
+
* conversationId: "STRING_VALUE",
|
|
40
|
+
* userId: "STRING_VALUE",
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* maxResults: Number("int"),
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListAttachmentsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListAttachmentsResponse
|
|
47
|
+
* // attachments: [ // AttachmentList
|
|
48
|
+
* // { // Attachment
|
|
49
|
+
* // attachmentId: "STRING_VALUE",
|
|
50
|
+
* // conversationId: "STRING_VALUE",
|
|
51
|
+
* // name: "STRING_VALUE",
|
|
52
|
+
* // copyFrom: { // CopyFromSource Union: only one key present
|
|
53
|
+
* // conversation: { // ConversationSource
|
|
54
|
+
* // conversationId: "STRING_VALUE", // required
|
|
55
|
+
* // attachmentId: "STRING_VALUE", // required
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // fileType: "STRING_VALUE",
|
|
59
|
+
* // fileSize: Number("int"),
|
|
60
|
+
* // md5chksum: "STRING_VALUE",
|
|
61
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
62
|
+
* // status: "FAILED" || "SUCCESS",
|
|
63
|
+
* // error: { // ErrorDetail
|
|
64
|
+
* // errorMessage: "STRING_VALUE",
|
|
65
|
+
* // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // nextToken: "STRING_VALUE",
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param ListAttachmentsCommandInput - {@link ListAttachmentsCommandInput}
|
|
75
|
+
* @returns {@link ListAttachmentsCommandOutput}
|
|
76
|
+
* @see {@link ListAttachmentsCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link ListAttachmentsCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
+
* <p> You don't have access to perform this action. Make sure you have the required
|
|
82
|
+
* permission policies and user accounts and try again.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalServerException} (server fault)
|
|
85
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
86
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link LicenseNotFoundException} (client fault)
|
|
89
|
+
* <p>You don't have permissions to perform the action because your license is inactive. Ask
|
|
90
|
+
* your admin to activate your license and try again after your licence is active.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p>The resource you want to use doesn’t exist. Make sure you have provided the correct
|
|
94
|
+
* resource and try again.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
97
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
98
|
+
* again.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ValidationException} (client fault)
|
|
101
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
102
|
+
* correct input and try again.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link QBusinessServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class ListAttachmentsCommand extends ListAttachmentsCommand_base {
|
|
110
|
+
/** @internal type navigation helper, not in runtime. */
|
|
111
|
+
protected static __types: {
|
|
112
|
+
api: {
|
|
113
|
+
input: ListAttachmentsRequest;
|
|
114
|
+
output: ListAttachmentsResponse;
|
|
115
|
+
};
|
|
116
|
+
sdk: {
|
|
117
|
+
input: ListAttachmentsCommandInput;
|
|
118
|
+
output: ListAttachmentsCommandOutput;
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -82,6 +82,10 @@ declare const ListDataSourceSyncJobsCommand_base: {
|
|
|
82
82
|
* <p> You don't have access to perform this action. Make sure you have the required
|
|
83
83
|
* permission policies and user accounts and try again.</p>
|
|
84
84
|
*
|
|
85
|
+
* @throws {@link ConflictException} (client fault)
|
|
86
|
+
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
87
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
88
|
+
*
|
|
85
89
|
* @throws {@link InternalServerException} (server fault)
|
|
86
90
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
87
91
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
@@ -67,7 +67,7 @@ declare const ListGroupsCommand_base: {
|
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ConflictException} (client fault)
|
|
69
69
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
70
|
-
* resource. Fix any
|
|
70
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link InternalServerException} (server fault)
|
|
73
73
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -53,11 +53,13 @@ declare const ListMessagesCommand_base: {
|
|
|
53
53
|
* // attachments: [ // AttachmentsOutput
|
|
54
54
|
* // { // AttachmentOutput
|
|
55
55
|
* // name: "STRING_VALUE",
|
|
56
|
-
* // status: "FAILED" || "
|
|
56
|
+
* // status: "FAILED" || "SUCCESS",
|
|
57
57
|
* // error: { // ErrorDetail
|
|
58
58
|
* // errorMessage: "STRING_VALUE",
|
|
59
59
|
* // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
|
|
60
60
|
* // },
|
|
61
|
+
* // attachmentId: "STRING_VALUE",
|
|
62
|
+
* // conversationId: "STRING_VALUE",
|
|
61
63
|
* // },
|
|
62
64
|
* // ],
|
|
63
65
|
* // sourceAttribution: [ // SourceAttributions
|
|
@@ -74,6 +76,8 @@ declare const ListMessagesCommand_base: {
|
|
|
74
76
|
* // snippetExcerpt: { // SnippetExcerpt
|
|
75
77
|
* // text: "STRING_VALUE",
|
|
76
78
|
* // },
|
|
79
|
+
* // mediaId: "STRING_VALUE",
|
|
80
|
+
* // mediaMimeType: "STRING_VALUE",
|
|
77
81
|
* // },
|
|
78
82
|
* // ],
|
|
79
83
|
* // },
|
|
@@ -84,7 +84,7 @@ declare const PutGroupCommand_base: {
|
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link ConflictException} (client fault)
|
|
86
86
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
87
|
-
* resource. Fix any
|
|
87
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link InternalServerException} (server fault)
|
|
90
90
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -60,7 +60,7 @@ declare const StartDataSourceSyncJobCommand_base: {
|
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ConflictException} (client fault)
|
|
62
62
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
63
|
-
* resource. Fix any
|
|
63
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link InternalServerException} (server fault)
|
|
66
66
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -56,6 +56,10 @@ declare const StopDataSourceSyncJobCommand_base: {
|
|
|
56
56
|
* <p> You don't have access to perform this action. Make sure you have the required
|
|
57
57
|
* permission policies and user accounts and try again.</p>
|
|
58
58
|
*
|
|
59
|
+
* @throws {@link ConflictException} (client fault)
|
|
60
|
+
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
61
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
62
|
+
*
|
|
59
63
|
* @throws {@link InternalServerException} (server fault)
|
|
60
64
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
61
65
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
@@ -63,7 +63,7 @@ declare const TagResourceCommand_base: {
|
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ConflictException} (client fault)
|
|
65
65
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
66
|
-
* resource. Fix any
|
|
66
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link InternalServerException} (server fault)
|
|
69
69
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -29,13 +29,16 @@ declare const UpdateApplicationCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates an existing Amazon Q Business application.</p>
|
|
31
31
|
* <note>
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
32
|
+
* <p>Amazon Q Business applications may securely transmit data for processing across
|
|
33
|
+
* Amazon Web Services Regions within your geography. For more information, see
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html">Cross region
|
|
35
|
+
* inference in Amazon Q Business</a>.</p>
|
|
36
|
+
* </note>
|
|
37
|
+
* <note>
|
|
38
|
+
* <p>An Amazon Q Apps service-linked role will be created if it's absent in the
|
|
39
|
+
* Amazon Web Services account when <code>QAppsConfiguration</code> is enabled in
|
|
40
|
+
* the request. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html">Using
|
|
41
|
+
* service-linked roles for Q Apps</a>. </p>
|
|
39
42
|
* </note>
|
|
40
43
|
* @example
|
|
41
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -81,7 +84,7 @@ declare const UpdateApplicationCommand_base: {
|
|
|
81
84
|
*
|
|
82
85
|
* @throws {@link ConflictException} (client fault)
|
|
83
86
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
84
|
-
* resource. Fix any
|
|
87
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
85
88
|
*
|
|
86
89
|
* @throws {@link InternalServerException} (server fault)
|
|
87
90
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -156,7 +156,7 @@ declare const UpdateChatControlsConfigurationCommand_base: {
|
|
|
156
156
|
*
|
|
157
157
|
* @throws {@link ConflictException} (client fault)
|
|
158
158
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
159
|
-
* resource. Fix any
|
|
159
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
160
160
|
*
|
|
161
161
|
* @throws {@link InternalServerException} (server fault)
|
|
162
162
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -116,6 +116,11 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
116
116
|
* roleArn: "STRING_VALUE",
|
|
117
117
|
* },
|
|
118
118
|
* },
|
|
119
|
+
* mediaExtractionConfiguration: { // MediaExtractionConfiguration
|
|
120
|
+
* imageExtractionConfiguration: { // ImageExtractionConfiguration
|
|
121
|
+
* imageExtractionStatus: "ENABLED" || "DISABLED", // required
|
|
122
|
+
* },
|
|
123
|
+
* },
|
|
119
124
|
* };
|
|
120
125
|
* const command = new UpdateDataSourceCommand(input);
|
|
121
126
|
* const response = await client.send(command);
|
|
@@ -135,7 +140,7 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
135
140
|
*
|
|
136
141
|
* @throws {@link ConflictException} (client fault)
|
|
137
142
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
138
|
-
* resource. Fix any
|
|
143
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
139
144
|
*
|
|
140
145
|
* @throws {@link InternalServerException} (server fault)
|
|
141
146
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -68,7 +68,7 @@ declare const UpdateIndexCommand_base: {
|
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ConflictException} (client fault)
|
|
70
70
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
71
|
-
* resource. Fix any
|
|
71
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link InternalServerException} (server fault)
|
|
74
74
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -81,7 +81,7 @@ declare const UpdatePluginCommand_base: {
|
|
|
81
81
|
*
|
|
82
82
|
* @throws {@link ConflictException} (client fault)
|
|
83
83
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
84
|
-
* resource. Fix any
|
|
84
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link InternalServerException} (server fault)
|
|
87
87
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -87,7 +87,7 @@ declare const UpdateRetrieverCommand_base: {
|
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link ConflictException} (client fault)
|
|
89
89
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
90
|
-
* resource. Fix any
|
|
90
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
91
91
|
*
|
|
92
92
|
* @throws {@link InternalServerException} (server fault)
|
|
93
93
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
@@ -62,6 +62,11 @@ declare const UpdateWebExperienceCommand_base: {
|
|
|
62
62
|
* origins: [ // WebExperienceOrigins
|
|
63
63
|
* "STRING_VALUE",
|
|
64
64
|
* ],
|
|
65
|
+
* browserExtensionConfiguration: { // BrowserExtensionConfiguration
|
|
66
|
+
* enabledBrowserExtensions: [ // BrowserExtensionList // required
|
|
67
|
+
* "STRING_VALUE",
|
|
68
|
+
* ],
|
|
69
|
+
* },
|
|
65
70
|
* };
|
|
66
71
|
* const command = new UpdateWebExperienceCommand(input);
|
|
67
72
|
* const response = await client.send(command);
|
|
@@ -81,7 +86,7 @@ declare const UpdateWebExperienceCommand_base: {
|
|
|
81
86
|
*
|
|
82
87
|
* @throws {@link ConflictException} (client fault)
|
|
83
88
|
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
84
|
-
* resource. Fix any
|
|
89
|
+
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
85
90
|
*
|
|
86
91
|
* @throws {@link InternalServerException} (server fault)
|
|
87
92
|
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|