String id
The identifier of the access control configuration.
String keyPath
Path to the Amazon Web Services S3 bucket that contains the ACL files.
String allowedGroupsColumnName
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 API.
String key
The key that identifies the attribute.
String valueType
The data type of the Value property.
AdditionalResultAttributeValue value
An object that contains the attribute value.
TextWithHighlights textWithHighlightsValue
The text associated with the attribute and information about the highlight to apply to the text.
String siteUrl
The URL of the Alfresco site. For example, https://hostname:8080.
String siteId
The identifier of the Alfresco site. For example, my-site.
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:
username—The user name of the Alfresco account.
password—The password of the Alfresco account.
S3Path sslCertificateS3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco.
Boolean crawlSystemFolders
TRUE to index shared files.
Boolean crawlComments
TRUE to index comments of blogs and other content.
List<E> entityFilter
Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
List<E> documentLibraryFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco
document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Alfresco fields. For more information, see Mapping data source fields. The
Alfresco data source field names must exist in your Alfresco custom metadata.
List<E> blogFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Alfresco fields. For more information, see Mapping data source fields. The
Alfresco data source field names must exist in your Alfresco custom metadata.
List<E> wikiFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Alfresco fields. For more information, see Mapping data source fields. The
Alfresco data source field names must exist in your Alfresco custom metadata.
List<E> inclusionPatterns
A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
String id
The identifier of your Amazon Kendra experience.
String indexId
The identifier of the index for your Amazon Kendra experience.
List<E> personas
The personas that define the specific permissions of users or groups in your Amazon Web Services SSO identity
source. The available personas or access roles are Owner and Viewer. For more
information on these personas, see Providing access to your search page.
List<E> andAllFilters
Performs a logical AND operation on all supplied filters.
List<E> orAllFilters
Performs a logical OR operation on all supplied filters.
AttributeFilter notFilter
Performs a logical NOT operation on all supplied filters.
DocumentAttribute equalsTo
Performs an equals operation on two document attributes.
DocumentAttribute containsAll
Returns true when a document contains all of the specified document attributes. This filter is only applicable to
StringListValue metadata.
DocumentAttribute containsAny
Returns true when a document contains any of the specified document attributes. This filter is only applicable to
StringListValue metadata.
DocumentAttribute greaterThan
Performs a greater than operation on two document attributes. Use with a document attribute of type
Date or Long.
DocumentAttribute greaterThanOrEquals
Performs a greater or equals than operation on two document attributes. Use with a document attribute of type
Date or Long.
DocumentAttribute lessThan
Performs a less than operation on two document attributes. Use with a document attribute of type
Date or Long.
DocumentAttribute lessThanOrEquals
Performs a less than or equals operation on two document attributes. Use with a document attribute of type
Date or Long.
String host
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".
Integer port
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.
String credentials
Your secret ARN, which you can create in 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.
String indexId
The identifier of the index that contains the documents to delete.
List<E> documentIdList
One or more identifiers for documents to delete from the index.
DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget
String indexId
The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
List<E> documentInfoList
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.
String documentId
The unique identifier of the document whose status could not be retrieved.
String errorCode
Indicates the source of the error.
String errorMessage
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.
List<E> errors
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.
List<E> documentStatusList
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.
String indexId
The identifier of the index to add the documents to. You need to create the index first using the
CreateIndex API.
String roleArn
The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more
information, see IAM Roles for Amazon
Kendra.
List<E> documents
One or more documents to add to the index.
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.
CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration
Configuration information for altering your document metadata and content during the document ingestion process
when you use the BatchPutDocument API.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
List<E> failedDocuments
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
String enterpriseId
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Authentication for a Box data source.
Boolean useChangeLog
TRUE to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than
to scan all of your documents.
Boolean crawlComments
TRUE to index comments.
Boolean crawlTasks
TRUE to index the contents of tasks.
Boolean crawlWebLinks
TRUE to index web links.
List<E> fileFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
List<E> taskFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
List<E> commentFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
List<E> webLinkFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
List<E> inclusionPatterns
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
Integer storageCapacityUnits
The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
Integer queryCapacityUnits
The amount of extra query capacity for an index and GetQuerySuggestions capacity.
A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.
GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base
capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries
per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another
0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions
capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
String indexId
The identifier of the index you want to clear query suggestions from.
String documentIdColumnName
The column that provides the document's unique identifier.
String documentDataColumnName
The column that contains the contents of the document.
String documentTitleColumnName
The column that contains the title of the document.
List<E> fieldMappings
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 API.
List<E> changeDetectingColumns
One to five columns that indicate when a document in the database has changed.
Boolean crawlAttachments
TRUE to index attachments of pages and blogs in Confluence.
List<E> attachmentFieldMappings
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom
fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
Confluence data source field names must exist in your Confluence custom metadata.
If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
String dataSourceFieldName
The name of the field in the data source.
You must first create the index field using the UpdateIndex API.
String dateFieldFormat
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.
String indexFieldName
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
List<E> blogFieldMappings
Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields,
use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
Confluence data source field names must exist in your Confluence custom metadata.
If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.
String dataSourceFieldName
The name of the field in the data source.
String dateFieldFormat
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.
String indexFieldName
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
String serverUrl
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/.
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.
String version
The version or the type of Confluence installation to connect to.
ConfluenceSpaceConfiguration spaceConfiguration
Configuration information for indexing Confluence spaces.
ConfluencePageConfiguration pageConfiguration
Configuration information for indexing Confluence pages.
ConfluenceBlogConfiguration blogConfiguration
Configuration information for indexing Confluence blogs.
ConfluenceAttachmentConfiguration attachmentConfiguration
Configuration information for indexing attachments to Confluence blogs and pages.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
List<E> inclusionPatterns
A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
List<E> pageFieldMappings
Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields,
use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
Confluence data source field names must exist in your Confluence custom metadata.
If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
String dataSourceFieldName
The name of the field in the data source.
String dateFieldFormat
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.
String indexFieldName
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
Boolean crawlPersonalSpaces
TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal
spaces are indexed, queries without user context information may return restricted items from a personal space in
their results. For more information, see Filtering on user context.
Boolean crawlArchivedSpaces
TRUE to index archived spaces.
List<E> includeSpaces
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.
List<E> excludeSpaces
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.
List<E> spaceFieldMappings
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields,
use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
Confluence data source field names must exist in your Confluence custom metadata.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
String dataSourceFieldName
The name of the field in the data source.
String dateFieldFormat
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.
String indexFieldName
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
String databaseHost
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
Integer databasePort
The port that the database uses for connections.
String databaseName
The name of the database containing the document data.
String tableName
The name of the table that contains the document data.
String secretArn
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.
List<E> dataSourceIds
The identifier of the data sources you want to use for your Amazon Kendra experience.
List<E> faqIds
The identifier of the FAQs that you want to use for your Amazon Kendra experience.
Boolean directPutContent
TRUE to use documents you indexed directly using the BatchPutDocument API.
Integer beginOffset
The zero-based location in the response string or text where the corrected word starts.
Integer endOffset
The zero-based location in the response string or text where the corrected word ends.
String term
The string or text of a misspelled word in a query.
String correctedTerm
The string or text of a corrected misspelled word in a query.
String indexId
The identifier of the index to create an access control configuration for your documents.
String name
A name for the access control configuration.
String description
A description for the access control configuration.
List<E> accessControlList
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
List<E> hierarchicalAccessControlList
The list of principal lists that define the hierarchy for which documents users should have access to.
String clientToken
A token that you provide to identify the request to create an access control configuration. Multiple calls to the
CreateAccessControlConfiguration API with the same client token will create only one access control
configuration.
String id
The identifier of the access control configuration for your documents in an index.
String name
A unique name for the data source connector. A data source name can't be changed without deleting and recreating the data source connector.
String indexId
The identifier of the index you want to use with the data source connector.
String type
The type of data source repository. For example, SHAREPOINT.
DataSourceConfiguration configuration
Configuration information to connect to your data source 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.
String description
A description for the data source connector.
String schedule
Sets the frequency for Amazon Kendra to check the documents in your data source 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 API 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.
String roleArn
The Amazon Resource Name (ARN) of a role with permission to access the data source connector. 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.
List<E> tags
A list of key-value pairs that identify the data source connector. You can use the tags to identify and organize your resources and to control access to resources.
String clientToken
A token that you provide to identify the request to create a data source connector. Multiple calls to the
CreateDataSource API with the same client token will create only one data source connector.
String languageCode
The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration
Configuration information for altering document metadata and content during the document ingestion process.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
String id
The identifier of the data source connector.
String name
A name for your Amazon Kendra experience.
String indexId
The identifier of the index for your Amazon Kendra experience.
String roleArn
The Amazon Resource Name (ARN) of a role with permission to access Query API,
QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your
user and group information. For more information, see IAM roles for Amazon Kendra.
ExperienceConfiguration configuration
Configuration information for your Amazon Kendra experience. This includes
ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and
UserIdentityConfiguration, which specifies the user or group information to grant access to your
Amazon Kendra experience.
String description
A description for your Amazon Kendra experience.
String clientToken
A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the
CreateExperience API with the same client token creates only one Amazon Kendra experience.
String id
The identifier for your created Amazon Kendra experience.
String indexId
The identifier of the index for the FAQ.
String name
A name for the FAQ.
String description
A description for the FAQ.
S3Path s3Path
The path to the FAQ file in S3.
String roleArn
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.
List<E> tags
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.
String fileFormat
The format of the FAQ 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.
String clientToken
A token that you provide to identify the request to create a FAQ. Multiple calls to the
CreateFaqRequest API with the same client token will create only one FAQ.
String languageCode
The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
String id
The unique identifier of the FAQ.
String name
A name for the index.
String edition
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.
String roleArn
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 you use when you call the BatchPutDocument API to
index documents from an Amazon S3 bucket.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
String description
A description for the index.
String clientToken
A token that you provide to identify the request to create an index. Multiple calls to the
CreateIndex API with the same client token will create only one index.
List<E> tags
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.
List<E> userTokenConfigurations
The user token configuration.
String userContextPolicy
The user context policy.
All indexed content is searchable and displayable for all users. If you want to filter search results on user
context, you can use the attribute filters of _user_id and _group_ids or you can
provide user and group information in UserContext.
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
UserGroupResolutionConfiguration userGroupResolutionConfiguration
Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.
String id
The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.
String indexId
The identifier of the index you want to create a query suggestions block list for.
String name
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.
String description
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."
S3Path sourceS3Path
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.
String clientToken
A token that you provide to identify the request to create a query suggestions block list.
String roleArn
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 Web Services 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.
List<E> tags
A tag that you can assign to a block list that categorizes the block list.
String id
The unique identifier of the created block list.
String indexId
The identifier of the index for the thesaurus.
String name
A name for the thesaurus.
String description
A description for the thesaurus.
String roleArn
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
List<E> tags
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.
S3Path sourceS3Path
The path to the thesaurus file in S3.
String clientToken
A token that you provide to identify the request to create a thesaurus. Multiple calls to the
CreateThesaurus API with the same client token will create only one thesaurus.
String id
The unique identifier of the thesaurus.
List<E> inlineConfigurations
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
HookConfiguration preExtractionHookConfiguration
Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.
HookConfiguration postExtractionHookConfiguration
Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.
String roleArn
The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and
PostExtractionHookConfiguration for altering document metadata and content during the document
ingestion process. For more information, see IAM roles for Amazon Kendra.
String databaseEngineType
The type of database engine that runs the database.
ConnectionConfiguration connectionConfiguration
Configuration information that's required to connect to a database.
DataSourceVpcConfiguration vpcConfiguration
ColumnConfiguration columnConfiguration
Information about where the index should get the document information from the database.
AclConfiguration aclConfiguration
Information about the database column that provides information for user context filtering.
SqlConfiguration sqlConfiguration
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
S3DataSourceConfiguration s3Configuration
Provides the configuration information to connect to an Amazon S3 bucket as your data source.
SharePointConfiguration sharePointConfiguration
Provides the configuration information to connect to Microsoft SharePoint as your data source.
DatabaseConfiguration databaseConfiguration
Provides the configuration information to connect to a database as your data source.
SalesforceConfiguration salesforceConfiguration
Provides the configuration information to connect to Salesforce as your data source.
OneDriveConfiguration oneDriveConfiguration
Provides the configuration information to connect to Microsoft OneDrive as your data source.
ServiceNowConfiguration serviceNowConfiguration
Provides the configuration information to connect to ServiceNow as your data source.
ConfluenceConfiguration confluenceConfiguration
Provides the configuration information to connect to Confluence as your data source.
GoogleDriveConfiguration googleDriveConfiguration
Provides the configuration information to connect to Google Drive as your data source.
WebCrawlerConfiguration webCrawlerConfiguration
WorkDocsConfiguration workDocsConfiguration
Provides the configuration information to connect to Amazon WorkDocs as your data source.
FsxConfiguration fsxConfiguration
Provides the configuration information to connect to Amazon FSx as your data source.
SlackConfiguration slackConfiguration
Provides the configuration information to connect to Slack as your data source.
BoxConfiguration boxConfiguration
Provides the configuration information to connect to Box as your data source.
QuipConfiguration quipConfiguration
Provides the configuration information to connect to Quip as your data source.
JiraConfiguration jiraConfiguration
Provides the configuration information to connect to Jira as your data source.
GitHubConfiguration gitHubConfiguration
Provides the configuration information to connect to GitHub as your data source.
AlfrescoConfiguration alfrescoConfiguration
Provides the configuration information to connect to Alfresco as your data source.
String groupId
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.
String dataSourceId
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.
String name
The name of the data source.
String id
The unique identifier for the data source.
String type
The type of the data source.
Date createdAt
The UNIX datetime that the data source was created.
Date updatedAt
The UNIX datetime that the data source was lasted updated.
String status
The status of the data source. When the status is ACTIVE the data source is ready to use.
String languageCode
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
String executionId
A unique identifier for the synchronization job.
Date startTime
The UNIX datetime that the synchronization job started.
Date endTime
The UNIX datetime that the synchronization job completed.
String status
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.
String errorMessage
If the Status field is set to ERROR, the ErrorMessage field contains a
description of the error that caused the synchronization to fail.
String errorCode
If the Status field is set to FAILED, the ErrorCode field indicates the
reason the synchronization failed.
String dataSourceErrorCode
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.
DataSourceSyncJobMetrics metrics
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.
String documentsAdded
The number of documents added from the data source up to now in the data source sync.
String documentsModified
The number of documents modified in the data source up to now in the data source sync run.
String documentsDeleted
The number of documents deleted from the data source up to now in the data source sync run.
String documentsFailed
The number of documents that failed to sync from the data source up to now in the data source sync run.
String documentsScanned
The current number of documents crawled by the current sync job in the data source.
String dataSourceId
The ID of the data source that is running the sync job.
String dataSourceSyncJobId
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.
List<E> subnetIds
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.
List<E> securityGroupIds
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
String id
The identifier of the index you want to delete.
String indexId
The identifier of the index you want to delete a group from.
String dataSourceId
The identifier of the data source you want to delete a group from.
A group can be tied to multiple data sources. You can 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.
String groupId
The identifier of the group you want to delete.
Long orderingId
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.
String name
The name for the access control configuration.
String description
The description for the access control configuration.
String errorMessage
The error message containing details if there are issues processing the access control configuration.
List<E> accessControlList
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
List<E> hierarchicalAccessControlList
The list of principal lists that define the hierarchy for which documents users should have access to.
String id
The identifier of the data source.
String indexId
The identifier of the index that contains the data source.
String name
The name that you gave the data source when it was created.
String type
The type of the data source.
DataSourceConfiguration configuration
Configuration details for the data source. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
Date createdAt
The Unix timestamp of when the data source was created.
Date updatedAt
The Unix timestamp of when the data source was last updated.
String description
The description for the data source.
String status
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.
String schedule
The schedule for Amazon Kendra to update the index.
String roleArn
The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
String errorMessage
When the Status field value is FAILED, the ErrorMessage field contains a
description of the error that caused the data source to fail.
String languageCode
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration
Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
String id
Shows the identifier of your Amazon Kendra experience.
String indexId
Shows the identifier of the index for your Amazon Kendra experience.
String name
Shows the name of your Amazon Kendra experience.
List<E> endpoints
Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
ExperienceConfiguration configuration
Shows the configuration information for your Amazon Kendra experience. This includes
ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and
UserIdentityConfiguration, which specifies the user or group information to grant access to your
Amazon Kendra experience.
Date createdAt
Shows the date-time your Amazon Kendra experience was created.
Date updatedAt
Shows the date-time your Amazon Kendra experience was last updated.
String description
Shows the description for your Amazon Kendra experience.
String status
The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your
Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage
field contains the reason that this failed.
String roleArn
Shows the Amazon Resource Name (ARN) of a role with permission to access Query API,
QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your
user and group information.
String errorMessage
The reason your Amazon Kendra experience could not properly process.
String id
The identifier of the FAQ.
String indexId
The identifier of the index for the FAQ.
String name
The name that you gave the FAQ when it was created.
String description
The description of the FAQ that you provided when it was created.
Date createdAt
The date and time that the FAQ was created.
Date updatedAt
The date and time that the FAQ was last updated.
S3Path s3Path
String status
The status of the FAQ. It is ready to use when the status is ACTIVE.
String roleArn
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
String errorMessage
If the Status field is FAILED, the ErrorMessage field contains the reason
why the FAQ failed.
String fileFormat
The file format used by the input files for the FAQ.
String languageCode
The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
String id
The identifier of the index you want to get information on.
String name
The name of the index.
String id
The identifier of the index.
String edition
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
String status
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.
String description
The description for the index.
Date createdAt
The Unix datetime that the index was created.
Date updatedAt
The Unix datetime that the index was last updated.
List<E> documentMetadataConfigurations
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
IndexStatistics indexStatistics
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
String errorMessage
When the Status field value is FAILED, the ErrorMessage field contains a
message that explains why.
CapacityUnitsConfiguration capacityUnits
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 query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
List<E> userTokenConfigurations
The user token configuration for the Amazon Kendra index.
String userContextPolicy
The user context policy for the Amazon Kendra index.
UserGroupResolutionConfiguration userGroupResolutionConfiguration
Whether you have enabled the configuration for fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source.
String indexId
The identifier of the index required to check the processing of PUT and DELETE actions
for mapping users to their groups.
String dataSourceId
The identifier of the data source to check the processing of PUT and DELETE actions for
mapping users to their groups.
String groupId
The identifier of the group required to check the processing of PUT and DELETE actions
for mapping users to their groups.
String indexId
Shows the identifier of the index to see information on the processing of PUT and
DELETE actions for mapping users to their groups.
String dataSourceId
Shows the identifier of the data source to see information on the processing of PUT and
DELETE actions for mapping users to their groups.
String groupId
Shows the identifier of the group to see information on the processing of PUT and
DELETE actions for mapping users to their groups.
List<E> groupOrderingIdSummaries
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.
String indexId
The identifier of the index for the block list.
String id
The identifier of the block list.
String name
The name of the block list.
String description
The description for the block list.
String status
The current status of the block list. When the value is ACTIVE, the block list is ready for use.
String errorMessage
The error message containing details if there are issues processing the block list.
Date createdAt
The date-time a block list for query suggestions was created.
Date updatedAt
The date-time a block list for query suggestions was last updated.
S3Path sourceS3Path
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.
Integer itemCount
The current number of valid, non-empty words or phrases in the block list text file.
Long fileSizeBytes
The current size of the block list text file in S3.
String roleArn
The 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.
String indexId
The identifier of the index with query suggestions that you want to get information on.
String mode
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 API.
String status
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.
Integer queryLogLookBackWindowInDays
How recent your queries are in your query log time window (in days).
Boolean includeQueriesWithoutUserInformation
TRUE to use all queries, otherwise use only queries that include user information to generate the
query suggestions.
Integer minimumNumberOfQueryingUsers
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
Integer minimumQueryCount
The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
Date lastSuggestionsBuildTime
The date-time query suggestions for an index was last updated.
Date lastClearTime
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.
Integer totalSuggestionsCount
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.
String id
The identifier of the thesaurus.
String indexId
The identifier of the index for the thesaurus.
String name
The thesaurus name.
String description
The thesaurus description.
String status
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.
String errorMessage
When the Status field value is FAILED, the ErrorMessage field provides
more information.
Date createdAt
The Unix datetime that the thesaurus was created.
Date updatedAt
The Unix datetime that the thesaurus was last updated.
String roleArn
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
S3Path sourceS3Path
Long fileSizeBytes
The size of the thesaurus file in bytes.
Long termCount
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.
Long synonymRuleCount
The number of synonym rules in the thesaurus file.
String id
The identifier of your Amazon Kendra experience.
String indexId
The identifier of the index for your Amazon Kendra experience.
List<E> entityIds
The identifiers of users or groups in your Amazon Web Services SSO identity source. For example, user IDs could be user emails.
String id
A unique identifier of the document in the index.
Note, each document ID must be unique per index. You cannot create a data source to index your documents with
their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa.
You can delete a data source and then use the BatchPutDocument API to index the same documents, or
vice versa.
String title
The title of the document.
ByteBuffer blob
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 APIs. If you are calling
the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
S3Path s3Path
List<E> attributes
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.
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.
List<E> accessControlList
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
List<E> hierarchicalAccessControlList
The list of principal lists that define the hierarchy for which documents users should have access to.
String contentType
The file type of the document in the Blob field.
String accessControlConfigurationId
The identifier of the access control configuration that you want to apply to the document.
String key
The identifier for the attribute.
DocumentAttributeValue value
The value of the attribute.
String conditionDocumentAttributeKey
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Kendra currently does not support _document_body as an attribute key used for the condition.
String operator
The condition operator.
For example, you can use 'Contains' to partially match a string.
DocumentAttributeValue conditionOnValue
The value used by the operator.
For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.
String targetDocumentAttributeKey
The identifier of the target document attribute or metadata field.
For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
Boolean targetDocumentAttributeValueDeletion
TRUE to delete the existing target value for your specified target attribute key. You cannot create
a target value and set this to TRUE. To create a target value (
TargetDocumentAttributeValue), set this to FALSE.
DocumentAttributeValue targetDocumentAttributeValue
The target value you want to create for the target attribute.
For example, 'Finance' could be the target value for the target attribute key 'Department'.
String stringValue
A string, such as "department".
List<E> stringListValue
A list of strings.
Long longValue
A long integer value.
Date dateValue
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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
DocumentAttributeValue documentAttributeValue
The value of the attribute. For example, "HR".
Integer count
The number of documents in the response that have the attribute value for the key.
List<E> facetResults
Contains the results of a document attribute that is a nested facet. A FacetResult contains the
counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
String documentId
The unique identifier of the document.
List<E> attributes
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".
String s3Prefix
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.
String entityId
The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.
String persona
The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity
source. The available personas or access roles are Owner and Viewer. For more
information on these personas, see Providing access to your search page.
ContentSourceConfiguration contentSourceConfiguration
The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the
BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.
UserIdentityConfiguration userIdentityConfiguration
The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.
String entityId
The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.
String entityType
Shows the type as User or Group.
EntityDisplayData displayData
Information about the user entity.
String name
The name of your Amazon Kendra experience.
String id
The identifier of your Amazon Kendra experience.
Date createdAt
The date-time your Amazon Kendra experience was created.
String status
The processing status of your Amazon Kendra experience.
List<E> endpoints
The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
String documentAttributeKey
The unique key for the document attribute.
List<E> facets
An array of document attributes that are nested facets within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
Integer maxResults
Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
String documentAttributeKey
The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.
String documentAttributeValueType
The data type of the facet value. This is the same as the type defined for the index field when it was created.
List<E> documentAttributeValueCountPairs
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.
String entityId
The identifier of the user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.
String errorMessage
The reason the user or group in your Amazon Web Services SSO identity source failed to properly configure with your Amazon Kendra experience.
Integer indexedQuestionAnswersCount
The total number of FAQ questions and answers contained in the index.
String id
The unique identifier of the FAQ.
String name
The name that you assigned the FAQ when you created or updated the FAQ.
String status
The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.
Date createdAt
The UNIX datetime that the FAQ was added to the index.
Date updatedAt
The UNIX datetime that the FAQ was last updated.
String fileFormat
The file type used to create the FAQ.
String languageCode
The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
String fileSystemId
The identifier of the Amazon FSx file system.
You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.
String fileSystemType
The Amazon FSx file system type. Windows is currently the only supported type.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.
List<E> inclusionPatterns
A list of regular expression patterns to include certain files in your Amazon FSx file system. 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain files in your Amazon FSx file system. 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field
names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before
you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon
FSx data source field names must exist in your Amazon FSx custom metadata.
String indexId
The identifier of the index you want to get query suggestions from.
String queryText
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.
Integer maxSuggestionsCount
The maximum number of query suggestions you want to show to your users.
String indexId
The identifier of the index to get search metrics data.
String interval
The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following
Saturday.
THIS_MONTH: The current month, starting on the first day of the month and ending on the day before
the current date.
ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day
of the month.
TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and
ending on last day of the month.
String metricType
The metric you want to retrieve. You can specify only one metric per call.
For more information about the metrics you can view, see Gaining insights with search analytics.
String nextToken
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 search metrics data.
Integer maxResults
The maximum number of returned data for the metric.
TimeRange snapShotTimeFilter
The date-time for the beginning and end of the time window for the search metrics data.
List<E> snapshotsDataHeader
The column headers for the search metrics data.
List<E> snapshotsData
The search metrics data. The data returned depends on the metric type you requested.
String nextToken
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.
SaaSConfiguration saaSConfiguration
Configuration information to connect to GitHub Enterprise Cloud (SaaS).
OnPremiseConfiguration onPremiseConfiguration
Configuration information to connect to GitHub Enterprise Server (on premises).
String type
The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:
githubToken—The access token created in GitHub. For more information on creating a token in GitHub, see Authentication for a GitHub data source.
Boolean useChangeLog
TRUE to use the GitHub change log to determine which documents require updating in the index.
Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to
scan all of your documents in GitHub.
GitHubDocumentCrawlProperties gitHubDocumentCrawlProperties
Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.
List<E> repositoryFilter
A list of names of the specific repositories you want to index.
List<E> inclusionFolderNamePatterns
A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don't match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.
List<E> inclusionFileTypePatterns
A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> inclusionFileNamePatterns
A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionFolderNamePatterns
A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don't match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.
List<E> exclusionFileTypePatterns
A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionFileNamePatterns
A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
DataSourceVpcConfiguration vpcConfiguration
Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.
List<E> gitHubRepositoryConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map GitHub repository attributes or field names
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubCommitConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub commits
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubIssueDocumentConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issues
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubIssueCommentConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue
comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before
you map to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubIssueAttachmentConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue
attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API
before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubPullRequestCommentConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull
request comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubPullRequestDocumentConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull
requests to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before
you map to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
List<E> gitHubPullRequestDocumentAttachmentConfigurationFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull
request attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub
data source field names must exist in your GitHub custom metadata.
Boolean crawlRepositoryDocuments
TRUE to index all files with a repository.
Boolean crawlIssue
TRUE to index all issues within a repository.
Boolean crawlIssueComment
TRUE to index all comments on issues.
Boolean crawlIssueCommentAttachment
TRUE to include all comment attachments for issues.
Boolean crawlPullRequest
TRUE to index all pull requests within a repository.
Boolean crawlPullRequestComment
TRUE to index all comments on pull requests.
Boolean crawlPullRequestCommentAttachment
TRUE to include all comment attachments for pull requests.
String secretArn
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.
List<E> inclusionPatterns
A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
List<E> fieldMappings
Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom
fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google
Drive data source field names must exist in your Google Drive custom metadata.
List<E> excludeMimeTypes
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.
List<E> excludeUserAccounts
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.
List<E> excludeSharedDrives
A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
List<E> memberGroups
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".
List<E> memberUsers
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
S3Path s3PathforGroupMembers
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.
You can download this example S3
file that uses the correct format for listing group members. Note, dataSourceId is optional. The
value of type for a group is always GROUP and for a user it is always USER
.
String status
The current processing status of actions for mapping users to their groups. The status can be either
PROCESSING, SUCCEEDED, DELETING, DELETED, or
FAILED.
Date lastUpdatedAt
The last date-time an action was updated. An action can be a PUT or DELETE action for
mapping users to their groups.
Date receivedAt
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.
Long orderingId
The order in which actions should complete processing. An action can be a PUT or DELETE
action for mapping users to their groups.
String failureReason
The reason an action could not be processed. An action can be a PUT or DELETE action
for mapping users to their groups.
Integer beginOffset
The zero-based location in the response string where the highlight starts.
Integer endOffset
The zero-based location in the response string where the highlight ends.
Boolean topAnswer
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
String type
The highlight type.
DocumentAttributeCondition invocationCondition
The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.
String lambdaArn
The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.
String s3Bucket
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
String name
The identifier of the index.
String id
A unique identifier for the index. Use this to identify the index when you are using APIs such as
Query, DescribeIndex, UpdateIndex, and DeleteIndex.
String edition
Indicates whether the index is a enterprise edition index or a developer edition index.
Date createdAt
The Unix timestamp when the index was created.
Date updatedAt
The Unix timestamp when the index was last updated by the UpdateIndex API.
String status
The current status of the index. When the status is ACTIVE, the index is ready to search.
FaqStatistics faqStatistics
The number of question and answer topics in the index.
TextDocumentStatistics textDocumentStatistics
The number of text documents indexed.
DocumentAttributeCondition condition
Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
DocumentAttributeTarget target
Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.
Boolean documentContentDeletion
TRUE to delete content if the condition used for the target attribute is met.
String jiraAccountUrl
The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.
String secretArn
The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:
jiraId—The Jira username.
jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Authentication for a Jira data source.
Boolean useChangeLog
TRUE to use the Jira change log to determine which documents require updating in the index.
Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all
of your documents in Jira.
List<E> project
Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
List<E> issueType
Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
List<E> status
Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
List<E> issueSubEntityFilter
Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
List<E> attachmentFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
List<E> commentFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
List<E> issueFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
List<E> projectFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
List<E> workLogFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
List<E> inclusionPatterns
A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.
String keyLocation
The location of the key.
String uRL
The signing key URL.
String secretManagerArn
The Amazon Resource Name (arn) of the secret.
String userNameAttributeField
The user name attribute field.
String groupAttributeField
The group attribute field.
String issuer
The issuer of the token.
String claimRegex
The regular expression that identifies the claim.
String indexId
The identifier of the index for the access control configuration.
String nextToken
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 access control configurations.
Integer maxResults
The maximum number of access control configurations to return.
String nextToken
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of access control configurations.
List<E> accessControlConfigurations
The details of your access control configurations.
String indexId
The identifier of the index used with one or more data sources.
String nextToken
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).
Integer maxResults
The maximum number of data sources to return.
String id
The identifier of the data source.
String indexId
The identifier of the index used with the data source.
String nextToken
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 jobs.
Integer maxResults
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.
TimeRange startTimeFilter
When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
String statusFilter
When specified, only returns synchronization jobs with the Status field equal to the specified
status.
String id
The identifier of your Amazon Kendra experience.
String indexId
The identifier of the index for your Amazon Kendra experience.
String nextToken
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 users or groups.
Integer maxResults
The maximum number of returned users or groups.
String id
The identifier of your Amazon Kendra experience.
String indexId
The identifier of the index for your Amazon Kendra experience.
String nextToken
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 users or groups.
String indexId
The identifier of the index for your Amazon Kendra experience.
String nextToken
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 Amazon Kendra experiences.
Integer maxResults
The maximum number of returned Amazon Kendra experiences.
String indexId
The index that contains the FAQ lists.
String nextToken
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 FAQs.
Integer maxResults
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.
String indexId
The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
String dataSourceId
The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
Long orderingId
The timestamp identifier used for the latest PUT or DELETE action for mapping users to
their groups.
String nextToken
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 groups that are mapped to users before a given ordering or timestamp identifier.
Integer maxResults
The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.
List<E> groupsSummaries
Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.
String nextToken
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.
String nextToken
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).
Integer maxResults
The maximum number of data sources to return.
List<E> indexConfigurationSummaryItems
An array of summary information on the configuration of one or more indexes.
String nextToken
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.
String indexId
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.
String nextToken
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).
Integer maxResults
The maximum number of block lists to return.
List<E> blockListSummaryItems
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.
String nextToken
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.
String resourceARN
The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.
String indexId
The identifier of the index with one or more thesauri.
String nextToken
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).
Integer maxResults
The maximum number of thesauri to return.
String userId
The identifier of the user you want to map to a group.
String tenantDomain
The Azure Active Directory domain of the organization.
String secretArn
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 oneDriveUsers
A list of user accounts whose documents should be indexed.
List<E> inclusionPatterns
A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field
names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before
you map to OneDrive fields. For more information, see Mapping data source fields. The
OneDrive data source field names must exist in your OneDrive custom metadata.
Boolean disableLocalGroups
TRUE to disable local groups information.
List<E> oneDriveUserList
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.
S3Path oneDriveUserS3Path
The S3 bucket location of a file containing a list of users whose documents should be indexed.
String hostUrl
The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/
String organizationName
The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.
S3Path sslCertificateS3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub.
String entityId
The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.
String persona
The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity
source. The available personas or access roles are Owner and Viewer. For more
information on these personas, see Providing access to your search page.
Date createdAt
The date-time the summary information was created.
Date updatedAt
The date-time the summary information was last updated.
String host
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".
Integer port
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.
String credentials
Your secret ARN, which you can create in 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.
String indexId
The identifier of the index you want to map users to their groups.
String dataSourceId
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.
String groupId
The identifier of the group you want to map its users to.
GroupMembers groupMembers
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.
Long orderingId
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.
String roleArn
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.
String indexId
The unique identifier of the index to search. The identifier is returned in the response from the
CreateIndex API.
String queryText
The text to search for.
AttributeFilter attributeFilter
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.
List<E> facets
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.
List<E> requestedDocumentAttributes
An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.
String queryResultTypeFilter
Sets the type of query. Only results for the specified query type are returned.
List<E> documentRelevanceOverrideConfigurations
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.
Integer pageNumber
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.
Integer pageSize
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 sortingConfiguration
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.
UserContext userContext
The user context token or user and group information.
String visitorId
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.
SpellCorrectionConfiguration spellCorrectionConfiguration
Enables suggested spell corrections for queries.
String queryId
The unique identifier for the search. You use QueryId to identify the search when using the feedback
API.
List<E> resultItems
The results of the search.
List<E> facetResults
Contains the facet results. A FacetResult contains the counts for each attribute key that was
specified in the Facets input parameter.
Integer totalNumberOfResults
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.
List<E> warnings
A list of warning codes and their messages on problems with your query.
Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.
List<E> spellCorrectedQueries
A list of information related to suggested spell corrections for a query.
String id
The unique identifier for the query result.
String type
The type of document.
List<E> additionalAttributes
One or more additional attributes associated with the query result.
String documentId
The unique identifier for the document.
TextWithHighlights documentTitle
The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
TextWithHighlights documentExcerpt
An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
String documentURI
The URI of the original location of the document.
List<E> documentAttributes
An array of document attributes assigned to a document in the search results. For example, the document author (
_author) or the source URI (_source_uri) of the document.
ScoreAttributes scoreAttributes
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.
String feedbackToken
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 .
String id
The identifier of a block list.
String name
The name of the block list.
String status
The status of the block list.
Date createdAt
The date-time summary information for a query suggestions block list was last created.
Date updatedAt
The date-time the block list was last updated.
Integer itemCount
The number of items in the block list file.
String domain
The Quip site domain.
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:
accessToken—The token created in Quip. For more information, see Authentication for a Quip data source.
Boolean crawlFileComments
TRUE to index file comments.
Boolean crawlChatRooms
TRUE to index the contents of chat rooms.
Boolean crawlAttachments
TRUE to index attachments.
List<E> folderIds
The identifiers of the Quip folders you want to index.
List<E> threadFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Quip fields. For more information, see Mapping data source fields. The Quip
field names must exist in your Quip custom metadata.
List<E> messageFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Quip fields. For more information, see Mapping data source fields. The Quip
field names must exist in your Quip custom metadata.
List<E> attachmentFieldMappings
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip
attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API
before you map to Quip fields. For more information, see Mapping data source fields. The Quip
field names must exist in your Quip custom metadata.
List<E> inclusionPatterns
A list of regular expression patterns to include certain files in your Quip file system. 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.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain files in your Quip file system. 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.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
Boolean freshness
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.
Integer importance
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
String duration
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.
String rankOrder
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.
Map<K,V> valueImportanceMap
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.
String bucketName
The name of the bucket that contains the documents.
List<E> inclusionPrefixes
A list of S3 prefixes for the documents that should be included in the index.
List<E> inclusionPatterns
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'.
List<E> exclusionPatterns
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 documentsMetadataConfiguration
AccessControlListConfiguration accessControlListConfiguration
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.
String organizationName
The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.
String hostUrl
The GitHub host URL or API endpoint URL. For example, https://api.github.com.
String documentDataFieldName
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body column.
String documentTitleFieldName
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is
typically the Title column.
List<E> fieldMappings
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
List<E> includeFilterTypes
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.
String serverUrl
The instance URL for the Salesforce site that you want to index.
String secretArn
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.
List<E> standardObjectConfigurations
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration
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.
SalesforceChatterFeedConfiguration chatterFeedConfiguration
Configuration information for Salesforce chatter feeds.
Boolean crawlAttachments
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
List<E> includeAttachmentFilePatterns
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
List<E> excludeAttachmentFilePatterns
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
String name
The name of the configuration.
String documentDataFieldName
The name of the field in the custom knowledge article that contains the document data to index.
String documentTitleFieldName
The name of the field in the custom knowledge article that contains the document title.
List<E> fieldMappings
Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create
custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information,
see Mapping data source fields. The
Salesforce data source field names must exist in your Salesforce custom metadata.
List<E> includedStates
Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
SalesforceStandardKnowledgeArticleTypeConfiguration standardKnowledgeArticleTypeConfiguration
Configuration information for standard Salesforce knowledge articles.
List<E> customKnowledgeArticleTypeConfigurations
Configuration information for custom Salesforce knowledge articles.
String documentDataFieldName
The name of the field that contains the document data to index.
String documentTitleFieldName
The name of the field that contains the document title.
List<E> fieldMappings
Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom
fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The
Salesforce data source field names must exist in your Salesforce custom metadata.
String name
The name of the standard object.
String documentDataFieldName
The name of the field in the standard object table that contains the document contents.
String documentTitleFieldName
The name of the field in the standard object table that contains the document title.
List<E> fieldMappings
Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom
fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The
Salesforce data source field names must exist in your Salesforce custom metadata.
String scoreConfidence
A relative ranking for how well the response matches the query.
Boolean facetable
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 .
Boolean searchable
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.
Boolean displayable
Determines whether the field is returned in the query response. The default is true.
Boolean sortable
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.
List<E> seedUrls
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.
String webCrawlerMode
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.
String kmsKeyId
The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.
String hostUrl
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
String secretArn
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Authentication for a ServiceNow data source.
String serviceNowBuildVersion
The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON release, use OTHERS.
ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
String authenticationType
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 Secrets Manager secret in the
SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the
credentials of client ID, client secret, user name and password.
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.
Boolean crawlAttachments
TRUE to index attachments to knowledge articles.
List<E> includeAttachmentFilePatterns
A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the field specified in the PatternTargetField.
List<E> excludeAttachmentFilePatterns
A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the field specified in the PatternTargetField.
String documentDataFieldName
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
String documentTitleFieldName
The name of the ServiceNow field that is mapped to the index document title field.
List<E> fieldMappings
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields,
use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The
ServiceNow data source field names must exist in your ServiceNow custom metadata.
String filterQuery
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.
Boolean crawlAttachments
TRUE to index attachments to service catalog items.
List<E> includeAttachmentFilePatterns
A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the file name of the attachment.
List<E> excludeAttachmentFilePatterns
A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the file name of the attachment.
String documentDataFieldName
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
String documentTitleFieldName
The name of the ServiceNow field that is mapped to the index document title field.
List<E> fieldMappings
Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The
ServiceNow data source field names must exist in your ServiceNow custom metadata.
String sharePointVersion
The version of Microsoft SharePoint that you use.
List<E> urls
The Microsoft SharePoint site URLs for the documents you want to indext.
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.
Boolean crawlAttachments
TRUE to index document attachments.
Boolean useChangeLog
TRUE to use the SharePoint change log to determine which documents require updating in the index.
Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all
of your documents in SharePoint.
List<E> inclusionPatterns
A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field
names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before
you map to SharePoint fields. For more information, see Mapping data source fields. The
SharePoint data source field names must exist in your SharePoint custom metadata.
String documentTitleFieldName
The Microsoft SharePoint attribute field that contains the title of the document.
Boolean disableLocalGroups
TRUE to disable local groups information.
S3Path sslCertificateS3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint.
String teamId
The identifier of the team in the Slack workspace. For example, T0123456789.
You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....
String secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:
slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.
List<E> slackEntityList
Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
Boolean useChangeLog
TRUE to use the Slack change log to determine which documents require updating in the index.
Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan
all of your documents in Slack.
Boolean crawlBotMessage
TRUE to index bot messages from your Slack workspace team.
Boolean excludeArchived
TRUE to exclude archived messages to index from your Slack workspace team.
String sinceCrawlDate
The date to start crawling your data from your Slack workspace team. The date must follow this format:
yyyy-mm-dd.
Integer lookBackPeriod
The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.
Change log updates your index only if new content was added since you last synced your data. Updated or deleted
content from before you last synced does not get updated in your index. To capture updated or deleted content
before you last synced, set the LookBackPeriod to the number of hours you want change log to look
back.
List<E> privateChannelFilter
The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
List<E> publicChannelFilter
The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
List<E> inclusionPatterns
A list of regular expression patterns to include certain attached files in your Slack workspace team. 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns to exclude certain attached files in your Slack workspace team. 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map
to Slack fields. For more information, see Mapping data source fields. The Slack
data source field names must exist in your Slack custom metadata.
String documentAttributeKey
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
String sortOrder
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.
Boolean includeQuerySpellCheckSuggestions
TRUE to suggest spell corrections for queries.
String queryIdentifiersEnclosingOption
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.
String executionId
Identifies a particular synchronization job.
String documentId
The unique identifier of the document.
String documentStatus
The current status of a document.
If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
String failureCode
Indicates the source of the error.
String failureReason
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.
String indexId
The identifier of the index that was queried.
String queryId
The identifier of the specific query for which you are submitting feedback. The query ID is returned in the
response to the Query API.
List<E> clickFeedbackItems
Tells Amazon Kendra that a particular search result link was chosen by the user.
List<E> relevanceFeedbackItems
Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
String id
The unique UUID (universally unique identifier) of a single query suggestion.
SuggestionValue value
The value for the unique UUID (universally unique identifier) of a single query suggestion.
The value is the text string of a suggestion.
SuggestionTextWithHighlights text
The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.
String indexId
The identifier of the index for an access control configuration.
String id
The identifier of the access control configuration you want to update.
String name
A new name for the access control configuration.
String description
A new description for the access control configuration.
List<E> accessControlList
Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
List<E> hierarchicalAccessControlList
The updated list of principal lists that define the hierarchy for which documents users should have access to.
String id
The identifier of the data source you want to update.
String name
A new name for the data source connector. You must first delete the data source and re-create it to change the name of the data source.
String indexId
The identifier of the index used with the data source connector.
DataSourceConfiguration configuration
Configuration information you want to update for the data source connector.
String description
A new description for the data source connector.
String schedule
The sync schedule you want to update for the data source connector.
String roleArn
The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.
String languageCode
The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration
Configuration information you want to update for altering document metadata and content during the document ingestion process.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
String id
The identifier of your Amazon Kendra experience you want to update.
String name
A new name for your Amazon Kendra experience.
String indexId
The identifier of the index for your Amazon Kendra experience.
String roleArn
The Amazon Resource Name (ARN) of a role with permission to access Query API,
QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your
user and group information. For more information, see IAM roles for Amazon Kendra.
ExperienceConfiguration configuration
Configuration information you want to update for your Amazon Kendra experience.
String description
A new description for your Amazon Kendra experience.
String id
The identifier of the index you want to update.
String name
The name of the index you want to update.
String roleArn
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
String description
A new description for the index.
List<E> documentMetadataConfigurationUpdates
The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
CapacityUnitsConfiguration capacityUnits
Sets the number of additional document 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, or make 5 API calls.
If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.
List<E> userTokenConfigurations
The user token configuration.
String userContextPolicy
The user context policy.
UserGroupResolutionConfiguration userGroupResolutionConfiguration
Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.
String indexId
The identifier of the index for the block list.
String id
The identifier of the block list you want to update.
String name
A new name for the block list.
String description
A new description for the block list.
S3Path sourceS3Path
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.
String roleArn
The IAM (Identity and Access Management) role used to access the block list text file in S3.
String indexId
The identifier of the index with query suggestions you want to update.
String mode
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.
Integer queryLogLookBackWindowInDays
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.
Boolean includeQueriesWithoutUserInformation
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.
Integer minimumNumberOfQueryingUsers
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.
Integer minimumQueryCount
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.
String id
The identifier of the thesaurus you want to update.
String name
A new name for the thesaurus.
String indexId
The identifier of the index for the thesaurus.
String description
A new description for the thesaurus.
String roleArn
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
S3Path sourceS3Path
SeedUrlConfiguration seedUrlConfiguration
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.
SiteMapsConfiguration siteMapsConfiguration
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.
String token
The user context token for filtering search results for a user. It must be a JWT or a JSON token.
String userId
The identifier of the user you want to filter search results based on their access to documents.
List<E> groups
The list of groups you want to filter search results based on the groups' access to documents.
List<E> dataSourceGroups
The list of data source groups you want to filter search results based on groups' access to documents in that data source.
String userGroupResolutionMode
The identity store provider (mode) you want to use to fetch access levels of groups and users. Amazon Web Services Single Sign On is currently the only available mode. Your users and groups must exist in an Amazon Web Services SSO identity source in order to use this mode.
String identityAttributeName
The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an Amazon Web Services SSO identity source.
JwtTokenTypeConfiguration jwtTokenTypeConfiguration
Information about the JWT token type configuration.
JsonTokenTypeConfiguration jsonTokenTypeConfiguration
Information about the JSON token type configuration.
Urls urls
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.
You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.
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 Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.
Integer crawlDepth
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.
Integer maxLinksPerPage
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.
Float maxContentSizePerPageInMegaBytes
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.
Integer maxUrlsPerMinuteCrawlRate
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.
List<E> urlInclusionPatterns
A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
List<E> urlExclusionPatterns
A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
ProxyConfiguration proxyConfiguration
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 Secrets Manager.
AuthenticationConfiguration authenticationConfiguration
Configuration information required to connect to websites using authentication.
You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.
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.
String organizationId
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
Boolean crawlComments
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.
Boolean useChangeLog
TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the
index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to
scan all of your documents in Amazon WorkDocs.
List<E> inclusionPatterns
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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> exclusionPatterns
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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or
field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API
before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon
WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
Copyright © 2022. All rights reserved.