@aws-sdk/client-qbusiness 3.511.0 → 3.514.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 +81 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/index.js +193 -92
- package/dist-cjs/runtimeConfig.shared.js +10 -0
- package/dist-es/QBusinessClient.js +17 -4
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/models/models_0.js +35 -0
- package/dist-es/runtimeConfig.shared.js +10 -0
- package/dist-es/runtimeExtensions.js +3 -0
- package/dist-types/QBusiness.d.ts +83 -2
- package/dist-types/QBusinessClient.d.ts +96 -13
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
- package/dist-types/commands/CreateRetrieverCommand.d.ts +21 -0
- package/dist-types/commands/GetRetrieverCommand.d.ts +21 -0
- package/dist-types/commands/PutFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +21 -0
- package/dist-types/extensionConfiguration.d.ts +2 -1
- package/dist-types/index.d.ts +83 -2
- package/dist-types/models/models_0.d.ts +239 -19
- package/dist-types/runtimeConfig.browser.d.ts +5 -3
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +6 -4
- package/dist-types/runtimeConfig.shared.d.ts +2 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +11 -9
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -6,8 +6,89 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
+
<note>
|
|
10
|
+
<p>Amazon Q is in preview release and is subject to change.</p>
|
|
11
|
+
</note>
|
|
12
|
+
<p>This is the <i>Amazon Q (for business use)</i> API Reference.
|
|
13
|
+
Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
|
|
14
|
+
you can deploy within your organization. Amazon Q enhances employee productivity by
|
|
15
|
+
supporting key tasks such as question-answering, knowledge discovery, writing email
|
|
16
|
+
messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
|
|
17
|
+
ask questions of Amazon Q and get answers that are presented in a conversational
|
|
18
|
+
manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
|
|
19
|
+
<i>Amazon Q (for business use) Developer
|
|
20
|
+
Guide</i>
|
|
21
|
+
</a>.</p>
|
|
22
|
+
<p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
|
|
23
|
+
<p>For information about the IAM access control permissions you need to
|
|
24
|
+
use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
|
|
25
|
+
<i>Amazon Q (for business use) Developer Guide</i>.</p>
|
|
26
|
+
<p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
|
|
27
|
+
<ul>
|
|
28
|
+
<li>
|
|
9
29
|
<p>
|
|
30
|
+
<a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
|
|
10
31
|
</p>
|
|
32
|
+
</li>
|
|
33
|
+
<li>
|
|
34
|
+
<p>
|
|
35
|
+
<a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
|
|
36
|
+
</p>
|
|
37
|
+
</li>
|
|
38
|
+
<li>
|
|
39
|
+
<p>
|
|
40
|
+
<a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
|
|
41
|
+
</p>
|
|
42
|
+
</li>
|
|
43
|
+
<li>
|
|
44
|
+
<p>
|
|
45
|
+
<a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
|
|
46
|
+
JavaScript</a>
|
|
47
|
+
</p>
|
|
48
|
+
</li>
|
|
49
|
+
<li>
|
|
50
|
+
<p>
|
|
51
|
+
<a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
|
|
52
|
+
</p>
|
|
53
|
+
</li>
|
|
54
|
+
<li>
|
|
55
|
+
<p>
|
|
56
|
+
<a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
|
|
57
|
+
(Boto3)</a>
|
|
58
|
+
</p>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<p>
|
|
62
|
+
<a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
|
|
63
|
+
</p>
|
|
64
|
+
</li>
|
|
65
|
+
</ul>
|
|
66
|
+
<p>The following resources provide additional information about using the Amazon Q
|
|
67
|
+
API:</p>
|
|
68
|
+
<ul>
|
|
69
|
+
<li>
|
|
70
|
+
<p>
|
|
71
|
+
<i>
|
|
72
|
+
<a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
|
|
73
|
+
Amazon Q</a>
|
|
74
|
+
</i>
|
|
75
|
+
</p>
|
|
76
|
+
</li>
|
|
77
|
+
<li>
|
|
78
|
+
<p>
|
|
79
|
+
<i>
|
|
80
|
+
<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
|
|
81
|
+
</i>
|
|
82
|
+
</p>
|
|
83
|
+
</li>
|
|
84
|
+
<li>
|
|
85
|
+
<p>
|
|
86
|
+
<i>
|
|
87
|
+
<a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
|
|
88
|
+
</i>
|
|
89
|
+
</p>
|
|
90
|
+
</li>
|
|
91
|
+
</ul>
|
|
11
92
|
|
|
12
93
|
## Installing
|
|
13
94
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../index.js");
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveHttpAuthSchemeConfig = exports.defaultQBusinessHttpAuthSchemeProvider = exports.defaultQBusinessHttpAuthSchemeParametersProvider = void 0;
|
|
4
|
+
const core_1 = require("@aws-sdk/core");
|
|
5
|
+
const util_middleware_1 = require("@smithy/util-middleware");
|
|
6
|
+
const defaultQBusinessHttpAuthSchemeParametersProvider = async (config, context, input) => {
|
|
7
|
+
return {
|
|
8
|
+
operation: (0, util_middleware_1.getSmithyContext)(context).operation,
|
|
9
|
+
region: (await (0, util_middleware_1.normalizeProvider)(config.region)()) ||
|
|
10
|
+
(() => {
|
|
11
|
+
throw new Error("expected `region` to be configured for `aws.auth#sigv4`");
|
|
12
|
+
})(),
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
exports.defaultQBusinessHttpAuthSchemeParametersProvider = defaultQBusinessHttpAuthSchemeParametersProvider;
|
|
16
|
+
function createAwsAuthSigv4HttpAuthOption(authParameters) {
|
|
17
|
+
return {
|
|
18
|
+
schemeId: "aws.auth#sigv4",
|
|
19
|
+
signingProperties: {
|
|
20
|
+
name: "qbusiness",
|
|
21
|
+
region: authParameters.region,
|
|
22
|
+
},
|
|
23
|
+
propertiesExtractor: (config, context) => ({
|
|
24
|
+
signingProperties: {
|
|
25
|
+
config,
|
|
26
|
+
context,
|
|
27
|
+
},
|
|
28
|
+
}),
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
const defaultQBusinessHttpAuthSchemeProvider = (authParameters) => {
|
|
32
|
+
const options = [];
|
|
33
|
+
switch (authParameters.operation) {
|
|
34
|
+
default: {
|
|
35
|
+
options.push(createAwsAuthSigv4HttpAuthOption(authParameters));
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return options;
|
|
39
|
+
};
|
|
40
|
+
exports.defaultQBusinessHttpAuthSchemeProvider = defaultQBusinessHttpAuthSchemeProvider;
|
|
41
|
+
const resolveHttpAuthSchemeConfig = (config) => {
|
|
42
|
+
const config_0 = (0, core_1.resolveAwsSdkSigV4Config)(config);
|
|
43
|
+
return {
|
|
44
|
+
...config_0,
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
exports.resolveHttpAuthSchemeConfig = resolveHttpAuthSchemeConfig;
|