cdk-comprehend-s3olap 2.0.23 → 2.0.24
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/.jsii +4 -4
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +13 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +110 -59
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +75 -69
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +4 -2
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +3 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +106 -61
- package/node_modules/aws-sdk/apis/mwaa-2020-07-01.min.json +24 -21
- package/node_modules/aws-sdk/apis/wellarchitected-2020-03-31.min.json +27 -5
- package/node_modules/aws-sdk/apis/workmail-2017-10-01.min.json +228 -61
- package/node_modules/aws-sdk/apis/workmail-2017-10-01.paginators.json +6 -0
- package/node_modules/aws-sdk/clients/athena.d.ts +57 -2
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +12 -3
- package/node_modules/aws-sdk/clients/emr.d.ts +8 -0
- package/node_modules/aws-sdk/clients/glue.d.ts +16 -3
- package/node_modules/aws-sdk/clients/kendra.d.ts +109 -41
- package/node_modules/aws-sdk/clients/mwaa.d.ts +9 -12
- package/node_modules/aws-sdk/clients/pricing.d.ts +3 -3
- package/node_modules/aws-sdk/clients/wellarchitected.d.ts +27 -1
- package/node_modules/aws-sdk/clients/workmail.d.ts +203 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +12 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +21 -10
- package/node_modules/aws-sdk/dist/aws-sdk.js +128 -64
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +92 -92
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/event_listeners.js +10 -0
- package/node_modules/aws-sdk/lib/model/api.js +1 -0
- package/node_modules/aws-sdk/package.json +1 -1
- package/node_modules/esbuild/install.js +4 -4
- package/node_modules/esbuild/lib/main.js +12 -12
- package/node_modules/esbuild/package.json +21 -21
- package/node_modules/esbuild-linux-64/bin/esbuild +0 -0
- package/node_modules/esbuild-linux-64/package.json +1 -1
- package/package.json +4 -4
@@ -324,7 +324,7 @@ declare namespace CustomerProfiles {
|
|
324
324
|
*/
|
325
325
|
ProfileId: uuid;
|
326
326
|
/**
|
327
|
-
* A searchable identifier of a customer profile.
|
327
|
+
* A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.
|
328
328
|
*/
|
329
329
|
KeyName: name;
|
330
330
|
/**
|
@@ -472,6 +472,10 @@ declare namespace CustomerProfiles {
|
|
472
472
|
* How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?
|
473
473
|
*/
|
474
474
|
ConflictResolution?: ConflictResolution;
|
475
|
+
/**
|
476
|
+
* A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
|
477
|
+
*/
|
478
|
+
MinAllowedConfidenceScoreForMerging?: Double0To1;
|
475
479
|
}
|
476
480
|
export interface Batch {
|
477
481
|
/**
|
@@ -862,6 +866,7 @@ declare namespace CustomerProfiles {
|
|
862
866
|
TotalSize?: long;
|
863
867
|
}
|
864
868
|
export type Double = number;
|
869
|
+
export type Double0To1 = number;
|
865
870
|
export interface ExportingConfig {
|
866
871
|
/**
|
867
872
|
* The S3 location where Identity Resolution Jobs write result files.
|
@@ -1005,6 +1010,10 @@ declare namespace CustomerProfiles {
|
|
1005
1010
|
* How the auto-merging process should resolve conflicts between different profiles.
|
1006
1011
|
*/
|
1007
1012
|
ConflictResolution: ConflictResolution;
|
1013
|
+
/**
|
1014
|
+
* Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
|
1015
|
+
*/
|
1016
|
+
MinAllowedConfidenceScoreForMerging?: Double0To1;
|
1008
1017
|
}
|
1009
1018
|
export interface GetAutoMergingPreviewResponse {
|
1010
1019
|
/**
|
@@ -1830,7 +1839,7 @@ declare namespace CustomerProfiles {
|
|
1830
1839
|
*/
|
1831
1840
|
ProfileIds?: ProfileIdList;
|
1832
1841
|
/**
|
1833
|
-
* A number between 0 and 1
|
1842
|
+
* A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.
|
1834
1843
|
*/
|
1835
1844
|
ConfidenceScore?: Double;
|
1836
1845
|
}
|
@@ -2127,7 +2136,7 @@ declare namespace CustomerProfiles {
|
|
2127
2136
|
*/
|
2128
2137
|
Description: text;
|
2129
2138
|
/**
|
2130
|
-
* A unique identifier for the object template.
|
2139
|
+
* A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.
|
2131
2140
|
*/
|
2132
2141
|
TemplateId?: name;
|
2133
2142
|
/**
|
@@ -512,6 +512,10 @@ declare namespace EMR {
|
|
512
512
|
* A list of StepConfig to be executed by the job flow.
|
513
513
|
*/
|
514
514
|
Steps: StepConfigList;
|
515
|
+
/**
|
516
|
+
* The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource. For example, arn:aws:iam::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
|
517
|
+
*/
|
518
|
+
ExecutionRoleArn?: ArnType;
|
515
519
|
}
|
516
520
|
export interface AddJobFlowStepsOutput {
|
517
521
|
/**
|
@@ -3247,6 +3251,10 @@ declare namespace EMR {
|
|
3247
3251
|
* The current execution status details of the cluster step.
|
3248
3252
|
*/
|
3249
3253
|
Status?: StepStatus;
|
3254
|
+
/**
|
3255
|
+
* The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource. For example, arn:aws:iam::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
|
3256
|
+
*/
|
3257
|
+
ExecutionRoleArn?: OptionalArnType;
|
3250
3258
|
}
|
3251
3259
|
export type StepCancellationOption = "SEND_INTERRUPT"|"TERMINATE_PROCESS"|string;
|
3252
3260
|
export interface StepConfig {
|
@@ -2791,7 +2791,7 @@ declare namespace Glue {
|
|
2791
2791
|
*/
|
2792
2792
|
MatchCriteria?: MatchCriteria;
|
2793
2793
|
/**
|
2794
|
-
* These key-value pairs define parameters for the connection: HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host. PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections. USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME". PASSWORD - A password, if one is used, for the user name. ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password. JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use. JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use. JDBC_ENGINE - The name of the JDBC engine to use. JDBC_ENGINE_VERSION - The version of the JDBC engine to use. CONFIG_FILES - (Reserved for future use.) INSTANCE_ID - The instance ID to use. JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source. JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false. CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format. SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate. CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate. CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source. KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself. KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true". KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string. KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
|
2794
|
+
* These key-value pairs define parameters for the connection: HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host. PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections. USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME". PASSWORD - A password, if one is used, for the user name. ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password. JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use. JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use. JDBC_ENGINE - The name of the JDBC engine to use. JDBC_ENGINE_VERSION - The version of the JDBC engine to use. CONFIG_FILES - (Reserved for future use.) INSTANCE_ID - The instance ID to use. JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source. JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false. CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format. SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate. CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate. CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source. SECRET_ID - The secret ID used for the secret manager of credentials. CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection. CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection. CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection. KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself. KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true". KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string. KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false". KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional). KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional). KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional). ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected). ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected). KAFKA_SASL_MECHANISM - "SCRAM-SHA-512" or "GSSAPI". These are the two supported SASL Mechanisms. KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism. KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism. ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected). KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab. KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf. KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration. KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
|
2795
2795
|
*/
|
2796
2796
|
ConnectionProperties?: ConnectionProperties;
|
2797
2797
|
/**
|
@@ -3285,6 +3285,10 @@ declare namespace Glue {
|
|
3285
3285
|
* The metadata for the database.
|
3286
3286
|
*/
|
3287
3287
|
DatabaseInput: DatabaseInput;
|
3288
|
+
/**
|
3289
|
+
* The tags you assign to the database.
|
3290
|
+
*/
|
3291
|
+
Tags?: TagsMap;
|
3288
3292
|
}
|
3289
3293
|
export interface CreateDatabaseResponse {
|
3290
3294
|
}
|
@@ -5292,7 +5296,7 @@ declare namespace Glue {
|
|
5292
5296
|
*/
|
5293
5297
|
Name: NameString;
|
5294
5298
|
/**
|
5295
|
-
* Allows you to retrieve the connection metadata without returning the password. For instance, the
|
5299
|
+
* Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
|
5296
5300
|
*/
|
5297
5301
|
HidePassword?: Boolean;
|
5298
5302
|
}
|
@@ -5322,7 +5326,7 @@ declare namespace Glue {
|
|
5322
5326
|
*/
|
5323
5327
|
Filter?: GetConnectionsFilter;
|
5324
5328
|
/**
|
5325
|
-
* Allows you to retrieve the connection metadata without returning the password. For instance, the
|
5329
|
+
* Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
|
5326
5330
|
*/
|
5327
5331
|
HidePassword?: Boolean;
|
5328
5332
|
/**
|
@@ -10136,6 +10140,9 @@ declare namespace Glue {
|
|
10136
10140
|
* The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
|
10137
10141
|
*/
|
10138
10142
|
Location?: LocationString;
|
10143
|
+
/**
|
10144
|
+
* A list of locations that point to the path where a Delta table is located.
|
10145
|
+
*/
|
10139
10146
|
AdditionalLocations?: LocationStringList;
|
10140
10147
|
/**
|
10141
10148
|
* The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
|
@@ -10288,6 +10295,9 @@ declare namespace Glue {
|
|
10288
10295
|
* The ID of the Data Catalog in which the table resides.
|
10289
10296
|
*/
|
10290
10297
|
CatalogId?: CatalogIdString;
|
10298
|
+
/**
|
10299
|
+
* The ID of the table version.
|
10300
|
+
*/
|
10291
10301
|
VersionId?: VersionString;
|
10292
10302
|
}
|
10293
10303
|
export interface TableError {
|
@@ -11164,6 +11174,9 @@ declare namespace Glue {
|
|
11164
11174
|
* The transaction ID at which to update the table contents.
|
11165
11175
|
*/
|
11166
11176
|
TransactionId?: TransactionIdString;
|
11177
|
+
/**
|
11178
|
+
* The version ID at which to update the table contents.
|
11179
|
+
*/
|
11167
11180
|
VersionId?: VersionString;
|
11168
11181
|
}
|
11169
11182
|
export interface UpdateTableResponse {
|
@@ -44,11 +44,11 @@ declare class Kendra extends Service {
|
|
44
44
|
*/
|
45
45
|
batchGetDocumentStatus(callback?: (err: AWSError, data: Kendra.Types.BatchGetDocumentStatusResponse) => void): Request<Kendra.Types.BatchGetDocumentStatusResponse, AWSError>;
|
46
46
|
/**
|
47
|
-
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
|
47
|
+
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
|
48
48
|
*/
|
49
49
|
batchPutDocument(params: Kendra.Types.BatchPutDocumentRequest, callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
50
50
|
/**
|
51
|
-
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
|
51
|
+
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
|
52
52
|
*/
|
53
53
|
batchPutDocument(callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
54
54
|
/**
|
@@ -60,51 +60,51 @@ declare class Kendra extends Service {
|
|
60
60
|
*/
|
61
61
|
clearQuerySuggestions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
62
62
|
/**
|
63
|
-
* Creates a data source that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
|
63
|
+
* Creates a data source that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
64
64
|
*/
|
65
65
|
createDataSource(params: Kendra.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: Kendra.Types.CreateDataSourceResponse) => void): Request<Kendra.Types.CreateDataSourceResponse, AWSError>;
|
66
66
|
/**
|
67
|
-
* Creates a data source that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
|
67
|
+
* Creates a data source that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
68
68
|
*/
|
69
69
|
createDataSource(callback?: (err: AWSError, data: Kendra.Types.CreateDataSourceResponse) => void): Request<Kendra.Types.CreateDataSourceResponse, AWSError>;
|
70
70
|
/**
|
71
|
-
* Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
|
71
|
+
* Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
|
72
72
|
*/
|
73
73
|
createExperience(params: Kendra.Types.CreateExperienceRequest, callback?: (err: AWSError, data: Kendra.Types.CreateExperienceResponse) => void): Request<Kendra.Types.CreateExperienceResponse, AWSError>;
|
74
74
|
/**
|
75
|
-
* Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
|
75
|
+
* Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
|
76
76
|
*/
|
77
77
|
createExperience(callback?: (err: AWSError, data: Kendra.Types.CreateExperienceResponse) => void): Request<Kendra.Types.CreateExperienceResponse, AWSError>;
|
78
78
|
/**
|
79
|
-
* Creates an new set of frequently asked question (FAQ) questions and answers. Adding FAQs to an index is an asynchronous operation.
|
79
|
+
* Creates an new set of frequently asked question (FAQ) questions and answers. Adding FAQs to an index is an asynchronous operation. For an example of adding an FAQ to an index using Python and Java SDKs, see Using you FAQ file.
|
80
80
|
*/
|
81
81
|
createFaq(params: Kendra.Types.CreateFaqRequest, callback?: (err: AWSError, data: Kendra.Types.CreateFaqResponse) => void): Request<Kendra.Types.CreateFaqResponse, AWSError>;
|
82
82
|
/**
|
83
|
-
* Creates an new set of frequently asked question (FAQ) questions and answers. Adding FAQs to an index is an asynchronous operation.
|
83
|
+
* Creates an new set of frequently asked question (FAQ) questions and answers. Adding FAQs to an index is an asynchronous operation. For an example of adding an FAQ to an index using Python and Java SDKs, see Using you FAQ file.
|
84
84
|
*/
|
85
85
|
createFaq(callback?: (err: AWSError, data: Kendra.Types.CreateFaqResponse) => void): Request<Kendra.Types.CreateFaqResponse, AWSError>;
|
86
86
|
/**
|
87
|
-
* Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.
|
87
|
+
* Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
88
88
|
*/
|
89
89
|
createIndex(params: Kendra.Types.CreateIndexRequest, callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
90
90
|
/**
|
91
|
-
* Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.
|
91
|
+
* Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
92
92
|
*/
|
93
93
|
createIndex(callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
94
94
|
/**
|
95
|
-
* Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
|
95
|
+
* Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
|
96
96
|
*/
|
97
97
|
createQuerySuggestionsBlockList(params: Kendra.Types.CreateQuerySuggestionsBlockListRequest, callback?: (err: AWSError, data: Kendra.Types.CreateQuerySuggestionsBlockListResponse) => void): Request<Kendra.Types.CreateQuerySuggestionsBlockListResponse, AWSError>;
|
98
98
|
/**
|
99
|
-
* Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
|
99
|
+
* Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
|
100
100
|
*/
|
101
101
|
createQuerySuggestionsBlockList(callback?: (err: AWSError, data: Kendra.Types.CreateQuerySuggestionsBlockListResponse) => void): Request<Kendra.Types.CreateQuerySuggestionsBlockListResponse, AWSError>;
|
102
102
|
/**
|
103
|
-
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
|
103
|
+
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format. For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
|
104
104
|
*/
|
105
105
|
createThesaurus(params: Kendra.Types.CreateThesaurusRequest, callback?: (err: AWSError, data: Kendra.Types.CreateThesaurusResponse) => void): Request<Kendra.Types.CreateThesaurusResponse, AWSError>;
|
106
106
|
/**
|
107
|
-
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
|
107
|
+
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format. For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
|
108
108
|
*/
|
109
109
|
createThesaurus(callback?: (err: AWSError, data: Kendra.Types.CreateThesaurusResponse) => void): Request<Kendra.Types.CreateThesaurusResponse, AWSError>;
|
110
110
|
/**
|
@@ -487,6 +487,61 @@ declare namespace Kendra {
|
|
487
487
|
TextWithHighlightsValue?: TextWithHighlights;
|
488
488
|
}
|
489
489
|
export type AdditionalResultAttributeValueType = "TEXT_WITH_HIGHLIGHTS_VALUE"|string;
|
490
|
+
export interface AlfrescoConfiguration {
|
491
|
+
/**
|
492
|
+
* The URL of the Alfresco site. For example, https://hostname:8080.
|
493
|
+
*/
|
494
|
+
SiteUrl: SiteUrl;
|
495
|
+
/**
|
496
|
+
* The identifier of the Alfresco site. For example, my-site.
|
497
|
+
*/
|
498
|
+
SiteId: SiteId;
|
499
|
+
/**
|
500
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys: username—The user name of the Alfresco account. password—The password of the Alfresco account.
|
501
|
+
*/
|
502
|
+
SecretArn: SecretArn;
|
503
|
+
/**
|
504
|
+
* The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco.
|
505
|
+
*/
|
506
|
+
SslCertificateS3Path: S3Path;
|
507
|
+
/**
|
508
|
+
* TRUE to index shared files.
|
509
|
+
*/
|
510
|
+
CrawlSystemFolders?: Boolean;
|
511
|
+
/**
|
512
|
+
* TRUE to index comments of wikis and blogs.
|
513
|
+
*/
|
514
|
+
CrawlComments?: Boolean;
|
515
|
+
/**
|
516
|
+
* Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
|
517
|
+
*/
|
518
|
+
EntityFilter?: EntityFilter;
|
519
|
+
/**
|
520
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
|
521
|
+
*/
|
522
|
+
DocumentLibraryFieldMappings?: DataSourceToIndexFieldMappingList;
|
523
|
+
/**
|
524
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
|
525
|
+
*/
|
526
|
+
BlogFieldMappings?: DataSourceToIndexFieldMappingList;
|
527
|
+
/**
|
528
|
+
* A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
|
529
|
+
*/
|
530
|
+
WikiFieldMappings?: DataSourceToIndexFieldMappingList;
|
531
|
+
/**
|
532
|
+
* A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
533
|
+
*/
|
534
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
535
|
+
/**
|
536
|
+
* A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
537
|
+
*/
|
538
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
539
|
+
/**
|
540
|
+
* Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
|
541
|
+
*/
|
542
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
543
|
+
}
|
544
|
+
export type AlfrescoEntity = "wiki"|"blog"|"documentLibrary"|string;
|
490
545
|
export type AmazonResourceName = string;
|
491
546
|
export type AssociateEntitiesToExperienceFailedEntityList = FailedEntity[];
|
492
547
|
export interface AssociateEntitiesToExperienceRequest {
|
@@ -758,11 +813,11 @@ declare namespace Kendra {
|
|
758
813
|
}
|
759
814
|
export interface CapacityUnitsConfiguration {
|
760
815
|
/**
|
761
|
-
* The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first.
|
816
|
+
* The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
|
762
817
|
*/
|
763
818
|
StorageCapacityUnits: StorageCapacityUnit;
|
764
819
|
/**
|
765
|
-
* The amount of extra query capacity for an index and GetQuerySuggestions capacity. A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
|
820
|
+
* The amount of extra query capacity for an index and GetQuerySuggestions capacity. A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
|
766
821
|
*/
|
767
822
|
QueryCapacityUnits: QueryCapacityUnit;
|
768
823
|
}
|
@@ -812,7 +867,7 @@ declare namespace Kendra {
|
|
812
867
|
export type ConditionOperator = "GreaterThan"|"GreaterThanOrEquals"|"LessThan"|"LessThanOrEquals"|"Equals"|"NotEquals"|"Contains"|"NotContains"|"Exists"|"NotExists"|"BeginsWith"|string;
|
813
868
|
export interface ConfluenceAttachmentConfiguration {
|
814
869
|
/**
|
815
|
-
*
|
870
|
+
* TRUE to index attachments of pages and blogs in Confluence.
|
816
871
|
*/
|
817
872
|
CrawlAttachments?: Boolean;
|
818
873
|
/**
|
@@ -864,11 +919,11 @@ declare namespace Kendra {
|
|
864
919
|
*/
|
865
920
|
ServerUrl: Url;
|
866
921
|
/**
|
867
|
-
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the
|
922
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluemce data source.
|
868
923
|
*/
|
869
924
|
SecretArn: SecretArn;
|
870
925
|
/**
|
871
|
-
*
|
926
|
+
* The version or the type of the Confluence installation to connect to.
|
872
927
|
*/
|
873
928
|
Version: ConfluenceVersion;
|
874
929
|
/**
|
@@ -896,13 +951,13 @@ declare namespace Kendra {
|
|
896
951
|
*/
|
897
952
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
898
953
|
/**
|
899
|
-
*
|
954
|
+
* A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
|
900
955
|
*/
|
901
956
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
902
957
|
}
|
903
958
|
export interface ConfluencePageConfiguration {
|
904
959
|
/**
|
905
|
-
*
|
960
|
+
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata. If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
|
906
961
|
*/
|
907
962
|
PageFieldMappings?: ConfluencePageFieldMappingsList;
|
908
963
|
}
|
@@ -924,11 +979,11 @@ declare namespace Kendra {
|
|
924
979
|
}
|
925
980
|
export interface ConfluenceSpaceConfiguration {
|
926
981
|
/**
|
927
|
-
*
|
982
|
+
* TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
|
928
983
|
*/
|
929
984
|
CrawlPersonalSpaces?: Boolean;
|
930
985
|
/**
|
931
|
-
*
|
986
|
+
* TRUE to index archived spaces.
|
932
987
|
*/
|
933
988
|
CrawlArchivedSpaces?: Boolean;
|
934
989
|
/**
|
@@ -1348,6 +1403,10 @@ declare namespace Kendra {
|
|
1348
1403
|
* Provides the configuration information to connect to GitHub as your data source.
|
1349
1404
|
*/
|
1350
1405
|
GitHubConfiguration?: GitHubConfiguration;
|
1406
|
+
/**
|
1407
|
+
* Provides the configuration information to connect to Alfresco as your data source.
|
1408
|
+
*/
|
1409
|
+
AlfrescoConfiguration?: AlfrescoConfiguration;
|
1351
1410
|
}
|
1352
1411
|
export type DataSourceDateFieldFormat = string;
|
1353
1412
|
export type DataSourceFieldName = string;
|
@@ -1483,7 +1542,7 @@ declare namespace Kendra {
|
|
1483
1542
|
IndexFieldName: IndexFieldName;
|
1484
1543
|
}
|
1485
1544
|
export type DataSourceToIndexFieldMappingList = DataSourceToIndexFieldMapping[];
|
1486
|
-
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|"FSX"|"SLACK"|"BOX"|"QUIP"|"JIRA"|"GITHUB"|string;
|
1545
|
+
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|"FSX"|"SLACK"|"BOX"|"QUIP"|"JIRA"|"GITHUB"|"ALFRESCO"|string;
|
1487
1546
|
export interface DataSourceVpcConfiguration {
|
1488
1547
|
/**
|
1489
1548
|
* A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
|
@@ -2285,6 +2344,7 @@ declare namespace Kendra {
|
|
2285
2344
|
*/
|
2286
2345
|
LastName?: NameType;
|
2287
2346
|
}
|
2347
|
+
export type EntityFilter = AlfrescoEntity[];
|
2288
2348
|
export type EntityId = string;
|
2289
2349
|
export type EntityIdsList = EntityId[];
|
2290
2350
|
export interface EntityPersonaConfiguration {
|
@@ -2862,15 +2922,15 @@ declare namespace Kendra {
|
|
2862
2922
|
export type JiraAccountUrl = string;
|
2863
2923
|
export interface JiraConfiguration {
|
2864
2924
|
/**
|
2865
|
-
* The URL of the Jira account. For example, company.
|
2925
|
+
* The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.
|
2866
2926
|
*/
|
2867
2927
|
JiraAccountUrl: JiraAccountUrl;
|
2868
2928
|
/**
|
2869
|
-
* The Amazon Resource Name (ARN) of
|
2929
|
+
* The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys: jiraId—The Jira username. jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Authentication for a Jira data source.
|
2870
2930
|
*/
|
2871
2931
|
SecretArn: SecretArn;
|
2872
2932
|
/**
|
2873
|
-
*
|
2933
|
+
* TRUE to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira.
|
2874
2934
|
*/
|
2875
2935
|
UseChangeLog?: Boolean;
|
2876
2936
|
/**
|
@@ -3291,7 +3351,7 @@ declare namespace Kendra {
|
|
3291
3351
|
*/
|
3292
3352
|
OrganizationName: OrganizationName;
|
3293
3353
|
/**
|
3294
|
-
*
|
3354
|
+
* The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub.
|
3295
3355
|
*/
|
3296
3356
|
SslCertificateS3Path: S3Path;
|
3297
3357
|
}
|
@@ -3321,7 +3381,7 @@ declare namespace Kendra {
|
|
3321
3381
|
*/
|
3322
3382
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
3323
3383
|
/**
|
3324
|
-
*
|
3384
|
+
* TRUE to disable local groups information.
|
3325
3385
|
*/
|
3326
3386
|
DisableLocalGroups?: Boolean;
|
3327
3387
|
}
|
@@ -3597,19 +3657,19 @@ declare namespace Kendra {
|
|
3597
3657
|
*/
|
3598
3658
|
SecretArn: SecretArn;
|
3599
3659
|
/**
|
3600
|
-
*
|
3660
|
+
* TRUE to index file comments.
|
3601
3661
|
*/
|
3602
3662
|
CrawlFileComments?: Boolean;
|
3603
3663
|
/**
|
3604
|
-
*
|
3664
|
+
* TRUE to index the contents of chat rooms.
|
3605
3665
|
*/
|
3606
3666
|
CrawlChatRooms?: Boolean;
|
3607
3667
|
/**
|
3608
|
-
*
|
3668
|
+
* TRUE to index attachments.
|
3609
3669
|
*/
|
3610
3670
|
CrawlAttachments?: Boolean;
|
3611
3671
|
/**
|
3612
|
-
* The identifier of the Quip
|
3672
|
+
* The identifier of the Quip folders you want to index.
|
3613
3673
|
*/
|
3614
3674
|
FolderIds?: FolderIdList;
|
3615
3675
|
/**
|
@@ -3913,7 +3973,7 @@ declare namespace Kendra {
|
|
3913
3973
|
*/
|
3914
3974
|
HostUrl: ServiceNowHostUrl;
|
3915
3975
|
/**
|
3916
|
-
* The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.
|
3976
|
+
* The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Authentication for a ServiceNow data source.
|
3917
3977
|
*/
|
3918
3978
|
SecretArn: SecretArn;
|
3919
3979
|
/**
|
@@ -3993,19 +4053,19 @@ declare namespace Kendra {
|
|
3993
4053
|
}
|
3994
4054
|
export interface SharePointConfiguration {
|
3995
4055
|
/**
|
3996
|
-
* The version of Microsoft SharePoint that you
|
4056
|
+
* The version of Microsoft SharePoint that you use.
|
3997
4057
|
*/
|
3998
4058
|
SharePointVersion: SharePointVersion;
|
3999
4059
|
/**
|
4000
|
-
* The
|
4060
|
+
* The Microsoft SharePoint site URLs for the documents you want to indext.
|
4001
4061
|
*/
|
4002
4062
|
Urls: SharePointUrlList;
|
4003
4063
|
/**
|
4004
|
-
* The Amazon Resource Name (ARN) of
|
4064
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.
|
4005
4065
|
*/
|
4006
4066
|
SecretArn: SecretArn;
|
4007
4067
|
/**
|
4008
|
-
* TRUE to
|
4068
|
+
* TRUE to index document attachments.
|
4009
4069
|
*/
|
4010
4070
|
CrawlAttachments?: Boolean;
|
4011
4071
|
/**
|
@@ -4013,13 +4073,16 @@ declare namespace Kendra {
|
|
4013
4073
|
*/
|
4014
4074
|
UseChangeLog?: Boolean;
|
4015
4075
|
/**
|
4016
|
-
* A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The regex
|
4076
|
+
* A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The regex applies to the display URL of the SharePoint document.
|
4017
4077
|
*/
|
4018
4078
|
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
4019
4079
|
/**
|
4020
|
-
* A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The regex
|
4080
|
+
* A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index. The regex applies to the display URL of the SharePoint document.
|
4021
4081
|
*/
|
4022
4082
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
4083
|
+
/**
|
4084
|
+
* Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.
|
4085
|
+
*/
|
4023
4086
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
4024
4087
|
/**
|
4025
4088
|
* A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
|
@@ -4030,15 +4093,19 @@ declare namespace Kendra {
|
|
4030
4093
|
*/
|
4031
4094
|
DocumentTitleFieldName?: DataSourceFieldName;
|
4032
4095
|
/**
|
4033
|
-
*
|
4096
|
+
* TRUE to disable local groups information.
|
4034
4097
|
*/
|
4035
4098
|
DisableLocalGroups?: Boolean;
|
4099
|
+
/**
|
4100
|
+
* The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint.
|
4101
|
+
*/
|
4036
4102
|
SslCertificateS3Path?: S3Path;
|
4037
4103
|
}
|
4038
4104
|
export type SharePointUrlList = Url[];
|
4039
4105
|
export type SharePointVersion = "SHAREPOINT_2013"|"SHAREPOINT_2016"|"SHAREPOINT_ONLINE"|string;
|
4040
4106
|
export type SharedDriveId = string;
|
4041
4107
|
export type SinceCrawlDate = string;
|
4108
|
+
export type SiteId = string;
|
4042
4109
|
export type SiteMap = string;
|
4043
4110
|
export interface SiteMapsConfiguration {
|
4044
4111
|
/**
|
@@ -4047,6 +4114,7 @@ declare namespace Kendra {
|
|
4047
4114
|
SiteMaps: SiteMapsList;
|
4048
4115
|
}
|
4049
4116
|
export type SiteMapsList = SiteMap[];
|
4117
|
+
export type SiteUrl = string;
|
4050
4118
|
export interface SlackConfiguration {
|
4051
4119
|
/**
|
4052
4120
|
* The identifier of the team in the Slack workspace. For example, T0123456789. You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....
|