Skip to content

Commit 6e64b56

Browse files
author
awstools
committed
docs(client-wisdom): This release added necessary API documents on creating a Wisdom knowledge base to integrate with S3.
1 parent 6869512 commit 6e64b56

File tree

2 files changed

+73
-20
lines changed

2 files changed

+73
-20
lines changed

‎clients/client-wisdom/src/models/models_0.ts

Lines changed: 63 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,23 @@ export interface AppIntegrationsConfiguration {
5252
* </p>
5353
* </li>
5454
* <li>
55-
* <p> For <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index"> SharePoint</a>, your AppIntegrations DataIntegration must have a FileConfiguration,
55+
* <p> For <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index">SharePoint</a>, your AppIntegrations DataIntegration must have a FileConfiguration,
5656
* including only file extensions that are among <code>docx</code>, <code>pdf</code>,
5757
* <code>html</code>, <code>htm</code>, and <code>txt</code>. </p>
5858
* </li>
59+
* <li>
60+
* <p> For <a href="https://aws.amazon.com/s3/">Amazon S3</a>, the
61+
* ObjectConfiguration and FileConfiguration of your AppIntegrations
62+
* DataIntegration must be null. The <code>SourceURI</code> of your
63+
* DataIntegration must use the following format:
64+
* <code>s3://your_s3_bucket_name</code>.</p>
65+
* <important>
66+
* <p>The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services
67+
* principal <code>app-integrations.amazonaws.com</code> to perform
68+
* <code>s3:ListBucket</code>, <code>s3:GetObject</code>, and <code>s3:GetBucketLocation</code>
69+
* against the bucket.</p>
70+
* </important>
71+
* </li>
5972
* </ul>
6073
*/
6174
appIntegrationArn: string | undefined;
@@ -528,13 +541,14 @@ export interface ListAssistantAssociationsResponse {
528541

529542
/**
530543
* @public
531-
* <p>The KMS key used for encryption.</p>
544+
* <p>The configuration information for the customer managed key used for encryption.</p>
532545
*/
533546
export interface ServerSideEncryptionConfiguration {
534547
/**
535548
* @public
536-
* <p>The KMS key. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers
537-
* (KeyId)</a>.</p>
549+
* <p>The customer managed key used for encryption. For more information about setting up a
550+
* customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom for your
551+
* instance</a>. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
538552
*/
539553
kmsKeyId?: string;
540554
}
@@ -591,7 +605,15 @@ export interface CreateAssistantRequest {
591605

592606
/**
593607
* @public
594-
* <p>The KMS key used for encryption.</p>
608+
* <p>The configuration information for the customer managed key used for encryption. </p>
609+
* <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>
610+
* and <code> kms:DescribeKey</code> permissions to the IAM identity using the key
611+
* to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
612+
* <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
613+
* <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
614+
* principal. </p>
615+
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
616+
* for your instance</a>.</p>
595617
*/
596618
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
597619
}
@@ -675,7 +697,15 @@ export interface AssistantData {
675697

676698
/**
677699
* @public
678-
* <p>The KMS key used for encryption.</p>
700+
* <p>The configuration information for the customer managed key used for encryption. </p>
701+
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
702+
* and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
703+
* to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
704+
* <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
705+
* <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
706+
* principal. </p>
707+
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
708+
* for your instance</a>.</p>
679709
*/
680710
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
681711

@@ -1134,7 +1164,15 @@ export interface AssistantSummary {
11341164

11351165
/**
11361166
* @public
1137-
* <p>The KMS key used for encryption.</p>
1167+
* <p>The configuration information for the customer managed key used for encryption. </p>
1168+
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
1169+
* and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
1170+
* to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
1171+
* <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
1172+
* <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
1173+
* principal. </p>
1174+
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
1175+
* for your instance</a>.</p>
11381176
*/
11391177
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
11401178

@@ -2154,7 +2192,12 @@ export interface CreateKnowledgeBaseRequest {
21542192

21552193
/**
21562194
* @public
2157-
* <p>The KMS key used for encryption.</p>
2195+
* <p>The configuration information for the customer managed key used for encryption. </p>
2196+
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
2197+
* and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
2198+
* to invoke Wisdom.</p>
2199+
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
2200+
* for your instance</a>.</p>
21582201
*/
21592202
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
21602203

@@ -2245,7 +2288,12 @@ export interface KnowledgeBaseData {
22452288

22462289
/**
22472290
* @public
2248-
* <p>The KMS key used for encryption.</p>
2291+
* <p>The configuration information for the customer managed key used for encryption. </p>
2292+
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
2293+
* and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
2294+
* to invoke Wisdom. </p>
2295+
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
2296+
* for your instance</a>.</p>
22492297
*/
22502298
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
22512299

@@ -2378,7 +2426,12 @@ export interface KnowledgeBaseSummary {
23782426

23792427
/**
23802428
* @public
2381-
* <p>The KMS key used for encryption.</p>
2429+
* <p>The configuration information for the customer managed key used for encryption. </p>
2430+
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
2431+
* and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
2432+
* to invoke Wisdom. </p>
2433+
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
2434+
* for your instance</a>.</p>
23822435
*/
23832436
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
23842437

0 commit comments

Comments
 (0)