@aws-sdk/client-kendra 3.216.0 → 3.218.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/commands/UpdateQuerySuggestionsConfigCommand.js +2 -2
- package/dist-cjs/commands/UpdateThesaurusCommand.js +2 -2
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_0.js +22 -21
- package/dist-cjs/models/models_1.js +17 -1
- package/dist-cjs/protocols/Aws_json1_1.js +43 -0
- package/dist-es/commands/UpdateQuerySuggestionsConfigCommand.js +1 -1
- package/dist-es/commands/UpdateThesaurusCommand.js +1 -1
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +14 -12
- package/dist-es/models/models_1.js +12 -0
- package/dist-es/protocols/Aws_json1_1.js +43 -0
- package/dist-types/Kendra.d.ts +64 -68
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +2 -2
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/CreateFaqCommand.d.ts +2 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +9 -11
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +5 -5
- package/dist-types/commands/DeleteIndexCommand.d.ts +3 -4
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +3 -3
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +2 -2
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +1 -1
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +2 -2
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +4 -4
- package/dist-types/commands/QueryCommand.d.ts +9 -10
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -4
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +6 -6
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +708 -827
- package/dist-types/models/models_1.d.ts +210 -56
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +22 -37
- package/dist-types/ts3.4/models/models_1.d.ts +39 -2
- package/package.json +3 -3
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { DocumentType as __DocumentType } from "@aws-sdk/types";
|
|
3
3
|
import { KendraServiceException as __BaseException } from "./KendraServiceException";
|
|
4
|
-
import { FacetResult } from "./models_1";
|
|
5
4
|
/**
|
|
6
5
|
* <p>Summary information on an access control configuration that you created for
|
|
7
6
|
* your documents in an index.</p>
|
|
@@ -24,7 +23,8 @@ export interface AccessControlListConfiguration {
|
|
|
24
23
|
KeyPath?: string;
|
|
25
24
|
}
|
|
26
25
|
/**
|
|
27
|
-
* <p
|
|
26
|
+
* <p>You don't have sufficient access to perform this action. Please ensure you have the
|
|
27
|
+
* required permission policies and user accounts and try again.</p>
|
|
28
28
|
*/
|
|
29
29
|
export declare class AccessDeniedException extends __BaseException {
|
|
30
30
|
readonly name: "AccessDeniedException";
|
|
@@ -172,11 +172,11 @@ export interface DataSourceVpcConfiguration {
|
|
|
172
172
|
/**
|
|
173
173
|
* <p>Provides the configuration information to connect to Alfresco as your
|
|
174
174
|
* data source.</p>
|
|
175
|
-
*
|
|
175
|
+
* <note>
|
|
176
176
|
* <p>Alfresco data source connector is currently in preview mode. Basic
|
|
177
177
|
* authentication is currently supported. If you would like to use Alfresco
|
|
178
178
|
* connector in production, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
179
|
-
*
|
|
179
|
+
* </note>
|
|
180
180
|
*/
|
|
181
181
|
export interface AlfrescoConfiguration {
|
|
182
182
|
/**
|
|
@@ -191,12 +191,12 @@ export interface AlfrescoConfiguration {
|
|
|
191
191
|
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
192
192
|
* contains the key-value pairs required to connect to your Alfresco
|
|
193
193
|
* data source. The secret must contain a JSON structure with the following keys:</p>
|
|
194
|
-
*
|
|
194
|
+
* <ul>
|
|
195
195
|
* <li>
|
|
196
|
-
*
|
|
196
|
+
* <p>username—The user name of the Alfresco account.</p>
|
|
197
197
|
* </li>
|
|
198
198
|
* <li>
|
|
199
|
-
*
|
|
199
|
+
* <p>password—The password of the Alfresco account.</p>
|
|
200
200
|
* </li>
|
|
201
201
|
* </ul>
|
|
202
202
|
*/
|
|
@@ -205,7 +205,7 @@ export interface AlfrescoConfiguration {
|
|
|
205
205
|
* <p>The path to the SSL certificate stored in an Amazon S3 bucket. You
|
|
206
206
|
* use this to connect to Alfresco if you require a secure SSL
|
|
207
207
|
* connection.</p>
|
|
208
|
-
*
|
|
208
|
+
* <p>You can simply generate a self-signed X509 certificate on any computer using
|
|
209
209
|
* OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
|
|
210
210
|
* <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign
|
|
211
211
|
* an X509 certificate</a>.</p>
|
|
@@ -338,7 +338,8 @@ export interface AssociateEntitiesToExperienceResponse {
|
|
|
338
338
|
FailedEntityList?: FailedEntity[];
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
|
-
* <p
|
|
341
|
+
* <p>An issue occurred with the internal server used for your Amazon Kendra service.
|
|
342
|
+
* Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
|
|
342
343
|
*/
|
|
343
344
|
export declare class InternalServerException extends __BaseException {
|
|
344
345
|
readonly name: "InternalServerException";
|
|
@@ -350,7 +351,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
350
351
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
351
352
|
}
|
|
352
353
|
/**
|
|
353
|
-
* <p
|
|
354
|
+
* <p>The resource you want to use already exists. Please check you have provided the
|
|
355
|
+
* correct resource and try again.</p>
|
|
354
356
|
*/
|
|
355
357
|
export declare class ResourceAlreadyExistException extends __BaseException {
|
|
356
358
|
readonly name: "ResourceAlreadyExistException";
|
|
@@ -362,7 +364,8 @@ export declare class ResourceAlreadyExistException extends __BaseException {
|
|
|
362
364
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistException, __BaseException>);
|
|
363
365
|
}
|
|
364
366
|
/**
|
|
365
|
-
* <p
|
|
367
|
+
* <p>The resource you want to use doesn’t exist. Please check you have provided the correct
|
|
368
|
+
* resource and try again.</p>
|
|
366
369
|
*/
|
|
367
370
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
368
371
|
readonly name: "ResourceNotFoundException";
|
|
@@ -374,7 +377,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
374
377
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
375
378
|
}
|
|
376
379
|
/**
|
|
377
|
-
* <p
|
|
380
|
+
* <p>The request was denied due to request throttling. Please reduce the number of requests
|
|
381
|
+
* and try again.</p>
|
|
378
382
|
*/
|
|
379
383
|
export declare class ThrottlingException extends __BaseException {
|
|
380
384
|
readonly name: "ThrottlingException";
|
|
@@ -386,7 +390,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
386
390
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
387
391
|
}
|
|
388
392
|
/**
|
|
389
|
-
* <p
|
|
393
|
+
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
394
|
+
* Please provide the correct input and try again.</p>
|
|
390
395
|
*/
|
|
391
396
|
export declare class ValidationException extends __BaseException {
|
|
392
397
|
readonly name: "ValidationException";
|
|
@@ -457,7 +462,7 @@ export interface DocumentAttributeValue {
|
|
|
457
462
|
*/
|
|
458
463
|
StringValue?: string;
|
|
459
464
|
/**
|
|
460
|
-
* <p>A list of strings.
|
|
465
|
+
* <p>A list of strings. The default maximum length or number of strings is 10.</p>
|
|
461
466
|
*/
|
|
462
467
|
StringListValue?: string[];
|
|
463
468
|
/**
|
|
@@ -466,7 +471,7 @@ export interface DocumentAttributeValue {
|
|
|
466
471
|
LongValue?: number;
|
|
467
472
|
/**
|
|
468
473
|
* <p>A date expressed as an ISO 8601 string.</p>
|
|
469
|
-
*
|
|
474
|
+
* <p>It is important for the time zone to be included in the ISO 8601 date-time format. For
|
|
470
475
|
* example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
|
|
471
476
|
* at 12:30PM (plus 10 seconds) in Central European Time.</p>
|
|
472
477
|
*/
|
|
@@ -495,21 +500,21 @@ export interface BasicAuthenticationConfiguration {
|
|
|
495
500
|
/**
|
|
496
501
|
* <p>The name of the website host you want to connect to using
|
|
497
502
|
* authentication credentials.</p>
|
|
498
|
-
*
|
|
503
|
+
* <p>For example, the host name of https://a.example.com/page1.html is
|
|
499
504
|
* "a.example.com".</p>
|
|
500
505
|
*/
|
|
501
506
|
Host: string | undefined;
|
|
502
507
|
/**
|
|
503
508
|
* <p>The port number of the website host you want to connect to using
|
|
504
509
|
* authentication credentials.</p>
|
|
505
|
-
*
|
|
510
|
+
* <p>For example, the port for https://a.example.com/page1.html is 443,
|
|
506
511
|
* the standard port for HTTPS.</p>
|
|
507
512
|
*/
|
|
508
513
|
Port: number | undefined;
|
|
509
514
|
/**
|
|
510
515
|
* <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
|
|
511
516
|
* </p>
|
|
512
|
-
*
|
|
517
|
+
* <p>You use a secret if basic authentication credentials are required to connect
|
|
513
518
|
* to a website. The secret stores your credentials of user name and password.</p>
|
|
514
519
|
*/
|
|
515
520
|
Credentials: string | undefined;
|
|
@@ -522,7 +527,7 @@ export interface AuthenticationConfiguration {
|
|
|
522
527
|
/**
|
|
523
528
|
* <p>The list of configuration information that's required to connect to and
|
|
524
529
|
* crawl a website host using basic authentication credentials.</p>
|
|
525
|
-
*
|
|
530
|
+
* <p>The list includes the name and port number of the website host.</p>
|
|
526
531
|
*/
|
|
527
532
|
BasicAuthentication?: BasicAuthenticationConfiguration[];
|
|
528
533
|
}
|
|
@@ -536,9 +541,9 @@ export interface DataSourceSyncJobMetricTarget {
|
|
|
536
541
|
DataSourceId: string | undefined;
|
|
537
542
|
/**
|
|
538
543
|
* <p>The ID of the sync job that is running on the data source.</p>
|
|
539
|
-
*
|
|
544
|
+
* <p>If the ID of a sync job is not provided and there is a sync job running, then the ID
|
|
540
545
|
* of this sync job is used and metrics are generated for this sync job.</p>
|
|
541
|
-
*
|
|
546
|
+
* <p>If the ID of a sync job is not provided and there is no sync job running, then no
|
|
542
547
|
* metrics are generated and documents are indexed/deleted at the index level without sync
|
|
543
548
|
* job metrics included.</p>
|
|
544
549
|
*/
|
|
@@ -590,7 +595,8 @@ export interface BatchDeleteDocumentResponse {
|
|
|
590
595
|
FailedDocuments?: BatchDeleteDocumentResponseFailedDocument[];
|
|
591
596
|
}
|
|
592
597
|
/**
|
|
593
|
-
* <p
|
|
598
|
+
* <p>A conflict occurred with the request. Please fix any inconsistences with your
|
|
599
|
+
* resources and try again.</p>
|
|
594
600
|
*/
|
|
595
601
|
export declare class ConflictException extends __BaseException {
|
|
596
602
|
readonly name: "ConflictException";
|
|
@@ -607,39 +613,39 @@ export declare class ConflictException extends __BaseException {
|
|
|
607
613
|
*/
|
|
608
614
|
export interface DocumentInfo {
|
|
609
615
|
/**
|
|
610
|
-
* <p>The
|
|
616
|
+
* <p>The identifier of the document.</p>
|
|
611
617
|
*/
|
|
612
618
|
DocumentId: string | undefined;
|
|
613
619
|
/**
|
|
614
620
|
* <p>Attributes that identify a specific version of a document to
|
|
615
621
|
* check.</p>
|
|
616
|
-
*
|
|
617
|
-
*
|
|
622
|
+
* <p>The only valid attributes are:</p>
|
|
623
|
+
* <ul>
|
|
618
624
|
* <li>
|
|
619
|
-
*
|
|
625
|
+
* <p>version</p>
|
|
620
626
|
* </li>
|
|
621
627
|
* <li>
|
|
622
|
-
*
|
|
628
|
+
* <p>datasourceId</p>
|
|
623
629
|
* </li>
|
|
624
630
|
* <li>
|
|
625
|
-
*
|
|
631
|
+
* <p>jobExecutionId</p>
|
|
626
632
|
* </li>
|
|
627
633
|
* </ul>
|
|
628
|
-
*
|
|
629
|
-
*
|
|
634
|
+
* <p>The attributes follow these rules:</p>
|
|
635
|
+
* <ul>
|
|
630
636
|
* <li>
|
|
631
|
-
*
|
|
637
|
+
* <p>
|
|
632
638
|
* <code>dataSourceId</code> and <code>jobExecutionId</code>
|
|
633
639
|
* must be used together.</p>
|
|
634
640
|
* </li>
|
|
635
641
|
* <li>
|
|
636
|
-
*
|
|
642
|
+
* <p>
|
|
637
643
|
* <code>version</code> is ignored if
|
|
638
644
|
* <code>dataSourceId</code> and
|
|
639
645
|
* <code>jobExecutionId</code> are not provided.</p>
|
|
640
646
|
* </li>
|
|
641
647
|
* <li>
|
|
642
|
-
*
|
|
648
|
+
* <p>If <code>dataSourceId</code> and
|
|
643
649
|
* <code>jobExecutionId</code> are provided, but
|
|
644
650
|
* <code>version</code> is not, the version defaults to
|
|
645
651
|
* "0".</p>
|
|
@@ -675,12 +681,12 @@ export declare enum DocumentStatus {
|
|
|
675
681
|
*/
|
|
676
682
|
export interface Status {
|
|
677
683
|
/**
|
|
678
|
-
* <p>The
|
|
684
|
+
* <p>The identifier of the document.</p>
|
|
679
685
|
*/
|
|
680
686
|
DocumentId?: string;
|
|
681
687
|
/**
|
|
682
688
|
* <p>The current status of a document.</p>
|
|
683
|
-
*
|
|
689
|
+
* <p>If the document was submitted for deletion, the status is
|
|
684
690
|
* <code>NOT_FOUND</code> after the document is deleted.</p>
|
|
685
691
|
*/
|
|
686
692
|
DocumentStatus?: DocumentStatus | string;
|
|
@@ -700,7 +706,7 @@ export interface Status {
|
|
|
700
706
|
*/
|
|
701
707
|
export interface BatchGetDocumentStatusResponseError {
|
|
702
708
|
/**
|
|
703
|
-
* <p>The
|
|
709
|
+
* <p>The identifier of the document whose status could not be retrieved.</p>
|
|
704
710
|
*/
|
|
705
711
|
DocumentId?: string;
|
|
706
712
|
/**
|
|
@@ -745,12 +751,12 @@ export declare enum ConditionOperator {
|
|
|
745
751
|
* <p>The condition used for the target document attribute or metadata field when
|
|
746
752
|
* ingesting documents into Amazon Kendra. You use this with <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html">DocumentAttributeTarget
|
|
747
753
|
* to apply the condition</a>.</p>
|
|
748
|
-
*
|
|
754
|
+
* <p>For example, you can create the 'Department' target field and have it prefill
|
|
749
755
|
* department names associated with the documents based on information in the
|
|
750
756
|
* 'Source_URI' field. Set the condition that if the 'Source_URI' field contains
|
|
751
757
|
* 'financial' in its URI value, then prefill the target field 'Department' with
|
|
752
758
|
* the target value 'Finance' for the document.</p>
|
|
753
|
-
*
|
|
759
|
+
* <p>Amazon Kendra cannot create a target field if it has not already been created as an
|
|
754
760
|
* index field. After you create your index field, you can create a document metadata
|
|
755
761
|
* field using <code>DocumentAttributeTarget</code>. Amazon Kendra then will map your newly
|
|
756
762
|
* created metadata field to your index field.</p>
|
|
@@ -758,20 +764,20 @@ export declare enum ConditionOperator {
|
|
|
758
764
|
export interface DocumentAttributeCondition {
|
|
759
765
|
/**
|
|
760
766
|
* <p>The identifier of the document attribute used for the condition.</p>
|
|
761
|
-
*
|
|
767
|
+
* <p>For example, 'Source_URI' could be an identifier for the attribute or metadata
|
|
762
768
|
* field that contains source URIs associated with the documents.</p>
|
|
763
|
-
*
|
|
769
|
+
* <p>Amazon Kendra currently does not support <code>_document_body</code> as an attribute
|
|
764
770
|
* key used for the condition.</p>
|
|
765
771
|
*/
|
|
766
772
|
ConditionDocumentAttributeKey: string | undefined;
|
|
767
773
|
/**
|
|
768
774
|
* <p>The condition operator.</p>
|
|
769
|
-
*
|
|
775
|
+
* <p>For example, you can use 'Contains' to partially match a string.</p>
|
|
770
776
|
*/
|
|
771
777
|
Operator: ConditionOperator | string | undefined;
|
|
772
778
|
/**
|
|
773
779
|
* <p>The value used by the operator.</p>
|
|
774
|
-
*
|
|
780
|
+
* <p>For example, you can specify the value 'financial' for strings in the 'Source_URI'
|
|
775
781
|
* field that partially match or contain this value.</p>
|
|
776
782
|
*/
|
|
777
783
|
ConditionOnValue?: DocumentAttributeValue;
|
|
@@ -779,21 +785,21 @@ export interface DocumentAttributeCondition {
|
|
|
779
785
|
/**
|
|
780
786
|
* <p>The target document attribute or metadata field you want to alter when ingesting
|
|
781
787
|
* documents into Amazon Kendra.</p>
|
|
782
|
-
*
|
|
788
|
+
* <p>For example, you can delete customer identification numbers associated with the
|
|
783
789
|
* documents, stored in the document metadata field called 'Customer_ID'. You set the
|
|
784
790
|
* target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This
|
|
785
791
|
* removes all customer ID values in the field 'Customer_ID'. This would scrub
|
|
786
792
|
* personally identifiable information from each document's metadata.</p>
|
|
787
|
-
*
|
|
793
|
+
* <p>Amazon Kendra cannot create a target field if it has not already been created as an
|
|
788
794
|
* index field. After you create your index field, you can create a document metadata
|
|
789
795
|
* field using <code>DocumentAttributeTarget</code>. Amazon Kendra then will map your newly
|
|
790
796
|
* created metadata field to your index field.</p>
|
|
791
|
-
*
|
|
797
|
+
* <p>You can also use this with <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html">DocumentAttributeCondition</a>.</p>
|
|
792
798
|
*/
|
|
793
799
|
export interface DocumentAttributeTarget {
|
|
794
800
|
/**
|
|
795
801
|
* <p>The identifier of the target document attribute or metadata field.</p>
|
|
796
|
-
*
|
|
802
|
+
* <p>For example, 'Department' could be an identifier for the target attribute or
|
|
797
803
|
* metadata field that includes the department names associated with the documents.</p>
|
|
798
804
|
*/
|
|
799
805
|
TargetDocumentAttributeKey?: string;
|
|
@@ -807,7 +813,7 @@ export interface DocumentAttributeTarget {
|
|
|
807
813
|
TargetDocumentAttributeValueDeletion?: boolean;
|
|
808
814
|
/**
|
|
809
815
|
* <p>The target value you want to create for the target attribute.</p>
|
|
810
|
-
*
|
|
816
|
+
* <p>For example, 'Finance' could be the target value for the target attribute key
|
|
811
817
|
* 'Department'.</p>
|
|
812
818
|
*/
|
|
813
819
|
TargetDocumentAttributeValue?: DocumentAttributeValue;
|
|
@@ -816,7 +822,7 @@ export interface DocumentAttributeTarget {
|
|
|
816
822
|
* <p>Provides the configuration information for applying basic logic to alter document
|
|
817
823
|
* metadata and content when ingesting documents into Amazon Kendra. To apply advanced
|
|
818
824
|
* logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html">HookConfiguration</a>.</p>
|
|
819
|
-
*
|
|
825
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata
|
|
820
826
|
* during the ingestion process</a>.</p>
|
|
821
827
|
*/
|
|
822
828
|
export interface InlineCustomDocumentEnrichmentConfiguration {
|
|
@@ -847,13 +853,13 @@ export interface InlineCustomDocumentEnrichmentConfiguration {
|
|
|
847
853
|
* you must configure your Lambda function using <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.
|
|
848
854
|
* You can only invoke one Lambda function. However, this function can invoke other
|
|
849
855
|
* functions it requires.</p>
|
|
850
|
-
*
|
|
856
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata
|
|
851
857
|
* during the ingestion process</a>.</p>
|
|
852
858
|
*/
|
|
853
859
|
export interface HookConfiguration {
|
|
854
860
|
/**
|
|
855
861
|
* <p>The condition used for when a Lambda function should be invoked.</p>
|
|
856
|
-
*
|
|
862
|
+
* <p>For example, you can specify a condition that if there are empty date-time
|
|
857
863
|
* values, then Amazon Kendra should invoke a function that inserts the current date-time.</p>
|
|
858
864
|
*/
|
|
859
865
|
InvocationCondition?: DocumentAttributeCondition;
|
|
@@ -873,7 +879,7 @@ export interface HookConfiguration {
|
|
|
873
879
|
/**
|
|
874
880
|
* <p>Provides the configuration information for altering document metadata and content
|
|
875
881
|
* during the document ingestion process.</p>
|
|
876
|
-
*
|
|
882
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata
|
|
877
883
|
* during the ingestion process</a>.</p>
|
|
878
884
|
*/
|
|
879
885
|
export interface CustomDocumentEnrichmentConfiguration {
|
|
@@ -962,8 +968,8 @@ export interface HierarchicalPrincipal {
|
|
|
962
968
|
*/
|
|
963
969
|
export interface Document {
|
|
964
970
|
/**
|
|
965
|
-
* <p>A
|
|
966
|
-
*
|
|
971
|
+
* <p>A identifier of the document in the index.</p>
|
|
972
|
+
* <p>Note, each document ID must be unique per index. You cannot create a data source to
|
|
967
973
|
* index your documents with their unique IDs and then use the
|
|
968
974
|
* <code>BatchPutDocument</code> API to index the same documents, or vice versa. You
|
|
969
975
|
* can delete a data source and then use the <code>BatchPutDocument</code> API to index the
|
|
@@ -976,7 +982,7 @@ export interface Document {
|
|
|
976
982
|
Title?: string;
|
|
977
983
|
/**
|
|
978
984
|
* <p>The contents of the document. </p>
|
|
979
|
-
*
|
|
985
|
+
* <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code
|
|
980
986
|
* might not need to encode the document file bytes if you're using an Amazon Web Services
|
|
981
987
|
* SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint
|
|
982
988
|
* directly using REST, you must base64 encode the contents before sending.</p>
|
|
@@ -990,7 +996,7 @@ export interface Document {
|
|
|
990
996
|
* <p>Custom attributes to apply to the document. Use the custom attributes to provide
|
|
991
997
|
* additional information for searching, to provide facets for refining searches, and to
|
|
992
998
|
* provide additional information in the query response.</p>
|
|
993
|
-
*
|
|
999
|
+
* <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that
|
|
994
1000
|
* provide information on the synchronization of documents running on a data source. Note,
|
|
995
1001
|
* 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of
|
|
996
1002
|
* a running sync job.</p>
|
|
@@ -1053,7 +1059,7 @@ export interface BatchPutDocumentRequest {
|
|
|
1053
1059
|
* <p>Configuration information for altering your document metadata and content during
|
|
1054
1060
|
* the document ingestion process when you use the <code>BatchPutDocument</code>
|
|
1055
1061
|
* API.</p>
|
|
1056
|
-
*
|
|
1062
|
+
* <p>For more information on how to create, modify and delete document metadata,
|
|
1057
1063
|
* or make other content alterations when you ingest documents into Amazon Kendra, see
|
|
1058
1064
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
1059
1065
|
* document metadata during the ingestion process</a>.</p>
|
|
@@ -1065,7 +1071,7 @@ export interface BatchPutDocumentRequest {
|
|
|
1065
1071
|
*/
|
|
1066
1072
|
export interface BatchPutDocumentResponseFailedDocument {
|
|
1067
1073
|
/**
|
|
1068
|
-
* <p>The
|
|
1074
|
+
* <p>The identifier of the document.</p>
|
|
1069
1075
|
*/
|
|
1070
1076
|
Id?: string;
|
|
1071
1077
|
/**
|
|
@@ -1091,7 +1097,9 @@ export interface BatchPutDocumentResponse {
|
|
|
1091
1097
|
FailedDocuments?: BatchPutDocumentResponseFailedDocument[];
|
|
1092
1098
|
}
|
|
1093
1099
|
/**
|
|
1094
|
-
* <p
|
|
1100
|
+
* <p>You have exceeded the set limits for your Amazon Kendra service. Please see
|
|
1101
|
+
* Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
|
|
1102
|
+
* an increase of limits.</p>
|
|
1095
1103
|
*/
|
|
1096
1104
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1097
1105
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -1162,29 +1170,28 @@ export interface BoxConfiguration {
|
|
|
1162
1170
|
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
|
|
1163
1171
|
* the key-value pairs required to connect to your Box platform. The secret must
|
|
1164
1172
|
* contain a JSON structure with the following keys:</p>
|
|
1165
|
-
*
|
|
1173
|
+
* <ul>
|
|
1166
1174
|
* <li>
|
|
1167
|
-
*
|
|
1175
|
+
* <p>clientID—The identifier of the client OAuth 2.0 authentication
|
|
1168
1176
|
* application created in Box.</p>
|
|
1169
1177
|
* </li>
|
|
1170
1178
|
* <li>
|
|
1171
|
-
*
|
|
1179
|
+
* <p>clientSecret—A set of characters known only to the OAuth 2.0
|
|
1172
1180
|
* authentication application created in Box.</p>
|
|
1173
1181
|
* </li>
|
|
1174
1182
|
* <li>
|
|
1175
|
-
*
|
|
1183
|
+
* <p>publicKeyId—The identifier of the public key contained within an
|
|
1176
1184
|
* identity certificate.</p>
|
|
1177
1185
|
* </li>
|
|
1178
1186
|
* <li>
|
|
1179
|
-
*
|
|
1187
|
+
* <p>privateKey—A set of characters that make up an encryption key.</p>
|
|
1180
1188
|
* </li>
|
|
1181
1189
|
* <li>
|
|
1182
|
-
*
|
|
1190
|
+
* <p>passphrase—A set of characters that act like a password.</p>
|
|
1183
1191
|
* </li>
|
|
1184
1192
|
* </ul>
|
|
1185
|
-
*
|
|
1186
|
-
* for the secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html
|
|
1187
|
-
* for a Box data source</a>.</p>
|
|
1193
|
+
* <p>You create an application in Box to generate the keys or credentials required
|
|
1194
|
+
* for the secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html">Using a Box data source</a>.</p>
|
|
1188
1195
|
*/
|
|
1189
1196
|
SecretArn: string | undefined;
|
|
1190
1197
|
/**
|
|
@@ -1279,37 +1286,33 @@ export declare enum ConfluenceAttachmentFieldName {
|
|
|
1279
1286
|
VERSION = "VERSION"
|
|
1280
1287
|
}
|
|
1281
1288
|
/**
|
|
1282
|
-
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index
|
|
1283
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1284
|
-
*
|
|
1285
|
-
*
|
|
1286
|
-
* The Confuence data source field names must exist in your Confluence custom metadata.</p>
|
|
1289
|
+
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index
|
|
1290
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before you
|
|
1291
|
+
* map to Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1292
|
+
* Confuence data source field names must exist in your Confluence custom metadata.</p>
|
|
1287
1293
|
*/
|
|
1288
1294
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
1289
1295
|
/**
|
|
1290
1296
|
* <p>The name of the field in the data source. </p>
|
|
1291
|
-
*
|
|
1292
|
-
* <code>UpdateIndex</code> API. </p>
|
|
1297
|
+
* <p>You must first create the index field using the <code>UpdateIndex</code> API. </p>
|
|
1293
1298
|
*/
|
|
1294
1299
|
DataSourceFieldName?: ConfluenceAttachmentFieldName | string;
|
|
1295
1300
|
/**
|
|
1296
|
-
* <p>The format for date fields in the data source. If the field
|
|
1297
|
-
*
|
|
1298
|
-
*
|
|
1299
|
-
* exception is thrown.</p>
|
|
1301
|
+
* <p>The format for date fields in the data source. If the field specified in
|
|
1302
|
+
* <code>DataSourceFieldName</code> is a date field you must specify the date format.
|
|
1303
|
+
* If the field is not a date field, an exception is thrown.</p>
|
|
1300
1304
|
*/
|
|
1301
1305
|
DateFieldFormat?: string;
|
|
1302
1306
|
/**
|
|
1303
|
-
* <p>The name of the index field to map to the Confluence data source
|
|
1304
|
-
* field
|
|
1305
|
-
* type.</p>
|
|
1307
|
+
* <p>The name of the index field to map to the Confluence data source field. The index
|
|
1308
|
+
* field type must match the Confluence field type.</p>
|
|
1306
1309
|
*/
|
|
1307
1310
|
IndexFieldName?: string;
|
|
1308
1311
|
}
|
|
1309
1312
|
/**
|
|
1310
|
-
* <p>Configuration of attachment settings for the Confluence data source.
|
|
1311
|
-
*
|
|
1312
|
-
*
|
|
1313
|
+
* <p>Configuration of attachment settings for the Confluence data source. Attachment
|
|
1314
|
+
* settings are optional, if you don't specify settings attachments, Amazon Kendra
|
|
1315
|
+
* won't index them.</p>
|
|
1313
1316
|
*/
|
|
1314
1317
|
export interface ConfluenceAttachmentConfiguration {
|
|
1315
1318
|
/**
|
|
@@ -1318,13 +1321,12 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
1318
1321
|
*/
|
|
1319
1322
|
CrawlAttachments?: boolean;
|
|
1320
1323
|
/**
|
|
1321
|
-
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index
|
|
1322
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1325
|
-
*
|
|
1326
|
-
*
|
|
1327
|
-
* at least one field mapping.</p>
|
|
1324
|
+
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index
|
|
1325
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before you
|
|
1326
|
+
* map to Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1327
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1328
|
+
* <p>If you specify the <code>AttachentFieldMappings</code> parameter, you must specify at
|
|
1329
|
+
* least one field mapping.</p>
|
|
1328
1330
|
*/
|
|
1329
1331
|
AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[];
|
|
1330
1332
|
}
|
|
@@ -1345,10 +1347,9 @@ export declare enum ConfluenceBlogFieldName {
|
|
|
1345
1347
|
}
|
|
1346
1348
|
/**
|
|
1347
1349
|
* <p>Maps attributes or field names of Confluence blog to Amazon Kendra index field
|
|
1348
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1349
|
-
*
|
|
1350
|
-
*
|
|
1351
|
-
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1350
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
1351
|
+
* Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1352
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1352
1353
|
*/
|
|
1353
1354
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
1354
1355
|
/**
|
|
@@ -1356,34 +1357,31 @@ export interface ConfluenceBlogToIndexFieldMapping {
|
|
|
1356
1357
|
*/
|
|
1357
1358
|
DataSourceFieldName?: ConfluenceBlogFieldName | string;
|
|
1358
1359
|
/**
|
|
1359
|
-
* <p>The format for date fields in the data source. If the field
|
|
1360
|
-
*
|
|
1361
|
-
*
|
|
1362
|
-
* exception is thrown.</p>
|
|
1360
|
+
* <p>The format for date fields in the data source. If the field specified in
|
|
1361
|
+
* <code>DataSourceFieldName</code> is a date field you must specify the date format.
|
|
1362
|
+
* If the field is not a date field, an exception is thrown.</p>
|
|
1363
1363
|
*/
|
|
1364
1364
|
DateFieldFormat?: string;
|
|
1365
1365
|
/**
|
|
1366
|
-
* <p>The name of the index field to map to the Confluence data source
|
|
1367
|
-
* field
|
|
1368
|
-
* type.</p>
|
|
1366
|
+
* <p>The name of the index field to map to the Confluence data source field. The index
|
|
1367
|
+
* field type must match the Confluence field type.</p>
|
|
1369
1368
|
*/
|
|
1370
1369
|
IndexFieldName?: string;
|
|
1371
1370
|
}
|
|
1372
1371
|
/**
|
|
1373
|
-
* <p>Configuration of blog settings for the Confluence data source. Blogs
|
|
1374
|
-
*
|
|
1375
|
-
* <code>
|
|
1376
|
-
*
|
|
1372
|
+
* <p>Configuration of blog settings for the Confluence data source. Blogs are always
|
|
1373
|
+
* indexed unless filtered from the index by the <code>ExclusionPatterns</code> or
|
|
1374
|
+
* <code>InclusionPatterns</code> fields in the <code>ConfluenceConfiguration</code>
|
|
1375
|
+
* object.</p>
|
|
1377
1376
|
*/
|
|
1378
1377
|
export interface ConfluenceBlogConfiguration {
|
|
1379
1378
|
/**
|
|
1380
1379
|
* <p>Maps attributes or field names of Confluence blogs to Amazon Kendra index field
|
|
1381
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1382
|
-
*
|
|
1383
|
-
*
|
|
1384
|
-
*
|
|
1385
|
-
*
|
|
1386
|
-
* must specify at least one field mapping.</p>
|
|
1380
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
1381
|
+
* Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1382
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1383
|
+
* <p>If you specify the <code>BlogFieldMappings</code> parameter, you must specify at least
|
|
1384
|
+
* one field mapping.</p>
|
|
1387
1385
|
*/
|
|
1388
1386
|
BlogFieldMappings?: ConfluenceBlogToIndexFieldMapping[];
|
|
1389
1387
|
}
|
|
@@ -1403,10 +1401,9 @@ export declare enum ConfluencePageFieldName {
|
|
|
1403
1401
|
}
|
|
1404
1402
|
/**
|
|
1405
1403
|
* <p>>Maps attributes or field names of Confluence pages to Amazon Kendra index field
|
|
1406
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1407
|
-
*
|
|
1408
|
-
*
|
|
1409
|
-
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1404
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
1405
|
+
* Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1406
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1410
1407
|
*/
|
|
1411
1408
|
export interface ConfluencePageToIndexFieldMapping {
|
|
1412
1409
|
/**
|
|
@@ -1414,16 +1411,14 @@ export interface ConfluencePageToIndexFieldMapping {
|
|
|
1414
1411
|
*/
|
|
1415
1412
|
DataSourceFieldName?: ConfluencePageFieldName | string;
|
|
1416
1413
|
/**
|
|
1417
|
-
* <p>The format for date fields in the data source. If the field
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
* exception is thrown.</p>
|
|
1414
|
+
* <p>The format for date fields in the data source. If the field specified in
|
|
1415
|
+
* <code>DataSourceFieldName</code> is a date field you must specify the date format.
|
|
1416
|
+
* If the field is not a date field, an exception is thrown.</p>
|
|
1421
1417
|
*/
|
|
1422
1418
|
DateFieldFormat?: string;
|
|
1423
1419
|
/**
|
|
1424
|
-
* <p>The name of the index field to map to the Confluence data source
|
|
1425
|
-
* field
|
|
1426
|
-
* type.</p>
|
|
1420
|
+
* <p>The name of the index field to map to the Confluence data source field. The index
|
|
1421
|
+
* field type must match the Confluence field type.</p>
|
|
1427
1422
|
*/
|
|
1428
1423
|
IndexFieldName?: string;
|
|
1429
1424
|
}
|
|
@@ -1433,12 +1428,11 @@ export interface ConfluencePageToIndexFieldMapping {
|
|
|
1433
1428
|
export interface ConfluencePageConfiguration {
|
|
1434
1429
|
/**
|
|
1435
1430
|
* <p>Maps attributes or field names of Confluence pages to Amazon Kendra index field
|
|
1436
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1437
|
-
*
|
|
1438
|
-
*
|
|
1439
|
-
*
|
|
1440
|
-
*
|
|
1441
|
-
* must specify at least one field mapping.</p>
|
|
1431
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
1432
|
+
* Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1433
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1434
|
+
* <p>If you specify the <code>PageFieldMappings</code> parameter, you must specify at least
|
|
1435
|
+
* one field mapping.</p>
|
|
1442
1436
|
*/
|
|
1443
1437
|
PageFieldMappings?: ConfluencePageToIndexFieldMapping[];
|
|
1444
1438
|
}
|
|
@@ -1450,21 +1444,21 @@ export interface ProxyConfiguration {
|
|
|
1450
1444
|
/**
|
|
1451
1445
|
* <p>The name of the website host you want to connect to
|
|
1452
1446
|
* via a web proxy server.</p>
|
|
1453
|
-
*
|
|
1447
|
+
* <p>For example, the host name of https://a.example.com/page1.html
|
|
1454
1448
|
* is "a.example.com".</p>
|
|
1455
1449
|
*/
|
|
1456
1450
|
Host: string | undefined;
|
|
1457
1451
|
/**
|
|
1458
1452
|
* <p>The port number of the website host you want to connect
|
|
1459
1453
|
* to via a web proxy server. </p>
|
|
1460
|
-
*
|
|
1454
|
+
* <p>For example, the port for https://a.example.com/page1.html
|
|
1461
1455
|
* is 443, the standard port for HTTPS.</p>
|
|
1462
1456
|
*/
|
|
1463
1457
|
Port: number | undefined;
|
|
1464
1458
|
/**
|
|
1465
1459
|
* <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
|
|
1466
1460
|
* </p>
|
|
1467
|
-
*
|
|
1461
|
+
* <p>The credentials are optional. You use a secret if web proxy credentials
|
|
1468
1462
|
* are required to connect to a website host. Amazon Kendra currently support basic
|
|
1469
1463
|
* authentication to connect to a web proxy server. The secret stores your
|
|
1470
1464
|
* credentials.</p>
|
|
@@ -1479,10 +1473,9 @@ export declare enum ConfluenceSpaceFieldName {
|
|
|
1479
1473
|
}
|
|
1480
1474
|
/**
|
|
1481
1475
|
* <p>>Maps attributes or field names of Confluence spaces to Amazon Kendra index field
|
|
1482
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1476
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
1477
|
+
* Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1478
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1486
1479
|
*/
|
|
1487
1480
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
1488
1481
|
/**
|
|
@@ -1490,16 +1483,14 @@ export interface ConfluenceSpaceToIndexFieldMapping {
|
|
|
1490
1483
|
*/
|
|
1491
1484
|
DataSourceFieldName?: ConfluenceSpaceFieldName | string;
|
|
1492
1485
|
/**
|
|
1493
|
-
* <p>The format for date fields in the data source. If the field
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1496
|
-
* exception is thrown.</p>
|
|
1486
|
+
* <p>The format for date fields in the data source. If the field specified in
|
|
1487
|
+
* <code>DataSourceFieldName</code> is a date field you must specify the date format.
|
|
1488
|
+
* If the field is not a date field, an exception is thrown.</p>
|
|
1497
1489
|
*/
|
|
1498
1490
|
DateFieldFormat?: string;
|
|
1499
1491
|
/**
|
|
1500
|
-
* <p>The name of the index field to map to the Confluence data source
|
|
1501
|
-
* field
|
|
1502
|
-
* type.</p>
|
|
1492
|
+
* <p>The name of the index field to map to the Confluence data source field. The index
|
|
1493
|
+
* field type must match the Confluence field type.</p>
|
|
1503
1494
|
*/
|
|
1504
1495
|
IndexFieldName?: string;
|
|
1505
1496
|
}
|
|
@@ -1509,12 +1500,11 @@ export interface ConfluenceSpaceToIndexFieldMapping {
|
|
|
1509
1500
|
export interface ConfluenceSpaceConfiguration {
|
|
1510
1501
|
/**
|
|
1511
1502
|
* <p>
|
|
1512
|
-
* <code>TRUE</code> to index personal spaces. You can
|
|
1513
|
-
*
|
|
1514
|
-
*
|
|
1515
|
-
*
|
|
1516
|
-
*
|
|
1517
|
-
* user context</a>.</p>
|
|
1503
|
+
* <code>TRUE</code> to index personal spaces. You can add restrictions to items in
|
|
1504
|
+
* personal spaces. If personal spaces are indexed, queries without user context
|
|
1505
|
+
* information may return restricted items from a personal space in their results. For more
|
|
1506
|
+
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering on user
|
|
1507
|
+
* context</a>.</p>
|
|
1518
1508
|
*/
|
|
1519
1509
|
CrawlPersonalSpaces?: boolean;
|
|
1520
1510
|
/**
|
|
@@ -1523,30 +1513,28 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
1523
1513
|
*/
|
|
1524
1514
|
CrawlArchivedSpaces?: boolean;
|
|
1525
1515
|
/**
|
|
1526
|
-
* <p>A list of space keys for Confluence spaces. If you include a key,
|
|
1527
|
-
*
|
|
1528
|
-
*
|
|
1529
|
-
*
|
|
1530
|
-
*
|
|
1531
|
-
* and the <code>ExcludeSpaces</code> list, the space is
|
|
1516
|
+
* <p>A list of space keys for Confluence spaces. If you include a key, the blogs,
|
|
1517
|
+
* documents, and attachments in the space are indexed. Spaces that aren't in the list
|
|
1518
|
+
* aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an
|
|
1519
|
+
* error when the data source is synchronized. If a space is in both the
|
|
1520
|
+
* <code>IncludeSpaces</code> and the <code>ExcludeSpaces</code> list, the space is
|
|
1532
1521
|
* excluded.</p>
|
|
1533
1522
|
*/
|
|
1534
1523
|
IncludeSpaces?: string[];
|
|
1535
1524
|
/**
|
|
1536
|
-
* <p>A list of space keys of Confluence spaces. If you include a key,
|
|
1537
|
-
*
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1525
|
+
* <p>A list of space keys of Confluence spaces. If you include a key, the blogs, documents,
|
|
1526
|
+
* and attachments in the space are not indexed. If a space is in both the
|
|
1527
|
+
* <code>ExcludeSpaces</code> and the <code>IncludeSpaces</code> list, the space is
|
|
1528
|
+
* excluded.</p>
|
|
1540
1529
|
*/
|
|
1541
1530
|
ExcludeSpaces?: string[];
|
|
1542
1531
|
/**
|
|
1543
1532
|
* <p>Maps attributes or field names of Confluence spaces to Amazon Kendra index field
|
|
1544
|
-
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1545
|
-
*
|
|
1546
|
-
*
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1549
|
-
* must specify at least one field mapping.</p>
|
|
1533
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
1534
|
+
* Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
1535
|
+
* Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1536
|
+
* <p>If you specify the <code>SpaceFieldMappings</code> parameter, you must specify at
|
|
1537
|
+
* least one field mapping.</p>
|
|
1550
1538
|
*/
|
|
1551
1539
|
SpaceFieldMappings?: ConfluenceSpaceToIndexFieldMapping[];
|
|
1552
1540
|
}
|
|
@@ -1555,27 +1543,23 @@ export declare enum ConfluenceVersion {
|
|
|
1555
1543
|
SERVER = "SERVER"
|
|
1556
1544
|
}
|
|
1557
1545
|
/**
|
|
1558
|
-
* <p>Provides the configuration information to connect to Confluence
|
|
1559
|
-
*
|
|
1546
|
+
* <p>Provides the configuration information to connect to Confluence as your data
|
|
1547
|
+
* source.</p>
|
|
1560
1548
|
*/
|
|
1561
1549
|
export interface ConfluenceConfiguration {
|
|
1562
1550
|
/**
|
|
1563
|
-
* <p>The URL of your Confluence instance. Use the full URL of the
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
* <i>https://192.168.1.113/</i>.</p>
|
|
1551
|
+
* <p>The URL of your Confluence instance. Use the full URL of the server. For example,
|
|
1552
|
+
* <i>https://server.example.com:port/</i>. You can also use an IP
|
|
1553
|
+
* address, for example, <i>https://192.168.1.113/</i>.</p>
|
|
1567
1554
|
*/
|
|
1568
1555
|
ServerUrl: string | undefined;
|
|
1569
1556
|
/**
|
|
1570
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
|
|
1571
|
-
*
|
|
1572
|
-
* Confluence
|
|
1573
|
-
*
|
|
1574
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html">Using a
|
|
1575
|
-
*
|
|
1576
|
-
* <p>You can also provide authentication credentials in the form of a
|
|
1577
|
-
* personal access token. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html#confluence-authentication">Authentication
|
|
1578
|
-
* for a Confluence data source</a>.</p>
|
|
1557
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the
|
|
1558
|
+
* user name and password required to connect to the Confluence instance. If you use
|
|
1559
|
+
* Confluence Cloud, you use a generated API token as the password.</p>
|
|
1560
|
+
* <p>You can also provide authentication credentials in the form of a personal access
|
|
1561
|
+
* token. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html">Using a Confluence data
|
|
1562
|
+
* source</a>.</p>
|
|
1579
1563
|
*/
|
|
1580
1564
|
SecretArn: string | undefined;
|
|
1581
1565
|
/**
|
|
@@ -1595,8 +1579,8 @@ export interface ConfluenceConfiguration {
|
|
|
1595
1579
|
*/
|
|
1596
1580
|
BlogConfiguration?: ConfluenceBlogConfiguration;
|
|
1597
1581
|
/**
|
|
1598
|
-
* <p>Configuration information for indexing attachments to
|
|
1599
|
-
*
|
|
1582
|
+
* <p>Configuration information for indexing attachments to Confluence blogs and
|
|
1583
|
+
* pages.</p>
|
|
1600
1584
|
*/
|
|
1601
1585
|
AttachmentConfiguration?: ConfluenceAttachmentConfiguration;
|
|
1602
1586
|
/**
|
|
@@ -1605,42 +1589,42 @@ export interface ConfluenceConfiguration {
|
|
|
1605
1589
|
*/
|
|
1606
1590
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1607
1591
|
/**
|
|
1608
|
-
* <p>A list of regular expression patterns to include certain blog posts, pages,
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1592
|
+
* <p>A list of regular expression patterns to include certain blog posts, pages, spaces, or
|
|
1593
|
+
* attachments in your Confluence. Content that matches the patterns are included in the
|
|
1594
|
+
* index. Content that doesn't match the patterns is excluded from the index. If content
|
|
1595
|
+
* matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence
|
|
1596
|
+
* and the content isn't included in the index.</p>
|
|
1613
1597
|
*/
|
|
1614
1598
|
InclusionPatterns?: string[];
|
|
1615
1599
|
/**
|
|
1616
|
-
* <p>A list of regular expression patterns to exclude certain blog posts, pages,
|
|
1617
|
-
*
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1620
|
-
*
|
|
1600
|
+
* <p>A list of regular expression patterns to exclude certain blog posts, pages, spaces, or
|
|
1601
|
+
* attachments in your Confluence. Content that matches the patterns are excluded from the
|
|
1602
|
+
* index. Content that doesn't match the patterns is included in the index. If content
|
|
1603
|
+
* matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence
|
|
1604
|
+
* and the content isn't included in the index.</p>
|
|
1621
1605
|
*/
|
|
1622
1606
|
ExclusionPatterns?: string[];
|
|
1623
1607
|
/**
|
|
1624
1608
|
* <p>Configuration information to connect to your Confluence URL instance via a web proxy.
|
|
1625
1609
|
* You can use this option for Confluence Server.</p>
|
|
1626
|
-
*
|
|
1627
|
-
*
|
|
1628
|
-
* is 443, the standard port for HTTPS.</p>
|
|
1629
|
-
*
|
|
1630
|
-
* server that requires basic authentication of user name and password. To store web
|
|
1631
|
-
*
|
|
1632
|
-
*
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1635
|
-
*
|
|
1636
|
-
*
|
|
1637
|
-
*
|
|
1610
|
+
* <p>You must provide the website host name and port number. For example, the host name of
|
|
1611
|
+
* <i>https://a.example.com/page1.html</i> is "a.example.com" and the
|
|
1612
|
+
* port is 443, the standard port for HTTPS.</p>
|
|
1613
|
+
* <p>Web proxy credentials are optional and you can use them to connect to a web proxy
|
|
1614
|
+
* server that requires basic authentication of user name and password. To store web proxy
|
|
1615
|
+
* credentials, you use a secret in Secrets Manager.</p>
|
|
1616
|
+
* <p>It is recommended that you follow best security practices when configuring your web
|
|
1617
|
+
* proxy. This includes setting up throttling, setting up logging and monitoring, and
|
|
1618
|
+
* applying security patches on a regular basis. If you use your web proxy with multiple
|
|
1619
|
+
* data sources, sync jobs that occur at the same time could strain the load on your proxy.
|
|
1620
|
+
* It is recommended you prepare your proxy beforehand for any security and load
|
|
1621
|
+
* requirements.</p>
|
|
1638
1622
|
*/
|
|
1639
1623
|
ProxyConfiguration?: ProxyConfiguration;
|
|
1640
1624
|
/**
|
|
1641
|
-
* <p>Whether you want to connect to Confluence using basic authentication of
|
|
1642
|
-
*
|
|
1643
|
-
*
|
|
1625
|
+
* <p>Whether you want to connect to Confluence using basic authentication of user name and
|
|
1626
|
+
* password, or a personal access token. You can use a personal access token for Confluence
|
|
1627
|
+
* Server.</p>
|
|
1644
1628
|
*/
|
|
1645
1629
|
AuthenticationType?: ConfluenceAuthenticationType | string;
|
|
1646
1630
|
}
|
|
@@ -1650,7 +1634,7 @@ export interface ConfluenceConfiguration {
|
|
|
1650
1634
|
*/
|
|
1651
1635
|
export interface ColumnConfiguration {
|
|
1652
1636
|
/**
|
|
1653
|
-
* <p>The column that provides the document's
|
|
1637
|
+
* <p>The column that provides the document's identifier.</p>
|
|
1654
1638
|
*/
|
|
1655
1639
|
DocumentIdColumnName: string | undefined;
|
|
1656
1640
|
/**
|
|
@@ -1722,13 +1706,13 @@ export interface SqlConfiguration {
|
|
|
1722
1706
|
/**
|
|
1723
1707
|
* <p>Determines whether Amazon Kendra encloses SQL identifiers for tables and column
|
|
1724
1708
|
* names in double quotes (") when making a database query.</p>
|
|
1725
|
-
*
|
|
1709
|
+
* <p>By default, Amazon Kendra passes SQL identifiers the way that they are entered
|
|
1726
1710
|
* into the data source configuration. It does not change the case of identifiers or
|
|
1727
1711
|
* enclose them in quotes.</p>
|
|
1728
|
-
*
|
|
1712
|
+
* <p>PostgreSQL internally converts uppercase characters to lower case characters in
|
|
1729
1713
|
* identifiers unless they are quoted. Choosing this option encloses identifiers in quotes
|
|
1730
1714
|
* so that PostgreSQL does not convert the character's case.</p>
|
|
1731
|
-
*
|
|
1715
|
+
* <p>For MySQL databases, you must enable the <code>ansi_quotes</code> option when you set
|
|
1732
1716
|
* this field to <code>DOUBLE_QUOTES</code>.</p>
|
|
1733
1717
|
*/
|
|
1734
1718
|
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption | string;
|
|
@@ -1775,7 +1759,7 @@ export declare enum FsxFileSystemType {
|
|
|
1775
1759
|
export interface FsxConfiguration {
|
|
1776
1760
|
/**
|
|
1777
1761
|
* <p>The identifier of the Amazon FSx file system.</p>
|
|
1778
|
-
*
|
|
1762
|
+
* <p>You can find your file system ID on the file system dashboard in
|
|
1779
1763
|
* the Amazon FSx console. For information on how to create a
|
|
1780
1764
|
* file system in Amazon FSx console, using Windows File Server
|
|
1781
1765
|
* as an example, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html">Amazon FSx
|
|
@@ -1798,16 +1782,16 @@ export interface FsxConfiguration {
|
|
|
1798
1782
|
* contains the key-value pairs required to connect to your Amazon FSx
|
|
1799
1783
|
* file system. Windows is currently the only supported type. The secret must
|
|
1800
1784
|
* contain a JSON structure with the following keys:</p>
|
|
1801
|
-
*
|
|
1785
|
+
* <ul>
|
|
1802
1786
|
* <li>
|
|
1803
|
-
*
|
|
1787
|
+
* <p>username—The Active Directory user name, along with the
|
|
1804
1788
|
* Domain Name System (DNS) domain name. For example,
|
|
1805
1789
|
* <i>user@corp.example.com</i>. The Active Directory
|
|
1806
1790
|
* user account must have read and mounting access to the
|
|
1807
1791
|
* Amazon FSx file system for Windows.</p>
|
|
1808
1792
|
* </li>
|
|
1809
1793
|
* <li>
|
|
1810
|
-
*
|
|
1794
|
+
* <p>password—The password of the Active Directory user account with
|
|
1811
1795
|
* read and mounting access to the Amazon FSx Windows file system.</p>
|
|
1812
1796
|
* </li>
|
|
1813
1797
|
* </ul>
|
|
@@ -1843,8 +1827,8 @@ export interface FsxConfiguration {
|
|
|
1843
1827
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1844
1828
|
}
|
|
1845
1829
|
/**
|
|
1846
|
-
* <p>Provides the configuration information to include certain types of GitHub content. You
|
|
1847
|
-
* configure to index repository files only, or also include issues and pull requests,
|
|
1830
|
+
* <p>Provides the configuration information to include certain types of GitHub content. You
|
|
1831
|
+
* can configure to index repository files only, or also include issues and pull requests,
|
|
1848
1832
|
* comments, and comment attachments.</p>
|
|
1849
1833
|
*/
|
|
1850
1834
|
export interface GitHubDocumentCrawlProperties {
|
|
@@ -1885,45 +1869,46 @@ export interface GitHubDocumentCrawlProperties {
|
|
|
1885
1869
|
CrawlPullRequestCommentAttachment?: boolean;
|
|
1886
1870
|
}
|
|
1887
1871
|
/**
|
|
1888
|
-
* <p>Provides the configuration information to connect to GitHub Enterprise Server (on
|
|
1872
|
+
* <p>Provides the configuration information to connect to GitHub Enterprise Server (on
|
|
1873
|
+
* premises).</p>
|
|
1889
1874
|
*/
|
|
1890
1875
|
export interface OnPremiseConfiguration {
|
|
1891
1876
|
/**
|
|
1892
1877
|
* <p>The GitHub host URL or API endpoint URL. For example,
|
|
1893
|
-
*
|
|
1878
|
+
* <i>https://on-prem-host-url/api/v3/</i>
|
|
1894
1879
|
* </p>
|
|
1895
1880
|
*/
|
|
1896
1881
|
HostUrl: string | undefined;
|
|
1897
1882
|
/**
|
|
1898
|
-
* <p>The name of the organization of the GitHub Enterprise Server (in-premise) account you
|
|
1899
|
-
* to connect to. You can find your organization name by logging into GitHub desktop
|
|
1900
|
-
* selecting <b>Your organizations</b> under your profile
|
|
1883
|
+
* <p>The name of the organization of the GitHub Enterprise Server (in-premise) account you
|
|
1884
|
+
* want to connect to. You can find your organization name by logging into GitHub desktop
|
|
1885
|
+
* and selecting <b>Your organizations</b> under your profile
|
|
1886
|
+
* picture dropdown.</p>
|
|
1901
1887
|
*/
|
|
1902
1888
|
OrganizationName: string | undefined;
|
|
1903
1889
|
/**
|
|
1904
|
-
* <p>The path to the SSL certificate stored in an Amazon S3 bucket. You
|
|
1905
|
-
*
|
|
1906
|
-
*
|
|
1907
|
-
*
|
|
1908
|
-
* OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
|
|
1909
|
-
* <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign
|
|
1910
|
-
* an X509 certificate</a>.</p>
|
|
1890
|
+
* <p>The path to the SSL certificate stored in an Amazon S3 bucket. You use this to
|
|
1891
|
+
* connect to GitHub if you require a secure SSL connection.</p>
|
|
1892
|
+
* <p>You can simply generate a self-signed X509 certificate on any computer using OpenSSL.
|
|
1893
|
+
* For an example of using OpenSSL to create an X509 certificate, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign an X509 certificate</a>.</p>
|
|
1911
1894
|
*/
|
|
1912
1895
|
SslCertificateS3Path: S3Path | undefined;
|
|
1913
1896
|
}
|
|
1914
1897
|
/**
|
|
1915
|
-
* <p>Provides the configuration information to connect to GitHub Enterprise Cloud
|
|
1898
|
+
* <p>Provides the configuration information to connect to GitHub Enterprise Cloud
|
|
1899
|
+
* (SaaS).</p>
|
|
1916
1900
|
*/
|
|
1917
1901
|
export interface SaaSConfiguration {
|
|
1918
1902
|
/**
|
|
1919
|
-
* <p>The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want
|
|
1920
|
-
*
|
|
1921
|
-
* selecting <b>Your organizations</b> under your profile picture
|
|
1903
|
+
* <p>The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to
|
|
1904
|
+
* connect to. You can find your organization name by logging into GitHub desktop and
|
|
1905
|
+
* selecting <b>Your organizations</b> under your profile picture
|
|
1906
|
+
* dropdown.</p>
|
|
1922
1907
|
*/
|
|
1923
1908
|
OrganizationName: string | undefined;
|
|
1924
1909
|
/**
|
|
1925
1910
|
* <p>The GitHub host URL or API endpoint URL. For example,
|
|
1926
|
-
*
|
|
1911
|
+
* <i>https://api.github.com</i>.</p>
|
|
1927
1912
|
*/
|
|
1928
1913
|
HostUrl: string | undefined;
|
|
1929
1914
|
}
|
|
@@ -1932,8 +1917,8 @@ export declare enum Type {
|
|
|
1932
1917
|
SAAS = "SAAS"
|
|
1933
1918
|
}
|
|
1934
1919
|
/**
|
|
1935
|
-
* <p>Provides the configuration information to connect to GitHub
|
|
1936
|
-
*
|
|
1920
|
+
* <p>Provides the configuration information to connect to GitHub as your data
|
|
1921
|
+
* source.</p>
|
|
1937
1922
|
*/
|
|
1938
1923
|
export interface GitHubConfiguration {
|
|
1939
1924
|
/**
|
|
@@ -1945,19 +1930,19 @@ export interface GitHubConfiguration {
|
|
|
1945
1930
|
*/
|
|
1946
1931
|
OnPremiseConfiguration?: OnPremiseConfiguration;
|
|
1947
1932
|
/**
|
|
1948
|
-
* <p>The type of GitHub service you want to connect to—GitHub Enterprise
|
|
1949
|
-
*
|
|
1933
|
+
* <p>The type of GitHub service you want to connect to—GitHub Enterprise Cloud
|
|
1934
|
+
* (SaaS) or GitHub Enterprise Server (on premises).</p>
|
|
1950
1935
|
*/
|
|
1951
1936
|
Type?: Type | string;
|
|
1952
1937
|
/**
|
|
1953
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1956
|
-
*
|
|
1938
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the
|
|
1939
|
+
* key-value pairs required to connect to your GitHub. The secret must contain a JSON
|
|
1940
|
+
* structure with the following keys:</p>
|
|
1941
|
+
* <ul>
|
|
1957
1942
|
* <li>
|
|
1958
|
-
*
|
|
1959
|
-
* on creating a token in GitHub, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html
|
|
1960
|
-
*
|
|
1943
|
+
* <p>personalToken—The access token created in GitHub. For more information
|
|
1944
|
+
* on creating a token in GitHub, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html">Using a GitHub data
|
|
1945
|
+
* source</a>.</p>
|
|
1961
1946
|
* </li>
|
|
1962
1947
|
* </ul>
|
|
1963
1948
|
*/
|
|
@@ -1965,8 +1950,8 @@ export interface GitHubConfiguration {
|
|
|
1965
1950
|
/**
|
|
1966
1951
|
* <p>
|
|
1967
1952
|
* <code>TRUE</code> to use the GitHub change log to determine which documents require
|
|
1968
|
-
* updating in the index. Depending on the GitHub change log's size, it may take longer
|
|
1969
|
-
*
|
|
1953
|
+
* updating in the index. Depending on the GitHub change log's size, it may take longer for
|
|
1954
|
+
* Amazon Kendra to use the change log than to scan all of your documents in
|
|
1970
1955
|
* GitHub.</p>
|
|
1971
1956
|
*/
|
|
1972
1957
|
UseChangeLog?: boolean;
|
|
@@ -1981,120 +1966,120 @@ export interface GitHubConfiguration {
|
|
|
1981
1966
|
*/
|
|
1982
1967
|
RepositoryFilter?: string[];
|
|
1983
1968
|
/**
|
|
1984
|
-
* <p>A list of regular expression patterns to include certain folder names in your
|
|
1985
|
-
*
|
|
1986
|
-
*
|
|
1987
|
-
*
|
|
1988
|
-
*
|
|
1969
|
+
* <p>A list of regular expression patterns to include certain folder names in your GitHub
|
|
1970
|
+
* repository or repositories. Folder names that match the patterns are included in the
|
|
1971
|
+
* index. Folder names that don't match the patterns are excluded from the index. If a
|
|
1972
|
+
* folder matches both an inclusion and exclusion pattern, the exclusion pattern takes
|
|
1973
|
+
* precedence and the folder isn't included in the index.</p>
|
|
1989
1974
|
*/
|
|
1990
1975
|
InclusionFolderNamePatterns?: string[];
|
|
1991
1976
|
/**
|
|
1992
|
-
* <p>A list of regular expression patterns to include certain file types in your
|
|
1993
|
-
*
|
|
1994
|
-
*
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
1977
|
+
* <p>A list of regular expression patterns to include certain file types in your GitHub
|
|
1978
|
+
* repository or repositories. File types that match the patterns are included in the
|
|
1979
|
+
* index. File types that don't match the patterns are excluded from the index. If a file
|
|
1980
|
+
* matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence
|
|
1981
|
+
* and the file isn't included in the index.</p>
|
|
1997
1982
|
*/
|
|
1998
1983
|
InclusionFileTypePatterns?: string[];
|
|
1999
1984
|
/**
|
|
2000
|
-
* <p>A list of regular expression patterns to include certain file names in your
|
|
2001
|
-
*
|
|
2002
|
-
*
|
|
2003
|
-
*
|
|
2004
|
-
*
|
|
1985
|
+
* <p>A list of regular expression patterns to include certain file names in your GitHub
|
|
1986
|
+
* repository or repositories. File names that match the patterns are included in the
|
|
1987
|
+
* index. File names that don't match the patterns are excluded from the index. If a file
|
|
1988
|
+
* matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence
|
|
1989
|
+
* and the file isn't included in the index.</p>
|
|
2005
1990
|
*/
|
|
2006
1991
|
InclusionFileNamePatterns?: string[];
|
|
2007
1992
|
/**
|
|
2008
|
-
* <p>A list of regular expression patterns to exclude certain folder names in your
|
|
2009
|
-
*
|
|
2010
|
-
*
|
|
2011
|
-
*
|
|
2012
|
-
*
|
|
1993
|
+
* <p>A list of regular expression patterns to exclude certain folder names in your GitHub
|
|
1994
|
+
* repository or repositories. Folder names that match the patterns are excluded from the
|
|
1995
|
+
* index. Folder names that don't match the patterns are included in the index. If a folder
|
|
1996
|
+
* matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence
|
|
1997
|
+
* and the folder isn't included in the index.</p>
|
|
2013
1998
|
*/
|
|
2014
1999
|
ExclusionFolderNamePatterns?: string[];
|
|
2015
2000
|
/**
|
|
2016
|
-
* <p>A list of regular expression patterns to exclude certain file types in your
|
|
2017
|
-
*
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
2020
|
-
*
|
|
2001
|
+
* <p>A list of regular expression patterns to exclude certain file types in your GitHub
|
|
2002
|
+
* repository or repositories. File types that match the patterns are excluded from the
|
|
2003
|
+
* index. File types that don't match the patterns are included in the index. If a file
|
|
2004
|
+
* matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence
|
|
2005
|
+
* and the file isn't included in the index.</p>
|
|
2021
2006
|
*/
|
|
2022
2007
|
ExclusionFileTypePatterns?: string[];
|
|
2023
2008
|
/**
|
|
2024
|
-
* <p>A list of regular expression patterns to exclude certain file names in your
|
|
2025
|
-
*
|
|
2026
|
-
*
|
|
2027
|
-
*
|
|
2028
|
-
*
|
|
2009
|
+
* <p>A list of regular expression patterns to exclude certain file names in your GitHub
|
|
2010
|
+
* repository or repositories. File names that match the patterns are excluded from the
|
|
2011
|
+
* index. File names that don't match the patterns are included in the index. If a file
|
|
2012
|
+
* matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence
|
|
2013
|
+
* and the file isn't included in the index.</p>
|
|
2029
2014
|
*/
|
|
2030
2015
|
ExclusionFileNamePatterns?: string[];
|
|
2031
2016
|
/**
|
|
2032
|
-
* <p>Configuration information of an Amazon Virtual Private Cloud to connect to your
|
|
2033
|
-
*
|
|
2017
|
+
* <p>Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For
|
|
2018
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
2034
2019
|
*/
|
|
2035
2020
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2036
2021
|
/**
|
|
2037
2022
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map GitHub
|
|
2038
|
-
* repository attributes or field names to Amazon Kendra index field names.
|
|
2039
|
-
*
|
|
2040
|
-
*
|
|
2041
|
-
*
|
|
2023
|
+
* repository attributes or field names to Amazon Kendra index field names. To create
|
|
2024
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For
|
|
2025
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2026
|
+
* GitHub data source field names must exist in your GitHub custom metadata.</p>
|
|
2042
2027
|
*/
|
|
2043
2028
|
GitHubRepositoryConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2044
2029
|
/**
|
|
2045
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2046
|
-
*
|
|
2047
|
-
*
|
|
2048
|
-
*
|
|
2049
|
-
*
|
|
2030
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2031
|
+
* field names of GitHub commits to Amazon Kendra index field names. To create custom
|
|
2032
|
+
* fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more
|
|
2033
|
+
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The GitHub data source field names must exist
|
|
2034
|
+
* in your GitHub custom metadata.</p>
|
|
2050
2035
|
*/
|
|
2051
2036
|
GitHubCommitConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2052
2037
|
/**
|
|
2053
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2057
|
-
*
|
|
2038
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2039
|
+
* field names of GitHub issues to Amazon Kendra index field names. To create custom
|
|
2040
|
+
* fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more
|
|
2041
|
+
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The GitHub data source field names must exist
|
|
2042
|
+
* in your GitHub custom metadata.</p>
|
|
2058
2043
|
*/
|
|
2059
2044
|
GitHubIssueDocumentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2060
2045
|
/**
|
|
2061
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2062
|
-
*
|
|
2063
|
-
*
|
|
2064
|
-
*
|
|
2065
|
-
*
|
|
2046
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2047
|
+
* field names of GitHub issue comments to Amazon Kendra index field names. To create
|
|
2048
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For
|
|
2049
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2050
|
+
* GitHub data source field names must exist in your GitHub custom metadata.</p>
|
|
2066
2051
|
*/
|
|
2067
2052
|
GitHubIssueCommentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2068
2053
|
/**
|
|
2069
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2070
|
-
*
|
|
2071
|
-
*
|
|
2072
|
-
*
|
|
2073
|
-
*
|
|
2054
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2055
|
+
* field names of GitHub issue attachments to Amazon Kendra index field names. To
|
|
2056
|
+
* create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub
|
|
2057
|
+
* fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2058
|
+
* GitHub data source field names must exist in your GitHub custom metadata.</p>
|
|
2074
2059
|
*/
|
|
2075
2060
|
GitHubIssueAttachmentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2076
2061
|
/**
|
|
2077
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2078
|
-
*
|
|
2079
|
-
*
|
|
2080
|
-
*
|
|
2081
|
-
*
|
|
2062
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2063
|
+
* field names of GitHub pull request comments to Amazon Kendra index field names. To
|
|
2064
|
+
* create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub
|
|
2065
|
+
* fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2066
|
+
* GitHub data source field names must exist in your GitHub custom metadata.</p>
|
|
2082
2067
|
*/
|
|
2083
2068
|
GitHubPullRequestCommentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2084
2069
|
/**
|
|
2085
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2086
|
-
*
|
|
2087
|
-
*
|
|
2088
|
-
*
|
|
2089
|
-
*
|
|
2070
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2071
|
+
* field names of GitHub pull requests to Amazon Kendra index field names. To create
|
|
2072
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For
|
|
2073
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2074
|
+
* GitHub data source field names must exist in your GitHub custom metadata.</p>
|
|
2090
2075
|
*/
|
|
2091
2076
|
GitHubPullRequestDocumentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2092
2077
|
/**
|
|
2093
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
|
|
2094
|
-
*
|
|
2095
|
-
* To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
2096
|
-
*
|
|
2097
|
-
*
|
|
2078
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2079
|
+
* field names of GitHub pull request attachments to Amazon Kendra index field names.
|
|
2080
|
+
* To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub
|
|
2081
|
+
* fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2082
|
+
* GitHub data source field names must exist in your GitHub custom metadata.</p>
|
|
2098
2083
|
*/
|
|
2099
2084
|
GitHubPullRequestDocumentAttachmentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2100
2085
|
}
|
|
@@ -2139,7 +2124,7 @@ export interface GoogleDriveConfiguration {
|
|
|
2139
2124
|
/**
|
|
2140
2125
|
* <p>A list of MIME types to exclude from the index. All documents
|
|
2141
2126
|
* matching the specified MIME type are excluded. </p>
|
|
2142
|
-
*
|
|
2127
|
+
* <p>For a list of MIME types, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html">Using a Google Workspace Drive data
|
|
2143
2128
|
* source</a>.</p>
|
|
2144
2129
|
*/
|
|
2145
2130
|
ExcludeMimeTypes?: string[];
|
|
@@ -2162,8 +2147,7 @@ export declare enum IssueSubEntity {
|
|
|
2162
2147
|
WORKLOGS = "WORKLOGS"
|
|
2163
2148
|
}
|
|
2164
2149
|
/**
|
|
2165
|
-
* <p>Provides the configuration information to connect to Jira as your
|
|
2166
|
-
* data source.</p>
|
|
2150
|
+
* <p>Provides the configuration information to connect to Jira as your data source.</p>
|
|
2167
2151
|
*/
|
|
2168
2152
|
export interface JiraConfiguration {
|
|
2169
2153
|
/**
|
|
@@ -2176,97 +2160,87 @@ export interface JiraConfiguration {
|
|
|
2176
2160
|
* <p>The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the
|
|
2177
2161
|
* key-value pairs required to connect to your Jira data source. The secret must contain a
|
|
2178
2162
|
* JSON structure with the following keys:</p>
|
|
2179
|
-
*
|
|
2163
|
+
* <ul>
|
|
2180
2164
|
* <li>
|
|
2181
|
-
*
|
|
2165
|
+
* <p>jiraId—The Jira username.</p>
|
|
2182
2166
|
* </li>
|
|
2183
2167
|
* <li>
|
|
2184
|
-
*
|
|
2185
|
-
* API token in Jira, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html
|
|
2168
|
+
* <p>jiraCredentials—The Jira API token. For more information on creating an
|
|
2169
|
+
* API token in Jira, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html"> Using a Jira data
|
|
2170
|
+
* source</a>.</p>
|
|
2186
2171
|
* </li>
|
|
2187
2172
|
* </ul>
|
|
2188
2173
|
*/
|
|
2189
2174
|
SecretArn: string | undefined;
|
|
2190
2175
|
/**
|
|
2191
2176
|
* <p>
|
|
2192
|
-
* <code>TRUE</code> to use the Jira change log to determine which documents require
|
|
2177
|
+
* <code>TRUE</code> to use the Jira change log to determine which documents require
|
|
2178
|
+
* updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra
|
|
2179
|
+
* to use the change log than to scan all of your documents in Jira.</p>
|
|
2193
2180
|
*/
|
|
2194
2181
|
UseChangeLog?: boolean;
|
|
2195
2182
|
/**
|
|
2196
|
-
* <p>Specify which projects to crawl in your Jira data source. You can specify
|
|
2197
|
-
*
|
|
2183
|
+
* <p>Specify which projects to crawl in your Jira data source. You can specify one or more
|
|
2184
|
+
* Jira project IDs.</p>
|
|
2198
2185
|
*/
|
|
2199
2186
|
Project?: string[];
|
|
2200
2187
|
/**
|
|
2201
|
-
* <p>Specify which issue types to crawl in your Jira data source.
|
|
2202
|
-
*
|
|
2188
|
+
* <p>Specify which issue types to crawl in your Jira data source. You can specify one or
|
|
2189
|
+
* more of these options to crawl.</p>
|
|
2203
2190
|
*/
|
|
2204
2191
|
IssueType?: string[];
|
|
2205
2192
|
/**
|
|
2206
|
-
* <p>Specify which statuses to crawl in your Jira data source.
|
|
2207
|
-
*
|
|
2193
|
+
* <p>Specify which statuses to crawl in your Jira data source. You can specify one or more
|
|
2194
|
+
* of these options to crawl.</p>
|
|
2208
2195
|
*/
|
|
2209
2196
|
Status?: string[];
|
|
2210
2197
|
/**
|
|
2211
|
-
* <p>Specify whether to crawl comments,
|
|
2212
|
-
*
|
|
2213
|
-
* and work logs. You can specify one or more of these options.</p>
|
|
2198
|
+
* <p>Specify whether to crawl comments, attachments, and work logs. You can specify one or
|
|
2199
|
+
* more of these options.</p>
|
|
2214
2200
|
*/
|
|
2215
2201
|
IssueSubEntityFilter?: (IssueSubEntity | string)[];
|
|
2216
2202
|
/**
|
|
2217
|
-
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2218
|
-
*
|
|
2219
|
-
*
|
|
2220
|
-
*
|
|
2221
|
-
*
|
|
2222
|
-
* Mapping data source fields</a>. The Jira data source field names
|
|
2223
|
-
* must exist in your Jira custom metadata.</p>
|
|
2203
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes or field names of
|
|
2204
|
+
* Jira attachments to Amazon Kendra index field names. To create custom fields, use the
|
|
2205
|
+
* UpdateIndex API before you map to Jira fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html"> Mapping data source
|
|
2206
|
+
* fields</a>. The Jira data source field names must exist in your Jira custom
|
|
2207
|
+
* metadata.</p>
|
|
2224
2208
|
*/
|
|
2225
2209
|
AttachmentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2226
2210
|
/**
|
|
2227
|
-
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2228
|
-
*
|
|
2229
|
-
*
|
|
2230
|
-
*
|
|
2231
|
-
*
|
|
2232
|
-
* Mapping data source fields</a>. The Jira data source field names
|
|
2233
|
-
* must exist in your Jira custom metadata.</p>
|
|
2211
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes or field names of
|
|
2212
|
+
* Jira comments to Amazon Kendra index field names. To create custom fields, use the
|
|
2213
|
+
* UpdateIndex API before you map to Jira fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html"> Mapping data source
|
|
2214
|
+
* fields</a>. The Jira data source field names must exist in your Jira custom
|
|
2215
|
+
* metadata.</p>
|
|
2234
2216
|
*/
|
|
2235
2217
|
CommentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2236
2218
|
/**
|
|
2237
|
-
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2238
|
-
*
|
|
2239
|
-
*
|
|
2240
|
-
*
|
|
2241
|
-
*
|
|
2242
|
-
* Mapping data source fields</a>. The Jira data source field names
|
|
2243
|
-
* must exist in your Jira custom metadata.</p>
|
|
2219
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes or field names of
|
|
2220
|
+
* Jira issues to Amazon Kendra index field names. To create custom fields, use the
|
|
2221
|
+
* UpdateIndex API before you map to Jira fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html"> Mapping data source
|
|
2222
|
+
* fields</a>. The Jira data source field names must exist in your Jira custom
|
|
2223
|
+
* metadata.</p>
|
|
2244
2224
|
*/
|
|
2245
2225
|
IssueFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2246
2226
|
/**
|
|
2247
|
-
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2248
|
-
*
|
|
2249
|
-
*
|
|
2250
|
-
*
|
|
2251
|
-
*
|
|
2252
|
-
* Mapping data source fields</a>. The Jira data source field names
|
|
2253
|
-
* must exist in your Jira custom metadata.</p>
|
|
2227
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes or field names of
|
|
2228
|
+
* Jira projects to Amazon Kendra index field names. To create custom fields, use the
|
|
2229
|
+
* UpdateIndex API before you map to Jira fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html"> Mapping data source
|
|
2230
|
+
* fields</a>. The Jira data source field names must exist in your Jira custom
|
|
2231
|
+
* metadata.</p>
|
|
2254
2232
|
*/
|
|
2255
2233
|
ProjectFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2256
2234
|
/**
|
|
2257
|
-
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2258
|
-
*
|
|
2259
|
-
*
|
|
2260
|
-
*
|
|
2261
|
-
*
|
|
2262
|
-
* Mapping data source fields</a>. The Jira data source field names
|
|
2263
|
-
* must exist in your Jira custom metadata.</p>
|
|
2235
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes or field names of
|
|
2236
|
+
* Jira work logs to Amazon Kendra index field names. To create custom fields, use the
|
|
2237
|
+
* UpdateIndex API before you map to Jira fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html"> Mapping data source
|
|
2238
|
+
* fields</a>. The Jira data source field names must exist in your Jira custom
|
|
2239
|
+
* metadata.</p>
|
|
2264
2240
|
*/
|
|
2265
2241
|
WorkLogFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2266
2242
|
/**
|
|
2267
|
-
* <p>A list of regular expression patterns to include certain file paths,
|
|
2268
|
-
* file
|
|
2269
|
-
* names, and
|
|
2243
|
+
* <p>A list of regular expression patterns to include certain file paths, file names, and
|
|
2270
2244
|
* file types in your Jira data source. Files that match the patterns are included in the
|
|
2271
2245
|
* index. Files that don't match the patterns are excluded from the index. If a file
|
|
2272
2246
|
* matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes
|
|
@@ -2274,19 +2248,16 @@ export interface JiraConfiguration {
|
|
|
2274
2248
|
*/
|
|
2275
2249
|
InclusionPatterns?: string[];
|
|
2276
2250
|
/**
|
|
2277
|
-
* <p>A list of regular expression patterns to exclude certain file paths,
|
|
2278
|
-
* file
|
|
2279
|
-
*
|
|
2280
|
-
*
|
|
2281
|
-
*
|
|
2282
|
-
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
2283
|
-
* and the file isn't included in the index.</p>
|
|
2251
|
+
* <p>A list of regular expression patterns to exclude certain file paths, file names, and
|
|
2252
|
+
* file types in your Jira data source. Files that match the patterns are excluded from the
|
|
2253
|
+
* index. Files that don’t match the patterns are included in the index. If a file matches
|
|
2254
|
+
* both an inclusion pattern and an exclusion pattern, the exclusion pattern takes
|
|
2255
|
+
* precedence and the file isn't included in the index.</p>
|
|
2284
2256
|
*/
|
|
2285
2257
|
ExclusionPatterns?: string[];
|
|
2286
2258
|
/**
|
|
2287
|
-
* <p>Configuration information for an
|
|
2288
|
-
*
|
|
2289
|
-
* account must reside inside your VPC.</p>
|
|
2259
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your
|
|
2260
|
+
* Jira account must reside inside your VPC.</p>
|
|
2290
2261
|
*/
|
|
2291
2262
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2292
2263
|
}
|
|
@@ -2333,7 +2304,7 @@ export interface OneDriveConfiguration {
|
|
|
2333
2304
|
* the patterns are excluded from the index. If a document matches both an inclusion and
|
|
2334
2305
|
* exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2335
2306
|
* included in the index.</p>
|
|
2336
|
-
*
|
|
2307
|
+
* <p>The pattern is applied to the file name.</p>
|
|
2337
2308
|
*/
|
|
2338
2309
|
InclusionPatterns?: string[];
|
|
2339
2310
|
/**
|
|
@@ -2342,7 +2313,7 @@ export interface OneDriveConfiguration {
|
|
|
2342
2313
|
* match the patterns are included in the index. If a document matches both an inclusion
|
|
2343
2314
|
* and exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2344
2315
|
* included in the index.</p>
|
|
2345
|
-
*
|
|
2316
|
+
* <p>The pattern is applied to the file name.</p>
|
|
2346
2317
|
*/
|
|
2347
2318
|
ExclusionPatterns?: string[];
|
|
2348
2319
|
/**
|
|
@@ -2364,19 +2335,19 @@ export interface OneDriveConfiguration {
|
|
|
2364
2335
|
*/
|
|
2365
2336
|
export interface QuipConfiguration {
|
|
2366
2337
|
/**
|
|
2367
|
-
* <p>The Quip site domain. For example,
|
|
2368
|
-
*
|
|
2338
|
+
* <p>The Quip site domain. For example,
|
|
2339
|
+
* <i>https://quip-company.quipdomain.com/browse</i>. The domain in this
|
|
2340
|
+
* example is "quipdomain".</p>
|
|
2369
2341
|
*/
|
|
2370
2342
|
Domain: string | undefined;
|
|
2371
2343
|
/**
|
|
2372
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
|
|
2373
|
-
*
|
|
2374
|
-
*
|
|
2375
|
-
*
|
|
2344
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the
|
|
2345
|
+
* key-value pairs that are required to connect to your Quip. The secret must contain a
|
|
2346
|
+
* JSON structure with the following keys:</p>
|
|
2347
|
+
* <ul>
|
|
2376
2348
|
* <li>
|
|
2377
|
-
*
|
|
2378
|
-
*
|
|
2379
|
-
* for a Quip data source</a>.</p>
|
|
2349
|
+
* <p>accessToken—The token created in Quip. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html">Using a
|
|
2350
|
+
* Quip data source</a>.</p>
|
|
2380
2351
|
* </li>
|
|
2381
2352
|
* </ul>
|
|
2382
2353
|
*/
|
|
@@ -2397,64 +2368,55 @@ export interface QuipConfiguration {
|
|
|
2397
2368
|
*/
|
|
2398
2369
|
CrawlAttachments?: boolean;
|
|
2399
2370
|
/**
|
|
2400
|
-
* <p>The identifiers of the Quip folders you want to index. You
|
|
2401
|
-
*
|
|
2402
|
-
*
|
|
2403
|
-
* <i>https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name</i>.
|
|
2371
|
+
* <p>The identifiers of the Quip folders you want to index. You can find the folder ID in
|
|
2372
|
+
* your browser URL when you access your folder in Quip. For example,
|
|
2373
|
+
* <i>https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name</i>.
|
|
2404
2374
|
* The folder ID in this example is "zlLuOVNSarTL".</p>
|
|
2405
2375
|
*/
|
|
2406
2376
|
FolderIds?: string[];
|
|
2407
2377
|
/**
|
|
2408
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2409
|
-
*
|
|
2410
|
-
*
|
|
2411
|
-
*
|
|
2412
|
-
*
|
|
2413
|
-
* data source fields</a>. The Quip field names must exist in your
|
|
2414
|
-
* Quip custom metadata.</p>
|
|
2378
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2379
|
+
* field names of Quip threads to Amazon Kendra index field names. To create custom
|
|
2380
|
+
* fields, use the <code>UpdateIndex</code> API before you map to Quip fields. For more
|
|
2381
|
+
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The Quip field names must exist in your Quip
|
|
2382
|
+
* custom metadata.</p>
|
|
2415
2383
|
*/
|
|
2416
2384
|
ThreadFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2417
2385
|
/**
|
|
2418
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2419
|
-
*
|
|
2420
|
-
*
|
|
2421
|
-
*
|
|
2422
|
-
*
|
|
2423
|
-
* data source fields</a>. The Quip field names must exist in your
|
|
2424
|
-
* Quip custom metadata.</p>
|
|
2386
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2387
|
+
* field names of Quip messages to Amazon Kendra index field names. To create custom
|
|
2388
|
+
* fields, use the <code>UpdateIndex</code> API before you map to Quip fields. For more
|
|
2389
|
+
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The Quip field names must exist in your Quip
|
|
2390
|
+
* custom metadata.</p>
|
|
2425
2391
|
*/
|
|
2426
2392
|
MessageFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2427
2393
|
/**
|
|
2428
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2429
|
-
*
|
|
2430
|
-
*
|
|
2431
|
-
*
|
|
2432
|
-
*
|
|
2433
|
-
* data source fields</a>. The Quip field names must exist in your
|
|
2434
|
-
* Quip custom metadata.</p>
|
|
2394
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
2395
|
+
* field names of Quip attachments to Amazon Kendra index field names. To create
|
|
2396
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to Quip fields. For
|
|
2397
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
|
|
2398
|
+
* Quip field names must exist in your Quip custom metadata.</p>
|
|
2435
2399
|
*/
|
|
2436
2400
|
AttachmentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2437
2401
|
/**
|
|
2438
2402
|
* <p>A list of regular expression patterns to include certain files in your Quip file
|
|
2439
2403
|
* system. Files that match the patterns are included in the index. Files that don't match
|
|
2440
2404
|
* the patterns are excluded from the index. If a file matches both an inclusion pattern
|
|
2441
|
-
* and an exclusion pattern, the exclusion pattern takes
|
|
2442
|
-
*
|
|
2405
|
+
* and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't
|
|
2406
|
+
* included in the index.</p>
|
|
2443
2407
|
*/
|
|
2444
2408
|
InclusionPatterns?: string[];
|
|
2445
2409
|
/**
|
|
2446
2410
|
* <p>A list of regular expression patterns to exclude certain files in your Quip file
|
|
2447
2411
|
* system. Files that match the patterns are excluded from the index. Files that don’t
|
|
2448
2412
|
* match the patterns are included in the index. If a file matches both an inclusion
|
|
2449
|
-
* pattern and an exclusion pattern, the exclusion pattern takes
|
|
2450
|
-
*
|
|
2413
|
+
* pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file
|
|
2414
|
+
* isn't included in the index.</p>
|
|
2451
2415
|
*/
|
|
2452
2416
|
ExclusionPatterns?: string[];
|
|
2453
2417
|
/**
|
|
2454
|
-
* <p>Configuration information for an Amazon Virtual Private Cloud
|
|
2455
|
-
*
|
|
2456
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring
|
|
2457
|
-
* a VPC</a>.</p>
|
|
2418
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip.
|
|
2419
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
2458
2420
|
*/
|
|
2459
2421
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2460
2422
|
}
|
|
@@ -2488,21 +2450,21 @@ export interface S3DataSourceConfiguration {
|
|
|
2488
2450
|
* <p>A list of glob patterns for documents that should be indexed. If a document that
|
|
2489
2451
|
* matches an inclusion pattern also matches an exclusion pattern, the document is not
|
|
2490
2452
|
* indexed.</p>
|
|
2491
|
-
*
|
|
2453
|
+
* <p>Some <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">examples</a>
|
|
2492
2454
|
* are:</p>
|
|
2493
|
-
*
|
|
2455
|
+
* <ul>
|
|
2494
2456
|
* <li>
|
|
2495
|
-
*
|
|
2457
|
+
* <p>
|
|
2496
2458
|
* <i>*.txt</i> will include all text files in a directory (files
|
|
2497
2459
|
* with the extension .txt).</p>
|
|
2498
2460
|
* </li>
|
|
2499
2461
|
* <li>
|
|
2500
|
-
*
|
|
2462
|
+
* <p>
|
|
2501
2463
|
* <i>**\/*.txt</i> will include all text files in a directory and
|
|
2502
2464
|
* its subdirectories.</p>
|
|
2503
2465
|
* </li>
|
|
2504
2466
|
* <li>
|
|
2505
|
-
*
|
|
2467
|
+
* <p>
|
|
2506
2468
|
* <i>*tax*</i> will include all files in a directory that contain
|
|
2507
2469
|
* 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.</p>
|
|
2508
2470
|
* </li>
|
|
@@ -2513,22 +2475,22 @@ export interface S3DataSourceConfiguration {
|
|
|
2513
2475
|
* <p>A list of glob patterns for documents that should not be indexed. If a document that
|
|
2514
2476
|
* matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the
|
|
2515
2477
|
* document is not indexed.</p>
|
|
2516
|
-
*
|
|
2478
|
+
* <p>Some <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">examples</a>
|
|
2517
2479
|
* are:</p>
|
|
2518
|
-
*
|
|
2480
|
+
* <ul>
|
|
2519
2481
|
* <li>
|
|
2520
|
-
*
|
|
2482
|
+
* <p>
|
|
2521
2483
|
* <i>*.png , *.jpg</i> will exclude all PNG and JPEG image files
|
|
2522
2484
|
* in a directory (files with the extensions .png and .jpg).</p>
|
|
2523
2485
|
* </li>
|
|
2524
2486
|
* <li>
|
|
2525
|
-
*
|
|
2487
|
+
* <p>
|
|
2526
2488
|
* <i>*internal*</i> will exclude all files in a directory that
|
|
2527
2489
|
* contain 'internal' in the file name, such as 'internal', 'internal_only',
|
|
2528
2490
|
* 'company_internal'.</p>
|
|
2529
2491
|
* </li>
|
|
2530
2492
|
* <li>
|
|
2531
|
-
*
|
|
2493
|
+
* <p>
|
|
2532
2494
|
* <i>**\/*internal*</i> will exclude all internal-related files in
|
|
2533
2495
|
* a directory and its subdirectories.</p>
|
|
2534
2496
|
* </li>
|
|
@@ -2725,29 +2687,29 @@ export interface SalesforceConfiguration {
|
|
|
2725
2687
|
* <p>The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the
|
|
2726
2688
|
* key/value pairs required to connect to your Salesforce instance. The secret must contain
|
|
2727
2689
|
* a JSON structure with the following keys:</p>
|
|
2728
|
-
*
|
|
2690
|
+
* <ul>
|
|
2729
2691
|
* <li>
|
|
2730
|
-
*
|
|
2692
|
+
* <p>authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get
|
|
2731
2693
|
* an OAUTH token. </p>
|
|
2732
2694
|
* </li>
|
|
2733
2695
|
* <li>
|
|
2734
|
-
*
|
|
2696
|
+
* <p>consumerKey - The application public key generated when you created your
|
|
2735
2697
|
* Salesforce application.</p>
|
|
2736
2698
|
* </li>
|
|
2737
2699
|
* <li>
|
|
2738
|
-
*
|
|
2700
|
+
* <p>consumerSecret - The application private key generated when you created your
|
|
2739
2701
|
* Salesforce application.</p>
|
|
2740
2702
|
* </li>
|
|
2741
2703
|
* <li>
|
|
2742
|
-
*
|
|
2704
|
+
* <p>password - The password associated with the user logging in to the Salesforce
|
|
2743
2705
|
* instance.</p>
|
|
2744
2706
|
* </li>
|
|
2745
2707
|
* <li>
|
|
2746
|
-
*
|
|
2708
|
+
* <p>securityToken - The token associated with the user account logging in to the
|
|
2747
2709
|
* Salesforce instance.</p>
|
|
2748
2710
|
* </li>
|
|
2749
2711
|
* <li>
|
|
2750
|
-
*
|
|
2712
|
+
* <p>username - The user name of the user logging in to the Salesforce
|
|
2751
2713
|
* instance.</p>
|
|
2752
2714
|
* </li>
|
|
2753
2715
|
* </ul>
|
|
@@ -2785,7 +2747,7 @@ export interface SalesforceConfiguration {
|
|
|
2785
2747
|
* the patterns are excluded from the index. If a document matches both an inclusion and
|
|
2786
2748
|
* exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2787
2749
|
* included in the index.</p>
|
|
2788
|
-
*
|
|
2750
|
+
* <p>The pattern is applied to the name of the attached file.</p>
|
|
2789
2751
|
*/
|
|
2790
2752
|
IncludeAttachmentFilePatterns?: string[];
|
|
2791
2753
|
/**
|
|
@@ -2794,7 +2756,7 @@ export interface SalesforceConfiguration {
|
|
|
2794
2756
|
* match the patterns are included in the index. If a document matches both an inclusion
|
|
2795
2757
|
* and exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
2796
2758
|
* included in the index.</p>
|
|
2797
|
-
*
|
|
2759
|
+
* <p>The pattern is applied to the name of the attached file.</p>
|
|
2798
2760
|
*/
|
|
2799
2761
|
ExcludeAttachmentFilePatterns?: string[];
|
|
2800
2762
|
}
|
|
@@ -2818,7 +2780,7 @@ export interface ServiceNowKnowledgeArticleConfiguration {
|
|
|
2818
2780
|
* Items that don't match the patterns are excluded from the index. If an item matches both
|
|
2819
2781
|
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
|
|
2820
2782
|
* isn't included in the index.</p>
|
|
2821
|
-
*
|
|
2783
|
+
* <p>The regex is applied to the field specified in the
|
|
2822
2784
|
* <code>PatternTargetField</code>.</p>
|
|
2823
2785
|
*/
|
|
2824
2786
|
IncludeAttachmentFilePatterns?: string[];
|
|
@@ -2828,7 +2790,7 @@ export interface ServiceNowKnowledgeArticleConfiguration {
|
|
|
2828
2790
|
* Items that don't match the patterns are included in the index. If an item matches both
|
|
2829
2791
|
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
|
|
2830
2792
|
* isn't included in the index.</p>
|
|
2831
|
-
*
|
|
2793
|
+
* <p>The regex is applied to the field specified in the
|
|
2832
2794
|
* <code>PatternTargetField</code>.</p>
|
|
2833
2795
|
*/
|
|
2834
2796
|
ExcludeAttachmentFilePatterns?: string[];
|
|
@@ -2852,7 +2814,7 @@ export interface ServiceNowKnowledgeArticleConfiguration {
|
|
|
2852
2814
|
/**
|
|
2853
2815
|
* <p>A query that selects the knowledge articles to index. The query can return articles
|
|
2854
2816
|
* from multiple knowledge bases, and the knowledge bases can be public or private.</p>
|
|
2855
|
-
*
|
|
2817
|
+
* <p>The query string must be one generated by the ServiceNow console. For more
|
|
2856
2818
|
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html">Specifying documents to index with a
|
|
2857
2819
|
* query</a>. </p>
|
|
2858
2820
|
*/
|
|
@@ -2874,7 +2836,7 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
2874
2836
|
* don't match the patterns are excluded from the index. If an item matches both an
|
|
2875
2837
|
* inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
|
|
2876
2838
|
* isn't included in the index.</p>
|
|
2877
|
-
*
|
|
2839
|
+
* <p>The regex is applied to the file name of the attachment.</p>
|
|
2878
2840
|
*/
|
|
2879
2841
|
IncludeAttachmentFilePatterns?: string[];
|
|
2880
2842
|
/**
|
|
@@ -2883,7 +2845,7 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
2883
2845
|
* don't match the patterns are included in the index. If an item matches both an inclusion
|
|
2884
2846
|
* and exclusion pattern, the exclusion pattern takes precedence and the item isn't
|
|
2885
2847
|
* included in the index.</p>
|
|
2886
|
-
*
|
|
2848
|
+
* <p>The regex is applied to the file name of the attachment.</p>
|
|
2887
2849
|
*/
|
|
2888
2850
|
ExcludeAttachmentFilePatterns?: string[];
|
|
2889
2851
|
/**
|
|
@@ -2923,7 +2885,8 @@ export interface ServiceNowConfiguration {
|
|
|
2923
2885
|
* <p>The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the
|
|
2924
2886
|
* user name and password required to connect to the ServiceNow instance. You can also
|
|
2925
2887
|
* provide OAuth authentication credentials of user name, password, client ID, and client
|
|
2926
|
-
* secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
|
|
2888
|
+
* secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a ServiceNow data
|
|
2889
|
+
* source</a>.</p>
|
|
2927
2890
|
*/
|
|
2928
2891
|
SecretArn: string | undefined;
|
|
2929
2892
|
/**
|
|
@@ -2946,7 +2909,7 @@ export interface ServiceNowConfiguration {
|
|
|
2946
2909
|
* password provided in the Secrets Manager secret in the <code>SecretArn</code>
|
|
2947
2910
|
* field. If you choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the
|
|
2948
2911
|
* credentials of client ID, client secret, user name and password.</p>
|
|
2949
|
-
*
|
|
2912
|
+
* <p>When you use <code>OAUTH2</code> authentication, you must generate a token and a
|
|
2950
2913
|
* client secret using the ServiceNow console. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a
|
|
2951
2914
|
* ServiceNow data source</a>.</p>
|
|
2952
2915
|
*/
|
|
@@ -2981,8 +2944,9 @@ export interface SharePointConfiguration {
|
|
|
2981
2944
|
* SharePoint Server, you also need to provide the sever domain name as part of the
|
|
2982
2945
|
* credentials. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html">Using a Microsoft SharePoint Data
|
|
2983
2946
|
* Source</a>.</p>
|
|
2984
|
-
*
|
|
2985
|
-
* ID, and client secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
|
|
2947
|
+
* <p>You can also provide OAuth authentication credentials of user name, password, client
|
|
2948
|
+
* ID, and client secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html">Using a SharePoint data
|
|
2949
|
+
* source</a>.</p>
|
|
2986
2950
|
*/
|
|
2987
2951
|
SecretArn: string | undefined;
|
|
2988
2952
|
/**
|
|
@@ -3004,7 +2968,7 @@ export interface SharePointConfiguration {
|
|
|
3004
2968
|
* the patterns are excluded from the index. If a document matches both an inclusion and
|
|
3005
2969
|
* exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
3006
2970
|
* included in the index.</p>
|
|
3007
|
-
*
|
|
2971
|
+
* <p>The regex applies to the display URL of the SharePoint document.</p>
|
|
3008
2972
|
*/
|
|
3009
2973
|
InclusionPatterns?: string[];
|
|
3010
2974
|
/**
|
|
@@ -3013,7 +2977,7 @@ export interface SharePointConfiguration {
|
|
|
3013
2977
|
* match the patterns are included in the index. If a document matches both an inclusion
|
|
3014
2978
|
* and exclusion pattern, the exclusion pattern takes precedence and the document isn't
|
|
3015
2979
|
* included in the index.</p>
|
|
3016
|
-
*
|
|
2980
|
+
* <p>The regex applies to the display URL of the SharePoint document.</p>
|
|
3017
2981
|
*/
|
|
3018
2982
|
ExclusionPatterns?: string[];
|
|
3019
2983
|
/**
|
|
@@ -3042,7 +3006,7 @@ export interface SharePointConfiguration {
|
|
|
3042
3006
|
/**
|
|
3043
3007
|
* <p>The path to the SSL certificate stored in an Amazon S3 bucket. You use this to
|
|
3044
3008
|
* connect to SharePoint Server if you require a secure SSL connection.</p>
|
|
3045
|
-
*
|
|
3009
|
+
* <p>You can simply generate a self-signed X509 certificate on any computer using OpenSSL.
|
|
3046
3010
|
* For an example of using OpenSSL to create an X509 certificate, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign an X509 certificate</a>.</p>
|
|
3047
3011
|
*/
|
|
3048
3012
|
SslCertificateS3Path?: S3Path;
|
|
@@ -3055,13 +3019,13 @@ export interface SharePointConfiguration {
|
|
|
3055
3019
|
/**
|
|
3056
3020
|
* <p>Configuration information to connect to your Microsoft SharePoint site URLs via
|
|
3057
3021
|
* instance via a web proxy. You can use this option for SharePoint Server.</p>
|
|
3058
|
-
*
|
|
3022
|
+
* <p>You must provide the website host name and port number. For example, the host name of
|
|
3059
3023
|
* <i>https://a.example.com/page1.html</i> is "a.example.com" and the
|
|
3060
3024
|
* port is 443, the standard port for HTTPS.</p>
|
|
3061
|
-
*
|
|
3025
|
+
* <p>Web proxy credentials are optional and you can use them to connect to a web proxy
|
|
3062
3026
|
* server that requires basic authentication of user name and password. To store web proxy
|
|
3063
3027
|
* credentials, you use a secret in Secrets Manager.</p>
|
|
3064
|
-
*
|
|
3028
|
+
* <p>It is recommended that you follow best security practices when configuring your web
|
|
3065
3029
|
* proxy. This includes setting up throttling, setting up logging and monitoring, and
|
|
3066
3030
|
* applying security patches on a regular basis. If you use your web proxy with multiple
|
|
3067
3031
|
* data sources, sync jobs that occur at the same time could strain the load on your proxy.
|
|
@@ -3084,7 +3048,7 @@ export interface SlackConfiguration {
|
|
|
3084
3048
|
/**
|
|
3085
3049
|
* <p>The identifier of the team in the Slack workspace. For example,
|
|
3086
3050
|
* <i>T0123456789</i>.</p>
|
|
3087
|
-
*
|
|
3051
|
+
* <p>You can find your team ID in the URL of the main page of your Slack workspace.
|
|
3088
3052
|
* When you log in to Slack via a browser, you are directed to the URL of the main
|
|
3089
3053
|
* page. For example, <i>https://app.slack.com/client/<b>T0123456789</b>/...</i>.</p>
|
|
3090
3054
|
*/
|
|
@@ -3093,9 +3057,9 @@ export interface SlackConfiguration {
|
|
|
3093
3057
|
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
|
|
3094
3058
|
* the key-value pairs required to connect to your Slack workspace team. The secret
|
|
3095
3059
|
* must contain a JSON structure with the following keys:</p>
|
|
3096
|
-
*
|
|
3060
|
+
* <ul>
|
|
3097
3061
|
* <li>
|
|
3098
|
-
*
|
|
3062
|
+
* <p>slackToken—The user or bot token created in Slack. For more
|
|
3099
3063
|
* information on creating a token in Slack, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication">Authentication
|
|
3100
3064
|
* for a Slack data source</a>.</p>
|
|
3101
3065
|
* </li>
|
|
@@ -3139,7 +3103,7 @@ export interface SlackConfiguration {
|
|
|
3139
3103
|
/**
|
|
3140
3104
|
* <p>The number of hours for change log to look back from when you last synchronized
|
|
3141
3105
|
* your data. You can look back up to 7 days or 168 hours.</p>
|
|
3142
|
-
*
|
|
3106
|
+
* <p>Change log updates your index only if new content was added since you
|
|
3143
3107
|
* last synced your data. Updated or deleted content from before you last synced
|
|
3144
3108
|
* does not get updated in your index. To capture updated or deleted content before you
|
|
3145
3109
|
* last synced, set the <code>LookBackPeriod</code> to the number of hours you want
|
|
@@ -3201,7 +3165,7 @@ export declare enum WebCrawlerMode {
|
|
|
3201
3165
|
}
|
|
3202
3166
|
/**
|
|
3203
3167
|
* <p>Provides the configuration information for the seed or starting point URLs to crawl.</p>
|
|
3204
|
-
*
|
|
3168
|
+
* <p>
|
|
3205
3169
|
* <i>When selecting websites to index, you must adhere to
|
|
3206
3170
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
3207
3171
|
* and all other Amazon terms. Remember that you must only use Amazon Kendra Web
|
|
@@ -3213,37 +3177,37 @@ export interface SeedUrlConfiguration {
|
|
|
3213
3177
|
/**
|
|
3214
3178
|
* <p>The list of seed or starting point URLs of the
|
|
3215
3179
|
* websites you want to crawl.</p>
|
|
3216
|
-
*
|
|
3180
|
+
* <p>The list can include a maximum of 100 seed URLs.</p>
|
|
3217
3181
|
*/
|
|
3218
3182
|
SeedUrls: string[] | undefined;
|
|
3219
3183
|
/**
|
|
3220
3184
|
* <p>You can choose one of the following modes:</p>
|
|
3221
|
-
*
|
|
3185
|
+
* <ul>
|
|
3222
3186
|
* <li>
|
|
3223
|
-
*
|
|
3187
|
+
* <p>
|
|
3224
3188
|
* <code>HOST_ONLY</code> – crawl only the website host names.
|
|
3225
3189
|
* For example, if the seed URL is "abc.example.com",
|
|
3226
3190
|
* then only URLs with host name "abc.example.com" are crawled.</p>
|
|
3227
3191
|
* </li>
|
|
3228
3192
|
* <li>
|
|
3229
|
-
*
|
|
3193
|
+
* <p>
|
|
3230
3194
|
* <code>SUBDOMAINS</code> – crawl the website host names with
|
|
3231
3195
|
* subdomains. For example, if the seed URL is "abc.example.com", then
|
|
3232
3196
|
* "a.abc.example.com" and "b.abc.example.com" are also crawled.</p>
|
|
3233
3197
|
* </li>
|
|
3234
3198
|
* <li>
|
|
3235
|
-
*
|
|
3199
|
+
* <p>
|
|
3236
3200
|
* <code>EVERYTHING</code> – crawl the website host names with
|
|
3237
3201
|
* subdomains and other domains that the webpages link to.</p>
|
|
3238
3202
|
* </li>
|
|
3239
3203
|
* </ul>
|
|
3240
|
-
*
|
|
3204
|
+
* <p>The default mode is set to <code>HOST_ONLY</code>.</p>
|
|
3241
3205
|
*/
|
|
3242
3206
|
WebCrawlerMode?: WebCrawlerMode | string;
|
|
3243
3207
|
}
|
|
3244
3208
|
/**
|
|
3245
3209
|
* <p>Provides the configuration information for the sitemap URLs to crawl.</p>
|
|
3246
|
-
*
|
|
3210
|
+
* <p>
|
|
3247
3211
|
* <i>When selecting websites to index, you must adhere to
|
|
3248
3212
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
3249
3213
|
* and all other Amazon terms. Remember that you must only use Amazon Kendra Web
|
|
@@ -3255,16 +3219,16 @@ export interface SiteMapsConfiguration {
|
|
|
3255
3219
|
/**
|
|
3256
3220
|
* <p>The list of sitemap URLs of the websites
|
|
3257
3221
|
* you want to crawl.</p>
|
|
3258
|
-
*
|
|
3222
|
+
* <p>The list can include a maximum of three sitemap URLs.</p>
|
|
3259
3223
|
*/
|
|
3260
3224
|
SiteMaps: string[] | undefined;
|
|
3261
3225
|
}
|
|
3262
3226
|
/**
|
|
3263
3227
|
* <p>Provides the configuration information of the URLs to crawl.</p>
|
|
3264
|
-
*
|
|
3228
|
+
* <p>You can only crawl websites that use the secure communication protocol,
|
|
3265
3229
|
* Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when
|
|
3266
3230
|
* crawling a website, it could be that the website is blocked from crawling.</p>
|
|
3267
|
-
*
|
|
3231
|
+
* <p>
|
|
3268
3232
|
* <i>When selecting websites to index, you must adhere to
|
|
3269
3233
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
3270
3234
|
* and all other Amazon terms. Remember that you must only use Amazon Kendra Web
|
|
@@ -3276,15 +3240,15 @@ export interface Urls {
|
|
|
3276
3240
|
/**
|
|
3277
3241
|
* <p>Configuration of the seed or starting point URLs of the websites
|
|
3278
3242
|
* you want to crawl.</p>
|
|
3279
|
-
*
|
|
3243
|
+
* <p>You can choose to crawl only the website host names, or the website host names
|
|
3280
3244
|
* with subdomains, or the website host names with subdomains and other domains
|
|
3281
3245
|
* that the webpages link to.</p>
|
|
3282
|
-
*
|
|
3246
|
+
* <p>You can list up to 100 seed URLs.</p>
|
|
3283
3247
|
*/
|
|
3284
3248
|
SeedUrlConfiguration?: SeedUrlConfiguration;
|
|
3285
3249
|
/**
|
|
3286
3250
|
* <p>Configuration of the sitemap URLs of the websites you want to crawl.</p>
|
|
3287
|
-
*
|
|
3251
|
+
* <p>Only URLs belonging to the same website host names are crawled. You can list up to
|
|
3288
3252
|
* three sitemap URLs.</p>
|
|
3289
3253
|
*/
|
|
3290
3254
|
SiteMapsConfiguration?: SiteMapsConfiguration;
|
|
@@ -3297,12 +3261,12 @@ export interface WebCrawlerConfiguration {
|
|
|
3297
3261
|
/**
|
|
3298
3262
|
* <p>Specifies the seed or starting point URLs of the
|
|
3299
3263
|
* websites or the sitemap URLs of the websites you want to crawl.</p>
|
|
3300
|
-
*
|
|
3264
|
+
* <p>You can include website subdomains. You can list up to 100 seed
|
|
3301
3265
|
* URLs and up to three sitemap URLs.</p>
|
|
3302
|
-
*
|
|
3266
|
+
* <p>You can only crawl websites that use the secure communication protocol,
|
|
3303
3267
|
* Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when
|
|
3304
3268
|
* crawling a website, it could be that the website is blocked from crawling.</p>
|
|
3305
|
-
*
|
|
3269
|
+
* <p>
|
|
3306
3270
|
* <i>When selecting websites to index, you must adhere to
|
|
3307
3271
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
3308
3272
|
* and all other Amazon terms. Remember that you must only use Amazon Kendra
|
|
@@ -3313,32 +3277,32 @@ export interface WebCrawlerConfiguration {
|
|
|
3313
3277
|
Urls: Urls | undefined;
|
|
3314
3278
|
/**
|
|
3315
3279
|
* <p>Specifies the number of levels in a website that you want to crawl.</p>
|
|
3316
|
-
*
|
|
3280
|
+
* <p>The first level begins from the website seed or starting point URL.
|
|
3317
3281
|
* For example, if a website has 3 levels – index level (i.e. seed in this
|
|
3318
3282
|
* example), sections level, and subsections level – and you are only
|
|
3319
3283
|
* interested in crawling information up to the sections level (i.e.
|
|
3320
3284
|
* levels 0-1), you can set your depth to 1.</p>
|
|
3321
|
-
*
|
|
3285
|
+
* <p>The default crawl depth is set to 2.</p>
|
|
3322
3286
|
*/
|
|
3323
3287
|
CrawlDepth?: number;
|
|
3324
3288
|
/**
|
|
3325
3289
|
* <p>The maximum number of URLs on a webpage to include when crawling a website.
|
|
3326
3290
|
* This number is per webpage.</p>
|
|
3327
|
-
*
|
|
3291
|
+
* <p>As a website’s webpages are crawled, any URLs the webpages link to are
|
|
3328
3292
|
* also crawled. URLs on a webpage are crawled in order of appearance.</p>
|
|
3329
|
-
*
|
|
3293
|
+
* <p>The default maximum links per page is 100.</p>
|
|
3330
3294
|
*/
|
|
3331
3295
|
MaxLinksPerPage?: number;
|
|
3332
3296
|
/**
|
|
3333
3297
|
* <p>The maximum size (in MB) of a webpage or attachment to crawl.</p>
|
|
3334
|
-
*
|
|
3335
|
-
*
|
|
3298
|
+
* <p>Files larger than this size (in MB) are skipped/not crawled.</p>
|
|
3299
|
+
* <p>The default maximum size of a webpage or attachment is set to 50 MB.</p>
|
|
3336
3300
|
*/
|
|
3337
3301
|
MaxContentSizePerPageInMegaBytes?: number;
|
|
3338
3302
|
/**
|
|
3339
3303
|
* <p>The maximum number of URLs crawled per website host per minute.</p>
|
|
3340
|
-
*
|
|
3341
|
-
*
|
|
3304
|
+
* <p>A minimum of one URL is required.</p>
|
|
3305
|
+
* <p>The default maximum number of URLs crawled per website host per minute is 300.</p>
|
|
3342
3306
|
*/
|
|
3343
3307
|
MaxUrlsPerMinuteCrawlRate?: number;
|
|
3344
3308
|
/**
|
|
@@ -3360,10 +3324,10 @@ export interface WebCrawlerConfiguration {
|
|
|
3360
3324
|
/**
|
|
3361
3325
|
* <p>Configuration information required to connect to your internal
|
|
3362
3326
|
* websites via a web proxy.</p>
|
|
3363
|
-
*
|
|
3327
|
+
* <p>You must provide the website host name and port number. For example, the
|
|
3364
3328
|
* host name of https://a.example.com/page1.html is "a.example.com" and the
|
|
3365
3329
|
* port is 443, the standard port for HTTPS.</p>
|
|
3366
|
-
*
|
|
3330
|
+
* <p>Web proxy credentials are optional and you can use them to connect to a
|
|
3367
3331
|
* web proxy server that requires basic authentication. To store web proxy
|
|
3368
3332
|
* credentials, you use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>.</p>
|
|
3369
3333
|
*/
|
|
@@ -3371,10 +3335,10 @@ export interface WebCrawlerConfiguration {
|
|
|
3371
3335
|
/**
|
|
3372
3336
|
* <p>Configuration information required to connect to websites using
|
|
3373
3337
|
* authentication.</p>
|
|
3374
|
-
*
|
|
3338
|
+
* <p>You can connect to websites using basic authentication of user name and password.
|
|
3375
3339
|
* You use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a> to store
|
|
3376
3340
|
* your authentication credentials.</p>
|
|
3377
|
-
*
|
|
3341
|
+
* <p>You must provide the website host name and port number. For example, the host name
|
|
3378
3342
|
* of https://a.example.com/page1.html is "a.example.com" and the port is 443, the
|
|
3379
3343
|
* standard port for HTTPS.</p>
|
|
3380
3344
|
*/
|
|
@@ -3383,14 +3347,14 @@ export interface WebCrawlerConfiguration {
|
|
|
3383
3347
|
/**
|
|
3384
3348
|
* <p>Provides the configuration information to connect to Amazon WorkDocs
|
|
3385
3349
|
* as your data source.</p>
|
|
3386
|
-
*
|
|
3350
|
+
* <p>Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland
|
|
3387
3351
|
* regions.</p>
|
|
3388
3352
|
*/
|
|
3389
3353
|
export interface WorkDocsConfiguration {
|
|
3390
3354
|
/**
|
|
3391
3355
|
* <p>The identifier of the directory corresponding to your
|
|
3392
3356
|
* Amazon WorkDocs site repository.</p>
|
|
3393
|
-
*
|
|
3357
|
+
* <p>You can find the organization ID in the
|
|
3394
3358
|
* <a href="https://console.aws.amazon.com/directoryservicev2/">Directory Service</a> by going to
|
|
3395
3359
|
* <b>Active Directory</b>, then
|
|
3396
3360
|
* <b>Directories</b>. Your Amazon WorkDocs site directory has an
|
|
@@ -3404,7 +3368,7 @@ export interface WorkDocsConfiguration {
|
|
|
3404
3368
|
* <code>TRUE</code> to include comments on documents
|
|
3405
3369
|
* in your index. Including comments in your index means each comment
|
|
3406
3370
|
* is a document that can be searched on.</p>
|
|
3407
|
-
*
|
|
3371
|
+
* <p>The default is set to <code>FALSE</code>.</p>
|
|
3408
3372
|
*/
|
|
3409
3373
|
CrawlComments?: boolean;
|
|
3410
3374
|
/**
|
|
@@ -3644,7 +3608,7 @@ export interface CreateDataSourceRequest {
|
|
|
3644
3608
|
/**
|
|
3645
3609
|
* <p>Configuration information for altering document metadata and content during the
|
|
3646
3610
|
* document ingestion process.</p>
|
|
3647
|
-
*
|
|
3611
|
+
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
3648
3612
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
3649
3613
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
3650
3614
|
* document metadata during the ingestion process</a>.</p>
|
|
@@ -3786,9 +3750,9 @@ export interface CreateFaqRequest {
|
|
|
3786
3750
|
* <p>The format of the FAQ input file. You can choose between a basic CSV format, a CSV format
|
|
3787
3751
|
* that includes customs attributes in a header, and a JSON format that includes custom
|
|
3788
3752
|
* attributes.</p>
|
|
3789
|
-
*
|
|
3753
|
+
* <p>The format must match the format of the file stored in the S3 bucket identified in the
|
|
3790
3754
|
* <code>S3Path</code> parameter.</p>
|
|
3791
|
-
*
|
|
3755
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html">Adding questions and
|
|
3792
3756
|
* answers</a>.</p>
|
|
3793
3757
|
*/
|
|
3794
3758
|
FileFormat?: FaqFileFormat | string;
|
|
@@ -3809,7 +3773,7 @@ export interface CreateFaqRequest {
|
|
|
3809
3773
|
}
|
|
3810
3774
|
export interface CreateFaqResponse {
|
|
3811
3775
|
/**
|
|
3812
|
-
* <p>The
|
|
3776
|
+
* <p>The identifier of the FAQ.</p>
|
|
3813
3777
|
*/
|
|
3814
3778
|
Id?: string;
|
|
3815
3779
|
}
|
|
@@ -3934,29 +3898,25 @@ export interface CreateIndexRequest {
|
|
|
3934
3898
|
*/
|
|
3935
3899
|
Name: string | undefined;
|
|
3936
3900
|
/**
|
|
3937
|
-
* <p>The Amazon Kendra edition to use for the index. Choose
|
|
3938
|
-
*
|
|
3939
|
-
*
|
|
3940
|
-
*
|
|
3941
|
-
*
|
|
3942
|
-
*
|
|
3943
|
-
*
|
|
3944
|
-
* <p>For more information on quota limits for enterprise and developer editions,
|
|
3945
|
-
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p>
|
|
3901
|
+
* <p>The Amazon Kendra edition to use for the index. Choose <code>DEVELOPER_EDITION</code>
|
|
3902
|
+
* for indexes intended for development, testing, or proof of concept. Use
|
|
3903
|
+
* <code>ENTERPRISE_EDITION</code> for your production databases. Once you set the edition for
|
|
3904
|
+
* an index, it can't be changed.</p>
|
|
3905
|
+
* <p>The <code>Edition</code> parameter is optional. If you don't supply a value, the default
|
|
3906
|
+
* is <code>ENTERPRISE_EDITION</code>.</p>
|
|
3907
|
+
* <p>For more information on quota limits for enterprise and developer editions, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p>
|
|
3946
3908
|
*/
|
|
3947
3909
|
Edition?: IndexEdition | string;
|
|
3948
3910
|
/**
|
|
3949
|
-
* <p>An Identity and Access Management (IAM) role that gives
|
|
3950
|
-
* Amazon
|
|
3951
|
-
*
|
|
3952
|
-
*
|
|
3953
|
-
* Amazon S3 bucket.</p>
|
|
3911
|
+
* <p>An Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access
|
|
3912
|
+
* your Amazon CloudWatch logs and metrics. This is also the role you use when you call the
|
|
3913
|
+
* <code>BatchPutDocument</code> API to index documents from an Amazon S3
|
|
3914
|
+
* bucket.</p>
|
|
3954
3915
|
*/
|
|
3955
3916
|
RoleArn: string | undefined;
|
|
3956
3917
|
/**
|
|
3957
|
-
* <p>The identifier of the KMS customer managed key (CMK) that's
|
|
3958
|
-
*
|
|
3959
|
-
* asymmetric CMKs.</p>
|
|
3918
|
+
* <p>The identifier of the KMS customer managed key (CMK) that's used to encrypt
|
|
3919
|
+
* data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.</p>
|
|
3960
3920
|
*/
|
|
3961
3921
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
3962
3922
|
/**
|
|
@@ -3964,15 +3924,13 @@ export interface CreateIndexRequest {
|
|
|
3964
3924
|
*/
|
|
3965
3925
|
Description?: string;
|
|
3966
3926
|
/**
|
|
3967
|
-
* <p>A token that you provide to identify the request to create an index.
|
|
3968
|
-
*
|
|
3969
|
-
* client token will create only one index.</p>
|
|
3927
|
+
* <p>A token that you provide to identify the request to create an index. Multiple calls to the
|
|
3928
|
+
* <code>CreateIndex</code> API with the same client token will create only one index.</p>
|
|
3970
3929
|
*/
|
|
3971
3930
|
ClientToken?: string;
|
|
3972
3931
|
/**
|
|
3973
|
-
* <p>A list of key-value pairs that identify the index. You can use the
|
|
3974
|
-
*
|
|
3975
|
-
* resources.</p>
|
|
3932
|
+
* <p>A list of key-value pairs that identify the index. You can use the tags to identify and
|
|
3933
|
+
* organize your resources and to control access to resources.</p>
|
|
3976
3934
|
*/
|
|
3977
3935
|
Tags?: Tag[];
|
|
3978
3936
|
/**
|
|
@@ -4011,8 +3969,8 @@ export interface CreateIndexRequest {
|
|
|
4011
3969
|
}
|
|
4012
3970
|
export interface CreateIndexResponse {
|
|
4013
3971
|
/**
|
|
4014
|
-
* <p>The
|
|
4015
|
-
*
|
|
3972
|
+
* <p>The identifier of the index. Use this identifier when you query an index, set up a
|
|
3973
|
+
* data source, or index a document.</p>
|
|
4016
3974
|
*/
|
|
4017
3975
|
Id?: string;
|
|
4018
3976
|
}
|
|
@@ -4023,21 +3981,21 @@ export interface CreateQuerySuggestionsBlockListRequest {
|
|
|
4023
3981
|
IndexId: string | undefined;
|
|
4024
3982
|
/**
|
|
4025
3983
|
* <p>A user friendly name for the block list.</p>
|
|
4026
|
-
*
|
|
3984
|
+
* <p>For example, the block list named 'offensive-words' includes all
|
|
4027
3985
|
* offensive words that could appear in user queries and need to be
|
|
4028
3986
|
* blocked from suggestions.</p>
|
|
4029
3987
|
*/
|
|
4030
3988
|
Name: string | undefined;
|
|
4031
3989
|
/**
|
|
4032
3990
|
* <p>A user-friendly description for the block list.</p>
|
|
4033
|
-
*
|
|
3991
|
+
* <p>For example, the description "List of all offensive words that can
|
|
4034
3992
|
* appear in user queries and need to be blocked from suggestions."</p>
|
|
4035
3993
|
*/
|
|
4036
3994
|
Description?: string;
|
|
4037
3995
|
/**
|
|
4038
3996
|
* <p>The S3 path to your block list text file in your S3 bucket.</p>
|
|
4039
|
-
*
|
|
4040
|
-
*
|
|
3997
|
+
* <p>Each block word or phrase should be on a separate line in a text file.</p>
|
|
3998
|
+
* <p>For information on the current quota limits for block lists, see
|
|
4041
3999
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
4042
4000
|
* for Amazon Kendra</a>.</p>
|
|
4043
4001
|
*/
|
|
@@ -4050,7 +4008,7 @@ export interface CreateQuerySuggestionsBlockListRequest {
|
|
|
4050
4008
|
/**
|
|
4051
4009
|
* <p>The IAM (Identity and Access Management) role used by Amazon Kendra to
|
|
4052
4010
|
* access the block list text file in your S3 bucket.</p>
|
|
4053
|
-
*
|
|
4011
|
+
* <p>You need permissions to the role ARN (Amazon Web Services Resource Name).
|
|
4054
4012
|
* The role needs S3 read permissions to your file in S3 and needs
|
|
4055
4013
|
* to give STS (Security Token Service) assume role permissions
|
|
4056
4014
|
* to Amazon Kendra.</p>
|
|
@@ -4064,7 +4022,7 @@ export interface CreateQuerySuggestionsBlockListRequest {
|
|
|
4064
4022
|
}
|
|
4065
4023
|
export interface CreateQuerySuggestionsBlockListResponse {
|
|
4066
4024
|
/**
|
|
4067
|
-
* <p>The
|
|
4025
|
+
* <p>The identifier of the created block list.</p>
|
|
4068
4026
|
*/
|
|
4069
4027
|
Id?: string;
|
|
4070
4028
|
}
|
|
@@ -4108,7 +4066,7 @@ export interface CreateThesaurusRequest {
|
|
|
4108
4066
|
}
|
|
4109
4067
|
export interface CreateThesaurusResponse {
|
|
4110
4068
|
/**
|
|
4111
|
-
* <p>The
|
|
4069
|
+
* <p>The identifier of the thesaurus.
|
|
4112
4070
|
* </p>
|
|
4113
4071
|
*/
|
|
4114
4072
|
Id?: string;
|
|
@@ -4170,7 +4128,7 @@ export interface DeletePrincipalMappingRequest {
|
|
|
4170
4128
|
IndexId: string | undefined;
|
|
4171
4129
|
/**
|
|
4172
4130
|
* <p>The identifier of the data source you want to delete a group from.</p>
|
|
4173
|
-
*
|
|
4131
|
+
* <p>A group can be tied to multiple data sources. You can
|
|
4174
4132
|
* delete a group from accessing documents in a certain data source. For example,
|
|
4175
4133
|
* the groups "Research", "Engineering", and "Sales and Marketing" are all tied to
|
|
4176
4134
|
* the company's documents stored in the data sources Confluence and Salesforce.
|
|
@@ -4190,13 +4148,13 @@ export interface DeletePrincipalMappingRequest {
|
|
|
4190
4148
|
* you want to process and apply on top of other actions with lower number
|
|
4191
4149
|
* IDs. This prevents previous actions with lower number IDs from possibly
|
|
4192
4150
|
* overriding the latest action.</p>
|
|
4193
|
-
*
|
|
4151
|
+
* <p>The ordering ID can be the UNIX time of the last update you made to a group
|
|
4194
4152
|
* members list. You would then provide this list when calling
|
|
4195
4153
|
* <code>PutPrincipalMapping</code>. This ensures your <code>DELETE</code> action
|
|
4196
4154
|
* for that updated group with the latest members list doesn't get overwritten
|
|
4197
4155
|
* by earlier <code>DELETE</code> actions for the same group which are yet to
|
|
4198
4156
|
* be processed.</p>
|
|
4199
|
-
*
|
|
4157
|
+
* <p>The default ordering ID is the current UNIX time in milliseconds that the
|
|
4200
4158
|
* action was received by Amazon Kendra.
|
|
4201
4159
|
* </p>
|
|
4202
4160
|
*/
|
|
@@ -4348,7 +4306,7 @@ export interface DescribeDataSourceResponse {
|
|
|
4348
4306
|
/**
|
|
4349
4307
|
* <p>Configuration information for altering document metadata and content during the
|
|
4350
4308
|
* document ingestion process when you describe a data source.</p>
|
|
4351
|
-
*
|
|
4309
|
+
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
4352
4310
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
4353
4311
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
4354
4312
|
* document metadata during the ingestion process</a>.</p>
|
|
@@ -4540,9 +4498,9 @@ export interface CapacityUnitsConfiguration {
|
|
|
4540
4498
|
/**
|
|
4541
4499
|
* <p>The amount of extra query capacity for an index and <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html">GetQuerySuggestions</a>
|
|
4542
4500
|
* capacity.</p>
|
|
4543
|
-
*
|
|
4501
|
+
* <p>A single extra capacity unit for an index provides 0.1 queries per second or
|
|
4544
4502
|
* approximately 8,000 queries per day. You can add up to 100 extra capacity units.</p>
|
|
4545
|
-
*
|
|
4503
|
+
* <p>
|
|
4546
4504
|
* <code>GetQuerySuggestions</code> capacity is five times the provisioned query capacity
|
|
4547
4505
|
* for an index, or the base capacity of 2.5 calls per second, whichever is higher. For
|
|
4548
4506
|
* example, the base capacity for an index is 0.1 queries per second, and
|
|
@@ -4582,18 +4540,18 @@ export interface Relevance {
|
|
|
4582
4540
|
* The higher the importance, the faster the effect drops off. If you don't specify a
|
|
4583
4541
|
* value, the default is 3 months. The value of the field is a numeric string followed by
|
|
4584
4542
|
* the character "s", for example "86400s" for one day, or "604800s" for one week. </p>
|
|
4585
|
-
*
|
|
4543
|
+
* <p>Only applies to <code>DATE</code> fields.</p>
|
|
4586
4544
|
*/
|
|
4587
4545
|
Duration?: string;
|
|
4588
4546
|
/**
|
|
4589
4547
|
* <p>Determines how values should be interpreted.</p>
|
|
4590
|
-
*
|
|
4548
|
+
* <p>When the <code>RankOrder</code> field is <code>ASCENDING</code>, higher numbers are
|
|
4591
4549
|
* better. For example, a document with a rating score of 10 is higher ranking than a
|
|
4592
4550
|
* document with a rating score of 1.</p>
|
|
4593
|
-
*
|
|
4551
|
+
* <p>When the <code>RankOrder</code> field is <code>DESCENDING</code>, lower numbers are
|
|
4594
4552
|
* better. For example, in a task tracking application, a priority 1 task is more important
|
|
4595
4553
|
* than a priority 5 task.</p>
|
|
4596
|
-
*
|
|
4554
|
+
* <p>Only applies to <code>LONG</code> and <code>DOUBLE</code> fields.</p>
|
|
4597
4555
|
*/
|
|
4598
4556
|
RankOrder?: Order | string;
|
|
4599
4557
|
/**
|
|
@@ -4601,7 +4559,7 @@ export interface Relevance {
|
|
|
4601
4559
|
* list. For example, if you are boosting a field called "department," query terms that
|
|
4602
4560
|
* match the department field are boosted in the result. However, you can add entries from
|
|
4603
4561
|
* the department field to boost documents with those values higher. </p>
|
|
4604
|
-
*
|
|
4562
|
+
* <p>For example, you can add entries to the map with names of departments. If you add
|
|
4605
4563
|
* "HR",5 and "Legal",3 those departments are given special attention when they appear in
|
|
4606
4564
|
* the metadata of a document. When those terms appear they are given the specified
|
|
4607
4565
|
* importance instead of the regular importance for the boost.</p>
|
|
@@ -4720,27 +4678,24 @@ export interface DescribeIndexResponse {
|
|
|
4720
4678
|
*/
|
|
4721
4679
|
Id?: string;
|
|
4722
4680
|
/**
|
|
4723
|
-
* <p>The Amazon Kendra edition used for the index. You decide the edition
|
|
4724
|
-
*
|
|
4681
|
+
* <p>The Amazon Kendra edition used for the index. You decide the edition when you create
|
|
4682
|
+
* the index.</p>
|
|
4725
4683
|
*/
|
|
4726
4684
|
Edition?: IndexEdition | string;
|
|
4727
4685
|
/**
|
|
4728
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra
|
|
4729
|
-
*
|
|
4686
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to
|
|
4687
|
+
* write to your Amazon Cloudwatch logs.</p>
|
|
4730
4688
|
*/
|
|
4731
4689
|
RoleArn?: string;
|
|
4732
4690
|
/**
|
|
4733
|
-
* <p>The identifier of the KMScustomer master key (CMK)
|
|
4734
|
-
*
|
|
4735
|
-
* asymmetric CMKs.</p>
|
|
4691
|
+
* <p>The identifier of the KMScustomer master key (CMK) that is used to encrypt
|
|
4692
|
+
* your data. Amazon Kendra doesn't support asymmetric CMKs.</p>
|
|
4736
4693
|
*/
|
|
4737
4694
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
4738
4695
|
/**
|
|
4739
|
-
* <p>The current status of the index. When the value is
|
|
4740
|
-
* <code>
|
|
4741
|
-
* <code>
|
|
4742
|
-
* <code>ErrorMessage</code> field contains a message that explains
|
|
4743
|
-
* why.</p>
|
|
4696
|
+
* <p>The current status of the index. When the value is <code>ACTIVE</code>, the index is ready
|
|
4697
|
+
* for use. If the <code>Status</code> field value is <code>FAILED</code>, the
|
|
4698
|
+
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
4744
4699
|
*/
|
|
4745
4700
|
Status?: IndexStatus | string;
|
|
4746
4701
|
/**
|
|
@@ -4756,29 +4711,26 @@ export interface DescribeIndexResponse {
|
|
|
4756
4711
|
*/
|
|
4757
4712
|
UpdatedAt?: Date;
|
|
4758
4713
|
/**
|
|
4759
|
-
* <p>Configuration information for document metadata or fields. Document metadata
|
|
4760
|
-
*
|
|
4761
|
-
*
|
|
4714
|
+
* <p>Configuration information for document metadata or fields. Document metadata are fields or
|
|
4715
|
+
* attributes associated with your documents. For example, the company department name associated
|
|
4716
|
+
* with each document.</p>
|
|
4762
4717
|
*/
|
|
4763
4718
|
DocumentMetadataConfigurations?: DocumentMetadataConfiguration[];
|
|
4764
4719
|
/**
|
|
4765
|
-
* <p>Provides information about the number of FAQ questions and answers and
|
|
4766
|
-
*
|
|
4720
|
+
* <p>Provides information about the number of FAQ questions and answers and the number of text
|
|
4721
|
+
* documents indexed.</p>
|
|
4767
4722
|
*/
|
|
4768
4723
|
IndexStatistics?: IndexStatistics;
|
|
4769
4724
|
/**
|
|
4770
4725
|
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
4771
|
-
* <code>ErrorMessage</code> field contains a message that explains
|
|
4772
|
-
* why.</p>
|
|
4726
|
+
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
4773
4727
|
*/
|
|
4774
4728
|
ErrorMessage?: string;
|
|
4775
4729
|
/**
|
|
4776
|
-
* <p>For Enterprise Edition indexes, you can choose to use additional
|
|
4777
|
-
*
|
|
4778
|
-
*
|
|
4779
|
-
*
|
|
4780
|
-
* on the default capacity for an index and adjusting this, see
|
|
4781
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
|
|
4730
|
+
* <p>For Enterprise Edition indexes, you can choose to use additional capacity to meet the
|
|
4731
|
+
* needs of your application. This contains the capacity units used for the index. A query or
|
|
4732
|
+
* document storage capacity of zero indicates that the index is using the default capacity. For
|
|
4733
|
+
* more information on the default capacity for an index and adjusting this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
|
|
4782
4734
|
* capacity</a>.</p>
|
|
4783
4735
|
*/
|
|
4784
4736
|
CapacityUnits?: CapacityUnitsConfiguration;
|
|
@@ -4881,24 +4833,24 @@ export interface DescribePrincipalMappingResponse {
|
|
|
4881
4833
|
/**
|
|
4882
4834
|
* <p>Shows the following information on the processing of <code>PUT</code> and
|
|
4883
4835
|
* <code>DELETE</code> actions for mapping users to their groups:</p>
|
|
4884
|
-
*
|
|
4836
|
+
* <ul>
|
|
4885
4837
|
* <li>
|
|
4886
|
-
*
|
|
4838
|
+
* <p>Status – the status can be either
|
|
4887
4839
|
* <code>PROCESSING</code>, <code>SUCCEEDED</code>, <code>DELETING</code>,
|
|
4888
4840
|
* <code>DELETED</code>, or <code>FAILED</code>.</p>
|
|
4889
4841
|
* </li>
|
|
4890
4842
|
* <li>
|
|
4891
|
-
*
|
|
4843
|
+
* <p>Last updated – the last date-time an action was updated.</p>
|
|
4892
4844
|
* </li>
|
|
4893
4845
|
* <li>
|
|
4894
|
-
*
|
|
4846
|
+
* <p>Received – the last date-time an action was received or submitted.</p>
|
|
4895
4847
|
* </li>
|
|
4896
4848
|
* <li>
|
|
4897
|
-
*
|
|
4849
|
+
* <p>Ordering ID – the latest action that should process and apply
|
|
4898
4850
|
* after other actions.</p>
|
|
4899
4851
|
* </li>
|
|
4900
4852
|
* <li>
|
|
4901
|
-
*
|
|
4853
|
+
* <p>Failure reason – the reason an action could not be processed.</p>
|
|
4902
4854
|
* </li>
|
|
4903
4855
|
* </ul>
|
|
4904
4856
|
*/
|
|
@@ -4959,8 +4911,8 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
4959
4911
|
UpdatedAt?: Date;
|
|
4960
4912
|
/**
|
|
4961
4913
|
* <p>Shows the current S3 path to your block list text file in your S3 bucket.</p>
|
|
4962
|
-
*
|
|
4963
|
-
*
|
|
4914
|
+
* <p>Each block word or phrase should be on a separate line in a text file.</p>
|
|
4915
|
+
* <p>For information on the current quota limits for block lists, see
|
|
4964
4916
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
4965
4917
|
* for Amazon Kendra</a>.</p>
|
|
4966
4918
|
*/
|
|
@@ -4977,7 +4929,7 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
4977
4929
|
/**
|
|
4978
4930
|
* <p>The IAM (Identity and Access Management) role used by
|
|
4979
4931
|
* Amazon Kendra to access the block list text file in S3.</p>
|
|
4980
|
-
*
|
|
4932
|
+
* <p>The role needs S3 read permissions to your file in S3 and needs to
|
|
4981
4933
|
* give STS (Security Token Service) assume role permissions to
|
|
4982
4934
|
* Amazon Kendra.</p>
|
|
4983
4935
|
*/
|
|
@@ -5002,7 +4954,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5002
4954
|
/**
|
|
5003
4955
|
* <p>Whether query suggestions are currently in
|
|
5004
4956
|
* <code>ENABLED</code> mode or <code>LEARN_ONLY</code> mode.</p>
|
|
5005
|
-
*
|
|
4957
|
+
* <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code>
|
|
5006
4958
|
* turns off query suggestions for your users. You can change the mode using
|
|
5007
4959
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a>
|
|
5008
4960
|
* API.</p>
|
|
@@ -5011,7 +4963,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5011
4963
|
/**
|
|
5012
4964
|
* <p>Whether the status of query suggestions settings is currently
|
|
5013
4965
|
* <code>ACTIVE</code> or <code>UPDATING</code>.</p>
|
|
5014
|
-
*
|
|
4966
|
+
* <p>Active means the current settings apply and Updating means your
|
|
5015
4967
|
* changed settings are in the process of applying.</p>
|
|
5016
4968
|
*/
|
|
5017
4969
|
Status?: QuerySuggestionsStatus | string;
|
|
@@ -5042,7 +4994,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5042
4994
|
LastSuggestionsBuildTime?: Date;
|
|
5043
4995
|
/**
|
|
5044
4996
|
* <p>The date-time query suggestions for an index was last cleared.</p>
|
|
5045
|
-
*
|
|
4997
|
+
* <p>After you clear suggestions, Amazon Kendra learns new suggestions based
|
|
5046
4998
|
* on new queries added to the query log from the time you cleared suggestions.
|
|
5047
4999
|
* Amazon Kendra only considers re-occurences of a query from the time you cleared
|
|
5048
5000
|
* suggestions. </p>
|
|
@@ -5050,7 +5002,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5050
5002
|
LastClearTime?: Date;
|
|
5051
5003
|
/**
|
|
5052
5004
|
* <p>The current total count of query suggestions for an index.</p>
|
|
5053
|
-
*
|
|
5005
|
+
* <p>This count can change when you update your query suggestions settings,
|
|
5054
5006
|
* if you filter out certain queries from suggestions using a block list,
|
|
5055
5007
|
* and as the query log accumulates more queries for Amazon Kendra to learn from.</p>
|
|
5056
5008
|
*/
|
|
@@ -5193,9 +5145,9 @@ export interface GetQuerySuggestionsRequest {
|
|
|
5193
5145
|
IndexId: string | undefined;
|
|
5194
5146
|
/**
|
|
5195
5147
|
* <p>The text of a user's query to generate query suggestions.</p>
|
|
5196
|
-
*
|
|
5148
|
+
* <p>A query is suggested if the query prefix matches
|
|
5197
5149
|
* what a user starts to type as their query.</p>
|
|
5198
|
-
*
|
|
5150
|
+
* <p>Amazon Kendra does not show any suggestions if a user
|
|
5199
5151
|
* types fewer than two characters or more than 60 characters.
|
|
5200
5152
|
* A query must also have at least one search result and contain
|
|
5201
5153
|
* at least one word of more than four characters.</p>
|
|
@@ -5248,20 +5200,20 @@ export interface SuggestionValue {
|
|
|
5248
5200
|
*/
|
|
5249
5201
|
export interface Suggestion {
|
|
5250
5202
|
/**
|
|
5251
|
-
* <p>The
|
|
5203
|
+
* <p>The UUID (universally unique identifier) of a single
|
|
5252
5204
|
* query suggestion.</p>
|
|
5253
5205
|
*/
|
|
5254
5206
|
Id?: string;
|
|
5255
5207
|
/**
|
|
5256
|
-
* <p>The value for the
|
|
5208
|
+
* <p>The value for the UUID (universally unique identifier)
|
|
5257
5209
|
* of a single query suggestion.</p>
|
|
5258
|
-
*
|
|
5210
|
+
* <p>The value is the text string of a suggestion.</p>
|
|
5259
5211
|
*/
|
|
5260
5212
|
Value?: SuggestionValue;
|
|
5261
5213
|
}
|
|
5262
5214
|
export interface GetQuerySuggestionsResponse {
|
|
5263
5215
|
/**
|
|
5264
|
-
* <p>The
|
|
5216
|
+
* <p>The identifier for a list of query suggestions for an index.</p>
|
|
5265
5217
|
*/
|
|
5266
5218
|
QuerySuggestionsId?: string;
|
|
5267
5219
|
/**
|
|
@@ -5294,34 +5246,34 @@ export interface GetSnapshotsRequest {
|
|
|
5294
5246
|
* <p>The time interval or time window to get search metrics data.
|
|
5295
5247
|
* The time interval uses the time zone of your index.
|
|
5296
5248
|
* You can view data in the following time windows:</p>
|
|
5297
|
-
*
|
|
5249
|
+
* <ul>
|
|
5298
5250
|
* <li>
|
|
5299
|
-
*
|
|
5251
|
+
* <p>
|
|
5300
5252
|
* <code>THIS_WEEK</code>: The current week, starting on
|
|
5301
5253
|
* the Sunday and ending on the day before the current date.</p>
|
|
5302
5254
|
* </li>
|
|
5303
5255
|
* <li>
|
|
5304
|
-
*
|
|
5256
|
+
* <p>
|
|
5305
5257
|
* <code>ONE_WEEK_AGO</code>: The previous week, starting on
|
|
5306
5258
|
* the Sunday and ending on the following Saturday.</p>
|
|
5307
5259
|
* </li>
|
|
5308
5260
|
* <li>
|
|
5309
|
-
*
|
|
5261
|
+
* <p>
|
|
5310
5262
|
* <code>TWO_WEEKS_AGO</code>: The week before the previous week,
|
|
5311
5263
|
* starting on the Sunday and ending on the following Saturday.</p>
|
|
5312
5264
|
* </li>
|
|
5313
5265
|
* <li>
|
|
5314
|
-
*
|
|
5266
|
+
* <p>
|
|
5315
5267
|
* <code>THIS_MONTH</code>: The current month, starting on the
|
|
5316
5268
|
* first day of the month and ending on the day before the current date.</p>
|
|
5317
5269
|
* </li>
|
|
5318
5270
|
* <li>
|
|
5319
|
-
*
|
|
5271
|
+
* <p>
|
|
5320
5272
|
* <code>ONE_MONTH_AGO</code>: The previous month, starting on the
|
|
5321
5273
|
* first day of the month and ending on the last day of the month.</p>
|
|
5322
5274
|
* </li>
|
|
5323
5275
|
* <li>
|
|
5324
|
-
*
|
|
5276
|
+
* <p>
|
|
5325
5277
|
* <code>TWO_MONTHS_AGO</code>: The month before the previous month,
|
|
5326
5278
|
* starting on the first day of the month and ending on last day of the month.</p>
|
|
5327
5279
|
* </li>
|
|
@@ -5331,7 +5283,7 @@ export interface GetSnapshotsRequest {
|
|
|
5331
5283
|
/**
|
|
5332
5284
|
* <p>The metric you want to retrieve. You
|
|
5333
5285
|
* can specify only one metric per call.</p>
|
|
5334
|
-
*
|
|
5286
|
+
* <p>For more information about the metrics you can view, see
|
|
5335
5287
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining
|
|
5336
5288
|
* insights with search analytics</a>.</p>
|
|
5337
5289
|
*/
|
|
@@ -5384,7 +5336,8 @@ export interface GetSnapshotsResponse {
|
|
|
5384
5336
|
NextToken?: string;
|
|
5385
5337
|
}
|
|
5386
5338
|
/**
|
|
5387
|
-
* <p>The input to the request is not valid
|
|
5339
|
+
* <p>The input to the request is not valid. Please provide the correct input and try
|
|
5340
|
+
* again.</p>
|
|
5388
5341
|
*/
|
|
5389
5342
|
export declare class InvalidRequestException extends __BaseException {
|
|
5390
5343
|
readonly name: "InvalidRequestException";
|
|
@@ -5431,7 +5384,7 @@ export interface ListDataSourcesRequest {
|
|
|
5431
5384
|
IndexId: string | undefined;
|
|
5432
5385
|
/**
|
|
5433
5386
|
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to
|
|
5434
|
-
* retrieve the next set of data source connectors
|
|
5387
|
+
* retrieve the next set of data source connectors. </p>
|
|
5435
5388
|
*/
|
|
5436
5389
|
NextToken?: string;
|
|
5437
5390
|
/**
|
|
@@ -5440,8 +5393,7 @@ export interface ListDataSourcesRequest {
|
|
|
5440
5393
|
MaxResults?: number;
|
|
5441
5394
|
}
|
|
5442
5395
|
/**
|
|
5443
|
-
* <p>Summary information for
|
|
5444
|
-
* <code>DescribeDataSource</code> API.</p>
|
|
5396
|
+
* <p>Summary information for a Amazon Kendra data source.</p>
|
|
5445
5397
|
*/
|
|
5446
5398
|
export interface DataSourceSummary {
|
|
5447
5399
|
/**
|
|
@@ -5449,7 +5401,7 @@ export interface DataSourceSummary {
|
|
|
5449
5401
|
*/
|
|
5450
5402
|
Name?: string;
|
|
5451
5403
|
/**
|
|
5452
|
-
* <p>The
|
|
5404
|
+
* <p>The identifier for the data source.</p>
|
|
5453
5405
|
*/
|
|
5454
5406
|
Id?: string;
|
|
5455
5407
|
/**
|
|
@@ -5565,7 +5517,7 @@ export interface DataSourceSyncJobMetrics {
|
|
|
5565
5517
|
*/
|
|
5566
5518
|
export interface DataSourceSyncJob {
|
|
5567
5519
|
/**
|
|
5568
|
-
* <p>A
|
|
5520
|
+
* <p>A identifier for the synchronization job.</p>
|
|
5569
5521
|
*/
|
|
5570
5522
|
ExecutionId?: string;
|
|
5571
5523
|
/**
|
|
@@ -5832,7 +5784,7 @@ export interface ListFaqsRequest {
|
|
|
5832
5784
|
*/
|
|
5833
5785
|
export interface FaqSummary {
|
|
5834
5786
|
/**
|
|
5835
|
-
* <p>The
|
|
5787
|
+
* <p>The identifier of the FAQ.</p>
|
|
5836
5788
|
*/
|
|
5837
5789
|
Id?: string;
|
|
5838
5790
|
/**
|
|
@@ -5942,14 +5894,12 @@ export interface ListGroupsOlderThanOrderingIdResponse {
|
|
|
5942
5894
|
}
|
|
5943
5895
|
export interface ListIndicesRequest {
|
|
5944
5896
|
/**
|
|
5945
|
-
* <p>If the previous response was incomplete (because there is more data to
|
|
5946
|
-
* retrieve
|
|
5947
|
-
* can use this pagination token to retrieve the next set of indexes
|
|
5948
|
-
* (<code>DataSourceSummaryItems</code>). </p>
|
|
5897
|
+
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to
|
|
5898
|
+
* retrieve the next set of indexes. </p>
|
|
5949
5899
|
*/
|
|
5950
5900
|
NextToken?: string;
|
|
5951
5901
|
/**
|
|
5952
|
-
* <p>The maximum number of
|
|
5902
|
+
* <p>The maximum number of indices to return.</p>
|
|
5953
5903
|
*/
|
|
5954
5904
|
MaxResults?: number;
|
|
5955
5905
|
}
|
|
@@ -5958,17 +5908,17 @@ export interface ListIndicesRequest {
|
|
|
5958
5908
|
*/
|
|
5959
5909
|
export interface IndexConfigurationSummary {
|
|
5960
5910
|
/**
|
|
5961
|
-
* <p>The
|
|
5911
|
+
* <p>The name of the index.</p>
|
|
5962
5912
|
*/
|
|
5963
5913
|
Name?: string;
|
|
5964
5914
|
/**
|
|
5965
|
-
* <p>A
|
|
5966
|
-
*
|
|
5967
|
-
*
|
|
5915
|
+
* <p>A identifier for the index. Use this to identify the index when you are using APIs
|
|
5916
|
+
* such as <code>Query</code>, <code>DescribeIndex</code>, <code>UpdateIndex</code>, and
|
|
5917
|
+
* <code>DeleteIndex</code>.</p>
|
|
5968
5918
|
*/
|
|
5969
5919
|
Id?: string;
|
|
5970
5920
|
/**
|
|
5971
|
-
* <p>Indicates whether the index is a
|
|
5921
|
+
* <p>Indicates whether the index is a Enterprise Edition index or a Developer Edition
|
|
5972
5922
|
* index. </p>
|
|
5973
5923
|
*/
|
|
5974
5924
|
Edition?: IndexEdition | string;
|
|
@@ -5993,9 +5943,8 @@ export interface ListIndicesResponse {
|
|
|
5993
5943
|
*/
|
|
5994
5944
|
IndexConfigurationSummaryItems?: IndexConfigurationSummary[];
|
|
5995
5945
|
/**
|
|
5996
|
-
* <p>If the response is truncated, Amazon Kendra returns this token that you
|
|
5997
|
-
*
|
|
5998
|
-
* indexes.</p>
|
|
5946
|
+
* <p>If the response is truncated, Amazon Kendra returns this token that you can use in
|
|
5947
|
+
* the subsequent request to retrieve the next set of indexes.</p>
|
|
5999
5948
|
*/
|
|
6000
5949
|
NextToken?: string;
|
|
6001
5950
|
}
|
|
@@ -6003,7 +5952,7 @@ export interface ListQuerySuggestionsBlockListsRequest {
|
|
|
6003
5952
|
/**
|
|
6004
5953
|
* <p>The identifier of the index for a list of all block lists that exist for
|
|
6005
5954
|
* that index.</p>
|
|
6006
|
-
*
|
|
5955
|
+
* <p>For information on the current quota limits for block lists, see
|
|
6007
5956
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
6008
5957
|
* for Amazon Kendra</a>.</p>
|
|
6009
5958
|
*/
|
|
@@ -6021,10 +5970,10 @@ export interface ListQuerySuggestionsBlockListsRequest {
|
|
|
6021
5970
|
}
|
|
6022
5971
|
/**
|
|
6023
5972
|
* <p>Summary information on a query suggestions block list.</p>
|
|
6024
|
-
*
|
|
5973
|
+
* <p>This includes information on the block list ID, block list name, when the
|
|
6025
5974
|
* block list was created, when the block list was last updated, and the count
|
|
6026
5975
|
* of block words/phrases in the block list.</p>
|
|
6027
|
-
*
|
|
5976
|
+
* <p>For information on the current quota limits for block lists, see
|
|
6028
5977
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
6029
5978
|
* for Amazon Kendra</a>.</p>
|
|
6030
5979
|
*/
|
|
@@ -6058,10 +6007,10 @@ export interface QuerySuggestionsBlockListSummary {
|
|
|
6058
6007
|
export interface ListQuerySuggestionsBlockListsResponse {
|
|
6059
6008
|
/**
|
|
6060
6009
|
* <p>Summary items for a block list.</p>
|
|
6061
|
-
*
|
|
6010
|
+
* <p>This includes summary items on the block list ID, block list name, when the
|
|
6062
6011
|
* block list was created, when the block list was last updated, and the count
|
|
6063
6012
|
* of block words/phrases in the block list.</p>
|
|
6064
|
-
*
|
|
6013
|
+
* <p>For information on the current quota limits for block lists, see
|
|
6065
6014
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
6066
6015
|
* for Amazon Kendra</a>.</p>
|
|
6067
6016
|
*/
|
|
@@ -6086,7 +6035,8 @@ export interface ListTagsForResourceResponse {
|
|
|
6086
6035
|
Tags?: Tag[];
|
|
6087
6036
|
}
|
|
6088
6037
|
/**
|
|
6089
|
-
* <p
|
|
6038
|
+
* <p>The resource you want to use isn't available. Please check you have provided the
|
|
6039
|
+
* correct resource and try again.</p>
|
|
6090
6040
|
*/
|
|
6091
6041
|
export declare class ResourceUnavailableException extends __BaseException {
|
|
6092
6042
|
readonly name: "ResourceUnavailableException";
|
|
@@ -6198,7 +6148,7 @@ export interface GroupMembers {
|
|
|
6198
6148
|
* groups for a group. Your sub groups can contain more than 1000 users, but
|
|
6199
6149
|
* the list of sub groups that belong to a group (and/or users) must be no
|
|
6200
6150
|
* more than 1000.</p>
|
|
6201
|
-
*
|
|
6151
|
+
* <p>You can download this
|
|
6202
6152
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip">example
|
|
6203
6153
|
* S3 file</a> that uses the correct format for listing group members. Note,
|
|
6204
6154
|
* <code>dataSourceId</code> is optional. The value of <code>type</code>
|
|
@@ -6214,7 +6164,7 @@ export interface PutPrincipalMappingRequest {
|
|
|
6214
6164
|
IndexId: string | undefined;
|
|
6215
6165
|
/**
|
|
6216
6166
|
* <p>The identifier of the data source you want to map users to their groups.</p>
|
|
6217
|
-
*
|
|
6167
|
+
* <p>This is useful if a group is tied to multiple data sources, but you only want
|
|
6218
6168
|
* the group to access documents of a certain data source. For example, the groups
|
|
6219
6169
|
* "Research", "Engineering", and "Sales and Marketing" are all tied to the company's
|
|
6220
6170
|
* documents stored in the data sources Confluence and Salesforce. However,
|
|
@@ -6229,9 +6179,9 @@ export interface PutPrincipalMappingRequest {
|
|
|
6229
6179
|
/**
|
|
6230
6180
|
* <p>The list that contains your users or sub groups that belong
|
|
6231
6181
|
* the same group.</p>
|
|
6232
|
-
*
|
|
6182
|
+
* <p>For example, the group "Company" includes the user "CEO" and the
|
|
6233
6183
|
* sub groups "Research", "Engineering", and "Sales and Marketing".</p>
|
|
6234
|
-
*
|
|
6184
|
+
* <p>If you have more than 1000 users and/or sub groups for a single group,
|
|
6235
6185
|
* you need to provide the path to the S3 file that lists your users and
|
|
6236
6186
|
* sub groups for a group. Your sub groups can contain more than 1000 users,
|
|
6237
6187
|
* but the list of sub groups that belong to a group (and/or users) must be
|
|
@@ -6244,20 +6194,20 @@ export interface PutPrincipalMappingRequest {
|
|
|
6244
6194
|
* ID, which is the ordering ID, is the latest action you want to process and
|
|
6245
6195
|
* apply on top of other actions with lower number IDs. This prevents previous
|
|
6246
6196
|
* actions with lower number IDs from possibly overriding the latest action.</p>
|
|
6247
|
-
*
|
|
6197
|
+
* <p>The ordering ID can be the UNIX time of the last update you made to a
|
|
6248
6198
|
* group members list. You would then provide this list when calling
|
|
6249
6199
|
* <code>PutPrincipalMapping</code>. This ensures your <code>PUT</code> action
|
|
6250
6200
|
* for that updated group with the latest members list doesn't get overwritten
|
|
6251
6201
|
* by earlier <code>PUT</code> actions for the same group which are yet to
|
|
6252
6202
|
* be processed.</p>
|
|
6253
|
-
*
|
|
6203
|
+
* <p>The default ordering ID is the current UNIX time in milliseconds that the
|
|
6254
6204
|
* action was received by Amazon Kendra.</p>
|
|
6255
6205
|
*/
|
|
6256
6206
|
OrderingId?: number;
|
|
6257
6207
|
/**
|
|
6258
6208
|
* <p>The Amazon Resource Name (ARN) of a role that has access to the S3 file
|
|
6259
6209
|
* that contains your list of users or sub groups that belong to a group.</p>
|
|
6260
|
-
*
|
|
6210
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds">IAM roles for Amazon Kendra</a>.</p>
|
|
6261
6211
|
*/
|
|
6262
6212
|
RoleArn?: string;
|
|
6263
6213
|
}
|
|
@@ -6291,22 +6241,22 @@ export declare enum SortOrder {
|
|
|
6291
6241
|
* query. You can specify a single attribute for sorting. The attribute must have the
|
|
6292
6242
|
* <code>Sortable</code> flag set to <code>true</code>, otherwise Amazon Kendra
|
|
6293
6243
|
* returns an exception.</p>
|
|
6294
|
-
*
|
|
6295
|
-
*
|
|
6244
|
+
* <p>You can sort attributes of the following types.</p>
|
|
6245
|
+
* <ul>
|
|
6296
6246
|
* <li>
|
|
6297
|
-
*
|
|
6247
|
+
* <p>Date value</p>
|
|
6298
6248
|
* </li>
|
|
6299
6249
|
* <li>
|
|
6300
|
-
*
|
|
6250
|
+
* <p>Long value</p>
|
|
6301
6251
|
* </li>
|
|
6302
6252
|
* <li>
|
|
6303
|
-
*
|
|
6253
|
+
* <p>String value</p>
|
|
6304
6254
|
* </li>
|
|
6305
6255
|
* </ul>
|
|
6306
|
-
*
|
|
6307
|
-
*
|
|
6256
|
+
* <p>You can't sort attributes of the following type.</p>
|
|
6257
|
+
* <ul>
|
|
6308
6258
|
* <li>
|
|
6309
|
-
*
|
|
6259
|
+
* <p>String list value</p>
|
|
6310
6260
|
* </li>
|
|
6311
6261
|
* </ul>
|
|
6312
6262
|
*/
|
|
@@ -6314,22 +6264,22 @@ export interface SortingConfiguration {
|
|
|
6314
6264
|
/**
|
|
6315
6265
|
* <p>The name of the document attribute used to sort the response. You can use any field
|
|
6316
6266
|
* that has the <code>Sortable</code> flag set to true.</p>
|
|
6317
|
-
*
|
|
6318
|
-
*
|
|
6267
|
+
* <p>You can also sort by any of the following built-in attributes:</p>
|
|
6268
|
+
* <ul>
|
|
6319
6269
|
* <li>
|
|
6320
|
-
*
|
|
6270
|
+
* <p>_category</p>
|
|
6321
6271
|
* </li>
|
|
6322
6272
|
* <li>
|
|
6323
|
-
*
|
|
6273
|
+
* <p>_created_at</p>
|
|
6324
6274
|
* </li>
|
|
6325
6275
|
* <li>
|
|
6326
|
-
*
|
|
6276
|
+
* <p>_last_updated_at</p>
|
|
6327
6277
|
* </li>
|
|
6328
6278
|
* <li>
|
|
6329
|
-
*
|
|
6279
|
+
* <p>_version</p>
|
|
6330
6280
|
* </li>
|
|
6331
6281
|
* <li>
|
|
6332
|
-
*
|
|
6282
|
+
* <p>_view_count</p>
|
|
6333
6283
|
* </li>
|
|
6334
6284
|
* </ul>
|
|
6335
6285
|
*/
|
|
@@ -6342,9 +6292,9 @@ export interface SortingConfiguration {
|
|
|
6342
6292
|
}
|
|
6343
6293
|
/**
|
|
6344
6294
|
* <p>Provides the configuration information for suggested query spell corrections.</p>
|
|
6345
|
-
*
|
|
6295
|
+
* <p>Suggested spell corrections are based on words that appear in your indexed documents
|
|
6346
6296
|
* and how closely a corrected word matches a misspelled word.</p>
|
|
6347
|
-
*
|
|
6297
|
+
* <p>This feature is designed with certain defaults or limits. For information on the
|
|
6348
6298
|
* current limits and how to request more support for some limits, see the
|
|
6349
6299
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html">Spell
|
|
6350
6300
|
* Checker documentation</a>.</p>
|
|
@@ -6418,6 +6368,10 @@ export interface UserContext {
|
|
|
6418
6368
|
*/
|
|
6419
6369
|
DataSourceGroups?: DataSourceGroup[];
|
|
6420
6370
|
}
|
|
6371
|
+
export declare enum QueryResultFormat {
|
|
6372
|
+
TABLE = "TABLE",
|
|
6373
|
+
TEXT = "TEXT"
|
|
6374
|
+
}
|
|
6421
6375
|
export declare enum ScoreConfidence {
|
|
6422
6376
|
HIGH = "HIGH",
|
|
6423
6377
|
LOW = "LOW",
|
|
@@ -6436,6 +6390,68 @@ export interface ScoreAttributes {
|
|
|
6436
6390
|
*/
|
|
6437
6391
|
ScoreConfidence?: ScoreConfidence | string;
|
|
6438
6392
|
}
|
|
6393
|
+
/**
|
|
6394
|
+
* <p>Provides information about a table cell in a
|
|
6395
|
+
* table excerpt.</p>
|
|
6396
|
+
*/
|
|
6397
|
+
export interface TableCell {
|
|
6398
|
+
/**
|
|
6399
|
+
* <p>The actual value or content within a table cell.
|
|
6400
|
+
* A table cell could contain a date value of a year,
|
|
6401
|
+
* or a string value of text, for example.</p>
|
|
6402
|
+
*/
|
|
6403
|
+
Value?: string;
|
|
6404
|
+
/**
|
|
6405
|
+
* <p>
|
|
6406
|
+
* <code>TRUE</code> if the response of the table
|
|
6407
|
+
* cell is the top answer. This is the cell value or
|
|
6408
|
+
* content with the highest confidence score or is the
|
|
6409
|
+
* most relevant to the query.</p>
|
|
6410
|
+
*/
|
|
6411
|
+
TopAnswer?: boolean;
|
|
6412
|
+
/**
|
|
6413
|
+
* <p>
|
|
6414
|
+
* <code>TRUE</code> means that the table cell has a
|
|
6415
|
+
* high enough confidence and is relevant to the query,
|
|
6416
|
+
* so the value or content should be highlighted.</p>
|
|
6417
|
+
*/
|
|
6418
|
+
Highlighted?: boolean;
|
|
6419
|
+
/**
|
|
6420
|
+
* <p>
|
|
6421
|
+
* <code>TRUE</code> means that the table cell should
|
|
6422
|
+
* be treated as a header.</p>
|
|
6423
|
+
*/
|
|
6424
|
+
Header?: boolean;
|
|
6425
|
+
}
|
|
6426
|
+
/**
|
|
6427
|
+
* <p>Information about a row in a table excerpt.</p>
|
|
6428
|
+
*/
|
|
6429
|
+
export interface TableRow {
|
|
6430
|
+
/**
|
|
6431
|
+
* <p>A list of table cells in a row.</p>
|
|
6432
|
+
*/
|
|
6433
|
+
Cells?: TableCell[];
|
|
6434
|
+
}
|
|
6435
|
+
/**
|
|
6436
|
+
* <p>An excerpt from a table within a document. The
|
|
6437
|
+
* table excerpt displays up to five columns and
|
|
6438
|
+
* three rows, depending on how many table cells are
|
|
6439
|
+
* relevant to the query and how many columns are
|
|
6440
|
+
* available in the original table. The top most
|
|
6441
|
+
* relevant cell is displayed in the table excerpt,
|
|
6442
|
+
* along with the next most relevant cells.</p>
|
|
6443
|
+
*/
|
|
6444
|
+
export interface TableExcerpt {
|
|
6445
|
+
/**
|
|
6446
|
+
* <p>A list of rows in the table excerpt.</p>
|
|
6447
|
+
*/
|
|
6448
|
+
Rows?: TableRow[];
|
|
6449
|
+
/**
|
|
6450
|
+
* <p>A count of the number of rows in the original
|
|
6451
|
+
* table within the document.</p>
|
|
6452
|
+
*/
|
|
6453
|
+
TotalNumberOfRows?: number;
|
|
6454
|
+
}
|
|
6439
6455
|
/**
|
|
6440
6456
|
* <p>A single query result.</p>
|
|
6441
6457
|
* <p>A query result contains information about a document returned by the
|
|
@@ -6445,20 +6461,29 @@ export interface ScoreAttributes {
|
|
|
6445
6461
|
*/
|
|
6446
6462
|
export interface QueryResultItem {
|
|
6447
6463
|
/**
|
|
6448
|
-
* <p>The
|
|
6464
|
+
* <p>The identifier for the query result.</p>
|
|
6449
6465
|
*/
|
|
6450
6466
|
Id?: string;
|
|
6451
6467
|
/**
|
|
6452
|
-
* <p>The type of document.
|
|
6468
|
+
* <p>The type of document within the response. For example, a response
|
|
6469
|
+
* could include a question-answer that's relevant to the query.</p>
|
|
6453
6470
|
*/
|
|
6454
6471
|
Type?: QueryResultType | string;
|
|
6472
|
+
/**
|
|
6473
|
+
* <p>If the <code>Type</code> of document within the response is
|
|
6474
|
+
* <code>ANSWER</code>, then it is either a <code>TABLE</code> answer or
|
|
6475
|
+
* <code>TEXT</code> answer. If it's a table answer, a table excerpt is
|
|
6476
|
+
* returned in <code>TableExcerpt</code>. If it's a text answer, a text
|
|
6477
|
+
* excerpt is returned in <code>DocumentExcerpt</code>.</p>
|
|
6478
|
+
*/
|
|
6479
|
+
Format?: QueryResultFormat | string;
|
|
6455
6480
|
/**
|
|
6456
6481
|
* <p>One or more additional attributes associated with the query
|
|
6457
6482
|
* result.</p>
|
|
6458
6483
|
*/
|
|
6459
6484
|
AdditionalAttributes?: AdditionalResultAttribute[];
|
|
6460
6485
|
/**
|
|
6461
|
-
* <p>The
|
|
6486
|
+
* <p>The identifier for the document.</p>
|
|
6462
6487
|
*/
|
|
6463
6488
|
DocumentId?: string;
|
|
6464
6489
|
/**
|
|
@@ -6496,10 +6521,14 @@ export interface QueryResultItem {
|
|
|
6496
6521
|
/**
|
|
6497
6522
|
* <p>A token that identifies a particular result from a particular query.
|
|
6498
6523
|
* Use this token to provide click-through feedback for the result. For
|
|
6499
|
-
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">
|
|
6524
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">Submitting feedback
|
|
6500
6525
|
* </a>.</p>
|
|
6501
6526
|
*/
|
|
6502
6527
|
FeedbackToken?: string;
|
|
6528
|
+
/**
|
|
6529
|
+
* <p>An excerpt from a table within a document.</p>
|
|
6530
|
+
*/
|
|
6531
|
+
TableExcerpt?: TableExcerpt;
|
|
6503
6532
|
}
|
|
6504
6533
|
/**
|
|
6505
6534
|
* <p>A corrected misspelled word in a query.</p>
|
|
@@ -6554,7 +6583,8 @@ export interface Warning {
|
|
|
6554
6583
|
Code?: WarningCode | string;
|
|
6555
6584
|
}
|
|
6556
6585
|
/**
|
|
6557
|
-
* <p
|
|
6586
|
+
* <p>The resource you want to use is currently in use. Please check you have provided the
|
|
6587
|
+
* correct resource and try again.</p>
|
|
6558
6588
|
*/
|
|
6559
6589
|
export declare class ResourceInUseException extends __BaseException {
|
|
6560
6590
|
readonly name: "ResourceInUseException";
|
|
@@ -6599,7 +6629,7 @@ export interface StopDataSourceSyncJobRequest {
|
|
|
6599
6629
|
*/
|
|
6600
6630
|
export interface ClickFeedback {
|
|
6601
6631
|
/**
|
|
6602
|
-
* <p>The
|
|
6632
|
+
* <p>The identifier of the search result that was clicked.</p>
|
|
6603
6633
|
*/
|
|
6604
6634
|
ResultId: string | undefined;
|
|
6605
6635
|
/**
|
|
@@ -6617,7 +6647,7 @@ export declare enum RelevanceType {
|
|
|
6617
6647
|
*/
|
|
6618
6648
|
export interface RelevanceFeedback {
|
|
6619
6649
|
/**
|
|
6620
|
-
* <p>The
|
|
6650
|
+
* <p>The identifier of the search result that the user provided relevance feedback
|
|
6621
6651
|
* for.</p>
|
|
6622
6652
|
*/
|
|
6623
6653
|
ResultId: string | undefined;
|
|
@@ -6755,7 +6785,7 @@ export interface UpdateDataSourceRequest {
|
|
|
6755
6785
|
/**
|
|
6756
6786
|
* <p>Configuration information you want to update for altering document metadata
|
|
6757
6787
|
* and content during the document ingestion process.</p>
|
|
6758
|
-
*
|
|
6788
|
+
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
6759
6789
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
6760
6790
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
6761
6791
|
* document metadata during the ingestion process</a>.</p>
|
|
@@ -6801,9 +6831,8 @@ export interface UpdateIndexRequest {
|
|
|
6801
6831
|
*/
|
|
6802
6832
|
Name?: string;
|
|
6803
6833
|
/**
|
|
6804
|
-
* <p>An Identity and Access Management (IAM) role that
|
|
6805
|
-
*
|
|
6806
|
-
* logs and metrics.</p>
|
|
6834
|
+
* <p>An Identity and Access Management (IAM) role that gives Amazon Kendra
|
|
6835
|
+
* permission to access Amazon CloudWatch logs and metrics.</p>
|
|
6807
6836
|
*/
|
|
6808
6837
|
RoleArn?: string;
|
|
6809
6838
|
/**
|
|
@@ -6811,18 +6840,17 @@ export interface UpdateIndexRequest {
|
|
|
6811
6840
|
*/
|
|
6812
6841
|
Description?: string;
|
|
6813
6842
|
/**
|
|
6814
|
-
* <p>The document metadata configuration you want to update for the index.
|
|
6815
|
-
*
|
|
6816
|
-
*
|
|
6843
|
+
* <p>The document metadata configuration you want to update for the index. Document metadata
|
|
6844
|
+
* are fields or attributes associated with your documents. For example, the company department
|
|
6845
|
+
* name associated with each document.</p>
|
|
6817
6846
|
*/
|
|
6818
6847
|
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
6819
6848
|
/**
|
|
6820
|
-
* <p>Sets the number of additional document storage and query capacity
|
|
6821
|
-
*
|
|
6822
|
-
*
|
|
6823
|
-
* <p>If you are using extra storage units, you can't reduce the storage
|
|
6824
|
-
*
|
|
6825
|
-
* index.</p>
|
|
6849
|
+
* <p>Sets the number of additional document storage and query capacity units that should be
|
|
6850
|
+
* used by the index. You can change the capacity of the index up to 5 times per day, or make 5
|
|
6851
|
+
* API calls.</p>
|
|
6852
|
+
* <p>If you are using extra storage units, you can't reduce the storage capacity below what is
|
|
6853
|
+
* required to meet the storage needs for your index.</p>
|
|
6826
6854
|
*/
|
|
6827
6855
|
CapacityUnits?: CapacityUnitsConfiguration;
|
|
6828
6856
|
/**
|
|
@@ -6859,12 +6887,12 @@ export interface UpdateQuerySuggestionsBlockListRequest {
|
|
|
6859
6887
|
Description?: string;
|
|
6860
6888
|
/**
|
|
6861
6889
|
* <p>The S3 path where your block list text file sits in S3.</p>
|
|
6862
|
-
*
|
|
6890
|
+
* <p>If you update your block list and provide the same path to the
|
|
6863
6891
|
* block list text file in S3, then Amazon Kendra reloads the file to refresh
|
|
6864
6892
|
* the block list. Amazon Kendra does not automatically refresh your block list.
|
|
6865
6893
|
* You need to call the <code>UpdateQuerySuggestionsBlockList</code> API
|
|
6866
6894
|
* to refresh you block list.</p>
|
|
6867
|
-
*
|
|
6895
|
+
* <p>If you update your block list, then Amazon Kendra asynchronously refreshes
|
|
6868
6896
|
* all query suggestions with the latest content in the S3 file. This
|
|
6869
6897
|
* means changes might not take effect immediately.</p>
|
|
6870
6898
|
*/
|
|
@@ -6875,149 +6903,6 @@ export interface UpdateQuerySuggestionsBlockListRequest {
|
|
|
6875
6903
|
*/
|
|
6876
6904
|
RoleArn?: string;
|
|
6877
6905
|
}
|
|
6878
|
-
export interface UpdateQuerySuggestionsConfigRequest {
|
|
6879
|
-
/**
|
|
6880
|
-
* <p> The identifier of the index with query suggestions you want to update.</p>
|
|
6881
|
-
*/
|
|
6882
|
-
IndexId: string | undefined;
|
|
6883
|
-
/**
|
|
6884
|
-
* <p>Set the mode to <code>ENABLED</code> or <code>LEARN_ONLY</code>.</p>
|
|
6885
|
-
* <p>By default, Amazon Kendra enables query suggestions.
|
|
6886
|
-
* <code>LEARN_ONLY</code> mode allows you to turn off query suggestions.
|
|
6887
|
-
* You can to update this at any time.</p>
|
|
6888
|
-
* <p>In <code>LEARN_ONLY</code> mode, Amazon Kendra continues to learn from new
|
|
6889
|
-
* queries to keep suggestions up to date for when you are ready to
|
|
6890
|
-
* switch to ENABLED mode again.</p>
|
|
6891
|
-
*/
|
|
6892
|
-
Mode?: Mode | string;
|
|
6893
|
-
/**
|
|
6894
|
-
* <p>How recent your queries are in your query log time window.</p>
|
|
6895
|
-
* <p>The time window is the number of days from current day to past days.</p>
|
|
6896
|
-
* <p>By default, Amazon Kendra sets this to 180.</p>
|
|
6897
|
-
*/
|
|
6898
|
-
QueryLogLookBackWindowInDays?: number;
|
|
6899
|
-
/**
|
|
6900
|
-
* <p>
|
|
6901
|
-
* <code>TRUE</code> to include queries without user information (i.e. all queries,
|
|
6902
|
-
* irrespective of the user), otherwise <code>FALSE</code> to only include queries
|
|
6903
|
-
* with user information.</p>
|
|
6904
|
-
* <p>If you pass user information to Amazon Kendra along with the queries, you can set this
|
|
6905
|
-
* flag to <code>FALSE</code> and instruct Amazon Kendra to only consider queries with user
|
|
6906
|
-
* information.</p>
|
|
6907
|
-
* <p>If you set to <code>FALSE</code>, Amazon Kendra only considers queries searched at least
|
|
6908
|
-
* <code>MinimumQueryCount</code> times across <code>MinimumNumberOfQueryingUsers</code>
|
|
6909
|
-
* unique users for suggestions.</p>
|
|
6910
|
-
* <p>If you set to <code>TRUE</code>, Amazon Kendra ignores all user information and learns
|
|
6911
|
-
* from all queries.</p>
|
|
6912
|
-
*/
|
|
6913
|
-
IncludeQueriesWithoutUserInformation?: boolean;
|
|
6914
|
-
/**
|
|
6915
|
-
* <p>The minimum number of unique users who must search a query in order for the query
|
|
6916
|
-
* to be eligible to suggest to your users.</p>
|
|
6917
|
-
* <p>Increasing this number might decrease the number of suggestions. However, this
|
|
6918
|
-
* ensures a query is searched by many users and is truly popular to suggest to users.</p>
|
|
6919
|
-
* <p>How you tune this setting depends on your specific needs.</p>
|
|
6920
|
-
*/
|
|
6921
|
-
MinimumNumberOfQueryingUsers?: number;
|
|
6922
|
-
/**
|
|
6923
|
-
* <p>The the minimum number of times a query must be searched in order to be
|
|
6924
|
-
* eligible to suggest to your users.</p>
|
|
6925
|
-
* <p>Decreasing this number increases the number of suggestions. However, this
|
|
6926
|
-
* affects the quality of suggestions as it sets a low bar for a query to be
|
|
6927
|
-
* considered popular to suggest to users.</p>
|
|
6928
|
-
* <p>How you tune this setting depends on your specific needs.</p>
|
|
6929
|
-
*/
|
|
6930
|
-
MinimumQueryCount?: number;
|
|
6931
|
-
}
|
|
6932
|
-
export interface UpdateThesaurusRequest {
|
|
6933
|
-
/**
|
|
6934
|
-
* <p>The identifier of the thesaurus you want to update.</p>
|
|
6935
|
-
*/
|
|
6936
|
-
Id: string | undefined;
|
|
6937
|
-
/**
|
|
6938
|
-
* <p>A new name for the thesaurus.</p>
|
|
6939
|
-
*/
|
|
6940
|
-
Name?: string;
|
|
6941
|
-
/**
|
|
6942
|
-
* <p>The identifier of the index for the thesaurus.</p>
|
|
6943
|
-
*/
|
|
6944
|
-
IndexId: string | undefined;
|
|
6945
|
-
/**
|
|
6946
|
-
* <p>A new description for the thesaurus.</p>
|
|
6947
|
-
*/
|
|
6948
|
-
Description?: string;
|
|
6949
|
-
/**
|
|
6950
|
-
* <p>An IAM role that gives Amazon Kendra permissions to
|
|
6951
|
-
* access thesaurus file specified in <code>SourceS3Path</code>.</p>
|
|
6952
|
-
*/
|
|
6953
|
-
RoleArn?: string;
|
|
6954
|
-
/**
|
|
6955
|
-
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
6956
|
-
*/
|
|
6957
|
-
SourceS3Path?: S3Path;
|
|
6958
|
-
}
|
|
6959
|
-
/**
|
|
6960
|
-
* <p>Information about a document attribute. You can use document
|
|
6961
|
-
* attributes as facets.</p>
|
|
6962
|
-
* <p>For example, the document attribute or facet "Department" includes
|
|
6963
|
-
* the values "HR", "Engineering", and "Accounting". You can display these
|
|
6964
|
-
* values in the search results so that documents can be searched by department.</p>
|
|
6965
|
-
* <p>You can display up to 10 facet values per facet for a query. If you want to
|
|
6966
|
-
* increase this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
6967
|
-
*/
|
|
6968
|
-
export interface Facet {
|
|
6969
|
-
/**
|
|
6970
|
-
* <p>The unique key for the document attribute.</p>
|
|
6971
|
-
*/
|
|
6972
|
-
DocumentAttributeKey?: string;
|
|
6973
|
-
/**
|
|
6974
|
-
* <p>An array of document attributes that are nested facets within a facet.</p>
|
|
6975
|
-
* <p>For example, the document attribute or facet "Department" includes a
|
|
6976
|
-
* value called "Engineering". In addition, the document attribute or
|
|
6977
|
-
* facet "SubDepartment" includes the values "Frontend" and "Backend" for documents
|
|
6978
|
-
* assigned to "Engineering". You can display nested facets in the search results
|
|
6979
|
-
* so that documents can be searched not only by department but also by a sub
|
|
6980
|
-
* department within a department. This helps your users further narrow their
|
|
6981
|
-
* search.</p>
|
|
6982
|
-
* <p>You can only have one nested facet within a facet. If you want to increase
|
|
6983
|
-
* this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
6984
|
-
*/
|
|
6985
|
-
Facets?: Facet[];
|
|
6986
|
-
/**
|
|
6987
|
-
* <p>Maximum number of facet values per facet. The default is 10. You can use
|
|
6988
|
-
* this to limit the number of facet values to less than 10. If you want to
|
|
6989
|
-
* increase the default, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
6990
|
-
*/
|
|
6991
|
-
MaxResults?: number;
|
|
6992
|
-
}
|
|
6993
|
-
/**
|
|
6994
|
-
* <p>Provides the count of documents that match a particular attribute when doing a faceted
|
|
6995
|
-
* search.</p>
|
|
6996
|
-
*/
|
|
6997
|
-
export interface DocumentAttributeValueCountPair {
|
|
6998
|
-
/**
|
|
6999
|
-
* <p>The value of the attribute. For example, "HR".</p>
|
|
7000
|
-
*/
|
|
7001
|
-
DocumentAttributeValue?: DocumentAttributeValue;
|
|
7002
|
-
/**
|
|
7003
|
-
* <p>The number of documents in the response that have the attribute value for the
|
|
7004
|
-
* key.</p>
|
|
7005
|
-
*/
|
|
7006
|
-
Count?: number;
|
|
7007
|
-
/**
|
|
7008
|
-
* <p>Contains the results of a document attribute that is a nested facet. A
|
|
7009
|
-
* <code>FacetResult</code> contains the counts for each facet nested within a
|
|
7010
|
-
* facet.</p>
|
|
7011
|
-
* <p>For example, the document attribute or facet "Department" includes a value called
|
|
7012
|
-
* "Engineering". In addition, the document attribute or facet "SubDepartment" includes the
|
|
7013
|
-
* values "Frontend" and "Backend" for documents assigned to "Engineering". You can display
|
|
7014
|
-
* nested facets in the search results so that documents can be searched not only by
|
|
7015
|
-
* department but also by a sub department within a department. The counts for documents
|
|
7016
|
-
* that belong to "Frontend" and "Backend" within "Engineering" are returned for a
|
|
7017
|
-
* query.</p>
|
|
7018
|
-
*/
|
|
7019
|
-
FacetResults?: FacetResult[];
|
|
7020
|
-
}
|
|
7021
6906
|
/**
|
|
7022
6907
|
* @internal
|
|
7023
6908
|
*/
|
|
@@ -7850,6 +7735,18 @@ export declare const UserContextFilterSensitiveLog: (obj: UserContext) => any;
|
|
|
7850
7735
|
* @internal
|
|
7851
7736
|
*/
|
|
7852
7737
|
export declare const ScoreAttributesFilterSensitiveLog: (obj: ScoreAttributes) => any;
|
|
7738
|
+
/**
|
|
7739
|
+
* @internal
|
|
7740
|
+
*/
|
|
7741
|
+
export declare const TableCellFilterSensitiveLog: (obj: TableCell) => any;
|
|
7742
|
+
/**
|
|
7743
|
+
* @internal
|
|
7744
|
+
*/
|
|
7745
|
+
export declare const TableRowFilterSensitiveLog: (obj: TableRow) => any;
|
|
7746
|
+
/**
|
|
7747
|
+
* @internal
|
|
7748
|
+
*/
|
|
7749
|
+
export declare const TableExcerptFilterSensitiveLog: (obj: TableExcerpt) => any;
|
|
7853
7750
|
/**
|
|
7854
7751
|
* @internal
|
|
7855
7752
|
*/
|
|
@@ -7930,19 +7827,3 @@ export declare const UpdateIndexRequestFilterSensitiveLog: (obj: UpdateIndexRequ
|
|
|
7930
7827
|
* @internal
|
|
7931
7828
|
*/
|
|
7932
7829
|
export declare const UpdateQuerySuggestionsBlockListRequestFilterSensitiveLog: (obj: UpdateQuerySuggestionsBlockListRequest) => any;
|
|
7933
|
-
/**
|
|
7934
|
-
* @internal
|
|
7935
|
-
*/
|
|
7936
|
-
export declare const UpdateQuerySuggestionsConfigRequestFilterSensitiveLog: (obj: UpdateQuerySuggestionsConfigRequest) => any;
|
|
7937
|
-
/**
|
|
7938
|
-
* @internal
|
|
7939
|
-
*/
|
|
7940
|
-
export declare const UpdateThesaurusRequestFilterSensitiveLog: (obj: UpdateThesaurusRequest) => any;
|
|
7941
|
-
/**
|
|
7942
|
-
* @internal
|
|
7943
|
-
*/
|
|
7944
|
-
export declare const FacetFilterSensitiveLog: (obj: Facet) => any;
|
|
7945
|
-
/**
|
|
7946
|
-
* @internal
|
|
7947
|
-
*/
|
|
7948
|
-
export declare const DocumentAttributeValueCountPairFilterSensitiveLog: (obj: DocumentAttributeValueCountPair) => any;
|