You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Kendra

Inherits:
AWS.Service show all
Identifier:
kendra
API Version:
2019-02-03
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Kendra is a service for indexing large document sets.

Sending a Request Using Kendra

var kendra = new AWS.Kendra();
kendra.batchDeleteDocument(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Kendra object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kendra = new AWS.Kendra({apiVersion: '2019-02-03'});

You can also set the API version globally in AWS.config.apiVersions using the kendra service identifier:

AWS.config.apiVersions = {
  kendra: '2019-02-03',
  // other service API versions
};

var kendra = new AWS.Kendra();

Version:

  • 2019-02-03

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Kendra(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Kendra object

var kendra = new AWS.Kendra({apiVersion: '2019-02-03'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Kendra.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Kendra.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Kendra.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDeleteDocument(params = {}, callback) ⇒ AWS.Request

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

Service Reference:

Examples:

Calling the batchDeleteDocument operation

var params = {
  DocumentIdList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  IndexId: 'STRING_VALUE', /* required */
  DataSourceSyncJobMetricTarget: {
    DataSourceId: 'STRING_VALUE', /* required */
    DataSourceSyncJobId: 'STRING_VALUE'
  }
};
kendra.batchDeleteDocument(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index that contains the documents to delete.

    • DocumentIdList — (Array<String>)

      One or more identifiers for documents to delete from the index.

    • DataSourceSyncJobMetricTarget — (map)

      Maps a particular data source sync job to a particular data source.

      • DataSourceId — required — (String)

        The ID of the data source that is running the sync job.

      • DataSourceSyncJobId — (String)

        The ID of the sync job that is running on the data source.

        If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.

        If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedDocuments — (Array<map>)

        A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

        • Id — (String)

          The identifier of the document that couldn't be removed from the index.

        • ErrorCode — (String)

          The error code for why the document couldn't be removed from the index.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
        • ErrorMessage — (String)

          An explanation for why the document couldn't be removed from the index.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

batchGetDocumentStatus(params = {}, callback) ⇒ AWS.Request

Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Service Reference:

Examples:

Calling the batchGetDocumentStatus operation

var params = {
  DocumentInfoList: [ /* required */
    {
      DocumentId: 'STRING_VALUE', /* required */
      Attributes: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: { /* required */
            DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
            LongValue: 'NUMBER_VALUE',
            StringListValue: [
              'STRING_VALUE',
              /* more items */
            ],
            StringValue: 'STRING_VALUE'
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  IndexId: 'STRING_VALUE' /* required */
};
kendra.batchGetDocumentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index to add documents to. The index ID is returned by the CreateIndex operation.

    • DocumentInfoList — (Array<map>)

      A list of DocumentInfo objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.

      • DocumentId — required — (String)

        The unique identifier of the document.

      • Attributes — (Array<map>)

        Attributes that identify a specific version of a document to check.

        The only valid attributes are:

        • version

        • datasourceId

        • jobExecutionId

        The attributes follow these rules:

        • dataSourceId and jobExecutionId must be used together.

        • version is ignored if dataSourceId and jobExecutionId are not provided.

        • If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Errors — (Array<map>)

        A list of documents that Amazon Kendra couldn't get the status for. The list includes the ID of the document and the reason that the status couldn't be found.

        • DocumentId — (String)

          The unique identifier of the document whose status could not be retrieved.

        • ErrorCode — (String)

          Indicates the source of the error.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
        • ErrorMessage — (String)

          States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.

      • DocumentStatusList — (Array<map>)

        The status of documents. The status indicates if the document is waiting to be indexed, is in the process of indexing, has completed indexing, or failed indexing. If a document failed indexing, the status provides the reason why.

        • DocumentId — (String)

          The unique identifier of the document.

        • DocumentStatus — (String)

          The current status of a document.

          If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

          Possible values include:
          • "NOT_FOUND"
          • "PROCESSING"
          • "INDEXED"
          • "UPDATED"
          • "FAILED"
          • "UPDATE_FAILED"
        • FailureCode — (String)

          Indicates the source of the error.

        • FailureReason — (String)

          Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

batchPutDocument(params = {}, callback) ⇒ AWS.Request

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation 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.

Service Reference:

Examples:

Calling the batchPutDocument operation

var params = {
  Documents: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      AccessControlList: [
        {
          Access: ALLOW | DENY, /* required */
          Name: 'STRING_VALUE', /* required */
          Type: USER | GROUP, /* required */
          DataSourceId: 'STRING_VALUE'
        },
        /* more items */
      ],
      Attributes: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: { /* required */
            DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
            LongValue: 'NUMBER_VALUE',
            StringListValue: [
              'STRING_VALUE',
              /* more items */
            ],
            StringValue: 'STRING_VALUE'
          }
        },
        /* more items */
      ],
      Blob: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      ContentType: PDF | HTML | MS_WORD | PLAIN_TEXT | PPT,
      HierarchicalAccessControlList: [
        {
          PrincipalList: [ /* required */
            {
              Access: ALLOW | DENY, /* required */
              Name: 'STRING_VALUE', /* required */
              Type: USER | GROUP, /* required */
              DataSourceId: 'STRING_VALUE'
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      S3Path: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE' /* required */
      },
      Title: 'STRING_VALUE'
    },
    /* more items */
  ],
  IndexId: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE'
};
kendra.batchPutDocument(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

    • Documents — (Array<map>)

      One or more documents to add to the index.

      Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

      Documents have the following file size limits.

      • 5 MB total size for inline documents

      • 50 MB total size for files from an S3 bucket

      • 5 MB extracted text for any file

      For more information about file size and transaction per second quotas, see Quotas.

      • Id — required — (String)

        A unique identifier of the document in the index.

      • Title — (String)

        The title of the document.

      • Blob — (Buffer, Typed Array, Blob, String)

        The contents of the document.

        Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

      • S3Path — (map)

        Information required to find a specific file in an Amazon S3 bucket.

        • Bucket — required — (String)

          The name of the S3 bucket that contains the file.

        • Key — required — (String)

          The name of the file.

      • Attributes — (Array<map>)

        Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • AccessControlList — (Array<map>)

        Information on user and group access rights, which is used for user context filtering.

        • Name — required — (String)

          The name of the user or group.

        • Type — required — (String)

          The type of principal.

          Possible values include:
          • "USER"
          • "GROUP"
        • Access — required — (String)

          Whether to allow or deny access to the principal.

          Possible values include:
          • "ALLOW"
          • "DENY"
        • DataSourceId — (String)

          The identifier of the data source the principal should access documents from.

      • HierarchicalAccessControlList — (Array<map>)

        The list of principal lists that define the hierarchy for which documents users should have access to.

        • PrincipalList — required — (Array<map>)

          A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

          • Name — required — (String)

            The name of the user or group.

          • Type — required — (String)

            The type of principal.

            Possible values include:
            • "USER"
            • "GROUP"
          • Access — required — (String)

            Whether to allow or deny access to the principal.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DataSourceId — (String)

            The identifier of the data source the principal should access documents from.

      • ContentType — (String)

        The file type of the document in the Blob field.

        Possible values include:
        • "PDF"
        • "HTML"
        • "MS_WORD"
        • "PLAIN_TEXT"
        • "PPT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedDocuments — (Array<map>)

        A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

        If there was an error adding a document to an index the error is reported in your Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch Logs

        • Id — (String)

          The unique identifier of the document.

        • ErrorCode — (String)

          The type of error that caused the document to fail to be indexed.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
        • ErrorMessage — (String)

          A description of the reason why the document could not be indexed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

clearQuerySuggestions(params = {}, callback) ⇒ AWS.Request

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

Service Reference:

Examples:

Calling the clearQuerySuggestions operation

var params = {
  IndexId: 'STRING_VALUE' /* required */
};
kendra.clearQuerySuggestions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to clear query suggestions from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDataSource(params = {}, callback) ⇒ AWS.Request

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Service Reference:

Examples:

Calling the createDataSource operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Type: S3 | SHAREPOINT | DATABASE | SALESFORCE | ONEDRIVE | SERVICENOW | CUSTOM | CONFLUENCE | GOOGLEDRIVE | WEBCRAWLER | WORKDOCS, /* required */
  ClientToken: 'STRING_VALUE',
  Configuration: {
    ConfluenceConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      ServerUrl: 'STRING_VALUE', /* required */
      Version: CLOUD | SERVER, /* required */
      AttachmentConfiguration: {
        AttachmentFieldMappings: [
          {
            DataSourceFieldName: AUTHOR | CONTENT_TYPE | CREATED_DATE | DISPLAY_URL | FILE_SIZE | ITEM_TYPE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ],
        CrawlAttachments: true || false
      },
      BlogConfiguration: {
        BlogFieldMappings: [
          {
            DataSourceFieldName: AUTHOR | DISPLAY_URL | ITEM_TYPE | LABELS | PUBLISH_DATE | SPACE_KEY | SPACE_NAME | URL | VERSION,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      PageConfiguration: {
        PageFieldMappings: [
          {
            DataSourceFieldName: AUTHOR | CONTENT_STATUS | CREATED_DATE | DISPLAY_URL | ITEM_TYPE | LABELS | MODIFIED_DATE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      SpaceConfiguration: {
        CrawlArchivedSpaces: true || false,
        CrawlPersonalSpaces: true || false,
        ExcludeSpaces: [
          'STRING_VALUE',
          /* more items */
        ],
        IncludeSpaces: [
          'STRING_VALUE',
          /* more items */
        ],
        SpaceFieldMappings: [
          {
            DataSourceFieldName: DISPLAY_URL | ITEM_TYPE | SPACE_KEY | URL,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      VpcConfiguration: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    DatabaseConfiguration: {
      ColumnConfiguration: { /* required */
        ChangeDetectingColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        DocumentDataColumnName: 'STRING_VALUE', /* required */
        DocumentIdColumnName: 'STRING_VALUE', /* required */
        DocumentTitleColumnName: 'STRING_VALUE',
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      ConnectionConfiguration: { /* required */
        DatabaseHost: 'STRING_VALUE', /* required */
        DatabaseName: 'STRING_VALUE', /* required */
        DatabasePort: 'NUMBER_VALUE', /* required */
        SecretArn: 'STRING_VALUE', /* required */
        TableName: 'STRING_VALUE' /* required */
      },
      DatabaseEngineType: RDS_AURORA_MYSQL | RDS_AURORA_POSTGRESQL | RDS_MYSQL | RDS_POSTGRESQL, /* required */
      AclConfiguration: {
        AllowedGroupsColumnName: 'STRING_VALUE' /* required */
      },
      SqlConfiguration: {
        QueryIdentifiersEnclosingOption: DOUBLE_QUOTES | NONE
      },
      VpcConfiguration: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    GoogleDriveConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      ExcludeMimeTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      ExcludeSharedDrives: [
        'STRING_VALUE',
        /* more items */
      ],
      ExcludeUserAccounts: [
        'STRING_VALUE',
        /* more items */
      ],
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    OneDriveConfiguration: {
      OneDriveUsers: { /* required */
        OneDriveUserList: [
          'STRING_VALUE',
          /* more items */
        ],
        OneDriveUserS3Path: {
          Bucket: 'STRING_VALUE', /* required */
          Key: 'STRING_VALUE' /* required */
        }
      },
      SecretArn: 'STRING_VALUE', /* required */
      TenantDomain: 'STRING_VALUE', /* required */
      DisableLocalGroups: true || false,
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    S3Configuration: {
      BucketName: 'STRING_VALUE', /* required */
      AccessControlListConfiguration: {
        KeyPath: 'STRING_VALUE'
      },
      DocumentsMetadataConfiguration: {
        S3Prefix: 'STRING_VALUE'
      },
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      InclusionPrefixes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    SalesforceConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      ServerUrl: 'STRING_VALUE', /* required */
      ChatterFeedConfiguration: {
        DocumentDataFieldName: 'STRING_VALUE', /* required */
        DocumentTitleFieldName: 'STRING_VALUE',
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ],
        IncludeFilterTypes: [
          ACTIVE_USER | STANDARD_USER,
          /* more items */
        ]
      },
      CrawlAttachments: true || false,
      ExcludeAttachmentFilePatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      IncludeAttachmentFilePatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      KnowledgeArticleConfiguration: {
        IncludedStates: [ /* required */
          DRAFT | PUBLISHED | ARCHIVED,
          /* more items */
        ],
        CustomKnowledgeArticleTypeConfigurations: [
          {
            DocumentDataFieldName: 'STRING_VALUE', /* required */
            Name: 'STRING_VALUE', /* required */
            DocumentTitleFieldName: 'STRING_VALUE',
            FieldMappings: [
              {
                DataSourceFieldName: 'STRING_VALUE', /* required */
                IndexFieldName: 'STRING_VALUE', /* required */
                DateFieldFormat: 'STRING_VALUE'
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        StandardKnowledgeArticleTypeConfiguration: {
          DocumentDataFieldName: 'STRING_VALUE', /* required */
          DocumentTitleFieldName: 'STRING_VALUE',
          FieldMappings: [
            {
              DataSourceFieldName: 'STRING_VALUE', /* required */
              IndexFieldName: 'STRING_VALUE', /* required */
              DateFieldFormat: 'STRING_VALUE'
            },
            /* more items */
          ]
        }
      },
      StandardObjectAttachmentConfiguration: {
        DocumentTitleFieldName: 'STRING_VALUE',
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      StandardObjectConfigurations: [
        {
          DocumentDataFieldName: 'STRING_VALUE', /* required */
          Name: ACCOUNT | CAMPAIGN | CASE | CONTACT | CONTRACT | DOCUMENT | GROUP | IDEA | LEAD | OPPORTUNITY | PARTNER | PRICEBOOK | PRODUCT | PROFILE | SOLUTION | TASK | USER, /* required */
          DocumentTitleFieldName: 'STRING_VALUE',
          FieldMappings: [
            {
              DataSourceFieldName: 'STRING_VALUE', /* required */
              IndexFieldName: 'STRING_VALUE', /* required */
              DateFieldFormat: 'STRING_VALUE'
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    ServiceNowConfiguration: {
      HostUrl: 'STRING_VALUE', /* required */
      SecretArn: 'STRING_VALUE', /* required */
      ServiceNowBuildVersion: LONDON | OTHERS, /* required */
      AuthenticationType: HTTP_BASIC | OAUTH2,
      KnowledgeArticleConfiguration: {
        DocumentDataFieldName: 'STRING_VALUE', /* required */
        CrawlAttachments: true || false,
        DocumentTitleFieldName: 'STRING_VALUE',
        ExcludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ],
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ],
        FilterQuery: 'STRING_VALUE',
        IncludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      ServiceCatalogConfiguration: {
        DocumentDataFieldName: 'STRING_VALUE', /* required */
        CrawlAttachments: true || false,
        DocumentTitleFieldName: 'STRING_VALUE',
        ExcludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ],
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ],
        IncludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    SharePointConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      SharePointVersion: SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_ONLINE, /* required */
      Urls: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CrawlAttachments: true || false,
      DisableLocalGroups: true || false,
      DocumentTitleFieldName: 'STRING_VALUE',
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      SslCertificateS3Path: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE' /* required */
      },
      UseChangeLog: true || false,
      VpcConfiguration: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    WebCrawlerConfiguration: {
      Urls: { /* required */
        SeedUrlConfiguration: {
          SeedUrls: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          WebCrawlerMode: HOST_ONLY | SUBDOMAINS | EVERYTHING
        },
        SiteMapsConfiguration: {
          SiteMaps: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      AuthenticationConfiguration: {
        BasicAuthentication: [
          {
            Credentials: 'STRING_VALUE', /* required */
            Host: 'STRING_VALUE', /* required */
            Port: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      CrawlDepth: 'NUMBER_VALUE',
      MaxContentSizePerPageInMegaBytes: 'NUMBER_VALUE',
      MaxLinksPerPage: 'NUMBER_VALUE',
      MaxUrlsPerMinuteCrawlRate: 'NUMBER_VALUE',
      ProxyConfiguration: {
        Host: 'STRING_VALUE', /* required */
        Port: 'NUMBER_VALUE', /* required */
        Credentials: 'STRING_VALUE'
      },
      UrlExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      UrlInclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    WorkDocsConfiguration: {
      OrganizationId: 'STRING_VALUE', /* required */
      CrawlComments: true || false,
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      UseChangeLog: true || false
    }
  },
  Description: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  Schedule: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendra.createDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

    • IndexId — (String)

      The identifier of the index that should be associated with this data source.

    • Type — (String)

      The type of repository that contains the data source.

      Possible values include:
      • "S3"
      • "SHAREPOINT"
      • "DATABASE"
      • "SALESFORCE"
      • "ONEDRIVE"
      • "SERVICENOW"
      • "CUSTOM"
      • "CONFLUENCE"
      • "GOOGLEDRIVE"
      • "WEBCRAWLER"
      • "WORKDOCS"
    • Configuration — (map)

      The connector configuration information that is required to access the repository.

      You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

      The Configuration parameter is required for all other data sources.

      • S3Configuration — (map)

        Provides information to create a data source connector for a document repository in an Amazon S3 bucket.

        • BucketName — required — (String)

          The name of the bucket that contains the documents.

        • InclusionPrefixes — (Array<String>)

          A list of S3 prefixes for the documents that should be included in the index.

        • InclusionPatterns — (Array<String>)

          A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

          Some examples are:

          • .txt will include all text files in a directory (files with the extension .txt).

          • **/.txt will include all text files in a directory and its subdirectories.

          • tax will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

        • ExclusionPatterns — (Array<String>)

          A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

          Some examples are:

          • .png , .jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

          • internal will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

          • /internal will exclude all internal-related files in a directory and its subdirectories.

        • DocumentsMetadataConfiguration — (map)

          Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

          • S3Prefix — (String)

            A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

        • AccessControlListConfiguration — (map)

          Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

          • KeyPath — (String)

            Path to the Amazon Web Services S3 bucket that contains the ACL files.

      • SharePointConfiguration — (map)

        Provides information necessary to create a data source connector for a Microsoft SharePoint site.

        • SharePointVersion — required — (String)

          The version of Microsoft SharePoint that you are using as a data source.

          Possible values include:
          • "SHAREPOINT_2013"
          • "SHAREPOINT_2016"
          • "SHAREPOINT_ONLINE"
        • Urls — required — (Array<String>)

          The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. 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. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

        • CrawlAttachments — (Boolean)

          TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

        • UseChangeLog — (Boolean)

          Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

          The regex is applied to the display URL of the SharePoint document.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

          The regex is applied to the display URL of the SharePoint document.

        • VpcConfiguration — (map)

          Provides information for connecting to an Amazon VPC.

          • SubnetIds — required — (Array<String>)

            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.

          • SecurityGroupIds — required — (Array<String>)

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

        • FieldMappings — (Array<map>)

          A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

        • DocumentTitleFieldName — (String)

          The Microsoft SharePoint attribute field that contains the title of the document.

        • DisableLocalGroups — (Boolean)

          A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

        • SslCertificateS3Path — (map)

          Information required to find a specific file in an Amazon S3 bucket.

          • Bucket — required — (String)

            The name of the S3 bucket that contains the file.

          • Key — required — (String)

            The name of the file.

      • DatabaseConfiguration — (map)

        Provides information necessary to create a data source connector for a database.

        • DatabaseEngineType — required — (String)

          The type of database engine that runs the database.

          Possible values include:
          • "RDS_AURORA_MYSQL"
          • "RDS_AURORA_POSTGRESQL"
          • "RDS_MYSQL"
          • "RDS_POSTGRESQL"
        • ConnectionConfiguration — required — (map)

          The information necessary to connect to a database.

          • DatabaseHost — required — (String)

            The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

          • DatabasePort — required — (Integer)

            The port that the database uses for connections.

          • DatabaseName — required — (String)

            The name of the database containing the document data.

          • TableName — required — (String)

            The name of the table that contains the document data.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

        • VpcConfiguration — (map)

          Provides information for connecting to an Amazon VPC.

          • SubnetIds — required — (Array<String>)

            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.

          • SecurityGroupIds — required — (Array<String>)

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

        • ColumnConfiguration — required — (map)

          Information about where the index should get the document information from the database.

          • DocumentIdColumnName — required — (String)

            The column that provides the document's unique identifier.

          • DocumentDataColumnName — required — (String)

            The column that contains the contents of the document.

          • DocumentTitleColumnName — (String)

            The column that contains the title of the document.

          • FieldMappings — (Array<map>)

            An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • ChangeDetectingColumns — required — (Array<String>)

            One to five columns that indicate when a document in the database has changed.

        • AclConfiguration — (map)

          Information about the database column that provides information for user context filtering.

          • AllowedGroupsColumnName — required — (String)

            A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

        • SqlConfiguration — (map)

          Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

          • QueryIdentifiersEnclosingOption — (String)

            Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

            By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

            PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

            For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

            Possible values include:
            • "DOUBLE_QUOTES"
            • "NONE"
      • SalesforceConfiguration — (map)

        Provides configuration information for data sources that connect to a Salesforce site.

        • ServerUrl — required — (String)

          The instance URL for the Salesforce site that you want to index.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

          • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

          • consumerKey - The application public key generated when you created your Salesforce application.

          • consumerSecret - The application private key generated when you created your Salesforce application.

          • password - The password associated with the user logging in to the Salesforce instance.

          • securityToken - The token associated with the user account logging in to the Salesforce instance.

          • username - The user name of the user logging in to the Salesforce instance.

        • StandardObjectConfigurations — (Array<map>)

          Specifies the Salesforce standard objects that Amazon Kendra indexes.

          • Name — required — (String)

            The name of the standard object.

            Possible values include:
            • "ACCOUNT"
            • "CAMPAIGN"
            • "CASE"
            • "CONTACT"
            • "CONTRACT"
            • "DOCUMENT"
            • "GROUP"
            • "IDEA"
            • "LEAD"
            • "OPPORTUNITY"
            • "PARTNER"
            • "PRICEBOOK"
            • "PRODUCT"
            • "PROFILE"
            • "SOLUTION"
            • "TASK"
            • "USER"
          • DocumentDataFieldName — required — (String)

            The name of the field in the standard object table that contains the document contents.

          • DocumentTitleFieldName — (String)

            The name of the field in the standard object table that contains the document title.

          • FieldMappings — (Array<map>)

            One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

        • KnowledgeArticleConfiguration — (map)

          Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

          • IncludedStates — required — (Array<String>)

            Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

          • StandardKnowledgeArticleTypeConfiguration — (map)

            Provides configuration information for standard Salesforce knowledge articles.

            • DocumentDataFieldName — required — (String)

              The name of the field that contains the document data to index.

            • DocumentTitleFieldName — (String)

              The name of the field that contains the document title.

            • FieldMappings — (Array<map>)

              One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

          • CustomKnowledgeArticleTypeConfigurations — (Array<map>)

            Provides configuration information for custom Salesforce knowledge articles.

            • Name — required — (String)

              The name of the configuration.

            • DocumentDataFieldName — required — (String)

              The name of the field in the custom knowledge article that contains the document data to index.

            • DocumentTitleFieldName — (String)

              The name of the field in the custom knowledge article that contains the document title.

            • FieldMappings — (Array<map>)

              One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

        • ChatterFeedConfiguration — (map)

          Specifies configuration information for Salesforce chatter feeds.

          • DocumentDataFieldName — required — (String)

            The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

          • DocumentTitleFieldName — (String)

            The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

          • FieldMappings — (Array<map>)

            Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • IncludeFilterTypes — (Array<String>)

            Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

        • CrawlAttachments — (Boolean)

          Indicates whether Amazon Kendra should index attachments to Salesforce objects.

        • StandardObjectAttachmentConfiguration — (map)

          Provides configuration information for processing attachments to Salesforce standard objects.

          • DocumentTitleFieldName — (String)

            The name of the field used for the document title.

          • FieldMappings — (Array<map>)

            One or more objects that map fields in attachments to Amazon Kendra index fields.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

        • IncludeAttachmentFilePatterns — (Array<String>)

          A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

          The regex is applied to the name of the attached file.

        • ExcludeAttachmentFilePatterns — (Array<String>)

          A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

          The regex is applied to the name of the attached file.

      • OneDriveConfiguration — (map)

        Provides configuration for data sources that connect to Microsoft OneDrive.

        • TenantDomain — required — (String)

          The Azure Active Directory domain of the organization.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

        • OneDriveUsers — required — (map)

          A list of user accounts whose documents should be indexed.

          • OneDriveUserList — (Array<String>)

            A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain. If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

          • OneDriveUserS3Path — (map)

            The S3 bucket location of a file containing a list of users whose documents should be indexed.

            • Bucket — required — (String)

              The name of the S3 bucket that contains the file.

            • Key — required — (String)

              The name of the file.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

          The exclusion pattern is applied to the file name.

        • ExclusionPatterns — (Array<String>)

          List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.

          The exclusion pattern is applied to the file name.

        • FieldMappings — (Array<map>)

          A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

        • DisableLocalGroups — (Boolean)

          A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

      • ServiceNowConfiguration — (map)

        Provides configuration for data sources that connect to ServiceNow instances.

        • HostUrl — required — (String)

          The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

        • ServiceNowBuildVersion — required — (String)

          The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

          Possible values include:
          • "LONDON"
          • "OTHERS"
        • KnowledgeArticleConfiguration — (map)

          Provides configuration information for crawling knowledge articles in the ServiceNow site.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra should index attachments to knowledge articles.

          • IncludeAttachmentFilePatterns — (Array<String>)

            List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

          • ExcludeAttachmentFilePatterns — (Array<String>)

            List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

          • DocumentDataFieldName — required — (String)

            The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

          • DocumentTitleFieldName — (String)

            The name of the ServiceNow field that is mapped to the index document title field.

          • FieldMappings — (Array<map>)

            Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • FilterQuery — (String)

            A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

            The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

        • ServiceCatalogConfiguration — (map)

          Provides configuration information for crawling service catalogs in the ServiceNow site.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

          • IncludeAttachmentFilePatterns — (Array<String>)

            A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

            The regex is applied to the file name of the attachment.

          • ExcludeAttachmentFilePatterns — (Array<String>)

            A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

            The regex is applied to the file name of the attachment.

          • DocumentDataFieldName — required — (String)

            The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

          • DocumentTitleFieldName — (String)

            The name of the ServiceNow field that is mapped to the index document title field.

          • FieldMappings — (Array<map>)

            Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

        • AuthenticationType — (String)

          Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

          When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

          Possible values include:
          • "HTTP_BASIC"
          • "OAUTH2"
      • ConfluenceConfiguration — (map)

        Provides configuration information for connecting to a Confluence data source.

        • ServerUrl — required — (String)

          The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

          • username - The user name or email address of a user with administrative privileges for the Confluence server.

          • password - The password associated with the user logging in to the Confluence server.

        • Version — required — (String)

          Specifies the version of the Confluence installation that you are connecting to.

          Possible values include:
          • "CLOUD"
          • "SERVER"
        • SpaceConfiguration — (map)

          Specifies configuration information for indexing Confluence spaces.

          • CrawlPersonalSpaces — (Boolean)

            Specifies whether Amazon Kendra should index personal spaces. Users 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.

          • CrawlArchivedSpaces — (Boolean)

            Specifies whether Amazon Kendra should index archived spaces.

          • IncludeSpaces — (Array<String>)

            A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

          • ExcludeSpaces — (Array<String>)

            A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

          • SpaceFieldMappings — (Array<map>)

            Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              Possible values include:
              • "DISPLAY_URL"
              • "ITEM_TYPE"
              • "SPACE_KEY"
              • "URL"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • PageConfiguration — (map)

          Specifies configuration information for indexing Confluence pages.

          • PageFieldMappings — (Array<map>)

            Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              Possible values include:
              • "AUTHOR"
              • "CONTENT_STATUS"
              • "CREATED_DATE"
              • "DISPLAY_URL"
              • "ITEM_TYPE"
              • "LABELS"
              • "MODIFIED_DATE"
              • "PARENT_ID"
              • "SPACE_KEY"
              • "SPACE_NAME"
              • "URL"
              • "VERSION"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • BlogConfiguration — (map)

          Specifies configuration information for indexing Confluence blogs.

          • BlogFieldMappings — (Array<map>)

            Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              Possible values include:
              • "AUTHOR"
              • "DISPLAY_URL"
              • "ITEM_TYPE"
              • "LABELS"
              • "PUBLISH_DATE"
              • "SPACE_KEY"
              • "SPACE_NAME"
              • "URL"
              • "VERSION"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • AttachmentConfiguration — (map)

          Specifies configuration information for indexing attachments to Confluence blogs and pages.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

          • AttachmentFieldMappings — (Array<map>)

            Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              You must first create the index field using the UpdateIndex operation.

              Possible values include:
              • "AUTHOR"
              • "CONTENT_TYPE"
              • "CREATED_DATE"
              • "DISPLAY_URL"
              • "FILE_SIZE"
              • "ITEM_TYPE"
              • "PARENT_ID"
              • "SPACE_KEY"
              • "SPACE_NAME"
              • "URL"
              • "VERSION"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • VpcConfiguration — (map)

          Specifies the information for connecting to an Amazon VPC.

          • SubnetIds — required — (Array<String>)

            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.

          • SecurityGroupIds — required — (Array<String>)

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.

      • GoogleDriveConfiguration — (map)

        Provides configuration for data sources that connect to Google Drive.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.

        • FieldMappings — (Array<map>)

          Defines mapping between a field in the Google Drive and a Amazon Kendra index field.

          If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

        • ExcludeMimeTypes — (Array<String>)

          A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

          For a list of MIME types, see Using a Google Workspace Drive data source.

        • ExcludeUserAccounts — (Array<String>)

          A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

        • ExcludeSharedDrives — (Array<String>)

          A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

      • WebCrawlerConfiguration — (map)

        Provides the configuration information required for Amazon Kendra web crawler.

        • Urls — required — (map)

          Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

          You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

          When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

          • SeedUrlConfiguration — (map)

            Provides the configuration of the seed or starting point URLs of the websites you want to crawl.

            You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

            You can list up to 100 seed URLs.

            • SeedUrls — required — (Array<String>)

              The list of seed or starting point URLs of the websites you want to crawl.

              The list can include a maximum of 100 seed URLs.

            • WebCrawlerMode — (String)

              You can choose one of the following modes:

              • HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

              • SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

              • EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

              The default mode is set to HOST_ONLY.

              Possible values include:
              • "HOST_ONLY"
              • "SUBDOMAINS"
              • "EVERYTHING"
          • SiteMapsConfiguration — (map)

            Provides the configuration of the sitemap URLs of the websites you want to crawl.

            Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

            • SiteMaps — required — (Array<String>)

              The list of sitemap URLs of the websites you want to crawl.

              The list can include a maximum of three sitemap URLs.

        • CrawlDepth — (Integer)

          Specifies the number of levels in a website that you want to crawl.

          The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

          The default crawl depth is set to 2.

        • MaxLinksPerPage — (Integer)

          The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

          As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

          The default maximum links per page is 100.

        • MaxContentSizePerPageInMegaBytes — (Float)

          The maximum size (in MB) of a webpage or attachment to crawl.

          Files larger than this size (in MB) are skipped/not crawled.

          The default maximum size of a webpage or attachment is set to 50 MB.

        • MaxUrlsPerMinuteCrawlRate — (Integer)

          The maximum number of URLs crawled per website host per minute.

          A minimum of one URL is required.

          The default maximum number of URLs crawled per website host per minute is 300.

        • UrlInclusionPatterns — (Array<String>)

          The regular expression pattern to include certain URLs to crawl.

          If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.

        • UrlExclusionPatterns — (Array<String>)

          The regular expression pattern to exclude certain URLs to crawl.

          If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.

        • ProxyConfiguration — (map)

          Provides configuration information required to connect to your internal websites via a web proxy.

          You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

          Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.

          • Host — required — (String)

            The name of the website host you want to connect to via a web proxy server.

            For example, the host name of https://a.example.com/page1.html is "a.example.com".

          • Port — required — (Integer)

            The port number of the website host you want to connect to via a web proxy server.

            For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

          • Credentials — (String)

            Your secret ARN, which you can create in AWS Secrets Manager

            The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

        • AuthenticationConfiguration — (map)

          Provides configuration information required to connect to websites using authentication.

          You can connect to websites using basic authentication of user name and password.

          You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.

          • BasicAuthentication — (Array<map>)

            The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

            The list includes the name and port number of the website host.

            • Host — required — (String)

              The name of the website host you want to connect to using authentication credentials.

              For example, the host name of https://a.example.com/page1.html is "a.example.com".

            • Port — required — (Integer)

              The port number of the website host you want to connect to using authentication credentials.

              For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

            • Credentials — required — (String)

              Your secret ARN, which you can create in AWS Secrets Manager

              You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

      • WorkDocsConfiguration — (map)

        Provides the configuration information to connect to WorkDocs as your data source.

        • OrganizationId — required — (String)

          The identifier of the directory corresponding to your Amazon WorkDocs site repository.

          You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

        • CrawlComments — (Boolean)

          TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

          The default is set to FALSE.

        • UseChangeLog — (Boolean)

          TRUE to use the change logs to update documents in your index instead of scanning all documents.

          If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.

          The default is set to FALSE.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. 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.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. 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.

        • FieldMappings — (Array<map>)

          A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

    • Description — (String)

      A description for the data source.

    • Schedule — (String)

      Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob operation to update the index.

      You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.

      You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

      The RoleArn parameter is required for all other data sources.

    • Tags — (Array<map>)

      A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

      • Value — required — (String)

        The value associated with the tag. The value may be an empty string but it can't be null.

    • ClientToken — (String)

      A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource operation with the same client token will create only one data source.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        A unique identifier for the data source.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFaq(params = {}, callback) ⇒ AWS.Request

Creates an new set of frequently asked question (FAQ) questions and answers.

Service Reference:

Examples:

Calling the createFaq operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  S3Path: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  FileFormat: CSV | CSV_WITH_HEADER | JSON,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendra.createFaq(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index that contains the FAQ.

    • Name — (String)

      The name that should be associated with the FAQ.

    • Description — (String)

      A description of the FAQ.

    • S3Path — (map)

      The S3 location of the FAQ input data.

      • Bucket — required — (String)

        The name of the S3 bucket that contains the file.

      • Key — required — (String)

        The name of the file.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

    • Tags — (Array<map>)

      A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

      • Value — required — (String)

        The value associated with the tag. The value may be an empty string but it can't be null.

    • FileFormat — (String)

      The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

      The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

      For more information, see Adding questions and answers.

      Possible values include:
      • "CSV"
      • "CSV_WITH_HEADER"
      • "JSON"
    • ClientToken — (String)

      A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest operation with the same client token will create only one FAQ.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The unique identifier of the FAQ.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIndex(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. 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 operation or using one of the supported data sources.

Service Reference:

Examples:

Calling the createIndex operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Edition: DEVELOPER_EDITION | ENTERPRISE_EDITION,
  ServerSideEncryptionConfiguration: {
    KmsKeyId: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  UserContextPolicy: ATTRIBUTE_FILTER | USER_TOKEN,
  UserTokenConfigurations: [
    {
      JsonTokenTypeConfiguration: {
        GroupAttributeField: 'STRING_VALUE', /* required */
        UserNameAttributeField: 'STRING_VALUE' /* required */
      },
      JwtTokenTypeConfiguration: {
        KeyLocation: URL | SECRET_MANAGER, /* required */
        ClaimRegex: 'STRING_VALUE',
        GroupAttributeField: 'STRING_VALUE',
        Issuer: 'STRING_VALUE',
        SecretManagerArn: 'STRING_VALUE',
        URL: 'STRING_VALUE',
        UserNameAttributeField: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
kendra.createIndex(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      The name for the new index.

    • Edition — (String)

      The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

      The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

      For more information on quota limits for enterprise and developer editions, see Quotas.

      Possible values include:
      • "DEVELOPER_EDITION"
      • "ENTERPRISE_EDITION"
    • RoleArn — (String)

      An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

    • ServerSideEncryptionConfiguration — (map)

      The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

      • KmsKeyId — (String)

        The identifier of the KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

    • Description — (String)

      A description for the index.

    • ClientToken — (String)

      A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

      • Value — required — (String)

        The value associated with the tag. The value may be an empty string but it can't be null.

    • UserTokenConfigurations — (Array<map>)

      The user token configuration.

      • JwtTokenTypeConfiguration — (map)

        Information about the JWT token type configuration.

        • KeyLocation — required — (String)

          The location of the key.

          Possible values include:
          • "URL"
          • "SECRET_MANAGER"
        • URL — (String)

          The signing key URL.

        • SecretManagerArn — (String)

          The Amazon Resource Name (arn) of the secret.

        • UserNameAttributeField — (String)

          The user name attribute field.

        • GroupAttributeField — (String)

          The group attribute field.

        • Issuer — (String)

          The issuer of the token.

        • ClaimRegex — (String)

          The regular expression that identifies the claim.

      • JsonTokenTypeConfiguration — (map)

        Information about the JSON token type configuration.

        • UserNameAttributeField — required — (String)

          The user name attribute field.

        • GroupAttributeField — required — (String)

          The group attribute field.

    • UserContextPolicy — (String)

      The user context policy.

      ATTRIBUTE_FILTER

      All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

      USER_TOKEN

      Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

      Possible values include:
      • "ATTRIBUTE_FILTER"
      • "USER_TOKEN"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createQuerySuggestionsBlockList(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createQuerySuggestionsBlockList operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  SourceS3Path: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendra.createQuerySuggestionsBlockList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to create a query suggestions block list for.

    • Name — (String)

      A user friendly name for the block list.

      For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

    • Description — (String)

      A user-friendly description for the block list.

      For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

    • SourceS3Path — (map)

      The S3 path to your block list text file in your S3 bucket.

      Each block word or phrase should be on a separate line in a text file.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

      • Bucket — required — (String)

        The name of the S3 bucket that contains the file.

      • Key — required — (String)

        The name of the file.

    • ClientToken — (String)

      A token that you provide to identify the request to create a query suggestions block list.

      If a token is not provided, the SDK will use a version 4 UUID.
    • RoleArn — (String)

      The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

      You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

    • Tags — (Array<map>)

      A tag that you can assign to a block list that categorizes the block list.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

      • Value — required — (String)

        The value associated with the tag. The value may be an empty string but it can't be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The unique identifier of the created block list.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createThesaurus(params = {}, callback) ⇒ AWS.Request

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

Service Reference:

Examples:

Calling the createThesaurus operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  SourceS3Path: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendra.createThesaurus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The unique identifier of the index for the new thesaurus.

    • Name — (String)

      The name for the new thesaurus.

    • Description — (String)

      The description for the new thesaurus.

    • RoleArn — (String)

      An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

    • Tags — (Array<map>)

      A list of key-value pairs that identify the thesaurus. You can use the tags to identify and organize your resources and to control access to resources.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

      • Value — required — (String)

        The value associated with the tag. The value may be an empty string but it can't be null.

    • SourceS3Path — (map)

      The thesaurus file Amazon S3 source path.

      • Bucket — required — (String)

        The name of the S3 bucket that contains the file.

      • Key — required — (String)

        The name of the file.

    • ClientToken — (String)

      A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The unique identifier of the thesaurus.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDataSource(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources.

Service Reference:

Examples:

Calling the deleteDataSource operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.deleteDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The unique identifier of the data source to delete.

    • IndexId — (String)

      The unique identifier of the index associated with the data source.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFaq(params = {}, callback) ⇒ AWS.Request

Removes an FAQ from an index.

Service Reference:

Examples:

Calling the deleteFaq operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.deleteFaq(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the FAQ to remove.

    • IndexId — (String)

      The index to remove the FAQ from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIndex(params = {}, callback) ⇒ AWS.Request

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.

Service Reference:

Examples:

Calling the deleteIndex operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
kendra.deleteIndex(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the index to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePrincipalMapping(params = {}, callback) ⇒ AWS.Request

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

Service Reference:

Examples:

Calling the deletePrincipalMapping operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE',
  OrderingId: 'NUMBER_VALUE'
};
kendra.deletePrincipalMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to delete a group from.

    • DataSourceId — (String)

      The identifier of the data source you want to delete a group from.

      This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

    • GroupId — (String)

      The identifier of the group you want to delete.

    • OrderingId — (Integer)

      The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

      The ordering ID can be the UNIX time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE actions for the same group which are yet to be processed.

      The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteQuerySuggestionsBlockList(params = {}, callback) ⇒ AWS.Request

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

Service Reference:

Examples:

Calling the deleteQuerySuggestionsBlockList operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.deleteQuerySuggestionsBlockList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the you want to delete a block list from.

    • Id — (String)

      The unique identifier of the block list that needs to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteThesaurus(params = {}, callback) ⇒ AWS.Request

Deletes an existing Amazon Kendra thesaurus.

Service Reference:

Examples:

Calling the deleteThesaurus operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.deleteThesaurus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the thesaurus to delete.

    • IndexId — (String)

      The identifier of the index associated with the thesaurus to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDataSource(params = {}, callback) ⇒ AWS.Request

Gets information about a Amazon Kendra data source.

Service Reference:

Examples:

Calling the describeDataSource operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.describeDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The unique identifier of the data source to describe.

    • IndexId — (String)

      The identifier of the index that contains the data source.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The identifier of the data source.

      • IndexId — (String)

        The identifier of the index that contains the data source.

      • Name — (String)

        The name that you gave the data source when it was created.

      • Type — (String)

        The type of the data source.

        Possible values include:
        • "S3"
        • "SHAREPOINT"
        • "DATABASE"
        • "SALESFORCE"
        • "ONEDRIVE"
        • "SERVICENOW"
        • "CUSTOM"
        • "CONFLUENCE"
        • "GOOGLEDRIVE"
        • "WEBCRAWLER"
        • "WORKDOCS"
      • Configuration — (map)

        Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

        • S3Configuration — (map)

          Provides information to create a data source connector for a document repository in an Amazon S3 bucket.

          • BucketName — required — (String)

            The name of the bucket that contains the documents.

          • InclusionPrefixes — (Array<String>)

            A list of S3 prefixes for the documents that should be included in the index.

          • InclusionPatterns — (Array<String>)

            A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

            Some examples are:

            • .txt will include all text files in a directory (files with the extension .txt).

            • **/.txt will include all text files in a directory and its subdirectories.

            • tax will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

          • ExclusionPatterns — (Array<String>)

            A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

            Some examples are:

            • .png , .jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

            • internal will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

            • /internal will exclude all internal-related files in a directory and its subdirectories.

          • DocumentsMetadataConfiguration — (map)

            Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

            • S3Prefix — (String)

              A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

          • AccessControlListConfiguration — (map)

            Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

            • KeyPath — (String)

              Path to the Amazon Web Services S3 bucket that contains the ACL files.

        • SharePointConfiguration — (map)

          Provides information necessary to create a data source connector for a Microsoft SharePoint site.

          • SharePointVersion — required — (String)

            The version of Microsoft SharePoint that you are using as a data source.

            Possible values include:
            • "SHAREPOINT_2013"
            • "SHAREPOINT_2016"
            • "SHAREPOINT_ONLINE"
          • Urls — required — (Array<String>)

            The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. 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. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

          • CrawlAttachments — (Boolean)

            TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

          • UseChangeLog — (Boolean)

            Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

          • InclusionPatterns — (Array<String>)

            A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

            The regex is applied to the display URL of the SharePoint document.

          • ExclusionPatterns — (Array<String>)

            A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

            The regex is applied to the display URL of the SharePoint document.

          • VpcConfiguration — (map)

            Provides information for connecting to an Amazon VPC.

            • SubnetIds — required — (Array<String>)

              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.

            • SecurityGroupIds — required — (Array<String>)

              A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • FieldMappings — (Array<map>)

            A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • DocumentTitleFieldName — (String)

            The Microsoft SharePoint attribute field that contains the title of the document.

          • DisableLocalGroups — (Boolean)

            A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

          • SslCertificateS3Path — (map)

            Information required to find a specific file in an Amazon S3 bucket.

            • Bucket — required — (String)

              The name of the S3 bucket that contains the file.

            • Key — required — (String)

              The name of the file.

        • DatabaseConfiguration — (map)

          Provides information necessary to create a data source connector for a database.

          • DatabaseEngineType — required — (String)

            The type of database engine that runs the database.

            Possible values include:
            • "RDS_AURORA_MYSQL"
            • "RDS_AURORA_POSTGRESQL"
            • "RDS_MYSQL"
            • "RDS_POSTGRESQL"
          • ConnectionConfiguration — required — (map)

            The information necessary to connect to a database.

            • DatabaseHost — required — (String)

              The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

            • DatabasePort — required — (Integer)

              The port that the database uses for connections.

            • DatabaseName — required — (String)

              The name of the database containing the document data.

            • TableName — required — (String)

              The name of the table that contains the document data.

            • SecretArn — required — (String)

              The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

          • VpcConfiguration — (map)

            Provides information for connecting to an Amazon VPC.

            • SubnetIds — required — (Array<String>)

              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.

            • SecurityGroupIds — required — (Array<String>)

              A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • ColumnConfiguration — required — (map)

            Information about where the index should get the document information from the database.

            • DocumentIdColumnName — required — (String)

              The column that provides the document's unique identifier.

            • DocumentDataColumnName — required — (String)

              The column that contains the contents of the document.

            • DocumentTitleColumnName — (String)

              The column that contains the title of the document.

            • FieldMappings — (Array<map>)

              An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

            • ChangeDetectingColumns — required — (Array<String>)

              One to five columns that indicate when a document in the database has changed.

          • AclConfiguration — (map)

            Information about the database column that provides information for user context filtering.

            • AllowedGroupsColumnName — required — (String)

              A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

          • SqlConfiguration — (map)

            Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

            • QueryIdentifiersEnclosingOption — (String)

              Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

              By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

              PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

              For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

              Possible values include:
              • "DOUBLE_QUOTES"
              • "NONE"
        • SalesforceConfiguration — (map)

          Provides configuration information for data sources that connect to a Salesforce site.

          • ServerUrl — required — (String)

            The instance URL for the Salesforce site that you want to index.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

            • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

            • consumerKey - The application public key generated when you created your Salesforce application.

            • consumerSecret - The application private key generated when you created your Salesforce application.

            • password - The password associated with the user logging in to the Salesforce instance.

            • securityToken - The token associated with the user account logging in to the Salesforce instance.

            • username - The user name of the user logging in to the Salesforce instance.

          • StandardObjectConfigurations — (Array<map>)

            Specifies the Salesforce standard objects that Amazon Kendra indexes.

            • Name — required — (String)

              The name of the standard object.

              Possible values include:
              • "ACCOUNT"
              • "CAMPAIGN"
              • "CASE"
              • "CONTACT"
              • "CONTRACT"
              • "DOCUMENT"
              • "GROUP"
              • "IDEA"
              • "LEAD"
              • "OPPORTUNITY"
              • "PARTNER"
              • "PRICEBOOK"
              • "PRODUCT"
              • "PROFILE"
              • "SOLUTION"
              • "TASK"
              • "USER"
            • DocumentDataFieldName — required — (String)

              The name of the field in the standard object table that contains the document contents.

            • DocumentTitleFieldName — (String)

              The name of the field in the standard object table that contains the document title.

            • FieldMappings — (Array<map>)

              One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

          • KnowledgeArticleConfiguration — (map)

            Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

            • IncludedStates — required — (Array<String>)

              Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

            • StandardKnowledgeArticleTypeConfiguration — (map)

              Provides configuration information for standard Salesforce knowledge articles.

              • DocumentDataFieldName — required — (String)

                The name of the field that contains the document data to index.

              • DocumentTitleFieldName — (String)

                The name of the field that contains the document title.

              • FieldMappings — (Array<map>)

                One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

                • DataSourceFieldName — required — (String)

                  The name of the column or attribute in the data source.

                • DateFieldFormat — (String)

                  The type of data stored in the column or attribute.

                • IndexFieldName — required — (String)

                  The name of the field in the index.

            • CustomKnowledgeArticleTypeConfigurations — (Array<map>)

              Provides configuration information for custom Salesforce knowledge articles.

              • Name — required — (String)

                The name of the configuration.

              • DocumentDataFieldName — required — (String)

                The name of the field in the custom knowledge article that contains the document data to index.

              • DocumentTitleFieldName — (String)

                The name of the field in the custom knowledge article that contains the document title.

              • FieldMappings — (Array<map>)

                One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

                • DataSourceFieldName — required — (String)

                  The name of the column or attribute in the data source.

                • DateFieldFormat — (String)

                  The type of data stored in the column or attribute.

                • IndexFieldName — required — (String)

                  The name of the field in the index.

          • ChatterFeedConfiguration — (map)

            Specifies configuration information for Salesforce chatter feeds.

            • DocumentDataFieldName — required — (String)

              The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

            • DocumentTitleFieldName — (String)

              The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

            • FieldMappings — (Array<map>)

              Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

            • IncludeFilterTypes — (Array<String>)

              Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra should index attachments to Salesforce objects.

          • StandardObjectAttachmentConfiguration — (map)

            Provides configuration information for processing attachments to Salesforce standard objects.

            • DocumentTitleFieldName — (String)

              The name of the field used for the document title.

            • FieldMappings — (Array<map>)

              One or more objects that map fields in attachments to Amazon Kendra index fields.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

          • IncludeAttachmentFilePatterns — (Array<String>)

            A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

            The regex is applied to the name of the attached file.

          • ExcludeAttachmentFilePatterns — (Array<String>)

            A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

            The regex is applied to the name of the attached file.

        • OneDriveConfiguration — (map)

          Provides configuration for data sources that connect to Microsoft OneDrive.

          • TenantDomain — required — (String)

            The Azure Active Directory domain of the organization.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

          • OneDriveUsers — required — (map)

            A list of user accounts whose documents should be indexed.

            • OneDriveUserList — (Array<String>)

              A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain. If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

            • OneDriveUserS3Path — (map)

              The S3 bucket location of a file containing a list of users whose documents should be indexed.

              • Bucket — required — (String)

                The name of the S3 bucket that contains the file.

              • Key — required — (String)

                The name of the file.

          • InclusionPatterns — (Array<String>)

            A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

            The exclusion pattern is applied to the file name.

          • ExclusionPatterns — (Array<String>)

            List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.

            The exclusion pattern is applied to the file name.

          • FieldMappings — (Array<map>)

            A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • DisableLocalGroups — (Boolean)

            A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

        • ServiceNowConfiguration — (map)

          Provides configuration for data sources that connect to ServiceNow instances.

          • HostUrl — required — (String)

            The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

          • ServiceNowBuildVersion — required — (String)

            The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

            Possible values include:
            • "LONDON"
            • "OTHERS"
          • KnowledgeArticleConfiguration — (map)

            Provides configuration information for crawling knowledge articles in the ServiceNow site.

            • CrawlAttachments — (Boolean)

              Indicates whether Amazon Kendra should index attachments to knowledge articles.

            • IncludeAttachmentFilePatterns — (Array<String>)

              List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

            • ExcludeAttachmentFilePatterns — (Array<String>)

              List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

            • DocumentDataFieldName — required — (String)

              The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

            • DocumentTitleFieldName — (String)

              The name of the ServiceNow field that is mapped to the index document title field.

            • FieldMappings — (Array<map>)

              Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

            • FilterQuery — (String)

              A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

              The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

          • ServiceCatalogConfiguration — (map)

            Provides configuration information for crawling service catalogs in the ServiceNow site.

            • CrawlAttachments — (Boolean)

              Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

            • IncludeAttachmentFilePatterns — (Array<String>)

              A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

              The regex is applied to the file name of the attachment.

            • ExcludeAttachmentFilePatterns — (Array<String>)

              A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

              The regex is applied to the file name of the attachment.

            • DocumentDataFieldName — required — (String)

              The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

            • DocumentTitleFieldName — (String)

              The name of the ServiceNow field that is mapped to the index document title field.

            • FieldMappings — (Array<map>)

              Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

          • AuthenticationType — (String)

            Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

            When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

            Possible values include:
            • "HTTP_BASIC"
            • "OAUTH2"
        • ConfluenceConfiguration — (map)

          Provides configuration information for connecting to a Confluence data source.

          • ServerUrl — required — (String)

            The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

            • username - The user name or email address of a user with administrative privileges for the Confluence server.

            • password - The password associated with the user logging in to the Confluence server.

          • Version — required — (String)

            Specifies the version of the Confluence installation that you are connecting to.

            Possible values include:
            • "CLOUD"
            • "SERVER"
          • SpaceConfiguration — (map)

            Specifies configuration information for indexing Confluence spaces.

            • CrawlPersonalSpaces — (Boolean)

              Specifies whether Amazon Kendra should index personal spaces. Users 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.

            • CrawlArchivedSpaces — (Boolean)

              Specifies whether Amazon Kendra should index archived spaces.

            • IncludeSpaces — (Array<String>)

              A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

            • ExcludeSpaces — (Array<String>)

              A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

            • SpaceFieldMappings — (Array<map>)

              Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

              If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

              • DataSourceFieldName — (String)

                The name of the field in the data source.

                Possible values include:
                • "DISPLAY_URL"
                • "ITEM_TYPE"
                • "SPACE_KEY"
                • "URL"
              • DateFieldFormat — (String)

                The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

              • IndexFieldName — (String)

                The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

          • PageConfiguration — (map)

            Specifies configuration information for indexing Confluence pages.

            • PageFieldMappings — (Array<map>)

              Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

              If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

              • DataSourceFieldName — (String)

                The name of the field in the data source.

                Possible values include:
                • "AUTHOR"
                • "CONTENT_STATUS"
                • "CREATED_DATE"
                • "DISPLAY_URL"
                • "ITEM_TYPE"
                • "LABELS"
                • "MODIFIED_DATE"
                • "PARENT_ID"
                • "SPACE_KEY"
                • "SPACE_NAME"
                • "URL"
                • "VERSION"
              • DateFieldFormat — (String)

                The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

              • IndexFieldName — (String)

                The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

          • BlogConfiguration — (map)

            Specifies configuration information for indexing Confluence blogs.

            • BlogFieldMappings — (Array<map>)

              Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

              If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

              • DataSourceFieldName — (String)

                The name of the field in the data source.

                Possible values include:
                • "AUTHOR"
                • "DISPLAY_URL"
                • "ITEM_TYPE"
                • "LABELS"
                • "PUBLISH_DATE"
                • "SPACE_KEY"
                • "SPACE_NAME"
                • "URL"
                • "VERSION"
              • DateFieldFormat — (String)

                The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

              • IndexFieldName — (String)

                The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

          • AttachmentConfiguration — (map)

            Specifies configuration information for indexing attachments to Confluence blogs and pages.

            • CrawlAttachments — (Boolean)

              Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

            • AttachmentFieldMappings — (Array<map>)

              Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

              If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

              • DataSourceFieldName — (String)

                The name of the field in the data source.

                You must first create the index field using the UpdateIndex operation.

                Possible values include:
                • "AUTHOR"
                • "CONTENT_TYPE"
                • "CREATED_DATE"
                • "DISPLAY_URL"
                • "FILE_SIZE"
                • "ITEM_TYPE"
                • "PARENT_ID"
                • "SPACE_KEY"
                • "SPACE_NAME"
                • "URL"
                • "VERSION"
              • DateFieldFormat — (String)

                The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

              • IndexFieldName — (String)

                The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

          • VpcConfiguration — (map)

            Specifies the information for connecting to an Amazon VPC.

            • SubnetIds — required — (Array<String>)

              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.

            • SecurityGroupIds — required — (Array<String>)

              A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • InclusionPatterns — (Array<String>)

            A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.

          • ExclusionPatterns — (Array<String>)

            A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.

        • GoogleDriveConfiguration — (map)

          Provides configuration for data sources that connect to Google Drive.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

          • InclusionPatterns — (Array<String>)

            A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.

          • ExclusionPatterns — (Array<String>)

            A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.

          • FieldMappings — (Array<map>)

            Defines mapping between a field in the Google Drive and a Amazon Kendra index field.

            If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • ExcludeMimeTypes — (Array<String>)

            A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

            For a list of MIME types, see Using a Google Workspace Drive data source.

          • ExcludeUserAccounts — (Array<String>)

            A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

          • ExcludeSharedDrives — (Array<String>)

            A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

        • WebCrawlerConfiguration — (map)

          Provides the configuration information required for Amazon Kendra web crawler.

          • Urls — required — (map)

            Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

            You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

            When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

            • SeedUrlConfiguration — (map)

              Provides the configuration of the seed or starting point URLs of the websites you want to crawl.

              You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

              You can list up to 100 seed URLs.

              • SeedUrls — required — (Array<String>)

                The list of seed or starting point URLs of the websites you want to crawl.

                The list can include a maximum of 100 seed URLs.

              • WebCrawlerMode — (String)

                You can choose one of the following modes:

                • HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

                • SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

                • EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

                The default mode is set to HOST_ONLY.

                Possible values include:
                • "HOST_ONLY"
                • "SUBDOMAINS"
                • "EVERYTHING"
            • SiteMapsConfiguration — (map)

              Provides the configuration of the sitemap URLs of the websites you want to crawl.

              Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

              • SiteMaps — required — (Array<String>)

                The list of sitemap URLs of the websites you want to crawl.

                The list can include a maximum of three sitemap URLs.

          • CrawlDepth — (Integer)

            Specifies the number of levels in a website that you want to crawl.

            The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

            The default crawl depth is set to 2.

          • MaxLinksPerPage — (Integer)

            The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

            As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

            The default maximum links per page is 100.

          • MaxContentSizePerPageInMegaBytes — (Float)

            The maximum size (in MB) of a webpage or attachment to crawl.

            Files larger than this size (in MB) are skipped/not crawled.

            The default maximum size of a webpage or attachment is set to 50 MB.

          • MaxUrlsPerMinuteCrawlRate — (Integer)

            The maximum number of URLs crawled per website host per minute.

            A minimum of one URL is required.

            The default maximum number of URLs crawled per website host per minute is 300.

          • UrlInclusionPatterns — (Array<String>)

            The regular expression pattern to include certain URLs to crawl.

            If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.

          • UrlExclusionPatterns — (Array<String>)

            The regular expression pattern to exclude certain URLs to crawl.

            If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.

          • ProxyConfiguration — (map)

            Provides configuration information required to connect to your internal websites via a web proxy.

            You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

            Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.

            • Host — required — (String)

              The name of the website host you want to connect to via a web proxy server.

              For example, the host name of https://a.example.com/page1.html is "a.example.com".

            • Port — required — (Integer)

              The port number of the website host you want to connect to via a web proxy server.

              For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

            • Credentials — (String)

              Your secret ARN, which you can create in AWS Secrets Manager

              The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

          • AuthenticationConfiguration — (map)

            Provides configuration information required to connect to websites using authentication.

            You can connect to websites using basic authentication of user name and password.

            You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.

            • BasicAuthentication — (Array<map>)

              The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

              The list includes the name and port number of the website host.

              • Host — required — (String)

                The name of the website host you want to connect to using authentication credentials.

                For example, the host name of https://a.example.com/page1.html is "a.example.com".

              • Port — required — (Integer)

                The port number of the website host you want to connect to using authentication credentials.

                For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

              • Credentials — required — (String)

                Your secret ARN, which you can create in AWS Secrets Manager

                You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

        • WorkDocsConfiguration — (map)

          Provides the configuration information to connect to WorkDocs as your data source.

          • OrganizationId — required — (String)

            The identifier of the directory corresponding to your Amazon WorkDocs site repository.

            You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

          • CrawlComments — (Boolean)

            TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

            The default is set to FALSE.

          • UseChangeLog — (Boolean)

            TRUE to use the change logs to update documents in your index instead of scanning all documents.

            If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.

            The default is set to FALSE.

          • InclusionPatterns — (Array<String>)

            A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. 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.

          • ExclusionPatterns — (Array<String>)

            A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. 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.

          • FieldMappings — (Array<map>)

            A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

      • CreatedAt — (Date)

        The Unix timestamp of when the data source was created.

      • UpdatedAt — (Date)

        The Unix timestamp of when the data source was last updated.

      • Description — (String)

        The description of the data source.

      • Status — (String)

        The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "ACTIVE"
      • Schedule — (String)

        The schedule that Amazon Kendra will update the data source.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

      • ErrorMessage — (String)

        When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFaq(params = {}, callback) ⇒ AWS.Request

Gets information about an FAQ list.

Service Reference:

Examples:

Calling the describeFaq operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.describeFaq(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The unique identifier of the FAQ.

    • IndexId — (String)

      The identifier of the index that contains the FAQ.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The identifier of the FAQ.

      • IndexId — (String)

        The identifier of the index that contains the FAQ.

      • Name — (String)

        The name that you gave the FAQ when it was created.

      • Description — (String)

        The description of the FAQ that you provided when it was created.

      • CreatedAt — (Date)

        The date and time that the FAQ was created.

      • UpdatedAt — (Date)

        The date and time that the FAQ was last updated.

      • S3Path — (map)

        Information required to find a specific file in an Amazon S3 bucket.

        • Bucket — required — (String)

          The name of the S3 bucket that contains the file.

        • Key — required — (String)

          The name of the file.

      • Status — (String)

        The status of the FAQ. It is ready to use when the status is ACTIVE.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

      • ErrorMessage — (String)

        If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

      • FileFormat — (String)

        The file format used by the input files for the FAQ.

        Possible values include:
        • "CSV"
        • "CSV_WITH_HEADER"
        • "JSON"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIndex(params = {}, callback) ⇒ AWS.Request

Describes an existing Amazon Kendra index

Service Reference:

Examples:

Calling the describeIndex operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
kendra.describeIndex(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The name of the index to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Name — (String)

        The name of the index.

      • Id — (String)

        The name of the index.

      • Edition — (String)

        The Amazon Kendra edition used for the index. You decide the edition when you create the index.

        Possible values include:
        • "DEVELOPER_EDITION"
        • "ENTERPRISE_EDITION"
      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

      • ServerSideEncryptionConfiguration — (map)

        The identifier of the KMScustomer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

        • KmsKeyId — (String)

          The identifier of the KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

      • Status — (String)

        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "SYSTEM_UPDATING"
      • Description — (String)

        The description of the index.

      • CreatedAt — (Date)

        The Unix datetime that the index was created.

      • UpdatedAt — (Date)

        The Unix datetime that the index was last updated.

      • DocumentMetadataConfigurations — (Array<map>)

        Configuration settings for any metadata applied to the documents in the index.

        • Name — required — (String)

          The name of the index field.

        • Type — required — (String)

          The data type of the index field.

          Possible values include:
          • "STRING_VALUE"
          • "STRING_LIST_VALUE"
          • "LONG_VALUE"
          • "DATE_VALUE"
        • Relevance — (map)

          Provides manual tuning parameters to determine how the field affects the search results.

          • Freshness — (Boolean)

            Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

          • Importance — (Integer)

            The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

          • Duration — (String)

            Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

            Only applies to DATE fields.

          • RankOrder — (String)

            Determines how values should be interpreted.

            When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

            When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

            Only applies to LONG and DOUBLE fields.

            Possible values include:
            • "ASCENDING"
            • "DESCENDING"
          • ValueImportanceMap — (map<Integer>)

            A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

            For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

        • Search — (map)

          Provides information about how the field is used during a search.

          • Facetable — (Boolean)

            Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

          • Searchable — (Boolean)

            Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

          • Displayable — (Boolean)

            Determines whether the field is returned in the query response. The default is true.

          • Sortable — (Boolean)

            Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

      • IndexStatistics — (map)

        Provides information about the number of FAQ questions and answers and the number of text documents indexed.

        • FaqStatistics — required — (map)

          The number of question and answer topics in the index.

          • IndexedQuestionAnswersCount — required — (Integer)

            The total number of FAQ questions and answers contained in the index.

        • TextDocumentStatistics — required — (map)

          The number of text documents indexed.

          • IndexedTextDocumentsCount — required — (Integer)

            The number of text documents indexed.

          • IndexedTextBytes — required — (Integer)

            The total size, in bytes, of the indexed documents.

      • ErrorMessage — (String)

        When th eStatus field value is FAILED, the ErrorMessage field contains a message that explains why.

      • CapacityUnits — (map)

        For Enterprise edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.

        • StorageCapacityUnits — required — (Integer)

          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.

        • QueryCapacityUnits — required — (Integer)

          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).

      • UserTokenConfigurations — (Array<map>)

        The user token configuration for the Amazon Kendra index.

        • JwtTokenTypeConfiguration — (map)

          Information about the JWT token type configuration.

          • KeyLocation — required — (String)

            The location of the key.

            Possible values include:
            • "URL"
            • "SECRET_MANAGER"
          • URL — (String)

            The signing key URL.

          • SecretManagerArn — (String)

            The Amazon Resource Name (arn) of the secret.

          • UserNameAttributeField — (String)

            The user name attribute field.

          • GroupAttributeField — (String)

            The group attribute field.

          • Issuer — (String)

            The issuer of the token.

          • ClaimRegex — (String)

            The regular expression that identifies the claim.

        • JsonTokenTypeConfiguration — (map)

          Information about the JSON token type configuration.

          • UserNameAttributeField — required — (String)

            The user name attribute field.

          • GroupAttributeField — required — (String)

            The group attribute field.

      • UserContextPolicy — (String)

        The user context policy for the Amazon Kendra index.

        Possible values include:
        • "ATTRIBUTE_FILTER"
        • "USER_TOKEN"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePrincipalMapping(params = {}, callback) ⇒ AWS.Request

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

Service Reference:

Examples:

Calling the describePrincipalMapping operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE'
};
kendra.describePrincipalMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.

    • DataSourceId — (String)

      The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.

    • GroupId — (String)

      The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IndexId — (String)

        Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

      • DataSourceId — (String)

        Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

      • GroupId — (String)

        Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

      • GroupOrderingIdSummaries — (Array<map>)

        Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

        • Status – the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

        • Last updated – the last date-time an action was updated.

        • Received – the last date-time an action was received or submitted.

        • Ordering ID – the latest action that should process and apply after other actions.

        • Failure reason – the reason an action could not be processed.

        • Status — (String)

          The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

          Possible values include:
          • "FAILED"
          • "SUCCEEDED"
          • "PROCESSING"
          • "DELETING"
          • "DELETED"
        • LastUpdatedAt — (Date)

          The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

        • ReceivedAt — (Date)

          The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

        • OrderingId — (Integer)

          The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

        • FailureReason — (String)

          The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeQuerySuggestionsBlockList(params = {}, callback) ⇒ AWS.Request

Describes a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

Service Reference:

Examples:

Calling the describeQuerySuggestionsBlockList operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.describeQuerySuggestionsBlockList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index for the block list.

    • Id — (String)

      The unique identifier of the block list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IndexId — (String)

        Shows the identifier of the index for the block list.

      • Id — (String)

        Shows the unique identifier of the block list.

      • Name — (String)

        Shows the name of the block list.

      • Description — (String)

        Shows the description for the block list.

      • Status — (String)

        Shows whether the current status of the block list is ACTIVE or INACTIVE.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "UPDATING"
        • "ACTIVE_BUT_UPDATE_FAILED"
        • "FAILED"
      • ErrorMessage — (String)

        Shows the error message with details when there are issues in processing the block list.

      • CreatedAt — (Date)

        Shows the date-time a block list for query suggestions was last created.

      • UpdatedAt — (Date)

        Shows the date-time a block list for query suggestions was last updated.

      • SourceS3Path — (map)

        Shows the current S3 path to your block list text file in your S3 bucket.

        Each block word or phrase should be on a separate line in a text file.

        For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

        • Bucket — required — (String)

          The name of the S3 bucket that contains the file.

        • Key — required — (String)

          The name of the file.

      • ItemCount — (Integer)

        Shows the current number of valid, non-empty words or phrases in the block list text file.

      • FileSizeBytes — (Integer)

        Shows the current size of the block list text file in S3.

      • RoleArn — (String)

        Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

        The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeQuerySuggestionsConfig(params = {}, callback) ⇒ AWS.Request

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

Service Reference:

Examples:

Calling the describeQuerySuggestionsConfig operation

var params = {
  IndexId: 'STRING_VALUE' /* required */
};
kendra.describeQuerySuggestionsConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to describe query suggestions settings for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Mode — (String)

        Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

        By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig operation.

        Possible values include:
        • "ENABLED"
        • "LEARN_ONLY"
      • Status — (String)

        Shows whether the status of query suggestions settings is currently Active or Updating.

        Active means the current settings apply and Updating means your changed settings are in the process of applying.

        Possible values include:
        • "ACTIVE"
        • "UPDATING"
      • QueryLogLookBackWindowInDays — (Integer)

        Shows how recent your queries are in your query log time window (in days).

      • IncludeQueriesWithoutUserInformation — (Boolean)

        Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

      • MinimumNumberOfQueryingUsers — (Integer)

        Shows the minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

      • MinimumQueryCount — (Integer)

        Shows the minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

      • LastSuggestionsBuildTime — (Date)

        Shows the date-time query suggestions for an index was last updated.

      • LastClearTime — (Date)

        Shows the date-time query suggestions for an index was last cleared.

        After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

      • TotalSuggestionsCount — (Integer)

        Shows the current total count of query suggestions for an index.

        This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeThesaurus(params = {}, callback) ⇒ AWS.Request

Describes an existing Amazon Kendra thesaurus.

Service Reference:

Examples:

Calling the describeThesaurus operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.describeThesaurus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the thesaurus to describe.

    • IndexId — (String)

      The identifier of the index associated with the thesaurus to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The identifier of the thesaurus.

      • IndexId — (String)

        The identifier of the index associated with the thesaurus to describe.

      • Name — (String)

        The thesaurus name.

      • Description — (String)

        The thesaurus description.

      • Status — (String)

        The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

        If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "ACTIVE_BUT_UPDATE_FAILED"
        • "FAILED"
      • ErrorMessage — (String)

        When the Status field value is FAILED, the ErrorMessage field provides more information.

      • CreatedAt — (Date)

        The Unix datetime that the thesaurus was created.

      • UpdatedAt — (Date)

        The Unix datetime that the thesaurus was last updated.

      • RoleArn — (String)

        An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

      • SourceS3Path — (map)

        Information required to find a specific file in an Amazon S3 bucket.

        • Bucket — required — (String)

          The name of the S3 bucket that contains the file.

        • Key — required — (String)

          The name of the file.

      • FileSizeBytes — (Integer)

        The size of the thesaurus file in bytes.

      • TermCount — (Integer)

        The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

      • SynonymRuleCount — (Integer)

        The number of synonym rules in the thesaurus file.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getQuerySuggestions(params = {}, callback) ⇒ AWS.Request

Fetches the queries that are suggested to your users.

Service Reference:

Examples:

Calling the getQuerySuggestions operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  QueryText: 'STRING_VALUE', /* required */
  MaxSuggestionsCount: 'NUMBER_VALUE'
};
kendra.getQuerySuggestions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to get query suggestions from.

    • QueryText — (String)

      The text of a user's query to generate query suggestions.

      A query is suggested if the query prefix matches what a user starts to type as their query.

      Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

    • MaxSuggestionsCount — (Integer)

      The maximum number of query suggestions you want to show to your users.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • QuerySuggestionsId — (String)

        The unique identifier for a list of query suggestions for an index.

      • Suggestions — (Array<map>)

        A list of query suggestions for an index.

        • Id — (String)

          The unique UUID (universally unique identifier) of a single query suggestion.

        • Value — (map)

          The value for the unique UUID (universally unique identifier) of a single query suggestion.

          The value is the text string of a suggestion.

          • Text — (map)

            The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.

            • Text — (String)

              The query suggestion text to display to the user.

            • Highlights — (Array<map>)

              The beginning and end of the query suggestion text that should be highlighted.

              • BeginOffset — (Integer)

                The zero-based location in the response string where the highlight starts.

              • EndOffset — (Integer)

                The zero-based location in the response string where the highlight ends.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDataSources(params = {}, callback) ⇒ AWS.Request

Lists the data sources that you have created.

Service Reference:

Examples:

Calling the listDataSources operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendra.listDataSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index that contains the data source.

    • NextToken — (String)

      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 retrieve the next set of data sources (DataSourceSummaryItems).

    • MaxResults — (Integer)

      The maximum number of data sources to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SummaryItems — (Array<map>)

        An array of summary information for one or more data sources.

        • Name — (String)

          The name of the data source.

        • Id — (String)

          The unique identifier for the data source.

        • Type — (String)

          The type of the data source.

          Possible values include:
          • "S3"
          • "SHAREPOINT"
          • "DATABASE"
          • "SALESFORCE"
          • "ONEDRIVE"
          • "SERVICENOW"
          • "CUSTOM"
          • "CONFLUENCE"
          • "GOOGLEDRIVE"
          • "WEBCRAWLER"
          • "WORKDOCS"
        • CreatedAt — (Date)

          The UNIX datetime that the data source was created.

        • UpdatedAt — (Date)

          The UNIX datetime that the data source was lasted updated.

        • Status — (String)

          The status of the data source. When the status is ACTIVE the data source is ready to use.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "FAILED"
          • "UPDATING"
          • "ACTIVE"
      • NextToken — (String)

        If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data sources.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDataSourceSyncJobs(params = {}, callback) ⇒ AWS.Request

Gets statistics about synchronizing Amazon Kendra with a data source.

Service Reference:

Examples:

Calling the listDataSourceSyncJobs operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartTimeFilter: {
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  StatusFilter: FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXING
};
kendra.listDataSourceSyncJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the data source.

    • IndexId — (String)

      The identifier of the index that contains the data source.

    • NextToken — (String)

      If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

    • MaxResults — (Integer)

      The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

    • StartTimeFilter — (map)

      When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

      • StartTime — (Date)

        The UNIX datetime of the beginning of the time range.

      • EndTime — (Date)

        The UNIX datetime of the end of the time range.

    • StatusFilter — (String)

      When specified, only returns synchronization jobs with the Status field equal to the specified status.

      Possible values include:
      • "FAILED"
      • "SUCCEEDED"
      • "SYNCING"
      • "INCOMPLETE"
      • "STOPPING"
      • "ABORTED"
      • "SYNCING_INDEXING"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • History — (Array<map>)

        A history of synchronization jobs for the data source.

        • ExecutionId — (String)

          A unique identifier for the synchronization job.

        • StartTime — (Date)

          The UNIX datetime that the synchronization job was started.

        • EndTime — (Date)

          The UNIX datetime that the synchronization job was completed.

        • Status — (String)

          The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

          Possible values include:
          • "FAILED"
          • "SUCCEEDED"
          • "SYNCING"
          • "INCOMPLETE"
          • "STOPPING"
          • "ABORTED"
          • "SYNCING_INDEXING"
        • ErrorMessage — (String)

          If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

        • ErrorCode — (String)

          If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
        • DataSourceErrorCode — (String)

          If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

        • Metrics — (map)

          Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

          • DocumentsAdded — (String)

            The number of documents added from the data source up to now in the data source sync.

          • DocumentsModified — (String)

            The number of documents modified in the data source up to now in the data source sync run.

          • DocumentsDeleted — (String)

            The number of documents deleted from the data source up to now in the data source sync run.

          • DocumentsFailed — (String)

            The number of documents that failed to sync from the data source up to now in the data source sync run.

          • DocumentsScanned — (String)

            The current number of documents crawled by the current sync job in the data source.

      • NextToken — (String)

        The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory operation to return in the next page of jobs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listFaqs(params = {}, callback) ⇒ AWS.Request

Gets a list of FAQ lists associated with an index.

Service Reference:

Examples:

Calling the listFaqs operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendra.listFaqs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The index that contains the FAQ lists.

    • NextToken — (String)

      If the result of the previous request to ListFaqs was truncated, include the NextToken to fetch the next set of FAQs.

    • MaxResults — (Integer)

      The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The ListFaqs operation returns a page of FAQs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the ListFaqs operation to return the next page of FAQs.

      • FaqSummaryItems — (Array<map>)

        information about the FAQs associated with the specified index.

        • Id — (String)

          The unique identifier of the FAQ.

        • Name — (String)

          The name that you assigned the FAQ when you created or updated the FAQ.

        • Status — (String)

          The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "ACTIVE"
          • "DELETING"
          • "FAILED"
        • CreatedAt — (Date)

          The UNIX datetime that the FAQ was added to the index.

        • UpdatedAt — (Date)

          The UNIX datetime that the FAQ was last updated.

        • FileFormat — (String)

          The file type used to create the FAQ.

          Possible values include:
          • "CSV"
          • "CSV_WITH_HEADER"
          • "JSON"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listGroupsOlderThanOrderingId(params = {}, callback) ⇒ AWS.Request

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

Service Reference:

Examples:

Calling the listGroupsOlderThanOrderingId operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  OrderingId: 'NUMBER_VALUE', /* required */
  DataSourceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendra.listGroupsOlderThanOrderingId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.

    • DataSourceId — (String)

      The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.

    • OrderingId — (Integer)

      The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

    • NextToken — (String)

      The next items in the list of groups that go beyond the maximum.

    • MaxResults — (Integer)

      The maximum results shown for a list of groups that are mapped to users before a given ordering or timestamp identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupsSummaries — (Array<map>)

        Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.

        • GroupId — (String)

          The identifier of the group you want group summary information on.

        • OrderingId — (Integer)

          The timestamp identifier used for the latest PUT or DELETE action.

      • NextToken — (String)

        The next items in the list of groups that go beyond the maximum.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listIndices(params = {}, callback) ⇒ AWS.Request

Lists the Amazon Kendra indexes that you have created.

Service Reference:

Examples:

Calling the listIndices operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendra.listIndices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      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 retrieve the next set of indexes (DataSourceSummaryItems).

    • MaxResults — (Integer)

      The maximum number of data sources to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IndexConfigurationSummaryItems — (Array<map>)

        An array of summary information for one or more indexes.

        • Name — (String)

          The name of the index.

        • Id — (String)

          A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

        • Edition — (String)

          Indicates whether the index is a enterprise edition index or a developer edition index.

          Possible values include:
          • "DEVELOPER_EDITION"
          • "ENTERPRISE_EDITION"
        • CreatedAt — required — (Date)

          The Unix timestamp when the index was created.

        • UpdatedAt — required — (Date)

          The Unix timestamp when the index was last updated by the UpdateIndex operation.

        • Status — required — (String)

          The current status of the index. When the status is ACTIVE, the index is ready to search.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "FAILED"
          • "UPDATING"
          • "SYSTEM_UPDATING"
      • NextToken — (String)

        If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of indexes.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listQuerySuggestionsBlockLists(params = {}, callback) ⇒ AWS.Request

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Service Reference:

Examples:

Calling the listQuerySuggestionsBlockLists operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendra.listQuerySuggestionsBlockLists(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index for a list of all block lists that exist for that index.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

    • NextToken — (String)

      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 retrieve the next set of block lists (BlockListSummaryItems).

    • MaxResults — (Integer)

      The maximum number of block lists to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BlockListSummaryItems — (Array<map>)

        Summary items for a block list.

        This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

        For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

        • Id — (String)

          The identifier of a block list.

        • Name — (String)

          The name of the block list.

        • Status — (String)

          The status of the block list.

          Possible values include:
          • "ACTIVE"
          • "CREATING"
          • "DELETING"
          • "UPDATING"
          • "ACTIVE_BUT_UPDATE_FAILED"
          • "FAILED"
        • CreatedAt — (Date)

          The date-time summary information for a query suggestions block list was last created.

        • UpdatedAt — (Date)

          The date-time the block list was last updated.

        • ItemCount — (Integer)

          The number of items in the block list file.

      • NextToken — (String)

        If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
kendra.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A list of tags associated with the index, FAQ, or data source.

        • Key — required — (String)

          The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

        • Value — required — (String)

          The value associated with the tag. The value may be an empty string but it can't be null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listThesauri(params = {}, callback) ⇒ AWS.Request

Lists the Amazon Kendra thesauri associated with an index.

Service Reference:

Examples:

Calling the listThesauri operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendra.listThesauri(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index associated with the thesaurus to list.

    • NextToken — (String)

      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 retrieve the next set of thesauri (ThesaurusSummaryItems).

    • MaxResults — (Integer)

      The maximum number of thesauri to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.

      • ThesaurusSummaryItems — (Array<map>)

        An array of summary information for one or more thesauruses.

        • Id — (String)

          The identifier of the thesaurus.

        • Name — (String)

          The name of the thesaurus.

        • Status — (String)

          The status of the thesaurus.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "UPDATING"
          • "ACTIVE_BUT_UPDATE_FAILED"
          • "FAILED"
        • CreatedAt — (Date)

          The Unix datetime that the thesaurus was created.

        • UpdatedAt — (Date)

          The Unix datetime that the thesaurus was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putPrincipalMapping(params = {}, callback) ⇒ AWS.Request

Maps users to their groups. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

Service Reference:

Examples:

Calling the putPrincipalMapping operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  GroupMembers: { /* required */
    MemberGroups: [
      {
        GroupId: 'STRING_VALUE', /* required */
        DataSourceId: 'STRING_VALUE'
      },
      /* more items */
    ],
    MemberUsers: [
      {
        UserId: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    S3PathforGroupMembers: {
      Bucket: 'STRING_VALUE', /* required */
      Key: 'STRING_VALUE' /* required */
    }
  },
  IndexId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE',
  OrderingId: 'NUMBER_VALUE',
  RoleArn: 'STRING_VALUE'
};
kendra.putPrincipalMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to map users to their groups.

    • DataSourceId — (String)

      The identifier of the data source you want to map users to their groups.

      This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

    • GroupId — (String)

      The identifier of the group you want to map its users to.

    • GroupMembers — (map)

      The list that contains your users or sub groups that belong the same group.

      For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

      If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

      • MemberGroups — (Array<map>)

        A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

        • GroupId — required — (String)

          The identifier of the sub group you want to map to a group.

        • DataSourceId — (String)

          The identifier of the data source for the sub group you want to map to a group.

      • MemberUsers — (Array<map>)

        A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

        • UserId — required — (String)

          The identifier of the user you want to map to a group.

      • S3PathforGroupMembers — (map)

        If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

        • Bucket — required — (String)

          The name of the S3 bucket that contains the file.

        • Key — required — (String)

          The name of the file.

    • OrderingId — (Integer)

      The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

      The ordering ID can be the UNIX time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed.

      The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

      For more information, see IAM roles for Amazon Kendra.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

query(params = {}, callback) ⇒ AWS.Request

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

  • Relevant passages

  • Matching FAQs

  • Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

Service Reference:

Examples:

Calling the query operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  QueryText: 'STRING_VALUE', /* required */
  AttributeFilter: { /* AttributeFilter */
    AndAllFilters: [
      /* recursive AttributeFilter */,
      /* more items */
    ],
    ContainsAll: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    ContainsAny: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    EqualsTo: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    GreaterThan: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    GreaterThanOrEquals: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    LessThan: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    LessThanOrEquals: {
      Key: 'STRING_VALUE', /* required */
      Value: { /* required */
        DateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        LongValue: 'NUMBER_VALUE',
        StringListValue: [
          'STRING_VALUE',
          /* more items */
        ],
        StringValue: 'STRING_VALUE'
      }
    },
    NotFilter: /* recursive AttributeFilter */,
    OrAllFilters: [
      /* recursive AttributeFilter */,
      /* more items */
    ]
  },
  DocumentRelevanceOverrideConfigurations: [
    {
      Name: 'STRING_VALUE', /* required */
      Relevance: { /* required */
        Duration: 'STRING_VALUE',
        Freshness: true || false,
        Importance: 'NUMBER_VALUE',
        RankOrder: ASCENDING | DESCENDING,
        ValueImportanceMap: {
          '<ValueImportanceMapKey>': 'NUMBER_VALUE',
          /* '<ValueImportanceMapKey>': ... */
        }
      }
    },
    /* more items */
  ],
  Facets: [
    {
      DocumentAttributeKey: 'STRING_VALUE'
    },
    /* more items */
  ],
  PageNumber: 'NUMBER_VALUE',
  PageSize: 'NUMBER_VALUE',
  QueryResultTypeFilter: DOCUMENT | QUESTION_ANSWER | ANSWER,
  RequestedDocumentAttributes: [
    'STRING_VALUE',
    /* more items */
  ],
  SortingConfiguration: {
    DocumentAttributeKey: 'STRING_VALUE', /* required */
    SortOrder: DESC | ASC /* required */
  },
  UserContext: {
    DataSourceGroups: [
      {
        DataSourceId: 'STRING_VALUE', /* required */
        GroupId: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Groups: [
      'STRING_VALUE',
      /* more items */
    ],
    Token: 'STRING_VALUE',
    UserId: 'STRING_VALUE'
  },
  VisitorId: 'STRING_VALUE'
};
kendra.query(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

    • QueryText — (String)

      The text to search for.

    • AttributeFilter — (map)

      Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

      The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

      • AndAllFilters — (Array<map>)

        Performs a logical AND operation on all supplied filters.

        • EqualsTo — (map)

          Performs an equals operation on two document attributes.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ContainsAll — (map)

          Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ContainsAny — (map)

          Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • GreaterThan — (map)

          Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • GreaterThanOrEquals — (map)

          Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • LessThan — (map)

          Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • LessThanOrEquals — (map)

          Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • OrAllFilters — (Array<map>)

        Performs a logical OR operation on all supplied filters.

        • EqualsTo — (map)

          Performs an equals operation on two document attributes.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ContainsAll — (map)

          Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ContainsAny — (map)

          Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • GreaterThan — (map)

          Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • GreaterThanOrEquals — (map)

          Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • LessThan — (map)

          Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • LessThanOrEquals — (map)

          Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • NotFilter — (map)

        Performs a logical NOT operation on all supplied filters.

        • AndAllFilters — (Array<map>)

          Performs a logical AND operation on all supplied filters.

        • OrAllFilters — (Array<map>)

          Performs a logical OR operation on all supplied filters.

        • EqualsTo — (map)

          Performs an equals operation on two document attributes.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ContainsAll — (map)

          Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ContainsAny — (map)

          Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • GreaterThan — (map)

          Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • GreaterThanOrEquals — (map)

          Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • LessThan — (map)

          Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • LessThanOrEquals — (map)

          Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • EqualsTo — (map)

        Performs an equals operation on two document attributes.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • ContainsAll — (map)

        Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • ContainsAny — (map)

        Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • GreaterThan — (map)

        Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • GreaterThanOrEquals — (map)

        Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • LessThan — (map)

        Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

      • LessThanOrEquals — (map)

        Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

        • Key — required — (String)

          The identifier for the attribute.

        • Value — required — (map)

          The value of the attribute.

          • StringValue — (String)

            A string, such as "department".

          • StringListValue — (Array<String>)

            A list of strings.

          • LongValue — (Integer)

            A long integer value.

          • DateValue — (Date)

            A date expressed as an ISO 8601 string.

            It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

    • Facets — (Array<map>)

      An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

      • DocumentAttributeKey — (String)

        The unique key for the document attribute.

    • RequestedDocumentAttributes — (Array<String>)

      An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

    • QueryResultTypeFilter — (String)

      Sets the type of query. Only results for the specified query type are returned.

      Possible values include:
      • "DOCUMENT"
      • "QUESTION_ANSWER"
      • "ANSWER"
    • DocumentRelevanceOverrideConfigurations — (Array<map>)

      Overrides relevance tuning configurations of fields or attributes set at the index level.

      If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

      If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

      If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

      • Name — required — (String)

        The name of the tuning configuration to override document relevance at the index level.

      • Relevance — required — (map)

        Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

        • Freshness — (Boolean)

          Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

        • Importance — (Integer)

          The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

        • Duration — (String)

          Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

          Only applies to DATE fields.

        • RankOrder — (String)

          Determines how values should be interpreted.

          When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

          When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

          Only applies to LONG and DOUBLE fields.

          Possible values include:
          • "ASCENDING"
          • "DESCENDING"
        • ValueImportanceMap — (map<Integer>)

          A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

          For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

    • PageNumber — (Integer)

      Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

    • PageSize — (Integer)

      Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

    • SortingConfiguration — (map)

      Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

      If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

      • DocumentAttributeKey — required — (String)

        The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.

        You can also sort by any of the following built-in attributes:

        • category

        • created_at

        • last_updated_at

        • version

        • _view_count

      • SortOrder — required — (String)

        The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

        Possible values include:
        • "DESC"
        • "ASC"
    • UserContext — (map)

      The user context token.

      • Token — (String)

        The user context token for filtering search results for a user. It must be a JWT or a JSON token.

      • UserId — (String)

        The identifier of the user you want to filter search results based on their access to documents.

      • Groups — (Array<String>)

        The list of groups you want to filter search results based on the groups' access to documents.

      • DataSourceGroups — (Array<map>)

        The list of data source groups you want to filter search results based on groups' access to documents in that data source.

        • GroupId — required — (String)

          The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups' access to documents.

        • DataSourceId — required — (String)

          The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.

    • VisitorId — (String)

      Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • QueryId — (String)

        The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

      • ResultItems — (Array<map>)

        The results of the search.

        • Id — (String)

          The unique identifier for the query result.

        • Type — (String)

          The type of document.

          Possible values include:
          • "DOCUMENT"
          • "QUESTION_ANSWER"
          • "ANSWER"
        • AdditionalAttributes — (Array<map>)

          One or more additional attributes associated with the query result.

          • Key — required — (String)

            The key that identifies the attribute.

          • ValueType — required — (String)

            The data type of the Value property.

            Possible values include:
            • "TEXT_WITH_HIGHLIGHTS_VALUE"
          • Value — required — (map)

            An object that contains the attribute value.

            • TextWithHighlightsValue — (map)

              The text associated with the attribute and information about the highlight to apply to the text.

              • Text — (String)

                The text to display to the user.

              • Highlights — (Array<map>)

                The beginning and end of the text that should be highlighted.

                • BeginOffset — required — (Integer)

                  The zero-based location in the response string where the highlight starts.

                • EndOffset — required — (Integer)

                  The zero-based location in the response string where the highlight ends.

                • TopAnswer — (Boolean)

                  Indicates whether the response is the best response. True if this is the best response; otherwise, false.

                • Type — (String)

                  The highlight type.

                  Possible values include:
                  • "STANDARD"
                  • "THESAURUS_SYNONYM"
        • DocumentId — (String)

          The unique identifier for the document.

        • DocumentTitle — (map)

          The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

          • Text — (String)

            The text to display to the user.

          • Highlights — (Array<map>)

            The beginning and end of the text that should be highlighted.

            • BeginOffset — required — (Integer)

              The zero-based location in the response string where the highlight starts.

            • EndOffset — required — (Integer)

              The zero-based location in the response string where the highlight ends.

            • TopAnswer — (Boolean)

              Indicates whether the response is the best response. True if this is the best response; otherwise, false.

            • Type — (String)

              The highlight type.

              Possible values include:
              • "STANDARD"
              • "THESAURUS_SYNONYM"
        • DocumentExcerpt — (map)

          An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

          • Text — (String)

            The text to display to the user.

          • Highlights — (Array<map>)

            The beginning and end of the text that should be highlighted.

            • BeginOffset — required — (Integer)

              The zero-based location in the response string where the highlight starts.

            • EndOffset — required — (Integer)

              The zero-based location in the response string where the highlight ends.

            • TopAnswer — (Boolean)

              Indicates whether the response is the best response. True if this is the best response; otherwise, false.

            • Type — (String)

              The highlight type.

              Possible values include:
              • "STANDARD"
              • "THESAURUS_SYNONYM"
        • DocumentURI — (String)

          The URI of the original location of the document.

        • DocumentAttributes — (Array<map>)

          An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

          • Key — required — (String)

            The identifier for the attribute.

          • Value — required — (map)

            The value of the attribute.

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

        • ScoreAttributes — (map)

          Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

          The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

          • ScoreConfidence — (String)

            A relative ranking for how well the response matches the query.

            Possible values include:
            • "VERY_HIGH"
            • "HIGH"
            • "MEDIUM"
            • "LOW"
        • FeedbackToken — (String)

          A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

      • FacetResults — (Array<map>)

        Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

        • DocumentAttributeKey — (String)

          The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

        • DocumentAttributeValueType — (String)

          The data type of the facet value. This is the same as the type defined for the index field when it was created.

          Possible values include:
          • "STRING_VALUE"
          • "STRING_LIST_VALUE"
          • "LONG_VALUE"
          • "DATE_VALUE"
        • DocumentAttributeValueCountPairs — (Array<map>)

          An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

          • DocumentAttributeValue — (map)

            The value of the attribute. For example, "HR."

            • StringValue — (String)

              A string, such as "department".

            • StringListValue — (Array<String>)

              A list of strings.

            • LongValue — (Integer)

              A long integer value.

            • DateValue — (Date)

              A date expressed as an ISO 8601 string.

              It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

          • Count — (Integer)

            The number of documents in the response that have the attribute value for the key.

      • TotalNumberOfResults — (Integer)

        The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Service Reference:

Examples:

Calling the startDataSourceSyncJob operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.startDataSourceSyncJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the data source to synchronize.

    • IndexId — (String)

      The identifier of the index that contains the data source.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExecutionId — (String)

        Identifies a particular synchronization job.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request

Stops a running synchronization job. You can't stop a scheduled synchronization job.

Service Reference:

Examples:

Calling the stopDataSourceSyncJob operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE' /* required */
};
kendra.stopDataSourceSyncJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the data source for which to stop the synchronization jobs.

    • IndexId — (String)

      The identifier of the index that contains the data source.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

submitFeedback(params = {}, callback) ⇒ AWS.Request

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

Service Reference:

Examples:

Calling the submitFeedback operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  QueryId: 'STRING_VALUE', /* required */
  ClickFeedbackItems: [
    {
      ClickTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      ResultId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RelevanceFeedbackItems: [
    {
      RelevanceValue: RELEVANT | NOT_RELEVANT, /* required */
      ResultId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendra.submitFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index that was queried.

    • QueryId — (String)

      The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query operation.

    • ClickFeedbackItems — (Array<map>)

      Tells Amazon Kendra that a particular search result link was chosen by the user.

      • ResultId — required — (String)

        The unique identifier of the search result that was clicked.

      • ClickTime — required — (Date)

        The Unix timestamp of the date and time that the result was clicked.

    • RelevanceFeedbackItems — (Array<map>)

      Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

      • ResultId — required — (String)

        The unique identifier of the search result that the user provided relevance feedback for.

      • RelevanceValue — required — (String)

        Whether to document was relevant or not relevant to the search.

        Possible values include:
        • "RELEVANT"
        • "NOT_RELEVANT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendra.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.

    • Tags — (Array<map>)

      A list of tag keys to add to the index, FAQ, or data source. If a tag already exists, the existing value is replaced with the new value.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

      • Value — required — (String)

        The value associated with the tag. The value may be an empty string but it can't be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from an index, FAQ, or a data source.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kendra.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.

    • TagKeys — (Array<String>)

      A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not exist on the resource, it is ignored.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDataSource(params = {}, callback) ⇒ AWS.Request

Updates an existing Amazon Kendra data source.

Service Reference:

Examples:

Calling the updateDataSource operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE', /* required */
  Configuration: {
    ConfluenceConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      ServerUrl: 'STRING_VALUE', /* required */
      Version: CLOUD | SERVER, /* required */
      AttachmentConfiguration: {
        AttachmentFieldMappings: [
          {
            DataSourceFieldName: AUTHOR | CONTENT_TYPE | CREATED_DATE | DISPLAY_URL | FILE_SIZE | ITEM_TYPE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ],
        CrawlAttachments: true || false
      },
      BlogConfiguration: {
        BlogFieldMappings: [
          {
            DataSourceFieldName: AUTHOR | DISPLAY_URL | ITEM_TYPE | LABELS | PUBLISH_DATE | SPACE_KEY | SPACE_NAME | URL | VERSION,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      PageConfiguration: {
        PageFieldMappings: [
          {
            DataSourceFieldName: AUTHOR | CONTENT_STATUS | CREATED_DATE | DISPLAY_URL | ITEM_TYPE | LABELS | MODIFIED_DATE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      SpaceConfiguration: {
        CrawlArchivedSpaces: true || false,
        CrawlPersonalSpaces: true || false,
        ExcludeSpaces: [
          'STRING_VALUE',
          /* more items */
        ],
        IncludeSpaces: [
          'STRING_VALUE',
          /* more items */
        ],
        SpaceFieldMappings: [
          {
            DataSourceFieldName: DISPLAY_URL | ITEM_TYPE | SPACE_KEY | URL,
            DateFieldFormat: 'STRING_VALUE',
            IndexFieldName: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      VpcConfiguration: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    DatabaseConfiguration: {
      ColumnConfiguration: { /* required */
        ChangeDetectingColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        DocumentDataColumnName: 'STRING_VALUE', /* required */
        DocumentIdColumnName: 'STRING_VALUE', /* required */
        DocumentTitleColumnName: 'STRING_VALUE',
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      ConnectionConfiguration: { /* required */
        DatabaseHost: 'STRING_VALUE', /* required */
        DatabaseName: 'STRING_VALUE', /* required */
        DatabasePort: 'NUMBER_VALUE', /* required */
        SecretArn: 'STRING_VALUE', /* required */
        TableName: 'STRING_VALUE' /* required */
      },
      DatabaseEngineType: RDS_AURORA_MYSQL | RDS_AURORA_POSTGRESQL | RDS_MYSQL | RDS_POSTGRESQL, /* required */
      AclConfiguration: {
        AllowedGroupsColumnName: 'STRING_VALUE' /* required */
      },
      SqlConfiguration: {
        QueryIdentifiersEnclosingOption: DOUBLE_QUOTES | NONE
      },
      VpcConfiguration: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    GoogleDriveConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      ExcludeMimeTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      ExcludeSharedDrives: [
        'STRING_VALUE',
        /* more items */
      ],
      ExcludeUserAccounts: [
        'STRING_VALUE',
        /* more items */
      ],
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    OneDriveConfiguration: {
      OneDriveUsers: { /* required */
        OneDriveUserList: [
          'STRING_VALUE',
          /* more items */
        ],
        OneDriveUserS3Path: {
          Bucket: 'STRING_VALUE', /* required */
          Key: 'STRING_VALUE' /* required */
        }
      },
      SecretArn: 'STRING_VALUE', /* required */
      TenantDomain: 'STRING_VALUE', /* required */
      DisableLocalGroups: true || false,
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    S3Configuration: {
      BucketName: 'STRING_VALUE', /* required */
      AccessControlListConfiguration: {
        KeyPath: 'STRING_VALUE'
      },
      DocumentsMetadataConfiguration: {
        S3Prefix: 'STRING_VALUE'
      },
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      InclusionPrefixes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    SalesforceConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      ServerUrl: 'STRING_VALUE', /* required */
      ChatterFeedConfiguration: {
        DocumentDataFieldName: 'STRING_VALUE', /* required */
        DocumentTitleFieldName: 'STRING_VALUE',
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ],
        IncludeFilterTypes: [
          ACTIVE_USER | STANDARD_USER,
          /* more items */
        ]
      },
      CrawlAttachments: true || false,
      ExcludeAttachmentFilePatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      IncludeAttachmentFilePatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      KnowledgeArticleConfiguration: {
        IncludedStates: [ /* required */
          DRAFT | PUBLISHED | ARCHIVED,
          /* more items */
        ],
        CustomKnowledgeArticleTypeConfigurations: [
          {
            DocumentDataFieldName: 'STRING_VALUE', /* required */
            Name: 'STRING_VALUE', /* required */
            DocumentTitleFieldName: 'STRING_VALUE',
            FieldMappings: [
              {
                DataSourceFieldName: 'STRING_VALUE', /* required */
                IndexFieldName: 'STRING_VALUE', /* required */
                DateFieldFormat: 'STRING_VALUE'
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        StandardKnowledgeArticleTypeConfiguration: {
          DocumentDataFieldName: 'STRING_VALUE', /* required */
          DocumentTitleFieldName: 'STRING_VALUE',
          FieldMappings: [
            {
              DataSourceFieldName: 'STRING_VALUE', /* required */
              IndexFieldName: 'STRING_VALUE', /* required */
              DateFieldFormat: 'STRING_VALUE'
            },
            /* more items */
          ]
        }
      },
      StandardObjectAttachmentConfiguration: {
        DocumentTitleFieldName: 'STRING_VALUE',
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      StandardObjectConfigurations: [
        {
          DocumentDataFieldName: 'STRING_VALUE', /* required */
          Name: ACCOUNT | CAMPAIGN | CASE | CONTACT | CONTRACT | DOCUMENT | GROUP | IDEA | LEAD | OPPORTUNITY | PARTNER | PRICEBOOK | PRODUCT | PROFILE | SOLUTION | TASK | USER, /* required */
          DocumentTitleFieldName: 'STRING_VALUE',
          FieldMappings: [
            {
              DataSourceFieldName: 'STRING_VALUE', /* required */
              IndexFieldName: 'STRING_VALUE', /* required */
              DateFieldFormat: 'STRING_VALUE'
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    ServiceNowConfiguration: {
      HostUrl: 'STRING_VALUE', /* required */
      SecretArn: 'STRING_VALUE', /* required */
      ServiceNowBuildVersion: LONDON | OTHERS, /* required */
      AuthenticationType: HTTP_BASIC | OAUTH2,
      KnowledgeArticleConfiguration: {
        DocumentDataFieldName: 'STRING_VALUE', /* required */
        CrawlAttachments: true || false,
        DocumentTitleFieldName: 'STRING_VALUE',
        ExcludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ],
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ],
        FilterQuery: 'STRING_VALUE',
        IncludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      ServiceCatalogConfiguration: {
        DocumentDataFieldName: 'STRING_VALUE', /* required */
        CrawlAttachments: true || false,
        DocumentTitleFieldName: 'STRING_VALUE',
        ExcludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ],
        FieldMappings: [
          {
            DataSourceFieldName: 'STRING_VALUE', /* required */
            IndexFieldName: 'STRING_VALUE', /* required */
            DateFieldFormat: 'STRING_VALUE'
          },
          /* more items */
        ],
        IncludeAttachmentFilePatterns: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    SharePointConfiguration: {
      SecretArn: 'STRING_VALUE', /* required */
      SharePointVersion: SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_ONLINE, /* required */
      Urls: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CrawlAttachments: true || false,
      DisableLocalGroups: true || false,
      DocumentTitleFieldName: 'STRING_VALUE',
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      SslCertificateS3Path: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE' /* required */
      },
      UseChangeLog: true || false,
      VpcConfiguration: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    WebCrawlerConfiguration: {
      Urls: { /* required */
        SeedUrlConfiguration: {
          SeedUrls: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          WebCrawlerMode: HOST_ONLY | SUBDOMAINS | EVERYTHING
        },
        SiteMapsConfiguration: {
          SiteMaps: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      AuthenticationConfiguration: {
        BasicAuthentication: [
          {
            Credentials: 'STRING_VALUE', /* required */
            Host: 'STRING_VALUE', /* required */
            Port: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      CrawlDepth: 'NUMBER_VALUE',
      MaxContentSizePerPageInMegaBytes: 'NUMBER_VALUE',
      MaxLinksPerPage: 'NUMBER_VALUE',
      MaxUrlsPerMinuteCrawlRate: 'NUMBER_VALUE',
      ProxyConfiguration: {
        Host: 'STRING_VALUE', /* required */
        Port: 'NUMBER_VALUE', /* required */
        Credentials: 'STRING_VALUE'
      },
      UrlExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      UrlInclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    WorkDocsConfiguration: {
      OrganizationId: 'STRING_VALUE', /* required */
      CrawlComments: true || false,
      ExclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      FieldMappings: [
        {
          DataSourceFieldName: 'STRING_VALUE', /* required */
          IndexFieldName: 'STRING_VALUE', /* required */
          DateFieldFormat: 'STRING_VALUE'
        },
        /* more items */
      ],
      InclusionPatterns: [
        'STRING_VALUE',
        /* more items */
      ],
      UseChangeLog: true || false
    }
  },
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  Schedule: 'STRING_VALUE'
};
kendra.updateDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The unique identifier of the data source to update.

    • Name — (String)

      The name of the data source to update. The name of the data source can't be updated. To rename a data source you must delete the data source and re-create it.

    • IndexId — (String)

      The identifier of the index that contains the data source to update.

    • Configuration — (map)

      Configuration information for a Amazon Kendra data source.

      • S3Configuration — (map)

        Provides information to create a data source connector for a document repository in an Amazon S3 bucket.

        • BucketName — required — (String)

          The name of the bucket that contains the documents.

        • InclusionPrefixes — (Array<String>)

          A list of S3 prefixes for the documents that should be included in the index.

        • InclusionPatterns — (Array<String>)

          A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

          Some examples are:

          • .txt will include all text files in a directory (files with the extension .txt).

          • **/.txt will include all text files in a directory and its subdirectories.

          • tax will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

        • ExclusionPatterns — (Array<String>)

          A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

          Some examples are:

          • .png , .jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

          • internal will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

          • /internal will exclude all internal-related files in a directory and its subdirectories.

        • DocumentsMetadataConfiguration — (map)

          Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

          • S3Prefix — (String)

            A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

        • AccessControlListConfiguration — (map)

          Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

          • KeyPath — (String)

            Path to the Amazon Web Services S3 bucket that contains the ACL files.

      • SharePointConfiguration — (map)

        Provides information necessary to create a data source connector for a Microsoft SharePoint site.

        • SharePointVersion — required — (String)

          The version of Microsoft SharePoint that you are using as a data source.

          Possible values include:
          • "SHAREPOINT_2013"
          • "SHAREPOINT_2016"
          • "SHAREPOINT_ONLINE"
        • Urls — required — (Array<String>)

          The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. 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. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

        • CrawlAttachments — (Boolean)

          TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

        • UseChangeLog — (Boolean)

          Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

          The regex is applied to the display URL of the SharePoint document.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

          The regex is applied to the display URL of the SharePoint document.

        • VpcConfiguration — (map)

          Provides information for connecting to an Amazon VPC.

          • SubnetIds — required — (Array<String>)

            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.

          • SecurityGroupIds — required — (Array<String>)

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

        • FieldMappings — (Array<map>)

          A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

        • DocumentTitleFieldName — (String)

          The Microsoft SharePoint attribute field that contains the title of the document.

        • DisableLocalGroups — (Boolean)

          A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

        • SslCertificateS3Path — (map)

          Information required to find a specific file in an Amazon S3 bucket.

          • Bucket — required — (String)

            The name of the S3 bucket that contains the file.

          • Key — required — (String)

            The name of the file.

      • DatabaseConfiguration — (map)

        Provides information necessary to create a data source connector for a database.

        • DatabaseEngineType — required — (String)

          The type of database engine that runs the database.

          Possible values include:
          • "RDS_AURORA_MYSQL"
          • "RDS_AURORA_POSTGRESQL"
          • "RDS_MYSQL"
          • "RDS_POSTGRESQL"
        • ConnectionConfiguration — required — (map)

          The information necessary to connect to a database.

          • DatabaseHost — required — (String)

            The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

          • DatabasePort — required — (Integer)

            The port that the database uses for connections.

          • DatabaseName — required — (String)

            The name of the database containing the document data.

          • TableName — required — (String)

            The name of the table that contains the document data.

          • SecretArn — required — (String)

            The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

        • VpcConfiguration — (map)

          Provides information for connecting to an Amazon VPC.

          • SubnetIds — required — (Array<String>)

            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.

          • SecurityGroupIds — required — (Array<String>)

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

        • ColumnConfiguration — required — (map)

          Information about where the index should get the document information from the database.

          • DocumentIdColumnName — required — (String)

            The column that provides the document's unique identifier.

          • DocumentDataColumnName — required — (String)

            The column that contains the contents of the document.

          • DocumentTitleColumnName — (String)

            The column that contains the title of the document.

          • FieldMappings — (Array<map>)

            An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • ChangeDetectingColumns — required — (Array<String>)

            One to five columns that indicate when a document in the database has changed.

        • AclConfiguration — (map)

          Information about the database column that provides information for user context filtering.

          • AllowedGroupsColumnName — required — (String)

            A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

        • SqlConfiguration — (map)

          Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

          • QueryIdentifiersEnclosingOption — (String)

            Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

            By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

            PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

            For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

            Possible values include:
            • "DOUBLE_QUOTES"
            • "NONE"
      • SalesforceConfiguration — (map)

        Provides configuration information for data sources that connect to a Salesforce site.

        • ServerUrl — required — (String)

          The instance URL for the Salesforce site that you want to index.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

          • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

          • consumerKey - The application public key generated when you created your Salesforce application.

          • consumerSecret - The application private key generated when you created your Salesforce application.

          • password - The password associated with the user logging in to the Salesforce instance.

          • securityToken - The token associated with the user account logging in to the Salesforce instance.

          • username - The user name of the user logging in to the Salesforce instance.

        • StandardObjectConfigurations — (Array<map>)

          Specifies the Salesforce standard objects that Amazon Kendra indexes.

          • Name — required — (String)

            The name of the standard object.

            Possible values include:
            • "ACCOUNT"
            • "CAMPAIGN"
            • "CASE"
            • "CONTACT"
            • "CONTRACT"
            • "DOCUMENT"
            • "GROUP"
            • "IDEA"
            • "LEAD"
            • "OPPORTUNITY"
            • "PARTNER"
            • "PRICEBOOK"
            • "PRODUCT"
            • "PROFILE"
            • "SOLUTION"
            • "TASK"
            • "USER"
          • DocumentDataFieldName — required — (String)

            The name of the field in the standard object table that contains the document contents.

          • DocumentTitleFieldName — (String)

            The name of the field in the standard object table that contains the document title.

          • FieldMappings — (Array<map>)

            One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

        • KnowledgeArticleConfiguration — (map)

          Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

          • IncludedStates — required — (Array<String>)

            Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

          • StandardKnowledgeArticleTypeConfiguration — (map)

            Provides configuration information for standard Salesforce knowledge articles.

            • DocumentDataFieldName — required — (String)

              The name of the field that contains the document data to index.

            • DocumentTitleFieldName — (String)

              The name of the field that contains the document title.

            • FieldMappings — (Array<map>)

              One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

          • CustomKnowledgeArticleTypeConfigurations — (Array<map>)

            Provides configuration information for custom Salesforce knowledge articles.

            • Name — required — (String)

              The name of the configuration.

            • DocumentDataFieldName — required — (String)

              The name of the field in the custom knowledge article that contains the document data to index.

            • DocumentTitleFieldName — (String)

              The name of the field in the custom knowledge article that contains the document title.

            • FieldMappings — (Array<map>)

              One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

              • DataSourceFieldName — required — (String)

                The name of the column or attribute in the data source.

              • DateFieldFormat — (String)

                The type of data stored in the column or attribute.

              • IndexFieldName — required — (String)

                The name of the field in the index.

        • ChatterFeedConfiguration — (map)

          Specifies configuration information for Salesforce chatter feeds.

          • DocumentDataFieldName — required — (String)

            The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

          • DocumentTitleFieldName — (String)

            The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

          • FieldMappings — (Array<map>)

            Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • IncludeFilterTypes — (Array<String>)

            Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

        • CrawlAttachments — (Boolean)

          Indicates whether Amazon Kendra should index attachments to Salesforce objects.

        • StandardObjectAttachmentConfiguration — (map)

          Provides configuration information for processing attachments to Salesforce standard objects.

          • DocumentTitleFieldName — (String)

            The name of the field used for the document title.

          • FieldMappings — (Array<map>)

            One or more objects that map fields in attachments to Amazon Kendra index fields.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

        • IncludeAttachmentFilePatterns — (Array<String>)

          A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

          The regex is applied to the name of the attached file.

        • ExcludeAttachmentFilePatterns — (Array<String>)

          A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

          The regex is applied to the name of the attached file.

      • OneDriveConfiguration — (map)

        Provides configuration for data sources that connect to Microsoft OneDrive.

        • TenantDomain — required — (String)

          The Azure Active Directory domain of the organization.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

        • OneDriveUsers — required — (map)

          A list of user accounts whose documents should be indexed.

          • OneDriveUserList — (Array<String>)

            A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain. If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

          • OneDriveUserS3Path — (map)

            The S3 bucket location of a file containing a list of users whose documents should be indexed.

            • Bucket — required — (String)

              The name of the S3 bucket that contains the file.

            • Key — required — (String)

              The name of the file.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

          The exclusion pattern is applied to the file name.

        • ExclusionPatterns — (Array<String>)

          List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.

          The exclusion pattern is applied to the file name.

        • FieldMappings — (Array<map>)

          A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

        • DisableLocalGroups — (Boolean)

          A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

      • ServiceNowConfiguration — (map)

        Provides configuration for data sources that connect to ServiceNow instances.

        • HostUrl — required — (String)

          The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

        • ServiceNowBuildVersion — required — (String)

          The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

          Possible values include:
          • "LONDON"
          • "OTHERS"
        • KnowledgeArticleConfiguration — (map)

          Provides configuration information for crawling knowledge articles in the ServiceNow site.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra should index attachments to knowledge articles.

          • IncludeAttachmentFilePatterns — (Array<String>)

            List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

          • ExcludeAttachmentFilePatterns — (Array<String>)

            List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

          • DocumentDataFieldName — required — (String)

            The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

          • DocumentTitleFieldName — (String)

            The name of the ServiceNow field that is mapped to the index document title field.

          • FieldMappings — (Array<map>)

            Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

          • FilterQuery — (String)

            A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

            The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

        • ServiceCatalogConfiguration — (map)

          Provides configuration information for crawling service catalogs in the ServiceNow site.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

          • IncludeAttachmentFilePatterns — (Array<String>)

            A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

            The regex is applied to the file name of the attachment.

          • ExcludeAttachmentFilePatterns — (Array<String>)

            A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

            The regex is applied to the file name of the attachment.

          • DocumentDataFieldName — required — (String)

            The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

          • DocumentTitleFieldName — (String)

            The name of the ServiceNow field that is mapped to the index document title field.

          • FieldMappings — (Array<map>)

            Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

            • DataSourceFieldName — required — (String)

              The name of the column or attribute in the data source.

            • DateFieldFormat — (String)

              The type of data stored in the column or attribute.

            • IndexFieldName — required — (String)

              The name of the field in the index.

        • AuthenticationType — (String)

          Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

          When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

          Possible values include:
          • "HTTP_BASIC"
          • "OAUTH2"
      • ConfluenceConfiguration — (map)

        Provides configuration information for connecting to a Confluence data source.

        • ServerUrl — required — (String)

          The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

          • username - The user name or email address of a user with administrative privileges for the Confluence server.

          • password - The password associated with the user logging in to the Confluence server.

        • Version — required — (String)

          Specifies the version of the Confluence installation that you are connecting to.

          Possible values include:
          • "CLOUD"
          • "SERVER"
        • SpaceConfiguration — (map)

          Specifies configuration information for indexing Confluence spaces.

          • CrawlPersonalSpaces — (Boolean)

            Specifies whether Amazon Kendra should index personal spaces. Users 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.

          • CrawlArchivedSpaces — (Boolean)

            Specifies whether Amazon Kendra should index archived spaces.

          • IncludeSpaces — (Array<String>)

            A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

          • ExcludeSpaces — (Array<String>)

            A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

          • SpaceFieldMappings — (Array<map>)

            Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              Possible values include:
              • "DISPLAY_URL"
              • "ITEM_TYPE"
              • "SPACE_KEY"
              • "URL"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • PageConfiguration — (map)

          Specifies configuration information for indexing Confluence pages.

          • PageFieldMappings — (Array<map>)

            Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              Possible values include:
              • "AUTHOR"
              • "CONTENT_STATUS"
              • "CREATED_DATE"
              • "DISPLAY_URL"
              • "ITEM_TYPE"
              • "LABELS"
              • "MODIFIED_DATE"
              • "PARENT_ID"
              • "SPACE_KEY"
              • "SPACE_NAME"
              • "URL"
              • "VERSION"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • BlogConfiguration — (map)

          Specifies configuration information for indexing Confluence blogs.

          • BlogFieldMappings — (Array<map>)

            Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              Possible values include:
              • "AUTHOR"
              • "DISPLAY_URL"
              • "ITEM_TYPE"
              • "LABELS"
              • "PUBLISH_DATE"
              • "SPACE_KEY"
              • "SPACE_NAME"
              • "URL"
              • "VERSION"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • AttachmentConfiguration — (map)

          Specifies configuration information for indexing attachments to Confluence blogs and pages.

          • CrawlAttachments — (Boolean)

            Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

          • AttachmentFieldMappings — (Array<map>)

            Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

            If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

            • DataSourceFieldName — (String)

              The name of the field in the data source.

              You must first create the index field using the UpdateIndex operation.

              Possible values include:
              • "AUTHOR"
              • "CONTENT_TYPE"
              • "CREATED_DATE"
              • "DISPLAY_URL"
              • "FILE_SIZE"
              • "ITEM_TYPE"
              • "PARENT_ID"
              • "SPACE_KEY"
              • "SPACE_NAME"
              • "URL"
              • "VERSION"
            • DateFieldFormat — (String)

              The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

            • IndexFieldName — (String)

              The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

        • VpcConfiguration — (map)

          Specifies the information for connecting to an Amazon VPC.

          • SubnetIds — required — (Array<String>)

            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.

          • SecurityGroupIds — required — (Array<String>)

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.

      • GoogleDriveConfiguration — (map)

        Provides configuration for data sources that connect to Google Drive.

        • SecretArn — required — (String)

          The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.

        • FieldMappings — (Array<map>)

          Defines mapping between a field in the Google Drive and a Amazon Kendra index field.

          If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

        • ExcludeMimeTypes — (Array<String>)

          A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

          For a list of MIME types, see Using a Google Workspace Drive data source.

        • ExcludeUserAccounts — (Array<String>)

          A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

        • ExcludeSharedDrives — (Array<String>)

          A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

      • WebCrawlerConfiguration — (map)

        Provides the configuration information required for Amazon Kendra web crawler.

        • Urls — required — (map)

          Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

          You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

          When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

          • SeedUrlConfiguration — (map)

            Provides the configuration of the seed or starting point URLs of the websites you want to crawl.

            You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

            You can list up to 100 seed URLs.

            • SeedUrls — required — (Array<String>)

              The list of seed or starting point URLs of the websites you want to crawl.

              The list can include a maximum of 100 seed URLs.

            • WebCrawlerMode — (String)

              You can choose one of the following modes:

              • HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

              • SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

              • EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

              The default mode is set to HOST_ONLY.

              Possible values include:
              • "HOST_ONLY"
              • "SUBDOMAINS"
              • "EVERYTHING"
          • SiteMapsConfiguration — (map)

            Provides the configuration of the sitemap URLs of the websites you want to crawl.

            Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

            • SiteMaps — required — (Array<String>)

              The list of sitemap URLs of the websites you want to crawl.

              The list can include a maximum of three sitemap URLs.

        • CrawlDepth — (Integer)

          Specifies the number of levels in a website that you want to crawl.

          The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

          The default crawl depth is set to 2.

        • MaxLinksPerPage — (Integer)

          The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

          As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

          The default maximum links per page is 100.

        • MaxContentSizePerPageInMegaBytes — (Float)

          The maximum size (in MB) of a webpage or attachment to crawl.

          Files larger than this size (in MB) are skipped/not crawled.

          The default maximum size of a webpage or attachment is set to 50 MB.

        • MaxUrlsPerMinuteCrawlRate — (Integer)

          The maximum number of URLs crawled per website host per minute.

          A minimum of one URL is required.

          The default maximum number of URLs crawled per website host per minute is 300.

        • UrlInclusionPatterns — (Array<String>)

          The regular expression pattern to include certain URLs to crawl.

          If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.

        • UrlExclusionPatterns — (Array<String>)

          The regular expression pattern to exclude certain URLs to crawl.

          If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.

        • ProxyConfiguration — (map)

          Provides configuration information required to connect to your internal websites via a web proxy.

          You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

          Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.

          • Host — required — (String)

            The name of the website host you want to connect to via a web proxy server.

            For example, the host name of https://a.example.com/page1.html is "a.example.com".

          • Port — required — (Integer)

            The port number of the website host you want to connect to via a web proxy server.

            For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

          • Credentials — (String)

            Your secret ARN, which you can create in AWS Secrets Manager

            The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

        • AuthenticationConfiguration — (map)

          Provides configuration information required to connect to websites using authentication.

          You can connect to websites using basic authentication of user name and password.

          You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.

          • BasicAuthentication — (Array<map>)

            The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

            The list includes the name and port number of the website host.

            • Host — required — (String)

              The name of the website host you want to connect to using authentication credentials.

              For example, the host name of https://a.example.com/page1.html is "a.example.com".

            • Port — required — (Integer)

              The port number of the website host you want to connect to using authentication credentials.

              For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

            • Credentials — required — (String)

              Your secret ARN, which you can create in AWS Secrets Manager

              You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

      • WorkDocsConfiguration — (map)

        Provides the configuration information to connect to WorkDocs as your data source.

        • OrganizationId — required — (String)

          The identifier of the directory corresponding to your Amazon WorkDocs site repository.

          You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

        • CrawlComments — (Boolean)

          TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

          The default is set to FALSE.

        • UseChangeLog — (Boolean)

          TRUE to use the change logs to update documents in your index instead of scanning all documents.

          If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.

          The default is set to FALSE.

        • InclusionPatterns — (Array<String>)

          A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. 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.

        • ExclusionPatterns — (Array<String>)

          A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. 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.

        • FieldMappings — (Array<map>)

          A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.

          • DataSourceFieldName — required — (String)

            The name of the column or attribute in the data source.

          • DateFieldFormat — (String)

            The type of data stored in the column or attribute.

          • IndexFieldName — required — (String)

            The name of the field in the index.

    • Description — (String)

      The new description for the data source.

    • Schedule — (String)

      The new update schedule for the data source.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateIndex(params = {}, callback) ⇒ AWS.Request

Updates an existing Amazon Kendra index.

Service Reference:

Examples:

Calling the updateIndex operation

var params = {
  Id: 'STRING_VALUE', /* required */
  CapacityUnits: {
    QueryCapacityUnits: 'NUMBER_VALUE', /* required */
    StorageCapacityUnits: 'NUMBER_VALUE' /* required */
  },
  Description: 'STRING_VALUE',
  DocumentMetadataConfigurationUpdates: [
    {
      Name: 'STRING_VALUE', /* required */
      Type: STRING_VALUE | STRING_LIST_VALUE | LONG_VALUE | DATE_VALUE, /* required */
      Relevance: {
        Duration: 'STRING_VALUE',
        Freshness: true || false,
        Importance: 'NUMBER_VALUE',
        RankOrder: ASCENDING | DESCENDING,
        ValueImportanceMap: {
          '<ValueImportanceMapKey>': 'NUMBER_VALUE',
          /* '<ValueImportanceMapKey>': ... */
        }
      },
      Search: {
        Displayable: true || false,
        Facetable: true || false,
        Searchable: true || false,
        Sortable: true || false
      }
    },
    /* more items */
  ],
  Name: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  UserContextPolicy: ATTRIBUTE_FILTER | USER_TOKEN,
  UserTokenConfigurations: [
    {
      JsonTokenTypeConfiguration: {
        GroupAttributeField: 'STRING_VALUE', /* required */
        UserNameAttributeField: 'STRING_VALUE' /* required */
      },
      JwtTokenTypeConfiguration: {
        KeyLocation: URL | SECRET_MANAGER, /* required */
        ClaimRegex: 'STRING_VALUE',
        GroupAttributeField: 'STRING_VALUE',
        Issuer: 'STRING_VALUE',
        SecretManagerArn: 'STRING_VALUE',
        URL: 'STRING_VALUE',
        UserNameAttributeField: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
kendra.updateIndex(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the index to update.

    • Name — (String)

      The name of the index to update.

    • RoleArn — (String)

      A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

    • Description — (String)

      A new description for the index.

    • DocumentMetadataConfigurationUpdates — (Array<map>)

      The document metadata to update.

      • Name — required — (String)

        The name of the index field.

      • Type — required — (String)

        The data type of the index field.

        Possible values include:
        • "STRING_VALUE"
        • "STRING_LIST_VALUE"
        • "LONG_VALUE"
        • "DATE_VALUE"
      • Relevance — (map)

        Provides manual tuning parameters to determine how the field affects the search results.

        • Freshness — (Boolean)

          Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

        • Importance — (Integer)

          The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

        • Duration — (String)

          Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

          Only applies to DATE fields.

        • RankOrder — (String)

          Determines how values should be interpreted.

          When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

          When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

          Only applies to LONG and DOUBLE fields.

          Possible values include:
          • "ASCENDING"
          • "DESCENDING"
        • ValueImportanceMap — (map<Integer>)

          A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

          For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

      • Search — (map)

        Provides information about how the field is used during a search.

        • Facetable — (Boolean)

          Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

        • Searchable — (Boolean)

          Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

        • Displayable — (Boolean)

          Determines whether the field is returned in the query response. The default is true.

        • Sortable — (Boolean)

          Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

    • CapacityUnits — (map)

      Sets the number of additional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day.

      If you are using extra storage units, you can't reduce the storage capacity below that required to meet the storage needs for your index.

      • StorageCapacityUnits — required — (Integer)

        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.

      • QueryCapacityUnits — required — (Integer)

        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).

    • UserTokenConfigurations — (Array<map>)

      The user token configuration.

      • JwtTokenTypeConfiguration — (map)

        Information about the JWT token type configuration.

        • KeyLocation — required — (String)

          The location of the key.

          Possible values include:
          • "URL"
          • "SECRET_MANAGER"
        • URL — (String)

          The signing key URL.

        • SecretManagerArn — (String)

          The Amazon Resource Name (arn) of the secret.

        • UserNameAttributeField — (String)

          The user name attribute field.

        • GroupAttributeField — (String)

          The group attribute field.

        • Issuer — (String)

          The issuer of the token.

        • ClaimRegex — (String)

          The regular expression that identifies the claim.

      • JsonTokenTypeConfiguration — (map)

        Information about the JSON token type configuration.

        • UserNameAttributeField — required — (String)

          The user name attribute field.

        • GroupAttributeField — required — (String)

          The group attribute field.

    • UserContextPolicy — (String)

      The user user token context policy.

      Possible values include:
      • "ATTRIBUTE_FILTER"
      • "USER_TOKEN"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateQuerySuggestionsBlockList(params = {}, callback) ⇒ AWS.Request

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

Service Reference:

Examples:

Calling the updateQuerySuggestionsBlockList operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  SourceS3Path: {
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE' /* required */
  }
};
kendra.updateQuerySuggestionsBlockList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index for a block list.

    • Id — (String)

      The unique identifier of a block list.

    • Name — (String)

      The name of a block list.

    • Description — (String)

      The description for a block list.

    • SourceS3Path — (map)

      The S3 path where your block list text file sits in S3.

      If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

      If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

      • Bucket — required — (String)

        The name of the S3 bucket that contains the file.

      • Key — required — (String)

        The name of the file.

    • RoleArn — (String)

      The IAM (Identity and Access Management) role used to access the block list text file in S3.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateQuerySuggestionsConfig(params = {}, callback) ⇒ AWS.Request

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

Service Reference:

Examples:

Calling the updateQuerySuggestionsConfig operation

var params = {
  IndexId: 'STRING_VALUE', /* required */
  IncludeQueriesWithoutUserInformation: true || false,
  MinimumNumberOfQueryingUsers: 'NUMBER_VALUE',
  MinimumQueryCount: 'NUMBER_VALUE',
  Mode: ENABLED | LEARN_ONLY,
  QueryLogLookBackWindowInDays: 'NUMBER_VALUE'
};
kendra.updateQuerySuggestionsConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IndexId — (String)

      The identifier of the index you want to update query suggestions settings for.

    • Mode — (String)

      Set the mode to ENABLED or LEARN_ONLY.

      By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

      In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

      Possible values include:
      • "ENABLED"
      • "LEARN_ONLY"
    • QueryLogLookBackWindowInDays — (Integer)

      How recent your queries are in your query log time window.

      The time window is the number of days from current day to past days.

      By default, Amazon Kendra sets this to 180.

    • IncludeQueriesWithoutUserInformation — (Boolean)

      TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

      If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

      If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

      If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

    • MinimumNumberOfQueryingUsers — (Integer)

      The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

      Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

      How you tune this setting depends on your specific needs.

    • MinimumQueryCount — (Integer)

      The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

      Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

      How you tune this setting depends on your specific needs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateThesaurus(params = {}, callback) ⇒ AWS.Request

Updates a thesaurus file associated with an index.

Service Reference:

Examples:

Calling the updateThesaurus operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IndexId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  SourceS3Path: {
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE' /* required */
  }
};
kendra.updateThesaurus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the thesaurus to update.

    • Name — (String)

      The updated name of the thesaurus.

    • IndexId — (String)

      The identifier of the index associated with the thesaurus to update.

    • Description — (String)

      The updated description of the thesaurus.

    • RoleArn — (String)

      The updated role ARN of the thesaurus.

    • SourceS3Path — (map)

      Information required to find a specific file in an Amazon S3 bucket.

      • Bucket — required — (String)

        The name of the S3 bucket that contains the file.

      • Key — required — (String)

        The name of the file.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.