String keyPath
Path to the AWS S3 bucket that contains the ACL files.
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.
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
Integer or Long.
DocumentAttribute greaterThanOrEquals
Performs a greater or equals than operation on two document attributes. Use with a document attribute of type
Integer or Long.
DocumentAttribute lessThan
Performs a less than operation on two document attributes. Use with a document attribute of type
Integer or Long.
DocumentAttribute lessThanOrEquals
Performs a less than or equals operation on two document attributes. Use with a document attribute of type
Integer or Long.
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 the documents to. You need to create the index first using the CreateIndex operation.
String roleArn
The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For
more information, see IAM Roles for Amazon
Kendra.
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.
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 AWS CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch Logs
Integer storageCapacityUnits
The amount of extra storage capacity for an index. Each capacity unit provides 150 Gb of storage space or 500,000 documents, whichever is reached first.
Integer queryCapacityUnits
The amount of extra query capacity for an index. Each capacity unit provides 0.5 queries per second and 40,000 queries per day.
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 operation.
List<E> changeDetectingColumns
One to five columns that indicate when a document in the database has changed.
Boolean crawlAttachments
Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.
List<E> attachmentFieldMappings
Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must
first create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
String dataSourceFieldName
The name of the field in the data source.
You must first create the index field using the operation.
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
Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first
create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.
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 AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
username - The user name or email address of a user with administrative privileges for the Confluence server.
password - The password associated with the user logging in to the Confluence server.
String version
Specifies the version of the Confluence installation that you are connecting to.
ConfluenceSpaceConfiguration spaceConfiguration
Specifies configuration information for indexing Confluence spaces.
ConfluencePageConfiguration pageConfiguration
Specifies configuration information for indexing Confluence pages.
ConfluenceBlogConfiguration blogConfiguration
Specifies configuration information for indexing Confluence blogs.
ConfluenceAttachmentConfiguration attachmentConfiguration
Specifies configuration information for indexing attachments to Confluence blogs and pages.
DataSourceVpcConfiguration vpcConfiguration
Specifies the information for connecting to an Amazon VPC.
List<E> inclusionPatterns
A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
List<E> exclusionPatterns
A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
List<E> pageFieldMappings
Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first
create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
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
Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
Boolean crawlArchivedSpaces
Specifies whether Amazon Kendra should 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
Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first
create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
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 AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
String name
A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.
String indexId
The identifier of the index that should be associated with this data source.
String type
The type of repository that contains the data source.
DataSourceConfiguration configuration
The connector configuration information that is required to access the repository.
You can't specify the Configuration parameter when the Type parameter is set to
CUSTOM. If you do, you receive a ValidationException exception.
The Configuration parameter is required for all other data sources.
String description
A description for the data source.
String schedule
Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you
don't set a schedule Amazon Kendra will not periodically update the index. You can call the
StartDataSourceSyncJob operation to update the index.
You can't specify the Schedule parameter when the Type parameter is set to
CUSTOM. If you do, you receive a ValidationException exception.
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.
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. 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. Multiple calls to the
CreateDataSource operation with the same client token will create only one data source.
String id
A unique identifier for the data source.
String indexId
The identifier of the index that contains the FAQ.
String name
The name that should be associated with the FAQ.
String description
A description of the FAQ.
S3Path s3Path
The S3 location of the FAQ input data.
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 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 operation with the same client token will create only one FAQ.
String id
The unique identifier of the FAQ.
String name
The name for the new 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.
String roleArn
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon
CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation
to index documents from an Amazon S3 bucket.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The identifier of the AWS KMS customer managed key (CMK) to use 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 operation 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 there is an access control list, it is ignored. You can filter on user and group attributes.
Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.
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 unique identifier of the index for the new thesaurus.
String name
The name for the new thesaurus.
String description
The description for the new thesaurus.
String roleArn
An AWS Identity and Access Management (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 thesaurus file Amazon S3 source path.
String clientToken
A token that you provide to identify the request to create a thesaurus. Multiple calls to the
CreateThesaurus operation with the same client token will create only one index.
String id
The unique identifier of the thesaurus.
String databaseEngineType
The type of database engine that runs the database.
ConnectionConfiguration connectionConfiguration
The information necessary 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 information to create a data source connector for a document repository in an Amazon S3 bucket.
SharePointConfiguration sharePointConfiguration
Provides information necessary to create a data source connector for a Microsoft SharePoint site.
DatabaseConfiguration databaseConfiguration
Provides information necessary to create a data source connector for a database.
SalesforceConfiguration salesforceConfiguration
Provides configuration information for data sources that connect to a Salesforce site.
OneDriveConfiguration oneDriveConfiguration
Provides configuration for data sources that connect to Microsoft OneDrive.
ServiceNowConfiguration serviceNowConfiguration
Provides configuration for data sources that connect to ServiceNow instances.
ConfluenceConfiguration confluenceConfiguration
Provides configuration information for connecting to a Confluence data source.
GoogleDriveConfiguration googleDriveConfiguration
Provides configuration for data sources that connect to Google Drive.
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 ATIVE the data source is ready to use.
String executionId
A unique identifier for the synchronization job.
Date startTime
The UNIX datetime that the synchronization job was started.
Date endTime
The UNIX datetime that the synchronization job was 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 contains a the
reason that 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.
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 to delete.
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
Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.
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 of 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 that Amazon Kendra will update the data source.
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 id
The identifier of the FAQ.
String indexId
The identifier of the index that contains 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 id
The name of the index to describe.
String name
The name of the index.
String id
The name 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 AWS KMS customer master key (CMK) 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 of 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 settings for any metadata applied to the documents in the index.
IndexStatistics indexStatistics
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
String errorMessage
When th eStatus field value is FAILED, the ErrorMessage field contains a
message that explains why.
CapacityUnitsConfiguration capacityUnits
For enterprise edtion indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.
List<E> userTokenConfigurations
The user token configuration for the Amazon Kendra index.
String userContextPolicy
The user context policy for the Amazon Kendra index.
String id
The identifier of the thesaurus.
String indexId
The identifier of the index associated with the thesaurus to describe.
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 AWS Identity and Access Management (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
A unique identifier of the document in the index.
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 AWS SDK to call Amazon Kendra operations. If you are calling the
Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
S3Path 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.
List<E> accessControlList
Information to use for user context filtering.
String contentType
The file type of the document in the Blob field.
String key
The identifier for the attribute.
DocumentAttributeValue value
The value of the attribute.
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.
String name
The name of the index field.
String type
The data type of the index field.
Relevance relevance
Provides manual tuning parameters to determine how the field affects the search results.
Search search
Provides information about how the field is used during a search.
String s3Prefix
A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple
metadata files. Use S3Prefix to include only the desired metadata files.
String documentAttributeKey
The unique key for the document attribute.
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.
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 secretArn
The Amazon Resource Name (ARN) of a AWS Secrets Manager secret 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 that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.
List<E> exclusionPatterns
A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.
List<E> fieldMappings
Defines mapping between a field in the Google Drive and a Amazon Kendra index field.
If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.
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.
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.
String name
The name of the index.
String id
A unique identifier for the index. Use this to identify the index when you are using operations 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 operation.
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.
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 that contains 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 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 that contains the data source.
String nextToken
If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the
NextToken to fetch 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.
List<E> history
A history of synchronization jobs for the data source.
String nextToken
The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a time. The maximum size
of the page is set by the MaxResults parameter. If there are more jobs in the list than the page
size, Amazon Kendra returns the NextPage token. Include the token in the next request to the
GetDataSourceSyncJobHistory operation to return in the next page of jobs.
String indexId
The index that contains the FAQ lists.
String nextToken
If the result of the previous request to ListFaqs was truncated, include the NextToken
to fetch 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 nextToken
The ListFaqs operation returns a page of FAQs at a time. The maximum size of the page is set by the
MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns
the NextPage token. Include the token in the next request to the ListFaqs operation to
return the next page of FAQs.
List<E> faqSummaryItems
information about the FAQs associated with the specified index.
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.
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 associated with the thesaurus to list.
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 tenantDomain
The Azure Active Directory domain of the organization.
String secretArn
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret 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. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The exclusion pattern is applied to the file name.
List<E> exclusionPatterns
List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
The exclusion pattern is applied to the file name.
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields
in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.
Boolean disableLocalGroups
A Boolean value that specifies whether local groups are disabled (True) or enabled (
False).
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 indexId
The unique identifier of the index to search. The identifier is returned in the response from the operation.
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. You can use this information to help narrow the search for your user.
List<E> requestedDocumentAttributes
An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.
String queryResultTypeFilter
Sets the type of query. Only results for the specified query type are returned.
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.
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.
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.
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 for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) 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 .
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.
For more information about glob patterns, see glob (programming) in Wikipedia.
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.
For more information about glob patterns, see glob (programming) in Wikipedia.
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 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 collumn.
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 AWS Secrets Manager secret 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
Specifies the Salesforce standard objects that Amazon Kendra indexes.
SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration
Specifies configuration information for the knowlege 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
Specifies configuration information for Salesforce chatter feeds.
Boolean crawlAttachments
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration
Provides configuration information for processing attachments to Salesforce standard objects.
List<E> includeAttachmentFilePatterns
A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the name of the attached file.
List<E> excludeAttachmentFilePatterns
A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the name of the attached file.
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
One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
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
Provides configuration information for standard Salesforce knowledge articles.
List<E> customKnowledgeArticleTypeConfigurations
Provides 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
One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.
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 titleB.
List<E> fieldMappings
One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.
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.
String kmsKeyId
The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
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 AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
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
Provides configuration information for crawling knowledge articles in the ServiceNow site.
ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration
Provides configuration information for crawling service catalogs in the ServiceNow site.
Boolean crawlAttachments
Indicates whether Amazon Kendra should index attachments to knowledge articles.
List<E> includeAttachmentFilePatterns
List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not
indexed. The regex is applied to the field specified in the PatternTargetField.
List<E> excludeAttachmentFilePatterns
List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not
indexed. The regex is applied to the field specified in the PatternTargetField
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
Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.
Boolean crawlAttachments
Indicates whether Amazon Kendra should crawl attachments to the service catalog items.
List<E> includeAttachmentFilePatterns
Determines the types of file attachments that are included in the index.
List<E> excludeAttachmentFilePatterns
Determines the types of file attachments that are excluded from the index.
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
Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.
String sharePointVersion
The version of Microsoft SharePoint that you are using as a data source.
List<E> urls
The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
String secretArn
The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
Boolean crawlAttachments
TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
otherwise, FALSE.
Boolean useChangeLog
Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be
updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to
use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
List<E> inclusionPatterns
A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
List<E> exclusionPatterns
A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
DataSourceVpcConfiguration vpcConfiguration
List<E> fieldMappings
A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom
fields in the Amazon Kendra index. You must first create the index fields using the operation before you map
SharePoint attributes. For more information, see Mapping Data Source Fields.
String documentTitleFieldName
The Microsoft SharePoint attribute field that contains the title of the document.
Boolean disableLocalGroups
A Boolean value that specifies whether local groups are disabled (True) or enabled (
False).
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.
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 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 operation.
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 identifier of the data source to update.
String name
The name of the data source to update. The name of the data source can't be updated. To rename a data source you must delete the data source and re-create it.
String indexId
The identifier of the index that contains the data source to update.
DataSourceConfiguration configuration
String description
The new description for the data source.
String schedule
The new update schedule for the data source.
String roleArn
The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
String id
The identifier of the index to update.
String name
The name of the index to update.
String roleArn
A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.
String description
A new description for the index.
List<E> documentMetadataConfigurationUpdates
The document metadata to update.
CapacityUnitsConfiguration capacityUnits
Sets the number of addtional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day.
If you are using extra storage units, you can't reduce the storage capacity below that required to meet the storage needs for your index.
List<E> userTokenConfigurations
The user token configuration.
String userContextPolicy
The user user token context policy.
String id
The identifier of the thesaurus to update.
String name
The updated name of the thesaurus.
String indexId
The identifier of the index associated with the thesaurus to update.
String description
The updated description of the thesaurus.
String roleArn
The updated role ARN of the thesaurus.
S3Path sourceS3Path
String token
The user context token. It must be a JWT or a JSON token.
JwtTokenTypeConfiguration jwtTokenTypeConfiguration
Information about the JWT token type configuration.
JsonTokenTypeConfiguration jsonTokenTypeConfiguration
Information about the JSON token type configuration.
Copyright © 2021. All rights reserved.