AWS SDK for PHP 3.x

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.
BatchPutDocument ( array $params = [] )
Adds one or more documents to an index.
CreateDataSource ( array $params = [] )
Creates a data source that you use to 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.
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.
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
DescribeThesaurus ( array $params = [] )
Describes an existing Amazon Kendra thesaurus.
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.
ListIndices ( array $params = [] )
Lists the Amazon Kendra indexes that you have created.
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.
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 the service.
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.
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:

ListDataSourceSyncJobs
ListDataSources
ListIndices

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 AWS 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>', // REQUIRED
    ],
    '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

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 AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.

Parameter Syntax

$result = $client->batchPutDocument([
    'Documents' => [ // REQUIRED
        [
            'AccessControlList' => [
                [
                    'Access' => 'ALLOW|DENY', // REQUIRED
                    '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',
            '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 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 CreateIndex operation.

RoleArn

Type: string

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

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 AWS CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch Logs

Errors

CreateDataSource

$result = $client->createDataSource([/* ... */]);
$promise = $client->createDataSourceAsync([/* ... */]);

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

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

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

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_ONLINE', // REQUIRED
            'Urls' => ['<string>', ...], // REQUIRED
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'Description' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
    'Schedule' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE', // 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 CreateDataSource operation 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 Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

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.

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 RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

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 StartDataSourceSyncJob operation to update the index.

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

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

Members

Id

Required: Yes
Type: string

A unique identifier for the data source.

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
    '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 CreateFaqRequest operation 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 S3Path parameter.

For more information, see Adding questions and answers.

IndexId

Required: Yes
Type: string

The identifier of the index that contains the FAQ.

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

Members

Id

Type: string

The unique identifier of the FAQ.

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',
    '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 CreateIndex operation 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_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

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

Name

Required: Yes
Type: string

The name for the new index.

RoleArn

Required: Yes
Type: string

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

ServerSideEncryptionConfiguration

Type: ServerSideEncryptionConfiguration structure

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

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 there is an access control list, it is ignored. You can filter on user and group attributes.
USER_TOKEN: Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

UserTokenConfigurations

Type: Array of UserTokenConfiguration structures

The user token configuration.

Result Syntax

[
    'Id' => '<string>',
]

Result Details

Members

Id

Type: string

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

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 CreateThesaurus operation with the same client token will create only one index.

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

Members

Id

Type: string

The unique identifier of the thesaurus.

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

Id

Required: Yes
Type: string

The unique identifier of the data source to delete.

IndexId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Id

Required: Yes
Type: string

The identifier of the FAQ to remove.

IndexId

Required: Yes
Type: string

The index to remove the FAQ from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

Id

Required: Yes
Type: string

The identifier of the index to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Id

Required: Yes
Type: string

The identifier of the thesaurus to delete.

IndexId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Id

Required: Yes
Type: string

The unique identifier of the data source to describe.

IndexId

Required: Yes
Type: string

The identifier of the index that contains the data source.

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_ONLINE',
            'Urls' => ['<string>', ...],
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ErrorMessage' => '<string>',
    'Id' => '<string>',
    'IndexId' => '<string>',
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'Schedule' => '<string>',
    'Status' => 'CREATING|DELETING|FAILED|UPDATING|ACTIVE',
    'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE',
    '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 Status field value is FAILED, the ErrorMessage field 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.

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 ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field 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

Id

Required: Yes
Type: string

The unique identifier of the FAQ.

IndexId

Required: Yes
Type: string

The identifier of the index that contains the FAQ.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ErrorMessage' => '<string>',
    'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
    'Id' => '<string>',
    'IndexId' => '<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 Status field is FAILED, the ErrorMessage field 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.

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

Members

Id

Required: Yes
Type: string

The name of the index to describe.

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',
    '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 eStatus field value is FAILED, the ErrorMessage field 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 AWS KMS customer 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 the Status field value is FAILED, the ErrorMessage field 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.

UserTokenConfigurations

Type: Array of UserTokenConfiguration structures

The user token configuration for the Amazon Kendra index.

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

Id

Required: Yes
Type: string

The identifier of the thesaurus to describe.

IndexId

Required: Yes
Type: string

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

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 Status field value is FAILED, the ErrorMessage field 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 the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

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,c and a=>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

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 result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch 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 Status field 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

The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory operation to return in the next page of jobs.

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>',
            'Name' => '<string>',
            'Status' => 'CREATING|DELETING|FAILED|UPDATING|ACTIVE',
            'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE',
            '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 result of the previous request to ListFaqs was truncated, include the NextToken to fetch the next set of FAQs.

Result Syntax

[
    'FaqSummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
            'Id' => '<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

The ListFaqs operation returns a page of FAQs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the ListFaqs operation to return the next page of FAQs.

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

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

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

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.

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

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 one or more thesauruses.

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' => [
        'Token' => '<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, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

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 CreateIndex operation.

PageNumber

Type: int

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

PageSize

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.

VisitorId

Type: string

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

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',
            ],
            'Type' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
        ],
        // ...
    ],
    'TotalNumberOfResults' => <integer>,
]

Result Details

Members

FacetResults

Type: Array of FacetResult structures

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

QueryId

Type: string

The unique identifier for the search. You use QueryId to 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

Id

Required: Yes
Type: string

The identifier of the data source to synchronize.

IndexId

Required: Yes
Type: string

The identifier of the index that contains the data source.

Result Syntax

[
    'ExecutionId' => '<string>',
]

Result Details

Members

ExecutionId

Type: string

Identifies a particular synchronization job.

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

Id

Required: Yes
Type: string

The identifier of the data source for which to stop the synchronization jobs.

IndexId

Required: Yes
Type: string

The identifier of the index that contains the data source.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

SubmitFeedback

$result = $client->submitFeedback([/* ... */]);
$promise = $client->submitFeedbackAsync([/* ... */]);

Enables you to provide feedback to Amazon Kendra to improve the performance of the service.

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 Query operation.

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

The results for this operation are always empty.

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

The results for this operation are always empty.

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

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.

TagKeys

Required: Yes
Type: Array of strings

A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not exist on the resource, it is ignored.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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_ONLINE', // REQUIRED
            'Urls' => ['<string>', ...], // REQUIRED
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'Description' => '<string>',
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
    '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.

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

The results for this operation are always empty.

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',
    '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 user token context policy.

UserTokenConfigurations

Type: Array of UserTokenConfiguration structures

The user token configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

The results for this operation are always empty.

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

KeyPath

Type: string

Path to the AWS S3 bucket that contains the ACL files.

AccessDeniedException

Description

Members

Message

Type: string

AclConfiguration

Description

Provides information about the column that should be used for filtering the query response by groups.

Members

AllowedGroupsColumnName

Required: Yes
Type: string

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

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 Value property.

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.

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."

Members

AndAllFilters

Type: Array of AttributeFilter structures

Performs a logical AND operation 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 StringListValue metadata.

ContainsAny

Type: DocumentAttribute structure

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

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 Integer or Long.

GreaterThanOrEquals

Type: DocumentAttribute structure

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

LessThan

Type: DocumentAttribute structure

Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

LessThanOrEquals

Type: DocumentAttribute structure

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

NotFilter

Type: AttributeFilter structure

Performs a logical NOT operation on all supplied filters.

OrAllFilters

Type: Array of AttributeFilter structures

Performs a logical OR operation on all supplied filters.

BatchDeleteDocumentResponseFailedDocument

Description

Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.

Members

ErrorCode

Type: string

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

ErrorMessage

Type: string

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

Id

Type: string

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

BatchPutDocumentResponseFailedDocument

Description

Provides information about a document that could not be indexed.

Members

ErrorCode

Type: string

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

ErrorMessage

Type: string

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

Id

Type: string

The unique identifier of the document.

CapacityUnitsConfiguration

Description

Specifies capacity units configured for your 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. Each capacity unit provides 0.5 queries per second and 40,000 queries per day.

StorageCapacityUnits

Required: Yes
Type: int

The amount of extra storage capacity for an index. Each capacity unit provides 150 Gb of storage space or 500,000 documents, whichever is reached first.

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

ClickTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix timestamp of the date and time that the result was clicked.

ResultId

Required: Yes
Type: string

The unique identifier of the search result that was clicked.

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 UpdateIndex operation.

ConflictException

Description

Members

Message

Type: string

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 UpdateIndex operation.

If you specify the AttachentFieldMappings parameter, 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 UpdateIndex operation.

DateFieldFormat

Type: string

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

IndexFieldName

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 UpdateIndex operation.

If you specify the BlogFieldMappings parameter, 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

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 AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

username - The user name or email address of a user with administrative privileges for the Confluence server.
password - The password associated with the user logging in to the Confluence server.

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 UpdateIndex operation.

If you specify the PageFieldMappings parameter, 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

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 ExcludeSpaces and the IncludeSpaces list, 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 IncludeSpaces and the ExcludeSpaces list, 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 UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, 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

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 AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

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.

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.

Name

Type: string

The name of the data source.

Status

Type: string

The status of the data source. When the status is ACTIVE the 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 Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

ErrorMessage

Type: string

If the Status field is set to ERROR, the ErrorMessage field 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 Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

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

Required: Yes
Type: string

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

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

DataSourceFieldName

Required: Yes
Type: string

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

DateFieldFormat

Type: string

The type of data stored in the column or attribute.

IndexFieldName

Required: Yes
Type: string

The name of the field in the index.

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 to use 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 Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

ContentType

Type: string

The file type of the document in the Blob field.

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.

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."

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

S3Prefix

Type: string

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

Description

Information about a document attribute

Members

DocumentAttributeKey

Type: string

The unique key for the document attribute.

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 DocumentAttributeKey provided 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

IndexedQuestionAnswersCount

Required: Yes
Type: int

The total number of FAQ questions and answers contained in the index.

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.

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 ACTIVE the 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 UpdateIndex operation.

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 AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

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, and DeleteIndex.

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 UpdateIndex operation.

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

Description

Members

Message

Type: string

JsonTokenTypeConfiguration

Description

Configuration information for the JSON token type.

Members

GroupAttributeField

Required: Yes
Type: string

The group attribute field.

UserNameAttributeField

Required: Yes
Type: string

The user name attribute field.

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.

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 DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

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 AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

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 the OneDriveUserS3Path field 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.

Name

Required: Yes
Type: string

The name of the user or group.

Type

Required: Yes
Type: string

The type of principal.

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Type

Type: string

The type of document.

Relevance

Description

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 DATE fields.

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 Freshness field on one DATE type field. Only applies to DATE fields.

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 RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

Only applies to LONG and DOUBLE fields.

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

RelevanceValue

Required: Yes
Type: string

Whether to document was relevant or not relevant to the search.

ResultId

Required: Yes
Type: string

The unique identifier of the search result that the user provided relevance feedback for.

ResourceAlreadyExistException

Description

Members

Message

Type: string

ResourceInUseException

Description

Members

Message

Type: string

ResourceNotFoundException

Description

Members

Message

Type: string

ResourceUnavailableException

Description

Members

Message

Type: string

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

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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

Bucket

Required: Yes
Type: string

The name of the S3 bucket that contains the file.

Key

Required: Yes
Type: string

The name of the file.

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 Body column.

DocumentTitleFieldName

Type: string

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

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_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

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 AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

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

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

ScoreConfidence

Type: string

A relative ranking for how well the response matches the query.

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 Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

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 Sortable set to true, Amazon Kendra returns an exception. The default is false.

ServerSideEncryptionConfiguration

Description

Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Members

KmsKeyId

Type: string

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

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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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

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 AWS Secret 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 LONDON release, use OTHERS.

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

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

Description

Members

Message

Type: string

SharePointConfiguration

Description

Provides configuration information for connecting to a Microsoft SharePoint data source.

Members

CrawlAttachments

Type: boolean

TRUE to 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

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

FieldMappings

Type: Array of DataSourceToIndexFieldMapping structures

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

InclusionPatterns

Type: Array of strings

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 AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

SharePointVersion

Required: Yes
Type: string

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

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 TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

VpcConfiguration

Type: DataSourceVpcConfiguration structure

Provides information for connecting to an Amazon VPC.

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 Sortable flag set to true.

You can also sort by any of the following built-in attributes:

_category
_created_at
_last_updated_at
_version
_view_count

SortOrder

Required: 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_quotes option when you set this field to DOUBLE_QUOTES.

TextDocumentStatistics

Description

Provides information about text documents indexed in an index.

Members

IndexedTextBytes

Required: Yes
Type: long (int|float)

The total size, in bytes, of the indexed documents.

IndexedTextDocumentsCount

Required: Yes
Type: int

The number of text documents indexed.

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 one or more thesauruses.

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

Description

Members

Message

Type: string

TimeRange

Description

Provides a range of time.

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The UNIX datetime of the end of the time range.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The UNIX datetime of the beginning of the time range.

UserContext

Description

Provides information about the user context for a Amazon Kendra index.

Members

Token

Type: string

The user context token. It must be a JWT or a JSON token.

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

Description

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWSKendraFrontendService 2019-02-03

Operation Summary

Paginators

Operations

BatchDeleteDocument

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchPutDocument

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDataSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFaq

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateIndex

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateThesaurus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteDataSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteFaq

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteIndex

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteThesaurus