@aws-sdk/client-qbusiness 3.699.0 → 3.705.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 +112 -0
- package/dist-cjs/index.js +1033 -57
- package/dist-es/QBusiness.js +28 -0
- package/dist-es/commands/AssociatePermissionCommand.js +22 -0
- package/dist-es/commands/ChatCommand.js +2 -1
- package/dist-es/commands/CreateDataAccessorCommand.js +23 -0
- package/dist-es/commands/DeleteDataAccessorCommand.js +22 -0
- package/dist-es/commands/DisassociatePermissionCommand.js +22 -0
- package/dist-es/commands/GetDataAccessorCommand.js +23 -0
- package/dist-es/commands/GetMediaCommand.js +22 -0
- package/dist-es/commands/GetPolicyCommand.js +22 -0
- package/dist-es/commands/ListAttachmentsCommand.js +22 -0
- package/dist-es/commands/ListDataAccessorsCommand.js +23 -0
- package/dist-es/commands/ListPluginActionsCommand.js +22 -0
- package/dist-es/commands/ListPluginTypeActionsCommand.js +22 -0
- package/dist-es/commands/ListPluginTypeMetadataCommand.js +22 -0
- package/dist-es/commands/SearchRelevantContentCommand.js +22 -0
- package/dist-es/commands/UpdateDataAccessorCommand.js +23 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +100 -53
- package/dist-es/models/models_1.js +54 -0
- package/dist-es/pagination/ListAttachmentsPaginator.js +4 -0
- package/dist-es/pagination/ListDataAccessorsPaginator.js +4 -0
- package/dist-es/pagination/ListPluginActionsPaginator.js +4 -0
- package/dist-es/pagination/ListPluginTypeActionsPaginator.js +4 -0
- package/dist-es/pagination/ListPluginTypeMetadataPaginator.js +4 -0
- package/dist-es/pagination/SearchRelevantContentPaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +574 -4
- package/dist-types/QBusiness.d.ts +99 -0
- package/dist-types/QBusinessClient.d.ts +16 -2
- package/dist-types/commands/AssociatePermissionCommand.d.ts +105 -0
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +3 -3
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +8 -3
- package/dist-types/commands/ChatCommand.d.ts +24 -8
- package/dist-types/commands/ChatSyncCommand.d.ts +24 -8
- package/dist-types/commands/CreateApplicationCommand.d.ts +16 -14
- package/dist-types/commands/CreateDataAccessorCommand.d.ts +203 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +8 -3
- package/dist-types/commands/CreateIndexCommand.d.ts +4 -4
- package/dist-types/commands/CreatePluginCommand.d.ts +10 -4
- package/dist-types/commands/CreateRetrieverCommand.d.ts +3 -3
- package/dist-types/commands/CreateUserCommand.d.ts +3 -3
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +14 -3
- package/dist-types/commands/DeleteApplicationCommand.d.ts +3 -3
- package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteConversationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDataAccessorCommand.d.ts +95 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +3 -3
- package/dist-types/commands/DeleteGroupCommand.d.ts +3 -3
- package/dist-types/commands/DeleteIndexCommand.d.ts +3 -3
- package/dist-types/commands/DeletePluginCommand.d.ts +3 -3
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +3 -3
- package/dist-types/commands/DeleteUserCommand.d.ts +3 -3
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +3 -3
- package/dist-types/commands/DisassociatePermissionCommand.d.ts +95 -0
- package/dist-types/commands/GetApplicationCommand.d.ts +6 -3
- package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/GetDataAccessorCommand.d.ts +191 -0
- package/dist-types/commands/GetDataSourceCommand.d.ts +7 -2
- package/dist-types/commands/GetGroupCommand.d.ts +3 -3
- package/dist-types/commands/GetIndexCommand.d.ts +3 -3
- package/dist-types/commands/GetMediaCommand.d.ts +105 -0
- package/dist-types/commands/GetPluginCommand.d.ts +9 -3
- package/dist-types/commands/GetPolicyCommand.d.ts +92 -0
- package/dist-types/commands/GetRetrieverCommand.d.ts +2 -2
- package/dist-types/commands/GetUserCommand.d.ts +3 -3
- package/dist-types/commands/GetWebExperienceCommand.d.ts +13 -2
- package/dist-types/commands/ListApplicationsCommand.d.ts +10 -1
- package/dist-types/commands/ListAttachmentsCommand.d.ts +121 -0
- package/dist-types/commands/ListConversationsCommand.d.ts +2 -2
- package/dist-types/commands/ListDataAccessorsCommand.d.ts +106 -0
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +6 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListDocumentsCommand.d.ts +2 -2
- package/dist-types/commands/ListGroupsCommand.d.ts +3 -3
- package/dist-types/commands/ListIndicesCommand.d.ts +2 -2
- package/dist-types/commands/ListMessagesCommand.d.ts +8 -4
- package/dist-types/commands/ListPluginActionsCommand.d.ts +102 -0
- package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +98 -0
- package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +95 -0
- package/dist-types/commands/ListPluginsCommand.d.ts +3 -3
- package/dist-types/commands/ListRetrieversCommand.d.ts +3 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListWebExperiencesCommand.d.ts +2 -2
- package/dist-types/commands/PutFeedbackCommand.d.ts +2 -2
- package/dist-types/commands/PutGroupCommand.d.ts +3 -3
- package/dist-types/commands/SearchRelevantContentCommand.d.ts +218 -0
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +5 -4
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +7 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateApplicationCommand.d.ts +13 -10
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/UpdateDataAccessorCommand.d.ts +186 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +8 -3
- package/dist-types/commands/UpdateIndexCommand.d.ts +3 -3
- package/dist-types/commands/UpdatePluginCommand.d.ts +9 -3
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +3 -3
- package/dist-types/commands/UpdateUserCommand.d.ts +3 -3
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +14 -3
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1119 -647
- package/dist-types/models/models_1.d.ts +752 -0
- package/dist-types/pagination/ListAttachmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataAccessorsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPluginActionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPluginTypeActionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPluginTypeMetadataPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchRelevantContentPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/QBusiness.d.ts +239 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +84 -0
- package/dist-types/ts3.4/commands/AssociatePermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ChatCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ChatSyncCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateDataAccessorCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DeleteDataAccessorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociatePermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDataAccessorCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/GetMediaCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAttachmentsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListDataAccessorsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPluginTypeMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchRelevantContentCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateChatControlsConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataAccessorCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +360 -232
- package/dist-types/ts3.4/models/models_1.d.ts +241 -0
- package/dist-types/ts3.4/pagination/ListAttachmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataAccessorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPluginActionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPluginTypeActionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPluginTypeMetadataPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchRelevantContentPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +1 -1
|
@@ -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,13 +76,15 @@ 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
|
* // },
|
|
80
84
|
* // ],
|
|
81
85
|
* // actionReview: { // ActionReview
|
|
82
86
|
* // pluginId: "STRING_VALUE",
|
|
83
|
-
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
87
|
+
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM" || "QUICKSIGHT" || "SERVICENOW_NOW_PLATFORM" || "JIRA_CLOUD" || "SALESFORCE_CRM" || "ZENDESK_SUITE" || "ATLASSIAN_CONFLUENCE" || "GOOGLE_CALENDAR" || "MICROSOFT_TEAMS" || "MICROSOFT_EXCHANGE" || "PAGERDUTY_ADVANCE" || "SMARTSHEET" || "ASANA",
|
|
84
88
|
* // payload: { // ActionReviewPayload
|
|
85
89
|
* // "<keys>": { // ActionReviewPayloadField
|
|
86
90
|
* // displayName: "STRING_VALUE",
|
|
@@ -136,8 +140,8 @@ declare const ListMessagesCommand_base: {
|
|
|
136
140
|
* your admin to activate your license and try again after your licence is active.</p>
|
|
137
141
|
*
|
|
138
142
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
139
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
140
|
-
* resource and try again.</p>
|
|
143
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
144
|
+
* provided the correct resource and try again.</p>
|
|
141
145
|
*
|
|
142
146
|
* @throws {@link ThrottlingException} (client fault)
|
|
143
147
|
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListPluginActionsRequest, ListPluginActionsResponse } 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 ListPluginActionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPluginActionsCommandInput extends ListPluginActionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPluginActionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPluginActionsCommandOutput extends ListPluginActionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListPluginActionsCommand_base: {
|
|
25
|
+
new (input: ListPluginActionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPluginActionsCommandInput, ListPluginActionsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListPluginActionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPluginActionsCommandInput, ListPluginActionsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QBusinessClient, ListPluginActionsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
35
|
+
* // const { QBusinessClient, ListPluginActionsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
36
|
+
* const client = new QBusinessClient(config);
|
|
37
|
+
* const input = { // ListPluginActionsRequest
|
|
38
|
+
* applicationId: "STRING_VALUE", // required
|
|
39
|
+
* pluginId: "STRING_VALUE", // required
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListPluginActionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListPluginActionsResponse
|
|
46
|
+
* // nextToken: "STRING_VALUE",
|
|
47
|
+
* // items: [ // Actions
|
|
48
|
+
* // { // ActionSummary
|
|
49
|
+
* // actionIdentifier: "STRING_VALUE",
|
|
50
|
+
* // displayName: "STRING_VALUE",
|
|
51
|
+
* // instructionExample: "STRING_VALUE",
|
|
52
|
+
* // description: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListPluginActionsCommandInput - {@link ListPluginActionsCommandInput}
|
|
60
|
+
* @returns {@link ListPluginActionsCommandOutput}
|
|
61
|
+
* @see {@link ListPluginActionsCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListPluginActionsCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @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>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
71
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
75
|
+
* provided the correct resource and try again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
79
|
+
* again.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
83
|
+
* correct input and try again.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link QBusinessServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class ListPluginActionsCommand extends ListPluginActionsCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: ListPluginActionsRequest;
|
|
95
|
+
output: ListPluginActionsResponse;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: ListPluginActionsCommandInput;
|
|
99
|
+
output: ListPluginActionsCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListPluginTypeActionsRequest, ListPluginTypeActionsResponse } 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 ListPluginTypeActionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPluginTypeActionsCommandInput extends ListPluginTypeActionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPluginTypeActionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPluginTypeActionsCommandOutput extends ListPluginTypeActionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListPluginTypeActionsCommand_base: {
|
|
25
|
+
new (input: ListPluginTypeActionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPluginTypeActionsCommandInput, ListPluginTypeActionsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListPluginTypeActionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPluginTypeActionsCommandInput, ListPluginTypeActionsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists configured Amazon Q Business actions for any plugin type—both
|
|
31
|
+
* built-in and custom.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { QBusinessClient, ListPluginTypeActionsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
36
|
+
* // const { QBusinessClient, ListPluginTypeActionsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
37
|
+
* const client = new QBusinessClient(config);
|
|
38
|
+
* const input = { // ListPluginTypeActionsRequest
|
|
39
|
+
* pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM" || "QUICKSIGHT" || "SERVICENOW_NOW_PLATFORM" || "JIRA_CLOUD" || "SALESFORCE_CRM" || "ZENDESK_SUITE" || "ATLASSIAN_CONFLUENCE" || "GOOGLE_CALENDAR" || "MICROSOFT_TEAMS" || "MICROSOFT_EXCHANGE" || "PAGERDUTY_ADVANCE" || "SMARTSHEET" || "ASANA", // required
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListPluginTypeActionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListPluginTypeActionsResponse
|
|
46
|
+
* // nextToken: "STRING_VALUE",
|
|
47
|
+
* // items: [ // Actions
|
|
48
|
+
* // { // ActionSummary
|
|
49
|
+
* // actionIdentifier: "STRING_VALUE",
|
|
50
|
+
* // displayName: "STRING_VALUE",
|
|
51
|
+
* // instructionExample: "STRING_VALUE",
|
|
52
|
+
* // description: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListPluginTypeActionsCommandInput - {@link ListPluginTypeActionsCommandInput}
|
|
60
|
+
* @returns {@link ListPluginTypeActionsCommandOutput}
|
|
61
|
+
* @see {@link ListPluginTypeActionsCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListPluginTypeActionsCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @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>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
71
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
75
|
+
* again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
79
|
+
* correct input and try again.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link QBusinessServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export declare class ListPluginTypeActionsCommand extends ListPluginTypeActionsCommand_base {
|
|
87
|
+
/** @internal type navigation helper, not in runtime. */
|
|
88
|
+
protected static __types: {
|
|
89
|
+
api: {
|
|
90
|
+
input: ListPluginTypeActionsRequest;
|
|
91
|
+
output: ListPluginTypeActionsResponse;
|
|
92
|
+
};
|
|
93
|
+
sdk: {
|
|
94
|
+
input: ListPluginTypeActionsCommandInput;
|
|
95
|
+
output: ListPluginTypeActionsCommandOutput;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListPluginTypeMetadataRequest, ListPluginTypeMetadataResponse } 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 ListPluginTypeMetadataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPluginTypeMetadataCommandInput extends ListPluginTypeMetadataRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPluginTypeMetadataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPluginTypeMetadataCommandOutput extends ListPluginTypeMetadataResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListPluginTypeMetadataCommand_base: {
|
|
25
|
+
new (input: ListPluginTypeMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<ListPluginTypeMetadataCommandInput, ListPluginTypeMetadataCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListPluginTypeMetadataCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPluginTypeMetadataCommandInput, ListPluginTypeMetadataCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists metadata for all Amazon Q Business plugin types.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QBusinessClient, ListPluginTypeMetadataCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
35
|
+
* // const { QBusinessClient, ListPluginTypeMetadataCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
36
|
+
* const client = new QBusinessClient(config);
|
|
37
|
+
* const input = { // ListPluginTypeMetadataRequest
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListPluginTypeMetadataCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListPluginTypeMetadataResponse
|
|
44
|
+
* // nextToken: "STRING_VALUE",
|
|
45
|
+
* // items: [ // ListPluginTypeMetadataSummaries
|
|
46
|
+
* // { // PluginTypeMetadataSummary
|
|
47
|
+
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM" || "QUICKSIGHT" || "SERVICENOW_NOW_PLATFORM" || "JIRA_CLOUD" || "SALESFORCE_CRM" || "ZENDESK_SUITE" || "ATLASSIAN_CONFLUENCE" || "GOOGLE_CALENDAR" || "MICROSOFT_TEAMS" || "MICROSOFT_EXCHANGE" || "PAGERDUTY_ADVANCE" || "SMARTSHEET" || "ASANA",
|
|
48
|
+
* // category: "Customer relationship management (CRM)" || "Project management" || "Communication" || "Productivity" || "Ticketing and incident management",
|
|
49
|
+
* // description: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param ListPluginTypeMetadataCommandInput - {@link ListPluginTypeMetadataCommandInput}
|
|
57
|
+
* @returns {@link ListPluginTypeMetadataCommandOutput}
|
|
58
|
+
* @see {@link ListPluginTypeMetadataCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link ListPluginTypeMetadataCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p> You don't have access to perform this action. Make sure you have the required
|
|
64
|
+
* permission policies and user accounts and try again.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
68
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
72
|
+
* again.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
76
|
+
* correct input and try again.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link QBusinessServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class ListPluginTypeMetadataCommand extends ListPluginTypeMetadataCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: ListPluginTypeMetadataRequest;
|
|
88
|
+
output: ListPluginTypeMetadataResponse;
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: ListPluginTypeMetadataCommandInput;
|
|
92
|
+
output: ListPluginTypeMetadataCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -47,7 +47,7 @@ declare const ListPluginsCommand_base: {
|
|
|
47
47
|
* // { // Plugin
|
|
48
48
|
* // pluginId: "STRING_VALUE",
|
|
49
49
|
* // displayName: "STRING_VALUE",
|
|
50
|
-
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM",
|
|
50
|
+
* // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM" || "QUICKSIGHT" || "SERVICENOW_NOW_PLATFORM" || "JIRA_CLOUD" || "SALESFORCE_CRM" || "ZENDESK_SUITE" || "ATLASSIAN_CONFLUENCE" || "GOOGLE_CALENDAR" || "MICROSOFT_TEAMS" || "MICROSOFT_EXCHANGE" || "PAGERDUTY_ADVANCE" || "SMARTSHEET" || "ASANA",
|
|
51
51
|
* // serverUrl: "STRING_VALUE",
|
|
52
52
|
* // state: "ENABLED" || "DISABLED",
|
|
53
53
|
* // buildStatus: "READY" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
|
|
@@ -74,8 +74,8 @@ declare const ListPluginsCommand_base: {
|
|
|
74
74
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
78
|
-
* resource and try again.</p>
|
|
77
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
78
|
+
* provided the correct resource and try again.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
81
81
|
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
@@ -24,7 +24,7 @@ export interface ListRetrieversCommandOutput extends ListRetrieversResponse, __M
|
|
|
24
24
|
declare const ListRetrieversCommand_base: {
|
|
25
25
|
new (input: ListRetrieversCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetrieversCommandInput, ListRetrieversCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
26
|
new (__0_0: ListRetrieversCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetrieversCommandInput, ListRetrieversCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists the retriever used by an Amazon Q Business application.</p>
|
|
@@ -71,8 +71,8 @@ declare const ListRetrieversCommand_base: {
|
|
|
71
71
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
75
|
-
* resource and try again.</p>
|
|
74
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
75
|
+
* provided the correct resource and try again.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ThrottlingException} (client fault)
|
|
78
78
|
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
@@ -66,8 +66,8 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
66
66
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
70
|
-
* resource and try again.</p>
|
|
69
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
70
|
+
* provided the correct resource and try again.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ThrottlingException} (client fault)
|
|
73
73
|
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
@@ -71,8 +71,8 @@ declare const ListWebExperiencesCommand_base: {
|
|
|
71
71
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
75
|
-
* resource and try again.</p>
|
|
74
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
75
|
+
* provided the correct resource and try again.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ThrottlingException} (client fault)
|
|
78
78
|
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
@@ -69,8 +69,8 @@ declare const PutFeedbackCommand_base: {
|
|
|
69
69
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
73
|
-
* resource and try again.</p>
|
|
72
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
73
|
+
* provided the correct resource and try again.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link ThrottlingException} (client fault)
|
|
76
76
|
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
@@ -84,15 +84,15 @@ 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
|
|
91
91
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
92
92
|
*
|
|
93
93
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
-
* <p>The resource you want to use doesn’t exist. Make sure you have
|
|
95
|
-
* resource and try again.</p>
|
|
94
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
95
|
+
* provided the correct resource and try again.</p>
|
|
96
96
|
*
|
|
97
97
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
98
98
|
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { SearchRelevantContentResponse } from "../models/models_0";
|
|
4
|
+
import { SearchRelevantContentRequest } from "../models/models_1";
|
|
5
|
+
import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link SearchRelevantContentCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface SearchRelevantContentCommandInput extends SearchRelevantContentRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link SearchRelevantContentCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface SearchRelevantContentCommandOutput extends SearchRelevantContentResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const SearchRelevantContentCommand_base: {
|
|
26
|
+
new (input: SearchRelevantContentCommandInput): import("@smithy/smithy-client").CommandImpl<SearchRelevantContentCommandInput, SearchRelevantContentCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (__0_0: SearchRelevantContentCommandInput): import("@smithy/smithy-client").CommandImpl<SearchRelevantContentCommandInput, SearchRelevantContentCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Searches for relevant content in a Q Business application based on a query. This operation takes a
|
|
32
|
+
* search query text, the Q Business application identifier, and optional filters
|
|
33
|
+
* (such as user ID, user groups, content source, and maximum results) as input. It returns a list of
|
|
34
|
+
* relevant content items, where each item includes the content text, the unique document identifier,
|
|
35
|
+
* the document title, the document URI, any relevant document attributes, and score attributes
|
|
36
|
+
* indicating the confidence level of the relevance.</p>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { QBusinessClient, SearchRelevantContentCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
41
|
+
* // const { QBusinessClient, SearchRelevantContentCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
42
|
+
* const client = new QBusinessClient(config);
|
|
43
|
+
* const input = { // SearchRelevantContentRequest
|
|
44
|
+
* applicationId: "STRING_VALUE", // required
|
|
45
|
+
* userId: "STRING_VALUE",
|
|
46
|
+
* userGroups: [ // UserGroups
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* queryText: "STRING_VALUE", // required
|
|
50
|
+
* contentSource: { // ContentSource Union: only one key present
|
|
51
|
+
* retriever: { // RetrieverContentSource
|
|
52
|
+
* retrieverId: "STRING_VALUE", // required
|
|
53
|
+
* },
|
|
54
|
+
* },
|
|
55
|
+
* attributeFilter: { // AttributeFilter
|
|
56
|
+
* andAllFilters: [ // AttributeFilters
|
|
57
|
+
* {
|
|
58
|
+
* andAllFilters: [
|
|
59
|
+
* "<AttributeFilter>",
|
|
60
|
+
* ],
|
|
61
|
+
* orAllFilters: [
|
|
62
|
+
* "<AttributeFilter>",
|
|
63
|
+
* ],
|
|
64
|
+
* notFilter: "<AttributeFilter>",
|
|
65
|
+
* equalsTo: { // DocumentAttribute
|
|
66
|
+
* name: "STRING_VALUE", // required
|
|
67
|
+
* value: { // DocumentAttributeValue Union: only one key present
|
|
68
|
+
* stringValue: "STRING_VALUE",
|
|
69
|
+
* stringListValue: [ // DocumentAttributeStringListValue
|
|
70
|
+
* "STRING_VALUE",
|
|
71
|
+
* ],
|
|
72
|
+
* longValue: Number("long"),
|
|
73
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
74
|
+
* },
|
|
75
|
+
* },
|
|
76
|
+
* containsAll: {
|
|
77
|
+
* name: "STRING_VALUE", // required
|
|
78
|
+
* value: {// Union: only one key present
|
|
79
|
+
* stringValue: "STRING_VALUE",
|
|
80
|
+
* stringListValue: [
|
|
81
|
+
* "STRING_VALUE",
|
|
82
|
+
* ],
|
|
83
|
+
* longValue: Number("long"),
|
|
84
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
85
|
+
* },
|
|
86
|
+
* },
|
|
87
|
+
* containsAny: {
|
|
88
|
+
* name: "STRING_VALUE", // required
|
|
89
|
+
* value: {// Union: only one key present
|
|
90
|
+
* stringValue: "STRING_VALUE",
|
|
91
|
+
* stringListValue: [
|
|
92
|
+
* "STRING_VALUE",
|
|
93
|
+
* ],
|
|
94
|
+
* longValue: Number("long"),
|
|
95
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
96
|
+
* },
|
|
97
|
+
* },
|
|
98
|
+
* greaterThan: {
|
|
99
|
+
* name: "STRING_VALUE", // required
|
|
100
|
+
* value: {// Union: only one key present
|
|
101
|
+
* stringValue: "STRING_VALUE",
|
|
102
|
+
* stringListValue: [
|
|
103
|
+
* "STRING_VALUE",
|
|
104
|
+
* ],
|
|
105
|
+
* longValue: Number("long"),
|
|
106
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
107
|
+
* },
|
|
108
|
+
* },
|
|
109
|
+
* greaterThanOrEquals: {
|
|
110
|
+
* name: "STRING_VALUE", // required
|
|
111
|
+
* value: {// Union: only one key present
|
|
112
|
+
* stringValue: "STRING_VALUE",
|
|
113
|
+
* stringListValue: [
|
|
114
|
+
* "STRING_VALUE",
|
|
115
|
+
* ],
|
|
116
|
+
* longValue: Number("long"),
|
|
117
|
+
* dateValue: new Date("TIMESTAMP"),
|
|
118
|
+
* },
|
|
119
|
+
* },
|
|
120
|
+
* lessThan: "<DocumentAttribute>",
|
|
121
|
+
* lessThanOrEquals: "<DocumentAttribute>",
|
|
122
|
+
* },
|
|
123
|
+
* ],
|
|
124
|
+
* orAllFilters: [
|
|
125
|
+
* "<AttributeFilter>",
|
|
126
|
+
* ],
|
|
127
|
+
* notFilter: "<AttributeFilter>",
|
|
128
|
+
* equalsTo: "<DocumentAttribute>",
|
|
129
|
+
* containsAll: "<DocumentAttribute>",
|
|
130
|
+
* containsAny: "<DocumentAttribute>",
|
|
131
|
+
* greaterThan: "<DocumentAttribute>",
|
|
132
|
+
* greaterThanOrEquals: "<DocumentAttribute>",
|
|
133
|
+
* lessThan: "<DocumentAttribute>",
|
|
134
|
+
* lessThanOrEquals: "<DocumentAttribute>",
|
|
135
|
+
* },
|
|
136
|
+
* maxResults: Number("int"),
|
|
137
|
+
* nextToken: "STRING_VALUE",
|
|
138
|
+
* };
|
|
139
|
+
* const command = new SearchRelevantContentCommand(input);
|
|
140
|
+
* const response = await client.send(command);
|
|
141
|
+
* // { // SearchRelevantContentResponse
|
|
142
|
+
* // relevantContent: [ // RelevantContentList
|
|
143
|
+
* // { // RelevantContent
|
|
144
|
+
* // content: "STRING_VALUE",
|
|
145
|
+
* // documentId: "STRING_VALUE",
|
|
146
|
+
* // documentTitle: "STRING_VALUE",
|
|
147
|
+
* // documentUri: "STRING_VALUE",
|
|
148
|
+
* // documentAttributes: [ // DocumentAttributes
|
|
149
|
+
* // { // DocumentAttribute
|
|
150
|
+
* // name: "STRING_VALUE", // required
|
|
151
|
+
* // value: { // DocumentAttributeValue Union: only one key present
|
|
152
|
+
* // stringValue: "STRING_VALUE",
|
|
153
|
+
* // stringListValue: [ // DocumentAttributeStringListValue
|
|
154
|
+
* // "STRING_VALUE",
|
|
155
|
+
* // ],
|
|
156
|
+
* // longValue: Number("long"),
|
|
157
|
+
* // dateValue: new Date("TIMESTAMP"),
|
|
158
|
+
* // },
|
|
159
|
+
* // },
|
|
160
|
+
* // ],
|
|
161
|
+
* // scoreAttributes: { // ScoreAttributes
|
|
162
|
+
* // scoreConfidence: "VERY_HIGH" || "HIGH" || "MEDIUM" || "LOW" || "NOT_AVAILABLE",
|
|
163
|
+
* // },
|
|
164
|
+
* // },
|
|
165
|
+
* // ],
|
|
166
|
+
* // nextToken: "STRING_VALUE",
|
|
167
|
+
* // };
|
|
168
|
+
*
|
|
169
|
+
* ```
|
|
170
|
+
*
|
|
171
|
+
* @param SearchRelevantContentCommandInput - {@link SearchRelevantContentCommandInput}
|
|
172
|
+
* @returns {@link SearchRelevantContentCommandOutput}
|
|
173
|
+
* @see {@link SearchRelevantContentCommandInput} for command's `input` shape.
|
|
174
|
+
* @see {@link SearchRelevantContentCommandOutput} for command's `response` shape.
|
|
175
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
176
|
+
*
|
|
177
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
178
|
+
* <p> You don't have access to perform this action. Make sure you have the required
|
|
179
|
+
* permission policies and user accounts and try again.</p>
|
|
180
|
+
*
|
|
181
|
+
* @throws {@link InternalServerException} (server fault)
|
|
182
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
183
|
+
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
184
|
+
*
|
|
185
|
+
* @throws {@link LicenseNotFoundException} (client fault)
|
|
186
|
+
* <p>You don't have permissions to perform the action because your license is inactive. Ask
|
|
187
|
+
* your admin to activate your license and try again after your licence is active.</p>
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
190
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
191
|
+
* provided the correct resource and try again.</p>
|
|
192
|
+
*
|
|
193
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
194
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
195
|
+
* again.</p>
|
|
196
|
+
*
|
|
197
|
+
* @throws {@link ValidationException} (client fault)
|
|
198
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
199
|
+
* correct input and try again.</p>
|
|
200
|
+
*
|
|
201
|
+
* @throws {@link QBusinessServiceException}
|
|
202
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
203
|
+
*
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
export declare class SearchRelevantContentCommand extends SearchRelevantContentCommand_base {
|
|
207
|
+
/** @internal type navigation helper, not in runtime. */
|
|
208
|
+
protected static __types: {
|
|
209
|
+
api: {
|
|
210
|
+
input: SearchRelevantContentRequest;
|
|
211
|
+
output: SearchRelevantContentResponse;
|
|
212
|
+
};
|
|
213
|
+
sdk: {
|
|
214
|
+
input: SearchRelevantContentCommandInput;
|
|
215
|
+
output: SearchRelevantContentCommandOutput;
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
}
|