AssociateEntitiesToExperience

$result = $client->associateEntitiesToExperience([/* ... */]);
$promise = $client->associateEntitiesToExperienceAsync([/* ... */]);

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->associateEntitiesToExperience([
    'EntityList' => [ // REQUIRED
        [
            'EntityId' => '<string>', // REQUIRED
            'EntityType' => 'USER|GROUP', // REQUIRED
        ],
        // ...
    ],
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FailedEntityList' => [
        [
            'EntityId' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ResourceAlreadyExistException:

The resource you want to use already exists. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

AssociatePersonasToEntities

$result = $client->associatePersonasToEntities([/* ... */]);
$promise = $client->associatePersonasToEntitiesAsync([/* ... */]);

Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->associatePersonasToEntities([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
    'Personas' => [ // REQUIRED
        [
            'EntityId' => '<string>', // REQUIRED
            'Persona' => 'OWNER|VIEWER', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FailedEntityList' => [
        [
            'EntityId' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ResourceAlreadyExistException:

The resource you want to use already exists. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

BatchDeleteDocument

$result = $client->batchDeleteDocument([/* ... */]);
$promise = $client->batchDeleteDocumentAsync([/* ... */]);

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FailedDocuments' => [
        [
            'DataSourceId' => '<string>',
            'ErrorCode' => 'InternalError|InvalidRequest',
            'ErrorMessage' => '<string>',
            'Id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

BatchDeleteFeaturedResultsSet

$result = $client->batchDeleteFeaturedResultsSet([/* ... */]);
$promise = $client->batchDeleteFeaturedResultsSetAsync([/* ... */]);

Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => 'InternalError|InvalidRequest',
            'ErrorMessage' => '<string>',
            'Id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

BatchGetDocumentStatus

$result = $client->batchGetDocumentStatus([/* ... */]);
$promise = $client->batchGetDocumentStatusAsync([/* ... */]);

Returns the indexing status for one or more documents submitted with the BatchPutDocument API.

When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Parameter Syntax

$result = $client->batchGetDocumentStatus([
    'DocumentInfoList' => [ // REQUIRED
        [
            'Attributes' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => [ // REQUIRED
                        'DateValue' => <integer || string || DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'DocumentId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DocumentStatusList' => [
        [
            'DocumentId' => '<string>',
            'DocumentStatus' => 'NOT_FOUND|PROCESSING|INDEXED|UPDATED|FAILED|UPDATE_FAILED',
            'FailureCode' => '<string>',
            'FailureReason' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'DataSourceId' => '<string>',
            'DocumentId' => '<string>',
            'ErrorCode' => 'InternalError|InvalidRequest',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

BatchPutDocument

$result = $client->batchPutDocument([/* ... */]);
$promise = $client->batchPutDocumentAsync([/* ... */]);

Adds one or more documents to an index.

The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents.

For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.

Parameter Syntax

$result = $client->batchPutDocument([
    'CustomDocumentEnrichmentConfiguration' => [
        'InlineConfigurations' => [
            [
                'Condition' => [
                    'ConditionDocumentAttributeKey' => '<string>', // REQUIRED
                    'ConditionOnValue' => [
                        'DateValue' => <integer || string || DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith', // REQUIRED
                ],
                'DocumentContentDeletion' => true || false,
                'Target' => [
                    'TargetDocumentAttributeKey' => '<string>',
                    'TargetDocumentAttributeValue' => [
                        'DateValue' => <integer || string || DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'TargetDocumentAttributeValueDeletion' => true || false,
                ],
            ],
            // ...
        ],
        'PostExtractionHookConfiguration' => [
            'InvocationCondition' => [
                'ConditionDocumentAttributeKey' => '<string>', // REQUIRED
                'ConditionOnValue' => [
                    'DateValue' => <integer || string || DateTime>,
                    'LongValue' => <integer>,
                    'StringListValue' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith', // REQUIRED
            ],
            'LambdaArn' => '<string>', // REQUIRED
            'S3Bucket' => '<string>', // REQUIRED
        ],
        'PreExtractionHookConfiguration' => [
            'InvocationCondition' => [
                'ConditionDocumentAttributeKey' => '<string>', // REQUIRED
                'ConditionOnValue' => [
                    'DateValue' => <integer || string || DateTime>,
                    'LongValue' => <integer>,
                    'StringListValue' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith', // REQUIRED
            ],
            'LambdaArn' => '<string>', // REQUIRED
            'S3Bucket' => '<string>', // REQUIRED
        ],
        'RoleArn' => '<string>',
    ],
    'Documents' => [ // REQUIRED
        [
            'AccessControlConfigurationId' => '<string>',
            'AccessControlList' => [
                [
                    'Access' => 'ALLOW|DENY', // REQUIRED
                    'DataSourceId' => '<string>',
                    'Name' => '<string>', // REQUIRED
                    'Type' => 'USER|GROUP', // REQUIRED
                ],
                // ...
            ],
            'Attributes' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => [ // REQUIRED
                        'DateValue' => <integer || string || DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'Blob' => <string || resource || Psr\Http\Message\StreamInterface>,
            'ContentType' => 'PDF|HTML|MS_WORD|PLAIN_TEXT|PPT|RTF|XML|XSLT|MS_EXCEL|CSV|JSON|MD',
            'HierarchicalAccessControlList' => [
                [
                    'PrincipalList' => [ // REQUIRED
                        [
                            'Access' => 'ALLOW|DENY', // REQUIRED
                            'DataSourceId' => '<string>',
                            'Name' => '<string>', // REQUIRED
                            'Type' => 'USER|GROUP', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Id' => '<string>', // REQUIRED
            'S3Path' => [
                'Bucket' => '<string>', // REQUIRED
                'Key' => '<string>', // REQUIRED
            ],
            'Title' => '<string>',
        ],
        // ...
    ],
    'IndexId' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FailedDocuments' => [
        [
            'DataSourceId' => '<string>',
            'ErrorCode' => 'InternalError|InvalidRequest',
            'ErrorMessage' => '<string>',
            'Id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ClearQuerySuggestions

$result = $client->clearQuerySuggestions([/* ... */]);
$promise = $client->clearQuerySuggestionsAsync([/* ... */]);

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateAccessControlConfiguration

$result = $client->createAccessControlConfiguration([/* ... */]);
$promise = $client->createAccessControlConfigurationAsync([/* ... */]);

Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

Parameter Syntax

$result = $client->createAccessControlConfiguration([
    'AccessControlList' => [
        [
            'Access' => 'ALLOW|DENY', // REQUIRED
            'DataSourceId' => '<string>',
            'Name' => '<string>', // REQUIRED
            'Type' => 'USER|GROUP', // REQUIRED
        ],
        // ...
    ],
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'HierarchicalAccessControlList' => [
        [
            'PrincipalList' => [ // REQUIRED
                [
                    'Access' => 'ALLOW|DENY', // REQUIRED
                    'DataSourceId' => '<string>',
                    'Name' => '<string>', // REQUIRED
                    'Type' => 'USER|GROUP', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'IndexId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateDataSource

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

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

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

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

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Parameter Syntax

$result = $client->createDataSource([
    'ClientToken' => '<string>',
    'Configuration' => [
        'AlfrescoConfiguration' => [
            'BlogFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CrawlComments' => true || false,
            'CrawlSystemFolders' => true || false,
            'DocumentLibraryFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'EntityFilter' => ['<string>', ...],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPatterns' => ['<string>', ...],
            'SecretArn' => '<string>', // REQUIRED
            'SiteId' => '<string>', // REQUIRED
            'SiteUrl' => '<string>', // REQUIRED
            'SslCertificateS3Path' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'Key' => '<string>', // REQUIRED
            ],
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
            'WikiFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'BoxConfiguration' => [
            'CommentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CrawlComments' => true || false,
            'CrawlTasks' => true || false,
            'CrawlWebLinks' => true || false,
            'EnterpriseId' => '<string>', // REQUIRED
            'ExclusionPatterns' => ['<string>', ...],
            'FileFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'SecretArn' => '<string>', // REQUIRED
            'TaskFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
            'WebLinkFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        '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,
            ],
            'AuthenticationType' => 'HTTP_BASIC|PAT',
            '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>',
                    ],
                    // ...
                ],
            ],
            'ProxyConfiguration' => [
                'Credentials' => '<string>',
                'Host' => '<string>', // REQUIRED
                'Port' => <integer>, // REQUIRED
            ],
            '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
            ],
        ],
        'FsxConfiguration' => [
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'FileSystemId' => '<string>', // REQUIRED
            'FileSystemType' => 'WINDOWS', // REQUIRED
            'InclusionPatterns' => ['<string>', ...],
            'SecretArn' => '<string>',
            'VpcConfiguration' => [ // REQUIRED
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        'GitHubConfiguration' => [
            'ExclusionFileNamePatterns' => ['<string>', ...],
            'ExclusionFileTypePatterns' => ['<string>', ...],
            'ExclusionFolderNamePatterns' => ['<string>', ...],
            'GitHubCommitConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubDocumentCrawlProperties' => [
                'CrawlIssue' => true || false,
                'CrawlIssueComment' => true || false,
                'CrawlIssueCommentAttachment' => true || false,
                'CrawlPullRequest' => true || false,
                'CrawlPullRequestComment' => true || false,
                'CrawlPullRequestCommentAttachment' => true || false,
                'CrawlRepositoryDocuments' => true || false,
            ],
            'GitHubIssueAttachmentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubIssueCommentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubIssueDocumentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubPullRequestCommentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubPullRequestDocumentAttachmentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubPullRequestDocumentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'GitHubRepositoryConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'InclusionFileNamePatterns' => ['<string>', ...],
            'InclusionFileTypePatterns' => ['<string>', ...],
            'InclusionFolderNamePatterns' => ['<string>', ...],
            'OnPremiseConfiguration' => [
                'HostUrl' => '<string>', // REQUIRED
                'OrganizationName' => '<string>', // REQUIRED
                'SslCertificateS3Path' => [ // REQUIRED
                    'Bucket' => '<string>', // REQUIRED
                    'Key' => '<string>', // REQUIRED
                ],
            ],
            'RepositoryFilter' => ['<string>', ...],
            'SaaSConfiguration' => [
                'HostUrl' => '<string>', // REQUIRED
                'OrganizationName' => '<string>', // REQUIRED
            ],
            'SecretArn' => '<string>', // REQUIRED
            'Type' => 'SAAS|ON_PREMISE',
            'UseChangeLog' => true || false,
            '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
        ],
        'JiraConfiguration' => [
            'AttachmentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CommentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPatterns' => ['<string>', ...],
            'IssueFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'IssueSubEntityFilter' => ['<string>', ...],
            'IssueType' => ['<string>', ...],
            'JiraAccountUrl' => '<string>', // REQUIRED
            'Project' => ['<string>', ...],
            'ProjectFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'SecretArn' => '<string>', // REQUIRED
            'Status' => ['<string>', ...],
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
            'WorkLogFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<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
        ],
        'QuipConfiguration' => [
            'AttachmentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'CrawlAttachments' => true || false,
            'CrawlChatRooms' => true || false,
            'CrawlFileComments' => true || false,
            'Domain' => '<string>', // REQUIRED
            'ExclusionPatterns' => ['<string>', ...],
            'FolderIds' => ['<string>', ...],
            'InclusionPatterns' => ['<string>', ...],
            'MessageFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'SecretArn' => '<string>', // REQUIRED
            'ThreadFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<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' => [
            'AuthenticationType' => 'HTTP_BASIC|OAUTH2',
            'CrawlAttachments' => true || false,
            'DisableLocalGroups' => true || false,
            'DocumentTitleFieldName' => '<string>',
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'ProxyConfiguration' => [
                'Credentials' => '<string>',
                'Host' => '<string>', // REQUIRED
                'Port' => <integer>, // REQUIRED
            ],
            'SecretArn' => '<string>', // REQUIRED
            'SharePointVersion' => 'SHAREPOINT_2013|SHAREPOINT_2016|SHAREPOINT_ONLINE|SHAREPOINT_2019', // REQUIRED
            'SslCertificateS3Path' => [
                'Bucket' => '<string>', // REQUIRED
                'Key' => '<string>', // REQUIRED
            ],
            'Urls' => ['<string>', ...], // REQUIRED
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        'SlackConfiguration' => [
            'CrawlBotMessage' => true || false,
            'ExcludeArchived' => true || false,
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'LookBackPeriod' => <integer>,
            'PrivateChannelFilter' => ['<string>', ...],
            'PublicChannelFilter' => ['<string>', ...],
            'SecretArn' => '<string>', // REQUIRED
            'SinceCrawlDate' => '<string>', // REQUIRED
            'SlackEntityList' => ['<string>', ...], // REQUIRED
            'TeamId' => '<string>', // REQUIRED
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        'TemplateConfiguration' => [
            'Template' => [
            ],
        ],
        'WebCrawlerConfiguration' => [
            'AuthenticationConfiguration' => [
                'BasicAuthentication' => [
                    [
                        'Credentials' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            'CrawlDepth' => <integer>,
            'MaxContentSizePerPageInMegaBytes' => <float>,
            'MaxLinksPerPage' => <integer>,
            'MaxUrlsPerMinuteCrawlRate' => <integer>,
            'ProxyConfiguration' => [
                'Credentials' => '<string>',
                'Host' => '<string>', // REQUIRED
                'Port' => <integer>, // REQUIRED
            ],
            'UrlExclusionPatterns' => ['<string>', ...],
            'UrlInclusionPatterns' => ['<string>', ...],
            'Urls' => [ // REQUIRED
                'SeedUrlConfiguration' => [
                    'SeedUrls' => ['<string>', ...], // REQUIRED
                    'WebCrawlerMode' => 'HOST_ONLY|SUBDOMAINS|EVERYTHING',
                ],
                'SiteMapsConfiguration' => [
                    'SiteMaps' => ['<string>', ...], // REQUIRED
                ],
            ],
        ],
        'WorkDocsConfiguration' => [
            'CrawlComments' => true || false,
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>', // REQUIRED
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'OrganizationId' => '<string>', // REQUIRED
            'UseChangeLog' => true || false,
        ],
    ],
    'CustomDocumentEnrichmentConfiguration' => [
        'InlineConfigurations' => [
            [
                'Condition' => [
                    'ConditionDocumentAttributeKey' => '<string>', // REQUIRED
                    'ConditionOnValue' => [
                        'DateValue' => <integer || string || DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith', // REQUIRED
                ],
                'DocumentContentDeletion' => true || false,
                'Target' => [
                    'TargetDocumentAttributeKey' => '<string>',
                    'TargetDocumentAttributeValue' => [
                        'DateValue' => <integer || string || DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'TargetDocumentAttributeValueDeletion' => true || false,
                ],
            ],
            // ...
        ],
        'PostExtractionHookConfiguration' => [
            'InvocationCondition' => [
                'ConditionDocumentAttributeKey' => '<string>', // REQUIRED
                'ConditionOnValue' => [
                    'DateValue' => <integer || string || DateTime>,
                    'LongValue' => <integer>,
                    'StringListValue' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith', // REQUIRED
            ],
            'LambdaArn' => '<string>', // REQUIRED
            'S3Bucket' => '<string>', // REQUIRED
        ],
        'PreExtractionHookConfiguration' => [
            'InvocationCondition' => [
                'ConditionDocumentAttributeKey' => '<string>', // REQUIRED
                'ConditionOnValue' => [
                    'DateValue' => <integer || string || DateTime>,
                    'LongValue' => <integer>,
                    'StringListValue' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith', // REQUIRED
            ],
            'LambdaArn' => '<string>', // REQUIRED
            'S3Bucket' => '<string>', // REQUIRED
        ],
        'RoleArn' => '<string>',
    ],
    'Description' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'LanguageCode' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
    'Schedule' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE|WEBCRAWLER|WORKDOCS|FSX|SLACK|BOX|QUIP|JIRA|GITHUB|ALFRESCO|TEMPLATE', // REQUIRED
    'VpcConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ResourceAlreadyExistException:

The resource you want to use already exists. Please check you have provided the correct resource and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateExperience

$result = $client->createExperience([/* ... */]);
$promise = $client->createExperienceAsync([/* ... */]);

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.

Parameter Syntax

$result = $client->createExperience([
    'ClientToken' => '<string>',
    'Configuration' => [
        'ContentSourceConfiguration' => [
            'DataSourceIds' => ['<string>', ...],
            'DirectPutContent' => true || false,
            'FaqIds' => ['<string>', ...],
        ],
        'UserIdentityConfiguration' => [
            'IdentityAttributeName' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateFaq

$result = $client->createFaq([/* ... */]);
$promise = $client->createFaqAsync([/* ... */]);

Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

Adding FAQs to an index is an asynchronous operation.

For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.

Parameter Syntax

$result = $client->createFaq([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
    'IndexId' => '<string>', // REQUIRED
    'LanguageCode' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'S3Path' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'Key' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateFeaturedResultsSet

$result = $client->createFeaturedResultsSet([/* ... */]);
$promise = $client->createFeaturedResultsSetAsync([/* ... */]);

Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.

You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.

Parameter Syntax

$result = $client->createFeaturedResultsSet([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'FeaturedDocuments' => [
        [
            'Id' => '<string>',
        ],
        // ...
    ],
    'FeaturedResultsSetName' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
    'QueryTexts' => ['<string>', ...],
    'Status' => 'ACTIVE|INACTIVE',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FeaturedResultsSet' => [
        'CreationTimestamp' => <integer>,
        'Description' => '<string>',
        'FeaturedDocuments' => [
            [
                'Id' => '<string>',
            ],
            // ...
        ],
        'FeaturedResultsSetId' => '<string>',
        'FeaturedResultsSetName' => '<string>',
        'LastUpdatedTimestamp' => <integer>,
        'QueryTexts' => ['<string>', ...],
        'Status' => 'ACTIVE|INACTIVE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

FeaturedResultsConflictException:

An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateIndex

$result = $client->createIndex([/* ... */]);
$promise = $client->createIndexAsync([/* ... */]);

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or using one of the supported data sources.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Parameter Syntax

$result = $client->createIndex([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Edition' => 'DEVELOPER_EDITION|ENTERPRISE_EDITION|GEN_AI_ENTERPRISE_EDITION',
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'ServerSideEncryptionConfiguration' => [
        'KmsKeyId' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserContextPolicy' => 'ATTRIBUTE_FILTER|USER_TOKEN',
    'UserGroupResolutionConfiguration' => [
        'UserGroupResolutionMode' => 'AWS_SSO|NONE', // REQUIRED
    ],
    'UserTokenConfigurations' => [
        [
            'JsonTokenTypeConfiguration' => [
                'GroupAttributeField' => '<string>', // REQUIRED
                'UserNameAttributeField' => '<string>', // REQUIRED
            ],
            'JwtTokenTypeConfiguration' => [
                'ClaimRegex' => '<string>',
                'GroupAttributeField' => '<string>',
                'Issuer' => '<string>',
                'KeyLocation' => 'URL|SECRET_MANAGER', // REQUIRED
                'SecretManagerArn' => '<string>',
                'URL' => '<string>',
                'UserNameAttributeField' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceAlreadyExistException:

The resource you want to use already exists. Please check you have provided the correct resource and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateQuerySuggestionsBlockList

$result = $client->createQuerySuggestionsBlockList([/* ... */]);
$promise = $client->createQuerySuggestionsBlockListAsync([/* ... */]);

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.

Parameter Syntax

$result = $client->createQuerySuggestionsBlockList([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'SourceS3Path' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'Key' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

CreateThesaurus

$result = $client->createThesaurus([/* ... */]);
$promise = $client->createThesaurusAsync([/* ... */]);

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.

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

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteAccessControlConfiguration

$result = $client->deleteAccessControlConfiguration([/* ... */]);
$promise = $client->deleteAccessControlConfigurationAsync([/* ... */]);

Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameter Syntax

$result = $client->deleteAccessControlConfiguration([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteDataSource

$result = $client->deleteDataSource([/* ... */]);
$promise = $client->deleteDataSourceAsync([/* ... */]);

Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.

Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.

Parameter Syntax

$result = $client->deleteDataSource([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteExperience

$result = $client->deleteExperience([/* ... */]);
$promise = $client->deleteExperienceAsync([/* ... */]);

Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->deleteExperience([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteFaq

$result = $client->deleteFaq([/* ... */]);
$promise = $client->deleteFaqAsync([/* ... */]);

Removes a FAQ from an index.

Parameter Syntax

$result = $client->deleteFaq([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteIndex

$result = $client->deleteIndex([/* ... */]);
$promise = $client->deleteIndexAsync([/* ... */]);

Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.

Parameter Syntax

$result = $client->deleteIndex([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeletePrincipalMapping

$result = $client->deletePrincipalMapping([/* ... */]);
$promise = $client->deletePrincipalMappingAsync([/* ... */]);

Deletes a group so that all users that belong to the group can no longer access documents only available to that group.

For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->deletePrincipalMapping([
    'DataSourceId' => '<string>',
    'GroupId' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
    'OrderingId' => <integer>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteQuerySuggestionsBlockList

$result = $client->deleteQuerySuggestionsBlockList([/* ... */]);
$promise = $client->deleteQuerySuggestionsBlockListAsync([/* ... */]);

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->deleteQuerySuggestionsBlockList([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DeleteThesaurus

$result = $client->deleteThesaurus([/* ... */]);
$promise = $client->deleteThesaurusAsync([/* ... */]);

Deletes an Amazon Kendra thesaurus.

Parameter Syntax

$result = $client->deleteThesaurus([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeAccessControlConfiguration

$result = $client->describeAccessControlConfiguration([/* ... */]);
$promise = $client->describeAccessControlConfigurationAsync([/* ... */]);

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameter Syntax

$result = $client->describeAccessControlConfiguration([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessControlList' => [
        [
            'Access' => 'ALLOW|DENY',
            'DataSourceId' => '<string>',
            'Name' => '<string>',
            'Type' => 'USER|GROUP',
        ],
        // ...
    ],
    'Description' => '<string>',
    'ErrorMessage' => '<string>',
    'HierarchicalAccessControlList' => [
        [
            'PrincipalList' => [
                [
                    'Access' => 'ALLOW|DENY',
                    'DataSourceId' => '<string>',
                    'Name' => '<string>',
                    'Type' => 'USER|GROUP',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Name' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeDataSource

$result = $client->describeDataSource([/* ... */]);
$promise = $client->describeDataSourceAsync([/* ... */]);

Gets information about an Amazon Kendra data source connector.

Parameter Syntax

$result = $client->describeDataSource([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Configuration' => [
        'AlfrescoConfiguration' => [
            'BlogFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'CrawlComments' => true || false,
            'CrawlSystemFolders' => true || false,
            'DocumentLibraryFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'EntityFilter' => ['<string>', ...],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPatterns' => ['<string>', ...],
            'SecretArn' => '<string>',
            'SiteId' => '<string>',
            'SiteUrl' => '<string>',
            'SslCertificateS3Path' => [
                'Bucket' => '<string>',
                'Key' => '<string>',
            ],
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
            'WikiFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
        ],
        'BoxConfiguration' => [
            'CommentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'CrawlComments' => true || false,
            'CrawlTasks' => true || false,
            'CrawlWebLinks' => true || false,
            'EnterpriseId' => '<string>',
            'ExclusionPatterns' => ['<string>', ...],
            'FileFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'SecretArn' => '<string>',
            'TaskFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
            'WebLinkFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
        ],
        '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,
            ],
            'AuthenticationType' => 'HTTP_BASIC|PAT',
            '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>',
                    ],
                    // ...
                ],
            ],
            'ProxyConfiguration' => [
                'Credentials' => '<string>',
                'Host' => '<string>',
                'Port' => <integer>,
            ],
            '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>', ...],
            ],
        ],
        'FsxConfiguration' => [
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS',
            'InclusionPatterns' => ['<string>', ...],
            'SecretArn' => '<string>',
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        'GitHubConfiguration' => [
            'ExclusionFileNamePatterns' => ['<string>', ...],
            'ExclusionFileTypePatterns' => ['<string>', ...],
            'ExclusionFolderNamePatterns' => ['<string>', ...],
            'GitHubCommitConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubDocumentCrawlProperties' => [
                'CrawlIssue' => true || false,
                'CrawlIssueComment' => true || false,
                'CrawlIssueCommentAttachment' => true || false,
                'CrawlPullRequest' => true || false,
                'CrawlPullRequestComment' => true || false,
                'CrawlPullRequestCommentAttachment' => true || false,
                'CrawlRepositoryDocuments' => true || false,
            ],
            'GitHubIssueAttachmentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubIssueCommentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubIssueDocumentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubPullRequestCommentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubPullRequestDocumentAttachmentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubPullRequestDocumentConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'GitHubRepositoryConfigurationFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'InclusionFileNamePatterns' => ['<string>', ...],
            'InclusionFileTypePatterns' => ['<string>', ...],
            'InclusionFolderNamePatterns' => ['<string>', ...],
            'OnPremiseConfiguration' => [
                'HostUrl' => '<string>',
                'OrganizationName' => '<string>',
                'SslCertificateS3Path' => [
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'RepositoryFilter' => ['<string>', ...],
            'SaaSConfiguration' => [
                'HostUrl' => '<string>',
                'OrganizationName' => '<string>',
            ],
            'SecretArn' => '<string>',
            'Type' => 'SAAS|ON_PREMISE',
            'UseChangeLog' => true || false,
            '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>',
        ],
        'JiraConfiguration' => [
            'AttachmentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'CommentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'ExclusionPatterns' => ['<string>', ...],
            'InclusionPatterns' => ['<string>', ...],
            'IssueFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'IssueSubEntityFilter' => ['<string>', ...],
            'IssueType' => ['<string>', ...],
            'JiraAccountUrl' => '<string>',
            'Project' => ['<string>', ...],
            'ProjectFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'SecretArn' => '<string>',
            'Status' => ['<string>', ...],
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
            'WorkLogFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<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>',
        ],
        'QuipConfiguration' => [
            'AttachmentFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'CrawlAttachments' => true || false,
            'CrawlChatRooms' => true || false,
            'CrawlFileComments' => true || false,
            'Domain' => '<string>',
            'ExclusionPatterns' => ['<string>', ...],
            'FolderIds' => ['<string>', ...],
            'InclusionPatterns' => ['<string>', ...],
            'MessageFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'SecretArn' => '<string>',
            'ThreadFieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<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' => [
            'AuthenticationType' => 'HTTP_BASIC|OAUTH2',
            'CrawlAttachments' => true || false,
            'DisableLocalGroups' => true || false,
            'DocumentTitleFieldName' => '<string>',
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'ProxyConfiguration' => [
                'Credentials' => '<string>',
                'Host' => '<string>',
                'Port' => <integer>,
            ],
            'SecretArn' => '<string>',
            'SharePointVersion' => 'SHAREPOINT_2013|SHAREPOINT_2016|SHAREPOINT_ONLINE|SHAREPOINT_2019',
            'SslCertificateS3Path' => [
                'Bucket' => '<string>',
                'Key' => '<string>',
            ],
            'Urls' => ['<string>', ...],
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        'SlackConfiguration' => [
            'CrawlBotMessage' => true || false,
            'ExcludeArchived' => true || false,
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'LookBackPeriod' => <integer>,
            'PrivateChannelFilter' => ['<string>', ...],
            'PublicChannelFilter' => ['<string>', ...],
            'SecretArn' => '<string>',
            'SinceCrawlDate' => '<string>',
            'SlackEntityList' => ['<string>', ...],
            'TeamId' => '<string>',
            'UseChangeLog' => true || false,
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        'TemplateConfiguration' => [
            'Template' => [
            ],
        ],
        'WebCrawlerConfiguration' => [
            'AuthenticationConfiguration' => [
                'BasicAuthentication' => [
                    [
                        'Credentials' => '<string>',
                        'Host' => '<string>',
                        'Port' => <integer>,
                    ],
                    // ...
                ],
            ],
            'CrawlDepth' => <integer>,
            'MaxContentSizePerPageInMegaBytes' => <float>,
            'MaxLinksPerPage' => <integer>,
            'MaxUrlsPerMinuteCrawlRate' => <integer>,
            'ProxyConfiguration' => [
                'Credentials' => '<string>',
                'Host' => '<string>',
                'Port' => <integer>,
            ],
            'UrlExclusionPatterns' => ['<string>', ...],
            'UrlInclusionPatterns' => ['<string>', ...],
            'Urls' => [
                'SeedUrlConfiguration' => [
                    'SeedUrls' => ['<string>', ...],
                    'WebCrawlerMode' => 'HOST_ONLY|SUBDOMAINS|EVERYTHING',
                ],
                'SiteMapsConfiguration' => [
                    'SiteMaps' => ['<string>', ...],
                ],
            ],
        ],
        'WorkDocsConfiguration' => [
            'CrawlComments' => true || false,
            'ExclusionPatterns' => ['<string>', ...],
            'FieldMappings' => [
                [
                    'DataSourceFieldName' => '<string>',
                    'DateFieldFormat' => '<string>',
                    'IndexFieldName' => '<string>',
                ],
                // ...
            ],
            'InclusionPatterns' => ['<string>', ...],
            'OrganizationId' => '<string>',
            'UseChangeLog' => true || false,
        ],
    ],
    'CreatedAt' => <DateTime>,
    'CustomDocumentEnrichmentConfiguration' => [
        'InlineConfigurations' => [
            [
                'Condition' => [
                    'ConditionDocumentAttributeKey' => '<string>',
                    'ConditionOnValue' => [
                        'DateValue' => <DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith',
                ],
                'DocumentContentDeletion' => true || false,
                'Target' => [
                    'TargetDocumentAttributeKey' => '<string>',
                    'TargetDocumentAttributeValue' => [
                        'DateValue' => <DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'TargetDocumentAttributeValueDeletion' => true || false,
                ],
            ],
            // ...
        ],
        'PostExtractionHookConfiguration' => [
            'InvocationCondition' => [
                'ConditionDocumentAttributeKey' => '<string>',
                'ConditionOnValue' => [
                    'DateValue' => <DateTime>,
                    'LongValue' => <integer>,
                    'StringListValue' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith',
            ],
            'LambdaArn' => '<string>',
            'S3Bucket' => '<string>',
        ],
        'PreExtractionHookConfiguration' => [
            'InvocationCondition' => [
                'ConditionDocumentAttributeKey' => '<string>',
                'ConditionOnValue' => [
                    'DateValue' => <DateTime>,
                    'LongValue' => <integer>,
                    'StringListValue' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                'Operator' => 'GreaterThan|GreaterThanOrEquals|LessThan|LessThanOrEquals|Equals|NotEquals|Contains|NotContains|Exists|NotExists|BeginsWith',
            ],
            'LambdaArn' => '<string>',
            'S3Bucket' => '<string>',
        ],
        'RoleArn' => '<string>',
    ],
    'Description' => '<string>',
    'ErrorMessage' => '<string>',
    'Id' => '<string>',
    'IndexId' => '<string>',
    'LanguageCode' => '<string>',
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'Schedule' => '<string>',
    'Status' => 'CREATING|DELETING|FAILED|UPDATING|ACTIVE',
    'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE|WEBCRAWLER|WORKDOCS|FSX|SLACK|BOX|QUIP|JIRA|GITHUB|ALFRESCO|TEMPLATE',
    'UpdatedAt' => <DateTime>,
    'VpcConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeExperience

$result = $client->describeExperience([/* ... */]);
$promise = $client->describeExperienceAsync([/* ... */]);

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->describeExperience([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Configuration' => [
        'ContentSourceConfiguration' => [
            'DataSourceIds' => ['<string>', ...],
            'DirectPutContent' => true || false,
            'FaqIds' => ['<string>', ...],
        ],
        'UserIdentityConfiguration' => [
            'IdentityAttributeName' => '<string>',
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Endpoints' => [
        [
            'Endpoint' => '<string>',
            'EndpointType' => 'HOME',
        ],
        // ...
    ],
    'ErrorMessage' => '<string>',
    'Id' => '<string>',
    'IndexId' => '<string>',
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'Status' => 'CREATING|ACTIVE|DELETING|FAILED',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeFaq

$result = $client->describeFaq([/* ... */]);
$promise = $client->describeFaqAsync([/* ... */]);

Gets information about a FAQ.

Parameter Syntax

$result = $client->describeFaq([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ErrorMessage' => '<string>',
    'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
    'Id' => '<string>',
    'IndexId' => '<string>',
    'LanguageCode' => '<string>',
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'S3Path' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
    ],
    'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeFeaturedResultsSet

$result = $client->describeFeaturedResultsSet([/* ... */]);
$promise = $client->describeFeaturedResultsSetAsync([/* ... */]);

Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Parameter Syntax

$result = $client->describeFeaturedResultsSet([
    'FeaturedResultsSetId' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTimestamp' => <integer>,
    'Description' => '<string>',
    'FeaturedDocumentsMissing' => [
        [
            'Id' => '<string>',
        ],
        // ...
    ],
    'FeaturedDocumentsWithMetadata' => [
        [
            'Id' => '<string>',
            'Title' => '<string>',
            'URI' => '<string>',
        ],
        // ...
    ],
    'FeaturedResultsSetId' => '<string>',
    'FeaturedResultsSetName' => '<string>',
    'LastUpdatedTimestamp' => <integer>,
    'QueryTexts' => ['<string>', ...],
    'Status' => 'ACTIVE|INACTIVE',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeIndex

$result = $client->describeIndex([/* ... */]);
$promise = $client->describeIndexAsync([/* ... */]);

Gets information about an Amazon Kendra index.

Parameter Syntax

$result = $client->describeIndex([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CapacityUnits' => [
        'QueryCapacityUnits' => <integer>,
        'StorageCapacityUnits' => <integer>,
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'DocumentMetadataConfigurations' => [
        [
            'Name' => '<string>',
            'Relevance' => [
                'Duration' => '<string>',
                'Freshness' => true || false,
                'Importance' => <integer>,
                'RankOrder' => 'ASCENDING|DESCENDING',
                'ValueImportanceMap' => [<integer>, ...],
            ],
            'Search' => [
                'Displayable' => true || false,
                'Facetable' => true || false,
                'Searchable' => true || false,
                'Sortable' => true || false,
            ],
            'Type' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE',
        ],
        // ...
    ],
    'Edition' => 'DEVELOPER_EDITION|ENTERPRISE_EDITION|GEN_AI_ENTERPRISE_EDITION',
    'ErrorMessage' => '<string>',
    'Id' => '<string>',
    'IndexStatistics' => [
        'FaqStatistics' => [
            'IndexedQuestionAnswersCount' => <integer>,
        ],
        'TextDocumentStatistics' => [
            'IndexedTextBytes' => <integer>,
            'IndexedTextDocumentsCount' => <integer>,
        ],
    ],
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'ServerSideEncryptionConfiguration' => [
        'KmsKeyId' => '<string>',
    ],
    'Status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|SYSTEM_UPDATING',
    'UpdatedAt' => <DateTime>,
    'UserContextPolicy' => 'ATTRIBUTE_FILTER|USER_TOKEN',
    'UserGroupResolutionConfiguration' => [
        'UserGroupResolutionMode' => 'AWS_SSO|NONE',
    ],
    'UserTokenConfigurations' => [
        [
            'JsonTokenTypeConfiguration' => [
                'GroupAttributeField' => '<string>',
                'UserNameAttributeField' => '<string>',
            ],
            'JwtTokenTypeConfiguration' => [
                'ClaimRegex' => '<string>',
                'GroupAttributeField' => '<string>',
                'Issuer' => '<string>',
                'KeyLocation' => 'URL|SECRET_MANAGER',
                'SecretManagerArn' => '<string>',
                'URL' => '<string>',
                'UserNameAttributeField' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribePrincipalMapping

$result = $client->describePrincipalMapping([/* ... */]);
$promise = $client->describePrincipalMappingAsync([/* ... */]);

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->describePrincipalMapping([
    'DataSourceId' => '<string>',
    'GroupId' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataSourceId' => '<string>',
    'GroupId' => '<string>',
    'GroupOrderingIdSummaries' => [
        [
            'FailureReason' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'OrderingId' => <integer>,
            'ReceivedAt' => <DateTime>,
            'Status' => 'FAILED|SUCCEEDED|PROCESSING|DELETING|DELETED',
        ],
        // ...
    ],
    'IndexId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeQuerySuggestionsBlockList

$result = $client->describeQuerySuggestionsBlockList([/* ... */]);
$promise = $client->describeQuerySuggestionsBlockListAsync([/* ... */]);

Gets information about a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->describeQuerySuggestionsBlockList([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ErrorMessage' => '<string>',
    'FileSizeBytes' => <integer>,
    'Id' => '<string>',
    'IndexId' => '<string>',
    'ItemCount' => <integer>,
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'SourceS3Path' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
    ],
    'Status' => 'ACTIVE|CREATING|DELETING|UPDATING|ACTIVE_BUT_UPDATE_FAILED|FAILED',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeQuerySuggestionsConfig

$result = $client->describeQuerySuggestionsConfig([/* ... */]);
$promise = $client->describeQuerySuggestionsConfigAsync([/* ... */]);

Gets information on the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AttributeSuggestionsConfig' => [
        'AttributeSuggestionsMode' => 'ACTIVE|INACTIVE',
        'SuggestableConfigList' => [
            [
                'AttributeName' => '<string>',
                'Suggestable' => true || false,
            ],
            // ...
        ],
    ],
    'IncludeQueriesWithoutUserInformation' => true || false,
    'LastClearTime' => <DateTime>,
    'LastSuggestionsBuildTime' => <DateTime>,
    'MinimumNumberOfQueryingUsers' => <integer>,
    'MinimumQueryCount' => <integer>,
    'Mode' => 'ENABLED|LEARN_ONLY',
    'QueryLogLookBackWindowInDays' => <integer>,
    'Status' => 'ACTIVE|UPDATING',
    'TotalSuggestionsCount' => <integer>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DescribeThesaurus

$result = $client->describeThesaurus([/* ... */]);
$promise = $client->describeThesaurusAsync([/* ... */]);

Gets information about an Amazon Kendra thesaurus.

Parameter Syntax

$result = $client->describeThesaurus([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

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

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DisassociateEntitiesFromExperience

$result = $client->disassociateEntitiesFromExperience([/* ... */]);
$promise = $client->disassociateEntitiesFromExperienceAsync([/* ... */]);

Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->disassociateEntitiesFromExperience([
    'EntityList' => [ // REQUIRED
        [
            'EntityId' => '<string>', // REQUIRED
            'EntityType' => 'USER|GROUP', // REQUIRED
        ],
        // ...
    ],
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FailedEntityList' => [
        [
            'EntityId' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

DisassociatePersonasFromEntities

$result = $client->disassociatePersonasFromEntities([/* ... */]);
$promise = $client->disassociatePersonasFromEntitiesAsync([/* ... */]);

Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->disassociatePersonasFromEntities([
    'EntityIds' => ['<string>', ...], // REQUIRED
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FailedEntityList' => [
        [
            'EntityId' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

GetQuerySuggestions

$result = $client->getQuerySuggestions([/* ... */]);
$promise = $client->getQuerySuggestionsAsync([/* ... */]);

Fetches the queries that are suggested to your users.

GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->getQuerySuggestions([
    'AttributeSuggestionsConfig' => [
        'AdditionalResponseAttributes' => ['<string>', ...],
        '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
                // ...
            ],
        ],
        'SuggestionAttributes' => ['<string>', ...],
        'UserContext' => [
            'DataSourceGroups' => [
                [
                    'DataSourceId' => '<string>', // REQUIRED
                    'GroupId' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Groups' => ['<string>', ...],
            'Token' => '<string>',
            'UserId' => '<string>',
        ],
    ],
    'IndexId' => '<string>', // REQUIRED
    'MaxSuggestionsCount' => <integer>,
    'QueryText' => '<string>', // REQUIRED
    'SuggestionTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'QuerySuggestionsId' => '<string>',
    'Suggestions' => [
        [
            'Id' => '<string>',
            'SourceDocuments' => [
                [
                    'AdditionalAttributes' => [
                        [
                            'Key' => '<string>',
                            'Value' => [
                                'DateValue' => <DateTime>,
                                'LongValue' => <integer>,
                                'StringListValue' => ['<string>', ...],
                                'StringValue' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'DocumentId' => '<string>',
                    'SuggestionAttributes' => ['<string>', ...],
                ],
                // ...
            ],
            'Value' => [
                'Text' => [
                    'Highlights' => [
                        [
                            'BeginOffset' => <integer>,
                            'EndOffset' => <integer>,
                        ],
                        // ...
                    ],
                    'Text' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

GetSnapshots

$result = $client->getSnapshots([/* ... */]);
$promise = $client->getSnapshotsAsync([/* ... */]);

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

Parameter Syntax

$result = $client->getSnapshots([
    'IndexId' => '<string>', // REQUIRED
    'Interval' => 'THIS_MONTH|THIS_WEEK|ONE_WEEK_AGO|TWO_WEEKS_AGO|ONE_MONTH_AGO|TWO_MONTHS_AGO', // REQUIRED
    'MaxResults' => <integer>,
    'MetricType' => 'QUERIES_BY_COUNT|QUERIES_BY_ZERO_CLICK_RATE|QUERIES_BY_ZERO_RESULT_RATE|DOCS_BY_CLICK_COUNT|AGG_QUERY_DOC_METRICS|TREND_QUERY_DOC_METRICS', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SnapShotTimeFilter' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'SnapshotsData' => [
        ['<string>', ...],
        // ...
    ],
    'SnapshotsDataHeader' => ['<string>', ...],
]

Result Details

Errors

InvalidRequestException:

The input to the request is not valid. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListAccessControlConfigurations

$result = $client->listAccessControlConfigurations([/* ... */]);
$promise = $client->listAccessControlConfigurationsAsync([/* ... */]);

Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameter Syntax

$result = $client->listAccessControlConfigurations([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccessControlConfigurations' => [
        [
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListDataSourceSyncJobs

$result = $client->listDataSourceSyncJobs([/* ... */]);
$promise = $client->listDataSourceSyncJobsAsync([/* ... */]);

Gets statistics about synchronizing a data source connector.

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

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

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListDataSources

$result = $client->listDataSources([/* ... */]);
$promise = $client->listDataSourcesAsync([/* ... */]);

Lists the data source connectors that you have created.

Parameter Syntax

$result = $client->listDataSources([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'Id' => '<string>',
            'LanguageCode' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATING|DELETING|FAILED|UPDATING|ACTIVE',
            'Type' => 'S3|SHAREPOINT|DATABASE|SALESFORCE|ONEDRIVE|SERVICENOW|CUSTOM|CONFLUENCE|GOOGLEDRIVE|WEBCRAWLER|WORKDOCS|FSX|SLACK|BOX|QUIP|JIRA|GITHUB|ALFRESCO|TEMPLATE',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListEntityPersonas

$result = $client->listEntityPersonas([/* ... */]);
$promise = $client->listEntityPersonasAsync([/* ... */]);

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

Parameter Syntax

$result = $client->listEntityPersonas([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'EntityId' => '<string>',
            'Persona' => 'OWNER|VIEWER',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListExperienceEntities

$result = $client->listExperienceEntities([/* ... */]);
$promise = $client->listExperienceEntitiesAsync([/* ... */]);

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->listExperienceEntities([
    'Id' => '<string>', // REQUIRED
    'IndexId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SummaryItems' => [
        [
            'DisplayData' => [
                'FirstName' => '<string>',
                'GroupName' => '<string>',
                'IdentifiedUserName' => '<string>',
                'LastName' => '<string>',
                'UserName' => '<string>',
            ],
            'EntityId' => '<string>',
            'EntityType' => 'USER|GROUP',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListExperiences

$result = $client->listExperiences([/* ... */]);
$promise = $client->listExperiencesAsync([/* ... */]);

Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Parameter Syntax

$result = $client->listExperiences([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'Endpoints' => [
                [
                    'Endpoint' => '<string>',
                    'EndpointType' => 'HOME',
                ],
                // ...
            ],
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATING|ACTIVE|DELETING|FAILED',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListFaqs

$result = $client->listFaqs([/* ... */]);
$promise = $client->listFaqsAsync([/* ... */]);

Gets a list of FAQs associated with an index.

Parameter Syntax

$result = $client->listFaqs([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FaqSummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'FileFormat' => 'CSV|CSV_WITH_HEADER|JSON',
            'Id' => '<string>',
            'LanguageCode' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListFeaturedResultsSets

$result = $client->listFeaturedResultsSets([/* ... */]);
$promise = $client->listFeaturedResultsSetsAsync([/* ... */]);

Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Parameter Syntax

$result = $client->listFeaturedResultsSets([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FeaturedResultsSetSummaryItems' => [
        [
            'CreationTimestamp' => <integer>,
            'FeaturedResultsSetId' => '<string>',
            'FeaturedResultsSetName' => '<string>',
            'LastUpdatedTimestamp' => <integer>,
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListGroupsOlderThanOrderingId

$result = $client->listGroupsOlderThanOrderingId([/* ... */]);
$promise = $client->listGroupsOlderThanOrderingIdAsync([/* ... */]);

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->listGroupsOlderThanOrderingId([
    'DataSourceId' => '<string>',
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OrderingId' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupsSummaries' => [
        [
            'GroupId' => '<string>',
            'OrderingId' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListIndices

$result = $client->listIndices([/* ... */]);
$promise = $client->listIndicesAsync([/* ... */]);

Lists the Amazon Kendra indexes that you created.

Parameter Syntax

$result = $client->listIndices([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IndexConfigurationSummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'Edition' => 'DEVELOPER_EDITION|ENTERPRISE_EDITION|GEN_AI_ENTERPRISE_EDITION',
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|SYSTEM_UPDATING',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListQuerySuggestionsBlockLists

$result = $client->listQuerySuggestionsBlockLists([/* ... */]);
$promise = $client->listQuerySuggestionsBlockListsAsync([/* ... */]);

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameter Syntax

$result = $client->listQuerySuggestionsBlockLists([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'BlockListSummaryItems' => [
        [
            'CreatedAt' => <DateTime>,
            'Id' => '<string>',
            'ItemCount' => <integer>,
            'Name' => '<string>',
            'Status' => 'ACTIVE|CREATING|DELETING|UPDATING|ACTIVE_BUT_UPDATE_FAILED|FAILED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceUnavailableException:

The resource you want to use isn't available. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

ListThesauri

$result = $client->listThesauri([/* ... */]);
$promise = $client->listThesauriAsync([/* ... */]);

Lists the thesauri for an index.

Parameter Syntax

$result = $client->listThesauri([
    'IndexId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

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

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

PutPrincipalMapping

$result = $client->putPrincipalMapping([/* ... */]);
$promise = $client->putPrincipalMappingAsync([/* ... */]);

Maps users to their groups so that you only need to provide the user ID when you issue the query.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

Parameter Syntax

$result = $client->putPrincipalMapping([
    'DataSourceId' => '<string>',
    'GroupId' => '<string>', // REQUIRED
    'GroupMembers' => [ // REQUIRED
        'MemberGroups' => [
            [
                'DataSourceId' => '<string>',
                'GroupId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'MemberUsers' => [
            [
                'UserId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'S3PathforGroupMembers' => [
            'Bucket' => '<string>', // REQUIRED
            'Key' => '<string>', // REQUIRED
        ],
    ],
    'IndexId' => '<string>', // REQUIRED
    'OrderingId' => <integer>,
    'RoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

ConflictException:

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

ResourceNotFoundException:

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException:

The request was denied due to request throttling. Please reduce the number of requests and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

InternalServerException:

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

Query

$result = $client->query([/* ... */]);
$promise = $client->queryAsync([/* ... */]);

Searches an index given an input query.

You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.

A query response contains three types of results.

• Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.

• Matching FAQs or questions-answer from your FAQ file.

• Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.

You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.

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
            // ...
        ],
    ],
    'CollapseConfiguration' => [
        'DocumentAttributeKey' => '<string>', // REQUIRED
        'Expand' => true || false,
        'ExpandConfiguration' => [
            'MaxExpandedResultsPerItem' => <integer>,
            'MaxResultItemsToExpand' => <integer>,
        ],
        'MissingAttributeKeyStrategy' => 'IGNORE|COLLAPSE|EXPAND',
        'SortingConfigurations' => [
            [
                'DocumentAttributeKey' => '<string>', // REQUIRED
                'SortOrder' => 'DESC|ASC', // REQUIRED
            ],
            // ...
        ],
    ],
    'DocumentRelevanceOverrideConfigurations' => [
        [
            'Name' => '<string>', // REQUIRED
            'Relevance' => [ // REQUIRED
                'Duration' => '<string>',
                'Freshness' => true || false,
                'Importance' => <integer>,
                'RankOrder' => 'ASCENDING|DESCENDING',
                'ValueImportanceMap' => [<integer>, ...],
            ],
        ],
        // ...
    ],
    'Facets' => [
        [
            'DocumentAttributeKey' => '<string>',
            'Facets' => [...], // RECURSIVE
            'MaxResults' => <integer>,
        ],
        // ...
    ],
    'IndexId' => '<string>', // REQUIRED
    'PageNumber' => <integer>,
    'PageSize' => <integer>,
    'QueryResultTypeFilter' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
    'QueryText' => '<string>',
    'RequestedDocumentAttributes' => ['<string>', ...],
    'SortingConfiguration' => [
        'DocumentAttributeKey' => '<string>', // REQUIRED
        'SortOrder' => 'DESC|ASC', // REQUIRED
    ],
    'SortingConfigurations' => [
        [
            'DocumentAttributeKey' => '<string>', // REQUIRED
            'SortOrder' => 'DESC|ASC', // REQUIRED
        ],
        // ...
    ],
    'SpellCorrectionConfiguration' => [
        'IncludeQuerySpellCheckSuggestions' => true || false, // REQUIRED
    ],
    'UserContext' => [
        'DataSourceGroups' => [
            [
                'DataSourceId' => '<string>', // REQUIRED
                'GroupId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Groups' => ['<string>', ...],
        'Token' => '<string>',
        'UserId' => '<string>',
    ],
    'VisitorId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FacetResults' => [
        [
            'DocumentAttributeKey' => '<string>',
            'DocumentAttributeValueCountPairs' => [
                [
                    'Count' => <integer>,
                    'DocumentAttributeValue' => [
                        'DateValue' => <DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                    'FacetResults' => [...], // RECURSIVE
                ],
                // ...
            ],
            'DocumentAttributeValueType' => 'STRING_VALUE|STRING_LIST_VALUE|LONG_VALUE|DATE_VALUE',
        ],
        // ...
    ],
    'FeaturedResultsItems' => [
        [
            '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>',
            'Type' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
        ],
        // ...
    ],
    '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',
                ],
                // ...
            ],
            'CollapsedResultDetail' => [
                'DocumentAttribute' => [
                    'Key' => '<string>',
                    'Value' => [
                        'DateValue' => <DateTime>,
                        'LongValue' => <integer>,
                        'StringListValue' => ['<string>', ...],
                        'StringValue' => '<string>',
                    ],
                ],
                'ExpandedResults' => [
                    [
                        '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>',
                        'Id' => '<string>',
                    ],
                    // ...
                ],
            ],
            '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>',
            'Format' => 'TABLE|TEXT',
            'Id' => '<string>',
            'ScoreAttributes' => [
                'ScoreConfidence' => 'VERY_HIGH|HIGH|MEDIUM|LOW|NOT_AVAILABLE',
            ],
            'TableExcerpt' => [
                'Rows' => [
                    [
                        'Cells' => [
                            [
                                'Header' => true || false,
                                'Highlighted' => true || false,
                                'TopAnswer' => true || false,
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'TotalNumberOfRows' => <integer>,
            ],
            'Type' => 'DOCUMENT|QUESTION_ANSWER|ANSWER',
        ],
        // ...
    ],
    'SpellCorrectedQueries' => [
        [
            'Corrections' => [
                [
                    'BeginOffset' => <integer>,
                    'CorrectedTerm' => '<string>',
                    'EndOffset' => <integer>,
                    'Term' => '<string>',
                ],
                // ...
            ],
            'SuggestedQueryText' => '<string>',
        ],
        // ...
    ],
    'TotalNumberOfResults' => <integer>,
    'Warnings' => [
        [
            'Code' => 'QUERY_LANGUAGE_INVALID_SYNTAX',
            'Message' => '<string>',
        ],
        // ...
    ],
]

Result Details