@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.
Files changed (37) hide show
  1. package/README.md +81 -0
  2. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  4. package/dist-cjs/index.js +193 -92
  5. package/dist-cjs/runtimeConfig.shared.js +10 -0
  6. package/dist-es/QBusinessClient.js +17 -4
  7. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  8. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  9. package/dist-es/models/models_0.js +35 -0
  10. package/dist-es/runtimeConfig.shared.js +10 -0
  11. package/dist-es/runtimeExtensions.js +3 -0
  12. package/dist-types/QBusiness.d.ts +83 -2
  13. package/dist-types/QBusinessClient.d.ts +96 -13
  14. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  15. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  16. package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
  17. package/dist-types/commands/CreateRetrieverCommand.d.ts +21 -0
  18. package/dist-types/commands/GetRetrieverCommand.d.ts +21 -0
  19. package/dist-types/commands/PutFeedbackCommand.d.ts +1 -1
  20. package/dist-types/commands/UpdateRetrieverCommand.d.ts +21 -0
  21. package/dist-types/extensionConfiguration.d.ts +2 -1
  22. package/dist-types/index.d.ts +83 -2
  23. package/dist-types/models/models_0.d.ts +239 -19
  24. package/dist-types/runtimeConfig.browser.d.ts +5 -3
  25. package/dist-types/runtimeConfig.d.ts +4 -2
  26. package/dist-types/runtimeConfig.native.d.ts +6 -4
  27. package/dist-types/runtimeConfig.shared.d.ts +2 -0
  28. package/dist-types/ts3.4/QBusinessClient.d.ts +11 -9
  29. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  30. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  31. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  32. package/dist-types/ts3.4/models/models_0.d.ts +99 -0
  33. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
  34. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
  35. package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
  36. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
  37. package/package.json +7 -7
@@ -1,10 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
+ const core_1 = require("@aws-sdk/core");
4
5
  const smithy_client_1 = require("@smithy/smithy-client");
5
6
  const url_parser_1 = require("@smithy/url-parser");
6
7
  const util_base64_1 = require("@smithy/util-base64");
7
8
  const util_utf8_1 = require("@smithy/util-utf8");
9
+ const httpAuthSchemeProvider_1 = require("./auth/httpAuthSchemeProvider");
8
10
  const endpointResolver_1 = require("./endpoint/endpointResolver");
9
11
  const getRuntimeConfig = (config) => {
10
12
  return {
@@ -14,6 +16,14 @@ const getRuntimeConfig = (config) => {
14
16
  disableHostPrefix: config?.disableHostPrefix ?? false,
15
17
  endpointProvider: config?.endpointProvider ?? endpointResolver_1.defaultEndpointResolver,
16
18
  extensions: config?.extensions ?? [],
19
+ httpAuthSchemeProvider: config?.httpAuthSchemeProvider ?? httpAuthSchemeProvider_1.defaultQBusinessHttpAuthSchemeProvider,
20
+ httpAuthSchemes: config?.httpAuthSchemes ?? [
21
+ {
22
+ schemeId: "aws.auth#sigv4",
23
+ identityProvider: (ipc) => ipc.getIdentityProvider("aws.auth#sigv4"),
24
+ signer: new core_1.AwsSdkSigV4Signer(),
25
+ },
26
+ ],
17
27
  logger: config?.logger ?? new smithy_client_1.NoOpLogger(),
18
28
  serviceId: config?.serviceId ?? "QBusiness",
19
29
  urlParser: config?.urlParser ?? url_parser_1.parseUrl,
@@ -1,13 +1,14 @@
1
1
  import { getHostHeaderPlugin, resolveHostHeaderConfig, } from "@aws-sdk/middleware-host-header";
2
2
  import { getLoggerPlugin } from "@aws-sdk/middleware-logger";
3
3
  import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection";
4
- import { getAwsAuthPlugin, resolveAwsAuthConfig, } from "@aws-sdk/middleware-signing";
5
4
  import { getUserAgentPlugin, resolveUserAgentConfig, } from "@aws-sdk/middleware-user-agent";
6
5
  import { resolveRegionConfig } from "@smithy/config-resolver";
6
+ import { DefaultIdentityProviderConfig, getHttpAuthSchemeEndpointRuleSetPlugin, getHttpSigningPlugin, } from "@smithy/core";
7
7
  import { getContentLengthPlugin } from "@smithy/middleware-content-length";
8
8
  import { resolveEndpointConfig } from "@smithy/middleware-endpoint";
9
9
  import { getRetryPlugin, resolveRetryConfig } from "@smithy/middleware-retry";
10
10
  import { Client as __Client, } from "@smithy/smithy-client";
11
+ import { defaultQBusinessHttpAuthSchemeParametersProvider, resolveHttpAuthSchemeConfig, } from "./auth/httpAuthSchemeProvider";
11
12
  import { resolveClientEndpointParameters, } from "./endpoint/EndpointParameters";
12
13
  import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
13
14
  import { resolveRuntimeExtensions } from "./runtimeExtensions";
@@ -20,8 +21,8 @@ export class QBusinessClient extends __Client {
20
21
  const _config_3 = resolveEndpointConfig(_config_2);
21
22
  const _config_4 = resolveRetryConfig(_config_3);
22
23
  const _config_5 = resolveHostHeaderConfig(_config_4);
23
- const _config_6 = resolveAwsAuthConfig(_config_5);
24
- const _config_7 = resolveUserAgentConfig(_config_6);
24
+ const _config_6 = resolveUserAgentConfig(_config_5);
25
+ const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
25
26
  const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
26
27
  super(_config_8);
27
28
  this.config = _config_8;
@@ -30,10 +31,22 @@ export class QBusinessClient extends __Client {
30
31
  this.middlewareStack.use(getHostHeaderPlugin(this.config));
31
32
  this.middlewareStack.use(getLoggerPlugin(this.config));
32
33
  this.middlewareStack.use(getRecursionDetectionPlugin(this.config));
33
- this.middlewareStack.use(getAwsAuthPlugin(this.config));
34
34
  this.middlewareStack.use(getUserAgentPlugin(this.config));
35
+ this.middlewareStack.use(getHttpAuthSchemeEndpointRuleSetPlugin(this.config, {
36
+ httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
37
+ identityProviderConfigProvider: this.getIdentityProviderConfigProvider(),
38
+ }));
39
+ this.middlewareStack.use(getHttpSigningPlugin(this.config));
35
40
  }
36
41
  destroy() {
37
42
  super.destroy();
38
43
  }
44
+ getDefaultHttpAuthSchemeParametersProvider() {
45
+ return defaultQBusinessHttpAuthSchemeParametersProvider;
46
+ }
47
+ getIdentityProviderConfigProvider() {
48
+ return async (config) => new DefaultIdentityProviderConfig({
49
+ "aws.auth#sigv4": config.credentials,
50
+ });
51
+ }
39
52
  }
@@ -0,0 +1,38 @@
1
+ export const getHttpAuthExtensionConfiguration = (runtimeConfig) => {
2
+ const _httpAuthSchemes = runtimeConfig.httpAuthSchemes;
3
+ let _httpAuthSchemeProvider = runtimeConfig.httpAuthSchemeProvider;
4
+ let _credentials = runtimeConfig.credentials;
5
+ return {
6
+ setHttpAuthScheme(httpAuthScheme) {
7
+ const index = _httpAuthSchemes.findIndex((scheme) => scheme.schemeId === httpAuthScheme.schemeId);
8
+ if (index === -1) {
9
+ _httpAuthSchemes.push(httpAuthScheme);
10
+ }
11
+ else {
12
+ _httpAuthSchemes.splice(index, 1, httpAuthScheme);
13
+ }
14
+ },
15
+ httpAuthSchemes() {
16
+ return _httpAuthSchemes;
17
+ },
18
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider) {
19
+ _httpAuthSchemeProvider = httpAuthSchemeProvider;
20
+ },
21
+ httpAuthSchemeProvider() {
22
+ return _httpAuthSchemeProvider;
23
+ },
24
+ setCredentials(credentials) {
25
+ _credentials = credentials;
26
+ },
27
+ credentials() {
28
+ return _credentials;
29
+ },
30
+ };
31
+ };
32
+ export const resolveHttpAuthRuntimeConfig = (config) => {
33
+ return {
34
+ httpAuthSchemes: config.httpAuthSchemes(),
35
+ httpAuthSchemeProvider: config.httpAuthSchemeProvider(),
36
+ credentials: config.credentials(),
37
+ };
38
+ };
@@ -0,0 +1,41 @@
1
+ import { resolveAwsSdkSigV4Config, } from "@aws-sdk/core";
2
+ import { getSmithyContext, normalizeProvider } from "@smithy/util-middleware";
3
+ export const defaultQBusinessHttpAuthSchemeParametersProvider = async (config, context, input) => {
4
+ return {
5
+ operation: getSmithyContext(context).operation,
6
+ region: (await normalizeProvider(config.region)()) ||
7
+ (() => {
8
+ throw new Error("expected `region` to be configured for `aws.auth#sigv4`");
9
+ })(),
10
+ };
11
+ };
12
+ function createAwsAuthSigv4HttpAuthOption(authParameters) {
13
+ return {
14
+ schemeId: "aws.auth#sigv4",
15
+ signingProperties: {
16
+ name: "qbusiness",
17
+ region: authParameters.region,
18
+ },
19
+ propertiesExtractor: (config, context) => ({
20
+ signingProperties: {
21
+ config,
22
+ context,
23
+ },
24
+ }),
25
+ };
26
+ }
27
+ export const defaultQBusinessHttpAuthSchemeProvider = (authParameters) => {
28
+ const options = [];
29
+ switch (authParameters.operation) {
30
+ default: {
31
+ options.push(createAwsAuthSigv4HttpAuthOption(authParameters));
32
+ }
33
+ }
34
+ return options;
35
+ };
36
+ export const resolveHttpAuthSchemeConfig = (config) => {
37
+ const config_0 = resolveAwsSdkSigV4Config(config);
38
+ return {
39
+ ...config_0,
40
+ };
41
+ };
@@ -220,6 +220,37 @@ export const PluginState = {
220
220
  DISABLED: "DISABLED",
221
221
  ENABLED: "ENABLED",
222
222
  };
223
+ export const DocumentAttributeBoostingLevel = {
224
+ HIGH: "HIGH",
225
+ LOW: "LOW",
226
+ MEDIUM: "MEDIUM",
227
+ NONE: "NONE",
228
+ VERY_HIGH: "VERY_HIGH",
229
+ };
230
+ export const NumberAttributeBoostingType = {
231
+ PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES",
232
+ PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES",
233
+ };
234
+ export const StringAttributeValueBoostingLevel = {
235
+ HIGH: "HIGH",
236
+ LOW: "LOW",
237
+ MEDIUM: "MEDIUM",
238
+ VERY_HIGH: "VERY_HIGH",
239
+ };
240
+ export var DocumentAttributeBoostingConfiguration;
241
+ (function (DocumentAttributeBoostingConfiguration) {
242
+ DocumentAttributeBoostingConfiguration.visit = (value, visitor) => {
243
+ if (value.numberConfiguration !== undefined)
244
+ return visitor.numberConfiguration(value.numberConfiguration);
245
+ if (value.stringConfiguration !== undefined)
246
+ return visitor.stringConfiguration(value.stringConfiguration);
247
+ if (value.dateConfiguration !== undefined)
248
+ return visitor.dateConfiguration(value.dateConfiguration);
249
+ if (value.stringListConfiguration !== undefined)
250
+ return visitor.stringListConfiguration(value.stringListConfiguration);
251
+ return visitor._(value.$unknown[0], value.$unknown[1]);
252
+ };
253
+ })(DocumentAttributeBoostingConfiguration || (DocumentAttributeBoostingConfiguration = {}));
223
254
  export var RetrieverConfiguration;
224
255
  (function (RetrieverConfiguration) {
225
256
  RetrieverConfiguration.visit = (value, visitor) => {
@@ -352,8 +383,12 @@ export const MessageUsefulnessReason = {
352
383
  HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE",
353
384
  HELPFUL: "HELPFUL",
354
385
  INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES",
386
+ NOT_BASED_ON_DOCUMENTS: "NOT_BASED_ON_DOCUMENTS",
387
+ NOT_COMPLETE: "NOT_COMPLETE",
388
+ NOT_CONCISE: "NOT_CONCISE",
355
389
  NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT",
356
390
  NOT_HELPFUL: "NOT_HELPFUL",
391
+ OTHER: "OTHER",
357
392
  RELEVANT_SOURCES: "RELEVANT_SOURCES",
358
393
  };
359
394
  export const MessageUsefulness = {
@@ -1,7 +1,9 @@
1
+ import { AwsSdkSigV4Signer } from "@aws-sdk/core";
1
2
  import { NoOpLogger } from "@smithy/smithy-client";
2
3
  import { parseUrl } from "@smithy/url-parser";
3
4
  import { fromBase64, toBase64 } from "@smithy/util-base64";
4
5
  import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
6
+ import { defaultQBusinessHttpAuthSchemeProvider } from "./auth/httpAuthSchemeProvider";
5
7
  import { defaultEndpointResolver } from "./endpoint/endpointResolver";
6
8
  export const getRuntimeConfig = (config) => {
7
9
  return {
@@ -11,6 +13,14 @@ export const getRuntimeConfig = (config) => {
11
13
  disableHostPrefix: config?.disableHostPrefix ?? false,
12
14
  endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
13
15
  extensions: config?.extensions ?? [],
16
+ httpAuthSchemeProvider: config?.httpAuthSchemeProvider ?? defaultQBusinessHttpAuthSchemeProvider,
17
+ httpAuthSchemes: config?.httpAuthSchemes ?? [
18
+ {
19
+ schemeId: "aws.auth#sigv4",
20
+ identityProvider: (ipc) => ipc.getIdentityProvider("aws.auth#sigv4"),
21
+ signer: new AwsSdkSigV4Signer(),
22
+ },
23
+ ],
14
24
  logger: config?.logger ?? new NoOpLogger(),
15
25
  serviceId: config?.serviceId ?? "QBusiness",
16
26
  urlParser: config?.urlParser ?? parseUrl,
@@ -1,12 +1,14 @@
1
1
  import { getAwsRegionExtensionConfiguration, resolveAwsRegionExtensionConfiguration, } from "@aws-sdk/region-config-resolver";
2
2
  import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
3
3
  import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
4
+ import { getHttpAuthExtensionConfiguration, resolveHttpAuthRuntimeConfig } from "./auth/httpAuthExtensionConfiguration";
4
5
  const asPartial = (t) => t;
5
6
  export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
6
7
  const extensionConfiguration = {
7
8
  ...asPartial(getAwsRegionExtensionConfiguration(runtimeConfig)),
8
9
  ...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
9
10
  ...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
11
+ ...asPartial(getHttpAuthExtensionConfiguration(runtimeConfig)),
10
12
  };
11
13
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
12
14
  return {
@@ -14,5 +16,6 @@ export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
14
16
  ...resolveAwsRegionExtensionConfiguration(extensionConfiguration),
15
17
  ...resolveDefaultRuntimeConfig(extensionConfiguration),
16
18
  ...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
19
+ ...resolveHttpAuthRuntimeConfig(extensionConfiguration),
17
20
  };
18
21
  };
@@ -389,8 +389,89 @@ export interface QBusiness {
389
389
  }
390
390
  /**
391
391
  * @public
392
- * <p>
393
- * </p>
392
+ * <note>
393
+ * <p>Amazon Q is in preview release and is subject to change.</p>
394
+ * </note>
395
+ * <p>This is the <i>Amazon Q (for business use)</i> API Reference.
396
+ * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
397
+ * you can deploy within your organization. Amazon Q enhances employee productivity by
398
+ * supporting key tasks such as question-answering, knowledge discovery, writing email
399
+ * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
400
+ * ask questions of Amazon Q and get answers that are presented in a conversational
401
+ * manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
402
+ * <i>Amazon Q (for business use) Developer
403
+ * Guide</i>
404
+ * </a>.</p>
405
+ * <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>
406
+ * <p>For information about the IAM access control permissions you need to
407
+ * 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
408
+ * <i>Amazon Q (for business use) Developer Guide</i>.</p>
409
+ * <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
410
+ * <ul>
411
+ * <li>
412
+ * <p>
413
+ * <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
414
+ * </p>
415
+ * </li>
416
+ * <li>
417
+ * <p>
418
+ * <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
419
+ * </p>
420
+ * </li>
421
+ * <li>
422
+ * <p>
423
+ * <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
424
+ * </p>
425
+ * </li>
426
+ * <li>
427
+ * <p>
428
+ * <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
429
+ * JavaScript</a>
430
+ * </p>
431
+ * </li>
432
+ * <li>
433
+ * <p>
434
+ * <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
435
+ * </p>
436
+ * </li>
437
+ * <li>
438
+ * <p>
439
+ * <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
440
+ * (Boto3)</a>
441
+ * </p>
442
+ * </li>
443
+ * <li>
444
+ * <p>
445
+ * <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
446
+ * </p>
447
+ * </li>
448
+ * </ul>
449
+ * <p>The following resources provide additional information about using the Amazon Q
450
+ * API:</p>
451
+ * <ul>
452
+ * <li>
453
+ * <p>
454
+ * <i>
455
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
456
+ * Amazon Q</a>
457
+ * </i>
458
+ * </p>
459
+ * </li>
460
+ * <li>
461
+ * <p>
462
+ * <i>
463
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
464
+ * </i>
465
+ * </p>
466
+ * </li>
467
+ * <li>
468
+ * <p>
469
+ * <i>
470
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
471
+ * </i>
472
+ * </p>
473
+ * </li>
474
+ * </ul>
394
475
  */
395
476
  export declare class QBusiness extends QBusinessClient implements QBusiness {
396
477
  }
@@ -1,13 +1,12 @@
1
1
  import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
2
- import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
3
2
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
4
- import { Credentials as __Credentials } from "@aws-sdk/types";
5
3
  import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
6
4
  import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
7
5
  import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
8
6
  import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
9
7
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
10
- import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
8
+ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
+ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
11
10
  import { BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput } from "./commands/BatchDeleteDocumentCommand";
12
11
  import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./commands/BatchPutDocumentCommand";
13
12
  import { ChatSyncCommandInput, ChatSyncCommandOutput } from "./commands/ChatSyncCommand";
@@ -146,20 +145,21 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
146
145
  * Enables FIPS compatible endpoints.
147
146
  */
148
147
  useFipsEndpoint?: boolean | __Provider<boolean>;
148
+ /**
149
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
150
+ * @internal
151
+ */
152
+ defaultUserAgentProvider?: Provider<__UserAgent>;
149
153
  /**
150
154
  * The AWS region to which this client will send requests
151
155
  */
152
156
  region?: string | __Provider<string>;
153
157
  /**
154
158
  * Default credentials provider; Not available in browser runtime.
159
+ * @deprecated
155
160
  * @internal
156
161
  */
157
- credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
158
- /**
159
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
160
- * @internal
161
- */
162
- defaultUserAgentProvider?: Provider<__UserAgent>;
162
+ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
163
163
  /**
164
164
  * Value for how many times a request will be made at most in case of retry.
165
165
  */
@@ -186,7 +186,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
186
186
  /**
187
187
  * @public
188
188
  */
189
- export type QBusinessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
189
+ export type QBusinessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
190
190
  /**
191
191
  * @public
192
192
  *
@@ -197,7 +197,7 @@ export interface QBusinessClientConfig extends QBusinessClientConfigType {
197
197
  /**
198
198
  * @public
199
199
  */
200
- export type QBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
200
+ export type QBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
201
201
  /**
202
202
  * @public
203
203
  *
@@ -207,8 +207,89 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
207
207
  }
208
208
  /**
209
209
  * @public
210
- * <p>
211
- * </p>
210
+ * <note>
211
+ * <p>Amazon Q is in preview release and is subject to change.</p>
212
+ * </note>
213
+ * <p>This is the <i>Amazon Q (for business use)</i> API Reference.
214
+ * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
215
+ * you can deploy within your organization. Amazon Q enhances employee productivity by
216
+ * supporting key tasks such as question-answering, knowledge discovery, writing email
217
+ * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
218
+ * ask questions of Amazon Q and get answers that are presented in a conversational
219
+ * manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
220
+ * <i>Amazon Q (for business use) Developer
221
+ * Guide</i>
222
+ * </a>.</p>
223
+ * <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>
224
+ * <p>For information about the IAM access control permissions you need to
225
+ * 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
226
+ * <i>Amazon Q (for business use) Developer Guide</i>.</p>
227
+ * <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
228
+ * <ul>
229
+ * <li>
230
+ * <p>
231
+ * <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
232
+ * </p>
233
+ * </li>
234
+ * <li>
235
+ * <p>
236
+ * <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
237
+ * </p>
238
+ * </li>
239
+ * <li>
240
+ * <p>
241
+ * <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
242
+ * </p>
243
+ * </li>
244
+ * <li>
245
+ * <p>
246
+ * <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
247
+ * JavaScript</a>
248
+ * </p>
249
+ * </li>
250
+ * <li>
251
+ * <p>
252
+ * <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
253
+ * </p>
254
+ * </li>
255
+ * <li>
256
+ * <p>
257
+ * <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
258
+ * (Boto3)</a>
259
+ * </p>
260
+ * </li>
261
+ * <li>
262
+ * <p>
263
+ * <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
264
+ * </p>
265
+ * </li>
266
+ * </ul>
267
+ * <p>The following resources provide additional information about using the Amazon Q
268
+ * API:</p>
269
+ * <ul>
270
+ * <li>
271
+ * <p>
272
+ * <i>
273
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
274
+ * Amazon Q</a>
275
+ * </i>
276
+ * </p>
277
+ * </li>
278
+ * <li>
279
+ * <p>
280
+ * <i>
281
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
282
+ * </i>
283
+ * </p>
284
+ * </li>
285
+ * <li>
286
+ * <p>
287
+ * <i>
288
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
289
+ * </i>
290
+ * </p>
291
+ * </li>
292
+ * </ul>
212
293
  */
213
294
  export declare class QBusinessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, QBusinessClientResolvedConfig> {
214
295
  /**
@@ -222,4 +303,6 @@ export declare class QBusinessClient extends __Client<__HttpHandlerOptions, Serv
222
303
  * Otherwise, sockets might stay open for quite a long time before the server terminates them.
223
304
  */
224
305
  destroy(): void;
306
+ private getDefaultHttpAuthSchemeParametersProvider;
307
+ private getIdentityProviderConfigProvider;
225
308
  }
@@ -0,0 +1,29 @@
1
+ import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
2
+ import { QBusinessHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface HttpAuthExtensionConfiguration {
7
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
8
+ httpAuthSchemes(): HttpAuthScheme[];
9
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider: QBusinessHttpAuthSchemeProvider): void;
10
+ httpAuthSchemeProvider(): QBusinessHttpAuthSchemeProvider;
11
+ setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
12
+ credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
13
+ }
14
+ /**
15
+ * @internal
16
+ */
17
+ export type HttpAuthRuntimeConfig = Partial<{
18
+ httpAuthSchemes: HttpAuthScheme[];
19
+ httpAuthSchemeProvider: QBusinessHttpAuthSchemeProvider;
20
+ credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
21
+ }>;
22
+ /**
23
+ * @internal
24
+ */
25
+ export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
26
+ /**
27
+ * @internal
28
+ */
29
+ export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;
@@ -0,0 +1,61 @@
1
+ import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
2
+ import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider } from "@smithy/types";
3
+ import { QBusinessClientResolvedConfig } from "../QBusinessClient";
4
+ /**
5
+ * @internal
6
+ */
7
+ export interface QBusinessHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
8
+ region?: string;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export interface QBusinessHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<QBusinessClientResolvedConfig, HandlerExecutionContext, QBusinessHttpAuthSchemeParameters, object> {
14
+ }
15
+ /**
16
+ * @internal
17
+ */
18
+ export declare const defaultQBusinessHttpAuthSchemeParametersProvider: (config: QBusinessClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<QBusinessHttpAuthSchemeParameters>;
19
+ /**
20
+ * @internal
21
+ */
22
+ export interface QBusinessHttpAuthSchemeProvider extends HttpAuthSchemeProvider<QBusinessHttpAuthSchemeParameters> {
23
+ }
24
+ /**
25
+ * @internal
26
+ */
27
+ export declare const defaultQBusinessHttpAuthSchemeProvider: QBusinessHttpAuthSchemeProvider;
28
+ /**
29
+ * @internal
30
+ */
31
+ export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
32
+ /**
33
+ * experimentalIdentityAndAuth: Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
34
+ * @internal
35
+ */
36
+ httpAuthSchemes?: HttpAuthScheme[];
37
+ /**
38
+ * experimentalIdentityAndAuth: Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
39
+ * @internal
40
+ */
41
+ httpAuthSchemeProvider?: QBusinessHttpAuthSchemeProvider;
42
+ }
43
+ /**
44
+ * @internal
45
+ */
46
+ export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
47
+ /**
48
+ * experimentalIdentityAndAuth: Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
49
+ * @internal
50
+ */
51
+ readonly httpAuthSchemes: HttpAuthScheme[];
52
+ /**
53
+ * experimentalIdentityAndAuth: Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
54
+ * @internal
55
+ */
56
+ readonly httpAuthSchemeProvider: QBusinessHttpAuthSchemeProvider;
57
+ }
58
+ /**
59
+ * @internal
60
+ */
61
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;
@@ -30,9 +30,9 @@ declare const CreateIndexCommand_base: {
30
30
  * <p>To determine if index creation has completed, check the <code>Status</code> field
31
31
  * returned from a call to <code>DescribeIndex</code>. The <code>Status</code> field is set
32
32
  * to <code>ACTIVE</code> when the index is ready to use.</p>
33
- * <p>Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_BatchPutDocument.html">
33
+ * <p>Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html">
34
34
  * <code>BatchPutDocument</code>
35
- * </a> API or the <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CreateDataSource.html">
35
+ * </a> API or the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html">
36
36
  * <code>CreateDataSource</code>
37
37
  * </a> API.</p>
38
38
  * @example
@@ -40,6 +40,27 @@ declare const CreateRetrieverCommand_base: {
40
40
  * configuration: { // RetrieverConfiguration Union: only one key present
41
41
  * nativeIndexConfiguration: { // NativeIndexConfiguration
42
42
  * indexId: "STRING_VALUE", // required
43
+ * boostingOverride: { // DocumentAttributeBoostingOverrideMap
44
+ * "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
45
+ * numberConfiguration: { // NumberAttributeBoostingConfiguration
46
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
47
+ * boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
48
+ * },
49
+ * stringConfiguration: { // StringAttributeBoostingConfiguration
50
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
51
+ * attributeValueBoosting: { // StringAttributeValueBoosting
52
+ * "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
53
+ * },
54
+ * },
55
+ * dateConfiguration: { // DateAttributeBoostingConfiguration
56
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
57
+ * boostingDurationInSeconds: Number("long"),
58
+ * },
59
+ * stringListConfiguration: { // StringListAttributeBoostingConfiguration
60
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
61
+ * },
62
+ * },
63
+ * },
43
64
  * },
44
65
  * kendraIndexConfiguration: { // KendraIndexConfiguration
45
66
  * indexId: "STRING_VALUE", // required