AWSKendraFrontendService 2019-02-03
- Client: Aws\kendra\kendraClient
- Service ID: kendra
- Version: 2019-02-03
This page describes the parameters and results for the operations of the AWSKendraFrontendService (2019-02-03), and shows how to use the Aws\kendra\kendraClient object to call the described operations. This documentation is specific to the 2019-02-03 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchDeleteDocument ( array $params = [] )
Removes one or more documents from an index.
- BatchGetDocumentStatus ( array $params = [] )
Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
- BatchPutDocument ( array $params = [] )
Adds one or more documents to an index.
- ClearQuerySuggestions ( array $params = [] )
Clears existing query suggestions from an index.
- CreateDataSource ( array $params = [] )
Creates a data source that you want to use with an Amazon Kendra index.
- CreateFaq ( array $params = [] )
Creates an new set of frequently asked question (FAQ) questions and answers.
- CreateIndex ( array $params = [] )
Creates a new Amazon Kendra index.
- CreateQuerySuggestionsBlockList ( array $params = [] )
Creates a block list to exlcude certain queries from suggestions.
- CreateThesaurus ( array $params = [] )
Creates a thesaurus for an index.
- DeleteDataSource ( array $params = [] )
Deletes an Amazon Kendra data source.
- DeleteFaq ( array $params = [] )
Removes an FAQ from an index.
- DeleteIndex ( array $params = [] )
Deletes an existing Amazon Kendra index.
- DeletePrincipalMapping ( array $params = [] )
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.
- DeleteQuerySuggestionsBlockList ( array $params = [] )
Deletes a block list used for query suggestions for an index.
- DeleteThesaurus ( array $params = [] )
Deletes an existing Amazon Kendra thesaurus.
- DescribeDataSource ( array $params = [] )
Gets information about a Amazon Kendra data source.
- DescribeFaq ( array $params = [] )
Gets information about an FAQ list.
- DescribeIndex ( array $params = [] )
Describes an existing Amazon Kendra index
- DescribePrincipalMapping ( array $params = [] )
Describes the processing of PUT and DELETE actions for mapping users to their groups.
- DescribeQuerySuggestionsBlockList ( array $params = [] )
Describes a block list used for query suggestions for an index.
- DescribeQuerySuggestionsConfig ( array $params = [] )
Describes the settings of query suggestions for an index.
- DescribeThesaurus ( array $params = [] )
Describes an existing Amazon Kendra thesaurus.
- GetQuerySuggestions ( array $params = [] )
Fetches the queries that are suggested to your users.
- ListDataSourceSyncJobs ( array $params = [] )
Gets statistics about synchronizing Amazon Kendra with a data source.
- ListDataSources ( array $params = [] )
Lists the data sources that you have created.
- ListFaqs ( array $params = [] )
Gets a list of FAQ lists associated with an index.
- ListGroupsOlderThanOrderingId ( array $params = [] )
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
- ListIndices ( array $params = [] )
Lists the Amazon Kendra indexes that you have created.
- ListQuerySuggestionsBlockLists ( array $params = [] )
Lists the block lists used for query suggestions for an index.
- ListTagsForResource ( array $params = [] )
Gets a list of tags associated with a specified resource.
- ListThesauri ( array $params = [] )
Lists the Amazon Kendra thesauri associated with an index.
- PutPrincipalMapping ( array $params = [] )
Maps users to their groups so that you only need to provide the user ID when you issue the query.
- Query ( array $params = [] )
Searches an active index.
- StartDataSourceSyncJob ( array $params = [] )
Starts a synchronization job for a data source.
- StopDataSourceSyncJob ( array $params = [] )
Stops a running synchronization job.
- SubmitFeedback ( array $params = [] )
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
- TagResource ( array $params = [] )
Adds the specified tag to the specified index, FAQ, or data source resource.
- UntagResource ( array $params = [] )
Removes a tag from an index, FAQ, or a data source.
- UpdateDataSource ( array $params = [] )
Updates an existing Amazon Kendra data source.
- UpdateIndex ( array $params = [] )
Updates an existing Amazon Kendra index.
- UpdateQuerySuggestionsBlockList ( array $params = [] )
Updates a block list used for query suggestions for an index.
- UpdateQuerySuggestionsConfig ( array $params = [] )
Updates the settings of query suggestions for an index.
- UpdateThesaurus ( array $params = [] )
Updates a thesaurus file associated with an index.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchDeleteDocument
$result = $client->batchDeleteDocument([/* ... */]); $promise = $client->batchDeleteDocumentAsync([/* ... */]);
Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
Parameter Syntax
$result = $client->batchDeleteDocument([
'DataSourceSyncJobMetricTarget' => [
'DataSourceId' => '<string>', // REQUIRED
'DataSourceSyncJobId' => '<string>',
],
'DocumentIdList' => ['<string>', ...], // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DataSourceSyncJobMetricTarget
-
- Type: DataSourceSyncJobMetricTarget structure
Maps a particular data source sync job to a particular data source.
- DocumentIdList
-
- Required: Yes
- Type: Array of strings
One or more identifiers for documents to delete from the index.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that contains the documents to delete.
Result Syntax
[
'FailedDocuments' => [
[
'ErrorCode' => 'InternalError|InvalidRequest',
'ErrorMessage' => '<string>',
'Id' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedDocuments
-
- Type: Array of BatchDeleteDocumentResponseFailedDocument structures
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.
Errors
BatchGetDocumentStatus
$result = $client->batchGetDocumentStatus([/* ... */]); $promise = $client->batchGetDocumentStatusAsync([/* ... */]);
Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.
You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
Parameter Syntax
$result = $client->batchGetDocumentStatus([
'DocumentInfoList' => [ // REQUIRED
[
'Attributes' => [
[
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
// ...
],
'DocumentId' => '<string>', // REQUIRED
],
// ...
],
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DocumentInfoList
-
- Required: Yes
- Type: Array of DocumentInfo structures
A list of
DocumentInfoobjects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes. - IndexId
-
- Required: Yes
- Type: string
The identifier of the index to add documents to. The index ID is returned by the CreateIndex operation.
Result Syntax
[
'DocumentStatusList' => [
[
'DocumentId' => '<string>',
'DocumentStatus' => 'NOT_FOUND|PROCESSING|INDEXED|UPDATED|FAILED|UPDATE_FAILED',
'FailureCode' => '<string>',
'FailureReason' => '<string>',
],
// ...
],
'Errors' => [
[
'DocumentId' => '<string>',
'ErrorCode' => 'InternalError|InvalidRequest',
'ErrorMessage' => '<string>',
],
// ...
],
]
Result Details
Members
- DocumentStatusList
-
- Type: Array of Status structures
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.
- Errors
-
- Type: Array of BatchGetDocumentStatusResponseError structures
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.
Errors
BatchPutDocument
$result = $client->batchPutDocument([/* ... */]); $promise = $client->batchPutDocumentAsync([/* ... */]);
Adds one or more documents to an index.
The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
Parameter Syntax
$result = $client->batchPutDocument([
'Documents' => [ // REQUIRED
[
'AccessControlList' => [
[
'Access' => 'ALLOW|DENY', // REQUIRED
'DataSourceId' => '<string>',
'Name' => '<string>', // REQUIRED
'Type' => 'USER|GROUP', // REQUIRED
],
// ...
],
'Attributes' => [
[
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
// ...
],
'Blob' => <string || resource || Psr\Http\Message\StreamInterface>,
'ContentType' => 'PDF|HTML|MS_WORD|PLAIN_TEXT|PPT',
'HierarchicalAccessControlList' => [
[
'PrincipalList' => [ // REQUIRED
[
'Access' => 'ALLOW|DENY', // REQUIRED
'DataSourceId' => '<string>',
'Name' => '<string>', // REQUIRED
'Type' => 'USER|GROUP', // REQUIRED
],
// ...
],
],
// ...
],
'Id' => '<string>', // REQUIRED
'S3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
'Title' => '<string>',
],
// ...
],
'IndexId' => '<string>', // REQUIRED
'RoleArn' => '<string>',
]);
Parameter Details
Members
- Documents
-
- Required: Yes
- Type: Array of Document structures
One or more documents to add to the index.
Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.
Documents have the following file size limits.
-
5 MB total size for inline documents
-
50 MB total size for files from an S3 bucket
-
5 MB extracted text for any file
For more information about file size and transaction per second quotas, see Quotas.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index to add the documents to. You need to create the index first using the
CreateIndexoperation. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of a role that is allowed to run the
BatchPutDocumentoperation. For more information, see IAM Roles for Amazon Kendra.
Result Syntax
[
'FailedDocuments' => [
[
'ErrorCode' => 'InternalError|InvalidRequest',
'ErrorMessage' => '<string>',
'Id' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedDocuments
-
- Type: Array of BatchPutDocumentResponseFailedDocument structures
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
Errors
ClearQuerySuggestions
$result = $client->clearQuerySuggestions([/* ... */]); $promise = $client->clearQuerySuggestionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->clearQuerySuggestions([
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
CreateDataSource
$result = $client->createDataSource([/* ... */]); $promise = $client->createDataSourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createDataSource([
'ClientToken' => '<string>',
'Configuration' => [
'ConfluenceConfiguration' => [
'AttachmentConfiguration' => [
'AttachmentFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|CONTENT_TYPE|CREATED_DATE|DISPLAY_URL|FILE_SIZE|ITEM_TYPE|PARENT_ID|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'CrawlAttachments' => true || false,
],
'BlogConfiguration' => [
'BlogFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|DISPLAY_URL|ITEM_TYPE|LABELS|PUBLISH_DATE|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'ExclusionPatterns' => ['<string>', ...],
'InclusionPatterns' => ['<string>', ...],
'PageConfiguration' => [
'PageFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|CONTENT_STATUS|CREATED_DATE|DISPLAY_URL|ITEM_TYPE|LABELS|MODIFIED_DATE|PARENT_ID|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'SecretArn' => '<string>', // REQUIRED
'ServerUrl' => '<string>', // REQUIRED
'SpaceConfiguration' => [
'CrawlArchivedSpaces' => true || false,
'CrawlPersonalSpaces' => true || false,
'ExcludeSpaces' => ['<string>', ...],
'IncludeSpaces' => ['<string>', ...],
'SpaceFieldMappings' => [
[
'DataSourceFieldName' => 'DISPLAY_URL|ITEM_TYPE|SPACE_KEY|URL',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'Version' => 'CLOUD|SERVER', // REQUIRED
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'DatabaseConfiguration' => [
'AclConfiguration' => [
'AllowedGroupsColumnName' => '<string>', // REQUIRED
],
'ColumnConfiguration' => [ // REQUIRED
'ChangeDetectingColumns' => ['<string>', ...], // REQUIRED
'DocumentDataColumnName' => '<string>', // REQUIRED
'DocumentIdColumnName' => '<string>', // REQUIRED
'DocumentTitleColumnName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
],
'ConnectionConfiguration' => [ // REQUIRED
'DatabaseHost' => '<string>', // REQUIRED
'DatabaseName' => '<string>', // REQUIRED
'DatabasePort' => <integer>, // REQUIRED
'SecretArn' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
],
'DatabaseEngineType' => 'RDS_AURORA_MYSQL|RDS_AURORA_POSTGRESQL|RDS_MYSQL|RDS_POSTGRESQL', // REQUIRED
'SqlConfiguration' => [
'QueryIdentifiersEnclosingOption' => 'DOUBLE_QUOTES|NONE',
],
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'GoogleDriveConfiguration' => [
'ExcludeMimeTypes' => ['<string>', ...],
'ExcludeSharedDrives' => ['<string>', ...],
'ExcludeUserAccounts' => ['<string>', ...],
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'SecretArn' => '<string>', // REQUIRED
],
'OneDriveConfiguration' => [
'DisableLocalGroups' => true || false,
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'OneDriveUsers' => [ // REQUIRED
'OneDriveUserList' => ['<string>', ...],
'OneDriveUserS3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
],
'SecretArn' => '<string>', // REQUIRED
'TenantDomain' => '<string>', // REQUIRED
],
'S3Configuration' => [
'AccessControlListConfiguration' => [
'KeyPath' => '<string>',
],
'BucketName' => '<string>', // REQUIRED
'DocumentsMetadataConfiguration' => [
'S3Prefix' => '<string>',
],
'ExclusionPatterns' => ['<string>', ...],
'InclusionPatterns' => ['<string>', ...],
'InclusionPrefixes' => ['<string>', ...],
],
'SalesforceConfiguration' => [
'ChatterFeedConfiguration' => [
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'IncludeFilterTypes' => ['<string>', ...],
],
'CrawlAttachments' => true || false,
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'IncludeAttachmentFilePatterns' => ['<string>', ...],
'KnowledgeArticleConfiguration' => [
'CustomKnowledgeArticleTypeConfigurations' => [
[
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
],
// ...
],
'IncludedStates' => ['<string>', ...], // REQUIRED
'StandardKnowledgeArticleTypeConfiguration' => [
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
],
],
'SecretArn' => '<string>', // REQUIRED
'ServerUrl' => '<string>', // REQUIRED
'StandardObjectAttachmentConfiguration' => [
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
],
'StandardObjectConfigurations' => [
[
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'Name' => 'ACCOUNT|CAMPAIGN|CASE|CONTACT|CONTRACT|DOCUMENT|GROUP|IDEA|LEAD|OPPORTUNITY|PARTNER|PRICEBOOK|PRODUCT|PROFILE|SOLUTION|TASK|USER', // REQUIRED
],
// ...
],
],
'ServiceNowConfiguration' => [
'AuthenticationType' => 'HTTP_BASIC|OAUTH2',
'HostUrl' => '<string>', // REQUIRED
'KnowledgeArticleConfiguration' => [
'CrawlAttachments' => true || false,
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'FilterQuery' => '<string>',
'IncludeAttachmentFilePatterns' => ['<string>', ...],
],
'SecretArn' => '<string>', // REQUIRED
'ServiceCatalogConfiguration' => [
'CrawlAttachments' => true || false,
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'IncludeAttachmentFilePatterns' => ['<string>', ...],
],
'ServiceNowBuildVersion' => 'LONDON|OTHERS', // REQUIRED
],
'SharePointConfiguration' => [
'CrawlAttachments' => true || false,
'DisableLocalGroups' => true || false,
'DocumentTitleFieldName' => '<string>',
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'SecretArn' => '<string>', // REQUIRED
'SharePointVersion' => 'SHAREPOINT_2013|SHAREPOINT_2016|SHAREPOINT_ONLINE', // REQUIRED
'SslCertificateS3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
'Urls' => ['<string>', ...], // REQUIRED
'UseChangeLog' => true || false,
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'WebCrawlerConfiguration' => [
'AuthenticationConfiguration' => [
'BasicAuthentication' => [
[
'Credentials' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
// ...
],
],
'CrawlDepth' => <integer>,
'MaxContentSizePerPageInMegaBytes' => <float>,
'MaxLinksPerPage' => <integer>,
'MaxUrlsPerMinuteCrawlRate' => <integer>,
'ProxyConfiguration' => [
'Credentials' => '<string>',
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'UrlExclusionPatterns' => ['<string>', ...],
'UrlInclusionPatterns' => ['<string>', ...],
'Urls' => [ // REQUIRED
'SeedUrlConfiguration' => [
'SeedUrls' => ['<string>', ...], // REQUIRED
'WebCrawlerMode' => 'HOST_ONLY|SUBDOMAINS|EVERYTHING',
],
'SiteMapsConfiguration' => [
'SiteMaps' => ['<string>', ...], // REQUIRED
],
],
],
'WorkDocsConfiguration' => [
'CrawlComments' => true || false,
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'OrganizationId' => '<string>', // REQUIRED
'UseChangeLog' => true || false,
],
],
'Description' => '<string>',
'IndexId' => '<string>', // REQUIRED
'LanguageCode' => '<string>',
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>',
'Schedule' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE|WEBCRAWLER|WORKDOCS', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A token that you provide to identify the request to create a data source. Multiple calls to the
CreateDataSourceoperation with the same client token will create only one data source. - Configuration
-
- Type: DataSourceConfiguration structure
The connector configuration information that is required to access the repository.
You can't specify the
Configurationparameter when theTypeparameter is set toCUSTOM. If you do, you receive aValidationExceptionexception.The
Configurationparameter is required for all other data sources. - Description
-
- Type: string
A description for the data source.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that should be associated with this data source.
- LanguageCode
-
- Type: string
The code for a language. This allows you to support a language for all documents when creating 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.
- Name
-
- Required: Yes
- Type: string
A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.
You can't specify the
RoleArnparameter when theTypeparameter is set toCUSTOM. If you do, you receive aValidationExceptionexception.The
RoleArnparameter is required for all other data sources. - Schedule
-
- Type: string
Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the
StartDataSourceSyncJoboperation to update the index.You can't specify the
Scheduleparameter when theTypeparameter is set toCUSTOM. If you do, you receive aValidationExceptionexception. - Tags
-
- Type: Array of Tag structures
A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.
- Type
-
- Required: Yes
- Type: string
The type of repository that contains the data source.
Result Syntax
[
'Id' => '<string>',
]
Result Details
Errors
CreateFaq
$result = $client->createFaq([/* ... */]); $promise = $client->createFaqAsync([/* ... */]);
Creates an new set of frequently asked question (FAQ) questions and answers.
Parameter Syntax
$result = $client->createFaq([
'ClientToken' => '<string>',
'Description' => '<string>',
'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
'IndexId' => '<string>', // REQUIRED
'LanguageCode' => '<string>',
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
'S3Path' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A token that you provide to identify the request to create a FAQ. Multiple calls to the
CreateFaqRequestoperation with the same client token will create only one FAQ. - Description
-
- Type: string
A description of the FAQ.
- FileFormat
-
- Type: string
The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The format must match the format of the file stored in the S3 bucket identified in the
S3Pathparameter.For more information, see Adding questions and answers.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that contains the FAQ.
- LanguageCode
-
- Type: string
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.
- Name
-
- Required: Yes
- Type: string
The name that should be associated with the FAQ.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
- S3Path
-
- Required: Yes
- Type: S3Path structure
The S3 location of the FAQ input data.
- Tags
-
- Type: Array of Tag structures
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.
Result Syntax
[
'Id' => '<string>',
]
Result Details
Errors
CreateIndex
$result = $client->createIndex([/* ... */]); $promise = $client->createIndexAsync([/* ... */]);
Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.
Parameter Syntax
$result = $client->createIndex([
'ClientToken' => '<string>',
'Description' => '<string>',
'Edition' => 'DEVELOPER_EDITION|ENTERPRISE_EDITION',
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
'ServerSideEncryptionConfiguration' => [
'KmsKeyId' => '<string>',
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'UserContextPolicy' => 'ATTRIBUTE_FILTER|USER_TOKEN',
'UserGroupResolutionConfiguration' => [
'UserGroupResolutionMode' => 'AWS_SSO|NONE', // REQUIRED
],
'UserTokenConfigurations' => [
[
'JsonTokenTypeConfiguration' => [
'GroupAttributeField' => '<string>', // REQUIRED
'UserNameAttributeField' => '<string>', // REQUIRED
],
'JwtTokenTypeConfiguration' => [
'ClaimRegex' => '<string>',
'GroupAttributeField' => '<string>',
'Issuer' => '<string>',
'KeyLocation' => 'URL|SECRET_MANAGER', // REQUIRED
'SecretManagerArn' => '<string>',
'URL' => '<string>',
'UserNameAttributeField' => '<string>',
],
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A token that you provide to identify the request to create an index. Multiple calls to the
CreateIndexoperation with the same client token will create only one index. - Description
-
- Type: string
A description for the index.
- Edition
-
- Type: string
The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed.The
Editionparameter is optional. If you don't supply a value, the default isENTERPRISE_EDITION.For more information on quota limits for enterprise and developer editions, see Quotas.
- Name
-
- Required: Yes
- Type: string
The name for the new index.
- RoleArn
-
- Required: Yes
- Type: string
An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the
BatchPutDocumentoperation to index documents from an Amazon S3 bucket. - ServerSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
- Tags
-
- Type: Array of Tag structures
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.
- UserContextPolicy
-
- Type: string
The user context policy.
- ATTRIBUTE_FILTER
-
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_idand_group_idsor you can provide user and group information inUserContext. - USER_TOKEN
-
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
- UserGroupResolutionConfiguration
-
- Type: UserGroupResolutionConfiguration structure
Enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration.
- UserTokenConfigurations
-
- Type: Array of UserTokenConfiguration structures
The user token configuration.
Result Syntax
[
'Id' => '<string>',
]
Result Details
Members
Errors
CreateQuerySuggestionsBlockList
$result = $client->createQuerySuggestionsBlockList([/* ... */]); $promise = $client->createQuerySuggestionsBlockListAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createQuerySuggestionsBlockList([
'ClientToken' => '<string>',
'Description' => '<string>',
'IndexId' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
'SourceS3Path' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A token that you provide to identify the request to create a query suggestions block list.
- Description
-
- Type: string
A user-friendly description for the block list.
For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index you want to create a query suggestions block list for.
- Name
-
- Required: Yes
- Type: string
A user friendly name for the block list.
For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.
- RoleArn
-
- Required: Yes
- Type: string
The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
- SourceS3Path
-
- Required: Yes
- Type: S3Path structure
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.
- Tags
-
- Type: Array of Tag structures
A tag that you can assign to a block list that categorizes the block list.
Result Syntax
[
'Id' => '<string>',
]
Result Details
Errors
CreateThesaurus
$result = $client->createThesaurus([/* ... */]); $promise = $client->createThesaurusAsync([/* ... */]);
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
Parameter Syntax
$result = $client->createThesaurus([
'ClientToken' => '<string>',
'Description' => '<string>',
'IndexId' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
'SourceS3Path' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A token that you provide to identify the request to create a thesaurus. Multiple calls to the
CreateThesaurusoperation with the same client token will create only one thesaurus. - Description
-
- Type: string
The description for the new thesaurus.
- IndexId
-
- Required: Yes
- Type: string
The unique identifier of the index for the new thesaurus.
- Name
-
- Required: Yes
- Type: string
The name for the new thesaurus.
- RoleArn
-
- Required: Yes
- Type: string
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in
SourceS3Path. - SourceS3Path
-
- Required: Yes
- Type: S3Path structure
The thesaurus file Amazon S3 source path.
- Tags
-
- Type: Array of Tag structures
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.
Result Syntax
[
'Id' => '<string>',
]
Result Details
Errors
DeleteDataSource
$result = $client->deleteDataSource([/* ... */]); $promise = $client->deleteDataSourceAsync([/* ... */]);
Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources.
Parameter Syntax
$result = $client->deleteDataSource([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeleteFaq
$result = $client->deleteFaq([/* ... */]); $promise = $client->deleteFaqAsync([/* ... */]);
Removes an FAQ from an index.
Parameter Syntax
$result = $client->deleteFaq([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeleteIndex
$result = $client->deleteIndex([/* ... */]); $promise = $client->deleteIndexAsync([/* ... */]);
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.
Parameter Syntax
$result = $client->deleteIndex([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
DeletePrincipalMapping
$result = $client->deletePrincipalMapping([/* ... */]); $promise = $client->deletePrincipalMappingAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deletePrincipalMapping([
'DataSourceId' => '<string>',
'GroupId' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
'OrderingId' => <integer>,
]);
Parameter Details
Members
- DataSourceId
-
- Type: string
The identifier of the data source you want to delete a group from.
This is useful if a group is tied to multiple data sources and you want to delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.
- GroupId
-
- Required: Yes
- Type: string
The identifier of the group you want to delete.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index you want to delete a group from.
- OrderingId
-
- Type: long (int|float)
The timestamp identifier you specify to ensure Amazon Kendra does not override the latest
DELETEaction 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 yourDELETEaction for that updated group with the latest members list doesn't get overwritten by earlierDELETEactions 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.
Result Syntax
[]
Result Details
Errors
DeleteQuerySuggestionsBlockList
$result = $client->deleteQuerySuggestionsBlockList([/* ... */]); $promise = $client->deleteQuerySuggestionsBlockListAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteQuerySuggestionsBlockList([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeleteThesaurus
$result = $client->deleteThesaurus([/* ... */]); $promise = $client->deleteThesaurusAsync([/* ... */]);
Deletes an existing Amazon Kendra thesaurus.
Parameter Syntax
$result = $client->deleteThesaurus([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DescribeDataSource
$result = $client->describeDataSource([/* ... */]); $promise = $client->describeDataSourceAsync([/* ... */]);
Gets information about a Amazon Kendra data source.
Parameter Syntax
$result = $client->describeDataSource([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Configuration' => [
'ConfluenceConfiguration' => [
'AttachmentConfiguration' => [
'AttachmentFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|CONTENT_TYPE|CREATED_DATE|DISPLAY_URL|FILE_SIZE|ITEM_TYPE|PARENT_ID|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'CrawlAttachments' => true || false,
],
'BlogConfiguration' => [
'BlogFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|DISPLAY_URL|ITEM_TYPE|LABELS|PUBLISH_DATE|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'ExclusionPatterns' => ['<string>', ...],
'InclusionPatterns' => ['<string>', ...],
'PageConfiguration' => [
'PageFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|CONTENT_STATUS|CREATED_DATE|DISPLAY_URL|ITEM_TYPE|LABELS|MODIFIED_DATE|PARENT_ID|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'SecretArn' => '<string>',
'ServerUrl' => '<string>',
'SpaceConfiguration' => [
'CrawlArchivedSpaces' => true || false,
'CrawlPersonalSpaces' => true || false,
'ExcludeSpaces' => ['<string>', ...],
'IncludeSpaces' => ['<string>', ...],
'SpaceFieldMappings' => [
[
'DataSourceFieldName' => 'DISPLAY_URL|ITEM_TYPE|SPACE_KEY|URL',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'Version' => 'CLOUD|SERVER',
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
'DatabaseConfiguration' => [
'AclConfiguration' => [
'AllowedGroupsColumnName' => '<string>',
],
'ColumnConfiguration' => [
'ChangeDetectingColumns' => ['<string>', ...],
'DocumentDataColumnName' => '<string>',
'DocumentIdColumnName' => '<string>',
'DocumentTitleColumnName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'ConnectionConfiguration' => [
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'SecretArn' => '<string>',
'TableName' => '<string>',
],
'DatabaseEngineType' => 'RDS_AURORA_MYSQL|RDS_AURORA_POSTGRESQL|RDS_MYSQL|RDS_POSTGRESQL',
'SqlConfiguration' => [
'QueryIdentifiersEnclosingOption' => 'DOUBLE_QUOTES|NONE',
],
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
'GoogleDriveConfiguration' => [
'ExcludeMimeTypes' => ['<string>', ...],
'ExcludeSharedDrives' => ['<string>', ...],
'ExcludeUserAccounts' => ['<string>', ...],
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'SecretArn' => '<string>',
],
'OneDriveConfiguration' => [
'DisableLocalGroups' => true || false,
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'OneDriveUsers' => [
'OneDriveUserList' => ['<string>', ...],
'OneDriveUserS3Path' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
],
'SecretArn' => '<string>',
'TenantDomain' => '<string>',
],
'S3Configuration' => [
'AccessControlListConfiguration' => [
'KeyPath' => '<string>',
],
'BucketName' => '<string>',
'DocumentsMetadataConfiguration' => [
'S3Prefix' => '<string>',
],
'ExclusionPatterns' => ['<string>', ...],
'InclusionPatterns' => ['<string>', ...],
'InclusionPrefixes' => ['<string>', ...],
],
'SalesforceConfiguration' => [
'ChatterFeedConfiguration' => [
'DocumentDataFieldName' => '<string>',
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'IncludeFilterTypes' => ['<string>', ...],
],
'CrawlAttachments' => true || false,
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'IncludeAttachmentFilePatterns' => ['<string>', ...],
'KnowledgeArticleConfiguration' => [
'CustomKnowledgeArticleTypeConfigurations' => [
[
'DocumentDataFieldName' => '<string>',
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'Name' => '<string>',
],
// ...
],
'IncludedStates' => ['<string>', ...],
'StandardKnowledgeArticleTypeConfiguration' => [
'DocumentDataFieldName' => '<string>',
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
],
'SecretArn' => '<string>',
'ServerUrl' => '<string>',
'StandardObjectAttachmentConfiguration' => [
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'StandardObjectConfigurations' => [
[
'DocumentDataFieldName' => '<string>',
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'Name' => 'ACCOUNT|CAMPAIGN|CASE|CONTACT|CONTRACT|DOCUMENT|GROUP|IDEA|LEAD|OPPORTUNITY|PARTNER|PRICEBOOK|PRODUCT|PROFILE|SOLUTION|TASK|USER',
],
// ...
],
],
'ServiceNowConfiguration' => [
'AuthenticationType' => 'HTTP_BASIC|OAUTH2',
'HostUrl' => '<string>',
'KnowledgeArticleConfiguration' => [
'CrawlAttachments' => true || false,
'DocumentDataFieldName' => '<string>',
'DocumentTitleFieldName' => '<string>',
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'FilterQuery' => '<string>',
'IncludeAttachmentFilePatterns' => ['<string>', ...],
],
'SecretArn' => '<string>',
'ServiceCatalogConfiguration' => [
'CrawlAttachments' => true || false,
'DocumentDataFieldName' => '<string>',
'DocumentTitleFieldName' => '<string>',
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'IncludeAttachmentFilePatterns' => ['<string>', ...],
],
'ServiceNowBuildVersion' => 'LONDON|OTHERS',
],
'SharePointConfiguration' => [
'CrawlAttachments' => true || false,
'DisableLocalGroups' => true || false,
'DocumentTitleFieldName' => '<string>',
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'SecretArn' => '<string>',
'SharePointVersion' => 'SHAREPOINT_2013|SHAREPOINT_2016|SHAREPOINT_ONLINE',
'SslCertificateS3Path' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
'Urls' => ['<string>', ...],
'UseChangeLog' => true || false,
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
'WebCrawlerConfiguration' => [
'AuthenticationConfiguration' => [
'BasicAuthentication' => [
[
'Credentials' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
// ...
],
],
'CrawlDepth' => <integer>,
'MaxContentSizePerPageInMegaBytes' => <float>,
'MaxLinksPerPage' => <integer>,
'MaxUrlsPerMinuteCrawlRate' => <integer>,
'ProxyConfiguration' => [
'Credentials' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'UrlExclusionPatterns' => ['<string>', ...],
'UrlInclusionPatterns' => ['<string>', ...],
'Urls' => [
'SeedUrlConfiguration' => [
'SeedUrls' => ['<string>', ...],
'WebCrawlerMode' => 'HOST_ONLY|SUBDOMAINS|EVERYTHING',
],
'SiteMapsConfiguration' => [
'SiteMaps' => ['<string>', ...],
],
],
],
'WorkDocsConfiguration' => [
'CrawlComments' => true || false,
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'OrganizationId' => '<string>',
'UseChangeLog' => true || false,
],
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'ErrorMessage' => '<string>',
'Id' => '<string>',
'IndexId' => '<string>',
'LanguageCode' => '<string>',
'Name' => '<string>',
'RoleArn' => '<string>',
'Schedule' => '<string>',
'Status' => 'CREATING|DELETING|FAILED|UPDATING|ACTIVE',
'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE|WEBCRAWLER|WORKDOCS',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Configuration
-
- Type: DataSourceConfiguration structure
Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp of when the data source was created.
- Description
-
- Type: string
The description of the data source.
- ErrorMessage
-
- Type: string
When the
Statusfield value isFAILED, theErrorMessagefield contains a description of the error that caused the data source to fail. - Id
-
- Type: string
The identifier of the data source.
- IndexId
-
- Type: string
The identifier of the index that contains the data source.
- LanguageCode
-
- Type: string
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.
- Name
-
- Type: string
The name that you gave the data source when it was created.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
- Schedule
-
- Type: string
The schedule that Amazon Kendra will update the data source.
- Status
-
- Type: string
The current status of the data source. When the status is
ACTIVEthe data source is ready to use. When the status isFAILED, theErrorMessagefield contains the reason that the data source failed. - Type
-
- Type: string
The type of the data source.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp of when the data source was last updated.
Errors
DescribeFaq
$result = $client->describeFaq([/* ... */]); $promise = $client->describeFaqAsync([/* ... */]);
Gets information about an FAQ list.
Parameter Syntax
$result = $client->describeFaq([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'ErrorMessage' => '<string>',
'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
'Id' => '<string>',
'IndexId' => '<string>',
'LanguageCode' => '<string>',
'Name' => '<string>',
'RoleArn' => '<string>',
'S3Path' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the FAQ was created.
- Description
-
- Type: string
The description of the FAQ that you provided when it was created.
- ErrorMessage
-
- Type: string
If the
Statusfield isFAILED, theErrorMessagefield contains the reason why the FAQ failed. - FileFormat
-
- Type: string
The file format used by the input files for the FAQ.
- Id
-
- Type: string
The identifier of the FAQ.
- IndexId
-
- Type: string
The identifier of the index that contains the FAQ.
- LanguageCode
-
- Type: string
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.
- Name
-
- Type: string
The name that you gave the FAQ when it was created.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
- S3Path
-
- Type: S3Path structure
Information required to find a specific file in an Amazon S3 bucket.
- Status
-
- Type: string
The status of the FAQ. It is ready to use when the status is
ACTIVE. - UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the FAQ was last updated.
Errors
DescribeIndex
$result = $client->describeIndex([/* ... */]); $promise = $client->describeIndexAsync([/* ... */]);
Describes an existing Amazon Kendra index
Parameter Syntax
$result = $client->describeIndex([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CapacityUnits' => [
'QueryCapacityUnits' => <integer>,
'StorageCapacityUnits' => <integer>,
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DocumentMetadataConfigurations' => [
[
'Name' => '<string>',
'Relevance' => [
'Duration' => '<string>',
'Freshness' => true || false,
'Importance' => <integer>,
'RankOrder' => 'ASCENDING|DESCENDING',
'ValueImportanceMap' => [<integer>, ...],
],
'Search' => [
'Displayable' => true || false,
'Facetable' => true || false,
'Searchable' => true || false,
'Sortable' => true || false,
],
'Type' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE',
],
// ...
],
'Edition' => 'DEVELOPER_EDITION|ENTERPRISE_EDITION',
'ErrorMessage' => '<string>',
'Id' => '<string>',
'IndexStatistics' => [
'FaqStatistics' => [
'IndexedQuestionAnswersCount' => <integer>,
],
'TextDocumentStatistics' => [
'IndexedTextBytes' => <integer>,
'IndexedTextDocumentsCount' => <integer>,
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'ServerSideEncryptionConfiguration' => [
'KmsKeyId' => '<string>',
],
'Status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|SYSTEM_UPDATING',
'UpdatedAt' => <DateTime>,
'UserContextPolicy' => 'ATTRIBUTE_FILTER|USER_TOKEN',
'UserGroupResolutionConfiguration' => [
'UserGroupResolutionMode' => 'AWS_SSO|NONE',
],
'UserTokenConfigurations' => [
[
'JsonTokenTypeConfiguration' => [
'GroupAttributeField' => '<string>',
'UserNameAttributeField' => '<string>',
],
'JwtTokenTypeConfiguration' => [
'ClaimRegex' => '<string>',
'GroupAttributeField' => '<string>',
'Issuer' => '<string>',
'KeyLocation' => 'URL|SECRET_MANAGER',
'SecretManagerArn' => '<string>',
'URL' => '<string>',
'UserNameAttributeField' => '<string>',
],
],
// ...
],
]
Result Details
Members
- CapacityUnits
-
- Type: CapacityUnitsConfiguration structure
For Enterprise edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix datetime that the index was created.
- Description
-
- Type: string
The description of the index.
- DocumentMetadataConfigurations
-
- Type: Array of DocumentMetadataConfiguration structures
Configuration settings for any metadata applied to the documents in the index.
- Edition
-
- Type: string
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
- ErrorMessage
-
- Type: string
When th e
Statusfield value isFAILED, theErrorMessagefield contains a message that explains why. - Id
-
- Type: string
The name of the index.
- IndexStatistics
-
- Type: IndexStatistics structure
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
- Name
-
- Type: string
The name of the index.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
- ServerSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The identifier of the KMScustomer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
- Status
-
- Type: string
The current status of the index. When the value is
ACTIVE, the index is ready for use. If theStatusfield value isFAILED, theErrorMessagefield contains a message that explains why. - UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix datetime that the index was last updated.
- UserContextPolicy
-
- Type: string
The user context policy for the Amazon Kendra index.
- UserGroupResolutionConfiguration
-
- Type: UserGroupResolutionConfiguration structure
Shows whether you have enabled the configuration for fetching access levels of groups and users from an AWS Single Sign-On identity source.
- UserTokenConfigurations
-
- Type: Array of UserTokenConfiguration structures
The user token configuration for the Amazon Kendra index.
Errors
DescribePrincipalMapping
$result = $client->describePrincipalMapping([/* ... */]); $promise = $client->describePrincipalMappingAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describePrincipalMapping([
'DataSourceId' => '<string>',
'GroupId' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DataSourceId
-
- Type: string
The identifier of the data source to check the processing of
PUTandDELETEactions for mapping users to their groups. - GroupId
-
- Required: Yes
- Type: string
The identifier of the group required to check the processing of
PUTandDELETEactions for mapping users to their groups. - IndexId
-
- Required: Yes
- Type: string
The identifier of the index required to check the processing of
PUTandDELETEactions for mapping users to their groups.
Result Syntax
[
'DataSourceId' => '<string>',
'GroupId' => '<string>',
'GroupOrderingIdSummaries' => [
[
'FailureReason' => '<string>',
'LastUpdatedAt' => <DateTime>,
'OrderingId' => <integer>,
'ReceivedAt' => <DateTime>,
'Status' => 'FAILED|SUCCEEDED|PROCESSING|DELETING|DELETED',
],
// ...
],
'IndexId' => '<string>',
]
Result Details
Members
- DataSourceId
-
- Type: string
Shows the identifier of the data source to see information on the processing of
PUTandDELETEactions for mapping users to their groups. - GroupId
-
- Type: string
Shows the identifier of the group to see information on the processing of
PUTandDELETEactions for mapping users to their groups. - GroupOrderingIdSummaries
-
- Type: Array of GroupOrderingIdSummary structures
Shows the following information on the processing of
PUTandDELETEactions for mapping users to their groups:-
Status – the status can be either
PROCESSING,SUCCEEDED,DELETING,DELETED, orFAILED. -
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.
- IndexId
-
- Type: string
Shows the identifier of the index to see information on the processing of
PUTandDELETEactions for mapping users to their groups.
Errors
DescribeQuerySuggestionsBlockList
$result = $client->describeQuerySuggestionsBlockList([/* ... */]); $promise = $client->describeQuerySuggestionsBlockListAsync([/* ... */]);
Describes a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
Parameter Syntax
$result = $client->describeQuerySuggestionsBlockList([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'ErrorMessage' => '<string>',
'FileSizeBytes' => <integer>,
'Id' => '<string>',
'IndexId' => '<string>',
'ItemCount' => <integer>,
'Name' => '<string>',
'RoleArn' => '<string>',
'SourceS3Path' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
'Status' => 'ACTIVE|CREATING|DELETING|UPDATING|ACTIVE_BUT_UPDATE_FAILED|FAILED',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Shows the date-time a block list for query suggestions was created.
- Description
-
- Type: string
Shows the description for the block list.
- ErrorMessage
-
- Type: string
Shows the error message with details when there are issues in processing the block list.
- FileSizeBytes
-
- Type: long (int|float)
Shows the current size of the block list text file in S3.
- Id
-
- Type: string
Shows the unique identifier of the block list.
- IndexId
-
- Type: string
Shows the identifier of the index for the block list.
- ItemCount
-
- Type: int
Shows the current number of valid, non-empty words or phrases in the block list text file.
- Name
-
- Type: string
Shows the name of the block list.
- RoleArn
-
- Type: string
Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
- SourceS3Path
-
- Type: S3Path structure
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.
- Status
-
- Type: string
Shows whether the current status of the block list is
ACTIVEorINACTIVE. - UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Shows the date-time a block list for query suggestions was last updated.
Errors
DescribeQuerySuggestionsConfig
$result = $client->describeQuerySuggestionsConfig([/* ... */]); $promise = $client->describeQuerySuggestionsConfigAsync([/* ... */]);
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
Parameter Syntax
$result = $client->describeQuerySuggestionsConfig([
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'IncludeQueriesWithoutUserInformation' => true || false,
'LastClearTime' => <DateTime>,
'LastSuggestionsBuildTime' => <DateTime>,
'MinimumNumberOfQueryingUsers' => <integer>,
'MinimumQueryCount' => <integer>,
'Mode' => 'ENABLED|LEARN_ONLY',
'QueryLogLookBackWindowInDays' => <integer>,
'Status' => 'ACTIVE|UPDATING',
'TotalSuggestionsCount' => <integer>,
]
Result Details
Members
- IncludeQueriesWithoutUserInformation
-
- Type: boolean
Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.
- LastClearTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Shows the date-time query suggestions for an index was last cleared.
After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.
- LastSuggestionsBuildTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Shows the date-time query suggestions for an index was last updated.
- MinimumNumberOfQueryingUsers
-
- Type: int
Shows the minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
- MinimumQueryCount
-
- Type: int
Shows the minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
- Mode
-
- Type: string
Shows whether query suggestions are currently in
ENABLEDmode orLEARN_ONLYmode.By default, Amazon Kendra enables query suggestions.
LEARN_ONLYturns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig operation. - QueryLogLookBackWindowInDays
-
- Type: int
Shows how recent your queries are in your query log time window (in days).
- Status
-
- Type: string
Shows whether the status of query suggestions settings is currently Active or Updating.
Active means the current settings apply and Updating means your changed settings are in the process of applying.
- TotalSuggestionsCount
-
- Type: int
Shows the current total count of query suggestions for an index.
This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.
Errors
DescribeThesaurus
$result = $client->describeThesaurus([/* ... */]); $promise = $client->describeThesaurusAsync([/* ... */]);
Describes an existing Amazon Kendra thesaurus.
Parameter Syntax
$result = $client->describeThesaurus([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'ErrorMessage' => '<string>',
'FileSizeBytes' => <integer>,
'Id' => '<string>',
'IndexId' => '<string>',
'Name' => '<string>',
'RoleArn' => '<string>',
'SourceS3Path' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
'Status' => 'CREATING|ACTIVE|DELETING|UPDATING|ACTIVE_BUT_UPDATE_FAILED|FAILED',
'SynonymRuleCount' => <integer>,
'TermCount' => <integer>,
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix datetime that the thesaurus was created.
- Description
-
- Type: string
The thesaurus description.
- ErrorMessage
-
- Type: string
When the
Statusfield value isFAILED, theErrorMessagefield provides more information. - FileSizeBytes
-
- Type: long (int|float)
The size of the thesaurus file in bytes.
- Id
-
- Type: string
The identifier of the thesaurus.
- IndexId
-
- Type: string
The identifier of the index associated with the thesaurus to describe.
- Name
-
- Type: string
The thesaurus name.
- RoleArn
-
- Type: string
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in
SourceS3Path. - SourceS3Path
-
- Type: S3Path structure
Information required to find a specific file in an Amazon S3 bucket.
- Status
-
- Type: string
The current status of the thesaurus. When the value is
ACTIVE, queries are able to use the thesaurus. If theStatusfield value isFAILED, theErrorMessagefield 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. - SynonymRuleCount
-
- Type: long (int|float)
The number of synonym rules in the thesaurus file.
- TermCount
-
- Type: long (int|float)
The number of unique terms in the thesaurus file. For example, the synonyms
a,b,canda=>d, the term count would be 4. - UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix datetime that the thesaurus was last updated.
Errors
GetQuerySuggestions
$result = $client->getQuerySuggestions([/* ... */]); $promise = $client->getQuerySuggestionsAsync([/* ... */]);
Fetches the queries that are suggested to your users.
Parameter Syntax
$result = $client->getQuerySuggestions([
'IndexId' => '<string>', // REQUIRED
'MaxSuggestionsCount' => <integer>,
'QueryText' => '<string>', // REQUIRED
]);
Parameter Details
Members
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index you want to get query suggestions from.
- MaxSuggestionsCount
-
- Type: int
The maximum number of query suggestions you want to show to your users.
- QueryText
-
- Required: Yes
- Type: string
The text of a user's query to generate query suggestions.
A query is suggested if the query prefix matches what a user starts to type as their query.
Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
Result Syntax
[
'QuerySuggestionsId' => '<string>',
'Suggestions' => [
[
'Id' => '<string>',
'Value' => [
'Text' => [
'Highlights' => [
[
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
],
// ...
],
'Text' => '<string>',
],
],
],
// ...
],
]
Result Details
Members
- QuerySuggestionsId
-
- Type: string
The unique identifier for a list of query suggestions for an index.
- Suggestions
-
- Type: Array of Suggestion structures
A list of query suggestions for an index.
Errors
ListDataSourceSyncJobs
$result = $client->listDataSourceSyncJobs([/* ... */]); $promise = $client->listDataSourceSyncJobsAsync([/* ... */]);
Gets statistics about synchronizing Amazon Kendra with a data source.
Parameter Syntax
$result = $client->listDataSourceSyncJobs([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'StartTimeFilter' => [
'EndTime' => <integer || string || DateTime>,
'StartTime' => <integer || string || DateTime>,
],
'StatusFilter' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED|SYNCING_INDEXING',
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the data source.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that contains the data source.
- MaxResults
-
- Type: int
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.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.
- StartTimeFilter
-
- Type: TimeRange structure
When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
- StatusFilter
-
- Type: string
When specified, only returns synchronization jobs with the
Statusfield equal to the specified status.
Result Syntax
[
'History' => [
[
'DataSourceErrorCode' => '<string>',
'EndTime' => <DateTime>,
'ErrorCode' => 'InternalError|InvalidRequest',
'ErrorMessage' => '<string>',
'ExecutionId' => '<string>',
'Metrics' => [
'DocumentsAdded' => '<string>',
'DocumentsDeleted' => '<string>',
'DocumentsFailed' => '<string>',
'DocumentsModified' => '<string>',
'DocumentsScanned' => '<string>',
],
'StartTime' => <DateTime>,
'Status' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED|SYNCING_INDEXING',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- History
-
- Type: Array of DataSourceSyncJob structures
A history of synchronization jobs for the data source.
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of jobs.
Errors
ListDataSources
$result = $client->listDataSources([/* ... */]); $promise = $client->listDataSourcesAsync([/* ... */]);
Lists the data sources that you have created.
Parameter Syntax
$result = $client->listDataSources([
'IndexId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that contains the data source.
- MaxResults
-
- Type: int
The maximum number of data sources to return.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data sources (
DataSourceSummaryItems).
Result Syntax
[
'NextToken' => '<string>',
'SummaryItems' => [
[
'CreatedAt' => <DateTime>,
'Id' => '<string>',
'LanguageCode' => '<string>',
'Name' => '<string>',
'Status' => 'CREATING|DELETING|FAILED|UPDATING|ACTIVE',
'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE|WEBCRAWLER|WORKDOCS',
'UpdatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data sources.
- SummaryItems
-
- Type: Array of DataSourceSummary structures
An array of summary information for one or more data sources.
Errors
ListFaqs
$result = $client->listFaqs([/* ... */]); $promise = $client->listFaqsAsync([/* ... */]);
Gets a list of FAQ lists associated with an index.
Parameter Syntax
$result = $client->listFaqs([
'IndexId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- IndexId
-
- Required: Yes
- Type: string
The index that contains the FAQ lists.
- MaxResults
-
- Type: int
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.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.
Result Syntax
[
'FaqSummaryItems' => [
[
'CreatedAt' => <DateTime>,
'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
'Id' => '<string>',
'LanguageCode' => '<string>',
'Name' => '<string>',
'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- FaqSummaryItems
-
- Type: Array of FaqSummary structures
information about the FAQs associated with the specified index.
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.
Errors
ListGroupsOlderThanOrderingId
$result = $client->listGroupsOlderThanOrderingId([/* ... */]); $promise = $client->listGroupsOlderThanOrderingIdAsync([/* ... */]);
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
Parameter Syntax
$result = $client->listGroupsOlderThanOrderingId([
'DataSourceId' => '<string>',
'IndexId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'OrderingId' => <integer>, // REQUIRED
]);
Parameter Details
Members
- DataSourceId
-
- Type: string
The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
- MaxResults
-
- Type: int
The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.
- OrderingId
-
- Required: Yes
- Type: long (int|float)
The timestamp identifier used for the latest
PUTorDELETEaction for mapping users to their groups.
Result Syntax
[
'GroupsSummaries' => [
[
'GroupId' => '<string>',
'OrderingId' => <integer>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- GroupsSummaries
-
- Type: Array of GroupSummary structures
Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.
Errors
ListIndices
$result = $client->listIndices([/* ... */]); $promise = $client->listIndicesAsync([/* ... */]);
Lists the Amazon Kendra indexes that you have created.
Parameter Syntax
$result = $client->listIndices([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of data sources to return.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of indexes (
DataSourceSummaryItems).
Result Syntax
[
'IndexConfigurationSummaryItems' => [
[
'CreatedAt' => <DateTime>,
'Edition' => 'DEVELOPER_EDITION|ENTERPRISE_EDITION',
'Id' => '<string>',
'Name' => '<string>',
'Status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|SYSTEM_UPDATING',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- IndexConfigurationSummaryItems
-
- Type: Array of IndexConfigurationSummary structures
An array of summary information for one or more indexes.
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of indexes.
Errors
ListQuerySuggestionsBlockLists
$result = $client->listQuerySuggestionsBlockLists([/* ... */]); $promise = $client->listQuerySuggestionsBlockListsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listQuerySuggestionsBlockLists([
'IndexId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index for a list of all block lists that exist for that index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
- MaxResults
-
- Type: int
The maximum number of block lists to return.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of block lists (
BlockListSummaryItems).
Result Syntax
[
'BlockListSummaryItems' => [
[
'CreatedAt' => <DateTime>,
'Id' => '<string>',
'ItemCount' => <integer>,
'Name' => '<string>',
'Status' => 'ACTIVE|CREATING|DELETING|UPDATING|ACTIVE_BUT_UPDATE_FAILED|FAILED',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- BlockListSummaryItems
-
- Type: Array of QuerySuggestionsBlockListSummary structures
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.
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.
Errors
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceARN' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
A list of tags associated with the index, FAQ, or data source.
Errors
ListThesauri
$result = $client->listThesauri([/* ... */]); $promise = $client->listThesauriAsync([/* ... */]);
Lists the Amazon Kendra thesauri associated with an index.
Parameter Syntax
$result = $client->listThesauri([
'IndexId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index associated with the thesaurus to list.
- MaxResults
-
- Type: int
The maximum number of thesauri to return.
- NextToken
-
- Type: string
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (
ThesaurusSummaryItems).
Result Syntax
[
'NextToken' => '<string>',
'ThesaurusSummaryItems' => [
[
'CreatedAt' => <DateTime>,
'Id' => '<string>',
'Name' => '<string>',
'Status' => 'CREATING|ACTIVE|DELETING|UPDATING|ACTIVE_BUT_UPDATE_FAILED|FAILED',
'UpdatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.
- ThesaurusSummaryItems
-
- Type: Array of ThesaurusSummary structures
An array of summary information for a thesaurus or multiple thesauri.
Errors
PutPrincipalMapping
$result = $client->putPrincipalMapping([/* ... */]); $promise = $client->putPrincipalMappingAsync([/* ... */]);
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.
You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.
If more than five PUT actions for a group are currently processing, a validation exception is thrown.
Parameter Syntax
$result = $client->putPrincipalMapping([
'DataSourceId' => '<string>',
'GroupId' => '<string>', // REQUIRED
'GroupMembers' => [ // REQUIRED
'MemberGroups' => [
[
'DataSourceId' => '<string>',
'GroupId' => '<string>', // REQUIRED
],
// ...
],
'MemberUsers' => [
[
'UserId' => '<string>', // REQUIRED
],
// ...
],
'S3PathforGroupMembers' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
],
'IndexId' => '<string>', // REQUIRED
'OrderingId' => <integer>,
'RoleArn' => '<string>',
]);
Parameter Details
Members
- DataSourceId
-
- Type: string
The identifier of the data source you want to map users to their groups.
This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.
- GroupId
-
- Required: Yes
- Type: string
The identifier of the group you want to map its users to.
- GroupMembers
-
- Required: Yes
- Type: GroupMembers structure
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.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index you want to map users to their groups.
- OrderingId
-
- Type: long (int|float)
The timestamp identifier you specify to ensure Amazon Kendra does not override the latest
PUTaction 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 yourPUTaction for that updated group with the latest members list doesn't get overwritten by earlierPUTactions for the same group which are yet to be processed.The default ordering ID is the current UNIX time in milliseconds that the action was received by Amazon Kendra.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.
For more information, see IAM roles for Amazon Kendra.
Result Syntax
[]
Result Details
Errors
Query
$result = $client->query([/* ... */]); $promise = $client->queryAsync([/* ... */]);
Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
-
Relevant passages
-
Matching FAQs
-
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.
Each query returns the 100 most relevant results.
Parameter Syntax
$result = $client->query([
'AttributeFilter' => [
'AndAllFilters' => [
[...], // RECURSIVE
// ...
],
'ContainsAll' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'ContainsAny' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'EqualsTo' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'GreaterThan' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'GreaterThanOrEquals' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'LessThan' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'LessThanOrEquals' => [
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'DateValue' => <integer || string || DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
'NotFilter' => [...], // RECURSIVE
'OrAllFilters' => [
[...], // RECURSIVE
// ...
],
],
'DocumentRelevanceOverrideConfigurations' => [
[
'Name' => '<string>', // REQUIRED
'Relevance' => [ // REQUIRED
'Duration' => '<string>',
'Freshness' => true || false,
'Importance' => <integer>,
'RankOrder' => 'ASCENDING|DESCENDING',
'ValueImportanceMap' => [<integer>, ...],
],
],
// ...
],
'Facets' => [
[
'DocumentAttributeKey' => '<string>',
],
// ...
],
'IndexId' => '<string>', // REQUIRED
'PageNumber' => <integer>,
'PageSize' => <integer>,
'QueryResultTypeFilter' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
'QueryText' => '<string>', // REQUIRED
'RequestedDocumentAttributes' => ['<string>', ...],
'SortingConfiguration' => [
'DocumentAttributeKey' => '<string>', // REQUIRED
'SortOrder' => 'DESC|ASC', // REQUIRED
],
'UserContext' => [
'DataSourceGroups' => [
[
'DataSourceId' => '<string>', // REQUIRED
'GroupId' => '<string>', // REQUIRED
],
// ...
],
'Groups' => ['<string>', ...],
'Token' => '<string>',
'UserId' => '<string>',
],
'VisitorId' => '<string>',
]);
Parameter Details
Members
- AttributeFilter
-
- Type: AttributeFilter structure
Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the
AndAllFilters,NotFilter, andOrAllFiltersparameters contain a list of other filters.The
AttributeFilterparameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results. - DocumentRelevanceOverrideConfigurations
-
- Type: Array of DocumentRelevanceConfiguration structures
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.
- Facets
-
- Type: Array of Facet structures
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.
- IndexId
-
- Required: Yes
- Type: string
The unique identifier of the index to search. The identifier is returned in the response from the
CreateIndexoperation. - PageNumber
-
- Type: int
Query results are returned in pages the size of the
PageSizeparameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one. - PageSize
-
- Type: int
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.
- QueryResultTypeFilter
-
- Type: string
Sets the type of query. Only results for the specified query type are returned.
- QueryText
-
- Required: Yes
- Type: string
The text to search for.
- RequestedDocumentAttributes
-
- Type: Array of strings
An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.
- SortingConfiguration
-
- Type: SortingConfiguration structure
Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.
If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.
- UserContext
-
- Type: UserContext structure
The user context token or user and group information.
- VisitorId
-
- Type: string
Provides an identifier for a specific user. The
VisitorIdshould be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as theVisitorId.
Result Syntax
[
'FacetResults' => [
[
'DocumentAttributeKey' => '<string>',
'DocumentAttributeValueCountPairs' => [
[
'Count' => <integer>,
'DocumentAttributeValue' => [
'DateValue' => <DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
// ...
],
'DocumentAttributeValueType' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE',
],
// ...
],
'QueryId' => '<string>',
'ResultItems' => [
[
'AdditionalAttributes' => [
[
'Key' => '<string>',
'Value' => [
'TextWithHighlightsValue' => [
'Highlights' => [
[
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
'TopAnswer' => true || false,
'Type' => 'STANDARD|THESAURUS_SYNONYM',
],
// ...
],
'Text' => '<string>',
],
],
'ValueType' => 'TEXT_WITH_HIGHLIGHTS_VALUE',
],
// ...
],
'DocumentAttributes' => [
[
'Key' => '<string>',
'Value' => [
'DateValue' => <DateTime>,
'LongValue' => <integer>,
'StringListValue' => ['<string>', ...],
'StringValue' => '<string>',
],
],
// ...
],
'DocumentExcerpt' => [
'Highlights' => [
[
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
'TopAnswer' => true || false,
'Type' => 'STANDARD|THESAURUS_SYNONYM',
],
// ...
],
'Text' => '<string>',
],
'DocumentId' => '<string>',
'DocumentTitle' => [
'Highlights' => [
[
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
'TopAnswer' => true || false,
'Type' => 'STANDARD|THESAURUS_SYNONYM',
],
// ...
],
'Text' => '<string>',
],
'DocumentURI' => '<string>',
'FeedbackToken' => '<string>',
'Id' => '<string>',
'ScoreAttributes' => [
'ScoreConfidence' => 'VERY_HIGH|HIGH|MEDIUM|LOW|NOT_AVAILABLE',
],
'Type' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
],
// ...
],
'TotalNumberOfResults' => <integer>,
]
Result Details
Members
- FacetResults
-
- Type: Array of FacetResult structures
Contains the facet results. A
FacetResultcontains the counts for each attribute key that was specified in theFacetsinput parameter. - QueryId
-
- Type: string
The unique identifier for the search. You use
QueryIdto identify the search when using the feedback API. - ResultItems
-
- Type: Array of QueryResultItem structures
The results of the search.
- TotalNumberOfResults
-
- Type: int
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.
Errors
StartDataSourceSyncJob
$result = $client->startDataSourceSyncJob([/* ... */]); $promise = $client->startDataSourceSyncJobAsync([/* ... */]);
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
Parameter Syntax
$result = $client->startDataSourceSyncJob([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ExecutionId' => '<string>',
]
Result Details
Errors
StopDataSourceSyncJob
$result = $client->stopDataSourceSyncJob([/* ... */]); $promise = $client->stopDataSourceSyncJobAsync([/* ... */]);
Stops a running synchronization job. You can't stop a scheduled synchronization job.
Parameter Syntax
$result = $client->stopDataSourceSyncJob([
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
SubmitFeedback
$result = $client->submitFeedback([/* ... */]); $promise = $client->submitFeedbackAsync([/* ... */]);
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
Parameter Syntax
$result = $client->submitFeedback([
'ClickFeedbackItems' => [
[
'ClickTime' => <integer || string || DateTime>, // REQUIRED
'ResultId' => '<string>', // REQUIRED
],
// ...
],
'IndexId' => '<string>', // REQUIRED
'QueryId' => '<string>', // REQUIRED
'RelevanceFeedbackItems' => [
[
'RelevanceValue' => 'RELEVANT|NOT_RELEVANT', // REQUIRED
'ResultId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClickFeedbackItems
-
- Type: Array of ClickFeedback structures
Tells Amazon Kendra that a particular search result link was chosen by the user.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that was queried.
- QueryId
-
- Required: Yes
- Type: string
The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the
Queryoperation. - RelevanceFeedbackItems
-
- Type: Array of RelevanceFeedback structures
Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
Result Syntax
[]
Result Details
Errors
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([
'ResourceARN' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
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.
Result Syntax
[]
Result Details
Errors
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag from an index, FAQ, or a data source.
Parameter Syntax
$result = $client->untagResource([
'ResourceARN' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
UpdateDataSource
$result = $client->updateDataSource([/* ... */]); $promise = $client->updateDataSourceAsync([/* ... */]);
Updates an existing Amazon Kendra data source.
Parameter Syntax
$result = $client->updateDataSource([
'Configuration' => [
'ConfluenceConfiguration' => [
'AttachmentConfiguration' => [
'AttachmentFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|CONTENT_TYPE|CREATED_DATE|DISPLAY_URL|FILE_SIZE|ITEM_TYPE|PARENT_ID|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
'CrawlAttachments' => true || false,
],
'BlogConfiguration' => [
'BlogFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|DISPLAY_URL|ITEM_TYPE|LABELS|PUBLISH_DATE|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'ExclusionPatterns' => ['<string>', ...],
'InclusionPatterns' => ['<string>', ...],
'PageConfiguration' => [
'PageFieldMappings' => [
[
'DataSourceFieldName' => 'AUTHOR|CONTENT_STATUS|CREATED_DATE|DISPLAY_URL|ITEM_TYPE|LABELS|MODIFIED_DATE|PARENT_ID|SPACE_KEY|SPACE_NAME|URL|VERSION',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'SecretArn' => '<string>', // REQUIRED
'ServerUrl' => '<string>', // REQUIRED
'SpaceConfiguration' => [
'CrawlArchivedSpaces' => true || false,
'CrawlPersonalSpaces' => true || false,
'ExcludeSpaces' => ['<string>', ...],
'IncludeSpaces' => ['<string>', ...],
'SpaceFieldMappings' => [
[
'DataSourceFieldName' => 'DISPLAY_URL|ITEM_TYPE|SPACE_KEY|URL',
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>',
],
// ...
],
],
'Version' => 'CLOUD|SERVER', // REQUIRED
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'DatabaseConfiguration' => [
'AclConfiguration' => [
'AllowedGroupsColumnName' => '<string>', // REQUIRED
],
'ColumnConfiguration' => [ // REQUIRED
'ChangeDetectingColumns' => ['<string>', ...], // REQUIRED
'DocumentDataColumnName' => '<string>', // REQUIRED
'DocumentIdColumnName' => '<string>', // REQUIRED
'DocumentTitleColumnName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
],
'ConnectionConfiguration' => [ // REQUIRED
'DatabaseHost' => '<string>', // REQUIRED
'DatabaseName' => '<string>', // REQUIRED
'DatabasePort' => <integer>, // REQUIRED
'SecretArn' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
],
'DatabaseEngineType' => 'RDS_AURORA_MYSQL|RDS_AURORA_POSTGRESQL|RDS_MYSQL|RDS_POSTGRESQL', // REQUIRED
'SqlConfiguration' => [
'QueryIdentifiersEnclosingOption' => 'DOUBLE_QUOTES|NONE',
],
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'GoogleDriveConfiguration' => [
'ExcludeMimeTypes' => ['<string>', ...],
'ExcludeSharedDrives' => ['<string>', ...],
'ExcludeUserAccounts' => ['<string>', ...],
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'SecretArn' => '<string>', // REQUIRED
],
'OneDriveConfiguration' => [
'DisableLocalGroups' => true || false,
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'OneDriveUsers' => [ // REQUIRED
'OneDriveUserList' => ['<string>', ...],
'OneDriveUserS3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
],
'SecretArn' => '<string>', // REQUIRED
'TenantDomain' => '<string>', // REQUIRED
],
'S3Configuration' => [
'AccessControlListConfiguration' => [
'KeyPath' => '<string>',
],
'BucketName' => '<string>', // REQUIRED
'DocumentsMetadataConfiguration' => [
'S3Prefix' => '<string>',
],
'ExclusionPatterns' => ['<string>', ...],
'InclusionPatterns' => ['<string>', ...],
'InclusionPrefixes' => ['<string>', ...],
],
'SalesforceConfiguration' => [
'ChatterFeedConfiguration' => [
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'IncludeFilterTypes' => ['<string>', ...],
],
'CrawlAttachments' => true || false,
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'IncludeAttachmentFilePatterns' => ['<string>', ...],
'KnowledgeArticleConfiguration' => [
'CustomKnowledgeArticleTypeConfigurations' => [
[
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
],
// ...
],
'IncludedStates' => ['<string>', ...], // REQUIRED
'StandardKnowledgeArticleTypeConfiguration' => [
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
],
],
'SecretArn' => '<string>', // REQUIRED
'ServerUrl' => '<string>', // REQUIRED
'StandardObjectAttachmentConfiguration' => [
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
],
'StandardObjectConfigurations' => [
[
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'Name' => 'ACCOUNT|CAMPAIGN|CASE|CONTACT|CONTRACT|DOCUMENT|GROUP|IDEA|LEAD|OPPORTUNITY|PARTNER|PRICEBOOK|PRODUCT|PROFILE|SOLUTION|TASK|USER', // REQUIRED
],
// ...
],
],
'ServiceNowConfiguration' => [
'AuthenticationType' => 'HTTP_BASIC|OAUTH2',
'HostUrl' => '<string>', // REQUIRED
'KnowledgeArticleConfiguration' => [
'CrawlAttachments' => true || false,
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'FilterQuery' => '<string>',
'IncludeAttachmentFilePatterns' => ['<string>', ...],
],
'SecretArn' => '<string>', // REQUIRED
'ServiceCatalogConfiguration' => [
'CrawlAttachments' => true || false,
'DocumentDataFieldName' => '<string>', // REQUIRED
'DocumentTitleFieldName' => '<string>',
'ExcludeAttachmentFilePatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'IncludeAttachmentFilePatterns' => ['<string>', ...],
],
'ServiceNowBuildVersion' => 'LONDON|OTHERS', // REQUIRED
],
'SharePointConfiguration' => [
'CrawlAttachments' => true || false,
'DisableLocalGroups' => true || false,
'DocumentTitleFieldName' => '<string>',
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'SecretArn' => '<string>', // REQUIRED
'SharePointVersion' => 'SHAREPOINT_2013|SHAREPOINT_2016|SHAREPOINT_ONLINE', // REQUIRED
'SslCertificateS3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
'Urls' => ['<string>', ...], // REQUIRED
'UseChangeLog' => true || false,
'VpcConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'WebCrawlerConfiguration' => [
'AuthenticationConfiguration' => [
'BasicAuthentication' => [
[
'Credentials' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
// ...
],
],
'CrawlDepth' => <integer>,
'MaxContentSizePerPageInMegaBytes' => <float>,
'MaxLinksPerPage' => <integer>,
'MaxUrlsPerMinuteCrawlRate' => <integer>,
'ProxyConfiguration' => [
'Credentials' => '<string>',
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'UrlExclusionPatterns' => ['<string>', ...],
'UrlInclusionPatterns' => ['<string>', ...],
'Urls' => [ // REQUIRED
'SeedUrlConfiguration' => [
'SeedUrls' => ['<string>', ...], // REQUIRED
'WebCrawlerMode' => 'HOST_ONLY|SUBDOMAINS|EVERYTHING',
],
'SiteMapsConfiguration' => [
'SiteMaps' => ['<string>', ...], // REQUIRED
],
],
],
'WorkDocsConfiguration' => [
'CrawlComments' => true || false,
'ExclusionPatterns' => ['<string>', ...],
'FieldMappings' => [
[
'DataSourceFieldName' => '<string>', // REQUIRED
'DateFieldFormat' => '<string>',
'IndexFieldName' => '<string>', // REQUIRED
],
// ...
],
'InclusionPatterns' => ['<string>', ...],
'OrganizationId' => '<string>', // REQUIRED
'UseChangeLog' => true || false,
],
],
'Description' => '<string>',
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
'LanguageCode' => '<string>',
'Name' => '<string>',
'RoleArn' => '<string>',
'Schedule' => '<string>',
]);
Parameter Details
Members
- Configuration
-
- Type: DataSourceConfiguration structure
Configuration information for a Amazon Kendra data source.
- Description
-
- Type: string
The new description for the data source.
- Id
-
- Required: Yes
- Type: string
The unique identifier of the data source to update.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index that contains the data source to update.
- LanguageCode
-
- Type: string
The code for a language. 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.
- Name
-
- Type: string
The name of the data source to update. The name of the data source can't be updated. To rename a data source you must delete the data source and re-create it.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
- Schedule
-
- Type: string
The new update schedule for the data source.
Result Syntax
[]
Result Details
Errors
UpdateIndex
$result = $client->updateIndex([/* ... */]); $promise = $client->updateIndexAsync([/* ... */]);
Updates an existing Amazon Kendra index.
Parameter Syntax
$result = $client->updateIndex([
'CapacityUnits' => [
'QueryCapacityUnits' => <integer>, // REQUIRED
'StorageCapacityUnits' => <integer>, // REQUIRED
],
'Description' => '<string>',
'DocumentMetadataConfigurationUpdates' => [
[
'Name' => '<string>', // REQUIRED
'Relevance' => [
'Duration' => '<string>',
'Freshness' => true || false,
'Importance' => <integer>,
'RankOrder' => 'ASCENDING|DESCENDING',
'ValueImportanceMap' => [<integer>, ...],
],
'Search' => [
'Displayable' => true || false,
'Facetable' => true || false,
'Searchable' => true || false,
'Sortable' => true || false,
],
'Type' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE', // REQUIRED
],
// ...
],
'Id' => '<string>', // REQUIRED
'Name' => '<string>',
'RoleArn' => '<string>',
'UserContextPolicy' => 'ATTRIBUTE_FILTER|USER_TOKEN',
'UserGroupResolutionConfiguration' => [
'UserGroupResolutionMode' => 'AWS_SSO|NONE', // REQUIRED
],
'UserTokenConfigurations' => [
[
'JsonTokenTypeConfiguration' => [
'GroupAttributeField' => '<string>', // REQUIRED
'UserNameAttributeField' => '<string>', // REQUIRED
],
'JwtTokenTypeConfiguration' => [
'ClaimRegex' => '<string>',
'GroupAttributeField' => '<string>',
'Issuer' => '<string>',
'KeyLocation' => 'URL|SECRET_MANAGER', // REQUIRED
'SecretManagerArn' => '<string>',
'URL' => '<string>',
'UserNameAttributeField' => '<string>',
],
],
// ...
],
]);
Parameter Details
Members
- CapacityUnits
-
- Type: CapacityUnitsConfiguration structure
Sets the number of additional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day.
If you are using extra storage units, you can't reduce the storage capacity below that required to meet the storage needs for your index.
- Description
-
- Type: string
A new description for the index.
- DocumentMetadataConfigurationUpdates
-
- Type: Array of DocumentMetadataConfiguration structures
The document metadata to update.
- Id
-
- Required: Yes
- Type: string
The identifier of the index to update.
- Name
-
- Type: string
The name of the index to update.
- RoleArn
-
- Type: string
A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.
- UserContextPolicy
-
- Type: string
The user context policy.
- UserGroupResolutionConfiguration
-
- Type: UserGroupResolutionConfiguration structure
Enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration.
- UserTokenConfigurations
-
- Type: Array of UserTokenConfiguration structures
The user token configuration.
Result Syntax
[]
Result Details
Errors
UpdateQuerySuggestionsBlockList
$result = $client->updateQuerySuggestionsBlockList([/* ... */]); $promise = $client->updateQuerySuggestionsBlockListAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateQuerySuggestionsBlockList([
'Description' => '<string>',
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
'Name' => '<string>',
'RoleArn' => '<string>',
'SourceS3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- Description
-
- Type: string
The description for a block list.
- Id
-
- Required: Yes
- Type: string
The unique identifier of a block list.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index for a block list.
- Name
-
- Type: string
The name of a block list.
- RoleArn
-
- Type: string
The IAM (Identity and Access Management) role used to access the block list text file in S3.
- SourceS3Path
-
- Type: S3Path structure
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
UpdateQuerySuggestionsBlockListAPI 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.
Result Syntax
[]
Result Details
Errors
UpdateQuerySuggestionsConfig
$result = $client->updateQuerySuggestionsConfig([/* ... */]); $promise = $client->updateQuerySuggestionsConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateQuerySuggestionsConfig([
'IncludeQueriesWithoutUserInformation' => true || false,
'IndexId' => '<string>', // REQUIRED
'MinimumNumberOfQueryingUsers' => <integer>,
'MinimumQueryCount' => <integer>,
'Mode' => 'ENABLED|LEARN_ONLY',
'QueryLogLookBackWindowInDays' => <integer>,
]);
Parameter Details
Members
- IncludeQueriesWithoutUserInformation
-
- Type: boolean
TRUEto include queries without user information (i.e. all queries, irrespective of the user), otherwiseFALSEto only include queries with user information.If you pass user information to Amazon Kendra along with the queries, you can set this flag to
FALSEand instruct Amazon Kendra to only consider queries with user information.If you set to
FALSE, Amazon Kendra only considers queries searched at leastMinimumQueryCounttimes acrossMinimumNumberOfQueryingUsersunique users for suggestions.If you set to
TRUE, Amazon Kendra ignores all user information and learns from all queries. - IndexId
-
- Required: Yes
- Type: string
The identifier of the index you want to update query suggestions settings for.
- MinimumNumberOfQueryingUsers
-
- Type: int
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
-
- Type: int
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
-
- Type: string
Set the mode to
ENABLEDorLEARN_ONLY.By default, Amazon Kendra enables query suggestions.
LEARN_ONLYmode allows you to turn off query suggestions. You can to update this at any time.In
LEARN_ONLYmode, 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. - QueryLogLookBackWindowInDays
-
- Type: int
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.
Result Syntax
[]
Result Details
Errors
UpdateThesaurus
$result = $client->updateThesaurus([/* ... */]); $promise = $client->updateThesaurusAsync([/* ... */]);
Updates a thesaurus file associated with an index.
Parameter Syntax
$result = $client->updateThesaurus([
'Description' => '<string>',
'Id' => '<string>', // REQUIRED
'IndexId' => '<string>', // REQUIRED
'Name' => '<string>',
'RoleArn' => '<string>',
'SourceS3Path' => [
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- Description
-
- Type: string
The updated description of the thesaurus.
- Id
-
- Required: Yes
- Type: string
The identifier of the thesaurus to update.
- IndexId
-
- Required: Yes
- Type: string
The identifier of the index associated with the thesaurus to update.
- Name
-
- Type: string
The updated name of the thesaurus.
- RoleArn
-
- Type: string
The updated role ARN of the thesaurus.
- SourceS3Path
-
- Type: S3Path structure
Information required to find a specific file in an Amazon S3 bucket.
Result Syntax
[]
Result Details
Errors
Shapes
AccessControlListConfiguration
Description
Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.
Members
AccessDeniedException
AclConfiguration
Description
Provides information about the column that should be used for filtering the query response by groups.
Members
AdditionalResultAttribute
Description
An attribute returned from an index query.
Members
- Key
-
- Required: Yes
- Type: string
The key that identifies the attribute.
- Value
-
- Required: Yes
- Type: AdditionalResultAttributeValue structure
An object that contains the attribute value.
- ValueType
-
- Required: Yes
- Type: string
The data type of the
Valueproperty.
AdditionalResultAttributeValue
Description
An attribute returned with a document from a search.
Members
- TextWithHighlightsValue
-
- Type: TextWithHighlights structure
The text associated with the attribute and information about the highlight to apply to the text.
AttributeFilter
Description
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> -
<EqualTo>
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".
Members
- AndAllFilters
-
- Type: Array of AttributeFilter structures
Performs a logical
ANDoperation on all supplied filters. - ContainsAll
-
- Type: DocumentAttribute structure
Returns true when a document contains all of the specified document attributes. This filter is only applicable to
StringListValuemetadata. - ContainsAny
-
- Type: DocumentAttribute structure
Returns true when a document contains any of the specified document attributes. This filter is only applicable to
StringListValuemetadata. - EqualsTo
-
- Type: DocumentAttribute structure
Performs an equals operation on two document attributes.
- GreaterThan
-
- Type: DocumentAttribute structure
Performs a greater than operation on two document attributes. Use with a document attribute of type
DateorLong. - GreaterThanOrEquals
-
- Type: DocumentAttribute structure
Performs a greater or equals than operation on two document attributes. Use with a document attribute of type
DateorLong. - LessThan
-
- Type: DocumentAttribute structure
Performs a less than operation on two document attributes. Use with a document attribute of type
DateorLong. - LessThanOrEquals
-
- Type: DocumentAttribute structure
Performs a less than or equals operation on two document attributes. Use with a document attribute of type
DateorLong. - NotFilter
-
- Type: AttributeFilter structure
Performs a logical
NOToperation on all supplied filters. - OrAllFilters
-
- Type: Array of AttributeFilter structures
Performs a logical
ORoperation on all supplied filters.
AuthenticationConfiguration
Description
Provides the configuration information to connect to websites that require user authentication.
Members
- BasicAuthentication
-
- Type: Array of BasicAuthenticationConfiguration structures
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.
BasicAuthenticationConfiguration
Description
Provides the configuration information to connect to websites that require basic user authentication.
Members
- Credentials
-
- Required: Yes
- Type: string
Your secret ARN, which you can create in AWS Secrets Manager
You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
- Host
-
- Required: Yes
- Type: string
The name of the website host you want to connect to using authentication credentials.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- Port
-
- Required: Yes
- Type: int
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.
BatchDeleteDocumentResponseFailedDocument
Description
Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.
Members
BatchGetDocumentStatusResponseError
Description
Provides a response when the status of a document could not be retrieved.
Members
- DocumentId
-
- Type: string
The unique identifier of the document whose status could not be retrieved.
- ErrorCode
-
- Type: string
Indicates the source of the error.
- ErrorMessage
-
- Type: string
States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.
BatchPutDocumentResponseFailedDocument
Description
Provides information about a document that could not be indexed.
Members
CapacityUnitsConfiguration
Description
Specifies capacity units configured for your enterprise edition index. You can add and remove capacity units to tune an index to your requirements.
Members
- QueryCapacityUnits
-
- Required: Yes
- Type: int
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.
GetQuerySuggestionscapacity 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, andGetQuerySuggestionscapacity 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, theGetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second). - StorageCapacityUnits
-
- Required: Yes
- Type: int
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.
ClickFeedback
Description
Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.
Members
ColumnConfiguration
Description
Provides information about how Amazon Kendra should use the columns of a database in an index.
Members
- ChangeDetectingColumns
-
- Required: Yes
- Type: Array of strings
One to five columns that indicate when a document in the database has changed.
- DocumentDataColumnName
-
- Required: Yes
- Type: string
The column that contains the contents of the document.
- DocumentIdColumnName
-
- Required: Yes
- Type: string
The column that provides the document's unique identifier.
- DocumentTitleColumnName
-
- Type: string
The column that contains the title of the document.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
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
UpdateIndexoperation.
ConflictException
ConfluenceAttachmentConfiguration
Description
Specifies the attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
Members
- AttachmentFieldMappings
-
- Type: Array of ConfluenceAttachmentToIndexFieldMapping structures
Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the
UpdateIndexoperation.If you specify the
AttachentFieldMappingsparameter, you must specify at least one field mapping. - CrawlAttachments
-
- Type: boolean
Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.
ConfluenceAttachmentToIndexFieldMapping
Description
Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the UpdateIndex operation.
Members
- DataSourceFieldName
-
- Type: string
The name of the field in the data source.
You must first create the index field using the
UpdateIndexoperation. - DateFieldFormat
-
- Type: string
The format for date fields in the data source. If the field specified in
DataSourceFieldNameis a date field you must specify the date format. If the field is not a date field, an exception is thrown. - IndexFieldName
-
- Type: string
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
ConfluenceBlogConfiguration
Description
Specifies the 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 type.
Members
- BlogFieldMappings
-
- Type: Array of ConfluenceBlogToIndexFieldMapping structures
Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the
UpdateIndexoperation.If you specify the
BlogFieldMappingsparameter, you must specify at least one field mapping.
ConfluenceBlogToIndexFieldMapping
Description
Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the UpdateIndex operation.
Members
- DataSourceFieldName
-
- Type: string
The name of the field in the data source.
- DateFieldFormat
-
- Type: string
The format for date fields in the data source. If the field specified in
DataSourceFieldNameis a date field you must specify the date format. If the field is not a date field, an exception is thrown. - IndexFieldName
-
- Type: string
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
ConfluenceConfiguration
Description
Provides configuration information for data sources that connect to Confluence.
Members
- AttachmentConfiguration
-
- Type: ConfluenceAttachmentConfiguration structure
Specifies configuration information for indexing attachments to Confluence blogs and pages.
- BlogConfiguration
-
- Type: ConfluenceBlogConfiguration structure
Specifies configuration information for indexing Confluence blogs.
- ExclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
- InclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
- PageConfiguration
-
- Type: ConfluencePageConfiguration structure
Specifies configuration information for indexing Confluence pages.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
-
username - The user name or email address of a user with administrative privileges for the Confluence server.
-
password - The password associated with the user logging in to the Confluence server.
- ServerUrl
-
- Required: Yes
- Type: string
The URL of your Confluence instance. Use the full URL of the server. For example,
https://server.example.com:port/. You can also use an IP address, for example,https://192.168.1.113/. - SpaceConfiguration
-
- Type: ConfluenceSpaceConfiguration structure
Specifies configuration information for indexing Confluence spaces.
- Version
-
- Required: Yes
- Type: string
Specifies the version of the Confluence installation that you are connecting to.
- VpcConfiguration
-
- Type: DataSourceVpcConfiguration structure
Specifies the information for connecting to an Amazon VPC.
ConfluencePageConfiguration
Description
Specifies the page settings for the Confluence data source.
Members
- PageFieldMappings
-
- Type: Array of ConfluencePageToIndexFieldMapping structures
Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the
UpdateIndexoperation.If you specify the
PageFieldMappingsparameter, you must specify at least one field mapping.
ConfluencePageToIndexFieldMapping
Description
Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the UpdateIndex operation.
Members
- DataSourceFieldName
-
- Type: string
The name of the field in the data source.
- DateFieldFormat
-
- Type: string
The format for date fields in the data source. If the field specified in
DataSourceFieldNameis a date field you must specify the date format. If the field is not a date field, an exception is thrown. - IndexFieldName
-
- Type: string
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
ConfluenceSpaceConfiguration
Description
Specifies the configuration for indexing Confluence spaces.
Members
- CrawlArchivedSpaces
-
- Type: boolean
Specifies whether Amazon Kendra should index archived spaces.
- CrawlPersonalSpaces
-
- Type: boolean
Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
- ExcludeSpaces
-
- Type: Array of strings
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
ExcludeSpacesand theIncludeSpaceslist, the space is excluded. - IncludeSpaces
-
- Type: Array of strings
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
IncludeSpacesand theExcludeSpaceslist, the space is excluded. - SpaceFieldMappings
-
- Type: Array of ConfluenceSpaceToIndexFieldMapping structures
Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the
UpdateIndexoperation.If you specify the
SpaceFieldMappingsparameter, you must specify at least one field mapping.
ConfluenceSpaceToIndexFieldMapping
Description
Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the UpdateIndex operation.
Members
- DataSourceFieldName
-
- Type: string
The name of the field in the data source.
- DateFieldFormat
-
- Type: string
The format for date fields in the data source. If the field specified in
DataSourceFieldNameis a date field you must specify the date format. If the field is not a date field, an exception is thrown. - IndexFieldName
-
- Type: string
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
ConnectionConfiguration
Description
Provides the information necessary to connect to a database.
Members
- DatabaseHost
-
- Required: Yes
- Type: string
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
- DatabaseName
-
- Required: Yes
- Type: string
The name of the database containing the document data.
- DatabasePort
-
- Required: Yes
- Type: int
The port that the database uses for connections.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.
- TableName
-
- Required: Yes
- Type: string
The name of the table that contains the document data.
DataSourceConfiguration
Description
Configuration information for a Amazon Kendra data source.
Members
- ConfluenceConfiguration
-
- Type: ConfluenceConfiguration structure
Provides configuration information for connecting to a Confluence data source.
- DatabaseConfiguration
-
- Type: DatabaseConfiguration structure
Provides information necessary to create a data source connector for a database.
- GoogleDriveConfiguration
-
- Type: GoogleDriveConfiguration structure
Provides configuration for data sources that connect to Google Drive.
- OneDriveConfiguration
-
- Type: OneDriveConfiguration structure
Provides configuration for data sources that connect to Microsoft OneDrive.
- S3Configuration
-
- Type: S3DataSourceConfiguration structure
Provides information to create a data source connector for a document repository in an Amazon S3 bucket.
- SalesforceConfiguration
-
- Type: SalesforceConfiguration structure
Provides configuration information for data sources that connect to a Salesforce site.
- ServiceNowConfiguration
-
- Type: ServiceNowConfiguration structure
Provides configuration for data sources that connect to ServiceNow instances.
- SharePointConfiguration
-
- Type: SharePointConfiguration structure
Provides information necessary to create a data source connector for a Microsoft SharePoint site.
- WebCrawlerConfiguration
-
- Type: WebCrawlerConfiguration structure
Provides the configuration information required for Amazon Kendra web crawler.
- WorkDocsConfiguration
-
- Type: WorkDocsConfiguration structure
Provides the configuration information to connect to WorkDocs as your data source.
DataSourceGroup
Description
Data source information for user context filtering.
Members
- DataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.
- GroupId
-
- Required: Yes
- Type: string
The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups' access to documents.
DataSourceSummary
Description
Summary information for a Amazon Kendra data source. Returned in a call to the DescribeDataSource operation.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UNIX datetime that the data source was created.
- Id
-
- Type: string
The unique identifier for the data source.
- LanguageCode
-
- Type: string
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.
- Name
-
- Type: string
The name of the data source.
- Status
-
- Type: string
The status of the data source. When the status is
ACTIVEthe data source is ready to use. - Type
-
- Type: string
The type of the data source.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UNIX datetime that the data source was lasted updated.
DataSourceSyncJob
Description
Provides information about a synchronization job.
Members
- DataSourceErrorCode
-
- Type: string
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UNIX datetime that the synchronization job was completed.
- ErrorCode
-
- Type: string
If the
Statusfield is set toFAILED, theErrorCodefield contains a the reason that the synchronization failed. - ErrorMessage
-
- Type: string
If the
Statusfield is set toERROR, theErrorMessagefield contains a description of the error that caused the synchronization to fail. - ExecutionId
-
- Type: string
A unique identifier for the synchronization job.
- Metrics
-
- Type: DataSourceSyncJobMetrics structure
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.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UNIX datetime that the synchronization job was started.
- Status
-
- Type: string
The execution status of the synchronization job. When the
Statusfield is set toSUCCEEDED, the synchronization job is done. If the status code is set toFAILED, theErrorCodeandErrorMessagefields give you the reason for the failure.
DataSourceSyncJobMetricTarget
Description
Maps a particular data source sync job to a particular data source.
Members
- DataSourceId
-
- Required: Yes
- Type: string
The ID of the data source that is running the sync job.
- DataSourceSyncJobId
-
- Type: string
The ID of the sync job that is running on the data source.
If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.
If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.
DataSourceSyncJobMetrics
Description
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.
Members
- DocumentsAdded
-
- Type: string
The number of documents added from the data source up to now in the data source sync.
- DocumentsDeleted
-
- Type: string
The number of documents deleted from the data source up to now in the data source sync run.
- DocumentsFailed
-
- Type: string
The number of documents that failed to sync from the data source up to now in the data source sync run.
- DocumentsModified
-
- Type: string
The number of documents modified in the data source up to now in the data source sync run.
- DocumentsScanned
-
- Type: string
The current number of documents crawled by the current sync job in the data source.
DataSourceToIndexFieldMapping
Description
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 operation.
Members
DataSourceVpcConfiguration
Description
Provides information for connecting to an Amazon VPC.
Members
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
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.
DatabaseConfiguration
Description
Provides the information necessary to connect a database to an index.
Members
- AclConfiguration
-
- Type: AclConfiguration structure
Information about the database column that provides information for user context filtering.
- ColumnConfiguration
-
- Required: Yes
- Type: ColumnConfiguration structure
Information about where the index should get the document information from the database.
- ConnectionConfiguration
-
- Required: Yes
- Type: ConnectionConfiguration structure
The information necessary to connect to a database.
- DatabaseEngineType
-
- Required: Yes
- Type: string
The type of database engine that runs the database.
- SqlConfiguration
-
- Type: SqlConfiguration structure
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- VpcConfiguration
-
- Type: DataSourceVpcConfiguration structure
Provides information for connecting to an Amazon VPC.
Document
Description
A document in an index.
Members
- AccessControlList
-
- Type: Array of Principal structures
Information on user and group access rights, which is used for user context filtering.
- Attributes
-
- Type: Array of DocumentAttribute structures
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.
- Blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The contents of the document.
Documents passed to the
Blobparameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending. - ContentType
-
- Type: string
The file type of the document in the
Blobfield. - HierarchicalAccessControlList
-
- Type: Array of HierarchicalPrincipal structures
The list of principal lists that define the hierarchy for which documents users should have access to.
- Id
-
- Required: Yes
- Type: string
A unique identifier of the document in the index.
- S3Path
-
- Type: S3Path structure
Information required to find a specific file in an Amazon S3 bucket.
- Title
-
- Type: string
The title of the document.
DocumentAttribute
Description
A custom attribute value assigned to a document.
Members
- Key
-
- Required: Yes
- Type: string
The identifier for the attribute.
- Value
-
- Required: Yes
- Type: DocumentAttributeValue structure
The value of the attribute.
DocumentAttributeValue
Description
The value of a custom document attribute. You can only provide one value for a custom attribute.
Members
- DateValue
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
- LongValue
-
- Type: long (int|float)
A long integer value.
- StringListValue
-
- Type: Array of strings
A list of strings.
- StringValue
-
- Type: string
A string, such as "department".
DocumentAttributeValueCountPair
Description
Provides the count of documents that match a particular attribute when doing a faceted search.
Members
- Count
-
- Type: int
The number of documents in the response that have the attribute value for the key.
- DocumentAttributeValue
-
- Type: DocumentAttributeValue structure
The value of the attribute. For example, "HR."
DocumentInfo
Description
Identifies a document for which to retrieve status information
Members
- Attributes
-
- Type: Array of DocumentAttribute structures
Attributes that identify a specific version of a document to check.
The only valid attributes are:
-
version
-
datasourceId
-
jobExecutionId
The attributes follow these rules:
-
dataSourceIdandjobExecutionIdmust be used together. -
versionis ignored ifdataSourceIdandjobExecutionIdare not provided. -
If
dataSourceIdandjobExecutionIdare provided, butversionis not, the version defaults to "0".
- DocumentId
-
- Required: Yes
- Type: string
The unique identifier of the document.
DocumentMetadataConfiguration
Description
Specifies the properties of a custom index field.
Members
- Name
-
- Required: Yes
- Type: string
The name of the index field.
- Relevance
-
- Type: Relevance structure
Provides manual tuning parameters to determine how the field affects the search results.
- Search
-
- Type: Search structure
Provides information about how the field is used during a search.
- Type
-
- Required: Yes
- Type: string
The data type of the index field.
DocumentRelevanceConfiguration
Description
Overrides the document relevance properties of a custom index field.
Members
- Name
-
- Required: Yes
- Type: string
The name of the tuning configuration to override document relevance at the index level.
- Relevance
-
- Required: Yes
- Type: Relevance structure
Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
DocumentsMetadataConfiguration
Description
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.
Members
Facet
Description
Information about a document attribute
Members
FacetResult
Description
The facet values for the documents in the response.
Members
- DocumentAttributeKey
-
- Type: string
The key for the facet values. This is the same as the
DocumentAttributeKeyprovided in the query. - DocumentAttributeValueCountPairs
-
- Type: Array of DocumentAttributeValueCountPair structures
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
-
- Type: string
The data type of the facet value. This is the same as the type defined for the index field when it was created.
FaqStatistics
Description
Provides statistical information about the FAQ questions and answers contained in an index.
Members
FaqSummary
Description
Provides information about a frequently asked questions and answer contained in an index.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UNIX datetime that the FAQ was added to the index.
- FileFormat
-
- Type: string
The file type used to create the FAQ.
- Id
-
- Type: string
The unique identifier of the FAQ.
- LanguageCode
-
- Type: string
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.
- Name
-
- Type: string
The name that you assigned the FAQ when you created or updated the FAQ.
- Status
-
- Type: string
The current status of the FAQ. When the status is
ACTIVEthe FAQ is ready for use. - UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UNIX datetime that the FAQ was last updated.
GoogleDriveConfiguration
Description
Provides configuration information for data sources that connect to Google Drive.
Members
- ExcludeMimeTypes
-
- Type: Array of strings
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.
- ExcludeSharedDrives
-
- Type: Array of strings
A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
- ExcludeUserAccounts
-
- Type: Array of strings
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.
- ExclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
Defines mapping between a field in the Google Drive and a Amazon Kendra index field.
If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the
UpdateIndexoperation. - InclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
GroupMembers
Description
A list of users or sub groups that belong to a group. Users and groups are useful for filtering search results to different users based on their group's access to documents.
Members
- MemberGroups
-
- Type: Array of MemberGroup structures
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".
- MemberUsers
-
- Type: Array of MemberUser structures
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
- S3PathforGroupMembers
-
- Type: S3Path structure
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,
dataSourceIdis optional. The value oftypefor a group is alwaysGROUPand for a user it is alwaysUSER.
GroupOrderingIdSummary
Description
Information on the processing of PUT and DELETE actions for mapping users to their groups.
Members
- FailureReason
-
- Type: string
The reason an action could not be processed. An action can be a
PUTorDELETEaction for mapping users to their groups. - LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last date-time an action was updated. An action can be a
PUTorDELETEaction for mapping users to their groups. - OrderingId
-
- Type: long (int|float)
The order in which actions should complete processing. An action can be a
PUTorDELETEaction for mapping users to their groups. - ReceivedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date-time an action was received by Amazon Kendra. An action can be a
PUTorDELETEaction for mapping users to their groups. - Status
-
- Type: string
The current processing status of actions for mapping users to their groups. The status can be either
PROCESSING,SUCCEEDED,DELETING,DELETED, orFAILED.
GroupSummary
Description
Group summary information.
Members
HierarchicalPrincipal
Description
Information to define the hierarchy for which documents users should have access to.
Members
Highlight
Description
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
Members
- BeginOffset
-
- Required: Yes
- Type: int
The zero-based location in the response string where the highlight starts.
- EndOffset
-
- Required: Yes
- Type: int
The zero-based location in the response string where the highlight ends.
- TopAnswer
-
- Type: boolean
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
- Type
-
- Type: string
The highlight type.
IndexConfigurationSummary
Description
A summary of information about an index.
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the index was created.
- Edition
-
- Type: string
Indicates whether the index is a enterprise edition index or a developer edition index.
- Id
-
- Type: string
A unique identifier for the index. Use this to identify the index when you are using operations such as
Query,DescribeIndex,UpdateIndex, andDeleteIndex. - Name
-
- Type: string
The name of the index.
- Status
-
- Required: Yes
- Type: string
The current status of the index. When the status is
ACTIVE, the index is ready to search. - UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the index was last updated by the
UpdateIndexoperation.
IndexStatistics
Description
Provides information about the number of documents and the number of questions and answers in an index.
Members
- FaqStatistics
-
- Required: Yes
- Type: FaqStatistics structure
The number of question and answer topics in the index.
- TextDocumentStatistics
-
- Required: Yes
- Type: TextDocumentStatistics structure
The number of text documents indexed.
InternalServerException
JsonTokenTypeConfiguration
Description
Configuration information for the JSON token type.
Members
JwtTokenTypeConfiguration
Description
Configuration information for the JWT token type.
Members
- ClaimRegex
-
- Type: string
The regular expression that identifies the claim.
- GroupAttributeField
-
- Type: string
The group attribute field.
- Issuer
-
- Type: string
The issuer of the token.
- KeyLocation
-
- Required: Yes
- Type: string
The location of the key.
- SecretManagerArn
-
- Type: string
The Amazon Resource Name (arn) of the secret.
- URL
-
- Type: string
The signing key URL.
- UserNameAttributeField
-
- Type: string
The user name attribute field.
MemberGroup
Description
The sub groups that belong to a group.
Members
MemberUser
Description
The users that belong to a group.
Members
OneDriveConfiguration
Description
Provides configuration information for data sources that connect to OneDrive.
Members
- DisableLocalGroups
-
- Type: boolean
A Boolean value that specifies whether local groups are disabled (
True) or enabled (False). - ExclusionPatterns
-
- Type: Array of strings
List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
The exclusion pattern is applied to the file name.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
A list of
DataSourceToIndexFieldMappingobjects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields. - InclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The exclusion pattern is applied to the file name.
- OneDriveUsers
-
- Required: Yes
- Type: OneDriveUsers structure
A list of user accounts whose documents should be indexed.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
- TenantDomain
-
- Required: Yes
- Type: string
The Azure Active Directory domain of the organization.
OneDriveUsers
Description
User accounts whose documents should be indexed.
Members
- OneDriveUserList
-
- Type: Array of strings
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 theOneDriveUserS3Pathfield to specify the location of a file containing a list of users. - OneDriveUserS3Path
-
- Type: S3Path structure
The S3 bucket location of a file containing a list of users whose documents should be indexed.
Principal
Description
Provides user and group information for document access filtering.
Members
- Access
-
- Required: Yes
- Type: string
Whether to allow or deny access to the principal.
- DataSourceId
-
- Type: string
The identifier of the data source the principal should access documents from.
- Name
-
- Required: Yes
- Type: string
The name of the user or group.
- Type
-
- Required: Yes
- Type: string
The type of principal.
ProxyConfiguration
Description
Provides the configuration information for a web proxy to connect to website hosts.
Members
- Credentials
-
- Type: string
Your secret ARN, which you can create in AWS Secrets Manager
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
- Host
-
- Required: Yes
- Type: string
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- Port
-
- Required: Yes
- Type: int
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.
QueryResultItem
Description
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.
Members
- AdditionalAttributes
-
- Type: Array of AdditionalResultAttribute structures
One or more additional attributes associated with the query result.
- DocumentAttributes
-
- Type: Array of DocumentAttribute structures
An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.
- DocumentExcerpt
-
- Type: TextWithHighlights structure
An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
- DocumentId
-
- Type: string
The unique identifier for the document.
- DocumentTitle
-
- Type: TextWithHighlights structure
The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
- DocumentURI
-
- Type: string
The URI of the original location of the document.
- FeedbackToken
-
- Type: string
A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .
- Id
-
- Type: string
The unique identifier for the query result.
- ScoreAttributes
-
- Type: ScoreAttributes structure
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,MEDIUMandLOW. You can use the score to determine if a response meets the confidence needed for your application.The field is only set to
LOWwhen theTypefield is set toDOCUMENTand Amazon Kendra is not confident that the result matches the query. - Type
-
- Type: string
The type of document.
QuerySuggestionsBlockListSummary
Description
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.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date-time summary information for a query suggestions block list was last created.
- Id
-
- Type: string
The identifier of a block list.
- ItemCount
-
- Type: int
The number of items in the block list file.
- Name
-
- Type: string
The name of the block list.
- Status
-
- Type: string
The status of the block list.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date-time the block list was last updated.
Relevance
Description
Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
Members
- Duration
-
- Type: string
Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.
Only applies to
DATEfields. - Freshness
-
- Type: boolean
Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the
Freshnessfield on oneDATEtype field. Only applies toDATEfields. - Importance
-
- Type: int
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
- RankOrder
-
- Type: string
Determines how values should be interpreted.
When the
RankOrderfield isASCENDING, 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
RankOrderfield isDESCENDING, 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
LONGandDOUBLEfields. - ValueImportanceMap
-
- Type: Associative array of custom strings keys (ValueImportanceMapKey) to ints
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.
RelevanceFeedback
Description
Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.
Members
ResourceAlreadyExistException
ResourceInUseException
ResourceNotFoundException
ResourceUnavailableException
S3DataSourceConfiguration
Description
Provides configuration information for a data source to index documents in an Amazon S3 bucket.
Members
- AccessControlListConfiguration
-
- Type: AccessControlListConfiguration structure
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.
- BucketName
-
- Required: Yes
- Type: string
The name of the bucket that contains the documents.
- DocumentsMetadataConfiguration
-
- Type: DocumentsMetadataConfiguration structure
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.
- ExclusionPatterns
-
- Type: Array of strings
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.
- InclusionPatterns
-
- Type: Array of strings
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'.
- InclusionPrefixes
-
- Type: Array of strings
A list of S3 prefixes for the documents that should be included in the index.
S3Path
Description
Information required to find a specific file in an Amazon S3 bucket.
Members
SalesforceChatterFeedConfiguration
Description
Defines configuration for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
Members
- DocumentDataFieldName
-
- Required: Yes
- Type: string
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Bodycolumn. - DocumentTitleFieldName
-
- Type: string
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the
Titlecolumn. - FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- IncludeFilterTypes
-
- Type: Array of strings
Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERSonly documents from users who have an active account are indexed. When you specifySTANDARD_USERonly documents for Salesforce standard users are documented. You can specify both.
SalesforceConfiguration
Description
Provides configuration information for connecting to a Salesforce data source.
Members
- ChatterFeedConfiguration
-
- Type: SalesforceChatterFeedConfiguration structure
Specifies configuration information for Salesforce chatter feeds.
- CrawlAttachments
-
- Type: boolean
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- ExcludeAttachmentFilePatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the name of the attached file.
- IncludeAttachmentFilePatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the name of the attached file.
- KnowledgeArticleConfiguration
-
- Type: SalesforceKnowledgeArticleConfiguration structure
Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
-
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
-
consumerKey - The application public key generated when you created your Salesforce application.
-
consumerSecret - The application private key generated when you created your Salesforce application.
-
password - The password associated with the user logging in to the Salesforce instance.
-
securityToken - The token associated with the user account logging in to the Salesforce instance.
-
username - The user name of the user logging in to the Salesforce instance.
- ServerUrl
-
- Required: Yes
- Type: string
The instance URL for the Salesforce site that you want to index.
- StandardObjectAttachmentConfiguration
-
- Type: SalesforceStandardObjectAttachmentConfiguration structure
Provides configuration information for processing attachments to Salesforce standard objects.
- StandardObjectConfigurations
-
- Type: Array of SalesforceStandardObjectConfiguration structures
Specifies the Salesforce standard objects that Amazon Kendra indexes.
SalesforceCustomKnowledgeArticleTypeConfiguration
Description
Provides configuration information for indexing Salesforce custom articles.
Members
- DocumentDataFieldName
-
- Required: Yes
- Type: string
The name of the field in the custom knowledge article that contains the document data to index.
- DocumentTitleFieldName
-
- Type: string
The name of the field in the custom knowledge article that contains the document title.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
- Name
-
- Required: Yes
- Type: string
The name of the configuration.
SalesforceKnowledgeArticleConfiguration
Description
Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both
Members
- CustomKnowledgeArticleTypeConfigurations
-
- Type: Array of SalesforceCustomKnowledgeArticleTypeConfiguration structures
Provides configuration information for custom Salesforce knowledge articles.
- IncludedStates
-
- Required: Yes
- Type: Array of strings
Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
- StandardKnowledgeArticleTypeConfiguration
-
- Type: SalesforceStandardKnowledgeArticleTypeConfiguration structure
Provides configuration information for standard Salesforce knowledge articles.
SalesforceStandardKnowledgeArticleTypeConfiguration
Description
Provides configuration information for standard Salesforce knowledge articles.
Members
- DocumentDataFieldName
-
- Required: Yes
- Type: string
The name of the field that contains the document data to index.
- DocumentTitleFieldName
-
- Type: string
The name of the field that contains the document title.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.
SalesforceStandardObjectAttachmentConfiguration
Description
Provides configuration information for processing attachments to Salesforce standard objects.
Members
- DocumentTitleFieldName
-
- Type: string
The name of the field used for the document title.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
One or more objects that map fields in attachments to Amazon Kendra index fields.
SalesforceStandardObjectConfiguration
Description
Specifies configuration information for indexing a single standard object.
Members
- DocumentDataFieldName
-
- Required: Yes
- Type: string
The name of the field in the standard object table that contains the document contents.
- DocumentTitleFieldName
-
- Type: string
The name of the field in the standard object table that contains the document title.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.
- Name
-
- Required: Yes
- Type: string
The name of the standard object.
ScoreAttributes
Description
Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.
Members
Search
Description
Provides information about how a custom index field is used during a search.
Members
- Displayable
-
- Type: boolean
Determines whether the field is returned in the query response. The default is
true. - Facetable
-
- Type: boolean
Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - Searchable
-
- Type: boolean
Determines whether the field is used in the search. If the
Searchablefield istrue, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default istruefor string fields andfalsefor number and date fields. - Sortable
-
- Type: boolean
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have
Sortableset totrue, Amazon Kendra returns an exception. The default isfalse.
SeedUrlConfiguration
Description
Provides the configuration information of 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 the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
Members
- SeedUrls
-
- Required: Yes
- Type: Array of strings
The list of seed or starting point URLs of the websites you want to crawl.
The list can include a maximum of 100 seed URLs.
- WebCrawlerMode
-
- Type: string
You can choose one of the following modes:
-
HOST_ONLY– crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled. -
SUBDOMAINS– crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled. -
EVERYTHING– crawl the website host names with subdomains and other domains that the webpages link to.
The default mode is set to
HOST_ONLY.
ServerSideEncryptionConfiguration
Description
Provides the identifier of the KMScustomer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
Members
ServiceNowConfiguration
Description
Provides configuration information required to connect to a ServiceNow data source.
Members
- AuthenticationType
-
- Type: string
Determines the type of authentication used to connect to the ServiceNow instance. If you choose
HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in theSecretArnfield. When you chooseOAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.When you use
OAUTH2authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source. - HostUrl
-
- Required: Yes
- Type: string
The ServiceNow instance that the data source connects to. The host endpoint should look like the following:
{instance}.service-now.com. - KnowledgeArticleConfiguration
-
- Type: ServiceNowKnowledgeArticleConfiguration structure
Provides configuration information for crawling knowledge articles in the ServiceNow site.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.
- ServiceCatalogConfiguration
-
- Type: ServiceNowServiceCatalogConfiguration structure
Provides configuration information for crawling service catalogs in the ServiceNow site.
- ServiceNowBuildVersion
-
- Required: Yes
- Type: string
The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDONrelease, useOTHERS.
ServiceNowKnowledgeArticleConfiguration
Description
Provides configuration information for crawling knowledge articles in the ServiceNow site.
Members
- CrawlAttachments
-
- Type: boolean
Indicates whether Amazon Kendra should index attachments to knowledge articles.
- DocumentDataFieldName
-
- Required: Yes
- Type: string
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- DocumentTitleFieldName
-
- Type: string
The name of the ServiceNow field that is mapped to the index document title field.
- ExcludeAttachmentFilePatterns
-
- Type: Array of strings
List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the
PatternTargetField - FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.
- FilterQuery
-
- Type: string
A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.
The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.
- IncludeAttachmentFilePatterns
-
- Type: Array of strings
List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the
PatternTargetField.
ServiceNowServiceCatalogConfiguration
Description
Provides configuration information for crawling service catalog items in the ServiceNow site
Members
- CrawlAttachments
-
- Type: boolean
Indicates whether Amazon Kendra should crawl attachments to the service catalog items.
- DocumentDataFieldName
-
- Required: Yes
- Type: string
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- DocumentTitleFieldName
-
- Type: string
The name of the ServiceNow field that is mapped to the index document title field.
- ExcludeAttachmentFilePatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the file name of the attachment.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.
- IncludeAttachmentFilePatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the file name of the attachment.
ServiceQuotaExceededException
SharePointConfiguration
Description
Provides configuration information for connecting to a Microsoft SharePoint data source.
Members
- CrawlAttachments
-
- Type: boolean
TRUEto include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise,FALSE. - DisableLocalGroups
-
- Type: boolean
A Boolean value that specifies whether local groups are disabled (
True) or enabled (False). - DocumentTitleFieldName
-
- Type: string
The Microsoft SharePoint attribute field that contains the title of the document.
- ExclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
A list of
DataSourceToIndexFieldMappingobjects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using theUpdateIndexoperation before you map SharePoint attributes. For more information, see Mapping Data Source Fields. - InclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
- SecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.
- SharePointVersion
-
- Required: Yes
- Type: string
The version of Microsoft SharePoint that you are using as a data source.
- SslCertificateS3Path
-
- Type: S3Path structure
Information required to find a specific file in an Amazon S3 bucket.
- Urls
-
- Required: Yes
- Type: Array of strings
The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
- UseChangeLog
-
- Type: boolean
Set to
TRUEto use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler. - VpcConfiguration
-
- Type: DataSourceVpcConfiguration structure
Provides information for connecting to an Amazon VPC.
SiteMapsConfiguration
Description
Provides the configuration information of 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 the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
Members
SortingConfiguration
Description
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
Members
- DocumentAttributeKey
-
- Required: Yes
- Type: string
The name of the document attribute used to sort the response. You can use any field that has the
Sortableflag set to true.You can also sort by any of the following built-in attributes:
-
_category
-
_created_at
-
_last_updated_at
-
_version
-
_view_count
- SortOrder
-
- Required: Yes
- Type: string
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.
SqlConfiguration
Description
Provides information that configures Amazon Kendra to use a SQL database.
Members
- QueryIdentifiersEnclosingOption
-
- Type: string
Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.
By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.
PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.
For MySQL databases, you must enable the
ansi_quotesoption when you set this field toDOUBLE_QUOTES.
Status
Description
Provides information about the status of documents submitted for indexing.
Members
- DocumentId
-
- Type: string
The unique identifier of the document.
- DocumentStatus
-
- Type: string
The current status of a document.
If the document was submitted for deletion, the status is
NOT_FOUNDafter the document is deleted. - FailureCode
-
- Type: string
Indicates the source of the error.
- FailureReason
-
- Type: string
Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
Suggestion
Description
A single query suggestion.
Members
- Id
-
- Type: string
The unique UUID (universally unique identifier) of a single query suggestion.
- Value
-
- Type: SuggestionValue structure
The value for the unique UUID (universally unique identifier) of a single query suggestion.
The value is the text string of a suggestion.
SuggestionHighlight
Description
The text highlights for a single query suggestion.
Members
SuggestionTextWithHighlights
Description
Provides text and information about where to highlight the query suggestion text.
Members
- Highlights
-
- Type: Array of SuggestionHighlight structures
The beginning and end of the query suggestion text that should be highlighted.
- Text
-
- Type: string
The query suggestion text to display to the user.
SuggestionValue
Description
The SuggestionTextWithHighlights structure information.
Members
- Text
-
- Type: SuggestionTextWithHighlights structure
The
SuggestionTextWithHighlightsstructure that contains the query suggestion text and highlights.
Tag
Description
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: _ . : / = + - @.
Members
TextDocumentStatistics
Description
Provides information about text documents indexed in an index.
Members
TextWithHighlights
Description
Provides text and information about where to highlight the text.
Members
- Highlights
-
- Type: Array of Highlight structures
The beginning and end of the text that should be highlighted.
- Text
-
- Type: string
The text to display to the user.
ThesaurusSummary
Description
An array of summary information for a thesaurus or multiple thesauri.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix datetime that the thesaurus was created.
- Id
-
- Type: string
The identifier of the thesaurus.
- Name
-
- Type: string
The name of the thesaurus.
- Status
-
- Type: string
The status of the thesaurus.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix datetime that the thesaurus was last updated.
ThrottlingException
TimeRange
Description
Provides a range of time.
Members
Urls
Description
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 the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
Members
- SeedUrlConfiguration
-
- Type: SeedUrlConfiguration structure
Provides the configuration of the seed or starting point URLs of the websites you want to crawl.
You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.
You can list up to 100 seed URLs.
- SiteMapsConfiguration
-
- Type: SiteMapsConfiguration structure
Provides the configuration of the sitemap URLs of the websites you want to crawl.
Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.
UserContext
Description
Provides information about the user context for an Amazon Kendra index.
This is used for filtering search results for different users based on their access to documents.
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.
Members
- DataSourceGroups
-
- Type: Array of DataSourceGroup structures
The list of data source groups you want to filter search results based on groups' access to documents in that data source.
- Groups
-
- Type: Array of strings
The list of groups you want to filter search results based on the groups' access to documents.
- Token
-
- Type: string
The user context token for filtering search results for a user. It must be a JWT or a JSON token.
- UserId
-
- Type: string
The identifier of the user you want to filter search results based on their access to documents.
UserGroupResolutionConfiguration
Description
Provides the configuration information to fetch access levels of groups and users from an AWS Single Sign-On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping operation.
To set up an AWS SSO identity source in the console to use with Amazon Kendra, see Getting started with an AWS SSO identity source. You must also grant the required permissions to use AWS SSO with Amazon Kendra. For more information, see IAM roles for AWS Single Sign-On.
Members
UserTokenConfiguration
Description
Provides configuration information for a token configuration.
Members
- JsonTokenTypeConfiguration
-
- Type: JsonTokenTypeConfiguration structure
Information about the JSON token type configuration.
- JwtTokenTypeConfiguration
-
- Type: JwtTokenTypeConfiguration structure
Information about the JWT token type configuration.
ValidationException
WebCrawlerConfiguration
Description
Provides the configuration information required for Amazon Kendra web crawler.
Members
- AuthenticationConfiguration
-
- Type: AuthenticationConfiguration structure
Provides configuration information required to connect to websites using authentication.
You can connect to websites using basic authentication of user name and password.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.
- CrawlDepth
-
- Type: int
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.
- MaxContentSizePerPageInMegaBytes
-
- Type: float
The maximum size (in MB) of a webpage or attachment to crawl.
Files larger than this size (in MB) are skipped/not crawled.
The default maximum size of a webpage or attachment is set to 50 MB.
- MaxLinksPerPage
-
- Type: int
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.
- MaxUrlsPerMinuteCrawlRate
-
- Type: int
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.
- ProxyConfiguration
-
- Type: ProxyConfiguration structure
Provides configuration information required to connect to your internal websites via a web proxy.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.
- UrlExclusionPatterns
-
- Type: Array of strings
The regular expression pattern to exclude certain URLs to crawl.
If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.
- UrlInclusionPatterns
-
- Type: Array of strings
The regular expression pattern to include certain URLs to crawl.
If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.
- Urls
-
- Required: Yes
- Type: Urls structure
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 the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
WorkDocsConfiguration
Description
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.
Members
- CrawlComments
-
- Type: boolean
TRUEto 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. - ExclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
- FieldMappings
-
- Type: Array of DataSourceToIndexFieldMapping structures
A list of
DataSourceToIndexFieldMappingobjects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using theUpdateIndexoperation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata. - InclusionPatterns
-
- Type: Array of strings
A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
- OrganizationId
-
- Required: Yes
- Type: string
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
- UseChangeLog
-
- Type: boolean
TRUEto use the change logs to update documents in your index instead of scanning all documents.If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
The default is set to
FALSE.