Amazon Kendra is a service for indexing large document sets.
", "operations": { "AssociateEntitiesToExperience": "Grants users or groups in your Amazon Web Services SSO identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "AssociatePersonasToEntities": "Defines the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "BatchDeleteDocument": "Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
", "BatchGetDocumentStatus": "Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.
You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
", "ClearQuerySuggestions": "Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
Creates a data source that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
", "CreateExperience": "Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
", "CreateFaq": "Creates an new set of frequently asked question (FAQ) questions and answers.
Adding FAQs to an index is an asynchronous operation.
For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
", "CreateIndex": "Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
", "CreateQuerySuggestionsBlockList": "Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
", "CreateThesaurus": "Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
", "DeleteAccessControlConfiguration": "Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", "DeleteDataSource": "Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "DeleteFaq": "Removes an FAQ from an index.
", "DeleteIndex": "Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.
DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Deletes an existing Amazon Kendra thesaurus.
", "DescribeAccessControlConfiguration": "Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", "DescribeDataSource": "Gets information about an Amazon Kendra data source.
", "DescribeExperience": "Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "DescribeFaq": "Gets information about an FAQ list.
", "DescribeIndex": "Gets information about an existing Amazon Kendra index.
", "DescribePrincipalMapping": "Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.
DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Gets information about a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Gets information on the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Gets information about an existing Amazon Kendra thesaurus.
", "DisassociateEntitiesFromExperience": "Prevents users or groups in your Amazon Web Services SSO identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "DisassociatePersonasFromEntities": "Removes the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "GetQuerySuggestions": "Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
", "ListAccessControlConfigurations": "Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", "ListDataSourceSyncJobs": "Gets statistics about synchronizing Amazon Kendra with a data source.
", "ListDataSources": "Lists the data sources that you have created.
", "ListEntityPersonas": "Lists specific permissions of users and groups with access to your Amazon Kendra experience.
", "ListExperienceEntities": "Lists users or groups in your Amazon Web Services SSO identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "ListExperiences": "Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "ListFaqs": "Gets a list of FAQ lists associated with an index.
", "ListGroupsOlderThanOrderingId": "Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Lists the Amazon Kendra indexes that you created.
", "ListQuerySuggestionsBlockLists": "Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
", "ListThesauri": "Lists the thesauri for an index.
", "PutPrincipalMapping": "Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.
If more than five PUT actions for a group are currently processing, a validation exception is thrown.
PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.
Each query returns the 100 most relevant results.
", "StartDataSourceSyncJob": "Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
", "SubmitFeedback": "Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
", "UntagResource": "Removes a tag from an index, FAQ, or a data source.
", "UpdateAccessControlConfiguration": "Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
Updates an existing Amazon Kendra data source.
", "UpdateExperience": "Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "UpdateIndex": "Updates an existing Amazon Kendra index.
", "UpdateQuerySuggestionsBlockList": "Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Updates a thesaurus for an index.
" }, "shapes": { "AccessControlConfigurationId": { "base": null, "refs": { "AccessControlConfigurationSummary$Id": "The identifier of the access control configuration.
", "CreateAccessControlConfigurationResponse$Id": "The identifier of the access control configuration for your documents in an index.
", "DeleteAccessControlConfigurationRequest$Id": "The identifier of the access control configuration you want to delete.
", "DescribeAccessControlConfigurationRequest$Id": "The identifier of the access control configuration you want to get information on.
", "Document$AccessControlConfigurationId": "The identifier of the access control configuration that you want to apply to the document.
", "UpdateAccessControlConfigurationRequest$Id": "The identifier of the access control configuration you want to update.
" } }, "AccessControlConfigurationName": { "base": null, "refs": { "CreateAccessControlConfigurationRequest$Name": "A name for the access control configuration.
", "DescribeAccessControlConfigurationResponse$Name": "The name for the access control configuration.
", "UpdateAccessControlConfigurationRequest$Name": "A new name for the access control configuration.
" } }, "AccessControlConfigurationSummary": { "base": "Summary information on an access control configuration that you created for your documents in an index.
", "refs": { "AccessControlConfigurationSummaryList$member": null } }, "AccessControlConfigurationSummaryList": { "base": null, "refs": { "ListAccessControlConfigurationsResponse$AccessControlConfigurations": "The details of your access control configurations.
" } }, "AccessControlListConfiguration": { "base": "Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.
", "refs": { "S3DataSourceConfiguration$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.
" } }, "AccessDeniedException": { "base": "", "refs": { } }, "AclConfiguration": { "base": "Provides information about the column that should be used for filtering the query response by groups.
", "refs": { "DatabaseConfiguration$AclConfiguration": "Information about the database column that provides information for user context filtering.
" } }, "AdditionalResultAttribute": { "base": "An attribute returned from an index query.
", "refs": { "AdditionalResultAttributeList$member": null } }, "AdditionalResultAttributeList": { "base": null, "refs": { "QueryResultItem$AdditionalAttributes": "One or more additional attributes associated with the query result.
" } }, "AdditionalResultAttributeValue": { "base": "An attribute returned with a document from a search.
", "refs": { "AdditionalResultAttribute$Value": "An object that contains the attribute value.
" } }, "AdditionalResultAttributeValueType": { "base": null, "refs": { "AdditionalResultAttribute$ValueType": "The data type of the Value property.
Provides the configuration information to connect to Alfresco as your data source.
Alfresco data source connector is currently in preview mode. Basic authentication is currently supported. If you would like to use Alfresco connector in production, contact Support.
Provides the configuration information to connect to Alfresco as your data source.
" } }, "AlfrescoEntity": { "base": null, "refs": { "EntityFilter$member": null } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.
", "TagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.
", "UntagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.
" } }, "AssociateEntitiesToExperienceFailedEntityList": { "base": null, "refs": { "AssociateEntitiesToExperienceResponse$FailedEntityList": "Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly configure with your Amazon Kendra experience.
" } }, "AssociateEntitiesToExperienceRequest": { "base": null, "refs": { } }, "AssociateEntitiesToExperienceResponse": { "base": null, "refs": { } }, "AssociateEntityList": { "base": null, "refs": { "AssociateEntitiesToExperienceRequest$EntityList": "Lists users or groups in your Amazon Web Services SSO identity source.
" } }, "AssociatePersonasToEntitiesRequest": { "base": null, "refs": { } }, "AssociatePersonasToEntitiesResponse": { "base": null, "refs": { } }, "AttributeFilter": { "base": "Provides filtering the query results based on document attributes.
When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:
<AndAllFilters>
<OrAllFilters>
<EqualsTo>
If you use more than 2 layers, you receive a ValidationException exception with the message \"AttributeFilter cannot have a depth of more than 2.\"
If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message \"AttributeFilter cannot have a length of more than 10\".
Performs a logical NOT operation on all supplied filters.
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.
Performs a logical AND operation on all supplied filters.
Performs a logical OR operation on all supplied filters.
Provides the configuration information to connect to websites that require user authentication.
", "refs": { "WebCrawlerConfiguration$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.
" } }, "BasicAuthenticationConfiguration": { "base": "Provides the configuration information to connect to websites that require basic user authentication.
", "refs": { "BasicAuthenticationConfigurationList$member": null } }, "BasicAuthenticationConfigurationList": { "base": null, "refs": { "AuthenticationConfiguration$BasicAuthentication": "The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.
The list includes the name and port number of the website host.
" } }, "BatchDeleteDocumentRequest": { "base": null, "refs": { } }, "BatchDeleteDocumentResponse": { "base": null, "refs": { } }, "BatchDeleteDocumentResponseFailedDocument": { "base": "Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.
A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
" } }, "BatchGetDocumentStatusRequest": { "base": null, "refs": { } }, "BatchGetDocumentStatusResponse": { "base": null, "refs": { } }, "BatchGetDocumentStatusResponseError": { "base": "Provides a response when the status of a document could not be retrieved.
", "refs": { "BatchGetDocumentStatusResponseErrors$member": null } }, "BatchGetDocumentStatusResponseErrors": { "base": null, "refs": { "BatchGetDocumentStatusResponse$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.
" } }, "BatchPutDocumentRequest": { "base": null, "refs": { } }, "BatchPutDocumentResponse": { "base": null, "refs": { } }, "BatchPutDocumentResponseFailedDocument": { "base": "Provides information about a document that could not be indexed.
", "refs": { "BatchPutDocumentResponseFailedDocuments$member": null } }, "BatchPutDocumentResponseFailedDocuments": { "base": null, "refs": { "BatchPutDocumentResponse$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
" } }, "Blob": { "base": null, "refs": { "Document$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.
TRUE to index shared files.
TRUE to index comments of blogs and other content.
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.
TRUE to index comments.
TRUE to index the contents of tasks.
TRUE to index web links.
TRUE to index attachments of pages and blogs in Confluence.
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.
TRUE to index archived spaces.
TRUE to use documents you indexed directly using the BatchPutDocument API.
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.
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.
TRUE to index all files with a repository.
TRUE to index all issues within a repository.
TRUE to index all comments on issues.
TRUE to include all comment attachments for issues.
TRUE to index all pull requests within a repository.
TRUE to index all comments on pull requests.
TRUE to include all comment attachments for pull requests.
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
", "InlineCustomDocumentEnrichmentConfiguration$DocumentContentDeletion": " TRUE to delete content if the condition used for the target attribute is met.
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.
TRUE to disable local groups information.
TRUE to index file comments.
TRUE to index the contents of chat rooms.
TRUE to index attachments.
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
", "Search$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 .
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.
Determines whether the field is returned in the query response. The default is true.
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.
TRUE to index attachments to knowledge articles.
TRUE to index attachments to service catalog items.
TRUE to index document attachments.
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.
TRUE to disable local groups information.
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.
TRUE to index bot messages from your Slack workspace team.
TRUE to exclude archived messages to index from your Slack workspace team.
TRUE to suggest spell corrections for queries.
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.
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.
Provides the configuration information to connect to Box as your data source.
", "refs": { "DataSourceConfiguration$BoxConfiguration": "Provides the configuration information to connect to Box as your data source.
" } }, "CapacityUnitsConfiguration": { "base": "Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.
", "refs": { "DescribeIndexResponse$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.
", "UpdateIndexRequest$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.
" } }, "ChangeDetectingColumns": { "base": null, "refs": { "ColumnConfiguration$ChangeDetectingColumns": "One to five columns that indicate when a document in the database has changed.
" } }, "ClaimRegex": { "base": null, "refs": { "JwtTokenTypeConfiguration$ClaimRegex": "The regular expression that identifies the claim.
" } }, "ClearQuerySuggestionsRequest": { "base": null, "refs": { } }, "ClickFeedback": { "base": "Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback API to provide click information.
Tells Amazon Kendra that a particular search result link was chosen by the user.
" } }, "ClientTokenName": { "base": null, "refs": { "CreateAccessControlConfigurationRequest$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.
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.
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.
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.
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.
A token that you provide to identify the request to create a query suggestions block list.
", "CreateThesaurusRequest$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.
Provides information about how Amazon Kendra should use the columns of a database in an index.
", "refs": { "DatabaseConfiguration$ColumnConfiguration": "Information about where the index should get the document information from the database.
" } }, "ColumnName": { "base": null, "refs": { "AclConfiguration$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.
The column that provides the document's unique identifier.
", "ColumnConfiguration$DocumentDataColumnName": "The column that contains the contents of the document.
", "ColumnConfiguration$DocumentTitleColumnName": "The column that contains the title of the document.
" } }, "ConditionOperator": { "base": null, "refs": { "DocumentAttributeCondition$Operator": "The condition operator.
For example, you can use 'Contains' to partially match a string.
" } }, "ConflictException": { "base": "", "refs": { } }, "ConfluenceAttachmentConfiguration": { "base": "Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
", "refs": { "ConfluenceConfiguration$AttachmentConfiguration": "Configuration information for indexing attachments to Confluence blogs and pages.
" } }, "ConfluenceAttachmentFieldMappingsList": { "base": null, "refs": { "ConfluenceAttachmentConfiguration$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.
The name of the field in the data source.
You must first create the index field using the UpdateIndex API.
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 Confuence data source field names must exist in your Confluence custom metadata.
Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.
Configuration information for indexing Confluence blogs.
" } }, "ConfluenceBlogFieldMappingsList": { "base": null, "refs": { "ConfluenceBlogConfiguration$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.
The name of the field in the data source.
" } }, "ConfluenceBlogToIndexFieldMapping": { "base": "Maps attributes or field names of Confluence blog 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.
Provides the configuration information to connect to Confluence as your data source.
", "refs": { "DataSourceConfiguration$ConfluenceConfiguration": "Provides the configuration information to connect to Confluence as your data source.
" } }, "ConfluencePageConfiguration": { "base": "Configuration of the page settings for the Confluence data source.
", "refs": { "ConfluenceConfiguration$PageConfiguration": "Configuration information for indexing Confluence pages.
" } }, "ConfluencePageFieldMappingsList": { "base": null, "refs": { "ConfluencePageConfiguration$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.
The name of the field in the data source.
" } }, "ConfluencePageToIndexFieldMapping": { "base": ">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.
Configuration information for indexing Confluence spaces.
", "refs": { "ConfluenceConfiguration$SpaceConfiguration": "Configuration information for indexing Confluence spaces.
" } }, "ConfluenceSpaceFieldMappingsList": { "base": null, "refs": { "ConfluenceSpaceConfiguration$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.
The name of the field in the data source.
" } }, "ConfluenceSpaceIdentifier": { "base": null, "refs": { "ConfluenceSpaceList$member": null } }, "ConfluenceSpaceList": { "base": null, "refs": { "ConfluenceSpaceConfiguration$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.
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.
>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.
The version or the type of Confluence installation to connect to.
" } }, "ConnectionConfiguration": { "base": "Provides the configuration information that's required to connect to a database.
", "refs": { "DatabaseConfiguration$ConnectionConfiguration": "Configuration information that's required to connect to a database.
" } }, "ContentSourceConfiguration": { "base": "Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument.
", "refs": { "ExperienceConfiguration$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.
The file type of the document in the Blob field.
A corrected misspelled word in a query.
", "refs": { "CorrectionList$member": null } }, "CorrectionList": { "base": null, "refs": { "SpellCorrectedQuery$Corrections": "The corrected misspelled word or words in a query.
" } }, "CrawlDepth": { "base": null, "refs": { "WebCrawlerConfiguration$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.
" } }, "CreateAccessControlConfigurationRequest": { "base": null, "refs": { } }, "CreateAccessControlConfigurationResponse": { "base": null, "refs": { } }, "CreateDataSourceRequest": { "base": null, "refs": { } }, "CreateDataSourceResponse": { "base": null, "refs": { } }, "CreateExperienceRequest": { "base": null, "refs": { } }, "CreateExperienceResponse": { "base": null, "refs": { } }, "CreateFaqRequest": { "base": null, "refs": { } }, "CreateFaqResponse": { "base": null, "refs": { } }, "CreateIndexRequest": { "base": null, "refs": { } }, "CreateIndexResponse": { "base": null, "refs": { } }, "CreateQuerySuggestionsBlockListRequest": { "base": null, "refs": { } }, "CreateQuerySuggestionsBlockListResponse": { "base": null, "refs": { } }, "CreateThesaurusRequest": { "base": null, "refs": { } }, "CreateThesaurusResponse": { "base": null, "refs": { } }, "CustomDocumentEnrichmentConfiguration": { "base": "Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Customizing document metadata during the ingestion process.
", "refs": { "BatchPutDocumentRequest$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.
", "CreateDataSourceRequest$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.
", "DescribeDataSourceResponse$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.
", "UpdateDataSourceRequest$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.
" } }, "DataSourceConfiguration": { "base": "Provides the configuration information for an Amazon Kendra data source.
", "refs": { "CreateDataSourceRequest$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.
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.
", "UpdateDataSourceRequest$Configuration": "Configuration information you want to update for the data source connector.
" } }, "DataSourceDateFieldFormat": { "base": null, "refs": { "ConfluenceAttachmentToIndexFieldMapping$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.
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.
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.
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.
The type of data stored in the column or attribute.
" } }, "DataSourceFieldName": { "base": null, "refs": { "DataSourceToIndexFieldMapping$DataSourceFieldName": "The name of the column or attribute in the data source.
", "SalesforceChatterFeedConfiguration$DocumentDataFieldName": "The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
The name of the field in the custom knowledge article that contains the document data to index.
", "SalesforceCustomKnowledgeArticleTypeConfiguration$DocumentTitleFieldName": "The name of the field in the custom knowledge article that contains the document title.
", "SalesforceStandardKnowledgeArticleTypeConfiguration$DocumentDataFieldName": "The name of the field that contains the document data to index.
", "SalesforceStandardKnowledgeArticleTypeConfiguration$DocumentTitleFieldName": "The name of the field that contains the document title.
", "SalesforceStandardObjectAttachmentConfiguration$DocumentTitleFieldName": "The name of the field used for the document title.
", "SalesforceStandardObjectConfiguration$DocumentDataFieldName": "The name of the field in the standard object table that contains the document contents.
", "SalesforceStandardObjectConfiguration$DocumentTitleFieldName": "The name of the field in the standard object table that contains the document title.
", "ServiceNowKnowledgeArticleConfiguration$DocumentDataFieldName": "The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
", "ServiceNowKnowledgeArticleConfiguration$DocumentTitleFieldName": "The name of the ServiceNow field that is mapped to the index document title field.
", "ServiceNowServiceCatalogConfiguration$DocumentDataFieldName": "The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
", "ServiceNowServiceCatalogConfiguration$DocumentTitleFieldName": "The name of the ServiceNow field that is mapped to the index document title field.
", "SharePointConfiguration$DocumentTitleFieldName": "The Microsoft SharePoint attribute field that contains the title of the document.
" } }, "DataSourceGroup": { "base": "Data source information for user context filtering.
", "refs": { "DataSourceGroups$member": null } }, "DataSourceGroups": { "base": null, "refs": { "UserContext$DataSourceGroups": "The list of data source groups you want to filter search results based on groups' access to documents in that data source.
" } }, "DataSourceId": { "base": null, "refs": { "CreateDataSourceResponse$Id": "The identifier of the data source connector.
", "DataSourceGroup$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.
", "DataSourceIdList$member": null, "DataSourceSummary$Id": "The unique identifier for the data source.
", "DataSourceSyncJobMetricTarget$DataSourceId": "The ID of the data source that is running the sync job.
", "DeleteDataSourceRequest$Id": "The identifier of the data source you want to delete.
", "DeletePrincipalMappingRequest$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.
", "DescribeDataSourceRequest$Id": "The identifier of the data source.
", "DescribeDataSourceResponse$Id": "The identifier of the data source.
", "DescribePrincipalMappingRequest$DataSourceId": "The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.
Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.
The identifier of the data source.
", "ListGroupsOlderThanOrderingIdRequest$DataSourceId": "The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
", "MemberGroup$DataSourceId": "The identifier of the data source for the sub group you want to map to a group.
", "Principal$DataSourceId": "The identifier of the data source the principal should access documents from.
", "PutPrincipalMappingRequest$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.
", "StartDataSourceSyncJobRequest$Id": "The identifier of the data source to synchronize.
", "StopDataSourceSyncJobRequest$Id": "The identifier of the data source for which to stop the synchronization jobs.
", "UpdateDataSourceRequest$Id": "The identifier of the data source you want to update.
" } }, "DataSourceIdList": { "base": null, "refs": { "ContentSourceConfiguration$DataSourceIds": "The identifier of the data sources you want to use for your Amazon Kendra experience.
" } }, "DataSourceInclusionsExclusionsStrings": { "base": null, "refs": { "AlfrescoConfiguration$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.
", "AlfrescoConfiguration$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.
", "BoxConfiguration$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.
", "BoxConfiguration$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.
", "ConfluenceConfiguration$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.
", "ConfluenceConfiguration$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.
", "FsxConfiguration$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.
", "FsxConfiguration$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.
", "GoogleDriveConfiguration$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.
", "GoogleDriveConfiguration$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.
", "JiraConfiguration$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.
", "JiraConfiguration$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.
", "OneDriveConfiguration$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.
", "OneDriveConfiguration$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.
", "QuipConfiguration$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.
", "QuipConfiguration$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.
", "S3DataSourceConfiguration$InclusionPrefixes": "A list of S3 prefixes for the documents that should be included in the index.
", "S3DataSourceConfiguration$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'.
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.
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.
", "SalesforceConfiguration$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.
", "ServiceNowKnowledgeArticleConfiguration$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.
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.
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.
", "ServiceNowServiceCatalogConfiguration$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.
", "SharePointConfiguration$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.
", "SharePointConfiguration$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.
", "SlackConfiguration$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.
", "SlackConfiguration$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.
", "WebCrawlerConfiguration$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.
", "WebCrawlerConfiguration$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.
", "WorkDocsConfiguration$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.
", "WorkDocsConfiguration$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.
" } }, "DataSourceInclusionsExclusionsStringsMember": { "base": null, "refs": { "DataSourceInclusionsExclusionsStrings$member": null } }, "DataSourceName": { "base": null, "refs": { "CreateDataSourceRequest$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.
", "DataSourceSummary$Name": "The name of the data source.
", "DescribeDataSourceResponse$Name": "The name that you gave the data source when it was created.
", "UpdateDataSourceRequest$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.
" } }, "DataSourceStatus": { "base": null, "refs": { "DataSourceSummary$Status": "The status of the data source. When the status is ACTIVE the data source is ready to use.
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.
Summary information for an Amazon Kendra data source. Returned in a call to the DescribeDataSource API.
An array of summary information for one or more data sources.
" } }, "DataSourceSyncJob": { "base": "Provides information about a data source synchronization job.
", "refs": { "DataSourceSyncJobHistoryList$member": null } }, "DataSourceSyncJobHistoryList": { "base": null, "refs": { "ListDataSourceSyncJobsResponse$History": "A history of synchronization jobs for the data source.
" } }, "DataSourceSyncJobId": { "base": null, "refs": { "DataSourceSyncJobMetricTarget$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.
" } }, "DataSourceSyncJobMetricTarget": { "base": "Maps a particular data source sync job to a particular data source.
", "refs": { "BatchDeleteDocumentRequest$DataSourceSyncJobMetricTarget": null } }, "DataSourceSyncJobMetrics": { "base": "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.
", "refs": { "DataSourceSyncJob$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.
" } }, "DataSourceSyncJobStatus": { "base": null, "refs": { "DataSourceSyncJob$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.
When specified, only returns synchronization jobs with the Status field equal to the specified status.
Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex API.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
", "JiraConfiguration$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.
", "JiraConfiguration$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.
", "JiraConfiguration$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.
", "JiraConfiguration$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.
", "OneDriveConfiguration$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.
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.
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.
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.
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
", "SalesforceCustomKnowledgeArticleTypeConfiguration$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.
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.
One or more objects that map fields in attachments to Amazon Kendra index fields.
", "SalesforceStandardObjectConfiguration$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.
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.
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.
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.
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.
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.
The type of data source repository. For example, SHAREPOINT.
The type of the data source.
", "DescribeDataSourceResponse$Type": "The type of the data source.
" } }, "DataSourceVpcConfiguration": { "base": "Provides the configuration information to connect to an Amazon VPC.
", "refs": { "AlfrescoConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
", "BoxConfiguration$VpcConfiguration": "Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
", "ConfluenceConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
", "DatabaseConfiguration$VpcConfiguration": null, "FsxConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
", "GitHubConfiguration$VpcConfiguration": "Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.
", "JiraConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.
", "QuipConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
", "SharePointConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.
", "SlackConfiguration$VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.
" } }, "DatabaseConfiguration": { "base": "Provides the configuration information to connect to a index.
", "refs": { "DataSourceConfiguration$DatabaseConfiguration": "Provides the configuration information to connect to a database as your data source.
" } }, "DatabaseEngineType": { "base": null, "refs": { "DatabaseConfiguration$DatabaseEngineType": "The type of database engine that runs the database.
" } }, "DatabaseHost": { "base": null, "refs": { "ConnectionConfiguration$DatabaseHost": "The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
" } }, "DatabaseName": { "base": null, "refs": { "ConnectionConfiguration$DatabaseName": "The name of the database containing the document data.
" } }, "DatabasePort": { "base": null, "refs": { "ConnectionConfiguration$DatabasePort": "The port that the database uses for connections.
" } }, "DeleteAccessControlConfigurationRequest": { "base": null, "refs": { } }, "DeleteAccessControlConfigurationResponse": { "base": null, "refs": { } }, "DeleteDataSourceRequest": { "base": null, "refs": { } }, "DeleteExperienceRequest": { "base": null, "refs": { } }, "DeleteExperienceResponse": { "base": null, "refs": { } }, "DeleteFaqRequest": { "base": null, "refs": { } }, "DeleteIndexRequest": { "base": null, "refs": { } }, "DeletePrincipalMappingRequest": { "base": null, "refs": { } }, "DeleteQuerySuggestionsBlockListRequest": { "base": null, "refs": { } }, "DeleteThesaurusRequest": { "base": null, "refs": { } }, "DescribeAccessControlConfigurationRequest": { "base": null, "refs": { } }, "DescribeAccessControlConfigurationResponse": { "base": null, "refs": { } }, "DescribeDataSourceRequest": { "base": null, "refs": { } }, "DescribeDataSourceResponse": { "base": null, "refs": { } }, "DescribeExperienceRequest": { "base": null, "refs": { } }, "DescribeExperienceResponse": { "base": null, "refs": { } }, "DescribeFaqRequest": { "base": null, "refs": { } }, "DescribeFaqResponse": { "base": null, "refs": { } }, "DescribeIndexRequest": { "base": null, "refs": { } }, "DescribeIndexResponse": { "base": null, "refs": { } }, "DescribePrincipalMappingRequest": { "base": null, "refs": { } }, "DescribePrincipalMappingResponse": { "base": null, "refs": { } }, "DescribeQuerySuggestionsBlockListRequest": { "base": null, "refs": { } }, "DescribeQuerySuggestionsBlockListResponse": { "base": null, "refs": { } }, "DescribeQuerySuggestionsConfigRequest": { "base": null, "refs": { } }, "DescribeQuerySuggestionsConfigResponse": { "base": null, "refs": { } }, "DescribeThesaurusRequest": { "base": null, "refs": { } }, "DescribeThesaurusResponse": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "CreateAccessControlConfigurationRequest$Description": "A description for the access control configuration.
", "CreateDataSourceRequest$Description": "A description for the data source connector.
", "CreateExperienceRequest$Description": "A description for your Amazon Kendra experience.
", "CreateFaqRequest$Description": "A description for the FAQ.
", "CreateIndexRequest$Description": "A description for the index.
", "CreateQuerySuggestionsBlockListRequest$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.\"
", "CreateThesaurusRequest$Description": "A description for the thesaurus.
", "DescribeAccessControlConfigurationResponse$Description": "The description for the access control configuration.
", "DescribeDataSourceResponse$Description": "The description for the data source.
", "DescribeExperienceResponse$Description": "Shows the description for your Amazon Kendra experience.
", "DescribeFaqResponse$Description": "The description of the FAQ that you provided when it was created.
", "DescribeIndexResponse$Description": "The description for the index.
", "DescribeQuerySuggestionsBlockListResponse$Description": "The description for the block list.
", "DescribeThesaurusResponse$Description": "The thesaurus description.
", "UpdateAccessControlConfigurationRequest$Description": "A new description for the access control configuration.
", "UpdateDataSourceRequest$Description": "A new description for the data source connector.
", "UpdateExperienceRequest$Description": "A new description for your Amazon Kendra experience.
", "UpdateIndexRequest$Description": "A new description for the index.
", "UpdateQuerySuggestionsBlockListRequest$Description": "A new description for the block list.
", "UpdateThesaurusRequest$Description": "A new description for the thesaurus.
" } }, "DisassociateEntitiesFromExperienceRequest": { "base": null, "refs": { } }, "DisassociateEntitiesFromExperienceResponse": { "base": null, "refs": { } }, "DisassociateEntityList": { "base": null, "refs": { "DisassociateEntitiesFromExperienceRequest$EntityList": "Lists users or groups in your Amazon Web Services SSO identity source.
" } }, "DisassociatePersonasFromEntitiesRequest": { "base": null, "refs": { } }, "DisassociatePersonasFromEntitiesResponse": { "base": null, "refs": { } }, "Document": { "base": "A document in an index.
", "refs": { "DocumentList$member": null } }, "DocumentAttribute": { "base": "A document attribute or metadata field. To create custom document attributes, see Custom attributes.
", "refs": { "AttributeFilter$EqualsTo": "Performs an equals operation on two document attributes.
", "AttributeFilter$ContainsAll": "Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.
Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.
Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.
Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.
Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.
Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.
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.
", "InlineCustomDocumentEnrichmentConfiguration$Condition": "Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
" } }, "DocumentAttributeKey": { "base": null, "refs": { "DocumentAttribute$Key": "The identifier for the attribute.
", "DocumentAttributeCondition$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.
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.
", "Facet$DocumentAttributeKey": "The unique key for the document attribute.
", "FacetResult$DocumentAttributeKey": "The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.
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
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.
" } }, "DocumentAttributeList": { "base": null, "refs": { "Document$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.
", "DocumentInfo$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\".
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.
A list of strings.
" } }, "DocumentAttributeStringValue": { "base": null, "refs": { "DocumentAttributeValue$StringValue": "A string, such as \"department\".
" } }, "DocumentAttributeTarget": { "base": "The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.
For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.
You can also use this with DocumentAttributeCondition.
", "refs": { "InlineCustomDocumentEnrichmentConfiguration$Target": "Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.
" } }, "DocumentAttributeValue": { "base": "The value of a document attribute. You can only provide one value for a document attribute.
", "refs": { "DocumentAttribute$Value": "The value of the attribute.
", "DocumentAttributeCondition$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.
", "DocumentAttributeTarget$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'.
", "DocumentAttributeValueCountPair$DocumentAttributeValue": "The value of the attribute. For example, \"HR\".
" } }, "DocumentAttributeValueCountPair": { "base": "Provides the count of documents that match a particular attribute when doing a faceted search.
", "refs": { "DocumentAttributeValueCountPairList$member": null } }, "DocumentAttributeValueCountPairList": { "base": null, "refs": { "FacetResult$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.
" } }, "DocumentAttributeValueType": { "base": null, "refs": { "DocumentMetadataConfiguration$Type": "The data type of the index field.
", "FacetResult$DocumentAttributeValueType": "The data type of the facet value. This is the same as the type defined for the index field when it was created.
" } }, "DocumentId": { "base": null, "refs": { "BatchDeleteDocumentResponseFailedDocument$Id": "The identifier of the document that couldn't be removed from the index.
", "BatchGetDocumentStatusResponseError$DocumentId": "The unique identifier of the document whose status could not be retrieved.
", "BatchPutDocumentResponseFailedDocument$Id": "The unique identifier of the document.
", "Document$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.
The unique identifier of the document.
", "QueryResultItem$DocumentId": "The unique identifier for the document.
", "Status$DocumentId": "The unique identifier of the document.
" } }, "DocumentIdList": { "base": null, "refs": { "BatchDeleteDocumentRequest$DocumentIdList": "One or more identifiers for documents to delete from the index.
" } }, "DocumentInfo": { "base": "Identifies a document for which to retrieve status information
", "refs": { "DocumentInfoList$member": null } }, "DocumentInfoList": { "base": null, "refs": { "BatchGetDocumentStatusRequest$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.
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.
" } }, "DocumentMetadataBoolean": { "base": null, "refs": { "Relevance$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.
Specifies the properties, such as relevance tuning and searchability, of an index field.
", "refs": { "DocumentMetadataConfigurationList$member": null } }, "DocumentMetadataConfigurationList": { "base": null, "refs": { "DescribeIndexResponse$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.
", "UpdateIndexRequest$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.
" } }, "DocumentMetadataConfigurationName": { "base": null, "refs": { "DocumentMetadataConfiguration$Name": "The name of the index field.
", "DocumentRelevanceConfiguration$Name": "The name of the index field.
" } }, "DocumentRelevanceConfiguration": { "base": "Overrides the document relevance properties of a custom index field.
", "refs": { "DocumentRelevanceOverrideConfigurationList$member": null } }, "DocumentRelevanceOverrideConfigurationList": { "base": null, "refs": { "QueryRequest$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.
" } }, "DocumentStatus": { "base": null, "refs": { "Status$DocumentStatus": "The current status of a document.
If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
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.
" } }, "DocumentsMetadataConfiguration": { "base": "Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
", "refs": { "S3DataSourceConfiguration$DocumentsMetadataConfiguration": null } }, "Domain": { "base": null, "refs": { "QuipConfiguration$Domain": "The Quip site domain.
" } }, "Duration": { "base": null, "refs": { "Relevance$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.
The endpoint of your Amazon Kendra experience.
" } }, "EndpointType": { "base": null, "refs": { "ExperienceEndpoint$EndpointType": "The type of endpoint for your Amazon Kendra experience. The type currently available is HOME, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.
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.
" } }, "EntityConfiguration": { "base": "Provides the configuration information for users or groups in your Amazon Web Services SSO identity source to grant access your Amazon Kendra experience.
", "refs": { "AssociateEntityList$member": null, "DisassociateEntityList$member": null } }, "EntityDisplayData": { "base": "Information about the user entity.
", "refs": { "ExperienceEntitiesSummary$DisplayData": "Information about the user entity.
" } }, "EntityFilter": { "base": null, "refs": { "AlfrescoConfiguration$EntityFilter": "Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
" } }, "EntityId": { "base": null, "refs": { "EntityConfiguration$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.
", "EntityIdsList$member": null, "EntityPersonaConfiguration$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.
", "ExperienceEntitiesSummary$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.
", "FailedEntity$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.
", "PersonasSummary$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.
" } }, "EntityIdsList": { "base": null, "refs": { "DisassociatePersonasFromEntitiesRequest$EntityIds": "The identifiers of users or groups in your Amazon Web Services SSO identity source. For example, user IDs could be user emails.
" } }, "EntityPersonaConfiguration": { "base": "Provides the configuration information for users or groups in your Amazon Web Services SSO identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.
", "refs": { "EntityPersonaConfigurationList$member": null } }, "EntityPersonaConfigurationList": { "base": null, "refs": { "AssociatePersonasToEntitiesRequest$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.
Specifies whether you are configuring a User or a Group.
Shows the type as User or Group.
The error code for why the document couldn't be removed from the index.
", "BatchGetDocumentStatusResponseError$ErrorCode": "Indicates the source of the error.
", "BatchPutDocumentResponseFailedDocument$ErrorCode": "The type of error that caused the document to fail to be indexed.
", "DataSourceSyncJob$ErrorCode": "If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
An explanation for why the document couldn't be removed from the index.
", "BatchGetDocumentStatusResponseError$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.
", "BatchPutDocumentResponseFailedDocument$ErrorMessage": "A description of the reason why the document could not be indexed.
", "ConflictException$Message": null, "DataSourceSyncJob$ErrorMessage": "If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
The error message containing details if there are issues processing the access control configuration.
", "DescribeDataSourceResponse$ErrorMessage": "When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
The reason your Amazon Kendra experience could not properly process.
", "DescribeFaqResponse$ErrorMessage": "If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
The error message containing details if there are issues processing the block list.
", "DescribeThesaurusResponse$ErrorMessage": "When the Status field value is FAILED, the ErrorMessage field provides more information.
The reason the user or group in your Amazon Web Services SSO identity source failed to properly configure with your Amazon Kendra experience.
", "InternalServerException$Message": null, "InvalidRequestException$Message": null, "ResourceAlreadyExistException$Message": null, "ResourceInUseException$Message": null, "ResourceNotFoundException$Message": null, "ResourceUnavailableException$Message": null, "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null, "ValidationException$Message": null } }, "ExcludeMimeTypesList": { "base": null, "refs": { "GoogleDriveConfiguration$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.
" } }, "ExcludeSharedDrivesList": { "base": null, "refs": { "GoogleDriveConfiguration$ExcludeSharedDrives": "A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
" } }, "ExcludeUserAccountsList": { "base": null, "refs": { "GoogleDriveConfiguration$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.
" } }, "ExperienceConfiguration": { "base": "Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.
", "refs": { "CreateExperienceRequest$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.
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.
Configuration information you want to update for your Amazon Kendra experience.
" } }, "ExperienceEndpoint": { "base": "Provides the configuration information for the endpoint for your Amazon Kendra experience.
", "refs": { "ExperienceEndpoints$member": null } }, "ExperienceEndpoints": { "base": null, "refs": { "DescribeExperienceResponse$Endpoints": "Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
", "ExperiencesSummary$Endpoints": "The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
" } }, "ExperienceEntitiesSummary": { "base": "Summary information for users or groups in your Amazon Web Services SSO identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "refs": { "ExperienceEntitiesSummaryList$member": null } }, "ExperienceEntitiesSummaryList": { "base": null, "refs": { "ListExperienceEntitiesResponse$SummaryItems": "An array of summary information for one or more users or groups.
" } }, "ExperienceId": { "base": null, "refs": { "AssociateEntitiesToExperienceRequest$Id": "The identifier of your Amazon Kendra experience.
", "AssociatePersonasToEntitiesRequest$Id": "The identifier of your Amazon Kendra experience.
", "CreateExperienceResponse$Id": "The identifier for your created Amazon Kendra experience.
", "DeleteExperienceRequest$Id": "The identifier of your Amazon Kendra experience you want to delete.
", "DescribeExperienceRequest$Id": "The identifier of your Amazon Kendra experience you want to get information on.
", "DescribeExperienceResponse$Id": "Shows the identifier of your Amazon Kendra experience.
", "DisassociateEntitiesFromExperienceRequest$Id": "The identifier of your Amazon Kendra experience.
", "DisassociatePersonasFromEntitiesRequest$Id": "The identifier of your Amazon Kendra experience.
", "ExperiencesSummary$Id": "The identifier of your Amazon Kendra experience.
", "ListEntityPersonasRequest$Id": "The identifier of your Amazon Kendra experience.
", "ListExperienceEntitiesRequest$Id": "The identifier of your Amazon Kendra experience.
", "UpdateExperienceRequest$Id": "The identifier of your Amazon Kendra experience you want to update.
" } }, "ExperienceName": { "base": null, "refs": { "CreateExperienceRequest$Name": "A name for your Amazon Kendra experience.
", "DescribeExperienceResponse$Name": "Shows the name of your Amazon Kendra experience.
", "ExperiencesSummary$Name": "The name of your Amazon Kendra experience.
", "UpdateExperienceRequest$Name": "A new name for your Amazon Kendra experience.
" } }, "ExperienceStatus": { "base": null, "refs": { "DescribeExperienceResponse$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.
The processing status of your Amazon Kendra experience.
" } }, "ExperiencesSummary": { "base": "Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "refs": { "ExperiencesSummaryList$member": null } }, "ExperiencesSummaryList": { "base": null, "refs": { "ListExperiencesResponse$SummaryItems": "An array of summary information for one or more Amazon Kendra experiences.
" } }, "Facet": { "base": "Information about a document attribute. You can use document attributes as facets.
For example, the document attribute or facet \"Department\" includes the values \"HR\", \"Engineering\", and \"Accounting\". You can display these values in the search results so that documents can be searched by department.
You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.
", "refs": { "FacetList$member": null } }, "FacetList": { "base": null, "refs": { "Facet$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.
", "QueryRequest$Facets": "An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.
" } }, "FacetResult": { "base": "The facet values for the documents in the response.
", "refs": { "FacetResultList$member": null } }, "FacetResultList": { "base": null, "refs": { "DocumentAttributeValueCountPair$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.
", "QueryResult$FacetResults": "Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.
Information on the users or groups in your Amazon Web Services SSO identity source that failed to properly configure with your Amazon Kendra experience.
", "refs": { "AssociateEntitiesToExperienceFailedEntityList$member": null, "FailedEntityList$member": null } }, "FailedEntityList": { "base": null, "refs": { "AssociatePersonasToEntitiesResponse$FailedEntityList": "Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly configure with your Amazon Kendra experience.
", "DisassociateEntitiesFromExperienceResponse$FailedEntityList": "Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly remove access to your Amazon Kendra experience.
", "DisassociatePersonasFromEntitiesResponse$FailedEntityList": "Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly remove access to your Amazon Kendra experience.
" } }, "FailureReason": { "base": null, "refs": { "GroupOrderingIdSummary$FailureReason": "The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.
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.
", "DescribeFaqResponse$FileFormat": "The file format used by the input files for the FAQ.
", "FaqSummary$FileFormat": "The file type used to create the FAQ.
" } }, "FaqId": { "base": null, "refs": { "CreateFaqResponse$Id": "The unique identifier of the FAQ.
", "DeleteFaqRequest$Id": "The identifier of the FAQ you want to remove.
", "DescribeFaqRequest$Id": "The identifier of the FAQ you want to get information on.
", "DescribeFaqResponse$Id": "The identifier of the FAQ.
", "FaqIdsList$member": null, "FaqSummary$Id": "The unique identifier of the FAQ.
" } }, "FaqIdsList": { "base": null, "refs": { "ContentSourceConfiguration$FaqIds": "The identifier of the FAQs that you want to use for your Amazon Kendra experience.
" } }, "FaqName": { "base": null, "refs": { "CreateFaqRequest$Name": "A name for the FAQ.
", "DescribeFaqResponse$Name": "The name that you gave the FAQ when it was created.
", "FaqSummary$Name": "The name that you assigned the FAQ when you created or updated the FAQ.
" } }, "FaqStatistics": { "base": "Provides statistical information about the FAQ questions and answers contained in an index.
", "refs": { "IndexStatistics$FaqStatistics": "The number of question and answer topics in the index.
" } }, "FaqStatus": { "base": null, "refs": { "DescribeFaqResponse$Status": "The status of the FAQ. It is ready to use when the status is ACTIVE.
The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.
Summary information for frequently asked questions and answers included in an index.
", "refs": { "FaqSummaryItems$member": null } }, "FaqSummaryItems": { "base": null, "refs": { "ListFaqsResponse$FaqSummaryItems": "information about the FAQs associated with the specified index.
" } }, "FeedbackToken": { "base": null, "refs": { "QueryResultItem$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 .
" } }, "FileSystemId": { "base": null, "refs": { "FsxConfiguration$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.
" } }, "FolderId": { "base": null, "refs": { "FolderIdList$member": null } }, "FolderIdList": { "base": null, "refs": { "QuipConfiguration$FolderIds": "The identifiers of the Quip folders you want to index.
" } }, "FsxConfiguration": { "base": "Provides the configuration information to connect to Amazon FSx as your data source.
", "refs": { "DataSourceConfiguration$FsxConfiguration": "Provides the configuration information to connect to Amazon FSx as your data source.
" } }, "FsxFileSystemType": { "base": null, "refs": { "FsxConfiguration$FileSystemType": "The Amazon FSx file system type. Windows is currently the only supported type.
" } }, "GetQuerySuggestionsRequest": { "base": null, "refs": { } }, "GetQuerySuggestionsResponse": { "base": null, "refs": { } }, "GetSnapshotsRequest": { "base": null, "refs": { } }, "GetSnapshotsResponse": { "base": null, "refs": { } }, "GitHubConfiguration": { "base": "Provides the configuration information to connect to GitHub as your data source.
", "refs": { "DataSourceConfiguration$GitHubConfiguration": "Provides the configuration information to connect to GitHub as your data source.
" } }, "GitHubDocumentCrawlProperties": { "base": "Provides the 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.
", "refs": { "GitHubConfiguration$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.
" } }, "GoogleDriveConfiguration": { "base": "Provides the configuration information to connect to Google Drive as your data source.
", "refs": { "DataSourceConfiguration$GoogleDriveConfiguration": "Provides the configuration information to connect to Google Drive as your data source.
" } }, "GroupAttributeField": { "base": null, "refs": { "JwtTokenTypeConfiguration$GroupAttributeField": "The group attribute field.
" } }, "GroupId": { "base": null, "refs": { "DeletePrincipalMappingRequest$GroupId": "The identifier of the group you want to delete.
", "DescribePrincipalMappingRequest$GroupId": "The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.
Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.
The identifier of the group you want group summary information on.
", "MemberGroup$GroupId": "The identifier of the sub group you want to map to a group.
", "PutPrincipalMappingRequest$GroupId": "The identifier of the group you want to map its users to.
" } }, "GroupMembers": { "base": "A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", "refs": { "PutPrincipalMappingRequest$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.
" } }, "GroupOrderingIdSummaries": { "base": null, "refs": { "DescribePrincipalMappingResponse$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.
Summary information on the processing of PUT and DELETE actions for mapping users to their groups.
Summary information for groups.
", "refs": { "ListOfGroupSummaries$member": null } }, "Groups": { "base": null, "refs": { "UserContext$Groups": "The list of groups you want to filter search results based on the groups' access to documents.
" } }, "HierarchicalPrincipal": { "base": "Information to define the hierarchy for which documents users should have access to.
", "refs": { "HierarchicalPrincipalList$member": null } }, "HierarchicalPrincipalList": { "base": "A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.
", "refs": { "CreateAccessControlConfigurationRequest$HierarchicalAccessControlList": "The list of principal lists that define the hierarchy for which documents users should have access to.
", "DescribeAccessControlConfigurationResponse$HierarchicalAccessControlList": "The list of principal lists that define the hierarchy for which documents users should have access to.
", "Document$HierarchicalAccessControlList": "The list of principal lists that define the hierarchy for which documents users should have access to.
", "UpdateAccessControlConfigurationRequest$HierarchicalAccessControlList": "The updated list of principal lists that define the hierarchy for which documents users should have access to.
" } }, "Highlight": { "base": "Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
", "refs": { "HighlightList$member": null } }, "HighlightList": { "base": null, "refs": { "TextWithHighlights$Highlights": "The beginning and end of the text that should be highlighted.
" } }, "HighlightType": { "base": null, "refs": { "Highlight$Type": "The highlight type.
" } }, "HookConfiguration": { "base": "Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Customizing document metadata during the ingestion process.
", "refs": { "CustomDocumentEnrichmentConfiguration$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.
", "CustomDocumentEnrichmentConfiguration$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.
" } }, "Host": { "base": null, "refs": { "BasicAuthenticationConfiguration$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\".
", "ProxyConfiguration$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\".
" } }, "IdentityAttributeName": { "base": null, "refs": { "UserIdentityConfiguration$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.
" } }, "Importance": { "base": null, "refs": { "Relevance$Importance": "The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
", "ValueImportanceMap$value": null } }, "IndexConfigurationSummary": { "base": "Summary information on the configuration of an index.
", "refs": { "IndexConfigurationSummaryList$member": null } }, "IndexConfigurationSummaryList": { "base": null, "refs": { "ListIndicesResponse$IndexConfigurationSummaryItems": "An array of summary information on the configuration of one or more indexes.
" } }, "IndexEdition": { "base": null, "refs": { "CreateIndexRequest$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.
", "DescribeIndexResponse$Edition": "The Amazon Kendra edition used for the index. You decide the edition when you create the index.
", "IndexConfigurationSummary$Edition": "Indicates whether the index is a enterprise edition index or a developer edition index.
" } }, "IndexFieldName": { "base": null, "refs": { "ConfluenceAttachmentToIndexFieldMapping$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.
", "ConfluenceBlogToIndexFieldMapping$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.
", "ConfluencePageToIndexFieldMapping$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.
", "ConfluenceSpaceToIndexFieldMapping$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.
", "DataSourceToIndexFieldMapping$IndexFieldName": "The name of the field in the index.
" } }, "IndexId": { "base": null, "refs": { "AssociateEntitiesToExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "AssociatePersonasToEntitiesRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "BatchDeleteDocumentRequest$IndexId": "The identifier of the index that contains the documents to delete.
", "BatchGetDocumentStatusRequest$IndexId": "The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
", "BatchPutDocumentRequest$IndexId": "The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
The identifier of the index you want to clear query suggestions from.
", "CreateAccessControlConfigurationRequest$IndexId": "The identifier of the index to create an access control configuration for your documents.
", "CreateDataSourceRequest$IndexId": "The identifier of the index you want to use with the data source connector.
", "CreateExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "CreateFaqRequest$IndexId": "The identifier of the index for the FAQ.
", "CreateIndexResponse$Id": "The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.
", "CreateQuerySuggestionsBlockListRequest$IndexId": "The identifier of the index you want to create a query suggestions block list for.
", "CreateThesaurusRequest$IndexId": "The identifier of the index for the thesaurus.
", "DeleteAccessControlConfigurationRequest$IndexId": "The identifier of the index for an access control configuration.
", "DeleteDataSourceRequest$IndexId": "The identifier of the index used with the data source.
", "DeleteExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "DeleteFaqRequest$IndexId": "The identifier of the index for the FAQ.
", "DeleteIndexRequest$Id": "The identifier of the index you want to delete.
", "DeletePrincipalMappingRequest$IndexId": "The identifier of the index you want to delete a group from.
", "DeleteQuerySuggestionsBlockListRequest$IndexId": "The identifier of the index for the block list.
", "DeleteThesaurusRequest$IndexId": "The identifier of the index for the thesaurus.
", "DescribeAccessControlConfigurationRequest$IndexId": "The identifier of the index for an access control configuration.
", "DescribeDataSourceRequest$IndexId": "The identifier of the index used with the data source.
", "DescribeDataSourceResponse$IndexId": "The identifier of the index that contains the data source.
", "DescribeExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "DescribeExperienceResponse$IndexId": "Shows the identifier of the index for your Amazon Kendra experience.
", "DescribeFaqRequest$IndexId": "The identifier of the index for the FAQ.
", "DescribeFaqResponse$IndexId": "The identifier of the index for the FAQ.
", "DescribeIndexRequest$Id": "The identifier of the index you want to get information on.
", "DescribeIndexResponse$Id": "The identifier of the index.
", "DescribePrincipalMappingRequest$IndexId": "The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.
Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.
The identifier of the index for the block list.
", "DescribeQuerySuggestionsBlockListResponse$IndexId": "The identifier of the index for the block list.
", "DescribeQuerySuggestionsConfigRequest$IndexId": "The identifier of the index with query suggestions that you want to get information on.
", "DescribeThesaurusRequest$IndexId": "The identifier of the index for the thesaurus.
", "DescribeThesaurusResponse$IndexId": "The identifier of the index for the thesaurus.
", "DisassociateEntitiesFromExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "DisassociatePersonasFromEntitiesRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "GetQuerySuggestionsRequest$IndexId": "The identifier of the index you want to get query suggestions from.
", "GetSnapshotsRequest$IndexId": "The identifier of the index to get search metrics data.
", "IndexConfigurationSummary$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.
The identifier of the index for the access control configuration.
", "ListDataSourceSyncJobsRequest$IndexId": "The identifier of the index used with the data source.
", "ListDataSourcesRequest$IndexId": "The identifier of the index used with one or more data sources.
", "ListEntityPersonasRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "ListExperienceEntitiesRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "ListExperiencesRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "ListFaqsRequest$IndexId": "The index that contains the FAQ lists.
", "ListGroupsOlderThanOrderingIdRequest$IndexId": "The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
", "ListQuerySuggestionsBlockListsRequest$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.
", "ListThesauriRequest$IndexId": "The identifier of the index with one or more thesauri.
", "PutPrincipalMappingRequest$IndexId": "The identifier of the index you want to map users to their groups.
", "QueryRequest$IndexId": "The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex API.
The identifier of the index that contains the data source.
", "StopDataSourceSyncJobRequest$IndexId": "The identifier of the index that contains the data source.
", "SubmitFeedbackRequest$IndexId": "The identifier of the index that was queried.
", "UpdateAccessControlConfigurationRequest$IndexId": "The identifier of the index for an access control configuration.
", "UpdateDataSourceRequest$IndexId": "The identifier of the index used with the data source connector.
", "UpdateExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "UpdateIndexRequest$Id": "The identifier of the index you want to update.
", "UpdateQuerySuggestionsBlockListRequest$IndexId": "The identifier of the index for the block list.
", "UpdateQuerySuggestionsConfigRequest$IndexId": "The identifier of the index with query suggestions you want to update.
", "UpdateThesaurusRequest$IndexId": "The identifier of the index for the thesaurus.
" } }, "IndexName": { "base": null, "refs": { "CreateIndexRequest$Name": "A name for the index.
", "DescribeIndexResponse$Name": "The name of the index.
", "IndexConfigurationSummary$Name": "The identifier of the index.
", "UpdateIndexRequest$Name": "The name of the index you want to update.
" } }, "IndexStatistics": { "base": "Provides information about the number of documents and the number of questions and answers in an index.
", "refs": { "DescribeIndexResponse$IndexStatistics": "Provides information about the number of FAQ questions and answers and the number of text documents indexed.
" } }, "IndexStatus": { "base": null, "refs": { "DescribeIndexResponse$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.
The current status of the index. When the status is ACTIVE, the index is ready to search.
The total number of FAQ questions and answers contained in the index.
" } }, "IndexedTextBytes": { "base": null, "refs": { "TextDocumentStatistics$IndexedTextBytes": "The total size, in bytes, of the indexed documents.
" } }, "IndexedTextDocumentsCount": { "base": null, "refs": { "TextDocumentStatistics$IndexedTextDocumentsCount": "The number of text documents indexed.
" } }, "InlineCustomDocumentEnrichmentConfiguration": { "base": "Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration.
For more information, see Customizing document metadata during the ingestion process.
", "refs": { "InlineCustomDocumentEnrichmentConfigurationList$member": null } }, "InlineCustomDocumentEnrichmentConfigurationList": { "base": null, "refs": { "CustomDocumentEnrichmentConfiguration$InlineConfigurations": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
" } }, "Integer": { "base": null, "refs": { "Correction$BeginOffset": "The zero-based location in the response string or text where the corrected word starts.
", "Correction$EndOffset": "The zero-based location in the response string or text where the corrected word ends.
", "DescribeQuerySuggestionsBlockListResponse$ItemCount": "The current number of valid, non-empty words or phrases in the block list text file.
", "DescribeQuerySuggestionsConfigResponse$QueryLogLookBackWindowInDays": "How recent your queries are in your query log time window (in days).
", "DescribeQuerySuggestionsConfigResponse$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.
", "DocumentAttributeValueCountPair$Count": "The number of documents in the response that have the attribute value for the key.
", "GetQuerySuggestionsRequest$MaxSuggestionsCount": "The maximum number of query suggestions you want to show to your users.
", "GetSnapshotsRequest$MaxResults": "The maximum number of returned data for the metric.
", "Highlight$BeginOffset": "The zero-based location in the response string where the highlight starts.
", "Highlight$EndOffset": "The zero-based location in the response string where the highlight ends.
", "QueryRequest$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.
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.
", "QueryResult$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.
", "QuerySuggestionsBlockListSummary$ItemCount": "The number of items in the block list file.
", "SuggestionHighlight$BeginOffset": "The zero-based location in the response string where the highlight starts.
", "SuggestionHighlight$EndOffset": "The zero-based location in the response string where the highlight ends.
", "UpdateQuerySuggestionsConfigRequest$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.
" } }, "InternalServerException": { "base": "", "refs": { } }, "Interval": { "base": null, "refs": { "GetSnapshotsRequest$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.
The input to the request is not valid.
", "refs": { } }, "IssueSubEntity": { "base": null, "refs": { "IssueSubEntityFilter$member": null } }, "IssueSubEntityFilter": { "base": null, "refs": { "JiraConfiguration$IssueSubEntityFilter": "Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
" } }, "IssueType": { "base": null, "refs": { "JiraConfiguration$IssueType": "Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
" } }, "Issuer": { "base": null, "refs": { "JwtTokenTypeConfiguration$Issuer": "The issuer of the token.
" } }, "JiraAccountUrl": { "base": null, "refs": { "JiraConfiguration$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.
" } }, "JiraConfiguration": { "base": "Provides the configuration information to connect to Jira as your data source.
", "refs": { "DataSourceConfiguration$JiraConfiguration": "Provides the configuration information to connect to Jira as your data source.
" } }, "JiraStatus": { "base": null, "refs": { "JiraConfiguration$Status": "Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
" } }, "JsonTokenTypeConfiguration": { "base": "Provides the configuration information for the JSON token type.
", "refs": { "UserTokenConfiguration$JsonTokenTypeConfiguration": "Information about the JSON token type configuration.
" } }, "JwtTokenTypeConfiguration": { "base": "Provides the configuration information for the JWT token type.
", "refs": { "UserTokenConfiguration$JwtTokenTypeConfiguration": "Information about the JWT token type configuration.
" } }, "KeyLocation": { "base": null, "refs": { "JwtTokenTypeConfiguration$KeyLocation": "The location of the key.
" } }, "KmsKeyId": { "base": null, "refs": { "ServerSideEncryptionConfiguration$KmsKeyId": "The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.
" } }, "LambdaArn": { "base": null, "refs": { "HookConfiguration$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.
" } }, "LanguageCode": { "base": "The code for a language. The default language is English. For more information on supported languages, including their codes, see Adding documents in languages other than English.
", "refs": { "CreateDataSourceRequest$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.
", "CreateFaqRequest$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.
", "DataSourceSummary$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.
", "DescribeDataSourceResponse$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.
", "DescribeFaqResponse$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.
", "FaqSummary$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.
", "UpdateDataSourceRequest$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.
" } }, "ListAccessControlConfigurationsRequest": { "base": null, "refs": { } }, "ListAccessControlConfigurationsResponse": { "base": null, "refs": { } }, "ListDataSourceSyncJobsRequest": { "base": null, "refs": { } }, "ListDataSourceSyncJobsResponse": { "base": null, "refs": { } }, "ListDataSourcesRequest": { "base": null, "refs": { } }, "ListDataSourcesResponse": { "base": null, "refs": { } }, "ListEntityPersonasRequest": { "base": null, "refs": { } }, "ListEntityPersonasResponse": { "base": null, "refs": { } }, "ListExperienceEntitiesRequest": { "base": null, "refs": { } }, "ListExperienceEntitiesResponse": { "base": null, "refs": { } }, "ListExperiencesRequest": { "base": null, "refs": { } }, "ListExperiencesResponse": { "base": null, "refs": { } }, "ListFaqsRequest": { "base": null, "refs": { } }, "ListFaqsResponse": { "base": null, "refs": { } }, "ListGroupsOlderThanOrderingIdRequest": { "base": null, "refs": { } }, "ListGroupsOlderThanOrderingIdResponse": { "base": null, "refs": { } }, "ListIndicesRequest": { "base": null, "refs": { } }, "ListIndicesResponse": { "base": null, "refs": { } }, "ListOfGroupSummaries": { "base": null, "refs": { "ListGroupsOlderThanOrderingIdResponse$GroupsSummaries": "Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.
" } }, "ListQuerySuggestionsBlockListsRequest": { "base": null, "refs": { } }, "ListQuerySuggestionsBlockListsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListThesauriRequest": { "base": null, "refs": { } }, "ListThesauriResponse": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "DescribeQuerySuggestionsBlockListResponse$FileSizeBytes": "The current size of the block list text file in S3.
", "DescribeThesaurusResponse$FileSizeBytes": "The size of the thesaurus file in bytes.
", "DescribeThesaurusResponse$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.
The number of synonym rules in the thesaurus file.
", "DocumentAttributeValue$LongValue": "A long integer value.
" } }, "LookBackPeriod": { "base": null, "refs": { "SlackConfiguration$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.
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.
" } }, "MaxLinksPerPage": { "base": null, "refs": { "WebCrawlerConfiguration$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.
" } }, "MaxResultsIntegerForListAccessControlConfigurationsRequest": { "base": null, "refs": { "ListAccessControlConfigurationsRequest$MaxResults": "The maximum number of access control configurations to return.
" } }, "MaxResultsIntegerForListDataSourceSyncJobsRequest": { "base": null, "refs": { "ListDataSourceSyncJobsRequest$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.
" } }, "MaxResultsIntegerForListDataSourcesRequest": { "base": null, "refs": { "ListDataSourcesRequest$MaxResults": "The maximum number of data sources to return.
" } }, "MaxResultsIntegerForListEntityPersonasRequest": { "base": null, "refs": { "ListEntityPersonasRequest$MaxResults": "The maximum number of returned users or groups.
" } }, "MaxResultsIntegerForListExperiencesRequest": { "base": null, "refs": { "ListExperiencesRequest$MaxResults": "The maximum number of returned Amazon Kendra experiences.
" } }, "MaxResultsIntegerForListFaqsRequest": { "base": null, "refs": { "ListFaqsRequest$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.
" } }, "MaxResultsIntegerForListIndicesRequest": { "base": null, "refs": { "ListIndicesRequest$MaxResults": "The maximum number of data sources to return.
" } }, "MaxResultsIntegerForListPrincipalsRequest": { "base": null, "refs": { "ListGroupsOlderThanOrderingIdRequest$MaxResults": "The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.
" } }, "MaxResultsIntegerForListQuerySuggestionsBlockLists": { "base": null, "refs": { "ListQuerySuggestionsBlockListsRequest$MaxResults": "The maximum number of block lists to return.
" } }, "MaxResultsIntegerForListThesauriRequest": { "base": null, "refs": { "ListThesauriRequest$MaxResults": "The maximum number of thesauri to return.
" } }, "MaxUrlsPerMinuteCrawlRate": { "base": null, "refs": { "WebCrawlerConfiguration$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.
" } }, "MemberGroup": { "base": "The sub groups that belong to a group.
", "refs": { "MemberGroups$member": null } }, "MemberGroups": { "base": null, "refs": { "GroupMembers$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\".
" } }, "MemberUser": { "base": "The users that belong to a group.
", "refs": { "MemberUsers$member": null } }, "MemberUsers": { "base": null, "refs": { "GroupMembers$MemberUsers": "A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.
" } }, "MetricType": { "base": null, "refs": { "GetSnapshotsRequest$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.
" } }, "MetricValue": { "base": null, "refs": { "DataSourceSyncJobMetrics$DocumentsAdded": "The number of documents added from the data source up to now in the data source sync.
", "DataSourceSyncJobMetrics$DocumentsModified": "The number of documents modified in the data source up to now in the data source sync run.
", "DataSourceSyncJobMetrics$DocumentsDeleted": "The number of documents deleted from the data source up to now in the data source sync run.
", "DataSourceSyncJobMetrics$DocumentsFailed": "The number of documents that failed to sync from the data source up to now in the data source sync run.
", "DataSourceSyncJobMetrics$DocumentsScanned": "The current number of documents crawled by the current sync job in the data source.
" } }, "MimeType": { "base": null, "refs": { "ExcludeMimeTypesList$member": null } }, "MinimumNumberOfQueryingUsers": { "base": null, "refs": { "DescribeQuerySuggestionsConfigResponse$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.
", "UpdateQuerySuggestionsConfigRequest$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.
" } }, "MinimumQueryCount": { "base": null, "refs": { "DescribeQuerySuggestionsConfigResponse$MinimumQueryCount": "The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
", "UpdateQuerySuggestionsConfigRequest$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.
" } }, "Mode": { "base": null, "refs": { "DescribeQuerySuggestionsConfigResponse$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.
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.
The name of the user.
", "EntityDisplayData$GroupName": "The name of the group.
", "EntityDisplayData$IdentifiedUserName": "The user name of the user.
", "EntityDisplayData$FirstName": "The first name of the user.
", "EntityDisplayData$LastName": "The last name of the user.
" } }, "NextToken": { "base": null, "refs": { "GetSnapshotsRequest$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.
", "GetSnapshotsResponse$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.
", "ListDataSourceSyncJobsRequest$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.
", "ListDataSourceSyncJobsResponse$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 jobs.
", "ListDataSourcesRequest$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).
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data sources.
", "ListEntityPersonasRequest$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.
", "ListEntityPersonasResponse$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 users or groups.
", "ListExperienceEntitiesRequest$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.
", "ListExperienceEntitiesResponse$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 users or groups.
", "ListExperiencesRequest$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.
", "ListExperiencesResponse$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 Amazon Kendra experiences.
", "ListFaqsRequest$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.
", "ListFaqsResponse$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 FAQs.
", "ListGroupsOlderThanOrderingIdRequest$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.
", "ListGroupsOlderThanOrderingIdResponse$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.
", "ListIndicesRequest$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).
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.
", "ListQuerySuggestionsBlockListsRequest$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).
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.
", "ListThesauriRequest$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).
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.
" } }, "ObjectBoolean": { "base": null, "refs": { "DescribeQuerySuggestionsConfigResponse$IncludeQueriesWithoutUserInformation": " TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
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.
Provides the configuration information to connect to GitHub Enterprise Server (on premises).
", "refs": { "GitHubConfiguration$OnPremiseConfiguration": "Configuration information to connect to GitHub Enterprise Server (on premises).
" } }, "OneDriveConfiguration": { "base": "Provides the configuration information to connect to OneDrive as your data source.
", "refs": { "DataSourceConfiguration$OneDriveConfiguration": "Provides the configuration information to connect to Microsoft OneDrive as your data source.
" } }, "OneDriveUser": { "base": null, "refs": { "OneDriveUserList$member": null } }, "OneDriveUserList": { "base": null, "refs": { "OneDriveUsers$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.
User accounts whose documents should be indexed.
", "refs": { "OneDriveConfiguration$OneDriveUsers": "A list of user accounts whose documents should be indexed.
" } }, "Order": { "base": null, "refs": { "Relevance$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.
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.
" } }, "OrganizationName": { "base": null, "refs": { "OnPremiseConfiguration$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.
", "SaaSConfiguration$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.
" } }, "Persona": { "base": null, "refs": { "EntityPersonaConfiguration$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.
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.
Summary information for users or groups in your Amazon Web Services SSO identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "refs": { "PersonasSummaryList$member": null } }, "PersonasSummaryList": { "base": null, "refs": { "ListEntityPersonasResponse$SummaryItems": "An array of summary information for one or more users or groups.
" } }, "Port": { "base": null, "refs": { "BasicAuthenticationConfiguration$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.
", "ProxyConfiguration$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.
" } }, "Principal": { "base": "Provides user and group information for user context filtering.
", "refs": { "PrincipalList$member": null } }, "PrincipalList": { "base": null, "refs": { "CreateAccessControlConfigurationRequest$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.
", "DescribeAccessControlConfigurationResponse$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.
", "Document$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.
", "HierarchicalPrincipal$PrincipalList": "A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.
", "UpdateAccessControlConfigurationRequest$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.
" } }, "PrincipalMappingStatus": { "base": null, "refs": { "GroupOrderingIdSummary$Status": "The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.
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.
", "Groups$member": null, "Principal$Name": "The name of the user or group.
", "UserContext$UserId": "The identifier of the user you want to filter search results based on their access to documents.
" } }, "PrincipalOrderingId": { "base": null, "refs": { "DeletePrincipalMappingRequest$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.
", "GroupOrderingIdSummary$OrderingId": "The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.
The timestamp identifier used for the latest PUT or DELETE action.
The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
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.
" } }, "PrincipalType": { "base": null, "refs": { "Principal$Type": "The type of principal.
" } }, "PrivateChannelFilter": { "base": null, "refs": { "SlackConfiguration$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.
" } }, "Project": { "base": null, "refs": { "JiraConfiguration$Project": "Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
" } }, "ProxyConfiguration": { "base": "Provides the configuration information for a web proxy to connect to website hosts.
", "refs": { "WebCrawlerConfiguration$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.
" } }, "PublicChannelFilter": { "base": null, "refs": { "SlackConfiguration$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.
" } }, "PutPrincipalMappingRequest": { "base": null, "refs": { } }, "QueryCapacityUnit": { "base": null, "refs": { "CapacityUnitsConfiguration$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).
The unique identifier for the search. You use QueryId to identify the search when using the feedback API.
The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.
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.
A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
", "refs": { "QueryResultItemList$member": null } }, "QueryResultItemList": { "base": null, "refs": { "QueryResult$ResultItems": "The results of the search.
" } }, "QueryResultType": { "base": null, "refs": { "QueryRequest$QueryResultTypeFilter": "Sets the type of query. Only results for the specified query type are returned.
", "QueryResultItem$Type": "The type of document.
" } }, "QuerySuggestionsBlockListId": { "base": null, "refs": { "CreateQuerySuggestionsBlockListResponse$Id": "The unique identifier of the created block list.
", "DeleteQuerySuggestionsBlockListRequest$Id": "The identifier of the block list you want to delete.
", "DescribeQuerySuggestionsBlockListRequest$Id": "The identifier of the block list you want to get information on.
", "DescribeQuerySuggestionsBlockListResponse$Id": "The identifier of the block list.
", "QuerySuggestionsBlockListSummary$Id": "The identifier of a block list.
", "UpdateQuerySuggestionsBlockListRequest$Id": "The identifier of the block list you want to update.
" } }, "QuerySuggestionsBlockListName": { "base": null, "refs": { "CreateQuerySuggestionsBlockListRequest$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.
", "DescribeQuerySuggestionsBlockListResponse$Name": "The name of the block list.
", "QuerySuggestionsBlockListSummary$Name": "The name of the block list.
", "UpdateQuerySuggestionsBlockListRequest$Name": "A new name for the block list.
" } }, "QuerySuggestionsBlockListStatus": { "base": null, "refs": { "DescribeQuerySuggestionsBlockListResponse$Status": "The current status of the block list. When the value is ACTIVE, the block list is ready for use.
The status of the block list.
" } }, "QuerySuggestionsBlockListSummary": { "base": "Summary information on a query suggestions block list.
This includes information 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.
", "refs": { "QuerySuggestionsBlockListSummaryItems$member": null } }, "QuerySuggestionsBlockListSummaryItems": { "base": null, "refs": { "ListQuerySuggestionsBlockListsResponse$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.
" } }, "QuerySuggestionsId": { "base": null, "refs": { "GetQuerySuggestionsResponse$QuerySuggestionsId": "The unique identifier for a list of query suggestions for an index.
" } }, "QuerySuggestionsStatus": { "base": null, "refs": { "DescribeQuerySuggestionsConfigResponse$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.
" } }, "QueryText": { "base": null, "refs": { "QueryRequest$QueryText": "The text to search for.
" } }, "QuipConfiguration": { "base": "Provides the configuration information to connect to Quip as your data source.
", "refs": { "DataSourceConfiguration$QuipConfiguration": "Provides the configuration information to connect to Quip as your data source.
" } }, "ReadAccessType": { "base": null, "refs": { "Principal$Access": "Whether to allow or deny document access to the principal.
" } }, "Relevance": { "base": "Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
", "refs": { "DocumentMetadataConfiguration$Relevance": "Provides tuning parameters to determine how the field affects the search results.
", "DocumentRelevanceConfiguration$Relevance": "Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
" } }, "RelevanceFeedback": { "base": "Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.
Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
" } }, "RelevanceType": { "base": null, "refs": { "RelevanceFeedback$RelevanceValue": "Whether to document was relevant or not relevant to the search.
" } }, "RepositoryName": { "base": null, "refs": { "RepositoryNames$member": null } }, "RepositoryNames": { "base": null, "refs": { "GitHubConfiguration$RepositoryFilter": "A list of names of the specific repositories you want to index.
" } }, "ResourceAlreadyExistException": { "base": "", "refs": { } }, "ResourceInUseException": { "base": "", "refs": { } }, "ResourceNotFoundException": { "base": "", "refs": { } }, "ResourceUnavailableException": { "base": "", "refs": { } }, "ResultId": { "base": null, "refs": { "ClickFeedback$ResultId": "The unique identifier of the search result that was clicked.
", "QueryResultItem$Id": "The unique identifier for the query result.
", "RelevanceFeedback$ResultId": "The unique identifier of the search result that the user provided relevance feedback for.
", "Suggestion$Id": "The unique UUID (universally unique identifier) of a single query suggestion.
" } }, "RoleArn": { "base": null, "refs": { "BatchPutDocumentRequest$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.
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.
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.
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.
", "CreateIndexRequest$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.
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.
", "CreateThesaurusRequest$RoleArn": "An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
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.
The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
", "DescribeExperienceResponse$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.
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
", "DescribeIndexResponse$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
", "DescribeQuerySuggestionsBlockListResponse$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.
", "DescribeThesaurusResponse$RoleArn": "An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
The Amazon Resource Name (arn) of the secret.
", "PutPrincipalMappingRequest$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.
", "UpdateDataSourceRequest$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.
", "UpdateExperienceRequest$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.
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
", "UpdateQuerySuggestionsBlockListRequest$RoleArn": "The IAM (Identity and Access Management) role used to access the block list text file in S3.
", "UpdateThesaurusRequest$RoleArn": "An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
", "S3DataSourceConfiguration$BucketName": "The name of the bucket that contains the documents.
", "S3Path$Bucket": "The name of the S3 bucket that contains the file.
" } }, "S3DataSourceConfiguration": { "base": "Provides the configuration information to connect to an Amazon S3 bucket.
", "refs": { "DataSourceConfiguration$S3Configuration": "Provides the configuration information to connect to an Amazon S3 bucket as your data source.
" } }, "S3ObjectKey": { "base": null, "refs": { "AccessControlListConfiguration$KeyPath": "Path to the Amazon Web Services S3 bucket that contains the ACL files.
", "DocumentsMetadataConfiguration$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.
The name of the file.
" } }, "S3Path": { "base": "Information required to find a specific file in an Amazon S3 bucket.
", "refs": { "AlfrescoConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco.
", "CreateFaqRequest$S3Path": "The path to the FAQ file in S3.
", "CreateQuerySuggestionsBlockListRequest$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.
", "CreateThesaurusRequest$SourceS3Path": "The path to the thesaurus file in S3.
", "DescribeFaqResponse$S3Path": null, "DescribeQuerySuggestionsBlockListResponse$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.
", "DescribeThesaurusResponse$SourceS3Path": null, "Document$S3Path": null, "GroupMembers$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.
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub.
", "OneDriveUsers$OneDriveUserS3Path": "The S3 bucket location of a file containing a list of users whose documents should be indexed.
", "SharePointConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint.
", "UpdateQuerySuggestionsBlockListRequest$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.
", "UpdateThesaurusRequest$SourceS3Path": null } }, "SaaSConfiguration": { "base": "Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).
", "refs": { "GitHubConfiguration$SaaSConfiguration": "Configuration information to connect to GitHub Enterprise Cloud (SaaS).
" } }, "SalesforceChatterFeedConfiguration": { "base": "The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
", "refs": { "SalesforceConfiguration$ChatterFeedConfiguration": "Configuration information for Salesforce chatter feeds.
" } }, "SalesforceChatterFeedIncludeFilterType": { "base": null, "refs": { "SalesforceChatterFeedIncludeFilterTypes$member": null } }, "SalesforceChatterFeedIncludeFilterTypes": { "base": null, "refs": { "SalesforceChatterFeedConfiguration$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.
Provides the configuration information to connect to Salesforce as your data source.
", "refs": { "DataSourceConfiguration$SalesforceConfiguration": "Provides the configuration information to connect to Salesforce as your data source.
" } }, "SalesforceCustomKnowledgeArticleTypeConfiguration": { "base": "Provides the configuration information for indexing Salesforce custom articles.
", "refs": { "SalesforceCustomKnowledgeArticleTypeConfigurationList$member": null } }, "SalesforceCustomKnowledgeArticleTypeConfigurationList": { "base": null, "refs": { "SalesforceKnowledgeArticleConfiguration$CustomKnowledgeArticleTypeConfigurations": "Configuration information for custom Salesforce knowledge articles.
" } }, "SalesforceCustomKnowledgeArticleTypeName": { "base": null, "refs": { "SalesforceCustomKnowledgeArticleTypeConfiguration$Name": "The name of the configuration.
" } }, "SalesforceKnowledgeArticleConfiguration": { "base": "Provides the 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
", "refs": { "SalesforceConfiguration$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.
" } }, "SalesforceKnowledgeArticleState": { "base": null, "refs": { "SalesforceKnowledgeArticleStateList$member": null } }, "SalesforceKnowledgeArticleStateList": { "base": null, "refs": { "SalesforceKnowledgeArticleConfiguration$IncludedStates": "Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
" } }, "SalesforceStandardKnowledgeArticleTypeConfiguration": { "base": "Provides the configuration information for standard Salesforce knowledge articles.
", "refs": { "SalesforceKnowledgeArticleConfiguration$StandardKnowledgeArticleTypeConfiguration": "Configuration information for standard Salesforce knowledge articles.
" } }, "SalesforceStandardObjectAttachmentConfiguration": { "base": "Provides the configuration information for processing attachments to Salesforce standard objects.
", "refs": { "SalesforceConfiguration$StandardObjectAttachmentConfiguration": "Configuration information for processing attachments to Salesforce standard objects.
" } }, "SalesforceStandardObjectConfiguration": { "base": "Provides the configuration information for indexing a single standard object.
", "refs": { "SalesforceStandardObjectConfigurationList$member": null } }, "SalesforceStandardObjectConfigurationList": { "base": null, "refs": { "SalesforceConfiguration$StandardObjectConfigurations": "Configuration of the Salesforce standard objects that Amazon Kendra indexes.
" } }, "SalesforceStandardObjectName": { "base": null, "refs": { "SalesforceStandardObjectConfiguration$Name": "The name of the standard object.
" } }, "ScanSchedule": { "base": null, "refs": { "CreateDataSourceRequest$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.
The schedule for Amazon Kendra to update the index.
", "UpdateDataSourceRequest$Schedule": "The sync schedule you want to update for the data source connector.
" } }, "ScoreAttributes": { "base": "Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.
", "refs": { "QueryResultItem$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.
A relative ranking for how well the response matches the query.
" } }, "Search": { "base": "Provides information about how a custom index field is used during a search.
", "refs": { "DocumentMetadataConfiguration$Search": "Provides information about how the field is used during a search.
" } }, "SecretArn": { "base": null, "refs": { "AlfrescoConfiguration$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.
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.
", "BoxConfiguration$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.
", "ConfluenceConfiguration$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.
", "ConnectionConfiguration$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.
", "FsxConfiguration$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.
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.
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.
", "JiraConfiguration$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.
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.
", "ProxyConfiguration$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.
", "QuipConfiguration$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.
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.
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.
", "SharePointConfiguration$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.
You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Authentication for a SharePoint data source.
", "SlackConfiguration$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.
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
" } }, "SeedUrl": { "base": null, "refs": { "SeedUrlList$member": null } }, "SeedUrlConfiguration": { "base": "Provides the configuration information for the seed or starting point URLs to crawl.
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.
", "refs": { "Urls$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.
" } }, "SeedUrlList": { "base": null, "refs": { "SeedUrlConfiguration$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.
" } }, "ServerSideEncryptionConfiguration": { "base": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.
", "refs": { "CreateIndexRequest$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.
", "DescribeIndexResponse$ServerSideEncryptionConfiguration": "The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
" } }, "ServiceNowAuthenticationType": { "base": null, "refs": { "ServiceNowConfiguration$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.
The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
Provides the configuration information to connect to ServiceNow as your data source.
", "refs": { "DataSourceConfiguration$ServiceNowConfiguration": "Provides the configuration information to connect to ServiceNow as your data source.
" } }, "ServiceNowHostUrl": { "base": null, "refs": { "ServiceNowConfiguration$HostUrl": "The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
" } }, "ServiceNowKnowledgeArticleConfiguration": { "base": "Provides the configuration information for crawling knowledge articles in the ServiceNow site.
", "refs": { "ServiceNowConfiguration$KnowledgeArticleConfiguration": "Configuration information for crawling knowledge articles in the ServiceNow site.
" } }, "ServiceNowKnowledgeArticleFilterQuery": { "base": null, "refs": { "ServiceNowKnowledgeArticleConfiguration$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.
" } }, "ServiceNowServiceCatalogConfiguration": { "base": "Provides the configuration information for crawling service catalog items in the ServiceNow site
", "refs": { "ServiceNowConfiguration$ServiceCatalogConfiguration": "Configuration information for crawling service catalogs in the ServiceNow site.
" } }, "ServiceQuotaExceededException": { "base": "", "refs": { } }, "SharePointConfiguration": { "base": "Provides the configuration information to connect to Microsoft SharePoint as your data source.
", "refs": { "DataSourceConfiguration$SharePointConfiguration": "Provides the configuration information to connect to Microsoft SharePoint as your data source.
" } }, "SharePointOnlineAuthenticationType": { "base": null, "refs": { "SharePointConfiguration$AuthenticationType": "Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret. You can use OAuth authentication for SharePoint Online.
" } }, "SharePointUrlList": { "base": null, "refs": { "SharePointConfiguration$Urls": "The Microsoft SharePoint site URLs for the documents you want to indext.
" } }, "SharePointVersion": { "base": null, "refs": { "SharePointConfiguration$SharePointVersion": "The version of Microsoft SharePoint that you use.
" } }, "SharedDriveId": { "base": null, "refs": { "ExcludeSharedDrivesList$member": null } }, "SinceCrawlDate": { "base": null, "refs": { "SlackConfiguration$SinceCrawlDate": "The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.
The identifier of the Alfresco site. For example, my-site.
" } }, "SiteMap": { "base": null, "refs": { "SiteMapsList$member": null } }, "SiteMapsConfiguration": { "base": "Provides the configuration information for the sitemap URLs to crawl.
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.
", "refs": { "Urls$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.
" } }, "SiteMapsList": { "base": null, "refs": { "SiteMapsConfiguration$SiteMaps": "The list of sitemap URLs of the websites you want to crawl.
The list can include a maximum of three sitemap URLs.
" } }, "SiteUrl": { "base": null, "refs": { "AlfrescoConfiguration$SiteUrl": "The URL of the Alfresco site. For example, https://hostname:8080.
" } }, "SlackConfiguration": { "base": "Provides the configuration information to connect to Slack as your data source.
", "refs": { "DataSourceConfiguration$SlackConfiguration": "Provides the configuration information to connect to Slack as your data source.
" } }, "SlackEntity": { "base": null, "refs": { "SlackEntityList$member": null } }, "SlackEntityList": { "base": null, "refs": { "SlackConfiguration$SlackEntityList": "Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
" } }, "SnapshotsDataHeaderFields": { "base": null, "refs": { "GetSnapshotsResponse$SnapshotsDataHeader": "The column headers for the search metrics data.
" } }, "SnapshotsDataRecord": { "base": null, "refs": { "SnapshotsDataRecords$member": null } }, "SnapshotsDataRecords": { "base": null, "refs": { "GetSnapshotsResponse$SnapshotsData": "The search metrics data. The data returned depends on the metric type you requested.
" } }, "SortOrder": { "base": null, "refs": { "SortingConfiguration$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.
" } }, "SortingConfiguration": { "base": "Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.
You can sort attributes of the following types.
Date value
Long value
String value
You can't sort attributes of the following type.
String list value
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.
" } }, "SpellCorrectedQuery": { "base": "A query with suggested spell corrections.
", "refs": { "SpellCorrectedQueryList$member": null } }, "SpellCorrectedQueryList": { "base": null, "refs": { "QueryResult$SpellCorrectedQueries": "A list of information related to suggested spell corrections for a query.
" } }, "SpellCorrectionConfiguration": { "base": "Provides the configuration information for suggested query spell corrections.
Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.
This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the Spell Checker documentation.
", "refs": { "QueryRequest$SpellCorrectionConfiguration": "Enables suggested spell corrections for queries.
" } }, "SqlConfiguration": { "base": "Provides the configuration information to use a SQL database.
", "refs": { "DatabaseConfiguration$SqlConfiguration": "Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
" } }, "StartDataSourceSyncJobRequest": { "base": null, "refs": { } }, "StartDataSourceSyncJobResponse": { "base": null, "refs": { } }, "Status": { "base": "Provides information about the status of documents submitted for indexing.
", "refs": { "DocumentStatusList$member": null } }, "StopDataSourceSyncJobRequest": { "base": null, "refs": { } }, "StorageCapacityUnit": { "base": null, "refs": { "CapacityUnitsConfiguration$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.
" } }, "String": { "base": null, "refs": { "AdditionalResultAttribute$Key": "The key that identifies the attribute.
", "Correction$Term": "The string or text of a misspelled word in a query.
", "Correction$CorrectedTerm": "The string or text of a corrected misspelled word in a query.
", "DataSourceSyncJob$ExecutionId": "A unique identifier for the synchronization job.
", "DataSourceSyncJob$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.
", "DocumentAttributeStringListValue$member": null, "IssueType$member": null, "JiraStatus$member": null, "JsonTokenTypeConfiguration$UserNameAttributeField": "The user name attribute field.
", "JsonTokenTypeConfiguration$GroupAttributeField": "The group attribute field.
", "ListAccessControlConfigurationsRequest$NextToken": "If the previous response was incomplete (because there's 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.
", "ListAccessControlConfigurationsResponse$NextToken": "If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations.
", "PrivateChannelFilter$member": null, "Project$member": null, "PublicChannelFilter$member": null, "SnapshotsDataHeaderFields$member": null, "SnapshotsDataRecord$member": null, "StartDataSourceSyncJobResponse$ExecutionId": "Identifies a particular synchronization job.
", "Status$FailureCode": "Indicates the source of the error.
", "Status$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.
", "StringList$member": null, "SuggestionTextWithHighlights$Text": "The query suggestion text to display to the user.
", "TextWithHighlights$Text": "The text to display to the user.
" } }, "StringList": { "base": null, "refs": { "GitHubConfiguration$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.
", "GitHubConfiguration$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.
", "GitHubConfiguration$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.
", "GitHubConfiguration$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.
", "GitHubConfiguration$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.
", "GitHubConfiguration$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.
" } }, "SubmitFeedbackRequest": { "base": null, "refs": { } }, "SubnetId": { "base": null, "refs": { "SubnetIdList$member": null } }, "SubnetIdList": { "base": null, "refs": { "DataSourceVpcConfiguration$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.
" } }, "SuggestedQueryText": { "base": null, "refs": { "SpellCorrectedQuery$SuggestedQueryText": "The query with the suggested spell corrections.
" } }, "Suggestion": { "base": "A single query suggestion.
", "refs": { "SuggestionList$member": null } }, "SuggestionHighlight": { "base": "The text highlights for a single query suggestion.
", "refs": { "SuggestionHighlightList$member": null } }, "SuggestionHighlightList": { "base": null, "refs": { "SuggestionTextWithHighlights$Highlights": "The beginning and end of the query suggestion text that should be highlighted.
" } }, "SuggestionList": { "base": null, "refs": { "GetQuerySuggestionsResponse$Suggestions": "A list of query suggestions for an index.
" } }, "SuggestionQueryText": { "base": null, "refs": { "GetQuerySuggestionsRequest$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.
" } }, "SuggestionTextWithHighlights": { "base": "Provides text and information about where to highlight the query suggestion text.
", "refs": { "SuggestionValue$Text": "The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.
The SuggestionTextWithHighlights structure information.
The value for the unique UUID (universally unique identifier) of a single query suggestion.
The value is the text string of a suggestion.
" } }, "TableName": { "base": null, "refs": { "ConnectionConfiguration$TableName": "The name of the table that contains the document data.
" } }, "Tag": { "base": "A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not exist on the resource, it is ignored.
" } }, "TagList": { "base": null, "refs": { "CreateDataSourceRequest$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.
", "CreateFaqRequest$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.
", "CreateIndexRequest$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.
", "CreateQuerySuggestionsBlockListRequest$Tags": "A tag that you can assign to a block list that categorizes the block list.
", "CreateThesaurusRequest$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.
", "ListTagsForResourceResponse$Tags": "A list of tags associated with the index, FAQ, or data source.
", "TagResourceRequest$Tags": "A list of tag keys to add to the index, FAQ, or data source. If a tag already exists, the existing value is replaced with the new value.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value associated with the tag. The value may be an empty string but it can't be null.
" } }, "TeamId": { "base": null, "refs": { "SlackConfiguration$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/....
" } }, "TenantDomain": { "base": null, "refs": { "OneDriveConfiguration$TenantDomain": "The Azure Active Directory domain of the organization.
" } }, "TextDocumentStatistics": { "base": "Provides information about text documents indexed in an index.
", "refs": { "IndexStatistics$TextDocumentStatistics": "The number of text documents indexed.
" } }, "TextWithHighlights": { "base": "Provides text and information about where to highlight the text.
", "refs": { "AdditionalResultAttributeValue$TextWithHighlightsValue": "The text associated with the attribute and information about the highlight to apply to the text.
", "QueryResultItem$DocumentTitle": "The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
", "QueryResultItem$DocumentExcerpt": "An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
" } }, "ThesaurusId": { "base": null, "refs": { "CreateThesaurusResponse$Id": "The unique identifier of the thesaurus.
", "DeleteThesaurusRequest$Id": "The identifier of the thesaurus you want to delete.
", "DescribeThesaurusRequest$Id": "The identifier of the thesaurus you want to get information on.
", "DescribeThesaurusResponse$Id": "The identifier of the thesaurus.
", "ThesaurusSummary$Id": "The identifier of the thesaurus.
", "UpdateThesaurusRequest$Id": "The identifier of the thesaurus you want to update.
" } }, "ThesaurusName": { "base": null, "refs": { "CreateThesaurusRequest$Name": "A name for the thesaurus.
", "DescribeThesaurusResponse$Name": "The thesaurus name.
", "ThesaurusSummary$Name": "The name of the thesaurus.
", "UpdateThesaurusRequest$Name": "A new name for the thesaurus.
" } }, "ThesaurusStatus": { "base": null, "refs": { "DescribeThesaurusResponse$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.
The status of the thesaurus.
" } }, "ThesaurusSummary": { "base": "An array of summary information for a thesaurus or multiple thesauri.
", "refs": { "ThesaurusSummaryItems$member": null } }, "ThesaurusSummaryItems": { "base": null, "refs": { "ListThesauriResponse$ThesaurusSummaryItems": "An array of summary information for a thesaurus or multiple thesauri.
" } }, "ThrottlingException": { "base": "", "refs": { } }, "TimeRange": { "base": "Provides a range of time.
", "refs": { "GetSnapshotsResponse$SnapShotTimeFilter": "The date-time for the beginning and end of the time window for the search metrics data.
", "ListDataSourceSyncJobsRequest$StartTimeFilter": "When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
" } }, "Timestamp": { "base": null, "refs": { "ClickFeedback$ClickTime": "The Unix timestamp of the date and time that the result was clicked.
", "DataSourceSummary$CreatedAt": "The UNIX datetime that the data source was created.
", "DataSourceSummary$UpdatedAt": "The UNIX datetime that the data source was lasted updated.
", "DataSourceSyncJob$StartTime": "The UNIX datetime that the synchronization job started.
", "DataSourceSyncJob$EndTime": "The UNIX datetime that the synchronization job completed.
", "DescribeDataSourceResponse$CreatedAt": "The Unix timestamp of when the data source was created.
", "DescribeDataSourceResponse$UpdatedAt": "The Unix timestamp of when the data source was last updated.
", "DescribeExperienceResponse$CreatedAt": "Shows the date-time your Amazon Kendra experience was created.
", "DescribeExperienceResponse$UpdatedAt": "Shows the date-time your Amazon Kendra experience was last updated.
", "DescribeFaqResponse$CreatedAt": "The date and time that the FAQ was created.
", "DescribeFaqResponse$UpdatedAt": "The date and time that the FAQ was last updated.
", "DescribeIndexResponse$CreatedAt": "The Unix datetime that the index was created.
", "DescribeIndexResponse$UpdatedAt": "The Unix datetime that the index was last updated.
", "DescribeQuerySuggestionsBlockListResponse$CreatedAt": "The date-time a block list for query suggestions was created.
", "DescribeQuerySuggestionsBlockListResponse$UpdatedAt": "The date-time a block list for query suggestions was last updated.
", "DescribeQuerySuggestionsConfigResponse$LastSuggestionsBuildTime": "The date-time query suggestions for an index was last updated.
", "DescribeQuerySuggestionsConfigResponse$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.
", "DescribeThesaurusResponse$CreatedAt": "The Unix datetime that the thesaurus was created.
", "DescribeThesaurusResponse$UpdatedAt": "The Unix datetime that the thesaurus was last updated.
", "DocumentAttributeValue$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.
", "ExperiencesSummary$CreatedAt": "The date-time your Amazon Kendra experience was created.
", "FaqSummary$CreatedAt": "The UNIX datetime that the FAQ was added to the index.
", "FaqSummary$UpdatedAt": "The UNIX datetime that the FAQ was last updated.
", "GroupOrderingIdSummary$LastUpdatedAt": "The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.
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.
The Unix timestamp when the index was created.
", "IndexConfigurationSummary$UpdatedAt": "The Unix timestamp when the index was last updated by the UpdateIndex API.
The date-time the summary information was created.
", "PersonasSummary$UpdatedAt": "The date-time the summary information was last updated.
", "QuerySuggestionsBlockListSummary$CreatedAt": "The date-time summary information for a query suggestions block list was last created.
", "QuerySuggestionsBlockListSummary$UpdatedAt": "The date-time the block list was last updated.
", "ThesaurusSummary$CreatedAt": "The Unix datetime that the thesaurus was created.
", "ThesaurusSummary$UpdatedAt": "The Unix datetime that the thesaurus was last updated.
", "TimeRange$StartTime": "The UNIX datetime of the beginning of the time range.
", "TimeRange$EndTime": "The UNIX datetime of the end of the time range.
" } }, "Title": { "base": null, "refs": { "Document$Title": "The title of the document.
" } }, "Token": { "base": null, "refs": { "UserContext$Token": "The user context token for filtering search results for a user. It must be a JWT or a JSON token.
" } }, "TopDocumentAttributeValueCountPairsSize": { "base": null, "refs": { "Facet$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.
" } }, "Type": { "base": null, "refs": { "GitHubConfiguration$Type": "The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAccessControlConfigurationRequest": { "base": null, "refs": { } }, "UpdateAccessControlConfigurationResponse": { "base": null, "refs": { } }, "UpdateDataSourceRequest": { "base": null, "refs": { } }, "UpdateExperienceRequest": { "base": null, "refs": { } }, "UpdateIndexRequest": { "base": null, "refs": { } }, "UpdateQuerySuggestionsBlockListRequest": { "base": null, "refs": { } }, "UpdateQuerySuggestionsConfigRequest": { "base": null, "refs": { } }, "UpdateThesaurusRequest": { "base": null, "refs": { } }, "Url": { "base": null, "refs": { "ConfluenceConfiguration$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/.
", "JwtTokenTypeConfiguration$URL": "The signing key URL.
", "OnPremiseConfiguration$HostUrl": "The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/
", "QueryResultItem$DocumentURI": "The URI of the original location of the document.
", "SaaSConfiguration$HostUrl": "The GitHub host URL or API endpoint URL. For example, https://api.github.com.
", "SalesforceConfiguration$ServerUrl": "The instance URL for the Salesforce site that you want to index.
", "SharePointUrlList$member": null } }, "Urls": { "base": "Provides the configuration information of the URLs to crawl.
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.
", "refs": { "WebCrawlerConfiguration$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.
" } }, "UserAccount": { "base": null, "refs": { "ExcludeUserAccountsList$member": null } }, "UserContext": { "base": "Provides information about the user context for an Amazon Kendra index.
User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.
You provide one of the following:
User token
User ID, the groups the user belongs to, and any data sources the groups can access.
If you provide both, an exception is thrown.
", "refs": { "QueryRequest$UserContext": "The user context token or user and group information.
" } }, "UserContextPolicy": { "base": null, "refs": { "CreateIndexRequest$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.
The user context policy for the Amazon Kendra index.
", "UpdateIndexRequest$UserContextPolicy": "The user context policy.
" } }, "UserGroupResolutionConfiguration": { "base": "Provides the configuration information to fetch access levels of groups and users from an Amazon Web Services Single Sign On identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping API to map users to their groups so that you only need to provide the user ID when you issue the query.
To set up an Amazon Web Services SSO identity source in the console to use with Amazon Kendra, see Getting started with an Amazon Web Services SSO identity source. You must also grant the required permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see IAM roles for Amazon Web Services SSO.
Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your Amazon Web Services SSO identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.
Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.
", "DescribeIndexResponse$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.
", "UpdateIndexRequest$UserGroupResolutionConfiguration": "Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.
" } }, "UserGroupResolutionMode": { "base": null, "refs": { "UserGroupResolutionConfiguration$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.
" } }, "UserId": { "base": null, "refs": { "MemberUser$UserId": "The identifier of the user you want to map to a group.
" } }, "UserIdentityConfiguration": { "base": "Provides the configuration information for the identifiers of your users.
", "refs": { "ExperienceConfiguration$UserIdentityConfiguration": "The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.
" } }, "UserNameAttributeField": { "base": null, "refs": { "JwtTokenTypeConfiguration$UserNameAttributeField": "The user name attribute field.
" } }, "UserTokenConfiguration": { "base": "Provides the configuration information for a token.
", "refs": { "UserTokenConfigurationList$member": null } }, "UserTokenConfigurationList": { "base": null, "refs": { "CreateIndexRequest$UserTokenConfigurations": "The user token configuration.
", "DescribeIndexResponse$UserTokenConfigurations": "The user token configuration for the Amazon Kendra index.
", "UpdateIndexRequest$UserTokenConfigurations": "The user token configuration.
" } }, "ValidationException": { "base": "", "refs": { } }, "ValueImportanceMap": { "base": null, "refs": { "Relevance$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.
" } }, "ValueImportanceMapKey": { "base": null, "refs": { "ValueImportanceMap$key": null } }, "VisitorId": { "base": null, "refs": { "QueryRequest$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.
The warning code and message that explains a problem with a query.
", "refs": { "WarningList$member": null } }, "WarningCode": { "base": null, "refs": { "Warning$Code": "The code used to show the type of warning for the query.
" } }, "WarningList": { "base": null, "refs": { "QueryResult$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.
" } }, "WarningMessage": { "base": null, "refs": { "Warning$Message": "The message that explains the problem with the query.
" } }, "WebCrawlerConfiguration": { "base": "Provides the configuration information required for Amazon Kendra Web Crawler.
", "refs": { "DataSourceConfiguration$WebCrawlerConfiguration": null } }, "WebCrawlerMode": { "base": null, "refs": { "SeedUrlConfiguration$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.
Provides the configuration information to connect to Amazon WorkDocs as your data source.
Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.
", "refs": { "DataSourceConfiguration$WorkDocsConfiguration": "Provides the configuration information to connect to Amazon WorkDocs as your data source.
" } } } }