@aws-sdk/client-qbusiness 3.873.0 → 3.875.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/dist-cjs/index.js CHANGED
@@ -1137,6 +1137,7 @@ var ChatOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
1137
1137
  // src/models/models_1.ts
1138
1138
 
1139
1139
  var OutputFormat = {
1140
+ EXTRACTED: "EXTRACTED",
1140
1141
  RAW: "RAW"
1141
1142
  };
1142
1143
  var GroupStatus = {
@@ -1,6 +1,7 @@
1
1
  import { SENSITIVE_STRING } from "@smithy/smithy-client";
2
2
  import { QBusinessServiceException as __BaseException } from "./QBusinessServiceException";
3
3
  export const OutputFormat = {
4
+ EXTRACTED: "EXTRACTED",
4
5
  RAW: "RAW",
5
6
  };
6
7
  export const GroupStatus = {
@@ -54,6 +54,9 @@ declare const DeleteConversationCommand_base: {
54
54
  * @throws {@link AccessDeniedException} (client fault)
55
55
  * <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
56
56
  *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
59
+ *
57
60
  * @throws {@link InternalServerException} (server fault)
58
61
  * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
59
62
  *
@@ -39,7 +39,7 @@ declare const GetDocumentContentCommand_base: {
39
39
  * indexId: "STRING_VALUE", // required
40
40
  * dataSourceId: "STRING_VALUE",
41
41
  * documentId: "STRING_VALUE", // required
42
- * outputFormat: "RAW",
42
+ * outputFormat: "RAW" || "EXTRACTED",
43
43
  * };
44
44
  * const command = new GetDocumentContentCommand(input);
45
45
  * const response = await client.send(command);
@@ -1788,7 +1788,7 @@ export interface CreateDataSourceRequest {
1788
1788
  */
1789
1789
  syncSchedule?: string | undefined;
1790
1790
  /**
1791
- * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.</p>
1791
+ * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.</p>
1792
1792
  * @public
1793
1793
  */
1794
1794
  roleArn?: string | undefined;
@@ -3666,7 +3666,7 @@ export interface CreateWebExperienceRequest {
3666
3666
  */
3667
3667
  origins?: string[] | undefined;
3668
3668
  /**
3669
- * <p>The Amazon Resource Name (ARN) of the service role attached to your web experience.</p> <note> <p>You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.</p> </note>
3669
+ * <p>The Amazon Resource Name (ARN) of the service role attached to your web experience.</p> <note> <p>The <code>roleArn</code> parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.</p> </note>
3670
3670
  * @public
3671
3671
  */
3672
3672
  roleArn?: string | undefined;
@@ -4658,7 +4658,7 @@ export interface BatchPutDocumentRequest {
4658
4658
  */
4659
4659
  indexId: string | undefined;
4660
4660
  /**
4661
- * <p>One or more documents to add to the index.</p>
4661
+ * <p>One or more documents to add to the index.</p> <important> <p>Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.</p> </important>
4662
4662
  * @public
4663
4663
  */
4664
4664
  documents: Document[] | undefined;
@@ -4689,7 +4689,7 @@ export interface BatchPutDocumentResponse {
4689
4689
  */
4690
4690
  export interface BlockedPhrasesConfiguration {
4691
4691
  /**
4692
- * <p>A list of phrases blocked from a Amazon Q Business web experience chat.</p>
4692
+ * <p>A list of phrases blocked from a Amazon Q Business web experience chat.</p> <note> <p>Each phrase can contain a maximum of 36 characters. The list can contain a maximum of 20 phrases.</p> </note>
4693
4693
  * @public
4694
4694
  */
4695
4695
  blockedPhrases?: string[] | undefined;
@@ -56,6 +56,7 @@ export interface GetChatResponseConfigurationResponse {
56
56
  * @enum
57
57
  */
58
58
  export declare const OutputFormat: {
59
+ readonly EXTRACTED: "EXTRACTED";
59
60
  readonly RAW: "RAW";
60
61
  };
61
62
  /**
@@ -87,7 +88,7 @@ export interface GetDocumentContentRequest {
87
88
  */
88
89
  documentId: string | undefined;
89
90
  /**
90
- * <p>Raw document outputFormat.</p>
91
+ * <p>Document outputFormat. Defaults to RAW if not selected.</p>
91
92
  * @public
92
93
  */
93
94
  outputFormat?: OutputFormat | undefined;
@@ -102,7 +103,7 @@ export interface GetDocumentContentResponse {
102
103
  */
103
104
  presignedUrl: string | undefined;
104
105
  /**
105
- * <p>The MIME type of the document content (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document).</p>
106
+ * <p>The MIME type of the document content. When outputFormat is RAW, this corresponds to the original document's MIME type (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document). When outputFormat is EXTRACTED, the MIME type is always application/json.</p>
106
107
  * @public
107
108
  */
108
109
  mimeType: string | undefined;
@@ -56,6 +56,7 @@ export interface GetChatResponseConfigurationResponse {
56
56
  lastUpdateConfiguration?: ChatResponseConfigurationDetail | undefined;
57
57
  }
58
58
  export declare const OutputFormat: {
59
+ readonly EXTRACTED: "EXTRACTED";
59
60
  readonly RAW: "RAW";
60
61
  };
61
62
  export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-qbusiness",
3
3
  "description": "AWS SDK for JavaScript Qbusiness Client for Node.js, Browser and React Native",
4
- "version": "3.873.0",
4
+ "version": "3.875.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-qbusiness",