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.
DeleteFaq ( array $params = [] )
Removes an FAQ from an index.
DeleteIndex ( array $params = [] )
Deletes an existing Amazon Kendra index.
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
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.
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.
UpdateDataSource ( array $params = [] )
Updates an existing Amazon Kendra data source.
UpdateIndex ( array $params = [] )
Updates an existing Amazon Kendra 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 releated to the processing of the batch are sent to you CloudWatch log.

Parameter Syntax

$result = $client->batchDeleteDocument([
    'DocumentIdList' => ['<string>', ...], // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Members

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.

Each document is limited to 5 Mb, the total size of the list is limited to 50 Mb.

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.

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, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.

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([
    'Configuration' => [ // 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
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        'S3Configuration' => [
            'AccessControlListConfiguration' => [
                'KeyPath' => '<string>',
            ],
            'BucketName' => '<string>', // REQUIRED
            'DocumentsMetadataConfiguration' => [
                'S3Prefix' => '<string>',
            ],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPrefixes' => ['<string>', ...],
        ],
        'SharePointConfiguration' => [
            'CrawlAttachments' => true || false,
            'DocumentTitleFieldName' => '<string>',
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'SecretArn' => '<string>', // REQUIRED
            'SharePointVersion' => 'SHAREPOINT_ONLINE', // REQUIRED
            'Urls' => ['<string>', ...], // REQUIRED
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'Description' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Schedule' => '<string>',
    'Type' => 'S3|SHAREPOINT|DATABASE', // REQUIRED
]);

Parameter Details

Members

Configuration

Required: Yes
Type: DataSourceConfiguration structure

The connector configuration information that is required to access the repository.

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

Required: Yes
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.

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.

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([
    'Description' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'S3Path' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'Key' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Description

Type: string

A description of the FAQ.

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.

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 . 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 operation or using one of the supported data sources.

Parameter Syntax

$result = $client->createIndex([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'ServerSideEncryptionConfiguration' => [
        'KmsKeyId' => '<string>',
    ],
]);

Parameter Details

Members

Description

Type: string

A description for the index.

Name

Required: Yes
Type: string

The name for the new index.

RoleArn

Required: Yes
Type: string

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

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

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

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' => [
        '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',
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        'S3Configuration' => [
            'AccessControlListConfiguration' => [
                'KeyPath' => '<string>',
            ],
            'BucketName' => '<string>',
            'DocumentsMetadataConfiguration' => [
                'S3Prefix' => '<string>',
            ],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPrefixes' => ['<string>', ...],
        ],
        'SharePointConfiguration' => [
            'CrawlAttachments' => true || false,
            'DocumentTitleFieldName' => '<string>',
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'SecretArn' => '<string>',
            'SharePointVersion' => 'SHAREPOINT_ONLINE',
            'Urls' => ['<string>', ...],
            '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',
    '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>',
    '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.

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

[
    '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,
            ],
            'Type' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE',
        ],
        // ...
    ],
    'ErrorMessage' => '<string>',
    'Id' => '<string>',
    'IndexStatistics' => [
        'FaqStatistics' => [
            'IndexedQuestionAnswersCount' => <integer>,
        ],
        'TextDocumentStatistics' => [
            'IndexedTextDocumentsCount' => <integer>,
        ],
    ],
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'ServerSideEncryptionConfiguration' => [
        'KmsKeyId' => '<string>',
    ],
    'Status' => 'CREATING|ACTIVE|DELETING|FAILED|SYSTEM_UPDATING',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members

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.

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.

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',
]);

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>',
            'StartTime' => <DateTime>,
            'Status' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED',
        ],
        // ...
    ],
    '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',
            '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>,
            '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>,
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATING|ACTIVE|DELETING|FAILED|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

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.

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
            // ...
        ],
    ],
    'Facets' => [
        [
            'DocumentAttributeKey' => '<string>',
        ],
        // ...
    ],
    'IndexId' => '<string>', // REQUIRED
    'PageNumber' => <integer>,
    'PageSize' => <integer>,
    'QueryResultTypeFilter' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
    'QueryText' => '<string>', // REQUIRED
    'RequestedDocumentAttributes' => ['<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.

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

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.

Result Syntax

[
    'FacetResults' => [
        [
            'DocumentAttributeKey' => '<string>',
            'DocumentAttributeValueCountPairs' => [
                [
                    'Count' => <integer>,
                    'DocumentAttributeValue' => [
                        'DateValue' => <DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'QueryId' => '<string>',
    'ResultItems' => [
        [
            'AdditionalAttributes' => [
                [
                    'Key' => '<string>',
                    'Value' => [
                        'TextWithHighlightsValue' => [
                            'Highlights' => [
                                [
                                    'BeginOffset' => <integer>,
                                    'EndOffset' => <integer>,
                                    'TopAnswer' => true || false,
                                ],
                                // ...
                            ],
                            '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,
                    ],
                    // ...
                ],
                'Text' => '<string>',
            ],
            'DocumentId' => '<string>',
            'DocumentTitle' => [
                'Highlights' => [
                    [
                        'BeginOffset' => <integer>,
                        'EndOffset' => <integer>,
                        'TopAnswer' => true || false,
                    ],
                    // ...
                ],
                'Text' => '<string>',
            ],
            'DocumentURI' => '<string>',
            'Id' => '<string>',
            '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 number of items returned by the search. Use this to determine when you have requested the last set of results.

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

UpdateDataSource

$result = $client->updateDataSource([/* ... */]);
$promise = $client->updateDataSourceAsync([/* ... */]);

Updates an existing Amazon Kendra data source.

Parameter Syntax

$result = $client->updateDataSource([
    'Configuration' => [
        '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
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        'S3Configuration' => [
            'AccessControlListConfiguration' => [
                'KeyPath' => '<string>',
            ],
            'BucketName' => '<string>', // REQUIRED
            'DocumentsMetadataConfiguration' => [
                'S3Prefix' => '<string>',
            ],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPrefixes' => ['<string>', ...],
        ],
        'SharePointConfiguration' => [
            'CrawlAttachments' => true || false,
            'DocumentTitleFieldName' => '<string>',
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'SecretArn' => '<string>', // REQUIRED
            'SharePointVersion' => 'SHAREPOINT_ONLINE', // REQUIRED
            'Urls' => ['<string>', ...], // REQUIRED
            '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([
    '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,
            ],
            'Type' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE', // REQUIRED
        ],
        // ...
    ],
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>',
    'RoleArn' => '<string>',
]);

Parameter Details

Members

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.

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.

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

Members

Key

Required: Yes
Type: string

Value

Required: Yes
Type: AdditionalResultAttributeValue structure

ValueType

Required: Yes
Type: string

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.

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.

ContainsAny

Type: DocumentAttribute structure

Returns true when a document contains any of the specified document attributes.

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.

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 data 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

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

DatabaseConfiguration

Type: DatabaseConfiguration structure

Provides information necessary to create a connector for a database.

S3Configuration

Type: S3DataSourceConfiguration structure

Provides information to create a connector for a document repository in an Amazon S3 bucket.

SharePointConfiguration

Type: SharePointConfiguration structure

Provides information necessary to create a connector for a Microsoft SharePoint site.

DataSourceSummary

Description

Summary information for a Amazon Kendra data source. Returned in a call to .

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

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.

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.

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 as a base-64 encoded string.

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 value expressed as seconds from the Unix epoch.

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.

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

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.

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.

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.

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.

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

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

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.

Id

Type: string

The unique identifier for the query result.

Type

Type: string

The type of document.

Relevance

Description

Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Members

Duration

Type: string

Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

Only applies to 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.

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

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.

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.

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.

DocumentTitleFieldName

Type: string

The Microsoft SharePoint attribute field that contains the title of the 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 operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

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.

VpcConfiguration

Type: DataSourceVpcConfiguration structure

Provides information for connecting to an Amazon VPC.

TextDocumentStatistics

Description

Provides information about text documents indexed in an index.

Members

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.

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.

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

DeleteFaq

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteIndex

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeDataSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeFaq

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors