AWSKendraFrontendService 2019-02-03

AssociateEntitiesToExperience

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

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FailedDocuments' => [
        [
            '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.

BatchGetDocumentStatus

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

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' => [
        [
            '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([/* ... */]);

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',
            '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' => [
        [
            '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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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([/* ... */]);

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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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[hyperlink Kendra Quotas pg] 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.

CreateIndex

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

Parameter Syntax

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

Parameter Details

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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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[hyperlink Kendra Quotas pg] 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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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.

DescribeIndex

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details