@aws-sdk/client-kendra 3.428.0 → 3.430.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.
|
@@ -92,7 +92,7 @@ export interface Highlight {
|
|
|
92
92
|
* @public
|
|
93
93
|
* <p>The highlight type. </p>
|
|
94
94
|
*/
|
|
95
|
-
Type?: HighlightType
|
|
95
|
+
Type?: HighlightType;
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
98
|
* @public
|
|
@@ -147,7 +147,7 @@ export interface AdditionalResultAttribute {
|
|
|
147
147
|
* @public
|
|
148
148
|
* <p>The data type of the <code>Value</code> property.</p>
|
|
149
149
|
*/
|
|
150
|
-
ValueType: AdditionalResultAttributeValueType |
|
|
150
|
+
ValueType: AdditionalResultAttributeValueType | undefined;
|
|
151
151
|
/**
|
|
152
152
|
* @public
|
|
153
153
|
* <p>An object that contains the attribute value.</p>
|
|
@@ -294,7 +294,7 @@ export interface AlfrescoConfiguration {
|
|
|
294
294
|
* <p>Specify whether to index document libraries, wikis, or blogs. You can specify one or
|
|
295
295
|
* more of these options.</p>
|
|
296
296
|
*/
|
|
297
|
-
EntityFilter?:
|
|
297
|
+
EntityFilter?: AlfrescoEntity[];
|
|
298
298
|
/**
|
|
299
299
|
* @public
|
|
300
300
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
@@ -379,7 +379,7 @@ export interface EntityConfiguration {
|
|
|
379
379
|
* <p>Specifies whether you are configuring a <code>User</code> or a
|
|
380
380
|
* <code>Group</code>.</p>
|
|
381
381
|
*/
|
|
382
|
-
EntityType: EntityType |
|
|
382
|
+
EntityType: EntityType | undefined;
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
385
|
* @public
|
|
@@ -535,7 +535,7 @@ export interface EntityPersonaConfiguration {
|
|
|
535
535
|
* information on these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
|
|
536
536
|
* access to your search page</a>.</p>
|
|
537
537
|
*/
|
|
538
|
-
Persona: Persona |
|
|
538
|
+
Persona: Persona | undefined;
|
|
539
539
|
}
|
|
540
540
|
/**
|
|
541
541
|
* @public
|
|
@@ -670,7 +670,7 @@ export interface AttributeSuggestionsDescribeConfig {
|
|
|
670
670
|
* and you haven't set your <code>SuggestionTypes</code> preference to <code>DOCUMENT_ATTRIBUTES</code>,
|
|
671
671
|
* then Amazon Kendra uses the query history.</p>
|
|
672
672
|
*/
|
|
673
|
-
AttributeSuggestionsMode?: AttributeSuggestionsMode
|
|
673
|
+
AttributeSuggestionsMode?: AttributeSuggestionsMode;
|
|
674
674
|
}
|
|
675
675
|
/**
|
|
676
676
|
* @public
|
|
@@ -765,7 +765,7 @@ export interface AttributeSuggestionsUpdateConfig {
|
|
|
765
765
|
* <code>SuggestionTypes</code> preference to <code>DOCUMENT_ATTRIBUTES</code>, then
|
|
766
766
|
* Amazon Kendra uses the query history.</p>
|
|
767
767
|
*/
|
|
768
|
-
AttributeSuggestionsMode?: AttributeSuggestionsMode
|
|
768
|
+
AttributeSuggestionsMode?: AttributeSuggestionsMode;
|
|
769
769
|
}
|
|
770
770
|
/**
|
|
771
771
|
* @public
|
|
@@ -880,7 +880,7 @@ export interface BatchDeleteDocumentResponseFailedDocument {
|
|
|
880
880
|
* @public
|
|
881
881
|
* <p>The error code for why the document couldn't be removed from the index.</p>
|
|
882
882
|
*/
|
|
883
|
-
ErrorCode?: ErrorCode
|
|
883
|
+
ErrorCode?: ErrorCode;
|
|
884
884
|
/**
|
|
885
885
|
* @public
|
|
886
886
|
* <p>An explanation for why the document couldn't be removed from the index.</p>
|
|
@@ -944,7 +944,7 @@ export interface BatchDeleteFeaturedResultsSetError {
|
|
|
944
944
|
* <p>The error code for why the set of featured results couldn't be removed
|
|
945
945
|
* from the index.</p>
|
|
946
946
|
*/
|
|
947
|
-
ErrorCode: ErrorCode |
|
|
947
|
+
ErrorCode: ErrorCode | undefined;
|
|
948
948
|
/**
|
|
949
949
|
* @public
|
|
950
950
|
* <p>An explanation for why the set of featured results couldn't be removed
|
|
@@ -1059,7 +1059,7 @@ export interface Status {
|
|
|
1059
1059
|
* <p>If the document was submitted for deletion, the status is <code>NOT_FOUND</code> after
|
|
1060
1060
|
* the document is deleted.</p>
|
|
1061
1061
|
*/
|
|
1062
|
-
DocumentStatus?: DocumentStatus
|
|
1062
|
+
DocumentStatus?: DocumentStatus;
|
|
1063
1063
|
/**
|
|
1064
1064
|
* @public
|
|
1065
1065
|
* <p>Indicates the source of the error.</p>
|
|
@@ -1086,7 +1086,7 @@ export interface BatchGetDocumentStatusResponseError {
|
|
|
1086
1086
|
* @public
|
|
1087
1087
|
* <p>Indicates the source of the error.</p>
|
|
1088
1088
|
*/
|
|
1089
|
-
ErrorCode?: ErrorCode
|
|
1089
|
+
ErrorCode?: ErrorCode;
|
|
1090
1090
|
/**
|
|
1091
1091
|
* @public
|
|
1092
1092
|
* <p>States that the API could not get the status of a document. This could be because the
|
|
@@ -1163,7 +1163,7 @@ export interface DocumentAttributeCondition {
|
|
|
1163
1163
|
* <p>The condition operator.</p>
|
|
1164
1164
|
* <p>For example, you can use 'Contains' to partially match a string.</p>
|
|
1165
1165
|
*/
|
|
1166
|
-
Operator: ConditionOperator |
|
|
1166
|
+
Operator: ConditionOperator | undefined;
|
|
1167
1167
|
/**
|
|
1168
1168
|
* @public
|
|
1169
1169
|
* <p>The value used by the operator.</p>
|
|
@@ -1351,12 +1351,12 @@ export interface Principal {
|
|
|
1351
1351
|
* @public
|
|
1352
1352
|
* <p>The type of principal.</p>
|
|
1353
1353
|
*/
|
|
1354
|
-
Type: PrincipalType |
|
|
1354
|
+
Type: PrincipalType | undefined;
|
|
1355
1355
|
/**
|
|
1356
1356
|
* @public
|
|
1357
1357
|
* <p>Whether to allow or deny document access to the principal.</p>
|
|
1358
1358
|
*/
|
|
1359
|
-
Access: ReadAccessType |
|
|
1359
|
+
Access: ReadAccessType | undefined;
|
|
1360
1360
|
/**
|
|
1361
1361
|
* @public
|
|
1362
1362
|
* <p>The identifier of the data source the principal should access documents from.</p>
|
|
@@ -1464,7 +1464,7 @@ export interface Document {
|
|
|
1464
1464
|
* of the HTML documents, you must add the <code>HTML</code> start and closing tags
|
|
1465
1465
|
* (<code><HTML>content</HTML></code>) around the content.</p>
|
|
1466
1466
|
*/
|
|
1467
|
-
ContentType?: ContentType
|
|
1467
|
+
ContentType?: ContentType;
|
|
1468
1468
|
/**
|
|
1469
1469
|
* @public
|
|
1470
1470
|
* <p>The identifier of the access control configuration that you want to apply to the
|
|
@@ -1526,7 +1526,7 @@ export interface BatchPutDocumentResponseFailedDocument {
|
|
|
1526
1526
|
* @public
|
|
1527
1527
|
* <p>The type of error that caused the document to fail to be indexed.</p>
|
|
1528
1528
|
*/
|
|
1529
|
-
ErrorCode?: ErrorCode
|
|
1529
|
+
ErrorCode?: ErrorCode;
|
|
1530
1530
|
/**
|
|
1531
1531
|
* @public
|
|
1532
1532
|
* <p>A description of the reason why the document could not be indexed.</p>
|
|
@@ -1791,7 +1791,7 @@ export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
|
1791
1791
|
* <p>The name of the field in the data source. </p>
|
|
1792
1792
|
* <p>You must first create the index field using the <code>UpdateIndex</code> API. </p>
|
|
1793
1793
|
*/
|
|
1794
|
-
DataSourceFieldName?: ConfluenceAttachmentFieldName
|
|
1794
|
+
DataSourceFieldName?: ConfluenceAttachmentFieldName;
|
|
1795
1795
|
/**
|
|
1796
1796
|
* @public
|
|
1797
1797
|
* <p>The format for date fields in the data source. If the field specified in
|
|
@@ -1873,7 +1873,7 @@ export interface ConfluenceBlogToIndexFieldMapping {
|
|
|
1873
1873
|
* @public
|
|
1874
1874
|
* <p>The name of the field in the data source. </p>
|
|
1875
1875
|
*/
|
|
1876
|
-
DataSourceFieldName?: ConfluenceBlogFieldName
|
|
1876
|
+
DataSourceFieldName?: ConfluenceBlogFieldName;
|
|
1877
1877
|
/**
|
|
1878
1878
|
* @public
|
|
1879
1879
|
* <p>The format for date fields in the data source. If the field specified in
|
|
@@ -1941,7 +1941,7 @@ export interface ConfluencePageToIndexFieldMapping {
|
|
|
1941
1941
|
* @public
|
|
1942
1942
|
* <p>The name of the field in the data source.</p>
|
|
1943
1943
|
*/
|
|
1944
|
-
DataSourceFieldName?: ConfluencePageFieldName
|
|
1944
|
+
DataSourceFieldName?: ConfluencePageFieldName;
|
|
1945
1945
|
/**
|
|
1946
1946
|
* @public
|
|
1947
1947
|
* <p>The format for date fields in the data source. If the field specified in
|
|
@@ -2028,7 +2028,7 @@ export interface ConfluenceSpaceToIndexFieldMapping {
|
|
|
2028
2028
|
* @public
|
|
2029
2029
|
* <p>The name of the field in the data source. </p>
|
|
2030
2030
|
*/
|
|
2031
|
-
DataSourceFieldName?: ConfluenceSpaceFieldName
|
|
2031
|
+
DataSourceFieldName?: ConfluenceSpaceFieldName;
|
|
2032
2032
|
/**
|
|
2033
2033
|
* @public
|
|
2034
2034
|
* <p>The format for date fields in the data source. If the field specified in
|
|
@@ -2132,7 +2132,7 @@ export interface ConfluenceConfiguration {
|
|
|
2132
2132
|
* @public
|
|
2133
2133
|
* <p>The version or the type of Confluence installation to connect to.</p>
|
|
2134
2134
|
*/
|
|
2135
|
-
Version: ConfluenceVersion |
|
|
2135
|
+
Version: ConfluenceVersion | undefined;
|
|
2136
2136
|
/**
|
|
2137
2137
|
* @public
|
|
2138
2138
|
* <p>Configuration information for indexing Confluence spaces.</p>
|
|
@@ -2202,7 +2202,7 @@ export interface ConfluenceConfiguration {
|
|
|
2202
2202
|
* password, or a personal access token. You can use a personal access token for Confluence
|
|
2203
2203
|
* Server.</p>
|
|
2204
2204
|
*/
|
|
2205
|
-
AuthenticationType?: ConfluenceAuthenticationType
|
|
2205
|
+
AuthenticationType?: ConfluenceAuthenticationType;
|
|
2206
2206
|
}
|
|
2207
2207
|
/**
|
|
2208
2208
|
* @public
|
|
@@ -2321,7 +2321,7 @@ export interface SqlConfiguration {
|
|
|
2321
2321
|
* <p>For MySQL databases, you must enable the <code>ansi_quotes</code> option when you set
|
|
2322
2322
|
* this field to <code>DOUBLE_QUOTES</code>.</p>
|
|
2323
2323
|
*/
|
|
2324
|
-
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption
|
|
2324
|
+
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption;
|
|
2325
2325
|
}
|
|
2326
2326
|
/**
|
|
2327
2327
|
* @public
|
|
@@ -2333,7 +2333,7 @@ export interface DatabaseConfiguration {
|
|
|
2333
2333
|
* @public
|
|
2334
2334
|
* <p>The type of database engine that runs the database.</p>
|
|
2335
2335
|
*/
|
|
2336
|
-
DatabaseEngineType: DatabaseEngineType |
|
|
2336
|
+
DatabaseEngineType: DatabaseEngineType | undefined;
|
|
2337
2337
|
/**
|
|
2338
2338
|
* @public
|
|
2339
2339
|
* <p>Configuration information that's required to connect to a database.</p>
|
|
@@ -2393,7 +2393,7 @@ export interface FsxConfiguration {
|
|
|
2393
2393
|
* <p>The Amazon FSx file system type. Windows is currently the only supported
|
|
2394
2394
|
* type.</p>
|
|
2395
2395
|
*/
|
|
2396
|
-
FileSystemType: FsxFileSystemType |
|
|
2396
|
+
FileSystemType: FsxFileSystemType | undefined;
|
|
2397
2397
|
/**
|
|
2398
2398
|
* @public
|
|
2399
2399
|
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.</p>
|
|
@@ -2579,7 +2579,7 @@ export interface GitHubConfiguration {
|
|
|
2579
2579
|
* <p>The type of GitHub service you want to connect to—GitHub Enterprise Cloud
|
|
2580
2580
|
* (SaaS) or GitHub Enterprise Server (on premises).</p>
|
|
2581
2581
|
*/
|
|
2582
|
-
Type?: Type
|
|
2582
|
+
Type?: Type;
|
|
2583
2583
|
/**
|
|
2584
2584
|
* @public
|
|
2585
2585
|
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the
|
|
@@ -2882,7 +2882,7 @@ export interface JiraConfiguration {
|
|
|
2882
2882
|
* <p>Specify whether to crawl comments, attachments, and work logs. You can specify one or
|
|
2883
2883
|
* more of these options.</p>
|
|
2884
2884
|
*/
|
|
2885
|
-
IssueSubEntityFilter?:
|
|
2885
|
+
IssueSubEntityFilter?: IssueSubEntity[];
|
|
2886
2886
|
/**
|
|
2887
2887
|
* @public
|
|
2888
2888
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
|
|
@@ -3282,7 +3282,7 @@ export interface SalesforceChatterFeedConfiguration {
|
|
|
3282
3282
|
* indexed. When you specify <code>STANDARD_USER</code> only documents for Salesforce
|
|
3283
3283
|
* standard users are documented. You can specify both.</p>
|
|
3284
3284
|
*/
|
|
3285
|
-
IncludeFilterTypes?:
|
|
3285
|
+
IncludeFilterTypes?: SalesforceChatterFeedIncludeFilterType[];
|
|
3286
3286
|
}
|
|
3287
3287
|
/**
|
|
3288
3288
|
* @public
|
|
@@ -3365,7 +3365,7 @@ export interface SalesforceKnowledgeArticleConfiguration {
|
|
|
3365
3365
|
* <p>Specifies the document states that should be included when Amazon Kendra indexes
|
|
3366
3366
|
* knowledge articles. You must specify at least one state.</p>
|
|
3367
3367
|
*/
|
|
3368
|
-
IncludedStates:
|
|
3368
|
+
IncludedStates: SalesforceKnowledgeArticleState[] | undefined;
|
|
3369
3369
|
/**
|
|
3370
3370
|
* @public
|
|
3371
3371
|
* <p>Configuration information for standard Salesforce knowledge articles.</p>
|
|
@@ -3431,7 +3431,7 @@ export interface SalesforceStandardObjectConfiguration {
|
|
|
3431
3431
|
* @public
|
|
3432
3432
|
* <p>The name of the standard object.</p>
|
|
3433
3433
|
*/
|
|
3434
|
-
Name: SalesforceStandardObjectName |
|
|
3434
|
+
Name: SalesforceStandardObjectName | undefined;
|
|
3435
3435
|
/**
|
|
3436
3436
|
* @public
|
|
3437
3437
|
* <p>The name of the field in the standard object table that contains the document
|
|
@@ -3713,7 +3713,7 @@ export interface ServiceNowConfiguration {
|
|
|
3713
3713
|
* <p>The identifier of the release that the ServiceNow host is running. If the host is not
|
|
3714
3714
|
* running the <code>LONDON</code> release, use <code>OTHERS</code>.</p>
|
|
3715
3715
|
*/
|
|
3716
|
-
ServiceNowBuildVersion: ServiceNowBuildVersionType |
|
|
3716
|
+
ServiceNowBuildVersion: ServiceNowBuildVersionType | undefined;
|
|
3717
3717
|
/**
|
|
3718
3718
|
* @public
|
|
3719
3719
|
* <p>Configuration information for crawling knowledge articles in the ServiceNow
|
|
@@ -3736,7 +3736,7 @@ export interface ServiceNowConfiguration {
|
|
|
3736
3736
|
* 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
|
|
3737
3737
|
* ServiceNow data source</a>.</p>
|
|
3738
3738
|
*/
|
|
3739
|
-
AuthenticationType?: ServiceNowAuthenticationType
|
|
3739
|
+
AuthenticationType?: ServiceNowAuthenticationType;
|
|
3740
3740
|
}
|
|
3741
3741
|
/**
|
|
3742
3742
|
* @public
|
|
@@ -3774,7 +3774,7 @@ export interface SharePointConfiguration {
|
|
|
3774
3774
|
* @public
|
|
3775
3775
|
* <p>The version of Microsoft SharePoint that you use.</p>
|
|
3776
3776
|
*/
|
|
3777
|
-
SharePointVersion: SharePointVersion |
|
|
3777
|
+
SharePointVersion: SharePointVersion | undefined;
|
|
3778
3778
|
/**
|
|
3779
3779
|
* @public
|
|
3780
3780
|
* <p>The Microsoft SharePoint site URLs for the documents you want to index.</p>
|
|
@@ -3865,7 +3865,7 @@ export interface SharePointConfiguration {
|
|
|
3865
3865
|
* name and password, or OAuth authentication of user name, password, client ID, and client
|
|
3866
3866
|
* secret, or AD App-only authentication of client secret.</p>
|
|
3867
3867
|
*/
|
|
3868
|
-
AuthenticationType?: SharePointOnlineAuthenticationType
|
|
3868
|
+
AuthenticationType?: SharePointOnlineAuthenticationType;
|
|
3869
3869
|
/**
|
|
3870
3870
|
* @public
|
|
3871
3871
|
* <p>Configuration information to connect to your Microsoft SharePoint site URLs via
|
|
@@ -3937,7 +3937,7 @@ export interface SlackConfiguration {
|
|
|
3937
3937
|
* <p>Specify whether to index public channels, private channels, group messages, and direct
|
|
3938
3938
|
* messages. You can specify one or more of these options.</p>
|
|
3939
3939
|
*/
|
|
3940
|
-
SlackEntityList:
|
|
3940
|
+
SlackEntityList: SlackEntity[] | undefined;
|
|
3941
3941
|
/**
|
|
3942
3942
|
* @public
|
|
3943
3943
|
* <p>
|
|
@@ -4089,7 +4089,7 @@ export interface SeedUrlConfiguration {
|
|
|
4089
4089
|
* </ul>
|
|
4090
4090
|
* <p>The default mode is set to <code>HOST_ONLY</code>.</p>
|
|
4091
4091
|
*/
|
|
4092
|
-
WebCrawlerMode?: WebCrawlerMode
|
|
4092
|
+
WebCrawlerMode?: WebCrawlerMode;
|
|
4093
4093
|
}
|
|
4094
4094
|
/**
|
|
4095
4095
|
* @public
|
|
@@ -4484,7 +4484,7 @@ export interface CreateDataSourceRequest {
|
|
|
4484
4484
|
* @public
|
|
4485
4485
|
* <p>The type of data source repository. For example, <code>SHAREPOINT</code>.</p>
|
|
4486
4486
|
*/
|
|
4487
|
-
Type: DataSourceType |
|
|
4487
|
+
Type: DataSourceType | undefined;
|
|
4488
4488
|
/**
|
|
4489
4489
|
* @public
|
|
4490
4490
|
* <p>Configuration information to connect to your data source repository.</p>
|
|
@@ -4747,7 +4747,7 @@ export interface CreateFaqRequest {
|
|
|
4747
4747
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html">Adding questions and
|
|
4748
4748
|
* answers</a>.</p>
|
|
4749
4749
|
*/
|
|
4750
|
-
FileFormat?: FaqFileFormat
|
|
4750
|
+
FileFormat?: FaqFileFormat;
|
|
4751
4751
|
/**
|
|
4752
4752
|
* @public
|
|
4753
4753
|
* <p>A token that you provide to identify the request to create a FAQ. Multiple calls to
|
|
@@ -4839,7 +4839,7 @@ export interface CreateFeaturedResultsSetRequest {
|
|
|
4839
4839
|
* featured results must be unique per featured results set for each index,
|
|
4840
4840
|
* whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
4841
4841
|
*/
|
|
4842
|
-
Status?: FeaturedResultsSetStatus
|
|
4842
|
+
Status?: FeaturedResultsSetStatus;
|
|
4843
4843
|
/**
|
|
4844
4844
|
* @public
|
|
4845
4845
|
* <p>A list of queries for featuring results. For more information on the
|
|
@@ -4895,7 +4895,7 @@ export interface FeaturedResultsSet {
|
|
|
4895
4895
|
* featured results must be unique per featured results set for each index,
|
|
4896
4896
|
* whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
4897
4897
|
*/
|
|
4898
|
-
Status?: FeaturedResultsSetStatus
|
|
4898
|
+
Status?: FeaturedResultsSetStatus;
|
|
4899
4899
|
/**
|
|
4900
4900
|
* @public
|
|
4901
4901
|
* <p>The list of queries for featuring results.</p>
|
|
@@ -5072,7 +5072,7 @@ export interface UserGroupResolutionConfiguration {
|
|
|
5072
5072
|
* IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups
|
|
5073
5073
|
* must exist in an IAM Identity Center identity source in order to use this mode.</p>
|
|
5074
5074
|
*/
|
|
5075
|
-
UserGroupResolutionMode: UserGroupResolutionMode |
|
|
5075
|
+
UserGroupResolutionMode: UserGroupResolutionMode | undefined;
|
|
5076
5076
|
}
|
|
5077
5077
|
/**
|
|
5078
5078
|
* @public
|
|
@@ -5111,7 +5111,7 @@ export interface JwtTokenTypeConfiguration {
|
|
|
5111
5111
|
* @public
|
|
5112
5112
|
* <p>The location of the key.</p>
|
|
5113
5113
|
*/
|
|
5114
|
-
KeyLocation: KeyLocation |
|
|
5114
|
+
KeyLocation: KeyLocation | undefined;
|
|
5115
5115
|
/**
|
|
5116
5116
|
* @public
|
|
5117
5117
|
* <p>The signing key URL.</p>
|
|
@@ -5178,7 +5178,7 @@ export interface CreateIndexRequest {
|
|
|
5178
5178
|
* is <code>ENTERPRISE_EDITION</code>.</p>
|
|
5179
5179
|
* <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>
|
|
5180
5180
|
*/
|
|
5181
|
-
Edition?: IndexEdition
|
|
5181
|
+
Edition?: IndexEdition;
|
|
5182
5182
|
/**
|
|
5183
5183
|
* @public
|
|
5184
5184
|
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access your
|
|
@@ -5234,7 +5234,7 @@ export interface CreateIndexRequest {
|
|
|
5234
5234
|
* </dd>
|
|
5235
5235
|
* </dl>
|
|
5236
5236
|
*/
|
|
5237
|
-
UserContextPolicy?: UserContextPolicy
|
|
5237
|
+
UserContextPolicy?: UserContextPolicy;
|
|
5238
5238
|
/**
|
|
5239
5239
|
* @public
|
|
5240
5240
|
* <p>Gets users and groups from IAM Identity Center (successor to Single Sign-On)
|
|
@@ -5634,7 +5634,7 @@ export interface DescribeDataSourceResponse {
|
|
|
5634
5634
|
* @public
|
|
5635
5635
|
* <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
|
|
5636
5636
|
*/
|
|
5637
|
-
Type?: DataSourceType
|
|
5637
|
+
Type?: DataSourceType;
|
|
5638
5638
|
/**
|
|
5639
5639
|
* @public
|
|
5640
5640
|
* <p>Configuration details for the data source connector. This shows how the data source is
|
|
@@ -5669,7 +5669,7 @@ export interface DescribeDataSourceResponse {
|
|
|
5669
5669
|
* the data source is ready to use. When the status is <code>FAILED</code>, the
|
|
5670
5670
|
* <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
|
|
5671
5671
|
*/
|
|
5672
|
-
Status?: DataSourceStatus
|
|
5672
|
+
Status?: DataSourceStatus;
|
|
5673
5673
|
/**
|
|
5674
5674
|
* @public
|
|
5675
5675
|
* <p>The schedule for Amazon Kendra to update the index.</p>
|
|
@@ -5744,7 +5744,7 @@ export interface ExperienceEndpoint {
|
|
|
5744
5744
|
* is <code>HOME</code>, which is a unique and fully hosted URL to the home page
|
|
5745
5745
|
* of your Amazon Kendra experience.</p>
|
|
5746
5746
|
*/
|
|
5747
|
-
EndpointType?: EndpointType
|
|
5747
|
+
EndpointType?: EndpointType;
|
|
5748
5748
|
/**
|
|
5749
5749
|
* @public
|
|
5750
5750
|
* <p>The endpoint of your Amazon Kendra experience.</p>
|
|
@@ -5820,7 +5820,7 @@ export interface DescribeExperienceResponse {
|
|
|
5820
5820
|
* status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains
|
|
5821
5821
|
* the reason that this failed.</p>
|
|
5822
5822
|
*/
|
|
5823
|
-
Status?: ExperienceStatus
|
|
5823
|
+
Status?: ExperienceStatus;
|
|
5824
5824
|
/**
|
|
5825
5825
|
* @public
|
|
5826
5826
|
* <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
|
|
@@ -5909,7 +5909,7 @@ export interface DescribeFaqResponse {
|
|
|
5909
5909
|
* <p>The status of the FAQ. It is ready to use when the status is
|
|
5910
5910
|
* <code>ACTIVE</code>.</p>
|
|
5911
5911
|
*/
|
|
5912
|
-
Status?: FaqStatus
|
|
5912
|
+
Status?: FaqStatus;
|
|
5913
5913
|
/**
|
|
5914
5914
|
* @public
|
|
5915
5915
|
* <p>The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket
|
|
@@ -5926,7 +5926,7 @@ export interface DescribeFaqResponse {
|
|
|
5926
5926
|
* @public
|
|
5927
5927
|
* <p>The file format used by the input files for the FAQ.</p>
|
|
5928
5928
|
*/
|
|
5929
|
-
FileFormat?: FaqFileFormat
|
|
5929
|
+
FileFormat?: FaqFileFormat;
|
|
5930
5930
|
/**
|
|
5931
5931
|
* @public
|
|
5932
5932
|
* <p>The code for a language. This shows a supported language
|
|
@@ -6025,7 +6025,7 @@ export interface DescribeFeaturedResultsSetResponse {
|
|
|
6025
6025
|
* featured results must be unique per featured results set for each index,
|
|
6026
6026
|
* whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
6027
6027
|
*/
|
|
6028
|
-
Status?: FeaturedResultsSetStatus
|
|
6028
|
+
Status?: FeaturedResultsSetStatus;
|
|
6029
6029
|
/**
|
|
6030
6030
|
* @public
|
|
6031
6031
|
* <p>The list of queries for featuring results. For more information on the
|
|
@@ -6152,7 +6152,7 @@ export interface Relevance {
|
|
|
6152
6152
|
* than a priority 5 task.</p>
|
|
6153
6153
|
* <p>Only applies to <code>LONG</code> and <code>DOUBLE</code> fields.</p>
|
|
6154
6154
|
*/
|
|
6155
|
-
RankOrder?: Order
|
|
6155
|
+
RankOrder?: Order;
|
|
6156
6156
|
/**
|
|
6157
6157
|
* @public
|
|
6158
6158
|
* <p>A list of values that should be given a different boost when they appear in the result
|
|
@@ -6228,7 +6228,7 @@ export interface DocumentMetadataConfiguration {
|
|
|
6228
6228
|
* @public
|
|
6229
6229
|
* <p>The data type of the index field. </p>
|
|
6230
6230
|
*/
|
|
6231
|
-
Type: DocumentAttributeValueType |
|
|
6231
|
+
Type: DocumentAttributeValueType | undefined;
|
|
6232
6232
|
/**
|
|
6233
6233
|
* @public
|
|
6234
6234
|
* <p>Provides tuning parameters to determine how the field affects the search
|
|
@@ -6321,7 +6321,7 @@ export interface DescribeIndexResponse {
|
|
|
6321
6321
|
* <p>The Amazon Kendra edition used for the index. You decide the edition when you create
|
|
6322
6322
|
* the index.</p>
|
|
6323
6323
|
*/
|
|
6324
|
-
Edition?: IndexEdition
|
|
6324
|
+
Edition?: IndexEdition;
|
|
6325
6325
|
/**
|
|
6326
6326
|
* @public
|
|
6327
6327
|
* <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to
|
|
@@ -6340,7 +6340,7 @@ export interface DescribeIndexResponse {
|
|
|
6340
6340
|
* for use. If the <code>Status</code> field value is <code>FAILED</code>, the
|
|
6341
6341
|
* <code>ErrorMessage</code> field contains a message that explains why.</p>
|
|
6342
6342
|
*/
|
|
6343
|
-
Status?: IndexStatus
|
|
6343
|
+
Status?: IndexStatus;
|
|
6344
6344
|
/**
|
|
6345
6345
|
* @public
|
|
6346
6346
|
* <p>The description for the index.</p>
|
|
@@ -6393,7 +6393,7 @@ export interface DescribeIndexResponse {
|
|
|
6393
6393
|
* @public
|
|
6394
6394
|
* <p>The user context policy for the Amazon Kendra index.</p>
|
|
6395
6395
|
*/
|
|
6396
|
-
UserContextPolicy?: UserContextPolicy
|
|
6396
|
+
UserContextPolicy?: UserContextPolicy;
|
|
6397
6397
|
/**
|
|
6398
6398
|
* @public
|
|
6399
6399
|
* <p>Whether you have enabled the configuration for fetching access levels of groups and
|
|
@@ -6451,7 +6451,7 @@ export interface GroupOrderingIdSummary {
|
|
|
6451
6451
|
* can be either <code>PROCESSING</code>, <code>SUCCEEDED</code>, <code>DELETING</code>,
|
|
6452
6452
|
* <code>DELETED</code>, or <code>FAILED</code>.</p>
|
|
6453
6453
|
*/
|
|
6454
|
-
Status?: PrincipalMappingStatus
|
|
6454
|
+
Status?: PrincipalMappingStatus;
|
|
6455
6455
|
/**
|
|
6456
6456
|
* @public
|
|
6457
6457
|
* <p>The Unix timestamp when an action was last updated. An action can be a <code>PUT</code>
|
|
@@ -6591,7 +6591,7 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
6591
6591
|
* <p>The current status of the block list. When the value is
|
|
6592
6592
|
* <code>ACTIVE</code>, the block list is ready for use.</p>
|
|
6593
6593
|
*/
|
|
6594
|
-
Status?: QuerySuggestionsBlockListStatus
|
|
6594
|
+
Status?: QuerySuggestionsBlockListStatus;
|
|
6595
6595
|
/**
|
|
6596
6596
|
* @public
|
|
6597
6597
|
* <p>The error message containing details if there are issues processing
|
|
@@ -6686,7 +6686,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
6686
6686
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a>
|
|
6687
6687
|
* API.</p>
|
|
6688
6688
|
*/
|
|
6689
|
-
Mode?: Mode
|
|
6689
|
+
Mode?: Mode;
|
|
6690
6690
|
/**
|
|
6691
6691
|
* @public
|
|
6692
6692
|
* <p>Whether the status of query suggestions settings is currently
|
|
@@ -6694,7 +6694,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
6694
6694
|
* <p>Active means the current settings apply and Updating means your
|
|
6695
6695
|
* changed settings are in the process of applying.</p>
|
|
6696
6696
|
*/
|
|
6697
|
-
Status?: QuerySuggestionsStatus
|
|
6697
|
+
Status?: QuerySuggestionsStatus;
|
|
6698
6698
|
/**
|
|
6699
6699
|
* @public
|
|
6700
6700
|
* <p>How recent your queries are in your query log time
|
|
@@ -6821,7 +6821,7 @@ export interface DescribeThesaurusResponse {
|
|
|
6821
6821
|
* thesaurus file is still active.
|
|
6822
6822
|
* </p>
|
|
6823
6823
|
*/
|
|
6824
|
-
Status?: ThesaurusStatus
|
|
6824
|
+
Status?: ThesaurusStatus;
|
|
6825
6825
|
/**
|
|
6826
6826
|
* @public
|
|
6827
6827
|
* <p>When the <code>Status</code> field value is <code>FAILED</code>, the
|
|
@@ -7131,14 +7131,14 @@ export interface GetSnapshotsRequest {
|
|
|
7131
7131
|
* </li>
|
|
7132
7132
|
* </ul>
|
|
7133
7133
|
*/
|
|
7134
|
-
Interval: Interval |
|
|
7134
|
+
Interval: Interval | undefined;
|
|
7135
7135
|
/**
|
|
7136
7136
|
* @public
|
|
7137
7137
|
* <p>The metric you want to retrieve. You can specify only one metric per call.</p>
|
|
7138
7138
|
* <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search
|
|
7139
7139
|
* analytics</a>.</p>
|
|
7140
7140
|
*/
|
|
7141
|
-
MetricType: MetricType |
|
|
7141
|
+
MetricType: MetricType | undefined;
|
|
7142
7142
|
/**
|
|
7143
7143
|
* @public
|
|
7144
7144
|
* <p>If the previous response was incomplete (because there is more data to retrieve),
|
|
@@ -7289,7 +7289,7 @@ export interface DataSourceSummary {
|
|
|
7289
7289
|
* @public
|
|
7290
7290
|
* <p>The type of the data source.</p>
|
|
7291
7291
|
*/
|
|
7292
|
-
Type?: DataSourceType
|
|
7292
|
+
Type?: DataSourceType;
|
|
7293
7293
|
/**
|
|
7294
7294
|
* @public
|
|
7295
7295
|
* <p>The Unix timestamp when the data source connector was created.</p>
|
|
@@ -7305,7 +7305,7 @@ export interface DataSourceSummary {
|
|
|
7305
7305
|
* <p>The status of the data source. When the status is <code>ACTIVE</code> the data source is
|
|
7306
7306
|
* ready to use.</p>
|
|
7307
7307
|
*/
|
|
7308
|
-
Status?: DataSourceStatus
|
|
7308
|
+
Status?: DataSourceStatus;
|
|
7309
7309
|
/**
|
|
7310
7310
|
* @public
|
|
7311
7311
|
* <p>The code for a language. This shows a supported language for all documents
|
|
@@ -7386,7 +7386,7 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
7386
7386
|
* <p>Only returns synchronization jobs with the <code>Status</code> field equal to the
|
|
7387
7387
|
* specified status.</p>
|
|
7388
7388
|
*/
|
|
7389
|
-
StatusFilter?: DataSourceSyncJobStatus
|
|
7389
|
+
StatusFilter?: DataSourceSyncJobStatus;
|
|
7390
7390
|
}
|
|
7391
7391
|
/**
|
|
7392
7392
|
* @public
|
|
@@ -7451,7 +7451,7 @@ export interface DataSourceSyncJob {
|
|
|
7451
7451
|
* <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code> fields give
|
|
7452
7452
|
* you the reason for the failure.</p>
|
|
7453
7453
|
*/
|
|
7454
|
-
Status?: DataSourceSyncJobStatus
|
|
7454
|
+
Status?: DataSourceSyncJobStatus;
|
|
7455
7455
|
/**
|
|
7456
7456
|
* @public
|
|
7457
7457
|
* <p>If the <code>Status</code> field is set to <code>ERROR</code>, the
|
|
@@ -7464,7 +7464,7 @@ export interface DataSourceSyncJob {
|
|
|
7464
7464
|
* <p>If the <code>Status</code> field is set to <code>FAILED</code>, the <code>ErrorCode</code>
|
|
7465
7465
|
* field indicates the reason the synchronization failed.</p>
|
|
7466
7466
|
*/
|
|
7467
|
-
ErrorCode?: ErrorCode
|
|
7467
|
+
ErrorCode?: ErrorCode;
|
|
7468
7468
|
/**
|
|
7469
7469
|
* @public
|
|
7470
7470
|
* <p>If the reason that the synchronization failed is due to an error with the underlying data
|
|
@@ -7545,7 +7545,7 @@ export interface PersonasSummary {
|
|
|
7545
7545
|
* these personas, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience">Providing
|
|
7546
7546
|
* access to your search page</a>.</p>
|
|
7547
7547
|
*/
|
|
7548
|
-
Persona?: Persona
|
|
7548
|
+
Persona?: Persona;
|
|
7549
7549
|
/**
|
|
7550
7550
|
* @public
|
|
7551
7551
|
* <p>The Unix timestamp when the summary information was created.</p>
|
|
@@ -7645,7 +7645,7 @@ export interface ExperienceEntitiesSummary {
|
|
|
7645
7645
|
* @public
|
|
7646
7646
|
* <p>Shows the type as <code>User</code> or <code>Group</code>.</p>
|
|
7647
7647
|
*/
|
|
7648
|
-
EntityType?: EntityType
|
|
7648
|
+
EntityType?: EntityType;
|
|
7649
7649
|
/**
|
|
7650
7650
|
* @public
|
|
7651
7651
|
* <p>Information about the user entity.</p>
|
|
@@ -7717,7 +7717,7 @@ export interface ExperiencesSummary {
|
|
|
7717
7717
|
* @public
|
|
7718
7718
|
* <p>The processing status of your Amazon Kendra experience.</p>
|
|
7719
7719
|
*/
|
|
7720
|
-
Status?: ExperienceStatus
|
|
7720
|
+
Status?: ExperienceStatus;
|
|
7721
7721
|
/**
|
|
7722
7722
|
* @public
|
|
7723
7723
|
* <p>The endpoint URLs for your Amazon Kendra experiences. The URLs are unique
|
|
@@ -7785,7 +7785,7 @@ export interface FaqSummary {
|
|
|
7785
7785
|
* <p>The current status of the FAQ. When the status is <code>ACTIVE</code> the FAQ is ready
|
|
7786
7786
|
* for use.</p>
|
|
7787
7787
|
*/
|
|
7788
|
-
Status?: FaqStatus
|
|
7788
|
+
Status?: FaqStatus;
|
|
7789
7789
|
/**
|
|
7790
7790
|
* @public
|
|
7791
7791
|
* <p>The Unix timestamp when the FAQ was created.</p>
|
|
@@ -7800,7 +7800,7 @@ export interface FaqSummary {
|
|
|
7800
7800
|
* @public
|
|
7801
7801
|
* <p>The file type used to create the FAQ. </p>
|
|
7802
7802
|
*/
|
|
7803
|
-
FileFormat?: FaqFileFormat
|
|
7803
|
+
FileFormat?: FaqFileFormat;
|
|
7804
7804
|
/**
|
|
7805
7805
|
* @public
|
|
7806
7806
|
* <p>The code for a language. This shows a supported language for the FAQ document
|
|
@@ -7876,7 +7876,7 @@ export interface FeaturedResultsSetSummary {
|
|
|
7876
7876
|
* featured results must be unique per featured results set for each index,
|
|
7877
7877
|
* whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
7878
7878
|
*/
|
|
7879
|
-
Status?: FeaturedResultsSetStatus
|
|
7879
|
+
Status?: FeaturedResultsSetStatus;
|
|
7880
7880
|
/**
|
|
7881
7881
|
* @public
|
|
7882
7882
|
* <p>The Unix timestamp when the set of featured results was last updated.</p>
|
|
@@ -8014,7 +8014,7 @@ export interface IndexConfigurationSummary {
|
|
|
8014
8014
|
* <p>Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
|
|
8015
8015
|
* </p>
|
|
8016
8016
|
*/
|
|
8017
|
-
Edition?: IndexEdition
|
|
8017
|
+
Edition?: IndexEdition;
|
|
8018
8018
|
/**
|
|
8019
8019
|
* @public
|
|
8020
8020
|
* <p>The Unix timestamp when the index was created.</p>
|
|
@@ -8030,7 +8030,7 @@ export interface IndexConfigurationSummary {
|
|
|
8030
8030
|
* <p>The current status of the index. When the status is <code>ACTIVE</code>, the index is
|
|
8031
8031
|
* ready to search.</p>
|
|
8032
8032
|
*/
|
|
8033
|
-
Status: IndexStatus |
|
|
8033
|
+
Status: IndexStatus | undefined;
|
|
8034
8034
|
}
|
|
8035
8035
|
/**
|
|
8036
8036
|
* @public
|
|
@@ -8099,7 +8099,7 @@ export interface QuerySuggestionsBlockListSummary {
|
|
|
8099
8099
|
* @public
|
|
8100
8100
|
* <p>The status of the block list.</p>
|
|
8101
8101
|
*/
|
|
8102
|
-
Status?: QuerySuggestionsBlockListStatus
|
|
8102
|
+
Status?: QuerySuggestionsBlockListStatus;
|
|
8103
8103
|
/**
|
|
8104
8104
|
* @public
|
|
8105
8105
|
* <p>The Unix timestamp when the block list was created.</p>
|
|
@@ -8215,7 +8215,7 @@ export interface ThesaurusSummary {
|
|
|
8215
8215
|
* @public
|
|
8216
8216
|
* <p>The status of the thesaurus.</p>
|
|
8217
8217
|
*/
|
|
8218
|
-
Status?: ThesaurusStatus
|
|
8218
|
+
Status?: ThesaurusStatus;
|
|
8219
8219
|
/**
|
|
8220
8220
|
* @public
|
|
8221
8221
|
* <p>The Unix timestamp when the thesaurus was created.</p>
|
|
@@ -8461,7 +8461,7 @@ export interface SortingConfiguration {
|
|
|
8461
8461
|
* <p>The order that the results should be returned in. In case of ties, the relevance
|
|
8462
8462
|
* assigned to the result by Amazon Kendra is used as the tie-breaker.</p>
|
|
8463
8463
|
*/
|
|
8464
|
-
SortOrder: SortOrder |
|
|
8464
|
+
SortOrder: SortOrder | undefined;
|
|
8465
8465
|
}
|
|
8466
8466
|
/**
|
|
8467
8467
|
* @public
|
|
@@ -8500,7 +8500,7 @@ export interface FeaturedResultsItem {
|
|
|
8500
8500
|
* a response could include a question-answer type that's relevant to the
|
|
8501
8501
|
* query.</p>
|
|
8502
8502
|
*/
|
|
8503
|
-
Type?: QueryResultType
|
|
8503
|
+
Type?: QueryResultType;
|
|
8504
8504
|
/**
|
|
8505
8505
|
* @public
|
|
8506
8506
|
* <p>One or more additional attributes associated with the featured result.</p>
|
|
@@ -8578,7 +8578,7 @@ export interface ScoreAttributes {
|
|
|
8578
8578
|
* @public
|
|
8579
8579
|
* <p>A relative ranking for how relevant the response is to the query.</p>
|
|
8580
8580
|
*/
|
|
8581
|
-
ScoreConfidence?: ScoreConfidence
|
|
8581
|
+
ScoreConfidence?: ScoreConfidence;
|
|
8582
8582
|
}
|
|
8583
8583
|
/**
|
|
8584
8584
|
* @public
|