|
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeia atributos ou nomes de campos dos arquivos do Drupal. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). Os nomes dos campos da fonte de dados do Drupal devem existir nos metadados personalizados do Drupal . |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Drupal. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para excluir determinadas páginas e ativos em sua fonte de dados do Drupal. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| contentDefinitions[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Especifique os tipos de conteúdo a serem rastreados e se os comentários e anexos devem ser rastreados para os tipos de conteúdo selecionados. |
| type | O tipo da fonte de dados. Especifique DRUPAL como seu tipo de fonte de dados. |
| authType | O tipo de autenticação que você usa: BASIC-AUTH ou OAUTH2. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Drupal. O segredo deve conter uma estrutura JSON com as seguintes chaves: **Se estiver usando a autenticação básica:**{
"username": "user name",
"passwords": "password"
} **Se estiver usando a autenticação OAuth 2.0:**{
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Drupal
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"hostUrl": {
"type": "string",
"pattern": "https:.*"
}
},
"required": [
"hostUrl"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"comment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"isCrawlArticle": {
"type": "boolean"
},
"isCrawlBasicPage": {
"type": "boolean"
},
"isCrawlBasicBlock": {
"type": "boolean"
},
"crawlCustomContentTypesList": {
"type": "array",
"items": {
"type": "string"
}
},
"crawlCustomBlockTypesList": {
"type": "array",
"items": {
"type": "string"
}
},
"filePath": {
"anyOf": [
{
"type": "string",
"pattern": "s3:.*"
},
{
"type": "string",
"pattern": ""
}
]
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"articleTitleInclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"articleTitleExclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"pageTitleInclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"pageTitleExclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"customContentTitleInclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"customContentTitleExclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"basicBlockTitleInclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"basicBlockTitleExclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"customBlockTitleInclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"customBlockTitleExclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"contentDefinitions": {
"type": "array",
"items": {
"properties": {
"contentType": {
"type": "string"
},
"fieldDefinition": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"machineName": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"machineName",
"type"
]
}
]
},
"isCrawlComments": {
"type": "boolean"
},
"isCrawlFiles": {
"type": "boolean"
}
}
},
"required": [
"contentType",
"fieldDefinition",
"isCrawlComments",
"isCrawlFiles"
]
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "DRUPAL"
},
"authType": {
"type": "string",
"enum": [
"BASIC-AUTH",
"OAUTH2"
]
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## GitHub esquema de modelo
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você fornece a URL do GitHub host, o nome da organização e se usa a GitHub nuvem ou o GitHub local como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `GITHUB`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [GitHub Esquema JSON](#github-json).
A tabela a seguir descreve os parâmetros do esquema GitHub JSON.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| type | Especifique o tipo como SAAS ou ON\$1PREMISE. |
| hostUrl | O URL do GitHub host. Por exemplo, se você usa GitHub SaaS/Enterprise Cloud:. https://api.github.com Ou, se você usa um servidor GitHub local/corporativo:. https://on-prem-host-url/api/v3/ |
| organizationName | Você pode encontrar o nome da sua organização ao fazer login no GitHub desktop e acessar Suas organizações no menu suspenso da foto do perfil. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campos. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu GitHub conteúdo para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| isCrawlAcl | true para fazer crawling das informações da lista de controle de acesso (ACL) dos documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar e pesquisar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources). |
| fieldForUserIdentificação | Especifique o tipo de ID de usuário que você deseja usar para o crawling da ACL. Especifique email se você deseja usar o e-mail do usuário para o ID do usuário ou username se deseja usar o nome de usuário para o ID do usuário. Se você não especificar uma opção, email será usado por padrão. |
| repositoryFilter | Uma lista de nomes de repositórios e ramificações específicos que você deseja indexar. |
| crawlRepository | true para fazer crawling de repositórios. |
| crawlRepositoryDocuments | true para fazer crawling de documentos do repositório. |
| crawlIssue | true para fazer crawling de problemas. |
| crawlIssueComment | true para fazer crawling de comentários do problema. |
| crawlIssueCommentAnexo | true para fazer crawling de anexos dos comentários do problema. |
| crawlPullRequest | true para fazer crawling de solicitações pull. |
| crawlPullRequestComente | true para fazer crawling de comentários de solicitações pull. |
| crawlPullRequestCommentAttachment | true para fazer crawling de anexos de comentários de solicitações pull. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressão regular para incluir determinado conteúdo em sua fonte GitHub de dados. O conteúdo que corresponde aos padrões é incluído no índice. O conteúdo que não corresponde aos padrões é excluído do índice. Se qualquer conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressão regular para excluir determinado conteúdo em sua fonte GitHub de dados. O conteúdo que corresponde aos padrões é excluído do índice. O conteúdo que não corresponde aos padrões é incluído no índice. Se qualquer conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice. |
| type | O tipo da fonte de dados. Especifique GITHUB como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. GitHub O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"personalToken": "token"
} |
| version | A versão desse modelo aceita no momento. |
### GitHub Esquema JSON
A seguir está o esquema GitHub JSON:
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"hostUrl": {
"type": "string",
"pattern": "https://.*"
},
"organizationName": {
"type": "string"
}
},
"required": [
"type",
"hostUrl",
"organizationName"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"ghRepository": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghCommit": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghIssueDocument": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghIssueComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghIssueAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghPRDocument": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghPRComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghPRAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"isCrawlAcl": {
"type": "boolean"
},
"fieldForUserId": {
"type": "string"
},
"crawlRepository": {
"type": "boolean"
},
"crawlRepositoryDocuments": {
"type": "boolean"
},
"crawlIssue": {
"type": "boolean"
},
"crawlIssueComment": {
"type": "boolean"
},
"crawlIssueCommentAttachment": {
"type": "boolean"
},
"crawlPullRequest": {
"type": "boolean"
},
"crawlPullRequestComment": {
"type": "boolean"
},
"crawlPullRequestCommentAttachment": {
"type": "boolean"
},
"repositoryFilter": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"repositoryName": {
"type": "string"
},
"branchNameList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"inclusionFolderNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFolderNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "GITHUB"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"enableIdentityCrawler"
]
}
```
## Esquema de modelos do Gmail
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `GMAIL`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Gmail](#gmail-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Gmail.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint em repositoryEndpointMetadata. Em vez disso, as informações de conexão são incluídas em um AWS Secrets Manager segredo que você fornece secretArn a. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo de suas mensagens e anexos do Gmail para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para incluir ou excluir mensagens com nomes de assuntos específicos na sua fonte de dados do Gmail. Os arquivos que correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| beforeDateFilter | Especifique mensagens e anexos a serem incluídos antes de uma determinada data. |
| afterDateFilter | Especifique mensagens e anexos a serem incluídos antes de uma determinada data. |
| isCrawlAttachment | Um valor booleano para escolher se você deseja rastrear anexos. As mensagens são rastreadas automaticamente. |
| type | O tipo da fonte de dados. Especifique GMAIL como seu tipo de fonte de dados. |
| shouldCrawlDraftMensagens | Um valor booleano para escolher se você deseja rastrear rascunhos de mensagens. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, qualquer sincronização de conteúdo novo, modificado ou excluído: Não remove mensagens que foram excluídas permanentemente do Gmail do índice do Amazon Kendra Não sincroniza alterações nos rótulos de e-mail do Gmail Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com seu Amazon Kendra índice, você deve executar rastreamentos completos periodicamente. |
| secretARN | O nome do recurso da Amazon (ARN) de uma senha do Secrets Manager que contém os pares de chave/valor necessários para se conectar ao Gmail. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"adminAccountEmailId": "service account email",
"clientEmailId": "user account email",
"privateKey": "private key"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Gmail
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
}
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"message": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"attachments": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING"]
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
}
},
"required": []
},
"additionalProperties": {
"type": "object",
"properties": {
"inclusionLabelNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionLabelNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionAttachmentTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionAttachmentTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionAttachmentNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionAttachmentNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionSubjectFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionSubjectFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"isSubjectAnd": {
"type": "boolean"
},
"inclusionFromFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFromFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionToFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionToFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionCcFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionCcFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionBccFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionBccFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"beforeDateFilter": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"afterDateFilter": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"isCrawlAttachment": {
"type": "boolean"
},
"shouldCrawlDraftMessages": {
"type": "boolean"
}
},
"required": [
"isCrawlAttachment",
"shouldCrawlDraftMessages"
]
},
"type" : {
"type" : "string",
"pattern": "GMAIL"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL"
]
},
"secretArn": {
"type": "string"
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
}
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"syncMode",
"secretArn",
"type"
]
}
```
## Esquema do modelo do Google Drive
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `GOOGLEDRIVE2`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Google Drive](#googledrive-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Google Drive.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração sobre a fonte de dados |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint. Você escolhe o tipo de autenticação: serviceAccount e OAuth2. As informações de conexão estão incluídas em um AWS Secrets Manager segredo que você fornece secretArn a. |
| authType | Escolha entre serviceAccount e OAuth2 com base no caso de uso. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeia atributos ou nomes de campos do Google Drive para o Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Especifique um limite de tamanho de arquivo MBs que Amazon Kendra deve ser rastreado. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling de comentários na fonte de dados do Google Drive. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | truepara rastrear MyDrive e compartilhar unidades do Shared With Me na sua fonte de dados do Google Drive. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling de drives Compartilhados na fonte de dados do Google Drive. |
| isCrawlAcl | true para fazer crawling das informações da lista de controle de acesso (ACL) dos documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar e pesquisar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources). |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Google Drive. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Google Drive. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| type | O tipo da fonte de dados. Especifique GOOOGLEDRIVEV2 como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Google Drive. O segredo deve conter uma estrutura JSON com as seguintes chaves: ****Se estiver usando a autenticação da conta de serviço do Google:{
"clientEmail": "user account email",
"adminAccountEmail": "service account email",
"privateKey": "private key"
} ****Se estiver usando a autenticação OAuth 2.0: {
"clientID": "OAuth client ID",
"clientSecret": "client secret",
"refreshToken": "refresh token"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Google Drive
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": [
"serviceAccount",
"OAuth2"
]
}
},
"required": [
"authType"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"comment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"maxFileSizeInMegaBytes": {
"type": "string"
},
"isCrawlComment": {
"type": "boolean"
},
"isCrawlMyDriveAndSharedWithMe": {
"type": "boolean"
},
"isCrawlSharedDrives": {
"type": "boolean"
},
"isCrawlAcl": {
"type": "boolean"
},
"excludeUserAccounts": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeSharedDrives": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeMimeTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"includeUserAccounts": {
"type": "array",
"items": {
"type": "string"
}
},
"includeSharedDrives": {
"type": "array",
"items": {
"type": "string"
}
},
"includeMimeTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"includeTargetAudienceGroup": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFilePathFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFilePathFilter": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"type": {
"type": "string",
"pattern": "GOOGLEDRIVEV2"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema DB2 de modelo IBM
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `JDBC`, o tipo de banco de dados `db2`, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema IBM DB2 JSON](#ibm-db2-json).
A tabela a seguir descreve os parâmetros do esquema IBM DB2 JSON.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações de configuração necessárias para conectar sua fonte de dados.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN do segredo. |
| document | Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados. |
| primaryKey | Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados. |
| titleColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| bodyColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| sqlQuery | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| timestampColumn | Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado. |
| timestampFormat | Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo. |
| timezone | Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado. |
| changeDetectingColumns | Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas |
| allowedUsersColumns | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| allowedGroupsColumn | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| fonte URIColumn | Insira o nome da coluna que contém URLs a Fonte a ser indexada. |
| isSslEnabled | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| type | O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"user name": "database user name",
"password": "password"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema IBM DB2 JSON
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"dbType": {
"type": "string",
"enum": [
"mysql",
"db2",
"postgresql",
"oracle",
"sqlserver"
]
},
"dbHost": {
"type": "string"
},
"dbPort": {
"type": "string"
},
"dbInstance": {
"type": "string"
}
},
"required": [
"dbType",
"dbHost",
"dbPort",
"dbInstance"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string"
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
]
},
"additionalProperties": {
"type": "object",
"properties": {
"primaryKey": {
"type": "string"
},
"titleColumn": {
"type": "string"
},
"bodyColumn": {
"type": "string"
},
"sqlQuery": {
"type": "string",
"not": {
"pattern": ";+"
}
},
"timestampColumn": {
"type": "string"
},
"timestampFormat": {
"type": "string"
},
"timezone": {
"type": "string"
},
"changeDetectingColumns": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedUsersColumn": {
"type": "string"
},
"allowedGroupsColumn": {
"type": "string"
},
"sourceURIColumn": {
"type": "string"
},
"isSslEnabled": {
"type": "boolean"
}
},
"required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
},
"type" : {
"type" : "string",
"pattern": "JDBC"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do Microsoft Exchange
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `MSEXCHANGE`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Microsoft Exchange](#msexchange-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft Exchange.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| tenantId | O ID do locatário do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo da sua fonte de dados do Microsoft Exchange para campos de Amazon Kendra índice. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções de configuração adicionais para conteúdo em sua fonte de dados |
| inclusionPatterns | Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| exclusionPatterns | Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os URLs que correspondem aos padrões são incluídos no índice. Os usuários que não correspondem aos padrões são excluídos do índice. Se um usuário corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o usuário não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os usuários que não correspondem aos padrões são excluídos do índice. Os usuários que não correspondem aos padrões são incluídos no índice. Se um usuário corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o usuário não será incluído no índice. |
| s3bucketName | O nome do seu bucket do S3, se quiser usar. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling desses tipos de conteúdo e informações de controle de acesso à sua fonte de dados do Microsoft Exchange. |
| startCalendarDateHora | Você pode configurar uma data e hora de início específica para o conteúdo do calendário. |
| endCalendarDateHora | Você pode configurar uma data e hora de início específica para o conteúdo do calendário. |
| subject | Você pode configurar uma linha de assunto específica para o conteúdo do e-mail. |
| emailFrom | Você pode configurar um e-mail específico para o conteúdo do e-mail “De” ou do remetente. |
| emailTo | Você pode configurar um e-mail específico para o conteúdo do e-mail “De” ou do remetente. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| type | O tipo da fonte de dados. Especifique MSEXCHANGE como seu tipo de fonte de dados. |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Microsoft Exchange. Isso inclui seu ID de cliente e seu segredo de cliente que são gerados quando você cria um OAuth aplicativo no portal do Azure. |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Microsoft Exchange
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
},
"required": ["tenantId"]
}
}
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"email": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "DATE","LONG"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"calendar": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"contacts": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"notes": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": ["email"
]
},
"additionalProperties": {
"type": "object",
"properties": {
"inclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionUsersList": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
},
"exclusionUsersList": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
},
"s3bucketName": {
"type": "string"
},
"inclusionUsersFileName": {
"type": "string"
},
"exclusionUsersFileName": {
"type": "string"
},
"inclusionDomainUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionDomainUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"crawlCalendar": {
"type": "boolean"
},
"crawlNotes": {
"type": "boolean"
},
"crawlContacts": {
"type": "boolean"
},
"crawlFolderAcl": {
"type": "boolean"
},
"startCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"endCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"subject": {
"type": "array",
"items": {
"type": "string"
}
},
"emailFrom": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
},
"emailTo": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
}
},
"required": [
]
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"type" : {
"type" : "string",
"pattern": "MSEXCHANGE"
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema OneDrive de modelos da Microsoft
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Forneça o ID do locatário como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `ONEDRIVEV2`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema Microsoft OneDrive JSON](#onedrive-json).
A tabela a seguir descreve os parâmetros do esquema Microsoft OneDrive JSON.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| tenantId | O ID do locatário do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| arquivo | Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus OneDrive arquivos da Microsoft para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Você pode escolher indexar arquivos, OneNote seções e OneNote páginas específicos e filtrar por nome de usuário. |
| isUserNameEm S3 | true para fornecer uma lista de nomes de usuário em um arquivo armazenado em um Amazon S3. |
| type | O tipo da fonte de dados. Especifique ONEDRIVEV2 como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| type | O tipo da fonte de dados. Especifique ONEDRIVEV2 como seu tipo de fonte de dados. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar à sua Microsoft. OneDrive O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"clientId": "client ID",
"clientSecret": "client secret"
} |
| version | Atualmente, apenas a versão deste modelo é compatível. |
### Esquema Microsoft OneDrive JSON
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
},
"required": [
"tenantId"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"userNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"userFilterPath": {
"type": "string"
},
"isUserNameOnS3": {
"type": "boolean"
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFilePathPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFilePathPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": []
},
"enableIdentityCrawler": {
"type": "boolean"
},
"type": {
"type": "string",
"pattern": "ONEDRIVEV2"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema SharePoint de modelos da Microsoft
Você inclui um JSON que contém o esquema da fonte de dados como parte do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)objeto. Você fornece o URL do SharePoint site/URLs, o domínio e também um ID do locatário, se necessário, como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `SHAREPOINTV2`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica `TEMPLATE` como o **Tipo** ao ligar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [SharePoint Esquema JSON](#sharepoint-json).
A tabela a seguir descreve os parâmetros do esquema Microsoft SharePoint JSON.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| tenantId | O ID do inquilino da sua SharePoint conta. |
| domínio | O domínio da sua SharePoint conta. |
| siteUrls | O anfitrião URLs da sua SharePoint conta. |
| repositoryAdditionalProperties | Propriedades adicionais para se conectar ao endpoint repository/data de origem. |
| s3bucketName | O nome do Amazon S3 bucket que armazena seu certificado X.509 autoassinado do Azure AD. |
| s3certificateName | O nome do certificado X.509 autoassinado do Azure AD armazenado em seu bucket. Amazon S3 |
| authType | O tipo de autenticação usada, seja OAuth2, OAuth2Certificate, OAuth2App, Basic, OAuth2\$1RefreshToken, NTLM ou Kerberos. |
| version | A SharePoint versão que você usa, seja Server ouOnline. |
| onPremVersion | A versão do SharePoint servidor que você usa2013, se 20162019, ouSubscriptionEdition. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campos. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu SharePoint conteúdo para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressão regular para include/exclude determinado conteúdo em sua fonte SharePoint de dados. Os itens de conteúdo que correspondem aos padrões de inclusão são incluídos no índice. Os itens de conteúdo que não correspondem aos padrões de inclusão são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling desses tipos de conteúdo. |
| crawlAcl | true para fazer crawling das informações da lista de controle de acesso (ACL) dos documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar e pesquisar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources). |
| fieldForUserIdentificação | Especifique email se você deseja usar o e-mail do usuário para o ID do usuário ou userPrincipalName se deseja usar um nome de usuário para o ID do usuário. Se você não especificar uma opção, email será usado por padrão. |
| aclConfiguration | Especifique ACLWithLDAPEmailFmt, ACLWithManualEmailFmt ou ACLWithUsernameFmtM. |
| emailDomain | O domínio do site do e-mail. Por exemplo, “amazon.com”. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling das informações de mapeamento de grupos. |
| proxyHost | O nome do host do proxy da web que você usa, sem o protocolo http:// ou https://. |
| proxyPort | O número da porta usada pelo protocolo de transporte de URL do host. Esse valor deve estar entre 0 e 65.535. |
| type | Especifique SHAREPOINTV2 como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. SharePoint Para obter informações sobre esses pares de valores-chave, consulte [as instruções de conexão para o SharePoint Online e SharePoint](https://docs.aws.amazon.com/kendra/latest/dg/data-source-v2-sharepoint.html#data-source-procedure-v2-sharepoint) o Server. |
| version | Atualmente, apenas a versão deste modelo é compatível. |
## SharePoint Esquema JSON
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
},
"domain": {
"type": "string"
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"pattern": "https://.*"
}
},
"repositoryAdditionalProperties": {
"type": "object",
"properties": {
"s3bucketName": {
"type": "string"
},
"s3certificateName": {
"type": "string"
},
"authType": {
"type": "string",
"enum": [
"OAuth2",
"OAuth2Certificate",
"OAuth2App",
"Basic",
"OAuth2_RefreshToken",
"NTLM",
"Kerberos"
]
},
"version": {
"type": "string",
"enum": [
"Server",
"Online"
]
},
"onPremVersion": {
"type": "string",
"enum": [
"",
"2013",
"2016",
"2019",
"SubscriptionEdition"
]
}
},
"required": [
"authType",
"version"
]
}
},
"required": [
"siteUrls",
"domain",
"repositoryAdditionalProperties"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"event": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"page": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"file": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"link": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"comment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"eventTitleFilterRegEx": {
"type": "array",
"items": {
"type": "string"
}
},
"pageTitleFilterRegEx": {
"type": "array",
"items": {
"type": "string"
}
},
"linkTitleFilterRegEx": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFilePath": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFilePath": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"crawlFiles": {
"type": "boolean"
},
"crawlPages": {
"type": "boolean"
},
"crawlEvents": {
"type": "boolean"
},
"crawlComments": {
"type": "boolean"
},
"crawlLinks": {
"type": "boolean"
},
"crawlAttachments": {
"type": "boolean"
},
"crawlListData": {
"type": "boolean"
},
"crawlAcl": {
"type": "boolean"
},
"fieldForUserId": {
"type": "string"
},
"aclConfiguration": {
"type": "string",
"enum": [
"ACLWithLDAPEmailFmt",
"ACLWithManualEmailFmt",
"ACLWithUsernameFmt"
]
},
"emailDomain": {
"type": "string"
},
"isCrawlLocalGroupMapping": {
"type": "boolean"
},
"isCrawlAdGroupMapping": {
"type": "boolean"
},
"proxyHost": {
"type": "string"
},
"proxyPort": {
"type": "string"
}
},
"required": [
]
},
"type": {
"type": "string",
"pattern": "SHAREPOINTV2"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"enableIdentityCrawler",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do Microsoft SQL Server
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `JDBC`, o tipo de banco de dados `sqlserver`, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Microsoft SQL Server](#ms-sql-server-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Micorosft SQL Server.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações de configuração necessárias para conectar sua fonte de dados.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN do segredo. |
| document | Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados. |
| primaryKey | Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados. |
| titleColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| bodyColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| sqlQuery | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| timestampColumn | Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado. |
| timestampFormat | Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo. |
| timezone | Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado. |
| changeDetectingColumns | Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas |
| allowedUsersColumns | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| allowedGroupsColumn | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| fonte URIColumn | Insira o nome da coluna que contém URLs a Fonte a ser indexada. |
| isSslEnabled | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| type | O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"user name": "database user name",
"password": "password"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Microsoft SQL Server
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"dbType": {
"type": "string",
"enum": [
"mysql",
"db2",
"postgresql",
"oracle",
"sqlserver"
]
},
"dbHost": {
"type": "string"
},
"dbPort": {
"type": "string"
},
"dbInstance": {
"type": "string"
}
},
"required": [
"dbType",
"dbHost",
"dbPort",
"dbInstance"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string"
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
]
},
"additionalProperties": {
"type": "object",
"properties": {
"primaryKey": {
"type": "string"
},
"titleColumn": {
"type": "string"
},
"bodyColumn": {
"type": "string"
},
"sqlQuery": {
"type": "string",
"not": {
"pattern": ";+"
}
},
"timestampColumn": {
"type": "string"
},
"timestampFormat": {
"type": "string"
},
"timezone": {
"type": "string"
},
"changeDetectingColumns": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedUsersColumn": {
"type": "string"
},
"allowedGroupsColumn": {
"type": "string"
},
"sourceURIColumn": {
"type": "string"
},
"isSslEnabled": {
"type": "boolean"
}
},
"required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
},
"type" : {
"type" : "string",
"pattern": "JDBC"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do Microsoft Teams
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Forneça o ID do locatário como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `MSTEAMS`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Microsoft Teams](#msteams-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft Teams.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para um endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| tenantId | O ID do locatário do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu conteúdo do Microsoft Teams para Amazon Kendra indexar nomes de campo. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| paymentModel | Especifica o tipo de modelo de pagamento a ser usado com fonte de dados do Microsoft Teams. Os modelos de pagamento do modelo A são restritos aos modelos de licenciamento e pagamento que exigem conformidade de segurança. Os modelos de pagamento do modelo A são restritos aos modelos de licenciamento e pagamento que exigem conformidade de segurança. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para incluir determinado conteúdo em sua fonte de dados do Microsoft Teams. O conteúdo que corresponde aos padrões é incluído no índice. O conteúdo que não corresponde aos padrões é excluído do índice. Se o conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para excluir determinados conteúdos em sua fonte de dados do Microsoft Teams. O conteúdo que corresponde aos padrões é excluído do índice. O conteúdo que não corresponde aos padrões é incluído no índice. Se o conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling desses tipos de conteúdo na sua fonte de dados do Microsoft Teams. |
| startCalendarDateHora | Você pode configurar uma data e hora de início específica para o conteúdo do calendário. |
| endCalendarDateHora | Você pode configurar uma data e hora de início específica para o conteúdo do calendário. |
| type | O tipo da fonte de dados. Especifique MSTEAMS como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Microsoft Teams. Isso inclui o ID do cliente e o segredo do cliente que são gerados quando você cria um OAuth aplicativo no portal do Azure. |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Microsoft Teams
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
},
"required": [
"tenantId"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"chatMessage": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"chatAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"channelPost": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"channelWiki": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"channelAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"meetingChat": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"meetingFile": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"meetingNote": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"calendarMeeting": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"paymentModel": {
"type": "string",
"enum": [
"A",
"B",
"Evaluation Mode"
]
},
"inclusionTeamNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionTeamNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionChannelNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionChannelNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionUserEmailFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"isCrawlChatMessage": {
"type": "boolean"
},
"isCrawlChatAttachment": {
"type": "boolean"
},
"isCrawlChannelPost": {
"type": "boolean"
},
"isCrawlChannelAttachment": {
"type": "boolean"
},
"isCrawlChannelWiki": {
"type": "boolean"
},
"isCrawlCalendarMeeting": {
"type": "boolean"
},
"isCrawlMeetingChat": {
"type": "boolean"
},
"isCrawlMeetingFile": {
"type": "boolean"
},
"isCrawlMeetingNote": {
"type": "boolean"
},
"startCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"endCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "MSTEAMS"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do Microsoft Yammer
Você inclui um JSON que contém o esquema da fonte de dados como parte do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)objeto. Especifique o tipo de fonte de dados como `YAMMER`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica `TEMPLATE` como o **Tipo** ao ligar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor.
A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft Yammer.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração sobre a fonte de dados |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint em repositoryEndpointMetadata. Em vez disso, as informações de conexão são incluídas em um AWS Secrets Manager segredo que você fornece secretArn a. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeia atributos de fonte de dados ou nomes de campos do Microsoft Yammer para nomes de campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| inclusionPatterns | Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Microsoft Yammer. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| exclusionPatterns | Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Microsoft Yammer. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| sinceDate | Opte por configurar um parâmetro psinceDate ara que o conector do Microsoft Yammer rastreie o conteúdo com base em um sinceDate específico. |
| communityNameFilter | Você pode optar por indexar um conteúdo específico da comunidade. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling de mensagens, anexos de mensagens e mensagens privadas. |
| type | Especifique YAMMER como seu tipo de fonte de dados. |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Microsoft Yammer. Isso inclui seu nome de usuário e senha do Microsoft Yammer, ID do cliente e segredo do cliente que são gerados quando você cria um OAuth aplicativo no portal do Azure. |
| useChangeLog | true para usar o log de alterações do Microsoft Yammer para determinar quais documentos precisam ser atualizados no índice. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
### Esquema JSON do Microsoft Yammer
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
}
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"community": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"user": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"message": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"inclusionPatterns": {
"type": "array"
},
"exclusionPatterns": {
"type": "array"
},
"sinceDate": {
"type": "string",
"pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])((\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]))?$"
},
"communityNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"isCrawlMessage": {
"type": "boolean"
},
"isCrawlAttachment": {
"type": "boolean"
},
"isCrawlPrivateMessage": {
"type": "boolean"
}
},
"required": [
"sinceDate"
]
},
"type": {
"type": "string",
"pattern": "YAMMER"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
},
"useChangeLog": {
"type": "string",
"enum": [
"true",
"false"
]
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
}
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"type",
"secretArn",
"syncMode"
]
}
```
## Esquema de modelo do MySQL
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `JDBC`, o tipo de banco de dados `mysql`, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema MySQL JSON](#mysql-json).
A tabela a seguir descreve os parâmetros do esquema JSON do MySQL.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações de configuração necessárias para conectar sua fonte de dados.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN do segredo. |
| document | Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados. |
| primaryKey | Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados. |
| titleColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| bodyColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| sqlQuery | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| timestampColumn | Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado. |
| timestampFormat | Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo. |
| timezone | Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado. |
| changeDetectingColumns | Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas |
| allowedUsersColumns | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| allowedGroupsColumn | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| fonte URIColumn | Insira o nome da coluna que contém URLs a Fonte a ser indexada. |
| isSslEnabled | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| type | O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"user name": "database user name",
"password": "password"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema MySQL JSON
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"dbType": {
"type": "string",
"enum": [
"mysql",
"db2",
"postgresql",
"oracle",
"sqlserver"
]
},
"dbHost": {
"type": "string"
},
"dbPort": {
"type": "string"
},
"dbInstance": {
"type": "string"
}
},
"required": [
"dbType",
"dbHost",
"dbPort",
"dbInstance"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string"
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
]
},
"additionalProperties": {
"type": "object",
"properties": {
"primaryKey": {
"type": "string"
},
"titleColumn": {
"type": "string"
},
"bodyColumn": {
"type": "string"
},
"sqlQuery": {
"type": "string",
"not": {
"pattern": ";+"
}
},
"timestampColumn": {
"type": "string"
},
"timestampFormat": {
"type": "string"
},
"timezone": {
"type": "string"
},
"changeDetectingColumns": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedUsersColumn": {
"type": "string"
},
"allowedGroupsColumn": {
"type": "string"
},
"sourceURIColumn": {
"type": "string"
},
"isSslEnabled": {
"type": "boolean"
}
},
"required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
},
"type" : {
"type" : "string",
"pattern": "JDBC"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelos do Oracle Database
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `JDBC`, o tipo de banco de dados `oracle`, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Oracle Database](#oracle-database-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Oracle Database.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações de configuração necessárias para conectar sua fonte de dados.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN do segredo. |
| document | Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados. |
| primaryKey | Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados. |
| titleColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| bodyColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| sqlQuery | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| timestampColumn | Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado. |
| timestampFormat | Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo. |
| timezone | Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado. |
| changeDetectingColumns | Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas |
| allowedUsersColumns | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| allowedGroupsColumn | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| fonte URIColumn | Insira o nome da coluna que contém URLs a Fonte a ser indexada. |
| isSslEnabled | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| type | O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"user name": "database user name",
"password": "password"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Oracle Database
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"dbType": {
"type": "string",
"enum": [
"mysql",
"db2",
"postgresql",
"oracle",
"sqlserver"
]
},
"dbHost": {
"type": "string"
},
"dbPort": {
"type": "string"
},
"dbInstance": {
"type": "string"
}
},
"required": [
"dbType",
"dbHost",
"dbPort",
"dbInstance"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string"
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
]
},
"additionalProperties": {
"type": "object",
"properties": {
"primaryKey": {
"type": "string"
},
"titleColumn": {
"type": "string"
},
"bodyColumn": {
"type": "string"
},
"sqlQuery": {
"type": "string",
"not": {
"pattern": ";+"
}
},
"timestampColumn": {
"type": "string"
},
"timestampFormat": {
"type": "string"
},
"timezone": {
"type": "string"
},
"changeDetectingColumns": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedUsersColumn": {
"type": "string"
},
"allowedGroupsColumn": {
"type": "string"
},
"sourceURIColumn": {
"type": "string"
},
"isSslEnabled": {
"type": "boolean"
}
},
"required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
},
"type" : {
"type" : "string",
"pattern": "JDBC"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do (PostgreSQL
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Especifique o tipo de fonte de dados como `JDBC`, o tipo de banco de dados `postgresql`, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do PostgreSQL](#postgresql-json).
A tabela a seguir descreve os parâmetros do esquema JSON do PostgreSQL.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações de configuração necessárias para conectar sua fonte de dados.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN do segredo. |
| document | Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados. |
| primaryKey | Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados. |
| titleColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| bodyColumn | Forneça o nome da coluna do título do documento na tabela do banco de dados. |
| sqlQuery | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| timestampColumn | Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado. |
| timestampFormat | Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo. |
| timezone | Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado. |
| changeDetectingColumns | Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas |
| allowedUsersColumns | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| allowedGroupsColumn | Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo. |
| fonte URIColumn | Insira o nome da coluna que contém URLs a Fonte a ser indexada. |
| isSslEnabled | Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta. |
| type | O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretArn | O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"user name": "database user name",
"password": "password"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do PostgreSQL
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"dbType": {
"type": "string",
"enum": [
"mysql",
"db2",
"postgresql",
"oracle",
"sqlserver"
]
},
"dbHost": {
"type": "string"
},
"dbPort": {
"type": "string"
},
"dbInstance": {
"type": "string"
}
},
"required": [
"dbType",
"dbHost",
"dbPort",
"dbInstance"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string"
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
]
},
"additionalProperties": {
"type": "object",
"properties": {
"primaryKey": {
"type": "string"
},
"titleColumn": {
"type": "string"
},
"bodyColumn": {
"type": "string"
},
"sqlQuery": {
"type": "string",
"not": {
"pattern": ";+"
}
},
"timestampColumn": {
"type": "string"
},
"timestampFormat": {
"type": "string"
},
"timezone": {
"type": "string"
},
"changeDetectingColumns": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedUsersColumn": {
"type": "string"
},
"allowedGroupsColumn": {
"type": "string"
},
"sourceURIColumn": {
"type": "string"
},
"isSslEnabled": {
"type": "boolean"
}
},
"required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
},
"type" : {
"type" : "string",
"pattern": "JDBC"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do Salesforce
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Forneça o URL do host do Salesforce como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `SALESFORCEV2`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Salesforce](#salesforce-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Salesforce.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| hostUrl | O URL da instância do Salesforce a ser indexado. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo de suas entidades do Salesforce para Amazon Kendra indexar nomes de campo. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Salesforce. O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
"consumerKey": "Application public key generated when you created your Salesforce application",
"consumerSecret": "Application private key generated when you created your Salesforce application",
"password": "Password associated with the user logging in to the Salesforce instance",
"securityToken": "Token associated with the user account logging in to the Salesforce instance",
"username": "User name of the user logging in to the Salesforce instance"
} |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma coleção de sequências de caracteres que especifica quais entidades filtrar. |
| inclusionPatterns [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Salesforce. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| exclusionPatterns [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressões regulares para excluir determinadas páginas e ativos em sua fonte de dados do Salesforce. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | true para fazer crawling desses tipos de arquivos em sua conta do Salesforce. |
| type | O tipo da fonte de dados. Especifique SALESFORCEV2 como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### Esquema JSON do Salesforce
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties":
{
"connectionConfiguration": {
"type": "object",
"properties":
{
"repositoryEndpointMetadata":
{
"type": "object",
"properties":
{
"hostUrl":
{
"type": "string",
"pattern": "https:.*"
}
},
"required":
[
"hostUrl"
]
}
},
"required":
[
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties":
{
"account":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"contact":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"campaign":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"case":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"product":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"lead":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"contract":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"partner":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"profile":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"idea":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"pricebook":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"task":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"solution":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"attachment":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"user":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"document":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"knowledgeArticles":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"group":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"opportunity":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"chatter":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"customEntity":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties":
{
"accountFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"contactFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"caseFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"campaignFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"contractFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"groupFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"leadFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"productFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"opportunityFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"partnerFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"pricebookFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"ideaFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"profileFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"taskFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"solutionFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"userFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"chatterFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"documentFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"knowledgeArticleFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"customEntities":{
"type": "array",
"items":
{
"type": "string"
}
},
"isCrawlAccount": {
"type": "boolean"
},
"isCrawlContact": {
"type": "boolean"
},
"isCrawlCase": {
"type": "boolean"
},
"isCrawlCampaign": {
"type": "boolean"
},
"isCrawlProduct": {
"type": "boolean"
},
"isCrawlLead": {
"type": "boolean"
},
"isCrawlContract": {
"type": "boolean"
},
"isCrawlPartner": {
"type": "boolean"
},
"isCrawlProfile": {
"type": "boolean"
},
"isCrawlIdea": {
"type": "boolean"
},
"isCrawlPricebook": {
"type": "boolean"
},
"isCrawlDocument": {
"type": "boolean"
},
"crawlSharedDocument": {
"type": "boolean"
},
"isCrawlGroup": {
"type": "boolean"
},
"isCrawlOpportunity": {
"type": "boolean"
},
"isCrawlChatter": {
"type": "boolean"
},
"isCrawlUser": {
"type": "boolean"
},
"isCrawlSolution":{
"type": "boolean"
},
"isCrawlTask":{
"type": "boolean"
},
"isCrawlAccountAttachments": {
"type": "boolean"
},
"isCrawlContactAttachments": {
"type": "boolean"
},
"isCrawlCaseAttachments": {
"type": "boolean"
},
"isCrawlCampaignAttachments": {
"type": "boolean"
},
"isCrawlLeadAttachments": {
"type": "boolean"
},
"isCrawlContractAttachments": {
"type": "boolean"
},
"isCrawlGroupAttachments": {
"type": "boolean"
},
"isCrawlOpportunityAttachments": {
"type": "boolean"
},
"isCrawlChatterAttachments": {
"type": "boolean"
},
"isCrawlSolutionAttachments":{
"type": "boolean"
},
"isCrawlTaskAttachments":{
"type": "boolean"
},
"isCrawlCustomEntityAttachments":{
"type": "boolean"
},
"isCrawlKnowledgeArticles": {
"type": "object",
"properties":
{
"isCrawlDraft": {
"type": "boolean"
},
"isCrawlPublish": {
"type": "boolean"
},
"isCrawlArchived": {
"type": "boolean"
}
}
},
"inclusionDocumentFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionDocumentFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionDocumentFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionDocumentFileNamePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionAccountFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionAccountFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionAccountFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionAccountFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCampaignFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCampaignFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCampaignFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCampaignFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCaseFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCaseFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCaseFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCaseFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContactFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContactFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContactFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContactFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContractFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContractFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContractFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContractFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionLeadFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionLeadFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionLeadFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionLeadFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionOpportunityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionOpportunityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionOpportunityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionOpportunityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionSolutionFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionSolutionFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionSolutionFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionSolutionFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionTaskFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionTaskFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionTaskFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionTaskFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionGroupFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionGroupFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionGroupFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionGroupFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionChatterFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionChatterFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionChatterFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionChatterFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCustomEntityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCustomEntityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCustomEntityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCustomEntityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
}
},
"required":
[]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"type": {
"type": "string",
"pattern": "SALESFORCEV2"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## ServiceNow esquema de modelo
Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você fornece o URL do ServiceNow host, o tipo de autenticação e a versão da instância como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `SERVICENOWV2`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [ServiceNow Esquema JSON](#servicenow-json).
A tabela a seguir descreve os parâmetros do esquema ServiceNow JSON.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| hostUrl | O URL do ServiceNow host. Por exemplo, .your-domain.service-now.com |
| authType | O tipo de autenticação que você usa: basicAuth ou OAuth2. |
| servicenowInstanceVersion | A ServiceNow versão que você usa. É possível escolher entre Tokyo, Sandiego, Rome e Others. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus artigos de ServiceNow conhecimento, anexos, catálogo de serviços e incidentes para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). Os nomes dos campos da fonte de ServiceNow dados devem existir nos seus metadados ServiceNow personalizados. |
| additional properties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| maxFileSizeInMegaBytes | Especifique o limite de tamanho do arquivo no MBs qual o Amazon Kendra rastreará. O Amazon Kendra fará crawling somente dos arquivos dentro do limite de tamanho definido. O tamanho de arquivo padrão é 50 MB. O tamanho máximo do arquivo deve ser maior que 0 MB e menor que ou igual a 50 MB. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de padrões de expressão regular para incluir e and/or excluir determinados arquivos em sua fonte ServiceNow de dados. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | truepara rastrear artigos de ServiceNow conhecimento, catálogos de serviços, incidentes e anexos. |
| type | O tipo da fonte de dados. Especifique SERVICENOWV2 como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| secretARN | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. ServiceNow O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"username": "user name",
"password": "password"
} Se você usa OAuth2 autenticação, seu segredo deve conter uma estrutura JSON com as seguintes chaves: {
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
} |
| version | Atualmente, apenas a versão do modelo tem suporte. |
### ServiceNow Esquema JSON
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"hostUrl": {
"type": "string",
"pattern": "^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(.service-now.com|.servicenowservices.com)$",
"minLength": 1,
"maxLength": 2048
},
"authType": {
"type": "string",
"enum": [
"basicAuth",
"OAuth2"
]
},
"servicenowInstanceVersion": {
"type": "string",
"enum": [
"Tokyo",
"Sandiego",
"Rome",
"Others"
]
}
},
"required": [
"hostUrl",
"authType",
"servicenowInstanceVersion"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"knowledgeArticle": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"LONG",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"serviceCatalog": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"incident": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"maxFileSizeInMegaBytes": {
"type": "string"
},
"isCrawlKnowledgeArticle": {
"type": "boolean"
},
"isCrawlKnowledgeArticleAttachment": {
"type": "boolean"
},
"includePublicArticlesOnly": {
"type": "boolean"
},
"knowledgeArticleFilter": {
"type": "string"
},
"incidentQueryFilter": {
"type": "string"
},
"serviceCatalogQueryFilter": {
"type": "string"
},
"isCrawlServiceCatalog": {
"type": "boolean"
},
"isCrawlServiceCatalogAttachment": {
"type": "boolean"
},
"isCrawlActiveServiceCatalog": {
"type": "boolean"
},
"isCrawlInactiveServiceCatalog": {
"type": "boolean"
},
"isCrawlIncident": {
"type": "boolean"
},
"isCrawlIncidentAttachment": {
"type": "boolean"
},
"isCrawlActiveIncident": {
"type": "boolean"
},
"isCrawlInactiveIncident": {
"type": "boolean"
},
"applyACLForKnowledgeArticle": {
"type": "boolean"
},
"applyACLForServiceCatalog": {
"type": "boolean"
},
"applyACLForIncident": {
"type": "boolean"
},
"incidentStateType": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Open",
"Open - Unassigned",
"Resolved",
"All"
]
}
},
"knowledgeArticleTitleRegExp": {
"type": "string"
},
"serviceCatalogTitleRegExp": {
"type": "string"
},
"incidentTitleRegExp": {
"type": "string"
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "SERVICENOWV2"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
```
## Esquema de modelo do Slack
Você inclui um JSON que contém o esquema da fonte de dados como parte do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)objeto. Forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `SLACK`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Slack](#slack-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Slack.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| teamId | O ID de equipe do Slack que você copiou do URL da página principal do Slack. |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campos. |
| Todos | Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu Slack conteúdo para Amazon Kendra indexar nomes de campos. |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| inclusionPatterns | Uma lista de padrões de expressões regulares para incluir conteúdo específico na fonte de dados do Slack. O conteúdo que corresponde aos padrões é incluído no índice. O conteúdo que não corresponde aos padrões é excluído do índice. Se qualquer conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice. |
| exclusionPatterns | Uma lista de padrões de expressões regulares para excluir conteúdo específico da fonte de dados do Slack. O conteúdo que corresponde aos padrões é excluído do índice. O conteúdo que não corresponde aos padrões é incluído no índice. Se qualquer conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice. |
| crawlBotMessages | truepara rastrear mensagens de bots. |
| excludeArchived | true para excluir o crawling de mensagens arquivadas. |
| conversationType | O tipo de conversa que você deseja indexar, seja PUBLIC\$1CHANNEL, PRIVATE\$1CHANNEL, GROUP\$1MESSAGE e DIRECT\$1MESSAGE. |
| channelFilter | O tipo de canal que você deseja indexar, seja private\$1channel ou public\$1channel. |
| sinceDate | Você pode optar por configurar um parâmetro sinceDate para que o conector do Slack realize crawling no conteúdo com base em um sinceDate específico. |
| lookBack | É possível optar por configurar um parâmetro lookBack para que o conector do Slack faça crawling do conteúdo atualizado ou excluído até um número específico de horas antes da última sincronização do conector. |
| syncMode | Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) |
| type | O tipo da fonte de dados. Especifique SLACK como seu tipo de fonte de dados. |
| enableIdentityCrawler | trueusar o rastreador Amazon Kendra de identidade para sincronizar identity/principal informações sobre usuários e grupos com acesso a determinados documentos. Se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você pode usar como alternativa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) para fazer upload de informações de acesso de usuários e grupos. |
| secretArn | O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. Slack O segredo deve conter uma estrutura JSON com as seguintes chaves: {
"slackToken": "token"
} |
| version | A versão desse modelo aceita no momento. |
### Esquema JSON do Slack
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"teamId": {
"type": "string"
}
},
"required": ["teamId"]
}
}
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"All": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE","LONG"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
]
},
"additionalProperties": {
"type": "object",
"properties": {
"exclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"crawlBotMessages": {
"type": "boolean"
},
"excludeArchived": {
"type": "boolean"
},
"conversationType": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PUBLIC_CHANNEL",
"PRIVATE_CHANNEL",
"GROUP_MESSAGE",
"DIRECT_MESSAGE"
]
}
},
"channelFilter": {
"type": "object",
"properties": {
"private_channel": {
"type": "array",
"items": {
"type": "string"
}
},
"public_channel": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"channelIdFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"sinceDate": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"lookBack": {
"type": "string",
"pattern": "^[0-9]*$"
}
},
"required": [
]
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"type" : {
"type" : "string",
"pattern": "SLACK"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type",
"enableIdentityCrawler"
]
}
```
## Esquema do modelo do Zendesk
Você inclui um JSON que contém o esquema da fonte de dados como parte do [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)objeto. Forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como `ZENDESK`, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique `TEMPLATE` como `Type` ao chamar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte [Esquema JSON do Zendesk](#zendesk-json).
A tabela a seguir descreve os parâmetros do esquema JSON do Zendesk.
| Configuração | Description |
| --- | --- |
| connectionConfiguration | Informações de configuração para o endpoint da fonte de dados. |
| repositoryEndpointMetadata | Informações do endpoint da fonte de dados. |
| hostURL | O URL do host do Zendesk. Por exemplo, .https://yoursubdomain.zendesk.com |
| repositoryConfigurations | Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Uma lista de objetos que mapeia atributos de fonte de dados ou nomes de campos do Zendesk para nomes de campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| secretARN | O nome de recurso da Amazon (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Zendesk. A senha deve conter uma estrutura JSON com as seguintes chaves: URL do host, ID do cliente, senha do cliente, nome de usuário e senha. |
| additionalProperties | Opções adicionais de configuração para o conteúdo em sua fonte de dados. |
| organizationNameFilter | Você pode optar por indexar os tíquetes em uma organização específica. |
| sinceDate | Você pode optar por configurar um parâmetro sinceDatepara que o conector do Zendesk rastreie o conteúdo com base em um sinceDate específico. |
| inclusionPatterns | Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Zendesk. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| exclusionPatterns | Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Zendesk. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/ds-schemas.html) | Insira “true” para fazer crawling desses tipos de conteúdo. |
| type | Especifique ZENDESK como seu tipo de fonte de dados. |
| useChangeLog | Insira “true” para usar o log de alterações do Zendesk para determinar quais documentos precisam ser atualizados no índice. Dependendo do tamanho do log de alterações, talvez seja mais rápido digitalizar os documentos no Zendesk. Se estiver sincronizando a fonte de dados do Zendesk com o índice pela primeira vez, todos os documentos serão digitalizados. |
### Esquema JSON do Zendesk
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"hostUrl": {
"type": "string",
"pattern": "https:.*"
}
},
"required": [
"hostUrl"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"ticket": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"ticketComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"ticketCommentAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"article": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"communityPostComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"articleComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"articleAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"communityTopic": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
}
}
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
},
"additionalProperties": {
"type": "object",
"properties": {
"organizationNameFilter": {
"type": "array"
},
"sinceDate": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
},
"inclusionPatterns": {
"type": "array"
},
"exclusionPatterns": {
"type": "array"
},
"isCrawTicket": {
"type": "string"
},
"isCrawTicketComment": {
"type": "string"
},
"isCrawTicketCommentAttachment": {
"type": "string"
},
"isCrawlArticle": {
"type": "string"
},
"isCrawlArticleAttachment": {
"type": "string"
},
"isCrawlArticleComment": {
"type": "string"
},
"isCrawlCommunityTopic": {
"type": "string"
},
"isCrawlCommunityPost": {
"type": "string"
},
"isCrawlCommunityPostComment": {
"type": "string"
}
}
},
"type": {
"type": "string",
"pattern": "ZENDESK"
},
"useChangeLog": {
"type": "string",
"enum": ["true", "false"]
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"additionalProperties": false,
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"useChangeLog",
"secretArn",
"type"
]
}
```
# Adobe Experience Manager
**nota**
O conector do Adobe Experience Manager permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O Adobe Experience Manager é um sistema de gerenciamento de conteúdo usado para criar conteúdo de site ou aplicativo móvel. Você pode usar Amazon Kendra para se conectar Adobe Experience Manager e indexar suas páginas e ativos de conteúdo.
Amazon Kendrasuporta Adobe Experience Manager (AEM) como instância de autor do Cloud Service e instância de autoria e Adobe Experience Manager publicação no local.
Você pode se conectar Amazon Kendra à sua fonte de Adobe Experience Manager dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Adobe Experience Manager, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-aem)
+ [
## Pré-requisitos
](#prerequisites-aem)
+ [
## Instruções de conexão
](#data-source-procedure-aem)
## Recursos compatíveis
o conector de fonte de dados do Adobe Experience Manager oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ OAuth 2.0 e autenticação básica
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Adobe Experience Manager dados, faça essas alterações em suas Adobe Experience Manager AWS contas.
**No Adobe Experience Manager, verifique se você:**
+ Acesso a uma conta com privilégios administrativos ou a um usuário administrador.
+ Copiou o URL do host do Adobe Experience Manager.
**nota**
(Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são iguais às informações do endpoint especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o [problema de assistência confusa](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html), que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.
+ Você anotou as credenciais básicas de autenticação do nome de usuário e senha do administrador.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional**: Credenciais OAuth 2.0 configuradas no Adobe Experience Manager (AEM) como um serviço de nuvem ou AEM On-Premise. Se você usa o AEM on-premises, as credenciais incluem o ID do cliente, a senha do cliente e chave privada. Se você usa o AEM como um serviço de nuvem, as credenciais incluem o ID do cliente, a senha do cliente, a chave privada, o ID da organização, o ID da conta técnica e o host (IMS) do Adobe Identity Management System. Para obter mais informações sobre como gerar essas credenciais para o AEM como serviço de nuvem, consulte a [documentação do Adobe Experience Manager](https://experienceleague.adobe.com/docs/experience-manager-learn/getting-started-with-aem-headless/authentication/service-credentials.html). Para o AEM On-Premise, a implementação do servidor Adobe Granite OAuth 2.0 (com.adobe.granite.oauth.server) fornece suporte às funcionalidades do servidor OAuth 2.0 no AEM.
+ Verifique se cada documento é exclusivo no Adobe Experience Manager e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Adobe Experience Manager em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Adobe Experience Manager Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Adobe Experience Manager dados, você deve fornecer os detalhes necessários da sua fonte de Adobe Experience Manager dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Adobe Experience Manager paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-aem).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Adobe Experience Manager**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Adobe Experience Manager** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Adobe Experience Manager** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir acesso e segurança**, insira as informações a seguir:
1. **Fonte**: escolha o **AEM on-premises** ou o **AEM como um serviço em nuvem**.
Insira o URL do host do Adobe Experience Manager. Por exemplo, ao usar o AEM on-premises, inclua o nome do host e a porta:. *https://hostname:port* Ou, ao usar o AEM como um serviço de nuvem, use a URL do autor: *https://author-xxxxxx-xxxxxxx.adobeaemcloud.com*.
1. **Local do certificado SSL**: insira o caminho para o certificado SSL armazenado em um bucket do Amazon S3. Você usa isso para se conectar ao AEM On-Premise com uma conexão SSL segura.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Autenticação** — escolha **Autenticação básica** ou **autenticação OAuth 2.0**. Em seguida, escolha um AWS Secrets Manager segredo existente ou crie um novo segredo para armazenar suas Adobe Experience Manager credenciais. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta será aberta.
Se escolher a **Autenticação básica**, insira um nome para a senha, o nome de usuário e a senha do site do Adobe Experience Manager. O usuário deve ter permissão de administrador ou ser um usuário administrador.
Se você escolheu a **autenticação OAuth 2.0** e usa o AEM On-Premise, insira um nome para o segredo, ID do cliente, segredo do cliente e chave privada. Se você usa o AEM como um serviço de nuvem, insira um nome para a senha, o ID do cliente, a senha do cliente, a chave privada, o ID da organização, o ID da conta técnica e o host (IMS) do Adobe Identity Management System.
Salve e adicione seu segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Escopo de sincronização**: defina limites de crawling determinados tipos de conteúdo, componentes da página e caminhos raiz e filtre o conteúdo usando padrões de expressão regex.
1. **Tipos de conteúdo**: escolha se deseja rastrear somente páginas, ativos ou os dois.
1. (Opcional) **Configurações adicionais**: defina as seguintes configurações opcionais:
+ **Componentes da página**: os nomes específicos dos componentes da página. O componente de página é um componente de página extensível projetado para funcionar com o editor de Adobe Experience Manager modelos e permite que componentes de página header/footer e estrutura sejam montados com o editor de modelos.
+ **Variações de fragmentos de conteúdo**: os nomes específicos das variações de fragmentos de conteúdo. Os fragmentos de conteúdo permitem que você projete, crie, organize e publique conteúdo independente de página no Adobe Experience Manager. Eles permitem que você prepare conteúdo pronto para uso em locations/over vários canais.
+ **Caminhos raiz**: os caminhos raiz para um conteúdo específico.
+ **Padrões Regex**: os padrões de expressão regular para incluir ou excluir determinadas páginas e ativos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. **ID do fuso horário**: se você usa o AEM on-premises e o fuso horário do servidor é diferente do fuso horário do conector ou índice do AEM do Amazon Kendra, especifique o fuso horário do servidor para alinhar com o conector ou índice do AEM. O fuso horário padrão para o AEM on-premises é o fuso horário do conector ou índice do AEM do Amazon Kendra. O fuso horário padrão para o AEM como serviço de nuvem é o Greenwich Mean Time.
1. **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Adobe Experience Manager**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-aem-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `AEM` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **URL do host do AEM**: especifique a URL do host do Adobe Experience Manager. Por exemplo, ao usar o AEM on-premises, inclua o nome do host e a porta:. *https://hostname:port* Ou, ao usar o AEM como um serviço de nuvem, use a URL do autor: *https://author-xxxxxx-xxxxxxx.adobeaemcloud.com*.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Tipo de autenticação**: especifique qual tipo de autenticação deseja usar: `Basic` ou `OAuth2`.
+ **Tipo de AEM**: especifique o tipo de Adobe Experience Manager usado: `CLOUD` ou `ON_PREMISE`.
+ **Nome do recurso da Amazon (ARN) da senha**: se quiser usar a autenticação básica para o AEM on-Premises ou Cloud, forneça uma senha que armazena as credenciais de autenticação do nome de usuário e da senha. Você fornece o Amazon Resource Name (ARN) de um AWS Secrets Manager segredo. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"aemUrl": "Adobe Experience Manager On-Premise host URL",
"username": "user name with admin permissions",
"password": "password with admin permissions"
}
```
Se você quiser usar a autenticação OAuth 2.0 para o AEM On-Premise, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"aemUrl": "Adobe Experience Manager host URL",
"clientId": "client ID",
"clientSecret": "client secret",
"privateKey": "private key"
}
```
Se você quiser usar a autenticação OAuth 2.0 para o AEM como um serviço de nuvem, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"clientId": "client ID",
"clientSecret": "client secret",
"privateKey": "private key",
"orgId": "organization ID",
"technicalAccountId": "technical account ID",
"imsHost": "Adobe Identity Management System (IMS) host"
}
```
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Adobe Experience Manager e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Adobe Experience Manager](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **ID do fuso horário** — Se você usa o AEM On-Premise e o fuso horário do seu servidor é diferente do fuso horário do conector ou índice do Amazon Kendra AEM, você pode especificar o fuso horário do servidor para se alinhar ao conector ou índice do AEM.
O fuso horário padrão para o AEM On-Premise é o fuso horário do conector ou índice do Amazon Kendra AEM. O fuso horário padrão para o AEM como serviço de nuvem é o Greenwich Mean Time.
Para obter informações sobre os fusos horários compatíveis IDs, consulte [Adobe Experience ManagerEsquema JSON](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#aem-json).
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas páginas e ativos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Adobe Experience Manager para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Adobe Experience Manager](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-aem-schema).
------
# Alfresco
**nota**
O conector do Alfresco permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Em relação a futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
OAlfresco é um serviço de gerenciamento de conteúdo que ajuda os clientes a armazenar e gerenciar o conteúdo. Você pode usar Amazon Kendra para indexar sua biblioteca de Alfresco documentos, Wiki e blog.
Amazon Kendraoferece suporte Alfresco local e Alfresco na nuvem (plataforma como serviço).
Você pode se conectar Amazon Kendra à sua fonte de Alfresco dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados Amazon Kendra Alfresco, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-alfresco)
+ [
## Pré-requisitos
](#prerequisites-alfresco)
+ [
## Instruções de conexão
](#data-source-procedure-alfresco)
+ [
## Saiba mais
](#alfresco-learn-more)
## Recursos compatíveis
o conector de fonte de dados do Amazon KendraAlfresco oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ OAuth 2.0 e autenticação básica
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Alfresco, faça essas alterações em seu Alfresco e. Contas da AWS
**No Alfresco, verifique se você:**
+ Copiou o URL do repositório do Alfresco e o URL da aplicação da Web. Se quiser indexar apenas um site específico do Alfresco, copie também o ID do site.
+ Anote suas credenciais de autenticação do Alfresco, que incluem um nome de usuário e senha com no mínimo permissão de leitura. Se quiser usar a autenticação OAuth 2.0, você deve adicionar o usuário ao grupo de Alfresco administradores.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional**: Credenciais OAuth 2.0 configuradas emAlfresco. As credenciais incluem ID do cliente, senha do cliente e URL do token. Para obter mais informações sobre como configurar clientes no Alfresco on-premises, consulte a [documentação do Alfresco](https://docs.alfresco.com/identity-service/latest/tutorial/sso/saml/). Se você usa o Alfresco Cloud (PaaS), deve entrar em contato com o [suporte da Hyland](https://community.hyland.com/) para obter a autenticação Alfresco OAuth 2.0.
+ Verifique se cada documento é exclusivo no Alfresco e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou as credenciais de autenticação do Alfresco em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Alfresco a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Alfresco, você deve fornecer os detalhes necessários da sua fonte de dados do Alfresco para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Alfresco paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-alfresco).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Alfresco**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Alfresco** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Alfresco** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Tipo do Alfresco**: escolha usar o Alfresco On-Premises/Server ou o Alfresco Cloud (plataforma como serviço).
1. **URL do repositório do Alfresco**: insira o URL do repositório do Alfresco. Por exemplo, se você usa o Cloud (PaaS) do Alfresco, o URL do repositório pode ser *https://company.alfrescocloud.com*. Ou, se você usa o Alfredo on-premises, o URL do repositório pode ser *https://company-alfresco-instance.company-domain.suffix:port*.
1. **Aplicativo do usuário do Alfresco. URL**: insira o URL da interface de usuário do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, o URL da interface do usuário pode ser *https://example.com*.
1. **Local do certificado SSL** — Insira o caminho para o certificado SSL armazenado em um bucket. Amazon S3 Você usa isso para se conectar ao Alfresco on-premises com uma conexão SSL segura.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Autenticação** — escolha **Autenticação básica** ou **autenticação OAuth 2.0**. Em seguida, escolha uma senha do Secrets Manager existente ou crie um novo segredo para armazenar as credenciais do Alfresco. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta será aberta.
Se escolher a **Autenticação básica**, insira um nome para a senha, o nome de usuário e a senha do Alfresco.
Se você escolheu a **autenticação OAuth 2.0**, insira um nome para o segredo, ID do cliente, segredo do cliente e URL do token.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Escopo de sincronização**: defina limites de crawling determinados e filtre o conteúdo usando padrões de expressão regex.
1.
1. **Conteúdo**: escolha se deseja rastrear conteúdo marcado com “Aspectos” no Alfresco, conteúdo em um site específico do Alfresco ou conteúdo em todos os sites do Alfresco.
1. (Opcional) **Configurações adicionais**: defina as seguintes configurações opcionais:
+ **Incluir comentários**: escolha incluir comentários na biblioteca de documentos e no blog do Alfresco.
+ **Padrões Regex**: os padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Alfresco**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-alfresco-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `ALFRESCO` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID do site do Alfresco**: especifique o ID do site do Alfresco.
+ **URL do repositório do Alfresco**: especifique o URL do repositório do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, se você usa o Cloud (PaaS) do Alfresco, o URL do repositório pode ser *https://company.alfrescocloud.com*. Ou, se você usa o Alfredo on-premises, o URL do repositório pode ser *https://company-alfresco-instance.company-domain.suffix:port*.
+ **URL do aplicativo da Web do Alfresco**: especifique o URL da interface do usuário do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, o URL da interface do usuário pode ser *https://example.com*.
+ **Tipo de autenticação**: especifique qual tipo de autenticação deseja usar: `OAuth2` ou `Basic`.
+ **Tipo do Alfresco**: especifique qual o tipo do Alfresco uado: `PAAS` (nuvem/plataforma como serviço) ou `ON_PREM` (on-premises).
+ **Nome do recurso da Amazon (ARN) da senha**: para usar a autenticação básica, forneça uma senha que armazena as credenciais de autenticação do nome de usuário e da senha. Você fornece o Amazon Resource Name (ARN) de um AWS Secrets Manager segredo. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password"
}
```
Se você quiser usar a autenticação OAuth 2.0, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"clientId": "client ID",
"clientSecret": "client secret",
"tokenUrl": "token URL"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Alfresco e. Amazon Kendra Para obter mais informações, [Funções do IAM para fontes de dados do Alfresco](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Tipo de conteúdo**: o tipo de conteúdo que você deseja rastrear, seja um conteúdo marcado com “Aspectos” no Alfresco, conteúdo em um site específico do Alfresco ou conteúdo em todos os sites do Alfresco. Você também pode listar conteúdo específico de “Aspectos”.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Alfresco para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Alfresco](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-alfresco-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Alfresco, consulte:
+ [Pesquise Alfresco conteúdo de forma inteligente usando Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/intelligently-search-alfresco-content-using-amazon-kendra/)
# Aurora(MySQL)
**nota**
O conector do Aurora(MySQL) permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
Auroraé um sistema de gerenciamento de banco de dados relacional (RDBMS) criado para a nuvem. Se você for um Aurora usuário, poderá usar Amazon Kendra para indexar sua fonte Aurora(MySQL) de dados. O conector da fonte de Amazon Kendra Aurora(MySQL) dados oferece suporte ao Aurora MySQL 3 e ao Aurora Serverless MySQL 8.0.
Você pode se conectar Amazon Kendra à sua fonte de Aurora(MySQL) dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Aurora(MySQL) dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-aurora-mysql)
+ [
## Pré-requisitos
](#prerequisites-aurora-mysql)
+ [
## Instruções de conexão
](#data-source-procedure-aurora-mysql)
+ [
## Observações
](#aurora-mysql-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Aurora(MySQL) dados, faça essas alterações em suas Aurora(MySQL) AWS contas.
**Em Aurora(MySQL), verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados. Você pode encontrar essas informações no Amazon RDS console.
+ Verifique se cada documento é exclusivo em Aurora(MySQL) e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Aurora(MySQL) em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Aurora(MySQL) dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Aurora(MySQL) dados, você deve fornecer detalhes de suas Aurora(MySQL) credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Aurora(MySQL) para Amazon Kendra ver[Pré-requisitos](#prerequisites-aurora-mysql).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Aurora(MySQL)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Aurora(MySQL)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Aurora(MySQL)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o URL do host do banco de dados; por exemplo: `http://instance URL.region.rds.amazonaws.com`.
1. **Porta**: insira a porta do banco de dados; por exemplo, `5432`.
1. **Instância**: insira a instância do banco de dados.
1. **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Aurora(MySQL) autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Aurora(MySQL) -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB As consultas SQL devem ter menos de 32 KB e não conter ponto e vírgula (;). Amazon Kendrarastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Aurora(MySQL)**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `mySql`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Aurora(MySQL) A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Aurora(MySQL) conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Aurora(MySQL)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Aurora(MySQL) para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Aurora Esquema de modelo (MySQL)](ds-schemas.md#ds-aurora-mysql-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Aurora(PostgreSQL)
**nota**
O conector do Aurora(PostgreSQL) permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
Auroraé um sistema de gerenciamento de banco de dados relacional (RDBMS) criado para a nuvem. Se você for um Aurora usuário, poderá usar Amazon Kendra para indexar sua fonte Aurora(PostgreSQL) de dados. O conector da fonte de Amazon Kendra Aurora(PostgreSQL) dados é compatível com o Aurora PostgreSQL 1.
Você pode se conectar Amazon Kendra à sua fonte de Aurora(PostgreSQL) dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Aurora(PostgreSQL) dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-aurora-postgresql)
+ [
## Pré-requisitos
](#prerequisites-aurora-postgresql)
+ [
## Instruções de conexão
](#data-source-procedure-aurora-postgresql)
+ [
## Observações
](#aurora-postgresql-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Aurora(PostgreSQL) dados, faça essas alterações em suas Aurora(PostgreSQL) AWS contas.
**Em Aurora(PostgreSQL), verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em Aurora(PostgreSQL) e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Aurora(PostgreSQL) em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Aurora(PostgreSQL) dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Aurora(PostgreSQL) dados, você deve fornecer detalhes de suas Aurora(PostgreSQL) credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Aurora(PostgreSQL) para Amazon Kendra ver[Pré-requisitos](#prerequisites-aurora-postgresql).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Aurora(PostgreSQL)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Aurora(PostgreSQL)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Aurora(PostgreSQL)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o URL do host do banco de dados; por exemplo: `http://instance URL.region.rds.amazonaws.com`.
1. **Porta**: insira a porta do banco de dados; por exemplo, `5432`.
1. **Instância**: insira a instância de banco de dados; por exemplo, `postgres`.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Aurora(PostgreSQL) autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Aurora(PostgreSQL) -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB As consultas SQL devem ter menos de 32 KB e não conter ponto e vírgula (;). Amazon Kendrarastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Aurora(PostgreSQL)**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `postgresql`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Aurora(PostgreSQL) A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Aurora(PostgreSQL) conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Aurora(PostgreSQL)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Aurora(PostgreSQL) para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Aurora Esquema de modelo (PostgreSQL)](ds-schemas.md#ds-aurora-postgresql-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Amazon FSx(Windows)
Amazon FSx(Windows) é um sistema de servidor de arquivos baseado em nuvem totalmente gerenciado que oferece recursos de armazenamento compartilhado. Se você for um usuário Amazon FSx (Windows), você pode usar Amazon Kendra para indexar sua fonte de dados Amazon FSx (Windows).
**nota**
Amazon Kendraagora oferece suporte a um conector atualizado Amazon FSx (Windows).
O console do foi atualizado automaticamente para você. Todos os novos conectores que você cria no console usam a arquitetura atualizada. Se usa a API, agora você deve passar a usar o objeto [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) em vez do `FSxConfiguration` para configurar o conector.
Os conectores configurados usando o console antigo e a arquitetura de API continuam funcionando conforme configurados. No entanto, não é possível editá-los nem atualizá-los. Se você quer editar ou atualizar a configuração do conector, será necessário criar outro conector.
Recomendamos migrar o fluxo de trabalho do conector para a versão atualizada. O suporte para conectores configurados usando a arquitetura mais antiga está programado para terminar em junho de 2024.
Você pode se conectar Amazon Kendra à sua fonte de dados Amazon FSx (Windows) usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados Amazon Kendra Amazon FSx (Windows), consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-fsx)
+ [
## Pré-requisitos
](#prerequisites-fsx)
+ [
## Instruções de conexão
](#data-source-procedure-fsx)
+ [
## Saiba mais
](#fsx-learn-more)
## Recursos compatíveis
Amazon KendraAmazon FSxO conector de fonte de dados (Windows) oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Crawling de identidade de usuário
+ Filtros de inclusão e exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de usar Amazon Kendra para indexar sua fonte de dados Amazon FSx (Windows), verifique os detalhes de seu Amazon FSx (Windows) Contas da AWS e.
**Para Amazon FSx (Windows), verifique se você tem**:
+ Configure Amazon FSx (Windows) com permissões de leitura e montagem.
+ Anotou o ID do sistema de arquivos. Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no console Amazon FSx (Windows).
+ Configurou uma nuvem privada virtual usando Amazon VPC onde seu sistema de arquivos Amazon FSx (Windows) reside.
+ Anotou suas credenciais de autenticação Amazon FSx (Windows) para uma conta de Active Directory usuário. Isso inclui o nome de usuário do Active Directory com o nome de domínio DNS (por exemplo, *user@corp.example.com*) e a senha.
**nota**
Use somente as credenciais necessárias para que o conector funcione. Não use credenciais privilegiadas, como administrador de domínio.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Verificado se cada documento é exclusivo no Amazon FSx (Windows) e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação Amazon FSx (Windows) em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados Amazon FSx (Windows) Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados Amazon FSx (Windows), você deve fornecer os detalhes necessários da sua fonte de dados Amazon FSx (Windows) para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Amazon FSx (Windows) paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-fsx).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao seu sistema de arquivos Amazon FSx (Windows)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Amazon FSx (Windows)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Amazon FSx (Windows)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Amazon FSxID do sistema de arquivos (Windows)** — Selecione na lista suspensa sua ID do sistema de arquivos existente, obtida Amazon FSx em (Windows). Ou crie um [sistema de arquivos do Amazon FSx (Windows)](https://console.aws.amazon.com/fsx/). Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no console Amazon FSx (Windows).
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Autenticação** — escolha um AWS Secrets Manager segredo existente ou crie um novo segredo para armazenar suas credenciais do sistema de arquivos. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
Forneça um segredo que armazene as credenciais de autenticação de nome de usuário e senha. O nome de usuário deve incluir o nome de domínio DNS. Por exemplo, *user@corp.example.com*.
Salve e adicione o segredo.
1. **Virtual Private Cloud (VPC)** — Você deve selecionar um Amazon VPC local onde seu Amazon FSx (Windows) reside. Você inclui a sub-rede da VPC e os grupos de segurança. Consulte [Configurando um Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Escopo de sincronização, padrões regex**: adicione padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. **Programação de execução de sincronização**: em **Frequência**, escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos padrão Amazon Kendra gerados dos seus arquivos que você deseja mapear para o seu índice. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao seu sistema de arquivos Amazon FSx (Windows)**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `FSX` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID do sistema de arquivos** — O identificador do sistema de arquivos Amazon FSx (Windows). É possível encontrar o ID do sistema de arquivos no painel de sistemas de arquivos no console do Amazon FSx (Windows).
+ **Tipo de sistema de arquivos**: especifique o tipo de sistema de arquivos como `WINDOWS`.
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
**nota**
Você deve selecionar um Amazon VPC local onde seu Amazon FSx (Windows) resida. Você inclui a sub-rede da VPC e os grupos de segurança.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta (Windows). Amazon FSx A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user@corp.example.com",
"password": "password"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Amazon FSx (Windows) e. Amazon Kendra Para obter mais informações, consulte [IAMfunções para fontes de dados Amazon FSx (Windows)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
**nota**
Para testar a filtragem de contexto de usuário em um usuário, você deve incluir o nome de domínio DNS como parte do nome de usuário ao realizar a consulta. Você deve ter permissões administrativas do domínio do Active Directory. Você também pode testar a filtragem de contexto do usuário no nome de um grupo.
+ **Mapeamentos de campo — Escolha mapear** seus campos de fonte de dados Amazon FSx (Windows) para seus Amazon Kendra campos de índice. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Consulte uma lista de outras chaves JSON importantes a serem configuradas em [Esquema do modelo do Amazon FSx (Windows)](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-windows-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados Amazon FSx (Windows), consulte:
+ [Pesquise com segurança dados não estruturados em sistemas de arquivos Windows com o Amazon Kendra conector para Amazon FSx (Windows) para](https://aws.amazon.com/blogs/machine-learning/securely-search-unstructured-data-on-windows-file-systems-with-amazon-kendra-connector-for-amazon-fsx-for-windows-file-server/). Windows File Server
# Amazon FSx(EM UM NetApp TOQUE)
Amazon FSx(NetApp ONTAP) é um sistema de servidor de arquivos baseado em nuvem totalmente gerenciado que oferece recursos de armazenamento compartilhado. Se você for um usuário Amazon FSx (NetApp ONTAP), você pode usar Amazon Kendra para indexar sua fonte de dados Amazon FSx (NetApp ONTAP).
Você pode se conectar Amazon Kendra à sua fonte de dados Amazon FSx (NetApp ONTAP) usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados Amazon Kendra Amazon FSx (NetApp ONTAP), consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-fsx-ontap)
+ [
## Pré-requisitos
](#prerequisites-fsx-ontap)
+ [
## Instruções de conexão
](#data-source-procedure-fsx-ontap)
## Recursos compatíveis
Amazon KendraAmazon FSxO conector de fonte de dados (NetApp ONTAP) oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão e exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de usar Amazon Kendra para indexar sua fonte de dados Amazon FSx (NetApp ONTAP), verifique os detalhes de sua Amazon FSx (NetApp ONTAP) e. Contas da AWS
**Para Amazon FSx (NetApp ONTAP), verifique se você tem**:
+ Configure Amazon FSx (NetApp ONTAP) com permissões de leitura e montagem.
+ Anotou o ID do sistema de arquivos. Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no console Amazon FSx (NetApp ONTAP).
+ Anotou o ID da máquina virtual de armazenamento (SVM) usado com o sistema de arquivos. Você pode encontrar sua ID SVM acessando o painel Sistemas de arquivos no console Amazon FSx (NetApp ONTAP), selecionando a ID do sistema de arquivos e, em seguida, selecionando Máquinas **virtuais de armazenamento**.
+ Configurou uma nuvem privada virtual usando Amazon VPC onde seu sistema de arquivos Amazon FSx (NetApp ONTAP) reside.
+ Anotou suas credenciais de autenticação Amazon FSx (NetApp ONTAP) para uma conta de Active Directory usuário. Isso inclui o nome de usuário do Active Directory com o nome de domínio DNS (por exemplo, *user@corp.example.com*) e a senha. Se você usa o protocolo Network File System (NFS) para seu sistema de arquivos Amazon FSx (NetApp ONTAP), as credenciais de autenticação incluem uma ID esquerda, uma ID direita e uma chave pré-compartilhada.
**nota**
Use somente as credenciais necessárias para que o conector funcione. Não use credenciais privilegiadas, como administrador de domínio.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Verifique se cada documento é exclusivo no Amazon FSx (NetApp ONTAP) e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação Amazon FSx (NetApp ONTAP) em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados Amazon FSx (NetApp ONTAP) a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados Amazon FSx (NetApp ONTAP), você deve fornecer os detalhes necessários da sua fonte de dados Amazon FSx (NetApp ONTAP) para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Amazon FSx (NetApp ONTAP) paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-fsx-ontap).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao seu sistema de arquivos Amazon FSx (NetApp ONTAP)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha **conector Amazon FSx (NetApp ONTAP)** e, em seguida, escolha **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector Amazon FSx (NetApp ONTAP)** com a tag “V2.0".
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Fonte**: forneça as informações do sistema de arquivos.
+ **Protocolo do sistema de arquivos** — Escolha o protocolo do seu sistema de arquivos Amazon FSx (NetApp ONTAP). Você pode escolher o protocolo Common Internet File System (CIFS) ou o protocolo Network File System (NFS) para Linux.
+ **Amazon FSxID do sistema de arquivos (NetApp ONTAP) — Selecione na lista suspensa sua ID** do sistema de arquivos existente, obtida de (ONTAP). Amazon FSx NetApp Ou crie um [sistema de arquivos Amazon FSx (NetApp ONTAP)](https://console.aws.amazon.com/fsx/). Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no console Amazon FSx (NetApp ONTAP).
+ **ID SVM** Amazon FSx (NetApp ONTAPsomente para NetApp ONTAP) — Forneça a ID da máquina virtual de armazenamento (SVM) da sua Amazon FSx (ONTAP). NetApp NetApp ONTAP Você pode encontrar sua ID SVM acessando o painel Sistemas de arquivos no console Amazon FSx (NetApp ONTAP), selecionando a ID do sistema de arquivos e selecionando Máquinas **virtuais de armazenamento**.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Autenticação** — escolha um AWS Secrets Manager segredo existente ou crie um novo segredo para armazenar suas credenciais do sistema de arquivos. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
Forneça um segredo que armazene as credenciais de autenticação de nome de usuário e senha. O nome de usuário deve incluir o nome de domínio DNS. Por exemplo, *user@corp.example.com*.
Se você usa o protocolo NFS para seu sistema de arquivos Amazon FSx (NetApp ONTAP), forneça um segredo que armazene suas credenciais de autenticação da ID esquerda, da ID da direita e da chave pré-compartilhada.
Salve e adicione o segredo.
1. **Virtual Private Cloud (VPC)** — Você deve selecionar um Amazon VPC local onde seu Amazon FSx (ONTAP) reside. NetApp Você inclui a sub-rede da VPC e os grupos de segurança. Consulte [Configurando um Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Escopo de sincronização, padrões regex**: adicione padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. **Programação de execução de sincronização**: em **Frequência**, escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos padrão Amazon Kendra gerados dos seus arquivos que você deseja mapear para o seu índice. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao seu sistema de arquivos Amazon FSx (NetApp ONTAP)**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-ontap-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `FSXONTAP` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID do sistema de arquivos** — O identificador do sistema de arquivos Amazon FSx (NetApp ONTAP). Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no console Amazon FSx (NetApp ONTAP).
+ **ID da SVM**: o ID da máquina virtual de armazenamento (SVM) usado com o sistema de arquivos. Você pode encontrar sua ID SVM acessando o painel Sistemas de arquivos no console Amazon FSx (NetApp ONTAP), selecionando a ID do sistema de arquivos e, em seguida, selecionando Máquinas **virtuais de armazenamento**.
+ **Tipo de protocolo**: especifique se você usa o protocolo Common Internet File System (CIFS) ou o protocolo Network File System (NFS) para Linux.
+ **Tipo de sistema de arquivos**: especifique o tipo de sistema de arquivos como `FSXONTAP`.
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
**nota**
Você deve selecionar um Amazon VPC local onde seu Amazon FSx (NetApp ONTAP) reside. Você inclui a sub-rede da VPC e os grupos de segurança.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta (ONTAP). Amazon FSx NetApp A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user@corp.example.com",
"password": "password"
}
```
Se você usa o protocolo NFS para seu sistema de arquivos Amazon FSx (NetApp ONTAP), o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"leftId": "left ID",
"rightId": "right ID",
"preSharedKey": "pre-shared key"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Amazon FSx (NetApp ONTAP) e. Amazon Kendra Para obter mais informações, consulte [IAMfunções para fontes de dados Amazon FSx (NetApp ONTAP)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
**nota**
Para testar a filtragem de contexto de usuário em um usuário, você deve incluir o nome de domínio DNS como parte do nome de usuário ao realizar a consulta. Você deve ter permissões administrativas do domínio do Active Directory. Você também pode testar a filtragem de contexto do usuário no nome de um grupo.
+ **Mapeamentos de campo — Escolha mapear** seus campos de fonte de dados Amazon FSx (NetApp ONTAP) para seus campos de índice. Amazon Kendra Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para obter uma lista de outras chaves JSON importantes a serem configuradas, consulte Esquema de [modelo Amazon FSx (NetApp ONTAP)](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-ontap-schema).
------
# Amazon RDS/Aurora
Você pode indexar documentos armazenados em um banco de dados usando uma fonte de dados do banco de dados. Depois de fornecer as informações de conexão para o banco de dados, Amazon Kendra conecta e indexa documentos.
Amazon Kendrasuporta os seguintes bancos de dados:
+ Amazon Aurora MySQL
+ Amazon Aurora PostgreSQL
+ Amazon RDSpara MySQL
+ Amazon RDSpara PostgreSQL
**nota**
Não há suporte para bancos de dados do Aurora com tecnologia sem servidor.
**Importante**
Esse RDS/Aurora conector da Amazon está programado para ser descontinuado até o final de 2023.
Amazon Kendraagora oferece suporte a novos conectores de fonte de dados de banco de dados. Para uma experiência aprimorada, recomendamos escolher entre os seguintes novos conectores para seu caso de uso:
[Aurora(MySQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-aurora-mysql.html)
[Aurora(PostgreSQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-aurora-postgresql.html)
[Amazon RDS(MySQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-mysql.html)
[Amazon RDS(Microsoft SQL Server)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-ms-sql-server.html)
[Amazon RDS(Oráculo)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-oracle.html)
[Amazon RDS(PostgreSQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-postgresql.html)
[IBM DB2](https://docs.aws.amazon.com/kendra/latest/dg/data-source-ibm-db2.html)
[Microsoft SQL Server](https://docs.aws.amazon.com/kendra/latest/dg/data-source-ms-sql-server.html)
[MySQL](https://docs.aws.amazon.com/kendra/latest/dg/data-source-mysql.html)
[Oracle Database](https://docs.aws.amazon.com/kendra/latest/dg/data-source-oracle-database.html)
[PostgreSQL](https://docs.aws.amazon.com/kendra/latest/dg/data-source-postgresql.html)
Você pode se conectar Amazon Kendra à sua fonte de dados do banco de dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [DatabaseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DatabaseConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra banco de dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-database)
+ [
## Pré-requisitos
](#prerequisites-database)
+ [
## Instruções de conexão
](#data-source-procedure-database)
## Recursos compatíveis
Amazon Kendrao conector de fonte de dados do banco de dados oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do banco de dados, faça essas alterações no banco de dados e AWS nas contas.
**No banco de dados, verifique se você:**
+ Anotou as credenciais básicas de autenticação do nome de usuário e senha no banco de dados.
+ Copiou o nome do host, o número da porta, o endereço do host, o nome do banco de dados e o nome da tabela de dados que contém os dados do documento. Para o PostgreSQL, a tabela de dados deve ser uma tabela pública ou um esquema público.
**nota**
O host e a porta informam Amazon Kendra onde encontrar o servidor de banco de dados na Internet. O nome do banco de dados e o nome da tabela informam Amazon Kendra onde encontrar os dados do documento no servidor do banco de dados.
+ Copiou os nomes das colunas na tabela de dados que contêm os dados do documento. Inclua o ID do documento, o corpo do documento, as colunas para detectar se um documento foi alterado (por exemplo, a última coluna atualizada) e as colunas opcionais da tabela de dados que foram mapeadas para campos de índice personalizados. Você também pode mapear qualquer [nome de campo reservado do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/hiw-document-attributes.html#index-reserved-fields) para uma coluna da tabela.
+ Copiou as informações do tipo de mecanismo de banco de dados, como se você usa Amazon RDS para MySQL ou outro tipo.
+ Verificou se cada documento é exclusivo no banco de dados e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do banco de dados em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do banco de dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à fonte de dados do banco de dados, você deve fornecer os detalhes necessários da fonte de dados do banco de dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o banco de dados paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-database).
------
#### [ Console ]
**Para se conectar Amazon Kendra a um banco de dados**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do banco de dados** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do banco de dados** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Endpoint** — Um nome de host DNS, um IPv4 endereço ou um endereço. IPv6
1. **Porta**: um número de porta.
1. **Banco de dados**: nome do banco de dados.
1. **Nome da tabela**: nome da tabela.
1. Em **Tipo de autenticação**, escolha entre **Existente** e **Novo** para armazenar as credenciais de autenticação do banco de dados. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-database-' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar autenticação**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
**nota**
Você deve usar uma sub-rede privada. Se sua instância do RDS estiver em uma sub-rede pública na VPC, crie uma sub-rede privada que tenha acesso de saída a um gateway NAT na sub-rede pública. As sub-redes fornecidas na configuração da VPC devem estar nas regiões Oeste dos EUA (Oregon), Leste dos EUA (N. da Virgínia), Leste dos EUA (N. da Virgínia) e UE (Irlanda).
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Selecione entre **Aurora MySQL**, **MySQL**, **Aurora PostgreSQL** e PostgreSQL** com base no seu caso de uso.
1. **Coloque os identificadores SQL entre aspas duplas**: selecione para colocar os identificadores SQL entre aspas duplas. Por exemplo, “ColumnName”.
1. Coluna **ACL e colunas** de **detecção de alterações** — Configure as colunas Amazon Kendra usadas para detecção de alterações (por exemplo, a última coluna atualizada) e sua lista de controle de acesso.
1. Em **Cronograma de execução da sincronização**, em **Frequência** — Escolha com que frequência Amazon Kendra será sincronizada com sua fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Amazon Kendramapeamentos de campo padrão — Selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice. Você deve adicionar os valores da **coluna Banco de dados** para `document_id` e `document_body`
1. **Mapeamentos de campo personalizados**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a um banco de dados**
Você deve especificar o seguinte na [DatabaseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DatabaseConfiguration.html)API:
+ **ColumnConfiguration**—Informações sobre onde o índice deve obter as informações do documento do banco de dados. Consulte mais detalhes em [ColumnConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ColumnConfiguration.html). Você deve especificar os campos `DocumentDataColumnName` (corpo do documento ou texto principal), `DocumentIdColumnName` e `ChangeDetectingColumn` (por exemplo, última coluna atualizada). A coluna mapeada para o campo `DocumentIdColumnName` deve ser uma coluna inteira. O exemplo a seguir mostra uma configuração de colunas simples para uma fonte de dados de banco de dados:
```
"ColumnConfiguration": {
"ChangeDetectingColumns": [
"LastUpdateDate",
"LastUpdateTime"
],
"DocumentDataColumnName": "TextColumn",
"DocumentIdColumnName": "IdentifierColumn",
"DocoumentTitleColumnName": "TitleColumn",
"FieldMappings": [
{
"DataSourceFieldName": "AbstractColumn",
"IndexFieldName": "Abstract"
}
]
}
```
+ **ConnectionConfiguration**— Informações de configuração necessárias para se conectar a um banco de dados. Consulte mais detalhes em [ConnectionConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConnectionConfiguration.html).
+ **DatabaseEngineType**— O tipo de mecanismo de banco de dados que executa o banco de dados. O `DatabaseHost` campo para `ConnectionConfiguration` deve ser o endpoint da instância Amazon Relational Database Service (Amazon RDS) do banco de dados. Não use o endpoint do cluster.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta de banco de dados. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password"
}
```
O exemplo a seguir mostra uma configuração de banco de dados, incluindo o ARN secreto.
```
"DatabaseConfiguration": {
"ConnectionConfiguration": {
"DatabaseHost": "host.subdomain.domain.tld",
"DatabaseName": "DocumentDatabase",
"DatabasePort": 3306,
"SecretArn": "arn:aws:secretmanager:region:account ID:secret/secret name",
"TableName": "DocumentTable"
}
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do banco de dados e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do banco de dados](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique `VpcConfiguration` como parte da configuração da fonte de dados. Consulte [Configuração do Amazon Kendra para usar uma VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
**nota**
Você deve usar somente uma sub-rede privada. Se sua instância do RDS estiver em uma sub-rede pública na VPC, crie uma sub-rede privada que tenha acesso de saída a um gateway NAT na sub-rede pública. As sub-redes fornecidas na configuração da VPC devem estar nas regiões Oeste dos EUA (Oregon), Leste dos EUA (N. da Virgínia), Leste dos EUA (N. da Virgínia) e UE (Irlanda).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
------
# Amazon RDS(Microsoft SQL Server)
**nota**
Amazon RDSO conector (Microsoft SQL Server) permanece totalmente compatível com os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O SQL Server é um sistema de gerenciamento de banco de dados desenvolvido pela Microsoft. Amazon RDSfor SQL Server facilita a configuração, a operação e a escalabilidade das implantações do SQL Server na nuvem. Se você for um usuário Amazon RDS (Microsoft SQL Server), você pode usar Amazon Kendra para indexar sua fonte de dados Amazon RDS (Microsoft SQL Server). O conector da fonte de dados Amazon Kendra JDBC oferece suporte ao Microsoft SQL Server 2019.
Você pode se conectar Amazon Kendra à sua fonte de dados Amazon RDS (Microsoft SQL Server) usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados Amazon Kendra Amazon RDS (Microsoft SQL Server), consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-rds-ms-sql-server)
+ [
## Pré-requisitos
](#prerequisites-rds-ms-sql-server)
+ [
## Instruções de conexão
](#data-source-procedure-rds-ms-sql-server)
+ [
## Observações
](#rds-ms-sql-server-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados Amazon RDS (Microsoft SQL Server), faça essas alterações na sua Amazon RDS (Microsoft SQL Server) e AWS nas contas.
**No Amazon RDS (Microsoft SQL Server), verifique se você tem:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verificado se cada documento é exclusivo no Amazon RDS (Microsoft SQL Server) e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação Amazon RDS (Microsoft SQL Server) em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados Amazon RDS (Microsoft SQL Server) Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados Amazon RDS (Microsoft SQL Server), você deve fornecer detalhes de suas credenciais Amazon RDS (Microsoft SQL Server) para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Amazon RDS (Microsoft SQL Server), Amazon Kendra consulte[Pré-requisitos](#prerequisites-rds-ms-sql-server).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Amazon RDS (Microsoft SQL Server)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Amazon RDS (Microsoft SQL Server)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Amazon RDS (Microsoft SQL Server)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação Amazon RDS (Microsoft SQL Server). Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Amazon RDS (Microsoft SQL Server) -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
**nota**
Se o nome de uma tabela incluir caracteres especiais (não alfanuméricos) no nome, você deverá usar colchetes ao redor do nome da tabela. Por exemplo, *select \$1 from [my-database-table]*.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna do usuário** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Amazon RDS (Microsoft SQL Server)**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `sqlserver`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
**nota**
Se o nome de uma tabela incluir caracteres especiais (não alfanuméricos) no nome, você deverá usar colchetes ao redor do nome da tabela. Por exemplo, *select \$1 from [my-database-table]*.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta (Amazon RDSMicrosoft SQL Server). A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Amazon RDS (Microsoft SQL Server) e. Amazon Kendra Para obter mais informações, consulte [IAMfunções para fontes de dados Amazon RDS (Microsoft SQL Server)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo — Escolha mapear** seus campos de fonte de dados (Amazon RDSMicrosoft SQL Server) para seus Amazon Kendra campos de índice. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Amazon RDS Esquema de modelo (Microsoft SQL Server)](ds-schemas.md#ds-rds-ms-sql-server-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Amazon RDS(MySQL)
**nota**
O conector do Amazon RDS(MySQL) permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
Amazon RDS(Amazon Relational Database Service) é um serviço web que facilita a configuração, a operação e a escalabilidade de um banco de dados relacional na AWS nuvem. Se você for um Amazon RDS usuário, poderá usar Amazon Kendra para indexar sua fonte Amazon RDS(MySQL) de dados. O conector da fonte de Amazon Kendra dados é compatível com Amazon RDS MySql 5.6, 5.7 e 8.0.
Você pode se conectar Amazon Kendra à sua fonte de Amazon RDS(MySQL) dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Amazon RDS(MySQL) dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-rds-mysql)
+ [
## Pré-requisitos
](#prerequisites-rds-mysql)
+ [
## Instruções de conexão
](#data-source-procedure-rds-mysql)
+ [
## Observações
](#rds-mysql-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Amazon RDS(MySQL) dados, faça essas alterações em suas Amazon RDS(MySQL) AWS contas.
**Em Amazon RDS(MySQL), verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados. Você pode encontrar essas informações no Amazon RDS console.
+ Verifique se cada documento é exclusivo em Amazon RDS(MySQL) e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Amazon RDS(MySQL) em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Amazon RDS(MySQL) dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Amazon RDS(MySQL) dados, você deve fornecer detalhes de suas Amazon RDS(MySQL) credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Amazon RDS(MySQL) para Amazon Kendra ver[Pré-requisitos](#prerequisites-rds-mysql).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Amazon RDS(MySQL)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Amazon RDS(MySQL)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Amazon RDS(MySQL)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o URL do host do banco de dados; por exemplo: `http://instance URL.region.rds.amazonaws.com`.
1. **Porta**: insira a porta do banco de dados; por exemplo, `5432`.
1. **Instância**: insira a instância de banco de dados; por exemplo, `postgres`.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Amazon RDS(MySQL) autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Amazon RDS(MySQL) -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB As consultas SQL devem ter menos de 32 KB e não conter ponto e vírgula (;). Amazon Kendrarastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Amazon RDS(MySQL)**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `mySql`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Amazon RDS(MySQL) A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Amazon RDS(MySQL) conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Amazon RDS(MySQL)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Amazon RDS(MySQL) para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Amazon RDS Esquema de modelo (MySQL)](ds-schemas.md#ds-rds-mysql-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Amazon RDS(Oracle)
**nota**
O conector do Amazon RDS(Oracle) permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
Amazon RDS(Amazon Relational Database Service) é um serviço web que facilita a configuração, a operação e a escalabilidade de um banco de dados relacional na AWS nuvem. Se você for um Amazon RDS(Oracle) usuário, poderá usar Amazon Kendra para indexar sua fonte Amazon RDS(Oracle) de dados. O conector da fonte de Amazon Kendra Amazon RDS(Oracle) dados é compatível com Amazon RDS Oracle Database 21c, Oracle Database 19c, Oracle Database 12c.
Você pode se conectar Amazon Kendra à sua fonte de Amazon RDS(Oracle) dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Amazon RDS(Oracle) dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-rds-oracle)
+ [
## Pré-requisitos
](#prerequisites-rds-oracle)
+ [
## Instruções de conexão
](#data-source-procedure-rds-oracle)
+ [
## Observações
](#rds-oracle-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Amazon RDS(Oracle) dados, faça essas alterações em suas Amazon RDS(Oracle) AWS contas.
**Em Amazon RDS(Oracle), verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em Amazon RDS(Oracle) e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Amazon RDS(Oracle) em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Amazon RDS(Oracle) dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Amazon RDS(Oracle) dados, você deve fornecer detalhes de suas Amazon RDS(Oracle) credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Amazon RDS(Oracle) para Amazon Kendra ver[Pré-requisitos](#prerequisites-rds-oracle).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Amazon RDS(Oracle)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Amazon RDS(Oracle)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Amazon RDS(Oracle)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Amazon RDS(Oracle) autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Amazon RDS(Oracle) -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Amazon RDS(Oracle)**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `oracle`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Amazon RDS(Oracle) A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Amazon RDS(Oracle) conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Amazon RDS(Oracle)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Amazon RDS(Oracle) para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Amazon RDS Esquema de modelo (Oracle)](ds-schemas.md#ds-rds-oracle-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Amazon RDS(PostgreSQL)
**nota**
O conector do Amazon RDS(PostgreSQL) permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
Amazon RDSé um serviço web que facilita a configuração, a operação e a escalabilidade de um banco de dados relacional na AWS nuvem. Se você for um Amazon RDS usuário, poderá usar Amazon Kendra para indexar sua fonte Amazon RDS(PostgreSQL) de dados. O conector da fonte de Amazon Kendra Amazon RDS(PostgreSQL) dados é compatível com o PostgreSQL 9.6.
Você pode se conectar Amazon Kendra à sua fonte de Amazon RDS(PostgreSQL) dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Amazon RDS(PostgreSQL) dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-rds-postgresql)
+ [
## Pré-requisitos
](#prerequisites-rds-postgresql)
+ [
## Instruções de conexão
](#data-source-procedure-rds-postgresql)
+ [
## Observações
](#rds-postgresql-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Amazon RDS(PostgreSQL) dados, faça essas alterações em suas Amazon RDS(PostgreSQL) AWS contas.
**Em Amazon RDS(PostgreSQL), verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados. Você pode encontrar essas informações no Amazon RDS console.
+ Verifique se cada documento é exclusivo em Amazon RDS(PostgreSQL) e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Amazon RDS(PostgreSQL) em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Amazon RDS(PostgreSQL) dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Amazon RDS(PostgreSQL) dados, você deve fornecer detalhes de suas Amazon RDS(PostgreSQL) credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Amazon RDS(PostgreSQL) para Amazon Kendra ver[Pré-requisitos](#prerequisites-rds-postgresql).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Amazon RDS(PostgreSQL)**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Amazon RDS(PostgreSQL)** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Amazon RDS(PostgreSQL)** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o URL do host do banco de dados; por exemplo: `http://instance URL.region.rds.amazonaws.com`.
1. **Porta**: insira a porta do banco de dados; por exemplo, `5432`.
1. **Instância**: insira a instância de banco de dados; por exemplo, `postgres`.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Amazon RDS(PostgreSQL) autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Amazon RDS(PostgreSQL) -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB As consultas SQL devem ter menos de 32 KB e não conter ponto e vírgula (;). Amazon Kendrarastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Amazon RDS(PostgreSQL)**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `postgresql`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Amazon RDS(PostgreSQL) A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Amazon RDS(PostgreSQL) conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Amazon RDS(PostgreSQL)](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Amazon RDS(PostgreSQL) para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Amazon RDS Esquema de modelo (PostgreSQL)](ds-schemas.md#ds-rds-postgresql-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Amazon S3
Amazon S3 é um serviço de armazenamento de objetos que armazena dados como objetos dentro de buckets. Você pode usar Amazon Kendra para indexar seu repositório de documentos em Amazon S3 bucket.
**Atenção**
Amazon Kendra não usa uma política de bucket que conceda permissões a um Amazon Kendra principal para interagir com um bucket do S3. Em vez disso, ele usa IAM funções. Certifique-se de que isso Amazon Kendra não esteja incluído como membro confiável em sua política de bucket para evitar problemas de segurança de dados ao conceder permissões acidentalmente a diretores arbitrários. No entanto, você pode adicionar uma política de bucket para usar um bucket do Amazon S3 em contas diferentes. Para obter mais informações, consulte [Políticas para uso do Amazon S3 em todas as contas](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds-s3-cross-accounts) (na guia Funções do IAM S3, em **Funções para fontes de dados do IAM **). Para obter informações sobre IAM funções para fontes de dados do S3, consulte [IAM funções](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds-s3).
**nota**
Amazon Kendra agora suporta um Amazon S3 conector atualizado.
O console do foi atualizado automaticamente para você. Quaisquer novos conectores criados no console usarão a arquitetura atualizada. Se usa a API, agora você deve passar a usar o objeto [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) em vez do `S3DataSourceConfiguration` para configurar o conector.
Os conectores configurados usando o console antigo e a arquitetura de API continuam funcionando conforme configurados. No entanto, não é possível editá-los nem atualizá-los. Se você quer editar ou atualizar a configuração do conector, será necessário criar outro conector.
Recomendamos migrar o fluxo de trabalho do conector para a versão atualizada. O suporte para conectores configurados usando a arquitetura mais antiga está programado para terminar em junho de 2024.
Você pode se conectar à sua fonte de Amazon S3 dados usando o [Amazon Kendra console](https://console.aws.amazon.com/kendra/) ou a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
**nota**
Para gerar um relatório de status de sincronização para sua fonte de Amazon S3 dados, consulte [Solução de problemas com fontes de dados](https://docs.aws.amazon.com/kendra/latest/dg/troubleshooting-data-sources.html#troubleshooting-data-sources-sync-status-manifest).
Para solucionar problemas do conector da fonte de dados Amazon Kendra S3, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-s3)
+ [
## Pré-requisitos
](#prerequisites-s3)
+ [
## Instruções de conexão
](#data-source-procedure-s3)
+ [
# Criação de uma fonte Amazon S3 de dados
](create-ds-s3.md)
+ [
# Amazon S3 metadados do documento
](s3-metadata.md)
+ [
# Controle de acesso para fontes Amazon S3 de dados
](s3-acl.md)
+ [
# Usando Amazon VPC com uma fonte Amazon S3 de dados
](s3-vpc-example-1.md)
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do S3, faça essas alterações no S3 e AWS nas contas.
**No S3, verifique se você:**
+ Copiou o nome do seu Amazon S3 bucket.
**nota**
Seu bucket deve estar na mesma região do seu Amazon Kendra índice e seu índice deve ter permissão para acessar o bucket que contém seus documentos.
+ Verifique se cada documento é exclusivo no S3 e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**Em sua AWS conta, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
Se você não tiver uma IAM função existente, poderá usar o console para criar uma nova IAM função ao conectar sua fonte de dados do S3 a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função existente e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do S3, você deve fornecer os detalhes necessários da sua fonte de dados do S3 para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o S3 para Amazon Kendra, consulte[Pré-requisitos](#prerequisites-s3).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Amazon S3 **
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do S3** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do S3** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações opcionais a seguir:
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Localização da fonte de dados**: especifique o caminho para o bucket do Amazon S3 em que os dados estão armazenados. Selecione **Procurar no S3** para escolher o bucket do S3.
1. Em **Tamanho máximo do arquivo**: especifique um limite em MB para fazer crawling somente de arquivos abaixo desse limite. O tamanho Amazon Kendra máximo de arquivo permitido é de 50 MB.
1. Para **arquivos de metadados (opcional), prefixe a localização da pasta** — especifique o caminho para a pasta na qual seus metadados fields/attributes e outros do documento estão armazenados. Selecione **Procurar no S3** para localizar a pasta de metadados.
1. (Opcional) Em **Localização do arquivo de configuração da lista de controle de acesso**: especifique o caminho do arquivo que contém uma estrutura JSON de seus usuários e o acesso aos documentos. Selecione **Procurar S3** para localizar o arquivo ACL.
1. (Opcional) **Selecione a chave de decodificação**: selecione para usar uma chave de decodificação. Você pode optar por usar uma chave do AWS KMS existente.
1. (Opcional) Em **Configuração adicional**: adicione padrões para incluir ou excluir certos arquivos. Todos os caminhos são relativos ao bucket S3 da localização da fonte de dados.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações opcionais:
1. **Mapeamentos de campo padrão — Selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Amazon S3**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `S3` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **BucketName**— O nome do bucket que contém os documentos.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector S3 e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do S3](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir certos nomes, tipos e caminhos de arquivos. Você usa padrões glob (padrões que podem expandir um padrão curinga em uma lista de nomes de caminhos que correspondem ao padrão fornecido). Para ver exemplos, consulte [Uso de filtros de exclusão e inclusão](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) na referência de comandos da AWS CLI.
+ **Configuração de metadados do documento e controle de acesso**: adicione arquivos de metadados do documento e de controle de acesso que contêm informações como URI da origem, autor do documento ou atributos/campos de documentos personalizados, além dos usuários e dos documentos que eles podem acessar. Cada arquivo de metadados contém metadados sobre um único documento.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do S3 para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do S3](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-s3-schema).
------
### Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do S3, consulte:
+ [Pesquise respostas com precisão usando o Amazon Kendra S3 Connector com suporte a VPC](https://aws.amazon.com/blogs/machine-learning/search-for-answers-accurately-using-amazon-kendra-s3-connector-with-vpc-support/)
# Criação de uma fonte Amazon S3 de dados
Os exemplos a seguir demonstram a criação de uma fonte de Amazon S3 dados. Os exemplos pressupõem que você já tenha criado um índice e uma IAM função com permissão para ler os dados do índice. Para obter mais informações sobre a IAM função, consulte [funções de IAM acesso](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds). Para obter mais informações sobre como criar um índice, consulte [Como criar um índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html).
------
#### [ CLI ]
```
aws kendra create-data-source \
--index-id index ID \
--name example-data-source \
--type S3 \
--configuration '{"S3Configuration":{"BucketName":"bucket name"}}'
--role-arn 'arn:aws:iam::account id:role:/role name
```
------
#### [ Python ]
O trecho de código Python a seguir cria uma fonte de dados. Amazon S3 Para um exemplo completo, consulte [Conceitos básicos (AWS SDK para Python (Boto3))](gs-python.md).
```
print("Create an Amazon S3 data source.")
# Provide a name for the data source
name = "getting-started-data-source"
# Provide an optional description for the data source
description = "Getting started data source."
# Provide the IAM role ARN required for data sources
role_arn = "arn:aws:iam::${accountID}:role/${roleName}"
# Provide the data soource connection information
s3_bucket_name = "S3-bucket-name"
type = "S3"
# Configure the data source
configuration = {"S3DataSourceConfiguration":
{
"BucketName": s3_bucket_name
}
}
data_source_response = kendra.create_data_source(
Configuration = configuration,
Name = name,
Description = description,
RoleArn = role_arn,
Type = type,
IndexId = index_id
)
```
------
Pode levar algum tempo para criar sua fonte de dados. Você pode monitorar o progresso usando a [DescribeDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeDataSource.html)API. Quando o status da fonte de dados é `ACTIVE`, a fonte de dados está pronta para uso.
Os exemplos a seguir demonstram como obter o status de uma fonte de dados.
------
#### [ CLI ]
```
aws kendra describe-data-source \
--index-id index ID \
--id data source ID
```
------
#### [ Python ]
O trecho de código Python a seguir obtém informações sobre uma fonte de dados do S3. Para um exemplo completo, consulte [Conceitos básicos (AWS SDK para Python (Boto3))](gs-python.md).
```
print("Wait for Amazon Kendra to create the data source.")
while True:
data_source_description = kendra.describe_data_source(
Id = "data-source-id",
IndexId = "index-id"
)
status = data_source_description["Status"]
print(" Creating data source. Status: "+status)
time.sleep(60)
if status != "CREATING":
break
```
------
Essa fonte de dados não tem um agendamento e, portanto, não é executada automaticamente. Para indexar a fonte de dados, você chama [StartDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StartDataSourceSyncJob.html)para sincronizar o índice com a fonte de dados.
Os exemplos a seguir demonstram a sincronização de uma fonte de dados.
------
#### [ CLI ]
```
aws kendra start-data-source-sync-job \
--index-id index ID \
--id data source ID
```
------
#### [ Python ]
O trecho de código Python a seguir sincroniza uma fonte de dados do Amazon S3 . Para um exemplo completo, consulte [Conceitos básicos (AWS SDK para Python (Boto3))](gs-python.md).
```
print("Synchronize the data source.")
sync_response = kendra.start_data_source_sync_job(
Id = "data-source-id",
IndexId = "index-id"
)
```
------
# Amazon S3 metadados do documento
Você pode adicionar metadados, informações adicionais sobre um documento, aos documentos em um bucket do Amazon S3 usando um arquivo de metadados. Cada arquivo de metadados está associado a um documento indexado.
Os arquivos de metadados devem ser armazenados no mesmo bucket dos arquivos indexados. Você pode especificar um local dentro do bucket para seus arquivos de metadados usando o console ou o `S3Prefix` campo do `DocumentsMetadataConfiguration` parâmetro ao criar uma fonte de Amazon S3 dados. Se você não especificar um prefixo do Amazon S3 , os arquivos de metadados deverão ser armazenados no mesmo local dos documentos indexados.
Se você especificar um Amazon S3 prefixo para seus arquivos de metadados, eles estarão em uma estrutura de diretórios paralela aos seus documentos indexados. Amazon Kendra procura seus metadados somente no diretório especificado. Se os metadados não forem lidos, verifique se a localização do diretório corresponde à localização dos metadados.
Os seguintes exemplos mostram como a localização do documento indexado é mapeada para a localização do arquivo de metadados: Observe que a Amazon S3 chave do documento é anexada ao Amazon S3 prefixo dos metadados e depois sufixada com `.metadata.json` para formar o caminho do arquivo de metadados. Amazon S3 A Amazon S3 chave combinada, com o Amazon S3 prefixo e o `.metadata.json` sufixo dos metadados, não deve ter mais do que um total de 1024 caracteres. É recomendável que você mantenha sua Amazon S3 chave abaixo de 1000 caracteres para considerar caracteres adicionais ao combinar sua chave com o prefixo e o sufixo.
```
Bucket name:
s3://bucketName
Document path:
documents
Metadata path:
none
File mapping
s3://bucketName/documents/file.txt ->
s3://bucketName/documents/file.txt.metadata.json
```
```
Bucket name:
s3://bucketName
Document path:
documents/legal
Metadata path:
metadata
File mapping
s3://bucketName/documents/legal/file.txt ->
s3://bucketName/metadata/documents/legal/file.txt.metadata.json
```
Os metadados do documento são definidos em um arquivo JSON. O arquivo deve ser um arquivo de texto UTF-8 sem um marcador BOM. O nome do arquivo JSON deve ser `..metadata.json`. Neste exemplo, o “documento” é o nome do documento ao qual os metadados se aplicam e a “extensão” é a extensão do arquivo do documento. O ID do documento deve ser exclusivo na `..metadata.json`.
O conteúdo do arquivo JSON segue esse modelo. Todos attributes/fields são opcionais, portanto, não é necessário incluir todos os atributos. Você deve fornecer um valor para cada atributo que deseja incluir; o valor não pode estar vazio. Se você não especificar o`_source_uri`, os links retornados Amazon Kendra nos resultados da pesquisa apontarão para o Amazon S3 bucket que contém o documento. `DocumentId`é mapeado para o campo `s3_document_id` e é o caminho absoluto para o documento no S3.
```
{
"DocumentId": "S3 document ID, the S3 path to doc",
"Attributes": {
"_category": "document category",
"_created_at": "ISO 8601 encoded string",
"_last_updated_at": "ISO 8601 encoded string",
"_source_uri": "document URI",
"_version": "file version",
"_view_count": number of times document has been viewed,
"custom attribute key": "custom attribute value",
additional custom attributes
},
"AccessControlList": [
{
"Name": "user name",
"Type": "GROUP | USER",
"Access": "ALLOW | DENY"
}
],
"Title": "document title",
"ContentType": "For example HTML | PDF. For supported content types, see [Types of documents](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html)."
}
```
Os campos de metadados `_created_at` e `_last_updated_at` são datas codificadas no ISO 8601. Por exemplo, 2012-03-25T12:30:10\$101:00 é o formato de data e hora do ISO 8601 para 25 de março de 2012 às 12h30 (mais 10 segundos) no horário da Europa Central.
Você pode adicionar informações adicionais ao campo `Attributes` sobre um documento que você usa para filtrar consultas ou agrupar respostas de consultas. Para obter mais informações, consulte [Criação de campos de documentos personalizados](custom-attributes.md).
Você pode usar o campo `AccessControlList` para filtrar a resposta de uma consulta. Dessa forma, somente determinados usuários e grupos têm acesso aos documentos. Para obter mais informações, consulte [Filtragem no contexto do usuário](user-context-filter.md).
# Controle de acesso para fontes Amazon S3 de dados
Você pode controlar o acesso aos documentos em uma fonte Amazon S3 de dados usando um arquivo de configuração. Você especifica o arquivo no console ou como `AccessControlListConfiguration` parâmetro ao chamar a [UpdateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html)API [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)ou.
O arquivo de configuração contém uma estrutura JSON que identifica um prefixo S3 e lista as configurações de acesso para o prefixo. O prefixo pode ser um caminho ou um arquivo individual. Se o prefixo for um caminho, as configurações de acesso se aplicarão a todos os arquivos nesse caminho. Há um número máximo de prefixos do S3 no arquivo de configuração JSON e um tamanho máximo de arquivo padrão. Para obter mais informações, consulte [Cotas para Amazon Kendra](quotas.md).
Você pode especificar usuários e grupos nas configurações de acesso. Ao consultar o índice, especifique informações do usuário e do grupo. Para obter mais informações, consulte [Filtrando por atributo do usuário](user-context-filter.md#context-filter-attribute).
A estrutura JSON do arquivo de configuração deve estar no seguinte formato:
```
[
{
"keyPrefix": "s3://BUCKETNAME/prefix1/",
"aclEntries": [
{
"Name": "user1",
"Type": "USER",
"Access": "ALLOW"
},
{
"Name": "group1",
"Type": "GROUP",
"Access": "DENY"
}
]
},
{
"keyPrefix": "s3://prefix2",
"aclEntries": [
{
"Name": "user2",
"Type": "USER",
"Access": "ALLOW"
},
{
"Name": "user1",
"Type": "USER",
"Access": "DENY"
},
{
"Name": "group1",
"Type": "GROUP",
"Access": "DENY"
}
]
}
]
```
# Usando Amazon VPC com uma fonte Amazon S3 de dados
Usando Amazon VPC com Amazon S3
Este tópico fornece um step-by-step exemplo que mostra como se conectar a um bucket do Amazon S3 usando um conector do Amazon S3 por meio do Amazon VPC. O exemplo pressupõe que você esteja começando com um bucket do S3 existente. Recomendamos que você faça upload de apenas alguns documentos no bucket do S3 para testar o exemplo.
Você pode se conectar Amazon Kendra ao seu Amazon S3 bucket por meio de Amazon VPC. Para fazer isso, você deve especificar a Amazon VPC sub-rede e os grupos de Amazon VPC segurança ao criar seu conector de fonte de Amazon S3 dados.
**Importante**
Para que um Amazon Kendra Amazon S3 conector possa acessar seu Amazon S3 bucket, certifique-se de ter atribuído um Amazon S3 endpoint à sua nuvem privada virtual (VPC).
Amazon Kendra Para sincronizar documentos do seu Amazon S3 bucket Amazon VPC, você deve concluir as seguintes etapas:
+ Configure um Amazon S3 endpoint para Amazon VPC. *Para obter mais informações sobre como configurar um Amazon S3 endpoint, consulte [Endpoints do Gateway Amazon S3](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints-s3.html) no AWS PrivateLink Guia.*
+ (Opcional) Verificou suas políticas Amazon S3 de bucket para garantir que o Amazon S3 bucket seja acessível a partir da nuvem privada virtual (VPC) à qual você atribuiu. Amazon Kendra Consulte mais informações em [Controlar o acesso a partir de endpoints da VPC com políticas de bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies-vpc-endpoint.html) no *Guia do usuário do Amazon S3*.
**Topics**
+ [
## Etapa 1: configurar um Amazon VPC
](#s3-configure-vpc)
+ [
## (Opcional) Etapa 2: configurar a política Amazon S3 de bucket
](#s3-configure-bucket-policy)
+ [
## Etapa 3: criar um conector de fonte Amazon S3 de dados de teste
](#s3-connect-vpc)
## Etapa 1: configurar um Amazon VPC
Crie uma rede VPC, incluindo uma sub-rede privada com um endpoint de Amazon S3 gateway e um grupo de segurança para Amazon Kendra uso posterior.
**Como configurar uma VPC com uma sub-rede privada, um endpoint do S3 e um grupo de segurança**
1. Faça login no Console de gerenciamento da AWS e abra o Amazon VPC console em[https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/).
1. **Crie uma VPC com uma sub-rede privada e um endpoint S3 para usar: Amazon Kendra **
No painel de navegação, escolha **Your** e, em seguida VPCs, escolha **Create VPC**.
1. Em **Resources to create (Recursos a serem criados)**, escolha **VPC and more (VPC e mais)**.
1. Em **Tag de nome**, ative **Gerar automaticamente** e insira **kendra-s3-example**.
1. Para o **blocoIPv4 / IPv6 CIDR**, mantenha os valores padrão.
1. Em **Número de zonas de disponibilidade (AZs)**, escolha **o número 1**.
1. Selecione **Personalizar** e AZs, em seguida, selecione uma zona de disponibilidade na lista **Primeira zona de disponibilidade**.
Amazon Kendra só oferece suporte a um conjunto específico de zonas de disponibilidade.
1. Em **Número de sub-redes públicas**, escolha **número 0**.
1. Em **Número de sub-redes privadas**, escolha **número 1**.
1. Em **NAT gateways** (Gateways NAT), escolha **None** (Nenhum).
1. Em **Endpoints da VPC**, escolha **Gateway do Amazon S3 **.
1. Deixe o restante dos valores na configuração padrão.
1. Selecione **Create VPC** (Criar VPC).
Espere até que o fluxo de trabalho **Criar VPC** termine. Depois, escolha **Visualizar VPC** para verificar a **VPC** que você acabou de criar.
Agora você criou uma rede da VPC com uma sub-rede privada, que não tem acesso à internet pública.
1. **Copie o ID do endpoint da VPC do endpoint do Amazon S3:**
1. No painel de navegação, escolha **Endpoints**.
1. Na lista de **Endpoints**, encontre o endpoint `kendra-s3-example-vpce-s3` do Amazon S3 que você acabou de criar junto com a VPC.
1. Anote o **ID do endpoint da VPC**.
Agora você criou um endpoint de gateway do Amazon S3 para acessar o bucket do Amazon S3 por meio de uma sub-rede.
1. **Crie um **Grupo de segurança** para o Amazon Kendra usar:**
1. No painel de navegação, escolha **Grupos de segurança** e **Criar grupo de segurança**.
1. Em **Nome do grupo de segurança**, insira **s3-data-source-security-group**.
1. Selecione a VPC na lista **Amazon VPC**.
1. Deixe as **regras de entrada** e as **regras de saída** como padrão.
1. Escolha **Criar grupo de segurança**.
Agora você criou um grupo de segurança da VPC.
Você atribui a sub-rede e o grupo de segurança que você criou ao seu conector de fonte de dados do Amazon Kendra Amazon S3 durante o processo de configuração do conector.
## (Opcional) Etapa 2: configurar a política Amazon S3 de bucket
Nessa etapa opcional, aprenda a configurar uma política de bucket do Amazon S3 para que o bucket do Amazon S3 só possa ser acessado pela VPC à qual você atribui ao Amazon Kendra.
Amazon Kendra usa funções do IAM para acessar seu bucket do Amazon S3 e não exige que você configure uma política de bucket do Amazon S3. No entanto, talvez seja útil criar uma política de bucket se quiser configurar um Amazon S3 conector usando um bucket do Amazon S3 que tenha políticas existentes que restringem o acesso a ele pela Internet pública.
**Para configurar sua política Amazon S3 de bucket**
1. Abra o console do Amazon S3 em [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/).
1. No painel de navegação, selecione **Buckets**.
1. Escolha o nome do bucket do Amazon S3 com o qual você deseja sincronizar. Amazon Kendra
1. Escolha a guia **Permissões**, role para baixo até a **Política de bucket** e clique em **Editar**.
1. Adicione ou modifique a política de bucket para permitir acesso somente do endpoint da VPC que você criou.
A seguir há um exemplo de política de bucket. Substitua *`bucket-name`* e *`vpce-id`* pelo nome do bucket do Amazon S3 e pelo ID do endpoint do Amazon S3 que você anotou anteriormente.
1. Selecione **Salvar alterações**.
O bucket do S3 agora está acessível somente pela VPC específica que você criou.
## Etapa 3: criar um conector de fonte Amazon S3 de dados de teste
Para testar sua Amazon VPC configuração, crie um Amazon S3 conector. Depois, configure-o com a VPC que você criou seguindo as etapas descritas em [Amazon S3](https://docs.aws.amazon.com/kendra/latest/dg/data-source-s3.html).
Para valores de Amazon VPC configuração, escolha os valores que você criou durante este exemplo:
+ **Amazon VPC(VPC**) — `kendra-s3-example-vpc`
+ **Sub-redes** — `kendra-s3-example-subnet-private1-[availability zone]`
+ **Grupos de segurança** — `s3-data-source-security-group`
Aguarde até a conclusão da criação do conector. Depois que o Amazon S3 conector for criado, escolha **Sincronizar agora** para iniciar uma sincronização.
Pode levar de alguns minutos a várias horas para concluir a sincronização, dependendo de quantos documentos estão em seu Amazon S3 bucket. Para testar o exemplo, recomendamos que você faça upload de apenas alguns documentos para o bucket do S3. Se a configuração estiver correta, o **Status de sincronização** será exibido como **Concluído**.
Se você encontrar algum erro, consulte [Solução de problemas de Amazon VPC conexão](https://docs.aws.amazon.com/kendra/latest/dg/vpc-connector-troubleshoot.html).
# Amazon Kendra Rastreador da Web
Você pode usar o Amazon Kendra Web Crawler para rastrear e indexar páginas da Web.
Você só pode rastrear sites públicos ou internos de empresas que usam o protocolo de comunicação segura do Hypertext Transfer Protocol Secure (HTTPS). Um erro recebido durante o crawling pode indicar que o site está bloqueado para crawling. Para rastrear sites internos, você pode configurar um proxy da web. O proxy da web deve estar voltado para o público. Você também pode usar a autenticação para acessar e rastrear sites.
*Ao selecionar sites para indexar, você precisa aderir à [Política de uso aceitável da Amazon](https://aws.amazon.com/aup/) e a todos os outros termos da Amazon. Lembre-se de que você só deve usar o Amazon Kendra Web Crawler para indexar suas próprias páginas da Web ou páginas da Web que você tenha autorização para indexar. Para saber como impedir que o Amazon Kendra Web Crawler indexe seu (s) site (s), consulte. [Configurando o `robots.txt` arquivo para o Amazon Kendra Web Crawler](stop-web-crawler.md)*
**nota**
**Abusar do Amazon Kendra Web Crawler para rastrear agressivamente sites ou páginas da web que você não possui não é considerado uso aceitável.**
Amazon Kendra tem duas versões do web crawler conector. Os recursos suportados de cada versão incluem:
**Amazon Kendra Conector Web Crawler v1.0/API [https://docs.aws.amazon.com/kendra/latest/dg/API_WebCrawlerConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_WebCrawlerConfiguration.html)**
+ Proxy da Web
+ Filtros de inclusão/exclusão
**Amazon Kendra Conector Web Crawler v2.0/API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)**
+ Mapeamentos de campos
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Proxy da Web
+ Autenticação básica, NTLM/Kerberos, SAML e de formulários para os sites
+ Nuvem privada virtual (VPC)
**Importante**
A criação do conector Web Crawler v2.0 não é suportada pelo. CloudFormation Use o conector Web Crawler v1.0 se precisar de suporte. CloudFormation
Para solucionar problemas do conector da fonte de dados do Amazon Kendra web crawler, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
# Amazon Kendra Conector Web Crawler v1.0
](data-source-v1-web-crawler.md)
+ [
# Amazon Kendra Conector Web Crawler v2.0
](data-source-v2-web-crawler.md)
+ [
# Configurando o `robots.txt` arquivo para o Amazon Kendra Web Crawler
](stop-web-crawler.md)
# Amazon Kendra Conector Web Crawler v1.0
Você pode usar o Amazon Kendra Web Crawler para rastrear e indexar páginas da Web.
Você só pode rastrear sites públicos e sites que usam o protocolo de comunicação segura do Hypertext Transfer Protocol Secure (HTTPS). Um erro recebido durante o crawling pode indicar que o site está bloqueado para crawling. Para rastrear sites internos, você pode configurar um proxy da web. O proxy da web deve estar voltado para o público.
*Ao selecionar sites para indexar, você precisa aderir à [Política de uso aceitável da Amazon](https://aws.amazon.com/aup/) e a todos os outros termos da Amazon. Lembre-se de que você só deve usar o Amazon Kendra Web Crawler para indexar suas próprias páginas da Web ou páginas da Web que você tenha autorização para indexar. Para saber como impedir que o Amazon Kendra Web Crawler indexe seu (s) site (s), consulte. [Configurando o `robots.txt` arquivo para o Amazon Kendra Web Crawler](stop-web-crawler.md)*
**nota**
**Abusar do Amazon Kendra Web Crawler para rastrear agressivamente sites ou páginas da web que você não possui não é considerado uso aceitável.**
Para solucionar problemas do conector da fonte de dados do Amazon Kendra web crawler, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-web-crawler)
+ [
## Pré-requisitos
](#prerequisites-v1-web-crawler)
+ [
## Instruções de conexão
](#data-source-v1-procedure-web-crawler)
+ [
## Saiba mais
](#web-crawler-learn-more)
## Recursos compatíveis
+ Proxy da Web
+ Filtros de inclusão/exclusão
## Pré-requisitos
Antes de usar Amazon Kendra para indexar seus sites, verifique os detalhes de seus sites e AWS contas.
**Para os sites, verifique se você tem:**
+ Copiou a semente ou o mapa do site URLs dos sites que você deseja indexar.
+ **Para sites que exigem autenticação básica**: anotou o nome de usuário e a senha e copiou o nome do host do site e o número da porta.
+ **Opcional:** copiou o nome do host do site e o número da porta se quiser usar um proxy da web para se conectar aos sites internos que você deseja rastrear. O proxy da web deve estar voltado para o público. O Amazon Kendra suporta a conexão com servidores proxy da web que são apoiados pela autenticação básica ou você pode se conectar sem autenticação.
+ Verificou se cada documento de página da Web que você deseja indexar é único e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**Em sua AWS conta, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Para sites que exigem autenticação, ou se estiverem usando um proxy da web com autenticação, armazenaram suas credenciais de autenticação em um AWS Secrets Manager segredo e, se estiverem usando a API, anotaram o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de web crawler dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de web crawler dados, você deve fornecer os detalhes necessários da sua fonte de web crawler dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou web crawler para Amazon Kendra ver[Pré-requisitos](#prerequisites-v1-web-crawler).
------
#### [ Console ]
**Para se conectar Amazon Kendra a web crawler**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do web crawler** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do crawler da web** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Em **Source**, escolha entre os **sitemaps Source URLs** e Source, dependendo do seu caso de uso, e insira os valores para cada um.**
Você pode adicionar até 10 fontes URLs e três mapas do site.
**nota**
Se você quiser rastrear um sitemap, verifique se o URL base ou raiz é o mesmo URLs listado na página do seu sitemap. Por exemplo, se o URL do seu sitemap for *https://example.com/sitemap-page.html*, o URLs listado nessa página do sitemap também deverá usar o URL base "”. https://example.com/
1. (Opcional) Para o **proxy da Web**, insira as seguintes informações:
1. **Nome do host**: o nome do host em que o proxy da web é necessário.
1. **Número da porta**: o número da porta usado pelo protocolo de transporte de URL do host. O número da porta deve ser um valor numérico entre 0 e 65535.
1. Para **credenciais de proxy da Web**: se a conexão do proxy da Web exigir autenticação, escolha uma senha existente ou crie uma nova senha para armazenar as credenciais de autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em **Criar uma janela de senha do AWS Secrets Manager Secrets Manager **:
1. **Senha**: um nome para sua senha. O prefixo “AmazonKendra-WebCrawler-” é adicionado automaticamente à senha.
1. Em **Nome de usuário** e **senha**, insira essas credenciais básicas de autenticação para seus sites.
1. Escolha **Salvar**.
1. (Opcional) **Hosts com autenticação**: selecione para adicionar outros hosts com autenticação.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. **Intervalo de rastreamento**: escolha o tipo de página da Web que você deseja rastrear.
1. **Profundidade do rastreamento** — Selecione o número de níveis do URL inicial que Amazon Kendra devem ser rastreados.
1. **As configurações avançadas de rastreamento** e a **configuração adicional** inserem as seguintes informações:
1. **Tamanho máximo do arquivo**: o tamanho máximo da página da Web ou do anexo a ser rastreado. Mínimo de 0,000001 MB (1 byte). Máximo de 50 MB.
1. **Máximo de links por página**: o número máximo de links rastreados por página. Os links passam pelo crawling por ordem de exibição. Mínimo 1link/page. Maximum 1000 links/page.
1. **Limitação máxima —** O número máximo de URLs rastreados por nome de host por minuto. Mínimo 1 URLs/host name/minute. Maximum 300 URLs/host name/minute.
1. Padrões **Regex — Adicione padrões** de expressão regular para incluir ou excluir determinados. URLs Você pode adicionar até 100 padrões.
1. Em **Cronograma de execução da sincronização**, em **Frequência** — Escolha com que frequência Amazon Kendra será sincronizada com sua fonte de dados.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a web crawler**
Você deve especificar o seguinte usando a [WebCrawlerConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_WebCrawlerConfiguration.html)API:
+ **URLs**—Especifique a semente ou o ponto URLs de partida dos sites ou o mapa URLs do site dos sites que você deseja rastrear usando e. [https://docs.aws.amazon.com/kendra/latest/dg/API_SeedUrlConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_SeedUrlConfiguration.html)
**nota**
Se você quiser rastrear um sitemap, verifique se o URL base ou raiz é o mesmo URLs listado na página do seu sitemap. Por exemplo, se o URL do seu sitemap for *https://example.com/sitemap-page.html*, o URLs listado nessa página do sitemap também deverá usar o URL base "”. https://example.com/
+ **Nome do recurso da Amazon (ARN) da senha**: se for necessário usar a autenticação básica do site, forneça o nome do host, o número da porta e uma senha que armazena as credenciais básicas de autenticação do seu nome de usuário e senha. Você fornece o ARN secreto usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_AuthenticationConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_AuthenticationConfiguration.html). A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password"
}
```
Você também pode fornecer credenciais de proxy da web usando uma senha do AWS Secrets Manager . Você usa a API [https://docs.aws.amazon.com/kendra/latest/dg/API_ProxyConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_ProxyConfiguration.html) para fornecer o nome do host e o número da porta do site e, opcionalmente, a senha que armazena as credenciais de proxy da web.
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do web crawler e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do web crawler](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Modo de rastreamento**: escolha se deseja rastrear somente nomes de host de sites ou nomes de host com subdomínios ou também rastrear outros domínios aos quais as páginas da Web estão vinculadas.
+ A “profundidade” ou número de níveis do nível semente para crawling. Por exemplo, a página de URL semente tem profundidade 1 e todos os hiperlinks nessa página nos quais também será realizado crawling têm profundidade 2.
+ O número máximo de páginas da URLs web a serem rastreadas em uma única página da web.
+ O tamanho máximo (em MB) de uma página da Web para crawling.
+ O número máximo de URLs rastreados por host do site por minuto.
+ O host do proxy da web e o número da porta para se conectar e rastrear sites internos. Por exemplo, o nome do host *https://a.example.com/page1.html* é "a.example.com" e o número da porta é 443, a porta padrão para HTTPS. Se o proxy da Web exigir credenciais para se conectar ao host de um site, crie um AWS Secrets Manager que armazene as credenciais.
+ As informações de autenticação para acessar e fazer o crawling de sites que exigem autenticação do usuário.
+ Você pode extrair metatags HTML como campos usando a ferramenta de *Enriquecimento de documentos personalizados*. Para obter mais informações, consulte [Personalização de metadados de documentos durante o processo de ingestão](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). Para obter um exemplo de extração de metatags HTML, consulte [exemplos de CDE](https://github.com/aws-samples/amazon-kendra-cde-examples).
+ **Filtros de inclusão e exclusão** — especifique se deseja incluir ou excluir determinados. URLs
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte web crawler de dados, consulte:
+ [Reimagine a descoberta de conhecimento usando o Web Amazon Kendra Crawler](https://aws.amazon.com/blogs/machine-learning/reimagine-knowledge-discovery-using-amazon-kendras-web-crawler/)
# Amazon Kendra Conector Web Crawler v2.0
Você pode usar o Amazon Kendra Web Crawler para rastrear e indexar páginas da Web.
Você só pode rastrear sites públicos ou internos de empresas que usam o protocolo de comunicação segura do Hypertext Transfer Protocol Secure (HTTPS). Um erro recebido durante o crawling pode indicar que o site está bloqueado para crawling. Para rastrear sites internos, você pode configurar um proxy da web. O proxy da web deve estar voltado para o público. Você também pode usar a autenticação para acessar e rastrear sites.
Amazon Kendra O Web Crawler v2.0 usa o pacote Selenium web crawler e um driver Chromium. Amazon Kendra atualiza automaticamente a versão do Selenium e do driver Chromium usando a Integração Contínua (CI).
*Ao selecionar sites para indexar, você precisa aderir à [Política de uso aceitável da Amazon](https://aws.amazon.com/aup/) e a todos os outros termos da Amazon. Lembre-se de que você só deve usar o Amazon Kendra Web Crawler para indexar suas próprias páginas da Web ou páginas da Web que você tenha autorização para indexar. Para saber como impedir que o Amazon Kendra Web Crawler indexe seu (s) site (s), consulte. [Configurando o `robots.txt` arquivo para o Amazon Kendra Web Crawler](stop-web-crawler.md)* . **Abusar do Amazon Kendra Web Crawler para rastrear agressivamente sites ou páginas da web que você não possui não é considerado uso aceitável.**
Para solucionar problemas do conector da fonte de dados do Amazon Kendra web crawler, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**nota**
O conector Web Crawler v2.0 *não* suporta o rastreamento de listas de sites da Web a partir de buckets criptografados. AWS KMS Amazon S3 Ele suporta somente criptografia do lado do servidor com chaves gerenciadas Amazon S3 .
**Importante**
A criação do conector Web Crawler v2.0 não é suportada pelo. CloudFormation Use o conector Web Crawler v1.0 se precisar de suporte. CloudFormation
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-web-crawler)
+ [
## Pré-requisitos
](#prerequisites-v2-web-crawler)
+ [
## Instruções de conexão
](#data-source-v2-procedure-web-crawler)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Proxy da Web
+ Autenticação básica, NTLM/Kerberos, SAML e de formulários para os sites
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de usar Amazon Kendra para indexar seus sites, verifique os detalhes de seus sites e AWS contas.
**Para os sites, verifique se você tem:**
+ Copiou a semente ou o mapa do site URLs dos sites que você deseja indexar. Você pode armazená-los URLs em um arquivo de texto e enviá-los para um Amazon S3 bucket. Cada URL no arquivo de texto deve ser formatado em uma linha separada. Se você quiser armazenar seus sitemaps em um Amazon S3 bucket, certifique-se de ter copiado o XML do sitemap e salvado em um arquivo XML. Você também pode agrupar vários arquivos XML de mapa do site em um arquivo ZIP.
**nota**
(Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são iguais às informações do endpoint especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o [problema de assistência confusa](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html), que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.
+ **Para sites que exigem autenticação básica, NTLM ou Kerberos**:
+ Anote suas credenciais de autenticação do site, que incluem um nome de usuário e senha.
**nota**
Amazon Kendra O Web Crawler v2.0 suporta o protocolo de autenticação NTLM, que inclui hash de senha, e o protocolo de autenticação Kerberos, que inclui criptografia de senha.
+ **Para sites que exigem autenticação por SAML ou formulário de login**:
+ Anote suas credenciais de autenticação do site, que incluem um nome de usuário e senha.
+ Copiou o XPaths (XML Path Language) do campo do nome do usuário (e o botão do nome do usuário se estiver usando SAML), do campo e do botão da senha e copiou o URL da página de login. Você pode encontrar os XPaths elementos usando as ferramentas de desenvolvedor do seu navegador. XPaths geralmente seguem este formato:`//tagname[@Attribute='Value']`.
**nota**
Amazon Kendra O Web Crawler v2.0 usa um navegador Chrome sem cabeçalho e as informações do formulário para autenticar e autorizar o acesso com um URL protegido 2.0. OAuth
+ **Opcional:** copiou o nome do host e o número da porta se quiser usar um servidor do proxy da web para se conectar aos sites internos que você deseja rastrear. O proxy da web deve estar voltado para o público. Amazon Kendra suporta a conexão com servidores proxy da web que são apoiados pela autenticação básica ou você pode se conectar sem autenticação.
+ **Opcional**: copiou o ID da sub-rede da nuvem privada virtual (VPC) se você quiser usar uma VPC para se conectar aos sites internos que deseja rastrear. Para obter mais informações, consulte [Configurando um Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
+ Verificou se cada documento de página da Web que você deseja indexar é único e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**Em sua AWS conta, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o nome de recurso da Amazon da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Para sites que exigem autenticação, ou se estiverem usando um proxy da web com autenticação, armazenaram suas credenciais de autenticação em um AWS Secrets Manager segredo e, se estiverem usando a API, anotaram o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de web crawler dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de web crawler dados, você deve fornecer os detalhes necessários da sua fonte de web crawler dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou web crawler para Amazon Kendra ver[Pré-requisitos](#prerequisites-v2-web-crawler).
------
#### [ Console ]
**Para se conectar Amazon Kendra a web crawler**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do web crawler** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do crawler da web** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Fonte** — Escolha **Origem URLs**, Sitemaps de **origem, Arquivo de origem, ** URLsArquivo** de sitemaps** de **origem**. Se você optar por usar um arquivo de texto que inclua uma lista de até 100 sementes URLs, especifique o caminho para o Amazon S3 bucket em que seu arquivo está armazenado. Se você optar por usar um arquivo XML de mapa do site, especifique o caminho para o bucket do Amazon S3 em que o arquivo está armazenado. Você também pode agrupar vários arquivos XML de mapa do site em um arquivo ZIP. Caso contrário, você pode inserir manualmente até 10 sementes ou pontos URLs de partida e até três mapas do site URLs.
**nota**
Se você quiser rastrear um sitemap, verifique se o URL base ou raiz é o mesmo URLs listado na página do seu sitemap. Por exemplo, se o URL do seu sitemap for *https://example.com/sitemap-page.html*, o URLs listado nessa página do sitemap também deverá usar o URL base "”. https://example.com/
Se os sites precisarem de autenticação para acessar os sites, você poderá escolher a autenticação básica, NTLM/Kerberos, SAML ou de formulário. Caso contrário, escolha a opção sem autenticação.
**nota**
Se você quiser editar posteriormente sua fonte de dados para alterar sua semente URLs com autenticação em sitemaps, você deve criar uma nova fonte de dados. Amazon Kendra configura a fonte de dados usando as informações do URLs endpoint inicial no Secrets Manager segredo para autenticação e, portanto, não pode reconfigurar a fonte de dados ao mudar para sitemaps.
1. **AWS Secrets Manager segredo** — Se seus sites precisarem da mesma autenticação para acessar os sites, escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar as credenciais do seu site. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta será aberta.
Se escolher a Autenticação **básica** ou **NTML/Kerberos**, insira um nome para o segredo o nome de usuário e a senha. O protocolo de autenticação NTLM inclui hash de senha e o protocolo de autenticação Kerberos inclui criptografia de senha.
Se escolher a Autenticação **Formulário** ou **SAML**, insira um nome para o segredo o nome de usuário e a senha. Use XPath para o campo de nome de usuário (e XPath para o botão de nome de usuário se estiver usando SAML). Use XPaths para o campo e botão de senha e URL da página de login. Você pode encontrar os elementos XPaths (XML Path Language) usando as ferramentas de desenvolvedor do seu navegador. XPaths geralmente seguem este formato:`//tagname[@Attribute='Value']`.
1. (Opcional) **Proxy da Web**: insira o nome do host e o número da porta do servidor proxy que deseja usar para se conectar aos sites internos. Por exemplo, o nome do host *https://a.example.com/page1.html* é "a.example.com" e o número da porta é 443, a porta padrão para HTTPS. Se forem necessárias credenciais de proxy da web para se conectar a um host de site, você poderá criar uma AWS Secrets Manager que armazene as credenciais.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Escopo de sincronização** — defina limites para rastrear páginas da Web, incluindo seus domínios, tamanhos de arquivo e links, e filtre URLs usando padrões regex.
1. (Opcional) **Intervalo de domínios de rastreamento**: escolha se deseja rastrear somente domínios de sites, domínios com subdomínios ou também rastrear outros domínios aos quais as páginas da Web estão vinculadas. Por padrão, rastreia Amazon Kendra apenas os domínios dos sites que você deseja rastrear.
1. (Opcional) **Configurações adicionais**: defina as seguintes configurações opcionais:
+ **Profundidade do crawling**: a “profundidade” ou número de níveis do nível semente para crawling. Por exemplo, a página de URL semente tem profundidade 1 e todos os hiperlinks nessa página que também são rastreados têm profundidade 2.
+ **Tamanho máximo do arquivo**: o tamanho máximo em MB da página da Web ou do anexo a ser rastreado.
+ **Máximo de links por página** — O número máximo de links URLs em uma única página da Web para rastrear.
+ Limitação **máxima da velocidade de rastreamento** — O número máximo de sites URLs rastreados por host de site por minuto.
+ **Arquivos**: escolha para rastrear arquivos aos quais as páginas da web estão vinculadas.
+ Rastreamento **e indexação URLs** — adicione padrões de expressão regular para incluir ou excluir o rastreamento de determinados URLs hiperlinks e a indexação de quaisquer hiperlinks nessas páginas da Web com URL.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. **Cronograma de execução da sincronização**: em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos padrão Amazon Kendra gerados de páginas da Web e arquivos que você deseja mapear para o seu índice.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a web crawler**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-web-crawler-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `WEBCRAWLERV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **URLs**—Especifique a semente ou o ponto URLs de partida dos sites ou o mapa do site URLs dos sites que você deseja rastrear. Você pode especificar o caminho para um Amazon S3 bucket que armazena sua lista de sementes URLs. Cada URL no arquivo de texto da semente URLs deve ser formatada em uma linha separada. Você também pode especificar o caminho para um Amazon S3 bucket que armazena seus arquivos XML do sitemap. Você pode agrupar vários arquivos do mapa do site em um arquivo ZIP e armazená-lo em seu bucket do Amazon S3 .
**nota**
Se você quiser rastrear um sitemap, verifique se o URL base ou raiz é o mesmo URLs listado na página do seu sitemap. Por exemplo, se o URL do seu sitemap for *https://example.com/sitemap-page.html*, o URLs listado nessa página do sitemap também deverá usar o URL base "”. https://example.com/
+ **Modo de sincronização** — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Autenticação**: se os sites exigirem a mesma autenticação, especifique a autenticação `BasicAuth`, `NTLM_Kerberos`, `SAML` ou `Form`. Se os sites não precisarem de autenticação, especifique `NoAuthentication`.
+ **Nome do recurso da Amazon (ARN) da senha**: se os sites exigirem autenticação básica, NTLM ou Kerberos, você fornecerá uma senha que armazena as credenciais de autenticação de nome de usuário e senha. Forneça o nome do recurso da Amazon (ARN) da senha do AWS Secrets Manager . A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"seedUrlsHash": "Hash representation of all seed URLs",
"userName": "user name",
"password": "password"
}
```
Se o site precisar de uma autenticação OAuth2, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"seedUrlsHash": "Hash representation of all seed URLs",
"userName": "user name",
"password": "password",
"userNameFieldXpath": "XPath for user name field",
"userNameButtonXpath": "XPath for user name button",
"passwordFieldXpath": "XPath for password field",
"passwordButtonXpath": "XPath for password button",
"loginPageUrl": "Full URL for website login page"
}
```
Se o site precisar de uma autenticação, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"seedUrlsHash": "Hash representation of all seed URLs",
"userName": "user name",
"password": "password",
"userNameFieldXpath": "XPath for user name field",
"passwordFieldXpath": "XPath for password field",
"passwordButtonXpath": "XPath for password button",
"loginPageUrl": "Full URL for website login page"
}
```
Você pode encontrar os elementos XPaths (XML Path Language) usando as ferramentas de desenvolvedor do seu navegador. XPaths geralmente seguem este formato:`//tagname[@Attribute='Value']`.
Você também pode fornecer credenciais de proxy da web usando uma senha do AWS Secrets Manager .
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do web crawler e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do web crawler](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Faixa de domínio**: escolha se deseja rastrear somente domínios de sites, domínios com subdomínios ou também rastrear outros domínios aos quais as páginas da Web estão vinculadas. Por padrão, rastreia Amazon Kendra apenas os domínios dos sites que você deseja rastrear.
+ A “profundidade” ou número de níveis do nível semente para crawling. Por exemplo, a página de URL semente tem profundidade 1 e todos os hiperlinks nessa página nos quais também será realizado crawling têm profundidade 2.
+ O número máximo de páginas da URLs web a serem rastreadas em uma única página da web.
+ O tamanho máximo em MB de uma página da Web ou anexo para crawling.
+ O número máximo de URLs rastreados por host do site por minuto.
+ O host do proxy da web e o número da porta para se conectar e rastrear sites internos. Por exemplo, o nome do host *https://a.example.com/page1.html* é "a.example.com" e o número da porta é 443, a porta padrão para HTTPS. Se o proxy da Web exigir credenciais para se conectar ao host de um site, crie um AWS Secrets Manager que armazene as credenciais.
+ **Filtros de inclusão e exclusão** — especifique se deseja incluir ou excluir o rastreamento de determinados hiperlinks URLs e a indexação de quaisquer hiperlinks nessas páginas da Web com URL.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo — Escolha mapear** os campos de páginas da Web e arquivos de páginas da Web para seus Amazon Kendra campos de índice. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Web Crawler do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-web-crawler).
------
# Configurando o `robots.txt` arquivo para o Amazon Kendra Web Crawler
Configurando o `robots.txt` arquivo para o Amazon Kendra Web Crawler
Amazon Kendra é um serviço de pesquisa inteligente que AWS os clientes usam para indexar e pesquisar documentos de sua escolha. Para indexar documentos na web, os clientes podem usar o Amazon Kendra Web Crawler, indicando quais URLs devem ser indexados e outros parâmetros operacionais. Amazon Kendra os clientes precisam obter autorização antes de indexar qualquer site específico.
Amazon Kendra O Web Crawler respeita as diretivas padrão do robots.txt, como e. `Allow` `Disallow` Você pode modificar o `robots.txt` arquivo do seu site para controlar como o Amazon Kendra Web Crawler rastreia seu site.
## Configurando como o Amazon Kendra Web Crawler acessa seu site
Você pode controlar como o Amazon Kendra Web Crawler indexa o uso `Allow` e as diretrizes do seu site. `Disallow` Você também pode controlar quais páginas da Web são indexadas e quais páginas da Web não são rastreadas.
**Para permitir que o Amazon Kendra Web Crawler rastreie todas as páginas da Web, exceto páginas da Web não permitidas, use a seguinte diretiva:**
```
User-agent: amazon-kendra # Amazon Kendra Web Crawler
Disallow: /credential-pages/ # disallow access to specific pages
```
**Para permitir que o Amazon Kendra Web Crawler rastreie somente páginas da Web específicas, use a seguinte diretiva:**
```
User-agent: amazon-kendra # Amazon Kendra Web Crawler
Allow: /pages/ # allow access to specific pages
```
**Para permitir que o Amazon Kendra Web Crawler rastreie todo o conteúdo do site e proibir o rastreamento de outros robôs, use a seguinte diretiva:**
```
User-agent: amazon-kendra # Amazon Kendra Web Crawler
Allow: / # allow access to all pages
User-agent: * # any (other) robot
Disallow: / # disallow access to any pages
```
## Impedindo que o Amazon Kendra Web Crawler rastreie seu site
Você pode impedir que o Amazon Kendra Web Crawler indexe seu site usando a diretiva. `Disallow` Você também pode controlar quais páginas da Web são rastreadas ou não.
**Para impedir que o Amazon Kendra Web Crawler rastreie o site, use a seguinte diretiva:**
```
User-agent: amazon-kendra # Amazon Kendra Web Crawler
Disallow: / # disallow access to any pages
```
Se você tiver alguma dúvida ou preocupação em relação ao Amazon Kendra Web Crawler, entre em contato com a equipe de [AWS suporte](https://aws.amazon.com/contact-us/?nc1=f_m).
# Box
O Box é um serviço de armazenamento em nuvem que oferece recursos de hospedagem de arquivos. Você pode usar Amazon Kendra para indexar o conteúdo do seu Box, incluindo comentários, tarefas e links da web.
Você pode se conectar Amazon Kendra à sua fonte de dados do Box usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [BoxConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BoxConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Box, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-box)
+ [
## Pré-requisitos
](#prerequisites-box)
+ [
## Instruções de conexão
](#data-source-procedure-box)
+ [
## Saiba mais
](#box-learn-more)
+ [
## Observações
](#box-notes)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados Box oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Log de alterações, sincronizações de conteúdo completas e incrementais
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Box, faça essas alterações no Box e AWS nas contas.
**No Box, verifique se você:**
+ Tem uma conta Box Enterprise ou Box Enterprise Plus.
+ Configurou uma aplicação personalizada do Box no Box Developer Console com a autenticação do lado do servidor usando o JSON Web Tokens (JWT). Consultou a [Documentação do Box sobre a criação de um aplicativo personalizado](https://developer.box.com/guides/applications/app-types/platform-apps/) e a [Documentação do Box sobre a configuração do JWT Auth](https://developer.box.com/guides/authentication/jwt/) para obter mais detalhes.
+ Definiu seu **nível de acesso** ao **Aplicativo e ao Enterprise Access** e permita que ele **Faça chamadas de API usando o cabeçalho como usuário**.
+ Usou o usuário administrador para adicionar os seguintes **Escopos de aplicativo** no aplicativo Box:
+ Gravou todos os arquivos e pastas armazenados no Box
+ Gerenciar usuários
+ Gerenciar grupos
+ Gerenciar propriedades corporativas
+ Par de Public/Private chaves configurado, incluindo um ID do cliente, um segredo do cliente, um ID de chave pública, um ID de chave privada, uma frase secreta e um ID corporativo para usar como suas credenciais de autenticação. Consulte mais detalhes em [Public and private key pair](https://developer.box.com/guides/authentication/jwt/jwt-setup/#public-and-private-key-pair).
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Copiou a ID do Enterprise do Box das configurações do Box Developer Console ou do aplicativo Box. Por exemplo, .*801234567*
+ Verifique se cada documento é exclusivo no Box e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Box em uma senha doAWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Box Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Box, você deve fornecer os detalhes necessários da fonte de dados do Box para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Box paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-box).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Box**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Box** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Box** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **ID do Box Enterprise**: insira seu ID do Box Enterprise. Por exemplo, .*801234567*
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Box. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Box-' é adicionado automaticamente ao seu nome secreto.
1. Para **ID do cliente**, **segredo do cliente**, ID da **chave pública, ID** da **chave privada** e **frase secreta**, insira os valores da Public/Private chave que você configurou no Box.
1. Adicione e salve o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Arquivos do Box**: escolha se deseja fazer crawling de links da web, comentários e tarefas.
1. Em **Configurações adicionais**: adicione padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Box**
Você deve especificar o seguinte usando a [BoxConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BoxConfiguration.html)API:
**ID do Box Enterprise**: insira seu ID do Box Enterprise. Você pode encontrar a ID do Enterprise nas configurações do Box Developer Console ou ao configurar uma aplicação no Box.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta Box. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"clientID": "client-id",
"clientSecret": "client-secret",
"publicKeyID": "public-key-id",
"privateKey": "private-key",
"passphrase": "pass-phrase"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Box e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para fontes de dados do Box](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique `VpcConfiguration` como parte da configuração da fonte de dados. Consulte [Configuração do Amazon Kendra para usar uma VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
+ **Log de alterações**: se o Amazon Kendra deve usar o mecanismo de log de alterações da fonte de dados do Box para determinar se um documento deve ser atualizado no índice.
**nota**
Use o log de alterações se o Amazon Kendra não quiser digitalizar todos os documentos. Se o registro de alterações for grande, talvez leve Amazon Kendra menos tempo para digitalizar os documentos na fonte de dados do Box do que para processar o registro de alterações. Se estiver sincronizando a fonte de dados do Box com o índice pela primeira vez, todos os documentos serão digitalizados.
+ **Comentários, tarefas, links da web**: especifique se é necessário fazer crawling desses tipos de conteúdo.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir certos arquivos e pastas do Box.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Box para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Box, consulte:
+ [Introdução ao conector Amazon Kendra Box](https://aws.amazon.com/blogs/machine-learning/getting-started-with-the-amazon-kendra-box-connector/)
## Observações
+ Quando as listas de controle de acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações da API Box. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# Confluence
O Confluence é uma ferramenta colaborativa de gerenciamento de trabalho projetada para compartilhar, armazenar e trabalhar no planejamento de projetos, desenvolvimento de software e gerenciamento de produtos. Amazon Kendra é compatível com o Confluence Server/Data Center e o Confluence Cloud. Você pode usar Amazon Kendra para indexar as seguintes entidades do Confluence:
+ **Espaços**: áreas designadas de alto nível para organizar conteúdo relacionado. Cada espaço serve como um contêiner, capaz de armazenar várias páginas, blogs e anexos.
+ **Páginas**: documentos individuais em um espaço em que os usuários criam e gerenciam conteúdo. As páginas podem conter texto, imagens, tabelas e elementos multimídia e podem ter subpáginas aninhadas. Cada página é considerada um único documento.
+ **Blogs**: conteúdo semelhante a páginas, normalmente usado para atualizações ou anúncios. Cada publicação de blog é considerada um único documento.
+ **Comentários**: permite que os usuários forneçam feedback ou participem de discussões sobre conteúdo específico em páginas ou publicações de blog.
+ **Anexos**: arquivos carregados em páginas ou publicações do blog no Confluence, como imagens, documentos ou outros tipos de arquivo.
Por padrão, Amazon Kendra não indexa arquivos e espaços pessoais do Confluence. Você pode optar por indexá-los ao criar a fonte de dados. Se você não quiser Amazon Kendra indexar um espaço, marque-o como privado no Confluence.
Você pode se conectar Amazon Kendra à sua fonte de dados do Confluence usando o [Amazon Kendra console](https://console.aws.amazon.com/kendra/), a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API ou a [ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html)API.
Amazon Kendra tem duas versões do conector Confluence. Os seguintes recursos são compatíveis.
****Conector Confluence V2.0/API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)****
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Padrões de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
****Conector Confluence V1.0/[ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html)API** (não é mais compatível)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ (Somente para o Confluence Server) Nuvem privada virtual (VPC)
**nota**
O conector V1.0 ConfluenceConfiguration /API do Confluence terminou em 2023. Recomendamos migrar ou usar o conector V2.0/API do Confluence. TemplateConfiguration
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Confluence, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## ACLs no Confluence Connector
](#data-source-confluence-acls)
+ [
# Conector Confluence v2.0
](data-source-v2-confluence.md)
+ [
# Conector o Confluence v1.0
](data-source-v1-confluence.md)
## ACLs no Confluence Connector
Os conectores suportam o rastreamento de listas de controle de acesso (ACLs) e a identificação de informações, quando aplicável, com base na fonte de dados. Se você indexar documentos sem ACLs, todos os documentos serão considerados públicos. A indexação de documentos ACLs garante a segurança dos dados.
O conector do Amazon Kendra Confluence digitaliza espaços para coletar páginas e postagens de blog junto com suas. ACLs Se não houver nenhuma restrição aplicada em uma página ou blog, o conector herdará as permissões de seu espaço. Se uma restrição específica de usuário ou grupo for aplicada em uma página, somente esses usuários poderão acessá-la. Se a página estiver aninhada, ela herdará as permissões da página principal caso nenhuma restrição tenha sido aplicada. Um modelo de permissões semelhante se aplica aos blogs. No entanto, o Confluence não é compatível com blogs aninhados.
Além disso, o conector do Amazon Kendra Confluence rastreia as informações principais do usuário (alias de usuário local, configurações de identidade de grupo local e grupo federado) e suas permissões para cada espaço configurado.
**nota**
O conector do Confluence Cloud não permite fazer crawling de macros, quadros brancos ou bancos de dados.
O conector do Amazon Kendra Confluence atualiza as alterações da ACL sempre que rastreia o conteúdo da fonte de dados. Para garantir que os usuários certos tenham acesso ao conteúdo correto, sincronize novamente sua fonte de dados para capturar quaisquer atualizações na ACL.
# Conector Confluence v2.0
O Confluence é uma ferramenta colaborativa de gerenciamento de trabalho projetada para compartilhar, armazenar e trabalhar no planejamento de projetos, no desenvolvimento de software e no gerenciamento de produtos. Você pode usar Amazon Kendra para indexar seus espaços, páginas do Confluence (incluindo páginas aninhadas), blogs e comentários e anexos em páginas e blogs indexados.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Confluence, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-confluence)
+ [
## Pré-requisitos
](#prerequisites-v2-confluence)
+ [
## Instruções de conexão
](#data-source-procedure-v2-confluence)
## Recursos compatíveis
Amazon Kendra O conector de fonte de dados do Confluence oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Padrões de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Confluence, faça essas alterações no Confluence e nas contas. AWS
**No Confluence, verifique se você tem:**
+ Copiar o URL da sua instância do Confluence. Por exemplo:*https://example.confluence.com*, ou*https://www.example.confluence.com/*, ou*https:// atlassian.net/*. O URL da instância do Confluence é necessário para se conectar ao Amazon Kendra.
Se você estiver usando o Confluence Cloud, o URL do seu host deve terminar com. *atlassian.net/*
**nota**
Os seguintes formatos de URL **não** são compatíveis:
*https://example.confluence.com/xyz*
*https://www.example.confluence.com//wiki/spacekey/xxx*
*https://atlassian.net/xyz*
**nota**
(Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são iguais às informações do endpoint especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o [problema de assistência confusa](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html), que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.
+ Configurou credenciais básicas de autenticação que contêm um nome de usuário (ID de e-mail usado para fazer login no Confluence) e uma senha (token de API do Confluence como senha). Consulte [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token).
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional:** credenciais OAuth 2.0 configuradas contendo uma chave do aplicativo Confluence, um segredo do aplicativo Confluence, um token de acesso do Confluence e um token de atualização do Confluence para permitir a conexão com sua instância do Confluence. Amazon Kendra Se o token de acesso expirar, você poderá usar o token de atualização para regenerar o token de acesso e o par de tokens de atualização. Ou você pode repetir o processo de autorização. Para obter mais informações sobre tokens de acesso, consulte [Gerenciar tokens de OAuth acesso](https://support.atlassian.com/confluence-cloud/docs/manage-oauth-access-tokens/).
+ (Somente para o Confluence Server/Data Center) **Opcional:** configurou um token de acesso pessoal (PAT) no Confluence. Consulte [Using Personal Access Tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html).
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Confluence em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Confluence a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Confluence, você deve fornecer os detalhes necessários da sua fonte de dados do Confluence para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Confluence para Amazon Kendra ver. [Pré-requisitos](#prerequisites-v2-confluence)
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Confluence**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Confluence** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Confluence** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Source**, escolha **Confluence Cloud ou ** Server/Data Confluence**** Center.
1. **URL do Confluence** insira o URL do host do Confluence. Por exemplo, .*https://example.confluence.com*
1. (Somente para o Confluence Server/Data Center) **Local do certificado SSL - *opcional*** — Insira o Amazon S3 caminho para seu arquivo de certificado SSL para o Confluence Server.
1. (Somente para o Confluence Server/Data Center) **Proxy Web - *opcional*** — Insira o nome do host do proxy web (sem o `https://` protocolo `http://` or) e o número da porta (porta usada pelo protocolo de transporte de URL do host). O número da porta deve ser um valor numérico entre 0 e 65535.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Autenticação** **— escolha entre **autenticação básica, autenticação** **Oauth 2.0 ou (somente para o Confluence Server/Data Center) autenticação** de token de acesso pessoal.**
1. **Segredo do AWS Secrets Manager **: escolha um segredo existente ou crie um segredo do Secrets Manager para armazenar as credenciais de autenticação do Confluence. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta. Insira as seguintes informações na janela:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Confluence-' é adicionado automaticamente ao seu nome secreto.
1. Se estiver usando a **Autenticação básica**, insira o nome do segredo, o nome de usuário e a senha (token da API do Confluence como senha) que você configurou no Confluence.
Se estiver usando a **autenticação OAuth2 .0**, insira o nome secreto, a chave do aplicativo, o segredo do aplicativo, o token de acesso e o token de atualização que você configurou no Confluence.
(Somente Server/Data no Confluence Center) Se estiver usando a **autenticação do Personal Access Token**, insira o nome secreto e o token do Confluence que você configurou no seu Confluence.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Escopo de sincronização**, em **Sincronizar conteúdos**: escolha sincronizar entre os seguintes tipos de conteúdo: páginas, comentários da página, anexos da página, blogs, comentários do blog, anexos do blog, espaços pessoais e espaços arquivados.
**nota**
Os comentários e os anexos da página só poderão ser selecionados se você optar por sincronizar as **Páginas**. Os comentários e os anexos do blog só poderão ser selecionados se você optar por sincronizar os **Blogs**.
**Importante**
Se você não especificar um padrão de regex de chave de espaço em **Configuração adicional**, será feito crawling de todas as páginas e blogs por padrão.
1. Em **Configuração adicional**, em **Tamanho máximo do arquivo** — Especifique o limite de tamanho do arquivo MBs que Amazon Kendra será rastreado. Amazon Kendra rastreará somente os arquivos dentro do limite de tamanho definido. O tamanho de arquivo padrão é 50 MB. O tamanho máximo do arquivo deve ser maior que 0 MB e menor que ou igual a 50 MB.
Em **Padrões regex de espaços**: especifique se deseja incluir ou excluir espaços específicos no índice usando:
+ Tecla de espaço (por exemplo,*my-space-123*)
**nota**
Se você não especificar um padrão de regex de chave de espaço, será feito crawling de todas as páginas e blogs por padrão.
+ URL (por exemplo,*.\$1/MySite/MyDocuments/*)
+ Tipo de arquivo (por exemplo,*.\$1\$1.pdf, .\$1\$1.txt*)
Em **Padrões de regex de títulos de entidades**: especifique padrões de expressão regular para incluir ou excluir determinados blogs, páginas, comentários e anexos por títulos.
**nota**
Se deseja incluir ou excluir o crawling de uma página ou subpágina específica, use os padrões de regex do título da página.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Confluence**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-confluence-schema) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `CONFLUENCEV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **URL do host**: especifique a instância do URL do host do Confluence. Por exemplo, .*https://example.confluence.com*
+ **Modo de sincronização**: especifique como o Amazon Kendra deve atualizar o índice quando o conteúdo da fonte de dados é alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL`para indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Tipo de autenticação**: especifique o tipo de autenticação, se `Basic`, `OAuth2`, `Personal-token` (somente Confluence Server).
+ (Opcional: somente para o Confluence Server) **Local do certificado SSL**: especifique o `S3bucketName` e `s3certificateName` usados para armazenar o certificado SSL.
+ **Nome de recurso secreto da Amazon (ARN)** — Forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação que você configurou no Confluence. Se você usar uma autenticação básica, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "email ID or user name",
"password": "Confluence API token"
}
```
Se você usa a autenticação OAuth 2.0, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"confluenceAppKey": "app key",
"confluenceAppSecret": "app secret",
"confluenceAccessToken": "access token",
"confluenceRefreshToken": "refresh token"
}
```
Somente para Servidor Confluence) Se você usar uma autenticação básica, a senha deverá ser armazenada em uma estrutura JSON com as seguintes chaves:
```
{
"hostUrl": "Confluence Server host URL",
"username": "Confluence Server user name",
"password": "Confluence Server password"
}
```
Somente para Servidor Confluence) Se você usar a autenticação com token de acesso pessoal, a senha será armazenada em uma estrutura JSON com as seguintes chaves:
```
{
"hostUrl": "Confluence Server host URL",
"patToken": "personal access token"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Confluence e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Confluence](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Tamanho do arquivo**: especifique o tamanho máximo do arquivo do qual fazer crawling.
+ **Tipos de documento/conteúdo**: especifique se deseja fazer crawling de páginas, comentários da página, anexos da página, blogs, comentários de blog, anexos de blog, espaços e espaços arquivados.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados espaços, páginas, blogs e seus comentários e anexos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Proxy da web**: especifique as informações do proxy da web se quiser se conectar à instância de URL do Confluence por meio de um proxy da web. Você pode usar essa opção para o Confluence Server.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Confluence para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Consulte uma lista de outras chaves JSON importantes a serem configuradas em [Esquema do modelo do Confluence](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-confluence-schema).
------
### Observações
+ O token de acesso pessoal (PAT) não está disponível para o Confluence Cloud.
# Conector o Confluence v1.0
O Confluence é uma ferramenta colaborativa de gerenciamento de trabalho projetada para compartilhar, armazenar e trabalhar no planejamento de projetos, no desenvolvimento de software e no gerenciamento de produtos. Você pode usar Amazon Kendra para indexar seus espaços, páginas do Confluence (incluindo páginas aninhadas), blogs e comentários e anexos em páginas e blogs indexados.
**nota**
O conector V1.0 ConfluenceConfiguration /API do Confluence terminou em 2023. Recomendamos migrar ou usar o conector V2.0/API do Confluence. TemplateConfiguration
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Confluence, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-confluence)
+ [
## Pré-requisitos
](#prerequisites-v1-confluence)
+ [
## Instruções de conexão
](#data-source-procedure-v1-confluence)
+ [
## Saiba mais
](#confluence-v1-learn-more)
## Recursos compatíveis
Amazon Kendra O conector de fonte de dados do Confluence oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ (Somente para o Confluence Server) Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Confluence, faça essas alterações no Confluence e nas contas. AWS
**No Confluence, verifique se você tem:**
+ Amazon Kendra Permissões concedidas para visualizar todo o conteúdo em sua instância do Confluence por:
+ Tornando Amazon Kendra um membro do `confluence-administrators` grupo.
+ Conceder permissões de administrador do site para todos os espaços, blogs e páginas existentes.
+ Copiar o URL da sua instância do Confluence.
+ **Para usuários de SSO (autenticação única):** ative **Exibir na página de login** para o nome de usuário e a senha ao configurar os **Métodos de autenticação** do Confluence no Confluence Data Center.
+ **Para o Confluence Server**
+ Anote suas credenciais básicas de autenticação contendo o nome de usuário e a senha da conta administrativa do Confluence para se conectar ao Amazon Kendra.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional:** gerou um token de acesso pessoal na sua conta do Confluence para se conectar ao Amazon Kendra. Para obter mais informações, consulte a [documentação do Confluence sobre a geração de tokens de acesso pessoal](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html).
+ **Para o Confluence Cloud**
+ Anote suas credenciais básicas de autenticação contendo o nome de usuário e a senha da conta administrativa do Confluence para se conectar ao Amazon Kendra.
+ Verifique se cada documento é exclusivo no Confluence e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Confluence em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Confluence a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Confluence, você deve fornecer detalhes das suas credenciais do Confluence para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Confluence para Amazon Kendra ver. [Pré-requisitos](#prerequisites-v1-confluence)
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Confluence**
1. Faça login no AWS Management Console e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Confluence V1.0** e, em seguida, escolha **Adicionar fonte de .dados**.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Escolha entre **Confluence Cloud** e **Confluence Server**.
1. Se escolher **Confluence Cloud**, insira as seguintes informações:
1. **URL do Confluence**: seu URL do Confluence.
1. **AWS Secrets Manager segredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Confluence. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager **:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Confluence-' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário** e **Senha**: insira o nome de usuário e a senha do Confluence.
1. Escolha **Salvar autenticação**.
1. Se escolher o **Confluence Server**, insira as seguintes informações:
1. **URL do Confluence**: seu nome de usuário e senha do Confluence.
1. (Opcional) Para o **proxy da Web**, insira as seguintes informações:
1. **Nome do hos**: nome do host da sua conta do Confluence.
1. **número da porta**: o número da publicação usado pelo protocolo de transporte de URL do host.
1. Em **Autenticação**, escolha **Autenticação básica** ou **Token de acesso pessoal** (somente Confluence Server).
1. **AWS Secrets Manager segredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Confluence. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager **:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Confluence-' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário** e **Senha**: insira os valores da credencial de autenticação que você configurou no Confluence. Se estiver usando a autenticação básica, use seu nome de usuário (ID de e-mail) e senha (token de API) do Confluence. Se estiver usando o token de acesso pessoal, insira os detalhes do **Token de acesso pessoal** que você configurou na conta do Confluence.
1. Salve e adicione o segredo.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Incluir espaços pessoais** e **Incluir espaços arquivados**, escolha os tipos de espaço opcionais a serem incluídos nessa fonte de dados.
1. Para **configuração adicional**, especifique padrões de expressão regular para incluir ou excluir determinado conteúdo. Você pode adicionar até 100 padrões.
1. Você também pode optar por **Rastrear anexos nos espaços escolhidos**.
1. Em **Cronograma de execução da sincronização**, em **Frequência** — Escolha com que frequência Amazon Kendra será sincronizada com sua fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **Espaço**, **Página**, **Blog** — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados ou **mapeamentos de campo adicionais sugeridos** para adicionar campos de índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Confluence**
Você deve especificar o seguinte usando a [ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html)API:
+ **Versão do Confluence**: especifique a versão da instância do Confluence usada: `CLOUD` ou `SERVER`.
+ **Nome de recurso secreto da Amazon (ARN)** — Forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha suas credenciais de autenticação do Confluence.
Se você usa o Confluence Server, pode usar o nome de usuário e a senha do Confluence ou o token de acesso pessoal como credenciais de autenticação.
Se você usa o nome de usuário e a senha do Confluence como credenciais de autenticação, armazene as seguintes credenciais como uma estrutura JSON em seu segredo do Secrets Manager :
```
{
"username": "user name",
"password": "password"
}
```
Se você usa um token de acesso pessoal para se conectar ao Confluence Server Amazon Kendra, armazene as seguintes credenciais como uma estrutura JSON em seu segredo: Secrets Manager
```
{
"patToken": "personal access token"
}
```
Se você usa o Confluence Cloud, use seu nome de usuário do Confluence e um token de API, configurado no Confluence, como senha. Você armazena as seguintes credenciais como uma estrutura JSON em seu Secrets Manager segredo:
```
{
"username": "user name",
"password": "API token"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Confluence e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Confluence](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Proxy da Web**: para conectar à instância de URL do Confluence por meio de um proxy da Web. Você pode usar essa opção para o Confluence Server.
+ (Apenas para o Servidor Confluence) **Nuvem privada virtual (VPC)**: especifique o `VpcConfiguration` como parte da configuração da fonte de dados. Consulte [Configuração Amazon Kendra para usar uma VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
+ **Filtros de inclusão e exclusão**: especifique padrões de expressões regulares para incluir ou excluir determinados espaços, publicações de blog, páginas, espaços e anexos. Se você optar por indexar anexos, somente os anexos das páginas indexadas e dos blogs serão indexados.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Confluence para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Confluence, consulte:
+ [Configurando seu conector do Amazon Kendra Confluence Server](https://aws.amazon.com/blogs/machine-learning/configuring-your-amazon-kendra-confluence-server-connector/)
# Conectores de fontes de dados personalizados
Use uma fonte de dados personalizada quando você tiver um repositório que o Amazon Kendra ainda não fornece um conector de fonte de dados para ele. Você pode usá-lo para ver as mesmas métricas de histórico de execução que as fontes de dados do Amazon Kendra fornecem, mesmo quando não é possível usar as fontes de dados do Amazon Kendra para sincronizar os repositórios. Use isso para criar uma experiência consistente de monitoramento de sincronização entre fontes de dados do Amazon Kendra e fontes personalizadas. [Especificamente, use uma fonte de dados personalizada para ver as métricas de sincronização de um conector de fonte de dados criado usando as APIs [BatchputDocument e BatchDeleteDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html).](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchDeleteDocument.html)
Para solucionar problemas do conector da fonte de dados do Amazon Kendra, consulte [Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
Ao criar uma fonte de dados personalizada, você tem controle total sobre como os documento indexados são selecionados. O Amazon Kendra fornece apenas informações métricas sobre o que pode ser usado para monitorar as tarefas de sincronização da origem dos dados. Você deve criar e executar o crawler que determina os documentos indexados pela fonte de dados.
Especifique o título principal dos documentos usando o objeto [Documento](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Document.html) e `_source_uri` em [DocumentAttribute](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttribute.html) para incluir `DocumentTitle` e `DocumentURI` na resposta do resultado da `Query`.
Você cria um identificador para a fonte de dados personalizada usando o console ou a API [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html). Para usar o console, dê um nome à sua fonte de dados e, opcionalmente, uma descrição e tags de recursos. Depois que a fonte de dados é criada, um ID da fonte de dados é exibida. Copie esse ID para usar ao sincronizar a fonte de dados com o índice.
![\[Form for specifying data source details, including name, description, and optional tags.\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/images/CustomDataSource.png)
Também é possível criar uma fonte de dados personalizada usando a API `CreateDataSource`. A API retorna um ID para ser usado quando ao sincronizar a fonte de dados. Ao usar a API `CreateDataSource` para criar uma fonte de dados personalizada, não é possível definir os parâmetros `Configuration`, `RoleArn` ou `Schedule`. Se você definir esses parâmetros, Amazon Kendra retornará uma exceção do `ValidationException`.
Para usar uma fonte de dados personalizada, crie um aplicativo responsável pela atualização do índice do Amazon Kendra. O aplicativo depende de um crawler criado por você. O crawler lê os documentos em seu repositório e determina quais devem ser enviados para Amazon Kendra. O aplicativo deve executar as seguintes etapas:
1. Rastreie o repositório e faça uma lista dos documentos no repositório que foram adicionados, atualizados ou excluídos.
1. Chame a API [StartDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StartDataSourceSyncJob.html) para sinalizar que um trabalho de sincronização está sendo iniciado. Forneça um ID da fonte de dados para identificar a fonte de dados que está sincronizando. o Amazon Kendra retorna um ID de execução para identificar um trabalho de sincronização específico.
1. Chame a API [BatchDeleteDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchDeleteDocument.html) para remover documentos do índice. Forneça o ID da fonte de dados e o ID de execução para identificar a fonte de dados que está sendo sincronizada e o trabalho ao qual essa atualização está associada.
1. Chame a API [StopDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StopDataSourceSyncJob.html) para sinalizar o fim do trabalho de sincronização. Depois de chamar a API `StopDataSourceSyncJob`, o ID de execução associado não é mais válido.
1. Chame a API [ListDataSourceSyncJobs](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ListDataSourceSyncJobs.html) com os identificadores de índice e fonte de dados para listar os trabalhos de sincronização da fonte de dados e ver as métricas dos trabalhos de sincronização.
Depois de finalizar um trabalho de sincronização, você pode iniciar um novo trabalho de sincronização. Pode haver um período de tempo até que todos os documentos enviados sejam adicionados ao índice. Use a API `ListDataSourceSyncJobs` para ver o status da tarefa de sincronização. Se o `Status` retornado para o trabalho de sincronização for `SYNCING_INDEXING`, alguns documentos ainda estão sendo indexados. Você pode iniciar um novo trabalho de sincronização quando o status do trabalho anterior for `FAILED` ou `SUCCEEDED`.
Depois de chamar a API `StopDataSourceSyncJob`, você não pode usar um identificador de trabalho de sincronização em uma chamada para as APIs `BatchPutDocument` ou `BatchDeleteDocument`. Se você fizer isso, todos os documentos enviados serão retornados na mensagem de resposta `FailedDocuments` da API.
## Atributos obrigatórios
Quando você envia um documento para Amazon Kendra usar a API `BatchPutDocument`, cada documento exige dois atributos para identificar a fonte de dados e a execução de sincronização à qual ela pertence. Você deve fornecer os dois seguintes atributos para mapear documentos da sua fonte de dados personalizada corretamente para um índice do Amazon Kendra:
+ `_data_source_id`: o identificador da fonte de dados. Ele é retornado quando você cria a fonte de dados com o console ou a API `CreateDataSource`.
+ `_data_source_sync_job_execution_id`: o identificador da execução da sincronização. Ele é retornado quando você inicia a sincronização do índice com a API `StartDataSourceSyncJob`.
Veja a seguir o JSON necessário para indexar um documento usando uma fonte de dados personalizada.
```
{
"Documents": [
{
"Attributes": [
{
"Key": "_data_source_id",
"Value": {
"StringValue": "data source identifier"
}
},
{
"Key": "_data_source_sync_job_execution_id",
"Value": {
"StringValue": "sync job identifier"
}
}
],
"Blob": "document content",
"ContentType": "content type",
"Id": "document identifier",
"Title": "document title"
}
],
"IndexId": "index identifier",
"RoleArn": "IAM role ARN"
}
```
Ao remover um documento do índice usando a API `BatchDeleteDocument`, especifique os dois campos a seguir no parâmetro `DataSourceSyncJobMetricTarget`:
+ `DataSourceId`: o identificador da fonte de dados. Ele é retornado quando você cria a fonte de dados com o console ou a API `CreateDataSource`.
+ `DataSourceSyncJobId`: o identificador da execução da sincronização. Ele é retornado quando você inicia a sincronização do índice com a API `StartDataSourceSyncJob`.
Veja a seguir o JSON necessário para excluir um documento do índice usando API `BatchDeleteDocument`.
```
{
"DataSourceSyncJobMetricTarget": {
"DataSourceId": "data source identifier",
"DataSourceSyncJobId": "sync job identifier"
},
"DocumentIdList": [
"document identifier"
],
"IndexId": "index identifier"
}
```
## Visualizar métricas
Depois que um trabalho de sincronização for concluído, use a API [DataSourceSyncJobMetrics para obter as métricas](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DataSourceSyncJobMetrics.html) associadas ao trabalho de sincronização. Use ela para monitorar as sincronizações de fontes de dados personalizadas.
Se você enviar o mesmo documento várias vezes, seja como parte da API `BatchPutDocument`, da `BatchDeleteDocument` API ou se o documento for enviado para adição e exclusão, o documento será contado apenas uma vez nas métricas.
+ `DocumentsAdded`: o número de documentos enviados usando a API `BatchPutDocument` associada a esse trabalho de sincronização adicionados ao índice pela primeira vez. Se um documento for enviado para adição mais de uma vez em uma sincronização, ele será contabilizado apenas uma vez nas métricas.
+ `DocumentsDeleted`: o número de documentos enviados usando a API `BatchDeleteDocument` associada a esse trabalho de sincronização excluídos pelo índice.. Se um documento for enviado para exclusão mais de uma vez em uma sincronização, ele será contabilizado apenas uma vez nas métricas.
+ `DocumentsFailed`: o número de documentos associados a essa tarefa de sincronização que falharam na indexação. Esses são documentos que foram aceitos por Amazon Kendra para indexação, mas que não puderam ser indexados ou excluídos. Se um documento não for aceito por Amazon Kendra, o identificador do documento será retornado na propriedade de resposta `FailedDocuments` das APIs `BatchPutDocument` e `BatchDeleteDocument`.
+ `DocumentsModified`: o número de documentos modificados e enviados usando a API `BatchPutDocument` associada a esse trabalho de sincronização modificados no índice Amazon Kendra.
O Amazon Kendra também emite métricas do Amazon CloudWatch ao indexar documentos. Para obter mais informações, consulte [Monitoramento do Amazon Kendra com o Amazon CloudWatch](https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-metrics.html).
O Amazon Kendra não retorna a métrica `DocumentsScanned` para fontes de dados personalizadas. Ele também emite as métricas CloudWatch listadas no documento [Métricas para fontes de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-metrics.html#cloudwatch-metrics-data-source).
## Saiba mais
Para saber mais sobre a integração do Amazon Kendra com a fonte de dados, consulte:
+ [Adicionar fontes de dados personalizadas ao Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/adding-custom-data-sources-to-amazon-kendra/)
# Fontes de dados personalizadas (Java)
O código a seguir fornece um exemplo de implementação de uma fonte de dados personalizada usando Java. Primeiro, o programa cria uma fonte de dados personalizada e depois sincroniza os documentos recém-adicionados ao índice com a fonte de dados personalizada.
O código a seguir demonstra a criação e o uso de uma fonte de dados personalizada. Ao usar uma fonte de dados personalizada no aplicativo, não é necessário criar uma nova fonte de dados (processo único) toda vez que o índice é sincronizado com a fonte de dados. Você usa o ID do índice e o ID da fonte de dados para sincronizar os dados.
```
package com.amazonaws.kendra;
import java.util.concurrent.TimeUnit;
import software.amazon.awssdk.services.kendra.KendraClient;
import csoftware.amazon.awssdk.services.kendra.model.BatchPutDocumentRequest;
import csoftware.amazon.awssdk.services.kendra.model.BatchPutDocumentResponse;
import software.amazon.awssdk.services.kendra.model.CreateDataSourceRequest;
import software.amazon.awssdk.services.kendra.model.CreateDataSourceResponse;
import software.amazon.awssdk.services.kendra.model.DataSourceType;
import software.amazon.awssdk.services.kendra.model.Document;
import software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest;
import software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse;
import software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobRequest;
import software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobResponse;
import software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobRequest;
import software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobResponse;
public class SampleSyncForCustomDataSource {
public static void main(String[] args) {
KendraClient kendra = KendraClient.builder().build();
String myIndexId = "yourIndexId";
String dataSourceName = "custom data source";
String dataSourceDescription = "Amazon Kendra custom data source connector"
// Create custom data source
CreateDataSourceRequest createDataSourceRequest = CreateDataSourceRequest
.builder()
.indexId(myIndexId)
.name(dataSourceName)
.description(dataSourceDescription)
.type(DataSourceType.CUSTOM)
.build();
CreateDataSourceResponse createDataSourceResponse = kendra.createDataSource(createDataSourceRequest);
System.out.println(String.format("Response of creating data source: %s", createDataSourceResponse));
// Get the data source ID from createDataSourceResponse
String dataSourceId = createDataSourceResponse.Id();
// Wait for the custom data source to become active
System.out.println(String.format("Waiting for Amazon Kendra to create the data source %s", dataSourceId));
// You can use the DescribeDataSource API to check the status
DescribeDataSourceRequest describeDataSourceRequest = DescribeDataSourceRequest
.builder()
.indexId(myIndexId)
.id(dataSourceId)
.build();
while (true) {
DescribeDataSourceResponse describeDataSourceResponse = kendra.describeDataSource(describeDataSourceRequest);
DataSourceStatus status = describeDataSourceResponse.status();
System.out.println(String.format("Creating data source. Status: %s", status));
if (status != DataSourceStatus.CREATING) {
break;
}
TimeUnit.SECONDS.sleep(60);
}
// Start syncing yor data source by calling StartDataSourceSyncJob and providing your index ID
// and your custom data source ID
System.out.println(String.format("Synchronize the data source %s", dataSourceId));
StartDataSourceSyncJobRequest startDataSourceSyncJobRequest = StartDataSourceSyncJobRequest
.builder()
.indexId(myIndexId)
.id(dataSourceId)
.build();
StartDataSourceSyncJobResponse startDataSourceSyncJobResponse = kendra.startDataSourceSyncJob(startDataSourceSyncJobRequest);
// Get the sync job execution ID from startDataSourceSyncJobResponse
String executionId = startDataSourceSyncJobResponse.ExecutionId();
System.out.println(String.format("Waiting for the data source to sync with the index %s for execution ID %s", indexId, startDataSourceSyncJobResponse.executionId()));
// Add 2 documents uploaded to S3 bucket to your index using the BatchPutDocument API
// The added documents should sync with your custom data source
Document pollyDoc = Document
.builder()
.s3Path(
S3Path.builder()
.bucket("amzn-s3-demo-bucket")
.key("what_is_Amazon_Polly.docx")
.build())
.title("What is Amazon Polly?")
.id("polly_doc_1")
.build();
Document rekognitionDoc = Document
.builder()
.s3Path(
S3Path.builder()
.bucket("amzn-s3-demo-bucket")
.key("what_is_amazon_rekognition.docx")
.build())
.title("What is Amazon rekognition?")
.id("rekognition_doc_1")
.build();
BatchPutDocumentRequest batchPutDocumentRequest = BatchPutDocumentRequest
.builder()
.indexId(myIndexId)
.documents(pollyDoc, rekognitionDoc)
.build();
BatchPutDocumentResponse result = kendra.batchPutDocument(batchPutDocumentRequest);
System.out.println(String.format("BatchPutDocument result: %s", result));
// Once custom data source synced, stop the sync job using the StopDataSourceSyncJob API
StopDataSourceSyncJobResponse stopDataSourceSyncJobResponse = kendra.stopDataSourceSyncJob(
StopDataSourceSyncJobRequest()
.indexId(myIndexId)
.id(dataSourceId)
);
// List your sync jobs
ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest = ListDataSourceSyncJobsRequest
.builder()
.indexId(myIndexId)
.id(dataSourceId)
.build();
while (true) {
ListDataSourceSyncJobsResponse listDataSourceSyncJobsResponse = kendra.listDataSourceSyncJobs(listDataSourceSyncJobsRequest);
DataSourceSyncJob job = listDataSourceSyncJobsResponse.history().get(0);
System.out.println(String.format("Status: %s", job.status()));
}
}
}
```
# Dropbox
O Dropbox é um serviço de hospedagem de arquivos que oferece armazenamento em nuvem, organização de documentos e serviços de modelagem de documentos. Se você for usuário do Dropbox, você pode usar Amazon Kendra para indexar seus arquivos do Dropbox, Dropbox Paper, modelos do Dropbox Paper e atalhos armazenados para páginas da web. Você também pode configurar Amazon Kendra para indexar arquivos específicos do Dropbox, Dropbox Paper, modelos do Dropbox Paper e atalhos armazenados em páginas da web.
Amazon Kendraé compatível com o Dropbox e o Dropbox Advanced para o Dropbox Business.
Você pode se conectar Amazon Kendra à sua fonte de dados do Dropbox usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados Amazon Kendra do Dropbox, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-dropbox)
+ [
## Pré-requisitos
](#prerequisites-dropbox)
+ [
## Instruções de conexão
](#data-source-procedure-dropbox)
+ [
## Saiba mais
](#dropbox-learn-more)
+ [
## Observações
](#dropbox-notes)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Dropbox é compatível com os seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Dropbox, faça essas alterações em seu Dropbox e AWS em suas contas.
**No Dropbox, verifique se você:**
+ Criou uma conta do Dropbox Advanced e configurou um usuário administrador.
+ Configurou uma aplicação do Dropbox com um **Nome de aplicação** exclusivo e ativou o **Acesso por escopo**. Consulte a [Documentação do Dropbox sobre a criação de um aplicativo](https://www.dropbox.com/developers/reference/getting-started#app%20console).
+ Ativou as permissões **completas do Dropbox** no console do Dropbox e adicionou as seguintes permissões:
+ files.content.read
+ files.metadata.read
+ sharing.read
+ file\$1requests.read
+ groups.read
+ team\$1info.read
+ team\$1data.content.read
+ Anote a chave do aplicativo do Dropbox, a senha do aplicativo do Dropbox e o token de acesso do Dropbox para credenciais básicas de autenticação.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Configurou e copiou um token de acesso temporário do Oauth 2.0 para a aplicação do Dropbox. Esse token é temporário e expira após 4 horas. Consulte a [documentação do Dropbox sobre OAuth autenticação](https://developers.dropbox.com/oauth-guide).
**nota**
É recomendável criar um token de acesso de atualização que nunca expire no Dropbox, em vez de confiar em um token de acesso único que expira após quatro horas. Um token de acesso de atualização é permanente e nunca expira, para que você possa continuar sincronizando a fonte de dados no futuro.
+ **Recomendado:** configurou um token de atualização permanente do Dropbox que nunca expira Amazon Kendra para permitir que você continue sincronizando sua fonte de dados sem interrupções. Consulte a [Documentação do Dropbox sobre tokens de atualização.](https://developers.dropbox.com/oauth-guide)
+ Verificou se cada documento é exclusivo no banco de dados e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Dropbox em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Dropbox a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Dropbox, você deve fornecer os detalhes necessários da sua fonte de dados do Dropbox para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Dropbox paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-dropbox).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Dropbox**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Dropbox** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Dropbox** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Tipo de token de autenticação**: escolha um token permanente (recomendado) ou um token de acesso temporário.
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Dropbox. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Dropbox' é adicionado automaticamente ao seu nome secreto.
1. Em **Chave da aplicação**, **Segredo da aplicação** e informações de token (permanentes ou temporários): insira os valores da credencial de autenticação configurados no Dropbox.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Selecionar entidades ou tipos de conteúdo**: selecione as entidades do Dropbox ou tipos de conteúdo dos quais você deseja fazer crawling.
1. Em **Configurações adicionais** para **Padrões Regex**: adicione os padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Arquivos**, **Dropbox Paper** e **modelos do Dropbox Paper** — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Dropbox**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-dropbox-schema) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `DROPBOX` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Modo de sincronização** — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Tipo de token de acesso**: especifique se você deseja usar um token de acesso permanente ou temporário para o segredo do AWS Secrets Manager, que armazena as credenciais de autenticação.
**nota**
É recomendável criar um token de acesso de atualização que nunca expire no Dropbox, em vez de confiar em um token de acesso único que expira após quatro horas. Crie um aplicativo e um token de acesso de atualização no console do desenvolvedor do Dropbox e forneça o token de acesso na senha.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Dropbox. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"appKey": "Dropbox app key",
"appSecret": "Dropbox app secret",
"accesstoken": "temporary access token or refresh access token"
}
```
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para ligar para o público necessário APIs para o conector do Dropbox e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para fontes de dados do Dropbox](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Tipos de documento/conteúdo**: especifique se deseja fazer crawling de arquivos em seus documentos do Dropbox, Dropbox Paper, em modelos do Dropbox Paper e em atalhos de páginas da web armazenados no Dropbox.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Dropbox para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Consulte uma lista de outras chaves JSON importantes a serem configuradas em [Esquema do modelo do Dropbox](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-dropbox-schema).
------
## Saiba mais
Para saber mais sobre a integração do Amazon Kendra com a fonte de dados do Box, consulte:
+ [Indexe o conteúdo do Dropbox usando o conector do Dropbox para o Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/index-your-dropbox-content-using-the-dropbox-connector-for-amazon-kendra/)
## Observações
+ Quando as Listas de Controle de Acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações da API do Dropbox. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# Drupal
**nota**
O conector do Drupal permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O Drupal é um sistema de gerenciamento de conteúdo de código aberto (CMS) que pode ser usado para criar sites e aplicativos da Web. Você pode usar Amazon Kendra para indexar o seguinte no Drupal:
+ Conteúdo: artigos, páginas básicas, blocos básicos, tipos de conteúdo definidos pelo usuário, tipos de blocos definidos pelo usuário, tipos de conteúdo personalizados e tipos de blocos personalizados
+ Comentário: para qualquer tipo de conteúdo e tipo de bloco
+ Anexos: para qualquer tipo de conteúdo e tipo de bloco
Você pode se conectar Amazon Kendra à sua fonte de dados do Drupal usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Drupal, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## Recursos compatíveis
](#supported-features-drupal)
+ [
## Pré-requisitos
](#prerequisites-drupal)
+ [
## Instruções de conexão
](#data-source-procedure-drupal)
+ [
## Observações
](#drupal-notes)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados Drupal oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Drupal, faça essas alterações no Drupal e nas contas. AWS
**No Drupal, verifique se você:**
+ Criou uma conta do Drupal (Standard) Suite e um usuário com função de administrador.
+ Copiou o nome do site do Drupal e configurou um URL de host. Por exemplo, .*https:///*
+ Credenciais básicas de autenticação configuradas contendo um nome de usuário (nome de usuário de login do site do Drupal) e senha (senha do site do Drupal).
+ **Recomendado:** configurou um token de credencial OAuth 2.0. Use esse token junto com a concessão de senha do Drupal, o ID do cliente, a senha do cliente, o nome de usuário (nome de usuário de login do site do Drupal) e senha (senha do site do Drupal) para se conectar ao Amazon Kendra.
+ As seguintes permissões foram adicionadas à sua conta do Drupal usando uma função de administrador:
+ administrar blocos
+ administrar blocos\$1exibição de conteúdo
+ administrar blocos\$1campos de conteúdo
+ administrar blocos\$1exibição de formulário de conteúdo
+ administrar visualizações
+ visualizar endereços de e-mail do usuário
+ ver conteúdo próprio não publicado
+ ver revisões da página
+ ver revisões do artigo
+ ver todas as revisões
+ ver o tema de administração
+ acessar conteúdo
+ visão geral do conteúdo do acesso
+ acessar comentários
+ pesquisar conteúdo
+ visão geral dos arquivos de acesso
+ acessar links contextuais
**nota**
Se houver tipos de conteúdo definidos pelo usuário, tipos de blocos definidos pelo usuário ou se quaisquer visualizações e blocos forem adicionados ao site do Drupal, eles deverão receber acesso de administrador.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Drupal em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Drupal a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Drupal, você deve fornecer detalhes de suas credenciais do Drupal para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Drupal para Amazon Kendra ver. [Pré-requisitos](#prerequisites-drupal)
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Drupal**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Drupal** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Drupal** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, para **URL do host**: o URL do host do site do Drupal. Por exemplo, .*https:///*
1. Para o **Local do certificado SSL**, insira o caminho para o certificado SSL armazenado em um bucket do Amazon S3.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. Para **autenticação** — escolha entre a **autenticação básica e a autenticação OAuth ** **2.0** com base no seu caso de uso.
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Drupal. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. Se você escolher a **Autenticação básica**, digite uma **senha**, o **Nome de usuário** (nome de usuário do site do Drupal) e a **Senha** (senha do site do Drupal) que você copiou e escolha **Salvar e adicionar senha**.
1. **Se você escolheu a **autenticação OAuth 2.0**, insira um **nome secreto, nome** de **usuário (nome** de usuário do site Drupal), **senha (senha** do site Drupal), **ID do cliente e segredo do cliente** **gerados em sua conta do** Drupal e escolha Salvar e adicionar segredo.**
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
**nota**
Ao escolher rastrear **Artigos**, **Páginas básicas** e **Blocos básicos**, os campos padrão serão sincronizados automaticamente. Você também pode optar por sincronizar comentários, anexos, campos personalizados e outras entidades personalizadas.
1. Para **Selecionar entidades**:
+ **Artigos**: escolha se deseja rastrear **Artigos**, seus comentários em **Comentários** e **Anexos**.
+ **Páginas básicas**: escolha se deseja rastrear as **Páginas básicas**, seus comentários em **Comentários** e **Anexos**.
+ **Blocos básicos**: escolha se deseja rastrear os **Blocos básicos**, seus comentários em **Comentários** e **Anexos**.
+ Também é possível adicionar **Tipos de conteúdo personalizados** e **Blocos personalizados**.
1. Para **Opções de configuração opcionais**:
+ Para o **padrão Regex**, adicione padrões de expressão regular para incluir ou excluir títulos de entidades e nomes de arquivos específicos. Você pode adicionar até 100 padrões.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **Conteúdo**, **Comentários** e **Anexos — Selecione entre os** campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Drupal**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-drupal-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `DRUPAL` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou na sua conta do Drupal.
Se você usar uma autenticação básica, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password"
}
```
Se você usa a autenticação OAuth 2.0, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
}
```
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Drupal e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para fontes de dados do Drupal](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão**: você pode especificar se deseja incluir conteúdo, comentários e anexos. Você também pode especificar padrões de expressão regular para incluir ou excluir conteúdos, comentários e anexos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Drupal para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Esquema de modelos do Drupal](ds-schemas.md#ds-drupal-schema).
------
## Observações
+ O Drupal não APIs tem limites oficiais de limitação.
+ Java não SDKs está disponível para o Drupal.
+ Os dados do Drupal só podem ser obtidos usando as APIs JSON nativas.
+ Os tipos de conteúdo não associados a nenhuma **visualização** do Drupal não podem ser rastreados.
+ Você precisa de acesso de administrador para rastrear dados do dos **Blocos** do Drupal.
+ Não há API JSON disponível para criar o tipo de conteúdo definido pelo usuário usando verbos HTTP.
+ O corpo do documento e os comentários para **Artigos**, **Páginas básicas**, **Blocos básicos**, tipo de conteúdo definido pelo usuário e tipo de bloco definido pelo usuário são exibidos no formato HTML. Se o conteúdo HTML não estiver bem formado, as tags relacionadas ao HTML aparecerão no corpo do documento e nos comentários e ficarão visíveis nos resultados da pesquisa do Amazon Kendra.
+ Os tipos de conteúdo e os tipos de **bloco** sem descrição ou corpo não serão Amazon Kendra incorporados. Somente **comentários** e **anexos** desses tipos de **conteúdo** ou **bloco** serão inseridos em seu índice. Amazon Kendra
# GitHub
GitHub é um serviço de hospedagem baseado na web para desenvolvimento de software que fornece serviços de armazenamento e gerenciamento de código com controle de versão. Você pode usar Amazon Kendra para indexar seus arquivos de repositório GitHub Enterprise Cloud (SaaS) e GitHub Enterprise Server (On Prem), solicitações de problemas e pull, comentários de problemas e pull requests e anexos de comentários de problemas e pull requests. Você também pode optar por incluir ou excluir determinados arquivos.
**nota**
Amazon Kendraagora suporta um GitHub conector atualizado.
O console do foi atualizado automaticamente para você. Quaisquer novos conectores criados no console usarão a arquitetura atualizada. Se usa a API, agora você deve passar a usar o objeto [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) em vez do `GitHubConfiguration` para configurar o conector.
Os conectores configurados usando o console antigo e a arquitetura de API continuam funcionando conforme configurados. No entanto, não é possível editá-los nem atualizá-los. Se você quer editar ou atualizar a configuração do conector, será necessário criar outro conector.
Recomendamos migrar o fluxo de trabalho do conector para a versão atualizada. O suporte para conectores configurados usando a arquitetura mais antiga está programado para terminar em junho de 2024.
Você pode se conectar Amazon Kendra à sua fonte de GitHub dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra GitHub dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-github)
+ [
## Pré-requisitos
](#prerequisites-github)
+ [
## Instruções de conexão
](#data-source-procedure-github)
+ [
## Saiba mais
](#github-learn-more)
## Recursos compatíveis
Amazon KendraGitHub o conector de fonte de dados oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de GitHub dados, faça essas alterações em suas GitHub AWS contas.
**Em GitHub, verifique se você tem:**
+ Criou um GitHub usuário com permissões administrativas para a GitHub organização.
+ Configurou um token de acesso pessoal no GitHub para usar como credenciais de autenticação. Consulte a [documentação do GitHub sobre como criar um token de acesso pessoal](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Recomendado:** configurou um OAuth token para credenciais de autenticação. Use o OAuth token para melhorar os limites de aceleração da API e o desempenho do conector. Veja [GitHub a documentação sobre OAuth autorização](https://docs.github.com/en/rest/apps/oauth-applications?apiVersion=2022-11-28#about-oauth-apps-and-oauth-authorizations-of-github-apps).
+ Anote o URL do GitHub host para o tipo de GitHub serviço que você usa. Por exemplo, a URL do host para a GitHub nuvem pode ser *https://api.github.com* e a URL do host para o GitHub servidor pode ser*https://on-prem-host-url/api/v3/*.
+ Anote o nome da sua organização para GitHub a conta do GitHub Enterprise Cloud (SaaS) ou da conta do GitHub Enterprise Server (local) à qual você deseja se conectar. Você pode encontrar o nome da sua organização fazendo login no GitHub desktop e selecionando **Suas organizações** na lista suspensa da foto do perfil.
+ **Opcional (somente servidor):** gerou um certificado SSL e copiou o caminho para o certificado armazenado em um Amazon S3 bucket. Você usa isso para GitHub se conectar se precisar de uma conexão SSL segura. Você pode simplesmente gerar um certificado autoassinado X509 em qualquer computador usando o OpenSSL. Para ver um exemplo de uso do OpenSSL para criar um certificado X509, consulte [Criar e assinar um certificado X509](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
+ Adicionou as seguintes permissões:
**Para nuvem GitHub corporativa (SaaS)**
+ `repo:status`— Concede read/write acesso aos status de confirmação em repositórios públicos e privados. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de confirmação do repositório privado sem conceder acesso ao código.
+ `repo_deployment`: concede acesso aos status de implantação de repositórios públicos e privados. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de implantação sem conceder acesso ao código.
+ `public_repo`: limita o acesso aos repositórios públicos. Isso inclui read/write acesso ao código, status de confirmação, projetos de repositório, colaboradores e status de implantação para repositórios e organizações públicas. Também é necessário para marcar repositórios públicos como favoritos.
+ `repo:invite`— Concede accept/decline habilidades para convites para colaborar em um repositório. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso a convites sem conceder acesso ao código.
+ `security_events`: concede acesso de leitura e gravação a eventos de segurança na API de verificação de código. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso a eventos de segurança sem conceder acesso ao código.
+ `read:org`: acesso somente leitura para associação da organização, projetos da organização e associação da equipe.
+ `user:email`: concede acesso de leitura aos endereços de e-mail de um usuário. Exigido pela Amazon Kendra para rastrear. ACLs
+ `user:follow`: concede acesso para seguir ou deixar de seguir outros usuários. Exigido pela Amazon Kendra para rastrear. ACLs
+ `read:user`: concede acesso para ler os dados do perfil de um usuário. Exigido pela Amazon Kendra para rastrear. ACLs
+ `workflow`: concede a capacidade de adicionar e atualizar arquivos de fluxo de trabalho do GitHub Actions. Arquivos de fluxo de trabalho podem ser confirmados sem esse escopo se o mesmo arquivo (com o mesmo caminho e conteúdo) existir em outra ramificação no mesmo repositório.
Para obter mais informações, consulte [Escopos para OAuth aplicativos](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) no GitHub Docs.
**Para servidor GitHub corporativo (no local)**
+ `repo:status`— Concede read/write acesso aos status de confirmação em repositórios públicos e privados. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de confirmação do repositório privado sem conceder acesso ao código.
+ `repo_deployment`: concede acesso aos status de implantação de repositórios públicos e privados. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de implantação sem conceder acesso ao código.
+ `public_repo`: limita o acesso aos repositórios públicos. Isso inclui read/write acesso ao código, status de confirmação, projetos de repositório, colaboradores e status de implantação para repositórios e organizações públicas. Também é necessário para marcar repositórios públicos como favoritos.
+ `repo:invite`— Concede accept/decline habilidades para convites para colaborar em um repositório. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso a convites sem conceder acesso ao código.
+ `security_events`: concede acesso de leitura e gravação a eventos de segurança na API de verificação de código. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso a eventos de segurança sem conceder acesso ao código.
+ `read:user`: concede acesso para ler os dados do perfil de um usuário. Exigido pelo Amazon Q Business para rastrear ACLs.
+ `user:email`: concede acesso de leitura aos endereços de e-mail de um usuário. Exigido pelo Amazon Q Business para rastrear ACLs.
+ `user:follow`: concede acesso para seguir ou deixar de seguir outros usuários. Exigido pelo Amazon Q Business para rastrear ACLs.
+ `site_admin`— Concede aos administradores do site acesso aos endpoints da API GitHub Enterprise Server Administration.
+ `workflow`: concede a capacidade de adicionar e atualizar arquivos de fluxo de trabalho do GitHub Actions. Arquivos de fluxo de trabalho podem ser confirmados sem esse escopo se o mesmo arquivo (com o mesmo caminho e conteúdo) existir em outra ramificação no mesmo repositório.
Para obter mais informações, consulte [Escopos para OAuth aplicativos](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) no GitHub Documentos e [Entendendo os escopos para OAuth aplicativos](https://developer.github.com/enterprise/2.16/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) no Developer. GitHub
+ Verifique se cada documento é exclusivo em GitHub e entre outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de GitHub autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de GitHub dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de GitHub dados, você deve fornecer os detalhes necessários da sua fonte de GitHub dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou GitHub paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-github).
------
#### [ Console ]
**Para se conectar Amazon Kendra a GitHub**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do GitHub ** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do GitHub ** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **GitHubfonte** — Escolha entre **GitHub Enterprise Cloud** e **GitHubEnterprise Server**.
1. **GitHub URL do host** — Por exemplo, o URL do host para a GitHub nuvem pode ser *https://api.github.com* e o URL do host GitHub do servidor pode ser*https://on-prem-host-url/api/v3/*.
1. **GitHub nome da organização** — Insira o nome GitHub da sua organização. Você pode encontrar as informações da sua organização em sua GitHub conta.
**nota**
GitHub O conector suporta o rastreamento de uma única organização por instância do conector da fonte de dados.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de GitHub autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- GitHub -' é adicionado automaticamente ao seu nome secreto.
1. Para **GitHubtoken** — Insira o valor da credencial de autenticação configurado em. GitHub
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Selecionar repositórios**: escolha fazer crawling de todos os repositórios ou dos selecionados.
Se você optar por fazer crawling de repositórios selecionados, adicione os nomes dos repositórios e, opcionalmente, o nome de qualquer ramificação específica.
1. **Tipos de conteúdo**: escolha os tipos de conteúdo do qual você deseja fazer crawling de arquivos, problemas, solicitações pull e muito mais.
1. **Padrões Regex**: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a GitHub**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-github-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `GITHUB` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **GitHubtipo** — Especifique o tipo como `SAAS` ou`ON_PREMISE`.
+ **URL do host** — especifique o URL do GitHub host ou o URL do endpoint da API. Por exemplo, se você usa GitHub SaaS/Enterprise Cloud, o URL do host pode ser e`https://api.github.com`, para o servidor GitHub local/corporativo, o URL do host pode ser. `https://on-prem-host-url/api/v3/`
+ **Nome da organização** — Especifique o nome da organização da GitHub conta. Você pode encontrar o nome da sua organização fazendo login no GitHub desktop e selecionando **Suas organizações** na lista suspensa da foto do perfil.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta. GitHub A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"personalToken": "token"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o GitHub conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do GitHub ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
**nota**
Se você usa GitHub servidor, você deve usar um Amazon VPC para se conectar ao seu GitHub servidor.
+ **Filtro de repositório**: filtra repositórios por seus nomes e nomes de ramificações.
+ **Tipos de documento/conteúdo**: especifique se deseja fazer crawling de documentos do repositório, problemas, comentários de problemas, anexos de comentários de problemas, solicitações pull, comentários de solicitações pull e anexos de comentários de solicitações pull.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir certos arquivos e pastas.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
+ **Mapeamentos de campo — Escolha mapear** os campos da fonte de GitHub dados para os Amazon Kendra campos de índice. É possível incluir campos de documentos, confirmações, problemas, anexos de problemas, comentários de problemas, solicitações pull, anexos de solicitações pull e comentários de solicitações pull. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
É obrigatório definir o campo de corpo do documento ou equivalente para que o Amazon Kendra possa pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do GitHub](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-github-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte GitHub de dados, consulte:
+ [Reinvente a pesquisa em GitHub repositórios com a potência do conector Amazon Kendra GitHub ](https://aws.amazon.com/blogs/machine-learning/reimagine-search-on-github-repositories-with-the-power-of-the-amazon-kendra-github-connector/)
# Gmail
O Gmail é um cliente de e-mail desenvolvido pelo Google em que você pode enviar mensagens de e-mail com anexos de arquivos. As mensagens do Gmail podem ser classificadas e armazenadas na caixa de entrada do e-mail usando pastas e marcadores. Você pode usar Amazon Kendra para indexar suas mensagens de e-mail e anexos de mensagens. Você também pode configurar Amazon Kendra para incluir ou excluir mensagens de e-mail, anexos de mensagens e rótulos específicos para indexação.
Você pode se conectar Amazon Kendra à sua fonte de dados do Gmail usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Gmail, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-gmail)
+ [
## Pré-requisitos
](#prerequisites-gmail)
+ [
## Instruções de conexão
](#data-source-procedure-gmail)
+ [
## Saiba mais
](#gmail-learn-more)
+ [
## Observações
](#gmail-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Gmail, faça essas alterações no Gmail e AWS nas contas.
**No Gmail, verifique se você:**
+ Criou uma conta de administrador do Google Cloud Platform e um projeto do Google Cloud.
+ Ativou a API do Gmail e a API do SDK Admin na conta de administrador.
+ Criou uma conta de serviço e baixou uma chave privada JSON para o Gmail. Para obter informações sobre como criar e acessar a chave privada, consulte a documentação do Google Cloud sobre como [criar uma chave de conta de serviço](https://cloud.google.com/iam/docs/keys-create-delete#creating) e as [credenciais da conta de serviço](https://cloud.google.com/iam/docs/service-account-creds#key-types).
+ Copiou o e-mail da conta de administrador, o e-mail da conta de serviço e a chave privada para usar como credenciais de autenticação.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Foram adicionados os seguintes escopos do Oauth (usando uma função de administrador) para o usuário e os diretórios compartilhados que você deseja indexar:
+ https://www.googleapis.com/auth/admin.directory.user.readonly
+ https://www.googleapis.com/auth/gmail.somente leitura
+ Verifique se cada documento é exclusivo no Gmail e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Gmail em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Gmail a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Gmail, você deve fornecer detalhes das suas credenciais do Gmail para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Gmail paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-gmail).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Gmail**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Gmail** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Gmail** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. Em **Autenticação** por **AWSSecrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Gmail. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha.
1. **E-mail do** cliente: o e-mail do cliente copiado da conta de serviço do Google.
1. **E-mail da conta do administrador**: o e-mail da conta do administrador que você gostaria de usar.
1. **Chave privada**: a chave privada que você copiou da conta de serviço do Google.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Tipos de entidade**: escolha sincronizar anexos de mensagens.
1. (Opcional) Em **Configurações adicionais**, insira as seguintes informações:
1. **Intervalo de datas**: insira um intervalo de datas para especificar a data de início e de término dos e-mails dos quais você deseja fazer crawling.
1. **Domínios de e-mail**: inclua ou exclua certos e-mails com base nos domínios de e-mail “para”, “de”, “cc” e “cco”.
1. **Palavras-chave nos assuntos**: inclua ou exclua e-mails com base nas palavras-chave nos assuntos de e-mail.
**nota**
Você também pode optar por incluir qualquer documento que corresponda a todas as palavras-chave do assunto inseridas
1. **Rótulos**: adicione padrões de expressão regular para incluir ou excluir certos rótulos de e-mail.
1. **Anexos**: adicione padrões de expressão regular para incluir ou excluir certos anexos de e-mail.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
**Importante**
Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, uma sincronização de conteúdo novo, modificado ou excluído:
Não remove mensagens que foram excluídas permanentemente do Gmail do índice do Amazon Kendra
Não sincroniza alterações nos rótulos de e-mail do Gmail
Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com o índice do Amazon Kendra, execute rastreamentos completos periodicamente.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
**nota**
Amazon KendraO conector de fonte de dados do Gmail não é compatível com a criação de campos de índice personalizados devido às limitações da API.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Gmail**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-gmail-schema) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `GMAIL` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
**Importante**
Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, uma sincronização de conteúdo novo, modificado ou excluído:
Não remove mensagens que foram excluídas permanentemente do Gmail do índice do Amazon Kendra
Não sincroniza alterações nos rótulos de e-mail do Gmail
Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com seu Amazon Kendra índice, você deve executar rastreamentos completos periodicamente.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Gmail. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"adminAccountEmailId": "service account email",
"clientEmailId": "user account email",
"privateKey": "private key"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para ligar para o público necessário APIs para o conector do Gmail e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para fontes de dados do Gmail](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados e-mails de “de”, “para”, “cc” e “cco”.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Gmail para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
**nota**
Amazon KendraO conector de fonte de dados do Gmail não é compatível com a criação de campos de índice personalizados devido às limitações da API.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Gmail](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-gmail-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Gmail, consulte:
+ [Faça pesquisas inteligentes em e-mails no seu espaço de trabalho do Google usando o conector do Gmail para o Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/perform-intelligent-search-across-emails-in-your-google-workspace-using-the-gmail-connector-for-amazon-kendra/).
## Observações
+ Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, uma `FULL_CRAWL`/**Sincronização de conteúdo novo, modificado ou excluído**:
+ Não removerá mensagens que foram excluídas permanentemente do Gmail do seu índice Amazon Kendra
+ Não sincroniza alterações nos rótulos de e-mail do Gmail
Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com seu Amazon Kendra índice, você deve executar rastreamentos completos periodicamente.
+ Amazon KendraO conector de fonte de dados do Gmail não é compatível com a criação de campos de índice personalizados devido às limitações da API.
# Google Drive
O Google Drive é um serviço de armazenamento de arquivos baseado em nuvem. Você pode usar o Amazon Kendra para indexar documentos armazenados nos drives compartilhados, Meus Drives e Compartilhado comigo na fonte de dados do Google Drive. Você pode indexar os documentos do Google Workspace e os documentos listados em [Tipos de documentação](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html). Você também pode usar filtros de inclusão e exclusão para indexar o conteúdo por nome, tipo e caminho do arquivo.
Você pode se conectar Amazon Kendra à sua fonte de dados do Google Drive usando o [Amazon Kendra console](https://console.aws.amazon.com/kendra/), a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API ou a [GoogleDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GoogleDriveConfiguration.html)API.
Amazon Kendra tem duas versões do conector do Google Drive. Os recursos suportados de cada versão incluem:
**Conector do Google Drive V1.0/API [GoogleDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GoogleDriveConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
**Conector do Google Drive V2.0/API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
**nota**
O conector do Google Drive V1.0 DriveConfiguration /API do Google terminou em 2023. Recomendamos migrar ou usar o conector V2.0 TemplateConfiguration /API do Google Drive.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Google Drive, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
# Conector Google Drive V1.0
](data-source-v1-google-drive.md)
+ [
# Conector Google Drive V2.0
](data-source-v2-google-drive.md)
# Conector Google Drive V1.0
O Google Drive é um serviço de armazenamento de arquivos baseado em nuvem. Você pode usar Amazon Kendra para indexar documentos e comentários armazenados nas pastas Drives compartilhados, Meus Drives e Compartilhado comigo na sua fonte de dados do Google Drive. Você pode indexar os documentos do Google Workspace e os documentos listados em [Tipos de documentação](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html). Você também pode usar filtros de inclusão e exclusão para indexar o conteúdo por nome, tipo e caminho do arquivo.
**nota**
O conector do Google Drive V1.0 DriveConfiguration /API do Google terminou em 2023. Recomendamos migrar ou usar o conector V2.0 TemplateConfiguration /API do Google Drive.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Google Drive, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-google-drive)
+ [
## Pré-requisitos
](#prerequisites-v1-google-drive)
+ [
## Instruções de conexão
](#data-source-v1-procedure-google-drive)
+ [
## Saiba mais
](#google-drive-learn-more)
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
## Pré-requisitos
Antes de usar Amazon Kendra para indexar sua fonte de dados do Google Drive, faça essas alterações no Google Drive e AWS nas contas.
**No Google Drive, verifique se você:**
+ **Recebeu** acesso para uma função de superadministrador **ou** é um usuário com privilégios administrativos. Você não precisa de uma função de superadministrador para você se tiver recebido acesso de uma função de superadministrador.
+ Criou uma conta de serviço com a opção **Ativar a delegação em todo o domínio do G Suite** ativada e uma chave JSON como chave privada usando a conta.
+ Copiou o e-mail da conta de usuário e o e-mail da conta de serviço. Ao se conectar, Amazon Kendra você insere o e-mail da sua conta de usuário como e-mail da conta de administrador e o e-mail da sua conta de serviço como e-mail do cliente em seu AWS Secrets Manager segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ A API Admin SDK e a API do Google Drive foram adicionadas à sua conta.
+ Adicionou (ou solicitou que um usuário com uma função de superadministrador adicionasse) as seguintes permissões à conta de serviço usando uma função de superadministrador:
+ https://www.googleapis.com/auth/drive.somente leitura
+ https://www.googleapis.com/auth/drive.metadata.somente leitura
+ https://www.googleapis.com/auth/admin.directory.user.readonly
+ https://www.googleapis.com/auth/admin.directory.group.somente leitura
+ Verificou se cada documento é exclusivo no Google Drive e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Google Drive em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Google Drive Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Google Drive, você deve fornecer os detalhes necessários da sua fonte de dados do Google Drive para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Google Drive para Amazon Kendra ver[Pré-requisitos](#prerequisites-v1-google-drive).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Google Drive**
1. Faça login no AWS Management Console e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Google Drive V1.0** e, em seguida, escolha **Adicionar conector**.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Para **Tipo de autenticação**: escolha entre **Existente** e **Novo**. Se você optar por usar um segredo existente, use **Selecionar senha** para escolher a senha.
1. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager **:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Google Drive-' é adicionado automaticamente ao seu nome secreto.
1. Para o **e-mail da conta de administrador**, o **e-mail do cliente** e a **chave privada**, insira os valores da credencial de autenticação que você gerou e baixou da conta do Google Drive.
1. Escolha **Salvar autenticação**.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Excluir contas de usuário**: os usuários do Google Drive que você deseja excluir do índice. Você pode adicionar até 100 contas de usuário.
1. **Excluir drives compartilhados**: os drives compartilhados do Google Drive que você deseja excluir do índice. Você pode adicionar até 100 drives compartilhados.
1. **Excluir drives de tipos de arquivos**: os drives compartilhados do Google Drive que você deseja excluir do índice. Você também pode optar por editar as seleções do tipo MIME.
1. **Configurações adicionais**: especifique padrões de expressão regular para incluir ou excluir determinado conteúdo. Você pode adicionar até 100 padrões.
1. **Frequência**: escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **nome do GoogleDrive campo** e **mapeamentos adicionais de campo sugeridos — Selecione entre os** campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Google Drive**
Você deve especificar o seguinte usando a [GoogleDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GoogleDriveConfiguration.html)API:
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Google Drive. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"clientAccount": "service account email",
"adminAccount": "user account email"",
"privateKey": "private key"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para ligar para o público necessário APIs para o conector do Google Drive e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para fontes de dados do Google Drive](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Filtros de inclusão e exclusão**, por padrão, o Amazon Kendra indexa todos os documentos no Google Drive. Você pode especificar se deseja incluir ou excluir determinados conteúdos em drives compartilhados, contas de usuário, tipos MIME de documentos e arquivos. Se você optar por excluir contas de usuário, nenhum dos arquivos no My Drive pertencentes à conta será indexado. Os arquivos compartilhados com o usuário são indexados, a menos que o proprietário do arquivo também seja excluído.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Google Drive para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Google Drive, consulte:
+ [Introdução ao conector do Amazon Kendra Google Drive](https://aws.amazon.com/blogs/machine-learning/getting-started-with-the-amazon-kendra-google-drive-connector/)
# Conector Google Drive V2.0
O Google Drive é um serviço de armazenamento de arquivos baseado em nuvem. Você pode usar Amazon Kendra para indexar documentos e comentários armazenados nas pastas Drives compartilhados, Meus Drives e Compartilhado comigo na sua fonte de dados do Google Drive. Você pode indexar os documentos do Google Workspace e os documentos listados em [Tipos de documentação](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html). Você também pode usar filtros de inclusão e exclusão para indexar o conteúdo por nome, tipo e caminho do arquivo.
**nota**
O conector do Google Drive V1.0 DriveConfiguration /API do Google terminou em 2023. Recomendamos migrar ou usar o conector V2.0 TemplateConfiguration /API do Google Drive.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Google Drive, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-google-drive)
+ [
## Pré-requisitos
](#prerequisites-v2-google-drive)
+ [
## Instruções de conexão
](#data-source-procedure-v2-google-drive)
+ [
## Observações
](#google-drive-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de usar Amazon Kendra para indexar sua fonte de dados do Google Drive, faça essas alterações no Google Drive e AWS nas contas.
**No Google Drive, verifique se você:**
+ **Recebeu** acesso para uma função de superadministrador **ou** é um usuário com privilégios administrativos. Você não precisa de uma função de superadministrador para você se tiver recebido acesso de uma função de superadministrador.
+ Credenciais de conexão da conta de serviço do Google Drive configuradas contendo o e-mail da conta de administrador, e-mail do cliente (e-mail da conta de serviço) e chave privada. Consulte a [documentação do Google Cloud sobre como criar e excluir chaves de contas de serviço](https://cloud.google.com/iam/docs/keys-create-delete).
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Criou uma conta de serviço do Google Cloud (uma conta com autoridade delegada para assumir a identidade do usuário) com a **ativação da Delegação em todo o domínio do G Suite** para server-to-server autenticação e, em seguida, gerou uma chave privada JSON usando a conta.
**nota**
A chave privada deve ser gerada após a criação da conta de serviço.
+ A API Admin SDK e a API do Google Drive foram adicionadas à sua conta de usuário.
+ **Opcional:** Credenciais de conexão do Google Drive OAuth 2.0 configuradas contendo ID do cliente, segredo do cliente e token de atualização como credenciais de conexão para um usuário específico. Você precisa disso para rastrear dados de contas individuais. Consulte a [documentação do Google sobre o uso da OAuth versão 2.0 para acessar APIs](https://developers.google.com/identity/protocols/oauth2).
+ Adicionou (ou solicitou que um usuário com uma função de superadministrador adicionasse) os seguintes OAuth escopos à sua conta de serviço usando uma função de superadministrador. Esses escopos de API são necessários para rastrear todos os documentos e as informações de controle de acesso (ACL) de todos os usuários em um domínio do Google Workspace:
+ https://www.googleapis.com/auth/drive.readonly — visualize e baixe todos os seus arquivos do Google Drive
+ https://www.googleapis.com/auth/drive.metadata.readonly — Visualize metadados para arquivos no seu Google Drive
+ https://www.googleapis.com/auth/admin.directory.group.readonly — Escopo para recuperar somente informações sobre grupos, alias de grupos e membros. Isso é necessário para o Amazon Kendra Identity Crawler.
+ https://www.googleapis.com/auth/admin.directory.user.readonly — Escopo para recuperar somente usuários ou aliases de usuários. Isso é necessário para listar usuários no Amazon Kendra Identity Crawler e para configurar. ACLs
+ https://www.googleapis.com/auth/Plataforma em nuvem — escopo para gerar token de acesso para buscar conteúdo de arquivos grandes do Google Drive.
+ https://www.googleapis.com/auth/forms.body.readonly — Escopo para buscar dados do Formulários Google.
**Para oferecer suporte à API de formulários, adicione o seguinte escopo adicional:**
+ https://www.googleapis.com/auth/forms.body.readonly
+ Verificou se cada documento é exclusivo no Google Drive e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Google Drive em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Google Drive Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Google Drive, você deve fornecer os detalhes necessários da sua fonte de dados do Google Drive para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Google Drive para Amazon Kendra ver[Pré-requisitos](#prerequisites-v2-google-drive).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Google Drive**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Google Drive** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Google Drive** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. Para **autenticação** — escolha entre a **conta de serviço do Google** e a **autenticação OAuth 2.0** com base no seu caso de uso.
1. **AWS Secrets Manager segredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Google Drive. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Se você escolheu a **conta de serviço do Google**, insira um nome para o segredo, o ID de e-mail do usuário administrador ou “Usuário da conta de serviço” na configuração da conta de serviço (e-mail de administrador), o ID de e-mail da conta do serviço (e-mail cliente) e a chave privada que você criou na conta de serviço.
Salve e adicione o segredo
1. Se você escolheu a **autenticação OAuth 2.0**, insira um nome para seu segredo, ID do cliente, segredo do cliente e token de atualização que você criou em sua OAuth conta. O ID de e-mail do usuário (usuário cujos detalhes de conexão estão configurados) será definido como ACL. O conector não define outras informações user/group principais como ACL devido às limitações da API.
Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. (Somente para usuários de autenticação da conta de serviço do Google)
**Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Sincronizar conteúdo**: defina quais opções ou o conteúdo do qual você deseja fazer crawling. Você pode optar por fazer crawling de Meu Drive (pastas pessoais), de Compartilhados comigo (pastas compartilhadas com você) ou de ambos. Você também pode incluir comentários do arquivo.
1. Em **Configuração adicional: opcional** também é possível inserir as seguintes informações opcionais:
1. **Tamanho máximo do arquivo** — Defina o limite máximo de tamanho MBs dos arquivos a serem rastreados.
1. **E-mail de usuário**: adicione os e-mails do usuário que você deseja incluir ou excluir.
1. **Compartilhados comigo** adicione os nomes dos drives compartilhados que você deseja incluir ou excluir.
1. **Tipos de MIME**: adicione os tipos de MIME que você deseja incluir ou excluir.
1. **Padrões de regex de entidade**: adicione padrões de expressão regular para incluir ou excluir determinados anexos de todas as entidades compatíveis. Você pode adicionar até 100 padrões.
Você pode configurar padrões de include/exclude regex para **Nome do arquivo**, **Tipo de arquivo** e **Caminho do arquivo**.
+ **Nome do arquivo**: o nome do arquivo a incluir ou excluir. Por exemplo, para indexar um arquivo com nome `teamroster.txt`, forneça `teamroster`.
+ **Tipo de arquivo**: o tipo de arquivo a incluir ou excluir. Por exemplo, .pdf, .txt ou .docx.
+ **Caminho do arquivo**: o caminho do arquivo a incluir ou excluir. Por exemplo, para indexar arquivos somente dentro da pasta `Products list` de um drive, forneça `/Products list`.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
**Importante**
A API do Google Drive não é compatível com a recuperação de comentários de um arquivo excluído permanentemente. Os comentários dos arquivos descartados podem ser recuperados. Quando um arquivo é descartado, o conector exclui os comentários do Amazon Kendra índice.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Em **Histórico de execução da sincronização**, escolha armazenar relatórios gerados automaticamente em um Amazon S3 ao sincronizar sua fonte de dados. Isso é útil para rastrear problemas ao sincronizar a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **arquivos** — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
**nota**
A API do Google Drive não é compatível com a criação de campos personalizados. O mapeamento de campo personalizado não está disponível para o conector do Google Drive.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Google Drive**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `GOOGLEDRIVEV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de autenticação** — especifique se deseja usar a autenticação da conta de serviço ou a autenticação OAuth 2.0.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL`para indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG`para indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
**Importante**
A API do Google Drive não é compatível com a recuperação de comentários de um arquivo excluído permanentemente. Os comentários dos arquivos descartados podem ser recuperados. Quando um arquivo é descartado, o conector exclui os comentários do Amazon Kendra índice.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação que você criou na sua conta do Google Drive. Se você usar uma autenticação da conta de serviço do Google, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"clientEmail": "user account email",
"adminAccountEmail": "service account email",
"privateKey": "private key"
}
```
Se você usa a autenticação OAuth 2.0, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"clientID": "OAuth client ID",
"clientSecret": "client secret",
"refreshToken": "refresh token"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para ligar para o público necessário APIs para o conector do Google Drive e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para fontes de dados do Google Drive](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Meus drives, drives compartilhados, comentários**: você pode especificar se deseja fazer crawling desses tipos de conteúdo.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas contas de usuários, drives compartilhados e tipos de MIME.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Google Drive para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Google Drive](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-google-drive-schema).
------
## Observações
+ O mapeamento de campo personalizado não está disponível para o conector do Google Drive, pois a interface do usuário do Google Drive não é compatível com a criação de campos personalizados.
+ A API do Google Drive não é compatível com a recuperação de comentários de um arquivo excluído permanentemente. Os comentários dos arquivos na lixeira podem ser recuperados. Quando um arquivo é descartado, o Amazon Kendra conector exclui os comentários do Amazon Kendra índice.
+ A API do Google Drive não retorna comentários presentes em um arquivo.docx.
+ Se a permissão para determinado Google document (documento, planilha, slide etc.) estiver definida como **Acesso geral: qualquer pessoa com o link** ou **Compartilhado com o domínio específico da sua empresa**, o documento não ficará visível para os usuários de pesquisa do Amazon Kendra até que o usuário que fez a consulta tenha acessado o documento.
# IBM DB2
**nota**
O conector do IBM DB2 permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Em relação a futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O IBM DB2 é um sistema de gerenciamento de banco de dados relacional desenvolvido pelo IBM. Se você for um usuário do IBM DB2, poderá usar o Amazon Kendra para indexar a fonte de dados do IBM DB2. O conector da fonte de Amazon Kendra IBM DB2 dados é compatível com DB2 11.5.7.
Você pode se conectar Amazon Kendra à sua fonte de IBM DB2 dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra IBM DB2 dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-ibm-db2)
+ [
## Pré-requisitos
](#prerequisites-ibm-db2)
+ [
## Instruções de conexão
](#data-source-procedure-ibm-db2)
+ [
## Observações
](#ibm-db2-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de IBM DB2 dados, faça essas alterações em suas IBM DB2 AWS contas.
**Em IBM DB2, verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em IBM DB2 e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de IBM DB2 em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de IBM DB2 dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de IBM DB2 dados, você deve fornecer detalhes de suas IBM DB2 credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou IBM DB2 para Amazon Kendra ver[Pré-requisitos](#prerequisites-ibm-db2).
------
#### [ Console ]
**Para se conectar Amazon Kendra a IBM DB2**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do IBM DB2** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do IBM DB2** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de IBM DB2 autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- IBM DB2 -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna do usuário** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a IBM DB2**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `db2`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. IBM DB2 A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o IBM DB2 conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do IBM DB2](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do IBM DB2 para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Esquema DB2 de modelo IBM](ds-schemas.md#ds-ibm-db2-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Jira
O Jira é uma ferramenta de gerenciamento de projetos para desenvolvimento de software, gerenciamento de produtos e rastreamento de bugs. Você pode usar Amazon Kendra para indexar seus projetos, problemas, comentários, anexos, registros de trabalho e status do Jira.
Amazon Kendraatualmente só é compatível com o Jira Cloud.
Você pode se conectar Amazon Kendra à sua fonte de dados do Jira usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [JiraConfiguration ](https://docs.aws.amazon.com/kendra/latest/APIReference/API_JiraConfiguration.html)API. Para obter uma lista de recursos compatíveis por cada um, consulte [Recursos compatíveis](#supported-features-jira).
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Jira, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-jira)
+ [
## Pré-requisitos
](#prerequisites-jira)
+ [
## Instruções de conexão
](#data-source-procedure-jira)
+ [
## Saiba mais
](#jira-learn-more)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Jira é compatível com os seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Jira, faça essas alterações no Jira e AWS nas contas.
**No Jira, verifique se você:**
+ Configurou credenciais de autenticação com token da API que incluem um ID do Jira (nome de usuário ou e-mail) e uma credencial do Jira (token de API do Jira). Consulte a [documentação da Atlassian sobre o gerenciamento de tokens de API](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Anotou o URL da conta do Jira nas configurações da sua conta do Jira. Por exemplo, .*https://company.atlassian.net/*
+ Verifique se cada documento é exclusivo no Jira e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Jira em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Jira a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Jira, você deve fornecer os detalhes necessários da sua fonte de dados do Jira para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Jira paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-jira).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Jira**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Jira** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Jira** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **URL da conta do Jira**: insira o URL da sua conta do Jira. Por exemplo: *https://company.atlassian.net/*.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Jira. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Jira-' é adicionado automaticamente ao seu nome secreto.
1. Para **Jira ID**: insira o nome de usuário ou e-mail do Jira.
1. Em **Senha/token**: insira o token da API do Jira configurado no Jira.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Selecionar quais projetos do Jira indexar**: escolha entre fazer crawling de todos os projetos ou apenas de projetos específicos.
1. **Configuração adicional**: especifique determinados status e tipos de problemas. Opte por fazer crawling de comentários, anexos e logs de trabalho. Use padrões de expressão regular para incluir ou excluir determinados conteúdos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Jira**
Você deve especificar o seguinte usando a [JiraConfiguration ](https://docs.aws.amazon.com/kendra/latest/APIReference/API_JiraConfiguration.html)API:
+ **URL da fonte de dados**: especifique o URL da conta do Jira. Por exemplo, .*company.atlassian.net*
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Jira. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"jiraId": "Jira user name or email",
"jiraCredential": "Jira API token"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Jira e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para a fontes de dados do Jira](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique `VpcConfiguration` como parte da configuração da fonte de dados. Consulte [Configuração do Amazon Kendra para usar uma VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
+ **Log de alterações**: se o Amazon Kendra deve usar o mecanismo de log de alterações da fonte de dados do Jira para determinar se um documento deve ser atualizado no índice.
**nota**
Use o log de alterações se o Amazon Kendra não quiser digitalizar todos os documentos. Se o registro de alterações for grande, talvez leve Amazon Kendra menos tempo para digitalizar os documentos na fonte de dados do Jira do que para processar o registro de alterações. Se estiver sincronizando a fonte de dados do Jira com o índice pela primeira vez, todos os documentos serão digitalizados.
+ **Filtros de inclusão e exclusão**: é possível especificar se deseja incluir ou excluir determinadas arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Comentários, anexos e logs de trabalho**: é possível especificar se deseja fazer crawling de determinados comentários, anexos e logs de trabalho de problemas.
+ **Projetos, problemas, status** — Você pode especificar se deseja rastrear determinados projetos IDs, tipos de problemas e status.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Jira para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Jira, consulte:
+ [Pesquise de forma inteligente seus projetos do Jira com o conector Amazon Kendra Jira Cloud](https://aws.amazon.com/blogs/machine-learning/intelligently-search-your-jira-projects-with-amazon-kendra-jira-cloud-connector/)
# Microsoft Exchange
O Microsoft Exchange é uma ferramenta de colaboração corporativa para mensagens, reuniões e compartilhamento de arquivos. Se você for um usuário do Microsoft Exchange, poderá usar Amazon Kendra para indexar sua fonte de dados do Microsoft Exchange.
Você pode se conectar Amazon Kendra à sua fonte de dados do Microsoft Exchange usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Microsoft Exchange, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Microsoft Exchange, faça essas alterações no Microsoft Exchange e AWS nas contas.
**No Microsoft Exchange, verifique se você:**
+ Criou uma conta do Microsoft Exchange no Office 365.
+ Anotou o ID de inquilino do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
+ Configurei um OAuth aplicativo no portal do Azure e anotei a ID e o segredo do cliente ou as credenciais do cliente. Consulte mais informações no [tutorial da Microsoft](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory) e no [exemplo de registro de aplicação](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application).
**nota**
Quando você cria ou registra uma aplicação no portal do Azure, o ID do segredo representa o valor real do segredo. Você deve anotar ou salvar o valor real do segredo imediatamente ao criar o segredo e a aplicação. É possível acessar o segredo selecionando o nome da aplicação no portal do Azure e acessando a opção de menu sobre certificados e segredos.
É possível acessar o ID de cliente selecionando o nome da aplicação no portal do Azure e acessando a página de visão geral. O ID da aplicação (cliente) é o ID de cliente.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Foram adicionadas as seguintes permissões para a aplicação conector:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-exchange.html)
+ Verifique se cada documento é exclusivo no Microsoft Exchange e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Microsoft Exchange em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Microsoft Exchange Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Microsoft Exchange, você deve fornecer os detalhes necessários da sua fonte de dados do Microsoft Exchange para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Microsoft Exchange paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-exchange).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Microsoft Exchange**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Microsoft Exchange** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Microsoft Exchange** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **ID de locatário**: insira o ID de locatário do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Microsoft Exchange. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Microsoft Exchange
1. Em **ID do cliente**, **Segredo do cliente**: insira as credenciais de autenticação configuradas no Microsoft Exchange no portal do Azure.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Usuário IDs** — Forneça e-mails ao usuário se quiser filtrar o conteúdo por determinados e-mails.
1. **Configuração adicional**: especifique os tipos de conteúdo dos quais você deseja fazer crawling.
+ **Tipos de entidade** — Você pode escolher rastrear o conteúdo do calendário ou dos OneNotes contatos.
+ **Crawling do calendário**: insira as datas de início e término para fazer crawling do conteúdo entre determinadas datas.
+ **Incluir e-mail**: insira “para”, “de” e o assunto do e-mail para filtrar determinados e-mails dos quais você deseja fazer crawling.
+ **Acesso a pastas compartilhadas**: escolha ativar o crawling da lista de controle de acesso para o controle de acesso à sua fonte de dados do Microsoft Exchange.
+ **Regex para domínios**: adicione padrões de expressão regular para incluir ou excluir certos domínios de e-mail.
+ **Padrões Regex**: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
**nota**
O conector da fonte de dados do Amazon Kendra Microsoft Exchange não oferece suporte a mapeamentos de campo personalizados.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Microsoft Exchange**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-msexchange-schema.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `MSEXCHANGE` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID do inquilino** — Você pode encontrar sua ID do inquilino nas Propriedades do Portal do Azure Active Directory ou no seu aplicativo. OAuth
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Microsoft Exchange. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"clientId": "client ID",
"clientSecret": "client secret"
}
```
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Microsoft Exchange e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Microsoft Exchange](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados tipos de conteúdo.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Lista de controle de acesso (ACL)**: especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Microsoft Exchange para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Consulte uma lista de outras chaves JSON importantes a serem configuradas em [Esquema do modelo do Microsoft Exchange](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-msexchange-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Microsoft Exchange, consulte:
+ [Indexe o conteúdo do Microsoft Exchange usando o conector do Exchange para o Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/index-your-microsoft-exchange-content-using-the-exchange-connector-for-amazon-kendra/)
## Observações
+ Quando as Listas de Controle de Acesso (ACLs) estão habilitadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações da API do Microsoft Exchange. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# Microsoft OneDrive
A Microsoft OneDrive é um serviço de armazenamento baseado em nuvem que você pode usar para armazenar, compartilhar e hospedar seu conteúdo. Você pode usar Amazon Kendra para indexar sua fonte OneDrive de dados.
Você pode se conectar Amazon Kendra à sua fonte de OneDrive dados usando o [Amazon Kendra console](https://console.aws.amazon.com/kendra/) e a [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_OneDriveConfiguration.html)API.
Amazon Kendra tem duas versões do OneDrive conector. Os recursos suportados de cada versão incluem:
** OneDrive Conector Microsoft V1.0/API [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_OneDriveConfiguration.html)**
+ Mapeamentos de campos
+ Filtros de inclusão/exclusão
** OneDrive Conector Microsoft V2.0/API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)**
+ Filtragem de contexto do usuário
+ Crawler de identidade do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
**nota**
O suporte para o OneDrive conector V1.0 OneDriveConfiguration /API está programado para terminar em junho de 2023. Recomendamos usar o OneDrive conector V2.0/ TemplateConfigurationAPI.
Para solucionar problemas do conector da fonte de Amazon Kendra OneDrive dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
# OneDrive Conector Microsoft V1.0
](data-source-v1-onedrive.md)
+ [
# OneDrive Conector Microsoft V2.0
](data-source-v2-onedrive.md)
+ [
## Saiba mais
](#onedrive-learn-more)
+ [
## Observações
](#onedrive-notes)
# OneDrive Conector Microsoft V1.0
A Microsoft OneDrive é um serviço de armazenamento baseado em nuvem que você pode usar para armazenar, compartilhar e hospedar seu conteúdo. Você pode usar Amazon Kendra para indexar sua fonte de OneDrive dados da Microsoft.
**nota**
O suporte para o OneDrive conector V1.0 OneDrive /API da Microsft está programado para terminar em junho de 2023. Recomendamos usar o OneDrive conector V2.0/ TemplateConfiguration API.
Para solucionar problemas do conector da fonte de Amazon Kendra OneDrive dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-onedrive)
+ [
## Pré-requisitos
](#prerequisites-v1-onedrive)
+ [
## Instruções de conexão
](#data-source-v1-procedure-onedrive)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtros de inclusão/exclusão
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de OneDrive dados, faça essas alterações em suas OneDrive AWS contas.
**No Azure Active Directory (AD), verifique se você:**
+ Criou um aplicativo Azure Active Directory (AD).
+ Usou o ID da aplicação AD para registrar uma chave secreta para a aplicação no site do AD. A chave secreta deve conter o ID da aplicação e uma chave secreta.
+ Copiou o domínio AD da organização.
+ As seguintes permissões de aplicação foram adicionadas à aplicação do AD na opção Microsoft Graph:
+ Leia arquivos em todos os conjuntos de sites (File.Read.All)
+ Leia o perfil completo de todos os usuários (User.Read.All)
+ Leia os dados do diretório (Directory.Read.All)
+ Leia todos os grupos (Group.Read.All)
+ Leia itens em todos os conjuntos de sites (Site.Read.All)
+ Copiou a lista de usuários cujos documentos devem ser indexados. Você pode optar por fornecer uma lista de nomes de usuário ou pode fornecer os nomes de usuário em um arquivo armazenado em um Amazon S3. Depois de criar a fonte de dados, você poderá:
+ Modifique a lista de usuários.
+ Mude de uma lista de usuários para uma lista armazenada em um Amazon S3 bucket.
+ Altere a localização do Amazon S3 bucket de uma lista de usuários. Se você alterar a localização do bucket, também deverá atualizar a IAM função da fonte de dados para que ela tenha acesso ao bucket.
**nota**
Se você armazenar a lista de nomes de usuário em um Amazon S3 bucket, a IAM política da fonte de dados deverá fornecer acesso ao bucket e acesso à chave com a qual o bucket foi criptografado, se houver.
+ Verifique se cada documento é exclusivo em OneDrive e entre outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de OneDrive autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de OneDrive dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de OneDrive dados, você deve fornecer detalhes de suas OneDrive credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou OneDrive para Amazon Kendra ver[Pré-requisitos](#prerequisites-v1-onedrive).
------
#### [ Console ]
**Para se conectar Amazon Kendra a OneDrive**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do OneDrive ** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do OneDrive ** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **OneDrive ID do inquilino — Insira o ID** do OneDrive inquilino sem o protocolo.
1. **Tipo de autenticação**: escolha entre **Novo** e **Existente**.
1.
1. Se você escolher **Existente**, selecione uma senha existente em **Selecionar senha**.
1. Se você escolher **Novo**, insira as seguintes informações na seção **Nova senha AWS Secrets Manager **:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- OneDrive -' é adicionado automaticamente ao seu nome secreto.
1. Para **ID do aplicativo** e **senha do aplicativo** — insira os valores da credencial de autenticação da sua OneDrive conta e escolha **Salvar** autenticação.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Escolha entre **Arquivo da lista** e **Lista de nomes** com base no caso de uso.
1. Se você escolher o **Arquivo da lista**, insira as seguintes informações:
1. **Selecione o local** e insira o caminho para o bucket do Amazon S3 .
**Adicionar arquivo de lista de usuários a Amazon S3** —Selecione para adicionar seus arquivos de lista de usuários ao seu Amazon S3 bucket.
**Mapeamentos de grupos locais de usuários**: selecione para usar o mapeamento de grupos locais para filtrar seu conteúdo.
1. Se você escolher o **Lista de nomes**, insira as seguintes informações:
1. **Nome de usuário**: insira até 10 drives de usuário para indexar. Para adicionar mais de 10 usuários, crie um arquivo que contenha os nomes.
**Selecione Adicionar outro**: escolha adicionar mais usuários.
**Mapeamentos de grupos locais de usuários**: selecione para usar o mapeamento de grupos locais para filtrar seu conteúdo.
1. Para **configuração adicional**, especifique padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
1. Em **Cronograma de execução da sincronização**, em **Frequência** — Escolha com que frequência Amazon Kendra será sincronizada com sua fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **Campos de fonte de dados padrão** e **mapeamentos de campo adicionais sugeridos — Selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a OneDrive**
Você deve especificar o seguinte usando a [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_OneDriveConfiguration.html)API:
+ **ID do inquilino**: o domínio do Azure Active Directory da organização.
+ **OneDrive Usuários** — especifique a lista de contas de usuário cujos documentos devem ser indexados.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta. OneDrive A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "OAuth client ID",
"password": "client secret"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o OneDrive conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do OneDrive ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados documentos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do OneDrive para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
------
# OneDrive Conector Microsoft V2.0
A Microsoft OneDrive é um serviço de armazenamento baseado em nuvem que você pode usar para armazenar, compartilhar e hospedar seu conteúdo. Você pode usar Amazon Kendra para indexar sua fonte OneDrive de dados.
Você pode se conectar Amazon Kendra à sua fonte de OneDrive dados usando o [Amazon Kendra console](https://console.aws.amazon.com/kendra/) e a [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/OneDriveConfiguration.html)API.
**nota**
O suporte para o OneDrive Connector V1.0/ OneDriveConfiguration API está programado para terminar em junho de 2023. Recomendamos usar o OneDrive Connector V2.0/ TemplateConfiguration API. A versão 2.0 fornece funcionalidade adicional ACLs e de rastreador de identidade.
Para solucionar problemas do conector da fonte de Amazon Kendra OneDrive dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-onedrive)
+ [
## Pré-requisitos
](#prerequisites-v2-onedrive)
+ [
## Instruções de conexão
](#data-source-procedure-v2-onedrive)
## Recursos compatíveis
Amazon Kendra OneDrive o conector de fonte de dados oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de OneDrive dados, faça essas alterações em suas OneDrive AWS contas.
**Em OneDrive, verifique se você tem:**
+ Criou uma OneDrive conta no Office 365.
+ Anotou o ID de inquilino do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
+ Criou um OAuth aplicativo no portal do Azure e anotou a ID do cliente e o segredo do cliente ou as credenciais do cliente usadas para autenticação com um AWS Secrets Manager segredo. Consulte mais informações no [tutorial da Microsoft](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory) e no [exemplo de registro de aplicação](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application).
**nota**
Quando você cria ou registra uma aplicação no portal do Azure, o ID do segredo representa o valor real do segredo. Você deve anotar ou salvar o valor real do segredo imediatamente ao criar o segredo e a aplicação. É possível acessar o segredo selecionando o nome da aplicação no portal do Azure e acessando a opção de menu sobre certificados e segredos.
É possível acessar o ID de cliente selecionando o nome da aplicação no portal do Azure e acessando a página de visão geral. O ID da aplicação (cliente) é o ID de cliente.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Usou o ID da aplicação AD para registrar uma chave secreta para a aplicação no site do AD. A chave secreta deve conter o ID da aplicação e uma chave secreta.
+ Copiou o domínio AD da organização.
+ As seguintes permissões foram adicionadas ao seu aplicativo AD na opção Microsoft Graph:
+ Leia arquivos em todos os conjuntos de sites (File.Read.All)
+ Leia o perfil completo de todos os usuários (User.Read.All)
+ Leia todos os grupos (Group.Read.All)
+ Leia todas as notas (Notes.Read.All)
+ Copiou a lista de usuários cujos documentos devem ser indexados. Você pode optar por fornecer uma lista de nomes de usuário ou pode fornecer os nomes de usuário em um arquivo armazenado em um Amazon S3. Depois de criar a fonte de dados, você poderá:
+ Modifique a lista de usuários.
+ Mude de uma lista de usuários para uma lista armazenada em um Amazon S3 bucket.
+ Altere a localização do Amazon S3 bucket de uma lista de usuários. Se você alterar a localização do bucket, também deverá atualizar a IAM função da fonte de dados para que ela tenha acesso ao bucket.
**nota**
Se você armazenar a lista de nomes de usuário em um Amazon S3 bucket, a IAM política da fonte de dados deverá fornecer acesso ao bucket e acesso à chave com a qual o bucket foi criptografado, se houver.
O OneDrive conector usa **e-mail das informações de contato** presentes nas propriedades do **usuário do Onedrive.** Certifique-se de que o usuário cujos dados você deseja rastrear tenha o campo de e-mail configurado na página **Informações de contato**, pois para novos usuários, isso pode estar em branco.
**Em sua AWS conta, verifique se você tem:**
+ Criou um Amazon Kendra índice e, se estiver usando a API, anotei o ID do índice.
+ Criou uma IAM função para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
+ Armazenou suas credenciais de OneDrive autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de OneDrive dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de OneDrive dados, você deve fornecer detalhes de suas OneDrive credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou OneDrive para Amazon Kendra, consulte[Pré-requisitos](#prerequisites-v2-onedrive).
------
#### [ Console ]
**Para se conectar Amazon Kendra a OneDrive**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do OneDrive ** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do OneDrive ** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **OneDrive ID do inquilino — Insira o ID** do OneDrive inquilino sem o protocolo.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. Em **Autenticação**: escolha entre **Novo** e **Existente**..
1.
1. Se você escolher **Existente**, selecione uma senha existente em **Selecionar senha**.
1. Se você escolher **Novo**, insira as seguintes informações na seção **Nova senha AWS Secrets Manager **:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- OneDrive -' é adicionado automaticamente ao seu nome secreto.
1. Em **ID do cliente** e **Segredo do cliente**: insira o ID do cliente e o segredo do cliente.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1.
1. Para **Escopo de sincronização** — Escolha quais OneDrive dados dos usuários serão indexados. Você pode adicionar no máximo 10 usuários manualmente.
1. Para as **Configurações adicionais**, adicione padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Campos de fonte de dados padrão** — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a OneDrive**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-onedrive-schema) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `ONEDRIVEV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID do inquilino**: especifique o ID do inquilino do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
+ **Modo de sincronização** — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. OneDrive
Se você usa a autenticação OAuth 2.0, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"clientId": "client ID",
"clientSecret": "client secret"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o OneDrive conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do OneDrive ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir ou excluir determinados arquivos, OneNote seções e OneNote páginas.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo** — Você só pode mapear campos de índice incorporados ou comuns para o conector. Amazon Kendra OneDrive O mapeamento de campo personalizado não está disponível para o OneDrive conector devido às limitações da API. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do OneDrive ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-onedrive-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte OneDrive de dados, consulte:
+ [Anunciando o OneDrive conector Microsoft atualizado (V2)](https://aws.amazon.com/blogs/machine-learning/announcing-the-updated-microsoft-onedrive-connector-v2-for-amazon-kendra/) para o. Amazon Kendra
## Observações
+ Quando as listas de controle de acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações OneDrive da API. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# Microsoft SharePoint
SharePoint é um serviço colaborativo de criação de sites que você pode usar para personalizar o conteúdo da Web e criar páginas, sites, bibliotecas de documentos e listas. Você pode usar Amazon Kendra para indexar sua fonte SharePoint de dados.
Amazon Kendra atualmente oferece suporte ao SharePoint Online e ao SharePoint Server (versões 2013, 2016, 2019 e Subscription Edition).
Você pode se conectar Amazon Kendra à sua fonte de SharePoint dados usando o [Amazon Kendra console](https://console.aws.amazon.com/kendra/), a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API ou a [SharePointConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SharePointConfiguration.html)API.
Amazon Kendra tem duas versões do SharePoint conector. Os recursos suportados de cada versão incluem:
**SharePoint Conector V1.0/API [SharePointConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SharePointConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Log de alterações
+ Nuvem privada virtual (VPC)
**SharePoint Conector V2.0/API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
**nota**
SharePoint o conector SharePointConfiguration V1.0/API terminou em 2023. Recomendamos migrar ou usar o SharePoint conector V2.0/ TemplateConfiguration API.
Para solucionar problemas do conector da fonte de Amazon Kendra SharePoint dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
# SharePoint conector V1.0
](data-source-v1-sharepoint.md)
+ [
# SharePoint conector V2.0
](data-source-v2-sharepoint.md)
# SharePoint conector V1.0
SharePoint é um serviço colaborativo de criação de sites que você pode usar para personalizar o conteúdo da Web e criar páginas, sites, bibliotecas de documentos e listas. Se você for um SharePoint usuário, poderá usar Amazon Kendra para indexar sua fonte SharePoint de dados.
**nota**
SharePoint o conector SharePointConfiguration V1.0/API terminou em 2023. Recomendamos migrar ou usar o SharePoint conector V2.0/ TemplateConfiguration API.
Para solucionar problemas do conector da fonte de Amazon Kendra SharePoint dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-sharepoint)
+ [
## Pré-requisitos
](#prerequisites-v1-sharepoint)
+ [
## Instruções de conexão
](#data-source-procedure-v1-sharepoint)
+ [
## Saiba mais
](#sharepoint-v1-learn-more)
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Log de alterações
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de SharePoint dados, faça essas alterações em suas SharePoint AWS contas.
Você precisa fornecer credenciais de autenticação, que você armazena com segurança em um segredo. AWS Secrets Manager
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
**Em SharePoint, verifique se você tem:**
+ Anote o URL dos SharePoint sites que você deseja indexar.
+ **Para SharePoint online:**
+ Anotou as credenciais de autenticação básicas, que incluem um nome de usuário e uma senha com no mínimo permissão de administrador
+ **Opcional:** Credenciais OAuth 2.0 geradas contendo nome de usuário, senha, ID do cliente e segredo do cliente.
+ Desativar os **padrões de segurança** no portal do Azure usando um usuário administrativo. Para obter mais informações sobre como gerenciar as configurações padrão de segurança no portal do Azure, consulte a [documentação da Microsoft sobre como usar padrões enable/disable de segurança](https://learn.microsoft.com/en-us/microsoft-365/business-premium/m365bp-conditional-access?view=o365-worldwide&tabs=secdefaults#security-defaults-1).
+ **Para SharePoint servidor:**
+ Anote o nome de domínio do seu SharePoint servidor (o nome NetBIOS no seu Active Directory). Você usa isso, junto com seu nome de usuário e senha de autenticação SharePoint básica, para conectar o SharePoint Servidor Amazon Kendra a.
**nota**
Se você usa o SharePoint Servidor e precisa converter sua Lista de Controle de Acesso (ACL) para o formato de e-mail para filtragem no contexto do usuário, forneça a URL do servidor LDAP e a base de pesquisa LDAP. Ou você pode usar a substituição de domínio do diretório. O URL do servidor LDAP é o nome completo do domínio e o número da porta (por exemplo, ldap://example.com:389). A base de pesquisa do LDAP são os controladores de domínio “example” e “com”. Com a substituição do domínio do diretório, você pode usar o domínio de e-mail em vez de usar o URL do servidor LDAP e a base de pesquisa LDAP. Por exemplo, o domínio do e-mail de username@example.com é “exemplo.com”. Você pode usar essa substituição se não estiver preocupado em validar o domínio e simplesmente quiser usar seu domínio de e-mail.
+ As seguintes permissões foram adicionadas à sua SharePoint conta:
**Para SharePoint listas**
+ Itens abertos: visualize a origem dos documentos com manipuladores de arquivos do lado do servidor.
+ Exibir páginas do aplicativo: visualize formulários, visualizações e páginas do aplicativo. Enumere as listas.
+ Exibir itens: visualize itens em listas e documentos na bibliotecas de documentos.
+ Exibir versões: visualize versões anteriores de um item de lista ou documento.
**Para SharePoint sites**
+ Procurar diretórios — Enumere arquivos e pastas em um site usando o Designer e a interface Web DAV. SharePoint
+ Procurar informações do usuário: visualize informações sobre os usuários do site.
+ Enumerar permissões: enumere as permissões no site, na lista, na pasta, no documento ou no item da lista.
+ Abrir: abra um site, lista ou pasta para acessar itens dentro do contêiner.
+ Use os recursos de integração do cliente — Use SOAP, WebDAV, o modelo de objeto do cliente ou SharePoint as interfaces do Designer para acessar o site.
+ Use interfaces remotas: use recursos que iniciam aplicativos cliente.
+ Exibir páginas: exibir páginas em um site.
+ Verifique se cada documento é exclusivo em SharePoint e entre outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de SharePoint autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de SharePoint dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de SharePoint dados, você deve fornecer detalhes de suas SharePoint credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou SharePoint para Amazon Kendra ver[Pré-requisitos](#prerequisites-v1-sharepoint).
------
#### [ Console ]
**Para se conectar Amazon Kendra a SharePoint**
1. Faça login no AWS Management Console e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha **SharePoint conector v1.0** e, em seguida, escolha **Adicionar fonte de dados**.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Para o **método de hospedagem** — Escolha entre **SharePoint Online** e **SharePointServidor**.
1. Para **SharePointOnline** — Entre no **site URLs específico do seu SharePoint repositório**.
1. Para **SharePointServidor** — Escolha sua **SharePoint versão**, insira **Site URLs específico para seu SharePoint repositório** e insira o Amazon S3 caminho para a localização do seu **certificado SSL.**
1. (Somente SharePoint servidor) Para **proxy da Web** — insira o **nome do host** e o **número da porta** da sua SharePoint instância interna. O número da porta deve ser um valor numérico entre 0 e 65535.
1. Para **autenticação**, escolha entre as seguintes opções com base no caso de uso:
1. **Para SharePoint on-line — Escolha entre a **autenticação básica e OAuth a autenticação 2.0**.**
1. **Para SharePoint Servidor — Escolha entre **Nenhum**, **LDAP** e Manual.**
1. Por **AWS Secrets Manager segredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de SharePoint autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta. Você deve inserir uma **Senha**. O prefixo 'AmazonKendra- SharePoint -' é adicionado automaticamente ao seu nome secreto.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager **:
1. Escolha entre as seguintes opções de autenticação SharePoint na nuvem, com base no seu caso de uso:
1. **Autenticação básica** — insira o nome de usuário SharePoint da sua conta como **Nome de usuário** e a senha SharePoint da conta como **Senha**.
1. **OAuth Autenticação 2.0** — Insira o nome de usuário da sua SharePoint SharePoint conta como **Nome de usuário**, a senha da conta como **Senha**, seu SharePoint ID exclusivo gerado automaticamente como **ID do cliente** e a string secreta compartilhada usada por ambos SharePoint e Amazon Kendra como segredo **do cliente**.
1. Escolha entre as seguintes opções de autenticação SharePoint do servidor, com base no seu caso de uso:
1. **Nenhuma** — Insira o nome de usuário SharePoint da sua conta como **Nome de usuário**, a senha SharePoint da sua conta como **Senha** e o **nome de domínio do servidor**.
1. **LDAP** — Insira o nome de usuário SharePoint da conta como nome de **usuário**, a senha da SharePoint conta como **senha**, o **endpoint do servidor LDAP** (incluindo protocolo e número da porta, por exemplo*ldap://example.com:389*) e sua base de pesquisa **LDAP** (por exemplo,). *dc=example, dc=com*
1. **Manual** — Insira o nome de usuário da SharePoint conta como **nome de usuário**, a senha SharePoint da conta como **senha** e a **substituição do domínio de e-mail** (domínio de e-mail do usuário ou grupo do diretório).
1. Escolha **Salvar**.
1. **nuvem privada virtual (VPC)**: adicione também **sub-redes** e **grupos de segurança de VPC**.
**nota**
Você deve usar uma VPC se usar SharePoint o Server. Amazon VPC é opcional para outras SharePoint versões.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. **Usar log de alterações**: selecione para atualizar o índice em vez de sincronizar todos os arquivos.
1. **Rastrear anexos**: selecione para rastrear anexos.
1. **Usar mapeamentos de grupos locais**: selecione para garantir que os documentos sejam filtrados adequadamente.
1. **Configuração adicional**: adicione padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Amazon Kendra mapeamentos de campo padrão — Selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. Para **Mapeamentos de campo personalizados**, adicione campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a SharePoint**
Você deve especificar o seguinte usando a [SharePointConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SharePointConfiguration.html)API:
+ **SharePointVersão** — especifique a SharePoint versão que você usa ao configurar SharePoint. Esse é o caso, não importa se você usa o SharePoint Server 2013, o SharePoint Server 2016, o SharePoint Server 2019 ou o SharePoint Online.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação que você criou em sua SharePoint conta. O segredo é armazenado em uma estrutura JSON.
Para a **autenticação básica SharePoint on-line**, a seguinte é a estrutura JSON mínima que deve estar em seu segredo:
```
{
"userName": "user name",
"password": "password"
}
```
Para a **autenticação SharePoint Online OAuth 2.0**, a seguinte é a estrutura JSON mínima que deve estar em seu segredo:
```
{
"userName": "SharePoint account user name"",
"password": "SharePoint account password",
"clientId": "SharePoint auto-generated unique client id",
"clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications"
}
```
Para a **autenticação básica do SharePoint servidor**, a seguinte é a estrutura JSON mínima que deve estar em seu segredo:
```
{
"userName": "user name",
"password": "password",
"domain": "server domain name"
}
```
Para a **autenticação LDAP SharePoint do servidor** (se você precisar converter sua lista de controle de acesso (ACL) para o formato de e-mail para filtrar no contexto do usuário, você pode incluir a URL do servidor LDAP e a base de pesquisa LDAP em seu segredo), a seguir está a estrutura JSON mínima que deve estar em seu segredo:
```
{
"userName": "user name",
"password": "password",
"domain": "server domain name"
"ldapServerUrl": "ldap://example.com:389",
"ldapSearchBase": "dc=example,dc=com"
}
```
Para a **autenticação manual do SharePoint servidor**, a seguinte é a estrutura JSON mínima que deve estar em seu segredo:
```
{
"userName": "user name",
"password": "password",
"domain": "server domain name",
"emailDomainOverride": "example.com"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o SharePoint conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do SharePoint ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
+ **Amazon VPC**—Se você usa o SharePoint Server, especifique `VpcConfiguration` como parte da configuração da fonte de dados. Consulte [Configuração Amazon Kendra para usar uma VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Você também pode adicionar os seguintes recursos opcionais:
+ **Proxy da Web** — Se você deve se conectar ao seu SharePoint site URLs por meio de um proxy da Web. Você pode usar essa opção somente para o SharePoint Servidor.
+ **Listas de indexação** — Se o conteúdo dos anexos Amazon Kendra deve ser indexado aos itens da lista. SharePoint
+ **Registro de alterações** — Se Amazon Kendra deve usar o mecanismo de registro de alterações da fonte de SharePoint dados para determinar se um documento deve ser atualizado no índice.
**nota**
Use o log de alterações se o Amazon Kendra não quiser digitalizar todos os documentos. Se o registro de alterações for grande, talvez leve Amazon Kendra menos tempo para digitalizar os documentos na fonte de SharePoint dados do que para processar o registro de alterações. Se você estiver sincronizando sua fonte de SharePoint dados com seu índice pela primeira vez, todos os documentos serão digitalizados.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados tipos de conteúdo.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do SharePoint para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte SharePoint de dados, consulte:
+ [Introdução ao conector Amazon Kendra SharePoint online](https://aws.amazon.com/blogs/machine-learning/getting-started-with-the-amazon-kendra-sharepoint-online-connector/)
# SharePoint conector V2.0
SharePoint é um serviço colaborativo de criação de sites que você pode usar para personalizar o conteúdo da Web e criar páginas, sites, bibliotecas de documentos e listas. Você pode usar Amazon Kendra para indexar sua fonte SharePoint de dados.
Amazon Kendra atualmente suporta SharePoint Online e SharePoint Server (2013, 2016, 2019 e Subscription Edition).
**nota**
SharePoint o conector SharePointConfiguration V1.0/API terminou em 2023. Recomendamos migrar ou usar o SharePoint conector V2.0/ TemplateConfiguration API.
Para solucionar problemas do conector da fonte de Amazon Kendra SharePoint dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-sharepoint)
+ [
## Pré-requisitos
](#prerequisites-v2-sharepoint)
+ [
## Instruções de conexão
](#data-source-procedure-v2-sharepoint)
+ [
## Observações
](#sharepoint-notes)
## Recursos compatíveis
Amazon Kendra SharePoint o conector de fonte de dados oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de SharePoint dados, faça essas alterações em suas SharePoint AWS contas.
Você precisa fornecer credenciais de autenticação, que você armazena com segurança em um segredo. AWS Secrets Manager
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
**No SharePoint Online, verifique se você tem:**
+ Copiou sua SharePoint instância URLs. O formato da URL do host que você insere é*https://yourdomain.com/sites/mysite*. O URL deve começar com `https`.
+ Copiou o nome de domínio do URL da sua SharePoint instância.
+ Anote suas credenciais básicas de autenticação contendo o nome de usuário e a senha com permissões de administrador do site para se conectar ao SharePoint Online.
+ Desativar os **padrões de segurança** no portal do Azure usando um usuário administrativo. Para obter mais informações sobre como gerenciar as configurações padrão de segurança no portal do Azure, consulte a [documentação da Microsoft sobre como usar padrões enable/disable de segurança](https://learn.microsoft.com/en-us/microsoft-365/business-premium/m365bp-conditional-access?view=o365-worldwide&tabs=secdefaults#security-defaults-1).
+ Autenticação multifator (MFA) desativada em sua SharePoint conta, para que ela não Amazon Kendra seja impedida de rastrear seu conteúdo. SharePoint
+ **Se estiver usando um tipo de autenticação diferente da autenticação básica:** copiou o ID do locatário da sua SharePoint instância. Para obter detalhes sobre como encontrar o ID de inquilino, consulte [Encontre o ID de inquilino do Microsoft 365](https://learn.microsoft.com/en-us/sharepoint/find-your-office-365-tenant-id).
+ Se você precisar migrar para a autenticação de usuário na nuvem com o Microsoft Entra, consulte a [documentação da Microsoft sobre a autenticação na nuvem](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/migrate-from-federation-to-cloud-authentication).
+ **Para autenticação OAuth 2.0 e autenticação de token de atualização OAuth 2.0: anote** suas credenciais de **autenticação básica** contendo o nome de usuário e a senha que você usa para se conectar ao SharePoint Online e o ID do cliente e o segredo do cliente gerados após o registro SharePoint no Azure AD.
+ **Se não estiver usando a ACL**, adicione as seguintes permissões:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-v2-sharepoint.html)
**nota**
Note.Read.All e Sites.Read.All são necessários somente se você quiser rastrear documentos. OneNote
Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão **Sites.Selected (aplicação)**. Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o [blog da Microsoft em permissões Sites.Selected](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476).
+ **Se não estiver usando a ACL**, adicione as seguintes permissões:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-v2-sharepoint.html)
**nota**
GroupMember**.Read.All e User.Read.All são necessários somente se o Identity Crawler estiver ativado.**
Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão **Sites.Selected (aplicação)**. Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o [blog da Microsoft em permissões Sites.Selected](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476).
+ **Para autenticação somente do aplicativo Azure AD:** chave privada e a ID do cliente que você gerou após se registrar SharePoint no Azure AD. Observe também o certificado X.509.
+ **Se não estiver usando a ACL**, adicione as seguintes permissões:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-v2-sharepoint.html)
**nota**
Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão **Sites.Selected (aplicação)**. Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o [blog da Microsoft em permissões Sites.Selected](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476).
+ **Se não estiver usando a ACL**, adicionou as seguintes permissões:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-v2-sharepoint.html)
**nota**
Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão **Sites.Selected (aplicação)**. Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o [blog da Microsoft em permissões Sites.Selected](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476).
+ **Para autenticação SharePoint somente do aplicativo: anote** sua ID SharePoint do cliente e segredo do cliente gerados ao conceder permissão somente ao SharePoint aplicativo, e sua ID do cliente e segredo do cliente gerados quando você registrou seu SharePoint aplicativo no Azure AD.
**nota**
SharePoint A autenticação somente de aplicativos *não* é compatível com a versão SharePoint 2013.
+ **(Opcional) Se você estiver rastreando OneNote documentos e usando o **Identity Crawler****, adicione as seguintes permissões:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-v2-sharepoint.html)
**nota**
Nenhuma permissão de API é necessária para rastrear entidades usando a **autenticação básica e a autenticação somente** do SharePoint **aplicativo**.
**No SharePoint Servidor, verifique se você tem:**
+ Copiou sua SharePoint instância URLs e o nome de domínio do seu SharePoint URLs. O formato da URL do host que você insere é*https://yourcompany/sites/mysite*. O URL deve começar com `https`.
**nota**
(Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são iguais às informações do endpoint especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o [problema de assistência confusa](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html), que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.
+ Autenticação multifator (MFA) desativada em sua SharePoint conta, para que ela não Amazon Kendra seja impedida de rastrear seu conteúdo. SharePoint
+ Se estiver usando a **autenticação SharePoint somente de aplicativos para controle** de acesso:
+ Copiou o ID SharePoint do cliente gerado quando você registrou o aplicativo somente no nível do site. O formato da ID do cliente é ClientId @TenantId. Por exemplo, .*ffa956f3-8f89-44e7-b0e4-49670756342c@888d0b57-69f1-4fb8-957f-e1f0bedf82fe*
+ Copiou o segredo SharePoint do cliente gerado quando você registrou o aplicativo somente no nível do site.
**Observação:** como os segredos do cliente IDs e do cliente são gerados para sites únicos somente quando você registra a autenticação SharePoint Server for App Only, somente uma URL do site é suportada para a autenticação SharePoint App Only.
**nota**
SharePoint A autenticação somente de aplicativos *não* é compatível com a versão SharePoint 2013.
+ Se estiver usando o **ID de e-mail com domínio personalizado** para controle de acesso:
+ Anote o valor do seu domínio de e-mail personalizado, por exemplo: "”. *amazon.com*
+ Se estiver usando o **ID de e-mail com domínio a partir da autorização do IDP**, faça uma cópia:
+ Endpoint do servidor LDAP (endpoint do servidor LDAP, incluindo protocolo e número da porta). Por exemplo: *ldap://example.com:389*.
+ Base de pesquisa LDAP (base de pesquisa do usuário LDAP). Por exemplo: *CN=Users,DC=sharepoint,DC=com*.
+ Nome de usuário e senha LDAP.
+ Credenciais de autenticação NTLM configuradas **ou** credenciais de autenticação Kerberos configuradas contendo um nome de usuário (nome de usuário da SharePoint conta) e senha (senha da conta). SharePoint
**No seu Conta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de SharePoint autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de SharePoint dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de SharePoint dados, você deve fornecer detalhes de suas SharePoint credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou SharePoint para Amazon Kendra ver[Pré-requisitos](#prerequisites-v2-sharepoint).
------
#### [ Console: SharePoint Online ]
**Para se conectar Amazon Kendra ao SharePoint Online**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do SharePoint ** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do SharePoint ** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Método de hospedagem** — Escolha **SharePointonline**.
1. **Site URLs específico para seu SharePoint repositório** — insira o SharePoint host. URLs O formato do host URLs que você insere é*https://yourdomain.sharepoint.com/sites/mysite*. O URL deve começar com o protocolo `https`. Separe URLs com uma nova linha. Você pode adicionar até 100 URLs.
1. **Domínio** — insira o SharePoint domínio. Por exemplo, o domínio na URL *https://yourdomain.sharepoint.com/sites/mysite* é*yourdomain*.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
Você também pode escolher o tipo de ID do usuário, seja o nome da entidade principal do usuário ou o e-mail do usuário extraído do portal do Azure. Se você não especificar, o e-mail será usado por padrão.
1. **Autenticação** — escolha entre básica, OAuth 2.0, autenticação somente de aplicativo do Azure AD, autenticação somente de SharePoint aplicativo ou OAuth autenticação de token de atualização 2.0. Escolha um segredo já existente do AWS Secrets Manager para armazenar as credenciais de autenticação ou crie um segredo.
1. Se estiver usando a **Autenticação Básica**, seu segredo deve incluir um nome secreto, nome de SharePoint usuário e senha.
1. Se estiver usando a **autenticação OAuth 2.0**, seu segredo deverá incluir o ID do SharePoint locatário, o nome secreto, o nome SharePoint do usuário, a senha, o ID do cliente do Azure AD gerado quando você se registra SharePoint no Azure AD e o segredo do cliente do Azure AD gerado quando você se registra SharePoint no Azure AD.
1. Se estiver usando a **autenticação somente de aplicativos do Azure AD**, seu segredo deverá incluir a ID do SharePoint locatário, o certificado X.509 autoassinado do Azure AD, o nome secreto, a ID do cliente do Azure AD gerada quando você se registra SharePoint no Azure AD e a chave privada para autenticar o conector para o Azure AD.
1. Se estiver usando a **autenticação SharePoint Somente Aplicativo**, seu segredo deverá incluir a ID do SharePoint locatário, o nome do segredo, a ID SharePoint do cliente que você gerou ao registrar o Aplicativo Somente no Nível do Locatário, o segredo SharePoint do cliente gerado ao se registrar no Aplicativo Somente no Nível do Locatário, o ID do cliente do Azure AD gerado ao se registrar SharePoint no Azure AD e o segredo do cliente do Azure AD gerado ao se registrar no Azure AD. SharePoint
O formato SharePoint do ID do cliente é*ClientID@TenantId*. Por exemplo, .*ffa956f3-8f89-44e7-b0e4-49670756342c@888d0b57-69f1-4fb8-957f-e1f0bedf82fe*
1. Se estiver usando a **autenticação de token de atualização OAuth 2.0**, seu segredo deverá incluir a ID do SharePoint locatário, o nome secreto, a ID exclusiva do cliente do Azure AD gerada quando você se registra SharePoint no Azure AD, o segredo do cliente do Azure AD gerado quando você se SharePoint registra no Azure AD e o token de atualização gerado para se conectar. Amazon Kendra SharePoint
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
Você também pode optar por fazer crawling do mapeamento de grupos locais ou o mapeamento de grupos do Azure Active Directory.
**nota**
O rastreamento de mapeamento de grupos do AD está disponível somente para OAuth 2.0, token de atualização OAuth 2.0 e autenticação somente de SharePoint aplicativo.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
1. **Selecionar entidades**: escolha as entidades que você deseja rastrear. Você pode optar por rastrear **todas** as entidades ou qualquer combinação de **arquivos**, **anexos**, **páginas** de **links**, **eventos**, **comentários** e **dados da lista**.
1. Em **Configuração adicional**, para **Padrões de regex de entidades**: adicione padrões de expressão regular para **Links**, **Páginas** e **Eventos** para incluir entidades específicas em vez de sincronizar todos os documentos.
1. Padrões **Regex — Adicione padrões** de expressão regular para incluir ou excluir arquivos por **caminho do arquivo**, nome do **arquivo, **tipo de arquivo**, nome** da **OneNote seção e nome** da **OneNote página**, em vez de sincronizar todos os seus documentos. Você pode adicionar até 100.
**nota**
OneNote o rastreamento está disponível somente para OAuth 2.0, token de atualização OAuth 2.0 e autenticação somente para SharePoint aplicativos.
1. No **Modo de sincronização**, escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados do Amazon Kendra pela primeira vez, todo o conteúdo é sincronizado por padrão.
+ **Sincronização completa**: sincronize todo o conteúdo, independentemente do status de sincronização anterior.
+ **Sincronização de documentos novos ou modificados**: sincronize somente documentos novos e modificados.
+ **Sincronização de documentos novos, modificados ou excluídos**: sincronize somente documentos novos, modificados e excluídos.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Campos de fonte de dados padrão** — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ Console: SharePoint Server ]
**Para se conectar Amazon Kendra a SharePoint**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendra console](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do SharePoint ** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do SharePoint ** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Método de hospedagem** — Escolha o **SharePointservidor**.
1. **Escolha a SharePoint versão** — escolha **SharePoint 2013**, **SharePoint 2016**, **SharePoint 2019** e **SharePoint (Edição por assinatura)**.
1. **Site URLs específico para seu SharePoint repositório** — insira o SharePoint host. URLs O formato do host URLs que você insere é*https://yourcompany/sites/mysite*. O URL deve começar com o protocolo `https`. Separe URLs com uma nova linha. Você pode adicionar até 100 URLs.
1. **Domínio** — insira o SharePoint domínio. Por exemplo, o domínio na URL *https://yourcompany/sites/mysite* é *yourcompany*
1. **Local do certificado SSL** — Insira o Amazon S3 caminho para o arquivo do certificado SSL.
1. (Opcional) **Proxy Web**: insira o nome do host (sem o protocolo `http://` ou `https://`) e o número da porta usada pelo protocolo de transporte de URL do host. O número da porta deve ser um valor numérico entre 0 e 65535.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
Para SharePoint Servidor, você pode escolher entre as seguintes opções de ACL:
1. **ID de e-mail com domínio do IDP** — O ID do usuário é baseado no e-mail IDs com seus domínios obtidos do provedor de identidade subjacente (IDP). Você fornece os detalhes da conexão do IDP no segredo do Secrets Manager como parte da **Autenticação**.
1. **ID de e-mail com domínio personalizado**: o ID de usuário é baseado no valor do domínio de e-mail personalizado. Por exemplo, “*amazon.com*”. O domínio de e-mail será usado para criar o ID de e-mail para controle de acesso. Você deve inserir seu domínio de e-mail personalizado.
1. **Domínio\$1Usuário com domínio**: o ID de usuário é estruturado usando o formato Domínio\$1ID de usuário. Você precisa fornecer um nome de domínio válido. Por exemplo: *"sharepoint2019"* para construir o controle de acesso.
1. Para **Autenticação**, escolha SharePoint Autenticação somente de aplicativo, autenticação NTLM ou autenticação Kerberos. Escolha um segredo já existente do AWS Secrets Manager para armazenar as credenciais de autenticação ou crie um segredo.
1. Se estiver usando a autenticação **NTLM ou a autenticação** **Kerberos**, seu segredo deverá incluir um nome secreto, nome de SharePoint usuário e senha.
Se estiver usando o **ID de e-mail com o domínio do IDP**, insira também:
+ **Endpoint do servidor LDAP**: endpoint do servidor LDAP, incluindo protocolo e número da porta. Por exemplo: *ldap://example.com:389*.
+ **Base de pesquisa LDAP** — Base de pesquisa do usuário LDAP. Por exemplo: *CN=Users,DC=sharepoint,DC=com*.
+ **Nome de usuário do LDAP**: o nome de usuário do LDAP.
+ **Senha LDAP**: a senha LDAP.
1. Se estiver usando a **autenticação SharePoint somente de aplicativo**, seu segredo deverá incluir um nome secreto, ID SharePoint do cliente que você gerou ao registrar o aplicativo somente no nível do site, o segredo SharePoint do cliente gerado quando você se registrou no aplicativo somente no nível do site.
O formato SharePoint do ID do cliente é*ClientID@TenantId*. Por exemplo, .*ffa956f3-8f89-44e7-b0e4-49670756342c@888d0b57-69f1-4fb8-957f-e1f0bedf82fe*
**Observação:** como os segredos do cliente IDs e do cliente são gerados para sites únicos somente quando você registra a autenticação SharePoint Server for App Only, somente uma URL do site é suportada para a autenticação SharePoint App Only.
Se estiver usando o **ID de e-mail com o domínio do IDP**, insira também:
+ **Endpoint do servidor LDAP**: endpoint do servidor LDAP, incluindo protocolo e número da porta. Por exemplo: *ldap://example.com:389*.
+ **Base de pesquisa LDAP** — Base de pesquisa do usuário LDAP. Por exemplo: *CN=Users,DC=sharepoint,DC=com*.
+ **Nome de usuário do LDAP**: o nome de usuário do LDAP.
+ **Senha LDAP**: a senha LDAP.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
Você também pode optar por fazer crawling do mapeamento de grupos locais ou o mapeamento de grupos do Azure Active Directory.
**nota**
O rastreamento de mapeamento de grupos do AD está disponível somente na autenticação SharePoint App Only.
1. **IAM função** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
1. **Selecionar entidades**: escolha as entidades que você deseja rastrear. Você pode optar por rastrear **todas** as entidades ou qualquer combinação de **arquivos**, **anexos**, **páginas** de **links**, **eventos** e **dados da lista**.
1. Em **Configuração adicional**, para **Padrões de regex de entidades**: adicione padrões de expressão regular para **Links**, **Páginas** e **Eventos** para incluir entidades específicas em vez de sincronizar todos os documentos.
1. Padrões **Regex — Adicione padrões** de expressão regular para incluir ou excluir arquivos por **caminho do arquivo Nome do arquivo** **Tipo de arquivo**, **nome** da **OneNoteseção e nome** da **OneNotepágina**, em vez de sincronizar todos os seus documentos. Você pode adicionar até 100.
**nota**
OneNote o rastreamento está disponível somente para autenticação somente de SharePoint aplicativos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Campos de fonte de dados padrão** — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a SharePoint**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `SHAREPOINTV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Metadados do endpoint do repositório** — especifique o fim da `tenantID` `domain` sua instância. `siteUrls` SharePoint
+ **Modo de sincronização** — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL`para indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG`para indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
**nota**
O crawler de identidade está disponível somente ao definir `crawlAcl` como `true`.
+ **Propriedades adicionais do repositório**, especifique:
+ (Somente para Azure AD) Você usa `s3bucketName` e `s3certificateName` para armazenar o certificado X.509 autoassinado do Azure AD.
+ Tipo de autenticação (`auth_Type`) que você usa, se `OAuth2`, `OAuth2App`, `OAuth2Certificate`, `Basic`, `OAuth2_RefreshToken`, `NTLM` e `Kerberos`.
+ Versão (`version`) que você usa, seja `Server` ou `Online`. Se você usar `Server`, poderá especificar ainda mais `onPremVersion` como `2013`, `2016`, `2019` ou `SubscriptionEdition`.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. SharePoint
Se você usa o SharePoint Online, pode escolher entre a autenticação Básica, OAuth 2.0, Somente Aplicativo do Azure AD e Somente SharePoint Aplicativo. Veja a seguir a estrutura JSON mínima que deve estar presente em sua senhao para cada opção de autenticação:
+ **Autenticação básica**
```
{
"userName": "SharePoint account user name",
"password": "SharePoint account password"
}
```
+ **OAuth Autenticação 2.0**
```
{
"clientId": "client id generated when registering SharePoint with Azure AD",
"clientSecret": "client secret generated when registering SharePoint with Azure AD",
"userName": "SharePoint account user name",
"password": "SharePoint account password"
}
```
+ **Autenticação somente para aplicativo do Azure AD**
```
{
"clientId": "client id generated when registering SharePoint with Azure AD",
"privateKey": "private key to authorize connection with Azure AD"
}
```
+ **SharePoint Autenticação somente por aplicativo**
```
{
"clientId": "client id generated when registering SharePoint for App Only at Tenant Level",
"clientSecret": "client secret generated when registering SharePoint for App Only at Tenant Level",
"adClientId": "client id generated while registering SharePoint with Azure AD",
"adClientSecret": "client secret generated while registering SharePoint with Azure AD"
}
```
+ **OAuth Autenticação de token de atualização 2.0**
```
{
"clientId": "client id generated when registering SharePoint with Azure AD",
"clientSecret": "client secret generated when registering SharePoint with Azure AD",
"refreshToken": "refresh token generated to connect to SharePoint"
}
```
Se você usa o SharePoint Server, pode escolher entre autenticação SharePoint somente de aplicativo, autenticação NTLM e autenticação Kerberos. Veja a seguir a estrutura JSON mínima que deve estar presente em sua senhao para cada opção de autenticação:
+ ** SharePoint Autenticação somente por aplicativo**
```
{
"siteUrlsHash": "Hash representation of SharePoint site URLs",
"clientId": "client id generated when registering SharePoint for App Only at Site Level",
"clientSecret": "client secret generated when registering SharePoint for App Only at Site Level"
}
```
+ ** SharePoint Autenticação somente de aplicativo com domínio a partir da autorização do IDP**
```
{
"siteUrlsHash": "Hash representation of SharePoint site URLs",
"clientId": "client id generated when registering SharePoint for App Only at Site Level",
"clientSecret": "client secret generated when registering SharePoint for App Only at Site Level",
"ldapUrl": "LDAP Account url eg. ldap://example.com:389",
"baseDn": "LDAP Account base dn eg. CN=Users,DC=sharepoint,DC=com",
"ldapUser": "LDAP account user name",
"ldapPassword": "LDAP account password"
}
```
+ **(Somente servidor) Autenticação NTLM ou Kerberos**
```
{
"siteUrlsHash": "Hash representation of SharePoint site URLs",
"userName": "SharePoint account user name",
"password": "SharePoint account password"
}
```
+ **(Somente servidor) Autenticação NTLM ou Kerberos com domínio a partir da autorização do IDP**
```
{
"siteUrlsHash": "Hash representation of SharePoint site URLs",
"userName": "SharePoint account user name",
"password": "SharePoint account password",
"ldapUrl": "ldap://example.com:389",
"baseDn": "CN=Users,DC=sharepoint,DC=com",
"ldapUser": "LDAP account user name",
"ldapPassword": "LDAP account password"
}
```
+ **IAM role** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o SharePoint conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do SharePoint ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir ou excluir determinados arquivos e outros conteúdos. OneNotes
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do SharePoint para os campos de índice do Amazon Kendra . Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do SharePoint ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-sharepoint).
------
## Observações
+ O conector oferece suporte a mapeamentos de campo personalizados somente para a entidade **Arquivos**.
+ Para todas as versões SharePoint do servidor, o token ACL deve estar em minúsculas. Para **e-mail com domínio do IDP** e **ID de e-mail com ACL de domínio personalizado**, por exemplo:. *user@sharepoint2019.com* Para **Domínio\$1 Usuário com ACL de domínio**, por exemplo:*sharepoint2013\$1user*.
+ Quando as listas de controle de acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações SharePoint da API. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
+ O conector não suporta o modo de registro de **alterações/sincronização de conteúdo novo ou modificado para SharePoint 2013**.
+ Se o nome de uma entidade tiver um caractere `%` em seu nome, o conector ignorará esses arquivos devido às limitações da API.
+ OneNote só pode ser rastreado pelo conector usando uma ID de locatário e com o token de atualização OAuth 2.0, OAuth 2.0 ou a autenticação somente do SharePoint aplicativo ativada para o Online. SharePoint
+ O conector rastreia a primeira seção de um OneNote documento usando somente o nome padrão, mesmo que o documento seja renomeado.
+ **O conector rastreia links na edição SharePoint 2019, SharePoint on-line e por assinatura, somente se **as páginas** e **os arquivos** forem selecionados como entidades a serem rastreadas, além dos links.**
+ O conector rastreia links em SharePoint 2013 e SharePoint 2016 se **Links** for selecionado como uma entidade a ser rastreada.
+ O conector rastreia os anexos e os comentários da lista somente quando os **Dados da Lista** também são selecionados como uma entidade a ser rastreada.
+ O conector rastreia os anexos de eventos somente quando os **Eventos** também são selecionados como uma entidade a ser rastreada.
+ Para a versão SharePoint online, o token ACL estará em minúsculas. Por exemplo, se o **nome principal do usuário** estiver *MaryMajor@domain.com* no portal do Azure, o token ACL no SharePoint Conector será*marymajor@domain.com*.
+ No **Identity Crawler** for SharePoint Online and Server, se você quiser rastrear grupos aninhados, precisará ativar o rastreamento local e o rastreamento de grupos do AD.
+ Se você estiver usando SharePoint Online e o Nome Principal do Usuário em seu Portal do Azure for uma combinação de maiúsculas e minúsculas, a SharePoint API o converterá internamente em minúsculas. Por causa disso, o Amazon Kendra SharePoint conector define a ACL em letras minúsculas.
# Microsoft SQL Server
**nota**
O conector do Microsoft SQL Server permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O Microsoft SQL Server é um sistema de gerenciamento de banco de dados relacional (RDBMS) desenvolvido pela Microsoft. Se você for um Microsoft SQL Server usuário, poderá usar Amazon Kendra para indexar sua fonte Microsoft SQL Server de dados. O conector da fonte de Amazon Kendra Microsoft SQL Server dados é compatível com o MS SQL Server 2019.
Você pode se conectar Amazon Kendra à sua fonte de Microsoft SQL Server dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Microsoft SQL Server dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-ms-sql-server)
+ [
## Pré-requisitos
](#prerequisites-ms-sql-server)
+ [
## Instruções de conexão
](#data-source-procedure-ms-sql-server)
+ [
## Observações
](#ms-sql-server-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Microsoft SQL Server dados, faça essas alterações em suas Microsoft SQL Server AWS contas.
**Em Microsoft SQL Server, verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em Microsoft SQL Server e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Microsoft SQL Server em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Microsoft SQL Server dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Microsoft SQL Server dados, você deve fornecer detalhes de suas Microsoft SQL Server credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Microsoft SQL Server para Amazon Kendra ver[Pré-requisitos](#prerequisites-ms-sql-server).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Microsoft SQL Server**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Microsoft SQL Server** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Microsoft SQL Server** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Microsoft SQL Server autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Microsoft SQL Server -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
**nota**
Se o nome de uma tabela incluir caracteres especiais (não alfanuméricos) no nome, você deverá usar colchetes ao redor do nome da tabela. Por exemplo, *select \$1 from [my-database-table]*.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna do usuário** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Microsoft SQL Server**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `sqlserver`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
**nota**
Se o nome de uma tabela incluir caracteres especiais (não alfanuméricos) no nome, você deverá usar colchetes ao redor do nome da tabela. Por exemplo, *select \$1 from [my-database-table]*.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Microsoft SQL Server A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Microsoft SQL Server conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Microsoft SQL Server](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Microsoft SQL Server para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Esquema de modelo do Microsoft SQL Server](ds-schemas.md#ds-ms-sql-server-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Microsoft Teams
O Microsoft Teams é uma ferramenta de colaboração corporativa para mensagens, reuniões e compartilhamento de arquivos. Se você for um usuário do Microsoft Teams, poderá usar Amazon Kendra para indexar sua fonte de dados do Microsoft Teams.
Você pode se conectar Amazon Kendra à sua fonte de dados do Microsoft Teams usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Microsoft Teams, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-teams)
+ [
## Pré-requisitos
](#prerequisites-teams)
+ [
## Instruções de conexão
](#data-source-procedure-teams)
+ [
## Saiba mais
](#teams-learn-more)
+ [
## Observações
](#teams-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de usar Amazon Kendra para indexar sua fonte de dados do Microsoft Teams, faça essas alterações nas suas AWS contas e no Microsoft Teams.
**No Microsoft Exchange, verifique se você:**
+ Criou uma conta do Microsoft Teams no Office 365.
+ Anotou o ID de inquilino do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
+ Configurei um OAuth aplicativo no portal do Azure e anotei a ID e o segredo do cliente ou as credenciais do cliente. Consulte mais informações no [tutorial da Microsoft](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory) e no [exemplo de registro de aplicação](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application).
**nota**
Quando você cria ou registra uma aplicação no portal do Azure, o ID do segredo representa o valor real do segredo. Você deve anotar ou salvar o valor real do segredo imediatamente ao criar o segredo e a aplicação. É possível acessar o segredo selecionando o nome da aplicação no portal do Azure e acessando a opção de menu sobre certificados e segredos.
É possível acessar o ID de cliente selecionando o nome da aplicação no portal do Azure e acessando a página de visão geral. O ID da aplicação (cliente) é o ID de cliente.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Permissões necessárias adicionadas. Você pode optar por adicionar todas as permissões ou limitar o escopo selecionando menos permissões com base nas entidades das quais deseja fazer crawling. A tabela apresentada a seguir lista as permissões no nível da aplicação por entidade correspondente:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-teams.html)
+ Verifique se cada documento é exclusivo no Microsoft Teams e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Microsoft Teams em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Microsoft Teams Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Microsoft Teams, você deve fornecer os detalhes necessários da sua fonte de dados do Microsoft Teams para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Microsoft Teams paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-teams).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Microsoft Teams**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Microsoft Teams** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Microsoft Teams** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **ID de locatário**: insira o ID de locatário do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Microsoft Teams. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Microsoft Teams-' é adicionado automaticamente ao seu nome secreto.
1. Em **ID do cliente** e **Segredo do cliente**: insira as credenciais de autenticação configuradas no Microsoft Teams no portal do Azure.
1. Salve e adicione o segredo.
1. **Modelo de pagamento**: você pode escolher um modelo de licenciamento e pagamento para sua conta do Microsoft Teams. Os modelos de pagamento do modelo A são restritos aos modelos de licenciamento e pagamento que exigem conformidade de segurança. Os modelos de pagamento do modelo A são restritos aos modelos de licenciamento e pagamento que exigem conformidade de segurança.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Sincronizar conteúdo**: selecione os tipos de conteúdo dos quais fazer crawling. É possível optar pelo crawling do conteúdo do chat, das equipes e do calendário.
1. **Configuração adicional** — especifique determinadas datas de início e término do calendário, e-mails de usuários, nomes de equipes e nomes de canais, anexos e. OneNotes
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Microsoft Teams**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `MSTEAMS` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID do inquilino** — você pode encontrar sua ID do inquilino nas Propriedades do Portal do Azure Active Directory ou no seu aplicativo. OAuth
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação da sua conta do Microsoft Teams. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"clientId": "client ID",
"clientSecret": "client secret"
}
```
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Microsoft Teams e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Microsoft Teams](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Tipos de documento/conteúdo**: especifique se deseja fazer crawling de mensagens e anexos de chat, publicações e anexos de canais, wikis de canais, conteúdo do calendário, chats de reuniões, arquivos e notas.
+ **Conteúdo do calendário**: especifique uma data e hora de início e término para fazer crawling do conteúdo do calendário.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados tipos de conteúdo no Microsoft Teams. Você pode incluir ou excluir nomes de equipes, nomes de canais, nomes e tipos de arquivos, e-mails de usuários, OneNote seções e OneNote páginas.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Microsoft Teams para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Consulte uma lista de outras chaves JSON importantes para configurar, em [Esquema do modelo do Microsoft Teams](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-msteams-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Microsoft Teams, consulte:
+ [Pesquise de forma inteligente a fonte de dados do Microsoft Teams da sua organização com o Amazon Kendra conector do Microsoft Teams](https://aws.amazon.com/blogs/machine-learning/intelligently-search-your-organizations-microsoft-teams-data-source-with-the-amazon-kendra-connector-for-microsoft-teams/)
## Observações
+ Quando as Listas de Controle de Acesso (ACLs) estão habilitadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações da API do Microsoft Teams. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# Microsoft Yammer
**nota**
O conector do Microsoft Yammer permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O Microsoft Yammer é uma ferramenta de colaboração corporativa para mensagens, reuniões e compartilhamento de arquivos. Se você for um usuário do Microsoft Yammer, poderá usar Amazon Kendra para indexar sua fonte de dados do Microsoft Yammer.
Você pode se conectar Amazon Kendra à sua fonte de dados do Microsoft Yammer usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Microsoft Yammer, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
## Recursos compatíveis
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de usar Amazon Kendra para indexar sua fonte de dados do Microsoft Yammer, faça essas alterações no Microsoft Yammer e AWS nas contas.
**No Microsoft Yammer, verifique se você:**
+ Criou uma conta administrativa do Microsoft Yammer no Office 365.
+ Anotou o nome de usuário e a respectiva senha do Microsoft Yammer.
+ Anotou o ID de inquilino do Microsoft 365. Você pode encontrar sua ID de locatário nas Propriedades do Portal do Azure Active Directory ou em seu OAuth aplicativo.
+ Configurei um OAuth aplicativo no portal do Azure e anotei a ID e o segredo do cliente ou as credenciais do cliente. Consulte mais informações no [tutorial da Microsoft](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory) e no [exemplo de registro de aplicação](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application).
**nota**
Quando você cria ou registra uma aplicação no portal do Azure, o ID do segredo representa o valor real do segredo. Você deve anotar ou salvar o valor real do segredo imediatamente ao criar o segredo e a aplicação. É possível acessar o segredo selecionando o nome da aplicação no portal do Azure e acessando a opção de menu sobre certificados e segredos.
É possível acessar o ID de cliente selecionando o nome da aplicação no portal do Azure e acessando a página de visão geral. O ID da aplicação (cliente) é o ID de cliente.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Verifique se cada documento é exclusivo no Microsoft Yammer e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Microsoft Yammer em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Microsoft Yammer a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Microsoft Yammer, você deve fornecer os detalhes necessários da sua fonte de dados do Microsoft Yammer para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Microsoft Yammer paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-yammer).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Microsoft Yammer**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Microsoft Yammer** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Microsoft Yammer** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Microsoft Yammer. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em **Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Microsoft Yammer-' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário**, **Senha**: digite o nome de usuário e senha do Microsoft Yammer.
1. Em **ID do cliente**, **Segredo do cliente**: insira as credenciais de autenticação configuradas no Microsoft Yammer no portal do Azure.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. **Desde a data**: especifique a data para começar a rastrear os dados no Microsoft Yammer.
1. **Sincronizar conteúdo**: selecione o tipo de conteúdo do qual fazer crawling. Por exemplo, mensagem pública, mensagens privadas e anexos.
1. **Configuração adicional**: especifique nomes de certas comunidades das quais você deseja fazer crawling e use padrões de expressão regular para incluir ou excluir determinados arquivos.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Microsoft Yammer**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `YAMMER` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Modo de sincronização** — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Microsoft Yammer. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password",
"clientId": "client ID",
"clientSecret": "client secret"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Microsoft Yammer e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Microsoft Yammer](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Tipos de documento/conteúdo**: especifique se deseja fazer crawling de conteúdo, mensagens e anexos da comunidade e mensagens privadas.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados tipos de conteúdo.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Microsoft Yammer para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Consulte uma lista de outras chaves JSON importantes a serem configuradas em [Esquema do modelo do Microsoft Yammer](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-yammer).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Microsoft Yammer, consulte:
+ [Anunciando o conector Yammer para Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/announcing-the-yammer-connector-for-amazon-kendra/)
# MySQL
**nota**
O conector do MySQL permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O MySQL é um sistema de gerenciamento de banco de dados relacional de código aberto. Se você for um MySQL usuário, poderá usar Amazon Kendra para indexar sua fonte MySQL de dados. O conector da fonte de Amazon Kendra MySQL dados é compatível com o MySQL 8.0. 21.
Você pode se conectar Amazon Kendra à sua fonte de MySQL dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra MySQL dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-mysql)
+ [
## Pré-requisitos
](#prerequisites-mysql)
+ [
## Instruções de conexão
](#data-source-procedure-mysql)
+ [
## Observações
](#mysql-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de MySQL dados, faça essas alterações em suas MySQL AWS contas.
**Em MySQL, verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em MySQL e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de MySQL em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de MySQL dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de MySQL dados, você deve fornecer detalhes de suas MySQL credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou MySQL para Amazon Kendra ver[Pré-requisitos](#prerequisites-mysql).
------
#### [ Console ]
**Para se conectar Amazon Kendra a MySQL**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do MySQL** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do MySQL** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de MySQL autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- MySQL -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a MySQL**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `mySql`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. MySQL A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o MySQL conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do MySQL](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do MySQL para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Oracle Database
**nota**
O conector do Oracle Database permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O Oracle Database é um sistema de gerenciamento de banco de dados. Se você for um Oracle Database usuário, poderá usar Amazon Kendra para indexar sua fonte Oracle Database de dados. O conector da fonte de Amazon Kendra Oracle Database dados é compatível com o Oracle Database 18c, 19c e 21c.
Você pode se conectar Amazon Kendra à sua fonte de Oracle Database dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra Oracle Database dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-oracle-database)
+ [
## Pré-requisitos
](#prerequisites-oracle-database)
+ [
## Instruções de conexão
](#data-source-procedure-oracle-database)
+ [
## Observações
](#oracle-database-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de Oracle Database dados, faça essas alterações em suas Oracle Database AWS contas.
**Em Oracle Database, verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em Oracle Database e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de Oracle Database em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de Oracle Database dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de Oracle Database dados, você deve fornecer detalhes de suas Oracle Database credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou Oracle Database para Amazon Kendra ver[Pré-requisitos](#prerequisites-oracle-database).
------
#### [ Console ]
**Para se conectar Amazon Kendra a Oracle Database**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Oracle Database** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Oracle Database** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de Oracle Database autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- Oracle Database -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna do usuário** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a Oracle Database**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `oracle`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. Oracle Database A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o Oracle Database conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Oracle Database](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Oracle Database para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Esquema de modelos do Oracle Database](ds-schemas.md#ds-oracle-database-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas durante a Amazon Kendra verificação do conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# PostgreSQL
**nota**
O conector do PostgreSQL permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O PostgreSQL é um sistema de gerenciamento de banco de dados relacional de código aberto. Se você for um PostgreSQL usuário, poderá usar Amazon Kendra para indexar sua fonte PostgreSQL de dados. O conector da fonte de Amazon Kendra PostgreSQL dados é compatível com o PostgreSQL 9.6.
Você pode se conectar Amazon Kendra à sua fonte de PostgreSQL dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de Amazon Kendra PostgreSQL dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-postgresql)
+ [
## Pré-requisitos
](#prerequisites-postgresql)
+ [
## Instruções de conexão
](#data-source-procedure-postgresql)
+ [
## Observações
](#postgresql-notes)
## Recursos compatíveis
+ Mapeamentos de campos
+ Filtragem de contexto do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de PostgreSQL dados, faça essas alterações em suas PostgreSQL AWS contas.
**Em PostgreSQL, verifique se você:**
+ Anotou o nome de usuário e senha do banco de dados
**Importante**
Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Copiou a URL, a porta e a instância do host do banco de dados.
+ Verifique se cada documento é exclusivo em PostgreSQL e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de PostgreSQL em um AWS Secrets Manager senha e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de PostgreSQL dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de PostgreSQL dados, você deve fornecer detalhes de suas PostgreSQL credenciais para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou PostgreSQL para Amazon Kendra ver[Pré-requisitos](#prerequisites-postgresql).
------
#### [ Console ]
**Para se conectar Amazon Kendra a PostgreSQL**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do PostgreSQL** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do PostgreSQL** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **Fonte**, insira o seguinte:
1. **Host**: insira o nome do host do banco de dados.
1. **Port**: insira a porta do banco de dados.
1. **Instância**: insira a instância do banco de dados.
1. **Ativar localização do certificado SSL** — Escolha inserir o Amazon S3 caminho para seu arquivo de certificado SSL.
1. Em **Autenticação**: insira as seguintes informações:
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de PostgreSQL autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- PostgreSQL -' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário do banco de dados** e **Senha**, insira os valores da credencial de autenticação que você copiou do banco de dados.
1. Escolha **Salvar**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. Em **Sincronizar escopo**, escolha uma das opções a seguir:
+ **Consulta SQL**: insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Coluna da chave primária**: forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
+ **Coluna de título**: forneça o nome da coluna do título do documento na tabela do banco de dados.
+ **Coluna do corpo**: forneça o nome da coluna do corpo do documento na tabela do banco de dados.
1. Em **Configuração adicional: *opcional***, escolha entre as seguintes opções para sincronizar um conteúdo específico em vez de sincronizar todos os arquivos:
+ **Colunas de detecção de alterações** — insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendrareindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas.
+ ** IDsColuna de usuários** — Insira o nome da coluna que contém o usuário IDs a ser autorizado a acessar o conteúdo.
+ **Coluna de grupos**: insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
+ ** URLsColuna de origem** — insira o nome da coluna que contém URLs a Fonte a ser indexada.
+ **Coluna de carimbos de data e hora** — Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendrausa informações de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
+ **Coluna de fusos horários**: insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
+ **Formato de carimbos de data/hora**: insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Cronograma de execução da sincronização**, em **Frequência**, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos de fonte de dados padrão gerados — **Documento IDs**, **Títulos do documento** e **Fonte URLs** — que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a PostgreSQL**
Você deve especificar o seguinte usando a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)API:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `JDBC` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **Tipo de banco de dados**: especifique o tipo de banco de dados como `postgresql`.
+ **Consulta SQL**: especifique declarações de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ser inferiores a 32 KB. O Amazon Kendra rastreará todo o conteúdo do banco de dados correspondente à sua consulta.
+ **Modo de sincronização** — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. PostgreSQL A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"user name": "database user name",
"password": "password"
}
```
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o PostgreSQL conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do PostgreSQL](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir conteúdo específico usando usuário IDs, grupos, fonte URLs, carimbos de data e hora e fusos horários.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do PostgreSQL para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte [Esquema de modelo do (PostgreSQL](ds-schemas.md#ds-postgresql-schema).
------
## Observações
+ As linhas excluídas do banco de dados não serão rastreadas ao Amazon Kendra verificar o conteúdo atualizado.
+ O tamanho dos nomes e valores dos campos em uma linha do banco de dados não pode exceder 400 KB.
+ Se você tiver uma grande quantidade de dados na fonte de dados do banco de dados e não quiser Amazon Kendra indexar todo o conteúdo do banco de dados após a primeira sincronização, poderá optar por sincronizar somente documentos novos, modificados ou excluídos.
+ Como prática recomendada, forneça credenciais de banco Amazon Kendra de dados somente para leitura.
+ Como prática recomendada, evite adicionar tabelas com dados confidenciais ou informações pessoais identificáveis (PII).
# Quip
**nota**
O conector do Quip permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.
O Quip é um software colaborativo de produtividade que oferece recursos de criação de documentos em tempo real. Você pode usar Amazon Kendra para indexar suas pastas, arquivos, comentários de arquivos, salas de bate-papo e anexos do Quip.
Você pode se conectar Amazon Kendra à sua fonte de dados do Quip usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [QuipConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QuipConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Quip, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-quip)
+ [
## Pré-requisitos
](#prerequisites-quip)
+ [
## Instruções de conexão
](#data-source-procedure-quip)
+ [
## Saiba mais
](#quip-learn-more)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Quip é compatível com os seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Quip, faça essas alterações no Quip e AWS nas contas.
**No Quip, verifique se você:**
+ Tem uma conta do Quip com permissões administrativas.
+ Criou credenciais de autenticação do Quip que incluem um token de acesso pessoal. O token é usado como sua credencial de autenticação armazenada em AWS Secrets Manager segredo. Consulte a [documentação do Quip sobre autenticação](https://quip.com/dev/admin/documentation/current#section/Authentication) para obter mais informações.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Copiou o domínio do site do Quip. Por exemplo, *https://quip-company.quipdomain.com/browse* onde *quipdomain* está o domínio.
+ Verifique se cada documento é exclusivo no Quip e em outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Quip em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Quip a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Quip, você deve fornecer os detalhes necessários da sua fonte de dados do Quip para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Quip paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-quip).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Quip**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Quip** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Quip** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **Nome de domínio do Quip**: insira o Quip que você copiou da conta do Quip.
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Quip. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Quip-' é adicionado automaticamente ao seu nome secreto.
1. **Token do Quip**: insira o acesso pessoal do Quip configurado no Quip.
1. Adicione e salve o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Adicionar pasta do Quip IDs para rastrear** — A pasta do Quip IDs que você deseja rastrear.
**nota**
Para fazer crawling de uma pasta raiz, incluindo todas as subpastas e documentos dentro dela, adicione o ID da pasta raiz. Para rastrear subpastas específicas, adicione a subpasta específica. IDs
1. **Configuração adicional (tipos de conteúdo)**: insira os tipos de conteúdo que você deseja rastrear.
1. **Padrões Regex**: os padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Selecione entre os campos da fonte de dados padrão gerados que você deseja mapear para Amazon Kendra indexar.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Quip**
Você deve especificar o seguinte usando a [QuipConfiguration ](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QuipConfiguration.html)API:
+ **Domínio do site do Quip** — Por exemplo, *https://quip-company.quipdomain.com/browse* onde *quipdomain* está o domínio.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Quip. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"accessToken": "token"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector Quip e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Quip](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique `VpcConfiguration` como parte da configuração da fonte de dados. Consulte [Configuração do Amazon Kendra para usar uma VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinadas arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Pastas**: especifique as pastas e subpastas do Quip que você deseja indexar
**nota**
Para realizar crawling em uma pasta raiz, inclusive todas as subpastas e documentos dentro dela, insira o ID da pasta raiz. Para rastrear subpastas específicas, adicione a subpasta específica. IDs
+ **Anexos, salas de chat, comentários de arquivos**: escolha se deseja incluir crawling de anexos, conteúdo de salas de chat e comentários de arquivos.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Quip para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Quip, consulte:
+ [Pesquise conhecimento em documentos do Quip com a pesquisa inteligente usando o conector do Quip para Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/search-for-knowledge-in-quip-documents-with-intelligent-search-using-the-quip-connector-for-amazon-kendra/)
# Salesforce
O Salesforce é uma ferramenta de gerenciamento de relacionamento com o cliente (CRM) para gerenciar equipes de suporte, vendas e marketing. Você pode usar Amazon Kendra para indexar seus objetos padrão do Salesforce e até mesmo objetos personalizados.
Você pode se conectar Amazon Kendra à sua fonte de dados do Salesforce usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/), a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API ou a [SalesforceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SalesforceConfiguration.html)API.
Amazon Kendratem duas versões do conector Salesforce. Os recursos suportados de cada versão incluem:
**Conector Salesforce V1.0/API [SalesforceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SalesforceConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
**Conector Salesforce V2.0/API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
**nota**
O conector Salesforce V1.0/ SalesforceConfiguration API terminou em 2023. Recomendamos migrar para ou usar o conector V2.0/API do Salesforce. TemplateConfiguration
Para solucionar problemas do conector da fonte de dados Amazon Kendra do Salesforce, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
# Connector V1.0 do Salesforce
](data-source-v1-salesforce.md)
+ [
# Connector V2.0 do Salesforce
](data-source-v2-salesforce.md)
# Connector V1.0 do Salesforce
O Salesforce é uma ferramenta de gerenciamento de relacionamento com o cliente (CRM) para gerenciar equipes de suporte, vendas e marketing. Você pode usar Amazon Kendra para indexar seus objetos padrão do Salesforce e até mesmo objetos personalizados.
**Importante**
Amazon Kendrausa a API Salesforce versão 48. A API do Salesforce limita o número de solicitações que podem ser feitas por dia. Se o Salesforce exceder essas solicitações, ele tentará novamente até conseguir continuar.
**nota**
O conector Salesforce V1.0/ SalesforceConfiguration API terminou em 2023. Recomendamos migrar para ou usar o conector V2.0/API do Salesforce. TemplateConfiguration
Para solucionar problemas do conector da fonte de dados Amazon Kendra do Salesforce, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-salesforce)
+ [
## Pré-requisitos
](#prerequisites-v1-salesforce)
+ [
## Instruções de conexão
](#data-source-procedure-v1-salesforce)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Salesforce oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Salesforce, faça essas alterações em seu Salesforce e em suas contas. AWS
**No Salesforce, verifique se você:**
+ Criou uma conta do Salesforce e anotou o nome de usuário e a senha que você usa para se conectar ao Salesforce.
+ Criou uma conta do Salesforce Connected App com a chave do consumidor OAuth ativada e copiada (ID do cliente) e o segredo do consumidor (segredo do cliente) atribuídos ao seu aplicativo Salesforce Connected. O ID do cliente e o segredo do cliente são usados como suas credenciais de autenticação armazenadas em um AWS Secrets Manager segredo. Consulte a [Documentação do Salesforce sobre aplicativos conectados](https://help.salesforce.com/s/articleView?id=sf.connected_app_overview.htm&type=5) para obter mais informações.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Copiou o token de segurança do Salesforce associado à conta usada para se conectar ao Salesforce.
+ Copiou o URL da instância do Salesforce que você deseja indexar. Normalmente, é *https://.salesforce.com/*. O servidor deve estar executando um aplicativo conectado ao Salesforce.
+ Adicionou credenciais ao seu servidor Salesforce para um usuário com acesso somente de leitura ao Salesforce clonando o ReadOnly perfil e adicionando as permissões Exibir todos os dados e Gerenciar artigos. Essas credenciais identificam o usuário que está fazendo a conexão e o aplicativo conectado ao Salesforce ao qual Amazon Kendra se conecta.
+ Verifique se cada documento é exclusivo no Salesforce e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Salesforce em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Salesforce a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Salesforce, você deve fornecer os detalhes necessários da sua fonte de dados do Salesforce para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Salesforce para Amazon Kendra ver. [Pré-requisitos](#prerequisites-v1-salesforce)
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Salesforce**
1. Faça login no AWS Management Console e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Salesforce V1.0** e, em seguida, escolha **Adicionar conector**.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. **Nome da fonte de dados**: digite um nome para sua fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. **Idioma padrão**: um idioma para filtrar os documentos para o índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. **Adicionar nova tag**: tags para pesquisar e filtrar os recursos ou monitorar os custos compartilhados.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **URL do Salesforce**: insira o URL da instância do site do Salesforce que você deseja indexar.
1. Em **Tipo de autenticação**, escolha entre **Existente** e **Novo** para armazenar as credenciais de autenticação do Salesforce. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Salesforce-' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário**, **Senha**, **Token de segurança**, **Chave do consumidor**, **Segredo do consumidor** e **URL de autenticação**, insira os valores da credencial de autenticação criados na conta do Salesforce.
1. Escolha **Salvar autenticação**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. Para **Rastrear anexos**: selecione para rastrear todos os objetos, os artigos e os feeds anexados.
1. Para **Objetos padrão**, **Artigos do conhecimento** e **Feeds do Chatter**, selecione as entidades do Salesforce ou tipos de conteúdo que deseja rastrear.
**nota**
Você deve fornecer informações de configuração para indexar pelo menos um dos objetos padrão, artigos de conhecimento ou feeds do Chatter. Se optar por rastrear **Artigos de conhecimento**, especifique os tipos de artigos de conhecimento a serem indexados, o nome dos artigos e se deseja indexar os campos padrão de todos os artigos de conhecimento ou somente os campos de um tipo de artigo personalizado. Se optar por indexar artigos personalizados, deverá especificar o nome interno do tipo de artigo. Você pode especificar até 10 tipos de artigos.
1. **Frequência** — Com que frequência Amazon Kendra será sincronizada com sua fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **artigos de conhecimento padrão****, anexos de objetos padrão e mapeamentos** **de campo adicionais sugeridos, selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para seu índice.
**nota**
É necessário um mapeamento de `_document_body`. Você não pode alterar o mapeamento entre o campo `Salesforce ID` e o campo Amazon Kendra `_document_id `.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Salesforce**
Você deve especificar o seguinte na [SalesforceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SalesforceConfiguration.html)API:
+ **URL do servidor**: o URL da instância do site do Salesforce que você deseja indexar.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Salesforce. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
"consumerKey": "Application public key generated when you created your Salesforce application",
"consumerSecret": "Application private key generated when you created your Salesforce application.",
"password": "Password associated with the user logging in to the Salesforce instance",
"securityToken": "Token associated with the user account logging in to the Salesforce instance",
"username": "User name of the user logging in to the Salesforce instance"
}
```
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Salesforce e. Amazon Kendra Para obter mais informações, [consulte Funções do IAM para as fontes de dados do Salesforce](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
+ Você deve fornecer informações de configuração para indexar pelo menos um dos objetos padrão, artigos de conhecimento ou feeds do Chatter.
+ **Objetos padrão**: se você optar por rastrear **Objetos padrão**, deverá especificar o nome do objeto padrão e o nome do campo na tabela de objetos padrão que contém o conteúdo do documento.
+ **Artigos de conhecimento**: se optar por rastrear **Artigos de conhecimento**, especifique os tipos de artigos de conhecimento a serem indexados, os estados dos artigos de conhecimento a serem indexados e se deseja indexar os campos padrão de todos os artigos de conhecimento ou somente os campos de um tipo de artigo personalizado.
+ **Feeds do Chatter** — Se você optar por rastrear os **feeds do Chatter**, deverá especificar o nome da coluna na tabela do Salesforce FeedItem que contém o conteúdo a ser indexado.
Você também pode adicionar os seguintes recursos opcionais:
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados anexos de arquivos.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Salesforce para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
------
# Connector V2.0 do Salesforce
O Salesforce é uma ferramenta de gerenciamento de relacionamento com o cliente (CRM) para gerenciar equipes de suporte, vendas e marketing. Você pode usar Amazon Kendra para indexar seus objetos padrão do Salesforce e até mesmo objetos personalizados.
O conector da fonte de dados Amazon Kendra do Salesforce é compatível com as seguintes edições do Salesforce: Developer Edition e Enterprise Edition.
**nota**
O conector Salesforce V1.0/ SalesforceConfiguration API terminou em 2023. Recomendamos migrar para ou usar o conector V2.0/API do Salesforce. TemplateConfiguration
Para solucionar problemas do conector da fonte de dados Amazon Kendra do Salesforce, consulte. [Solucionar problemas de origens de dados](troubleshooting-data-sources.md)
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-salesforce)
+ [
## Pré-requisitos
](#prerequisites-v2-salesforce)
+ [
## Instruções de conexão
](#data-source-procedure-v2-salesforce)
+ [
## Saiba mais
](#salesforce-v2-learn-more)
+ [
## Observações
](#salesforce-notes)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Salesforce oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Salesforce, faça essas alterações em seu Salesforce e em suas contas. AWS
**No Salesforce, verifique se você:**
+ Criou uma conta administrativa do Salesforce e anotou o nome de usuário e a senha que você usa para se conectar ao Salesforce.
+ Copiou o token de segurança do Salesforce associado à conta usada para se conectar ao Salesforce.
+ Criou uma conta do Salesforce Connected App com a chave do consumidor OAuth ativada e copiada (ID do cliente) e o segredo do consumidor (segredo do cliente) atribuídos ao seu aplicativo Salesforce Connected. O ID do cliente e o segredo do cliente são usados como suas credenciais de autenticação armazenadas em um AWS Secrets Manager segredo. Consulte a [Documentação do Salesforce sobre aplicativos conectados](https://help.salesforce.com/s/articleView?id=sf.connected_app_overview.htm&type=5) para obter mais informações.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Copiou o URL da instância do Salesforce que você deseja indexar. Normalmente, é *https://.salesforce.com/*. O servidor deve estar executando um aplicativo conectado ao Salesforce.
+ Adicionou credenciais ao seu servidor Salesforce para um usuário com acesso somente de leitura ao Salesforce clonando o ReadOnly perfil e adicionando as permissões Exibir todos os dados e Gerenciar artigos. Essas credenciais identificam o usuário que está fazendo a conexão e o aplicativo conectado ao Salesforce ao qual Amazon Kendra se conecta.
+ Verifique se cada documento é exclusivo no Salesforce e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Salesforce em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Salesforce a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Salesforce, você deve fornecer os detalhes necessários da sua fonte de dados do Salesforce para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Salesforce para Amazon Kendra ver. [Pré-requisitos](#prerequisites-v2-salesforce)
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Salesforce**:
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Salesforce** e **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do Salesforce** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **URL do Salesforce**: insira o URL da instância do site do Salesforce que você deseja indexar.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. Insira uma senha existente ou, se você criar uma nova senha, uma janela secreta da AWS Secrets Manager será aberta.
1. **Autenticação**: insira as seguintes informações em **Criar uma janela de segredo do AWS Secrets Manager**:
1. **Nome do segredo**: um nome para o segredo. O prefixo 'AmazonKendra-Salesforce-' é adicionado automaticamente ao seu nome secreto.
1. Em **Nome de usuário**, **Senha**, **Token de segurança**, **Chave do consumidor**, **Segredo do consumidor** e **URL de autenticação**, insira os valores das credenciais de autenticação que você gerou e baixou da conta do Salesforce.
**nota**
Se você usa o Salesforce Developer Edition, use `https://login.salesforce.com/services/oauth2/token` o URL de login do Meu domínio (por exemplo,* https://MyCompany.my.salesforce.com*) como o URL de **autenticação**. **Se você usa o Salesforce Sandbox Edition, use o URL `https://test.salesforce.com/services/oauth2/token ` de login do Meu domínio (por exemplo,* MyDomainName--SandboxName.sandbox.my.salesforce.com*) como o URL de autenticação.**
1. Escolha **Salvar autenticação**.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. Para **Rastrear anexos**: selecione para rastrear todos os objetos do Salesforce.
1. Em **Objetos padrão**, **Objetos padrão com anexos** e **Objeto padrão sem anexo** e **Artigos de conhecimento**: selecione entidades do Salesforce ou tipos de conteúdo dos quais você deseja fazer crawling.
1. Você deve fornecer informações de configuração para indexar pelo menos um dos objetos padrão, artigos de conhecimento ou feeds do Chatter. Se você optar por rastrear **Artigos de conhecimento**, deverá especificar os tipos de artigos de conhecimento a serem indexados. Você pode escolher textos publicados, arquivados, rascunhos e anexos.
**Filtro Regex**: especifique um padrão regex para incluir itens específicos do catálogo.
1. Para **Configuração adicional**:
+ **Informações sobre ACL**: todas as listas de controle de acesso são incluídas por padrão. Desmarcar uma lista de controle de acesso tornará públicos todos os arquivos dessa categoria.
+ **Padrões Regex**: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
**Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Para **artigos de conhecimento padrão****, anexos de objetos padrão e mapeamentos** **de campo adicionais sugeridos, selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para seu índice.
**nota**
É necessário um mapeamento de `_document_body`. Você não pode alterar o mapeamento entre o campo `Salesforce ID` e o campo Amazon Kendra `_document_id `. Você pode mapear qualquer campo do Salesforce para os campos de índice Amazon reserved/default Kendra do título ou corpo do documento.
Se você associar qualquer campo do Salesforce aos campos de título e corpo do documento do Amazon Kendra, este usará os dados desses campos nas respostas da pesquisa.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Salesforce**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `SALESFORCEV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **URL do host**: especifique o URL do host da instância do Salesforce.
+ **Modo de sincronização**: especifique como o Amazon Kendra deve atualizar o índice quando o conteúdo da fonte de dados é alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL`para indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG`para indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Salesforce. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
"consumerKey": "Application public key generated when you created your Salesforce application",
"consumerSecret": "Application private key generated when you created your Salesforce application",
"password": "Password associated with the user logging in to the Salesforce instance",
"securityToken": "Token associated with the user account logging in to the Salesforce instance",
"username": "User name of the user logging in to the Salesforce instance"
}
```
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Salesforce e. Amazon Kendra Para obter mais informações, [consulte Funções do IAM para as fontes de dados do Salesforce](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão** — você pode especificar se deseja incluir ou excluir determinados documentos, contas, campanhas, casos, contatos, leads, oportunidades, soluções, tarefas, grupos, conversas e arquivos de entidades personalizadas.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Salesforce para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
**nota**
É necessário um mapeamento de `_document_body`. Você não pode alterar o mapeamento entre o campo `Salesforce ID` e o campo Amazon Kendra `_document_id `. Você pode mapear qualquer campo do Salesforce para os campos de índice Amazon reserved/default Kendra do título ou corpo do documento.
Se você associar qualquer campo do Salesforce aos campos de título e corpo do documento do Amazon Kendra, este usará os dados desses campos nas respostas da pesquisa.
Consulte uma lista de outras chaves JSON importantes a serem configuradas, em [Esquema do modelo do Salesforce](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-salesforce-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Salesforce, consulte:
+ [Anunciando o conector Salesforce atualizado (V2) para Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/announcing-the-updated-salesforce-connector-v2-for-amazon-kendra/)
## Observações
+ Quando as listas de controle de acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações da API do Salesforce. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# ServiceNow
ServiceNow fornece um sistema de gerenciamento de serviços baseado em nuvem para criar e gerenciar fluxos de trabalho em nível organizacional, como serviços de TI, sistemas de emissão de bilhetes e suporte. Você pode usar Amazon Kendra para indexar seus ServiceNow catálogos, artigos de conhecimento, incidentes e seus anexos.
Você pode se conectar Amazon Kendra à sua fonte de ServiceNow dados usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/), a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API ou a [ServiceNowConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ServiceNowConfiguration.html)API.
Amazon Kendratem duas versões do ServiceNow conector. Os recursos suportados de cada versão incluem:
**ServiceNow conector V1.0/API [ServiceNowConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ServiceNowConfiguration.html)**
+ Mapeamentos de campos
+ ServiceNow versões de instância: Londres, outras
+ Filtros de inclusão/exclusão
**ServiceNow conector V2.0/API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)**
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ ServiceNow versões de instância: Roma, Sandiego, Tóquio, outras
+ Nuvem privada virtual (VPC)
**nota**
ServiceNow o conector ServiceNowConfiguration V1.0/API terminou em 2023. Recomendamos migrar ou usar o ServiceNow conector V2.0/ TemplateConfiguration API.
Para solucionar problemas do conector da fonte de Amazon Kendra ServiceNow dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
# ServiceNow conector V1.0
](data-source-v1-servicenow.md)
+ [
# ServiceNow conector V2.0
](data-source-v2-servicenow.md)
+ [
# Especificando documentos para indexar com uma consulta
](servicenow-query.md)
# ServiceNow conector V1.0
ServiceNow fornece um sistema de gerenciamento de serviços baseado em nuvem para criar e gerenciar fluxos de trabalho em nível organizacional, como serviços de TI, sistemas de emissão de bilhetes e suporte. Você pode usar Amazon Kendra para indexar seus ServiceNow catálogos, artigos de conhecimento e seus anexos.
**nota**
ServiceNow o conector ServiceNowConfiguration V1.0/API terminou em 2023. Recomendamos migrar ou usar o ServiceNow conector V2.0/ TemplateConfiguration API.
Para solucionar problemas do conector da fonte de Amazon Kendra ServiceNow dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v1-servicenow)
+ [
## Pré-requisitos
](#prerequisites-v1-servicenow)
+ [
## Instruções de conexão
](#data-source-procedure-v1-servicenow)
+ [
## Saiba mais
](#servicenow-v1-learn-more)
## Recursos compatíveis
Amazon KendraServiceNow o conector de fonte de dados oferece suporte aos seguintes recursos:
+ ServiceNow versões de instância: Londres, outras
+ Padrões de inclusão/exclusão: catálogos de serviços, artigos de conhecimento e anexos
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de ServiceNow dados, faça essas alterações em suas ServiceNow AWS contas.
**Em ServiceNow, verifique se você tem:**
+ Criei uma conta de ServiceNow administrador e criei uma ServiceNow instância.
+ Copiou o host do URL da sua ServiceNow instância. Por exemplo, se o URL da instância for*https://your-domain.service-now.com*, o formato do URL do host inserido será*your-domain.service-now.com*.
+ Anote suas credenciais básicas de autenticação contendo um nome de usuário e uma senha para permitir Amazon Kendra a conexão com sua ServiceNow instância.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional:** configurou um token de credencial OAuth 2.0 que pode identificar Amazon Kendra e gerar um nome de usuário, senha, ID do cliente e segredo do cliente. O nome de usuário e a senha devem fornecer acesso à base de ServiceNow conhecimento e ao catálogo de serviços. Consulte a [ServiceNow documentação sobre autenticação OAuth 2.0](https://www.servicenow.com/docs/bundle/utah-platform-security/page/integrate/single-sign-on/concept/c_Authentication.html) para obter mais informações.
+ Adicionou as seguintes permissões:
+ kb\$1category
+ kb\$1knowledge
+ kb\$1knowledge\$1base
+ kb\$1uc\$1cannot\$1read\$1mtom
+ kb\$1uc\$1can\$1read\$1mtom
+ sc\$1catalog
+ sc\$1category
+ sc\$1cat\$1item
+ sys\$1attachment
+ sys\$1attachment\$1doc
+ sys\$1user\$1role
+ Verifique se cada documento é exclusivo em ServiceNow e entre outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de ServiceNow autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de ServiceNow dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de ServiceNow dados, você deve fornecer os detalhes necessários da sua fonte de ServiceNow dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou ServiceNow para Amazon Kendra ver[Pré-requisitos](#prerequisites-v1-servicenow).
------
#### [ Console ]
**Para se conectar Amazon Kendra a ServiceNow**
1. Faça login no AWS Management Console e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha **ServiceNowconector V1.0** e, em seguida, escolha **Adicionar fonte de dados**.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **ServiceNow host** — Insira a URL do ServiceNow host.
1. **ServiceNow versão** — Selecione sua ServiceNow versão.
1. Escolha entre **Autenticação básica** e **Autenticação Oauth** 2.0 com base no seu caso de uso.
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de ServiceNow autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- ServiceNow -' é adicionado automaticamente ao seu nome secreto.
1. Se estiver usando a Autenticação Básica, insira o **nome secreto, o nome** **de usuário** e a **senha** da sua conta. ServiceNow
Se estiver usando a OAuth2 autenticação, insira o **nome secreto, nome** **de usuário**, **senha**, **ID do cliente** e **segredo do cliente** que você criou em sua conta. ServiceNow
1. Selecione **Salvar e adicionar senha**.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. **Inclua artigos de conhecimento**: escolha indexar artigos de conhecimento.
1. **Tipo de artigos de conhecimento** — Escolha entre **Incluir somente artigos públicos** e **Incluir artigos com base na consulta de ServiceNow filtro** com base em seu caso de uso. Se você selecionar **Incluir artigos com base na consulta de ServiceNow filtro**, deverá inserir uma **consulta de filtro** copiada da sua ServiceNow conta.
1. **Inclua anexos de artigos de conhecimento**: escolha indexar anexos de artigos de conhecimento. Você também pode selecionar tipos de arquivo específicos para indexar.
1. **Incluir itens do catálogo**: escolha indexar os itens do catálogo.
1. **Incluir anexos de itens de catálogo**: escolha indexar anexos de itens de catálogo. Você também pode selecionar tipos de arquivo específicos para indexar.
1. **Frequência** — Com que frequência Amazon Kendra será sincronizada com sua fonte de dados.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Artigos do Knowledge** e **catálogo de serviços** — Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados e os mapeamentos de campo adicionais sugeridos que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a ServiceNow**
Você deve especificar o seguinte usando a [ServiceNowConfiguration API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ServiceNowConfiguration.html):
+ **URL da fonte de dados** — especifique o ServiceNow URL. O endpoint do host deve ter a seguinte aparência:*your-domain.service-now.com*.
+ **Instância do host da fonte de dados** — especifique a versão da instância do ServiceNow host como `LONDON` ou`OTHERS`.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. ServiceNow
Se você usar uma autenticação básica, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password"
}
```
Se você estiver usando OAuth2 autenticação, o segredo será armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o ServiceNow conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do ServiceNow ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do ServiceNow para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados anexos de arquivos de catálogos e artigos de conhecimento.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Parâmetros de indexação**: você também pode optar por especificar se deseja:
+ Indexar artigos de conhecimento, catálogos de serviços ou os dois Se você optar por indexar artigos de conhecimento e itens do catálogo de serviços, deverá fornecer o nome do ServiceNow campo mapeado para o campo de conteúdo do documento de Amazon Kendra índice no índice.
+ Indexar anexos a artigos de conhecimento e itens de catálogo.
+ Use uma ServiceNow consulta que selecione documentos de uma ou mais bases de conhecimento. As bases de conhecimento podem ser públicas ou privadas. Para obter mais informações, consulte [Como especificar documentos para indexar com uma consulta](https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte ServiceNow de dados, consulte:
+ [Introdução ao conector Amazon Kendra ServiceNow online](https://aws.amazon.com/blogs/machine-learning/getting-started-with-amazon-kendra-servicenow-online-connector/)
# ServiceNow conector V2.0
ServiceNow fornece um sistema de gerenciamento de serviços baseado em nuvem para criar e gerenciar fluxos de trabalho em nível organizacional, como serviços de TI, sistemas de emissão de bilhetes e suporte. Você pode usar Amazon Kendra para indexar seus ServiceNow catálogos, artigos de conhecimento, incidentes e seus anexos.
Para solucionar problemas do conector da fonte de Amazon Kendra ServiceNow dados, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-v2-servicenow)
+ [
## Pré-requisitos
](#prerequisites-v2-servicenow)
+ [
## Instruções de conexão
](#data-source-procedure-v2-servicenow)
+ [
## Saiba mais
](#servicenow-learn-more)
## Recursos compatíveis
Amazon KendraServiceNow o conector de fonte de dados oferece suporte aos seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ ServiceNow versões de instância: Roma, Sandiego, Tóquio, outras
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de ServiceNow dados, faça essas alterações em suas ServiceNow AWS contas.
**Em ServiceNow, verifique se você tem:**
+ Criou uma instância do Personal ou do Enterprise Developer e tem uma instância do ServiceNow com um perfil administrativo.
+ Copiou o host do URL da sua ServiceNow instância. O formato da URL do host que você insere é*your-domain.service-now.com*. Você precisa do URL da instância do ServiceNow para se conectar ao Amazon Kendra.
+ Anote suas credenciais básicas de autenticação de um nome de usuário e senha para permitir Amazon Kendra a conexão com sua ServiceNow instância.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional:** credenciais de cliente OAuth 2.0 configuradas que podem ser identificadas Amazon Kendra usando um nome de usuário, senha, um ID de cliente gerado e um segredo do cliente. Consulte a [ServiceNow documentação sobre autenticação OAuth 2.0](https://www.servicenow.com/docs/bundle/utah-platform-security/page/integrate/single-sign-on/concept/c_Authentication.html) para obter mais informações.
+ Adicionou as seguintes permissões:
+ kb\$1category
+ kb\$1knowledge
+ kb\$1knowledge\$1base
+ kb\$1uc\$1cannot\$1read\$1mtom
+ kb\$1uc\$1can\$1read\$1mtom
+ sc\$1catalog
+ sc\$1category
+ sc\$1cat\$1item
+ sys\$1attachment
+ sys\$1attachment\$1doc
+ sys\$1user\$1role
+ Verifique se cada documento é exclusivo em ServiceNow e entre outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de ServiceNow autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de ServiceNow dados Amazon Kendra a. Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de ServiceNow dados, você deve fornecer os detalhes necessários da sua fonte de ServiceNow dados para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou ServiceNow para Amazon Kendra ver[Pré-requisitos](#prerequisites-v2-servicenow).
------
#### [ Console ]
**Para se conectar Amazon Kendra a ServiceNow**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do ServiceNow ** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **Conector do ServiceNow ** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **ServiceNow host** — Insira a URL do ServiceNow host. O formato da URL do host que você insere é*your-domain.service-now.com*.
1. **ServiceNow versão — Selecione a versão** da sua ServiceNow instância. Você pode escolher entre Roma, San Diego, Tóquio ou outros.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **Autenticação**: escolha entre a **Autenticação básica** e a **Autenticação OAuth 2.0**.
1. **AWSSecrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de ServiceNow autenticação. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta. Insira as seguintes informações na janela:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra- ServiceNow -' é adicionado automaticamente ao seu nome secreto.
1. Se estiver usando a Autenticação Básica, insira o **nome secreto, o nome** **de usuário** e a **senha** da sua conta. ServiceNow
Se estiver usando a autenticação OAuth2 .0, insira o **nome secreto, nome** **de usuário**, **senha**, **ID do cliente** e **segredo do cliente** que você criou em sua conta. ServiceNow
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurações de sincronização**, insira as seguintes informações:
1. Para **artigos de conhecimento**, escolha entre as seguintes opções:
+ **Artigos de conhecimento**: escolha indexar artigos de conhecimento.
+ **Anexos de artigos de conhecimento**: escolha indexar anexos de artigos de conhecimento.
+ **Tipo de artigos de conhecimento** — Escolha entre **Somente artigos públicos e artigos** de **conhecimento com base na consulta de ServiceNow filtro** com base em seu caso de uso. Se você selecionar **Incluir artigos com base na consulta de ServiceNow filtro**, deverá inserir uma **consulta de filtro** copiada da sua ServiceNow conta. Exemplos de consultas de filtro incluem:*workflow\$1state=draft^EQ*,*kb\$1knowledge\$1base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQ*,*article\$1type=text^active=true^EQ*.
**Importante**
Se você optar por rastrear Somente **artigos públicos, Amazon Kendra rastreia somente artigos** de conhecimento aos quais tenha sido atribuída uma função de acesso público em. ServiceNow
+ **Incluir artigos com base em um filtro de descrição curta**: especifique padrões de expressão regular para incluir ou excluir artigos específicos.
1. Para **Itens do catálogo de serviços**:
+ **Itens do catálogo de serviço**: escolha indexar os itens do catálogo de serviço.
+ **Anexos de itens de catálogo de serviço**: escolha indexar anexos de itens de catálogo.
+ **Itens do catálogo de serviço ativos**: escolha indexar os itens do catálogo de serviço ativos.
+ **Itens do catálogo de serviço inativos**: escolha indexar os itens do catálogo de serviço inativos.
+ **Consulta de filtro** — Escolha incluir itens do catálogo de serviços com base em um filtro definido na sua ServiceNow instância. Exemplos de consultas de filtro incluem:*short\$1descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQ*,*nameSTARTSWITHService^active=true^EQ*.
+ **Incluir itens do catálogo de serviços com base no filtro de descrição resumida**: especifique um padrão regex para incluir itens específicos do catálogo.
1. Para **incidentes**:
+ **Incidentes**: escolha indexar incidentes de serviço.
+ **Anexos de incidentes**: opte por indexar anexos de incidentes.
+ **Incidentes ativos**: escolha indexar incidentes ativos.
+ **Incidentes inativos**: escolha indexar incidentes inativos.
+ **Tipo de incidente ativo**: escolha entre **Todos os incidentes**, **Incidentes abertos**, **Aberto: incidentes não atribuídos** e **Incidentes resolvidos**, dependendo do caso de uso.
+ **Consulta de filtro** — Escolha incluir incidentes com base em um filtro definido na sua ServiceNow instância. Exemplos de consultas de filtro incluem:*short\$1descriptionLIKETest^urgency=3^state=1^EQ*,*priority=2^category=software^EQ *.
+ **Incluir incidentes com base em um filtro de descrição resumida**: especifique um padrão de regex para incluir incidentes específicos.
1. Para **Configuração adicional**:
+ **Informações de ACL**: as listas de controle de acesso para entidades que você selecionou são incluídas por padrão. Desmarcar uma lista de controle de acesso tornará públicos todos os arquivos dessa categoria. As opções de ACL são automaticamente desativadas para entidades não selecionadas. Para artigos públicos, a ACL não é aplicada.
+ Para **Tamanho máximo do arquivo** — Especifique o limite de tamanho do arquivo no MBs qual o Amazon Kendra rastreará. O Amazon Kendra fará crawling somente dos arquivos dentro do limite de tamanho definido. O tamanho de arquivo padrão é 50 MB. O tamanho máximo do arquivo deve ser maior que 0 MB e menor que ou igual a 50 MB.
+ **Padrões de regex de anexos**: adicione padrões de expressão regular para incluir ou excluir determinados arquivos anexados de catálogos, artigos de conhecimento e incidentes. Você pode adicionar até 100 padrões.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. **Mapeamentos de campo padrão — Selecione entre os** campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra a ServiceNow**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `SERVICENOWV2` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **URL do host** — especifique a versão da instância do ServiceNow host. Por exemplo, .*your-domain.service-now.com*
+ **Tipo de autenticação** — especifique o tipo de autenticação que você usa, seja `basicAuth` ou `OAuth2` para sua ServiceNow instância.
+ **ServiceNow versão da instância** — Especifique a ServiceNow instância que você usa, se`Tokyo`, `Sandiego``Rome`, ou`Others`.
+ **Modo de sincronização**: especifique como o Amazon Kendra deve atualizar o índice quando o conteúdo da fonte de dados é alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL`para indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação que você criou em sua conta. ServiceNow
Se você usar uma autenticação básica, a senha deverá conter uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password"
}
```
+ Se você usa credenciais de OAuth2 cliente, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:
```
{
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o ServiceNow conector e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do ServiceNow ](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados arquivos anexados usando os nomes dos arquivos e os tipos de arquivo de artigos de conhecimento, catálogos de serviços e incidentes.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Documentos específicos para indexar** — Você pode usar uma ServiceNow consulta para especificar os documentos que deseja de uma ou mais bases de conhecimento, incluindo bases de conhecimento privadas. O acesso às bases de conhecimento é determinado pelo usuário que você usa para se conectar à ServiceNow instância. Para obter mais informações, consulte [Como especificar documentos para indexar com uma consulta](https://docs.aws.amazon.com//kendra/latest/dg/servicenow-query.html).
+ **Parâmetros de indexação**: você também pode optar por especificar se deseja:
+ Indexar artigos de conhecimento, catálogos de serviços ou os dois Se você optar por indexar artigos de conhecimento, itens do catálogo de serviços e incidentes, deverá fornecer o nome do ServiceNow campo mapeado para o campo de conteúdo do documento de índice no Amazon Kendra índice.
+ Indexar anexos a artigos de conhecimento e itens de catálogo de serviço e incidentes.
+ Inclua artigos de conhecimento, itens do catálogo de serviços e incidentes com base no padrão de filtro `short description`.
+ Escolha filtrar itens e incidentes do catálogo de serviços ativos e inativos.
+ Escolha filtrar incidentes com base no tipo de incidente.
+ Escolha quais entidades devem ter a ACL rastreada.
+ Você pode usar uma ServiceNow consulta para especificar os documentos que deseja de uma ou mais bases de conhecimento, incluindo bases de conhecimento privadas. O acesso às bases de conhecimento é determinado pelo usuário que você usa para se conectar à ServiceNow instância. Para obter mais informações, consulte [Como especificar documentos para indexar com uma consulta](https://docs.aws.amazon.com//kendra/latest/dg/servicenow-query.html).
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do ServiceNow para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapear campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do ServiceNow ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-servicenow-schema).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte ServiceNow de dados, consulte:
+ [Introdução ao Amazon Kendra anúncio do ServiceNow conector atualizado (V2) para Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/announcing-the-updated-servicenow-connector-v2-for-amazon-kendra/)
# Especificando documentos para indexar com uma consulta
Especificando documentos com uma consulta
Você pode usar uma ServiceNow consulta para especificar os documentos que deseja incluir em um Amazon Kendra índice. Ao usar uma consulta, você pode especificar várias bases de conhecimento, incluindo bases de conhecimento privadas. O acesso às bases de conhecimento é determinado pelo usuário que você usa para se conectar à ServiceNow instância.
Para criar uma consulta, você usa o construtor de ServiceNow consultas. Você pode usar o construtor para criar a consulta e testar se a consulta retorna a lista correta de documentos.
**Para criar uma consulta usando o ServiceNow console**
1. Faça login no ServiceNow console.
1. No menu à esquerda, escolha **Conhecimento**, em seguida, **Artigos** e **Tudo**.
1. Na parte superior da página, selecione o ícone de filtro.
1. Use o criador de consultas para criar a consulta.
1. Quando a consulta estiver concluída, clique com o botão direito do mouse na consulta e escolha **Copiar consulta** para copiar a consulta do criador de consultas. Salve essa consulta para usar emAmazon Kendra.
![\[Query builder interface showing Knowledge base filters with options to run, save, and copy query.\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/images/ServiceNowQuery.png)
Certifique-se de não alterar nenhum parâmetro de consulta ao copiar a consulta. Se algum dos parâmetros da consulta não for reconhecido, ServiceNow tratará o parâmetro como vazio e não o usará para filtrar os resultados.
# Slack
O Slack é um aplicativo de comunicação empresarial que permite aos usuários enviar mensagens e anexos por meio de vários canais públicos e privados. Você pode usar Amazon Kendra para indexar seus canais públicos e privados do Slack, enviar bots e arquivar mensagens, arquivos e anexos, mensagens diretas e em grupo. Também é possível selecionar conteúdo específico para filtrar.
**nota**
Amazon Kendraagora suporta um conector Slack atualizado.
O console do foi atualizado automaticamente para você. Quaisquer novos conectores criados no console usarão a arquitetura atualizada. Se usa a API, agora você deve passar a usar o objeto [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) em vez do `SlackConfiguration` para configurar o conector.
Os conectores configurados usando o console antigo e a arquitetura de API continuam funcionando conforme configurados. No entanto, não é possível editá-los nem atualizá-los. Se você quer editar ou atualizar a configuração do conector, será necessário criar outro conector.
Recomendamos migrar o fluxo de trabalho do conector para a versão atualizada. O suporte para conectores configurados usando a arquitetura mais antiga está programado para terminar em junho de 2024.
Você pode se conectar Amazon Kendra à sua fonte de dados do Slack usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) ou a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte Amazon Kendra de dados do Slack, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-slack)
+ [
## Pré-requisitos
](#prerequisites-slack)
+ [
## Instruções de conexão
](#data-source-procedure-slack)
+ [
## Saiba mais
](#slack-learn-more)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Slack é compatível com os seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Sincronizações completas e incrementais de conteúdo
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Slack, faça essas alterações no Slack e AWS nas contas.
**No Slack, verifique se você:**
+ Configurei um token de usuário do Slack Bot ou OAuth token de usuário do OAuth Slack. Você pode escolher qualquer um dos tokens para se conectar Amazon Kendra à sua fonte de dados do Slack. É necessário usar um token como credenciais de autenticação. Consulte a [documentação do Slack sobre tokens de acesso](https://api.slack.com/authentication/token-types) para obter mais informações.
**nota**
Se você usar o token do bot como parte das credenciais do Slack, não poderá indexar mensagens diretas, mensagens de grupo e deverá adicionar o token do bot ao canal que deseja indexar.
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ Anotou o ID da equipe do Slack Workspace a partir do URL da página principal do Slack Workspace. Por exemplo, *https://app.slack.com/client/T0123456789/... * onde *T0123456789* está o ID da equipe.
+ Os seguintes escopos/permissões OAuth foram adicionados:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/kendra/latest/dg/data-source-slack.html)
+ Verifique se cada documento é exclusivo no Slack e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação do Slack em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Slack a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Slack, você deve fornecer os detalhes necessários da sua fonte de dados do Slack para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Slack paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-slack).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Slack**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Slack** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Slack** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. Em **ID da equipe do espaço de trabalho do Slack**: o ID da equipe do seu espaço de trabalho do Slack. É possível encontrar o ID da equipe do espaço de trabalho do Slack no URL da página principal. Por exemplo, *https://app.slack.com/client/T0123456789/...* onde *T0123456789* está o ID da equipe.
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Slack. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Insira as seguintes informações em ** Criar uma janela de senha do AWS Secrets Manager**:
1. **Senha**: um nome para sua senha. O prefixo 'AmazonKendra-Slack-' é adicionado automaticamente ao seu nome secreto.
1. Em **Token do Slack**: insira os valores da credencial de autenticação que você configurou no Slack.
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Selecionar tipo de conteúdo**: escolha as entidades ou os tipos de conteúdo do Slack dos quais você quer fazer crawling. É possível escolher entre as opções de todos os canais, canais públicos, canais privados, mensagens em grupo e mensagens privadas.
1. **Selecionar data de início do crawling**: insira a data em que você quer começar a fazer crawling do conteúdo.
1. Em **Configuração adicional**: opte por incluir mensagens de bot e arquivadas e use padrões de expressão regular para incluir ou excluir determinado conteúdo.
**nota**
Se você optar por incluir os nomes do canal IDs e do canal, o conector do Amazon Kendra Slack priorizará o canal em IDs vez dos nomes dos canais.
Se você optou por incluir determinadas mensagens privadas e de grupo, o conector do Slack do Amazon Kendra ignora todas as mensagens privadas e em grupo e faz crawling somente daquelas que são especificadas.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Slack**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-slack) usando a API [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `SLACK` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Especifique também a fonte de dados como `TEMPLATE` ao chamar a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **ID da equipe do espaço de trabalho do Slack**: o ID da equipe do Slack que você copiou do URL da página principal do Slack.
+ **Data de início**: a data para começar a fazer crawling dos dados da equipe do espaço de trabalho do Slack. A data deve seguir este formato: yyyy-mm-dd.
+ **Modo de sincronização** — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
+ `FORCED_FULL_CRAWL` para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ `FULL_CRAWL` para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ `CHANGE_LOG` para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Slack. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"slackToken": "token"
}
```
+ **IAMrole** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para chamar o público necessário APIs para o conector do Slack e. Amazon Kendra Para obter mais informações, consulte [Funções para o IAM das fontes de dados do Slack](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Canais específicos**: filtre por canais públicos ou privados e especifique determinados canais pelo respectivo ID.
+ **Tipos de canais e mensagens**: se o Amazon Kendra deve indexar canais públicos e privados, mensagens diretas e em grupo e mensagens de bot e arquivadas. Se você usar o token do bot como parte das credenciais do Slack, adicione o token do bot ao canal que deseja indexar. Você não pode indexar mensagens diretas e mensagens de grupo usando um token de bot.
+ **Retrospectiva**: é possível optar por configurar um parâmetro `lookBack` para que o conector do Slack faça crawling do conteúdo atualizado ou excluído até um número específico de horas antes da última sincronização do conector.
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados tipos de conteúdo do Slack. Se você usar o token do bot como parte das credenciais do Slack, adicione o token do bot ao canal que deseja indexar. Você não pode indexar mensagens diretas e mensagens de grupo usando um token de bot.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Slack para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Slack](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-slack).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Slack, consulte:
+ [Descubra o conhecimento nos espaços de trabalho do Slack com a pesquisa inteligente usando o conector do Slack Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/unravel-the-knowledge-in-slack-workspaces-with-intelligent-search-using-the-amazon-kendra-slack-connector/)
# Zendesk
O Zendesk é um sistema de gerenciamento de relacionamento com o cliente que ajuda as empresas a automatizar e aprimorar as interações de suporte ao cliente. Você pode usar Amazon Kendra para indexar seus tickets de suporte do Zendesk, comentários do ticket, anexos do ticket, artigos da central de ajuda, comentários de artigos, anexos de comentários de artigos, tópicos da comunidade do Guide, publicações da comunidade e comentários de publicações da comunidade.
Você pode filtrar pelo nome da organização se quiser indexar tickets que estejam somente dentro de uma organização específica. Você também pode escolher definir uma data de rastreamento para quando quiser começar a rastrear dados do Zendesk.
Você pode se conectar Amazon Kendra à sua fonte de dados do Zendesk usando o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/) e a [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)API.
Para solucionar problemas do conector da fonte de dados do Amazon Kendra Zendesk, consulte[Solucionar problemas de origens de dados](troubleshooting-data-sources.md).
**Topics**
+ [
## Recursos compatíveis
](#supported-features-zendesk)
+ [
## Pré-requisitos
](#prerequisites-zendesk)
+ [
## Instruções de conexão
](#data-source-procedure-zendesk)
+ [
## Saiba mais
](#zendesk-learn-more)
+ [
## Observações
](#zendesk-notes)
## Recursos compatíveis
Amazon KendraO conector de fonte de dados do Zendesk é compatível com os seguintes recursos:
+ Mapeamentos de campos
+ Controle de acesso do usuário
+ Filtros de inclusão/exclusão
+ Log de alterações, sincronizações de conteúdo completas e incrementais
+ Nuvem privada virtual (VPC)
## Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Zendesk, faça essas alterações em seu Zendesk e AWS em suas contas.
**No , verifique se você:**
+ Criou uma conta administrativa da Zendesk Suite (Profissional/Empresarial).
+ Anotou o URL de host do Zendesk. Por exemplo, .*https://\$1sub-domain\$1.zendesk.com/*
**nota**
(Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são iguais às informações do endpoint especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o [problema de assistência confusa](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html), que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.
+ Configure a autenticação OAuth 2.0 usando o fluxo de concessão do código de autorização:
1. Na Central de administração, navegue até Aplicativos e integrações > APIs > API do Zendesk.
1. Selecione a guia OAuth Clientes e clique em “Adicionar OAuth cliente”.
1. Configure os detalhes do OAuth cliente: defina o nome e a descrição do cliente, defina o tipo do cliente como “Confidencial”, adicione o redirecionamento apropriado URLs (por exemplo, https://localhost/callback para teste), salve e armazene com segurança o ID do cliente e o segredo do cliente gerados.
1. Certifique-se de que o OAuth cliente tenha o escopo de “leitura” necessário (ou “leitura e gravação” se você precisar de acesso de gravação).
1. Gere um token de acesso usando o fluxo de concessão do código de autorização:
+ Em um navegador, acesse: `https://{subdomain}.zendesk.com/oauth/authorizations/new?response_type=code&client_id={your_client_id}&redirect_uri={your_redirect_uri}&scope=read`
+ Autentique e autorize a aplicação quando solicitado.
+ Após a autorização, o Zendesk redireciona para o redirect\$1uri com um parâmetro de código (por exemplo, o código de autorização). https://localhost/callback?code=\$1authorization\$1code\$1). Copy
+ Troque o código de autorização por um token de acesso enviando uma solicitação POST para o endpoint de token do Zendesk:
```
curl -X POST https://{subdomain}.zendesk.com/oauth/tokens \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=authorization_code&code={authorization_code}&client_id={your_client_id}&client_secret={your_client_secret}&redirect_uri={your_redirect_uri}&scope=read"
```
+ O Zendesk responde com um objeto JSON que contém o access\$1token. Extraia e armazene com segurança esse token de acesso.
1. Armazene o token de acesso gerado com segurança. Esse token de acesso será usado para a integração com o Kendra.
+
**nota**
É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
+ **Opcional:** instalou um certificado SSL para permitir a conexão ao Amazon Kendra.
+ Verificou se cada documento é exclusivo no Zendesk e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.
**No seuConta da AWS, verifique se você tem:**
+ [Criou um Amazon Kendra índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) e, se estiver usando a API, anotei o ID do índice.
+ [Criou uma IAM função](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.
**nota**
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
+ Armazenou suas credenciais de autenticação de em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
**nota**
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. **Não** recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um Secrets Manager segredo ao conectar sua fonte de dados do Zendesk a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.
## Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Zendesk, você deve fornecer os detalhes necessários da sua fonte de dados do Zendesk para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Zendesk paraAmazon Kendra, consulte[Pré-requisitos](#prerequisites-zendesk).
------
#### [ Console ]
**Para se conectar Amazon Kendra ao Zendesk**
1. Faça login no Console de gerenciamento da AWS e abra o [Amazon Kendraconsole](https://console.aws.amazon.com/kendra/).
1. No painel de navegação esquerdo, escolha **Índices** e, em seguida, escolha o índice que deseja usar na lista de índices.
**nota**
Você pode escolher definir ou editar as configurações de **Controle de acesso do usuário** em **Configurações do índice**.
1. Na página **Introdução**, escolha **Adicionar fonte de dados**.
1. Na página **Adicionar fonte de dados**, escolha o **Conector do Zendesk** e selecione **Adicionar conector**. Se estiver usando a versão 2 (se aplicável), escolha o **conector do Zendesk** com a tag “V2.0”.
1. Na página **Especar detalhes da fonte de dados**, insira as seguintes informações:
1. Em **Nome e descrição**, em **Nome da fonte de dados**: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
1. (Opcional) **Descrição**: insira uma descrição opcional para a fonte de dados.
1. Em **Idioma padrão**: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
1. Em **Tags**, em **Adicionar nova tag** — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
1. Escolha **Próximo**.
1. Na página **Definir seção e segurança**, insira as informações a seguir:
1. **URL do Zendesk**: insira o URL do Zendesk. Por exemplo, .*https://\$1sub-domain\$1.zendesk.com/*
1. **Autorização**: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources).
1. **AWS Secrets Managersegredo** — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Zendesk. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
1. Crie um segredo com a seguinte estrutura:
```
{
"hostUrl": "https://yoursubdomain.zendesk.com/",
"accessToken": "your_access_token"
}
```
**nota**
Para a integração com o Kendra, o nome secreto deve começar com AmazonKendra '-Zendesk' seguido pelo identificador escolhido (por exemplo, '-Zendesk-'). AmazonKendra MyConnector
1. Salve e adicione o segredo.
1. **Nuvem privada virtual (VPC)**: você pode escolher usar uma VPC. Nesse caso, você deve adicionar **sub-redes** e grupos de segurança da **VPC**.
1. **Crawler de identidade**: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a [filtragem de contexto Amazon Kendra do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources) dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
1. **IAMfunção** — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
**nota**
IAMas funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha **Criar uma nova função** para evitar erros.
1. Escolha **Próximo**.
1. Na página **Configurar configurações de sincronização**, insira as seguintes informações:
1. **Selecionar conteúdo**: selecione os tipos de conteúdo de que você deseja fazer crawling desde tíquetes, até artigos da central de ajuda, tópicos da comunidade e muito mais.
1. **Nome da organização**: insira os nomes da organização do Zendesk para filtrar conteúdo.
1. **Data de início da sincronização**: a data a partir da qual você deseja indexar o crawling do conteúdo.
1. **Padrões Regex**: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
1. **Modo de sincronização**: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
+ Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
+ Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
+ Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendrapode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
1. Em **Programação de execução de sincronização**, em **Frequência**: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.
1. Escolha **Próximo**.
1. Na página **Definir mapeamentos de campo**, insira as seguintes informações:
1. Campos **de fonte de dados padrão — Selecione entre os campos** de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
1. **Adicionar campo**: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
1. Escolha **Próximo**.
1. Na página **Revisar e criar**, verifique se as informações inseridas estão corretas e selecione **Adicionar fonte de dados**. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página **Fontes de dados** depois que a fonte de dados for adicionada com sucesso.
------
#### [ API ]
**Para se conectar Amazon Kendra ao Zendesk**
Você deve especificar um JSON do [esquema da fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) usando a API [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html). Você deve fornecer as seguintes informações:
+ **Fonte de dados**: especifique o tipo de fonte de dados como `ZENDESK` ao usar o esquema JSON [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html). Também especifique a fonte de dados como `TEMPLATE` quando você chama a API [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
+ **URL do host**: forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Por exemplo, .* https://yoursubdomain.zendesk.com*
+ **Log de alterações**: se o Amazon Kendra deve usar o mecanismo de log de alterações da fonte de dados do Zendesk para determinar se um documento deve ser atualizado no índice.
**nota**
Use o log de alterações se o Amazon Kendra não quiser digitalizar todos os documentos. Se seu registro de alterações for grande, talvez leve Amazon Kendra menos tempo para digitalizar os documentos na fonte de dados do Zendesk do que para processar o registro de alterações. Se estiver sincronizando a fonte de dados do Zendesk com o índice pela primeira vez, todos os documentos serão digitalizados.
+ **Nome de recurso secreto da Amazon (ARN) — Forneça** o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Zendesk. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
"hostUrl": "https://yoursubdomain.zendesk.com",
"clientId": "client ID",
"clientSecret": "Zendesk client secret",
"userName": "Zendesk user name",
"password": "Zendesk password"
}
```
+ **IAMfunção** — Especifique `RoleArn` quando você liga `CreateDataSource` para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para ligar para o público necessário APIs para o conector do Zendesk e. Amazon Kendra Para obter mais informações, consulte [Funções do IAM para as fontes de dados do Zendesk](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
Você também pode adicionar os seguintes recursos opcionais:
+ **Nuvem privada virtual (VPC)**: especifique a `VpcConfiguration` quando ao chamar `CreateDataSource`. Para obter mais informações, consulte [Configurando Amazon Kendra para usar um Amazon VPC](vpc-configuration.md).
+ **Tipos de documento/conteúdo**: especifique se deseja fazer crawling:
+ Support tickets, comentários de tickets, anexos de comentários de and/or tickets
+ Artigos da central de ajuda, anexos de artigos e comentários de artigos
+ Tópicos, publicações ou comentários da comunidade do guia
+ **Filtros de inclusão e exclusão**: especifique se deseja incluir ou excluir determinados tipos de conteúdo do Slack. Se você usar o token do bot como parte das credenciais do Slack, adicione o token do bot ao canal que deseja indexar. Você não pode indexar mensagens diretas e mensagens de grupo usando um token de bot.
**nota**
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
+ **Filtragem de contexto do usuário e controle de acesso**: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte [Filtrar o contexto do usuário](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter).
+ **Mapeamentos de campo**: escolha mapear os campos de fonte de dados do Zendesk para os campos de índice do Amazon Kendra. Para obter mais informações, consulte [Mapeamento de campos de fonte de dados](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
**nota**
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice `_document_body`. Todos os demais campos são opcionais.
Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o [Esquema do modelo do Zendesk](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-zendesk).
------
## Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Zendesk, consulte:
+ [Descubra os insights do Zendesk com a pesquisa Amazon Kendra inteligente](https://aws.amazon.com/blogs/machine-learning/discover-insights-from-zendesk-with-amazon-kendra-intelligent-search/)
## Observações
+ Quando as listas de controle de acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações da API da Zendesk. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído”, ou desative ACLs se precisar usar esse modo de sincronização.
# Mapeando campos de fontes de dados
Amazon Kendra conectores de fonte de dados podem mapear campos de documentos ou de conteúdo da sua fonte de dados para campos no seu Amazon Kendra índice. Por padrão, todo conector é projetado para rastrear campos específicos da fonte de dados. Os campos padrão da fonte de dados e suas propriedades não podem ser alterados nem personalizados. No Amazon Kendra console, os campos padrão e as propriedades do campo padrão que não podem ser editados ficam acinzentados.
Amazon Kendra os conectores também permitem que você mapeie campos personalizados de documentos ou conteúdos de sua fonte de dados para campos personalizados em seu índice. Por exemplo, se você tiver um campo na fonte de dados chamado “departamento” que contém informações do departamento de um documento, ele pode ser mapeado para um campo de índice chamado “Departamento”. Dessa forma, você pode usar o campo ao consultar documentos.
Você também pode mapear campos Amazon Kendra reservados ou comuns, como`_created_at`. Se sua fonte de dados tiver um campo chamado “creation\$1date”, você poderá mapeá-lo para o campo Amazon Kendra reservado equivalente chamado. `_created_at` Para obter mais informações sobre campos Amazon Kendra reservados, consulte [Atributos ou campos do documento](https://docs.aws.amazon.com/kendra/latest/dg/hiw-document-attributes.html).
Você pode mapear campos para a maioria das fontes de dados. Você pode criar mapeamentos de campo para as seguintes fontes de dados:
+ Adobe Experience Manager
+ Alfresco
+ Aurora (MySQL)
+ Aurora (PostgreSQL)
+ Amazon FSx (Windows)
+ Amazon FSx (EM UM NetApp TOQUE)
+ Amazon RDS/Aurora
+ Amazon RDS (Microsoft SQL Server)
+ Amazon RDS (MySQL)
+ Amazon RDS (Oracle)
+ Amazon RDS (PostgreSQL)
+ Amazon Kendra Rastreador da Web
+ WorkDocs
+ Box
+ Confluence
+ Dropbox
+ Drupal
+ GitHub
+ Google Workspace Drives
+ Gmail
+ IBM DB2
+ Jira
+ Microsoft Exchange
+ Microsoft OneDrive
+ Microsoft SharePoint
+ Microsoft Teams
+ Microsoft SQL Server
+ Microsoft Yammer
+ MySQL
+ Oracle Database
+ PostgreSQL
+ Quip
+ Salesforce
+ ServiceNow
+ Slack
+ Zendesk
Ao armazenar os documentos em um bucket do S3 ou fonte de dados do S3, especifique os campos usando um arquivo de metadados JSON. Para obter mais informações, consulte [conectores de fonte de dados do S3](https://docs.aws.amazon.com/kendra/latest/dg/data-source-s3.html).
O mapeamento dos campos da fonte de dados para um campo de índice é um processo de três etapas:
1. Crie um índice. Para obter mais informações, consulte [Criar um índice](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html).
1. Atualize o índice para adicionar campos.
1. Crie uma fonte de dados e inclua mapeamentos de campo para mapear campos reservados e quaisquer campos personalizados para Amazon Kendra indexar campos.
Para atualizar o índice para adicionar campos personalizados, use o console para editar os mapeamentos dos campos da fonte de dados e adicionar um campo personalizado ou usar a [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html)API. Você pode adicionar um total de 500 campos personalizados ao seu índice.
Para fontes de dados do banco de dados, se o nome da coluna do banco de dados corresponder ao nome de um campo reservado, o campo e a coluna serão mapeados automaticamente.
Com a [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html)API, você adiciona campos reservados e personalizados usando`DocumentMetadataConfigurationUpdates`.
O exemplo de JSON a seguir usa `DocumentMetadataConfigurationUpdates` para adicionar um campo chamado “Departamento” ao índice.
```
"DocumentmetadataConfigurationUpdates": [
{
"Name": "Department",
"Type": "STRING_VALUE"
}
]
```
Ao criar o campo, você tem a opção de definir como o campo é usado para pesquisa. Você pode escolher entre as seguintes opções:
+ **Exibível**: determina se o campo é retornado na resposta da consulta. O padrão é `true`.
+ **Facetável**: indica que o campo pode ser usado para criar facetas. O padrão é `false`.
+ **Pesquisável**: determina se o campo é usado na pesquisa. O padrão é `true` para campos de string e `false` para campos de número e data.
+ **Classificável**: indica que o campo pode ser usado para classificar os resultados da pesquisa. Ele só pode ser definido para campos de data, número e sequência de caracteres. Ele não pode ser definido para campos de lista de strings.
O exemplo de JSON a seguir usa `DocumentMetadataConfigurationUpdates` para adicionar um campo chamado “Departamento” ao índice.
```
"DocumentMetadataConfigurationUpdates": [
{
"Name": "Department",
"Type": "STRING_VALUE",
"Search": {
"Facetable": true
}
}
]
```
## Usando campos de documentos Amazon Kendra reservados ou comuns
Com a [UpdateIndex API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html), você pode criar campos reservados ou comuns usando `DocumentMetadataConfigurationUpdates` e especificando o nome do campo de índice Amazon Kendra reservado para mapear para o attribute/field nome do documento equivalente. Você também pode criar campos personalizados. Se você usa um conector de fonte de dados, a maioria inclui mapeamentos de campo que mapeiam os campos do documento da fonte de dados para campos de Amazon Kendra índice. Se usar o console, atualize os campos selecionando a fonte de dados, a ação de edição e, em seguida, prosseguindo para a seção de mapeamentos de campo para configurar a fonte de dados.
Você pode configurar o objeto `Search` para definir um campo como exibível, facetável, pesquisável e classificável. Configure o objeto `Relevance` para definir a ordem de classificação, a duração do aumento ou o período de tempo de um campo a ser aplicado ao aumento, à atualização, ao valor de importância e aos valores de importância mapeados para valores de campo específicos. Se usar o console, defina as configurações de pesquisa de um campo selecionando a opção de faceta no menu de navegação. Para definir o ajuste de relevância, selecione a opção de pesquisar o índice no menu de navegação, insira uma consulta e use as opções do painel lateral para ajustar a relevância da pesquisa. Você não pode alterar o tipo de campo depois de criar o campo.
Amazon Kendra tem os seguintes campos de documento reservados ou comuns que você pode usar:
+ `_authors`: uma lista de um ou mais autores responsáveis pelo conteúdo do documento.
+ `_category`: uma categoria que coloca um documento em um grupo específico.
+ `_created_at`: a data e a hora no formato ISO 8601 em que o documento foi criado. Por exemplo, 2012-03-25T12:30:10\$101:00 é o formato de data e hora ISO 8601 para 25 de março de 2012 às 12h30 (mais 10 segundos) no horário da Europa Central.
+ `_data_source_id`: o identificador da fonte de dados que contém o documento.
+ `_document_body`: o conteúdo do documento de trabalho.
+ `_document_id`: o identificador exclusivo de cada documento.
+ `_document_title`: o título do documento.
+ `_excerpt_page_number`: o número da página em um arquivo PDF em que o trecho do documento aparece. Se o índice foi criado antes de 8 de setembro de 2020, você deve reindexar os documentos antes de poder usar esse atributo.
+ `_faq_id`: se for um documento do tipo pergunta e resposta (Perguntas frequentes), um identificador exclusivo para as Perguntas frequentes.
+ `_file_type`: o tipo de arquivo do documento, como pdf ou doc.
+ `_last_updated_at`: a data e a hora no formato ISO 8601 em que o documento foi atualizado pela última vez. Por exemplo, 2012-03-25T12:30:10\$101:00 é o formato de data e hora ISO 8601 para 25 de março de 2012 às 12h30 (mais 10 segundos) no horário da Europa Central.
+ `_source_uri`: o URI em que o documento está disponível. Por exemplo, o URI do documento no site da empresa.
+ `_version`: um identificador para a versão específica de um documento.
+ `_view_count`: o número de vezes que o documento foi visualizado.
+ `_language_code`(String): o código de um idioma que se aplica ao documento. O padrão é inglês se você não especificar um idioma. Para obter mais informações sobre os idiomas suportados, incluindo os códigos, consulte [Adicionar documentos em outros idiomas além do inglês](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Para campos personalizados, você cria esses campos usando `DocumentMetadataConfigurationUpdates` com a API `UpdateIndex`, assim como faz ao criar um campo reservado ou comum. Você deve definir o tipo de dados apropriado para o campo personalizado. Se usar o console, atualize os campos selecionando a fonte de dados, a ação de edição e, em seguida, prosseguindo para a seção de mapeamentos de campo para configurar a fonte de dados. Algumas fontes de dados não oferecem suporte à adição de novos campos ou campos personalizados. Você não pode alterar o tipo de campo depois de criar o campo.
Estes são os tipos que podem ser definidos em campos personalizados:
+ Data
+ Número
+ String
+ Lista de strings
Se você adicionou documentos ao índice usando a [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html)API, `Attributes` fields/attributes lista seus documentos e cria campos usando o `DocumentAttribute` objeto.
Para documentos indexados de uma fonte de Amazon S3 dados, você cria campos usando um [arquivo de metadados JSON](https://docs.aws.amazon.com/kendra/latest/dg/s3-metadata.html) que inclui as informações dos campos.
Ao usar um banco de dados compatível como fonte de dados, poderá configura os campos usando a [opção de mapeamentos de campo](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html#data-source-procedure-database).
# Adicionar documentos em outros idiomas além do inglês
Você pode indexar documentos em vários idiomas. Se não especificar um idioma, o Amazon Kendra indexa documentos em uma fonte de dados em inglês por padrão. Inclua o código do idioma de um documento nos metadados do documento como um campo. Consulte [Mapeamentos de campo](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) e [Atributos personalizados](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html) para obter mais informações sobre o campo `_language_code` de um documento.
Você pode especificar o código do idioma para todos os seus documentos em sua fonte de dados ao ligar [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html). Se um documento não tiver um código de idioma especificado em um campo de metadados, o documento será indexado usando o código de idioma especificado para todos os documentos no nível da fonte de dados. No console, indexe os documentos em um idioma compatível somente no nível da fonte de dados. Acesse as **Fontes de dados**, em seguida, a página **Especificar detalhes da fonte de dados** e escolha um idioma no menu suspenso **Idioma**.
Você também pode pesquisar ou consultar documentos em um idioma compatível. Para obter mais informações, consulte [Pesquisar em idiomas](https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-languages).
Os seguintes idiomas e os códigos são suportados (inglês ou `en` por padrão, se você não especificar um idioma). Essa tabela inclui idiomas que oferecem Amazon Kendra suporte à pesquisa semântica completa, bem como idiomas que oferecem suporte apenas à correspondência simples de palavras-chave. Os idiomas que oferecem suporte à pesquisa semântica completa são marcados com um asterisco e estão em negrito na tabela a seguir. O inglês (idioma padrão) também é suportado com a pesquisa semântica completa.
| **Nome do idioma** | **Código do idioma** |
| --- | --- |
| Árabe | ar |
| Armênio | hy |
| Basco | eu |
| Bengali | bn |
| Búlgaro | bg |
| Catalão | ca |
| Chinês: simplificado e tradicional\$1 | zh |
| Tcheco | cs |
| Dinamarquesa | da |
| Holandesa | nl |
| Finlandesa | fi |
| Francês: inclui francês (Canadá) \$1 | fr |
| Galego | gl |
| Alemão\$1 | de |
| Grega | el |
| Hindi | hi |
| Húngara | hu |
| Indonésia | id |
| Irlandês | ga |
| Italiana | it |
| Japonês\$1 | ja |
| Coreano\$1 | ko |
| Letão | lv |
| Lituano | lt |
| Norueguesa | no |
| Persa | fa |
| Portuguesa | pt |
| Português (Brasil) | pt-BR |
| Romena | ro |
| Russa | ru |
| Sorani | ckb |
| Espanhol: inclui espanhol (México)\$1 | es |
| Sueco | sv |
| Turco | tr |
*\$1A pesquisa semântica é suportada para o idioma.*
Para idiomas que oferecem suporte à pesquisa semântica, os seguintes recursos são suportados:
+ Relevância do documento além da simples correspondência de palavras-chave.
+ FAQs além da simples correspondência de palavras-chave.
+ Extraindo respostas de documentos com base na compreensão Amazon Kendra de leitura.
+ Buckets de confiança (muito alto, alto, médio e baixo) dos resultados da pesquisa.
Para idiomas que não oferecem suporte à pesquisa semântica, a correspondência simples de palavras-chave é suportada para relevância do documento e. FAQs
[Sinônimos](https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms.html) (incluindo sinônimos personalizados), [aprendizado e feedback incrementais](https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html) e [sugestões de consulta](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html) são compatíveis somente no inglês (idioma padrão).
# Configurando Amazon Kendra para usar um Amazon VPC
Amazon Kendra pode se conectar a uma nuvem privada virtual (VPC) que você criou Amazon Virtual Private Cloud para indexar o conteúdo armazenado em fontes de dados executadas em sua nuvem privada. Ao criar um conector de fonte de dados, você pode fornecer identificadores de grupo de segurança e sub-rede para a sub-rede que contém a fonte de dados. Com essas informações, Amazon Kendra cria uma interface de rede elástica que é usada para se comunicar com segurança com sua fonte de dados na sua VPC.
Para configurar um conector de fonte de Amazon Kendra dados com Amazon VPC, você pode usar a operação Console de gerenciamento da AWS ou a [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API. Se usar o console, conecte uma VPC durante o processo de configuração do conector.
**nota**
O Amazon VPC recurso é opcional ao configurar um conector Amazon Kendra de fonte de dados. Se sua fonte de dados estiver acessível pela Internet pública, você não precisará ativar o Amazon VPC recurso. Nem todos os conectores de fonte de dados do Amazon Kendra são compatíveis com Amazon VPC.
Se sua fonte de dados não estiver em execução Amazon VPC e não estiver acessível pela Internet pública, primeiro conecte sua fonte de dados à sua VPC usando uma rede privada virtual (VPN). Em seguida, você pode conectar sua fonte de dados Amazon Kendra usando uma combinação de Amazon VPC AWS Virtual Private Network e. Para obter mais informações sobre como configurar uma VPN, consulte a [documentação da Site-to-Site VPN](https://docs.aws.amazon.com/vpn/).
**Topics**
+ [
# Configurando o Amazon VPC suporte para conectores Amazon Kendra
](connector-vpc-steps.md)
+ [
# Configurar uma fonte Amazon Kendra de dados à qual se conectar Amazon VPC
](connector-vpc-setup.md)
+ [
# Conectar um banco de dados em uma VPC
](vpc-example.md)
+ [
# Solução de problemas de conexão da VPC
](vpc-connector-troubleshoot.md)
# Configurando o Amazon VPC suporte para conectores Amazon Kendra
Configurando Amazon VPC
Para configurar Amazon VPC para uso com seus Amazon Kendra conectores, siga as etapas a seguir.
**Topics**
+ [
## Etapa 1. Crie Amazon VPC sub-redes para Amazon Kendra
](#connector-vpc-prerequisites-1)
+ [
## Etapa 2. Crie grupos Amazon VPC de segurança para Amazon Kendra
](#connector-vpc-prerequisites-2)
+ [
## Etapa 3. Configure sua fonte de dados externa e Amazon VPC
](#connector-vpc-prerequisites-3)
## Etapa 1. Crie Amazon VPC sub-redes para Amazon Kendra
Crie ou escolha uma Amazon VPC sub-rede existente que Amazon Kendra possa ser usada para acessar sua fonte de dados. As sub-redes preparadas devem estar em uma das seguintes zonas Regiões da AWS de disponibilidade:
+ Oeste dos EUA (Oregon)/us-west-2: usw2-az1, usw2-az2, usw2-az3
+ Leste dos EUA (Norte da Virgínia) /us-east-1—use1-az1, use1-az2, use1-az4
+ Leste dos EUA (Ohio) /us-east-2—use2-az1, use2-az2, use2-az3
+ Ásia-Pacífico (Tóquio) /ap-northeast-1—apne1-az1, apne1-az2, apne1-az4
+ Ásia-Pacífico (Mumbai) /ap-south—aps1-az1, aps1-az2, aps1-az3
+ Ásia-Pacífico (Singapura) /ap-southeast-1—apse1-az1, apse1-az2, apse1-az3
+ Ásia-Pacífico (Sydney) /ap-southeast-2—apse2-az1, apse2-az2, apse2-az3
+ Canadá (Central) /ca-central-1—cac1-az1, cac1-az2, cac1-az4
+ Europa (Irlanda) /eu-west-1-1-az1euw1-az1, uew1-az2, euw1-az3
+ Europa (Londres)/eu-west-2—euw2-az1, euw2-az2, euw2-az3
A fonte de dados deve estar acessível a partir das sub-redes que você forneceu ao conector do Amazon Kendra .
Para obter mais informações sobre como configurar Amazon VPC sub-redes, consulte [Sub-redes para você no](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) Guia do usuário Amazon VPC da Amazon *VPC*.
Se for Amazon Kendra necessário rotear a conexão entre duas ou mais sub-redes, você poderá preparar várias sub-redes. Por exemplo, a sub-rede que contém a fonte de dados está sem endereços IP. Nesse caso, você pode fornecer uma sub-rede adicional Amazon Kendra com endereços IP suficientes e conectada à primeira sub-rede. Se você listar várias sub-redes, as sub-redes devem conseguir se comunicar entre si.
## Etapa 2. Crie grupos Amazon VPC de segurança para Amazon Kendra
Para conectar seu conector de fonte de Amazon Kendra dados Amazon VPC, você deve preparar um ou mais grupos de segurança da sua VPC para atribuir. Amazon Kendra Os grupos de segurança serão associados à interface de rede elástica criada pelo Amazon Kendra. Essa interface de rede controla o tráfego de entrada e saída de e para o Amazon VPC acesso às Amazon Kendra sub-redes.
As regras de saída do seu grupo de segurança devem permitir que o tráfego dos conectores da fonte de dados do Amazon Kendra acesse as sub-redes e a fonte de dados com a qual você vai sincronizar. Por exemplo, você pode usar um conector MySQL para sincronizar a partir de um banco de dados MySQL. Se você estiver usando a porta padrão, os grupos de segurança devem permitir o acesso Amazon Kendra à porta 3306 no host que executa o banco de dados.
Recomendamos que você configure um grupo de segurança padrão com os seguintes valores Amazon Kendra para uso:
+ **Regras de entrada**: se você optar por deixar em branco, todo o tráfego de entrada será bloqueado.
+ **Regras de saída** — adicione uma regra para permitir que todo o tráfego de saída Amazon Kendra possa iniciar as solicitações de sincronização a partir da sua fonte de dados.
+ **Versão IP** — IPv4
+ **Tipo**: todo o tráfego
+ **Protocolo**: todo o tráfego
+ **Alcance de portas**: todos
+ **Destino**: 0.0.0.0/0
Para obter mais informações sobre como configurar grupos Amazon VPC de segurança, consulte [Regras de grupos de segurança](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) no Guia do *usuário da Amazon VPC*.
## Etapa 3. Configure sua fonte de dados externa e Amazon VPC
Certifique-se de que sua fonte de dados externa tenha as configurações de permissões e de rede corretas Amazon Kendra para acessá-la. Você pode encontrar instruções detalhadas sobre como configurar suas fontes de dados na seção de pré-requisitos na página de cada conector.
Além disso, verifique suas Amazon VPC configurações e certifique-se de que sua fonte de dados externa possa ser acessada pela sub-rede à qual você atribuirá. Amazon Kendra Para fazer isso, recomendamos que você crie uma Amazon EC2 instância na mesma sub-rede com os mesmos grupos de segurança e teste o acesso à sua fonte de dados a partir dessa Amazon EC2 instância. Para obter mais informações, consulte [Solução de problemas de Amazon VPC conexão](https://docs.aws.amazon.com/kendra/latest/dg/vpc-connector-troubleshoot.html).
# Configurar uma fonte Amazon Kendra de dados à qual se conectar Amazon VPC
Conectando-se a Amazon VPC
Ao adicionar uma nova fonte de dados Amazon Kendra, você pode usar o Amazon VPC recurso se o conector da fonte de dados selecionado suportar esse recurso.
Você pode configurar uma nova fonte de Amazon Kendra dados Amazon VPC ativada usando a Console de gerenciamento da AWS ou a Amazon Kendra API. Especificamente, use a operação de API [https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) e, em seguida, o parâmetro `VpcConfiguration` para fornecer as seguintes informações:
+ `SubnetIds`— Uma lista de identificadores de sub-redes Amazon VPC
+ `SecurityGroupIds`— Uma lista de identificadores de grupos de Amazon VPC segurança
Se você usa o console, fornece as Amazon VPC informações necessárias durante a configuração do conector. Para usar o console para habilitar o atributo Amazon VPC para um conector, primeiro escolha uma Amazon VPC. Em seguida, forneça identificadores de todas as sub-redes e identificadores de grupos de segurança da Amazon VPC. Você pode escolher as sub-redes e os grupos de segurança da Amazon VPC que você criou em [Como configurar a Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/connector-vpc-steps.html) ou usar um que já exista.
**Topics**
+ [
## Visualizando Amazon VPC identificadores
](#viewing-vpc-identifiers)
+ [
## Verificando sua IAM função de fonte de dados
](#vpc-iam-roles)
## Visualizando Amazon VPC identificadores
Os identificadores para sub-redes e grupos de segurança são configurados no console. Amazon VPC Para visualizar os identificadores, use os seguintes procedimentos:
**Como visualizar identificadores de sub-rede**
1. Faça login no Console de gerenciamento da AWS e abra o console da Amazon VPC em. [https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/)
1. No painel de navegação, escolha **Sub-redes**.
1. Na lista de **sub-redes**, escolha a sub-rede que contém o servidor do banco de dados.
1. Na guia **Detalhes**, anote o identificador no campo **ID da sub-rede**.
**Como visualizar identificadores de grupos de segurança**
1. Faça login no Console de gerenciamento da AWS e abra o console da Amazon VPC em. [https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/)
1. No painel de navegação, escolha **Grupos de segurança**.
1. Na lista de grupo de segurança, escolha o grupo para o qual você deseja obter o identificador.
1. Na guia **Detalhes**, anote o identificador no campo **ID do grupo de segurança**.
## Verificando sua IAM função de fonte de dados
Certifique-se de que sua função de fonte de dados AWS Identity and Access Management IAM(conector) contenha permissões para acessar seu Amazon VPC.
Se você usar o console para criar uma nova função para sua IAM função, Amazon Kendra adicionará automaticamente as permissões corretas à sua IAM função em seu nome. Se você usa a API ou usa uma IAM função existente, verifique se sua função contém permissões de acesso Amazon VPC. Verifique se você tem as permissões corretas em [Perfis do IAM para a VPC](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-vpc).
É possível modificar uma fonte de dados existente para usar uma sub-rede diferente de Amazon VPC . No entanto, verifique a IAM função da fonte de dados e, se necessário, modifique-a para refletir a alteração para que o conector da fonte de Amazon Kendra dados funcione corretamente.
# Conectar um banco de dados em uma VPC
Conectar-se a um banco de dados
O exemplo a seguir mostra como conectar um banco de dados MySQL em execução em uma nuvem privada virtual (VPC). O exemplo pressupõe que você esteja começando com a VPC padrão e que precise criar um banco de dados MySQL. Se você já tem uma VPC, verifique se ela está configurada conforme mostrado. Caso tenha um banco de dados MySQL, você pode usá-lo em vez de criar um.
**Topics**
+ [
## Etapa 1: Configurar uma VPC
](#vpc-example-1)
+ [
## Etapa 2: criar e configurar grupos de segurança.
](#vpc-example-2)
+ [
## Etapa 3: criar um banco de dados
](#vpc-example-3)
+ [
## Etapa 4: criar um conector de fonte de dados
](#vpc-example-4)
## Etapa 1: Configurar uma VPC
Configure a VPC para obter uma sub-rede privada e um grupo de segurança para que o Amazon Kendra acesse um banco de dados MySQL em execução na sub-rede. As sub-redes fornecidas na configuração da VPC devem estar nas regiões Oeste dos EUA (Oregon), Leste dos EUA (Norte da Virgínia) ou Europa (Irlanda).
**Para configurar uma VPC usando Amazon VPC**
1. Faça login no Console de gerenciamento da AWS e abra o console da Amazon VPC em. [https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/)
1. No painel de navegação, escolha **Tabelas de rotas** e selecione **Criar tabela de rotas**.
1. No campo **Nome**, insira **Private subnet route table**. No menu suspenso **VPC**, selecione sua VPC e escolha **Criar tabela de rotas**. Para retornar à lista de tabelas, escolha **Fechar**.
1. No painel de navegação, escolha **NAT gateways** e **Criar NAT gateway**.
1. No menu suspenso **Sub-rede**, escolha a sub-rede pública. Anote o ID da sub-rede.
1. Se você não tiver um endereço IP elástico, escolha **Criar novo EIP**, **Criar um gateway NAT** e, em seguida, escolha **Fechar.**
1. No painel de navegação, escolha **Tabelas de rotas**.
1. Na lista da tabela de rotas, escolha a **tabela de rotas de sub-rede privada** que você criou na etapa 3. Em **Ações**, selecione **Editar rotas**.
1. Escolha **Adicionar rota**. Para destino, insira **0.0.0.0/0** para permitir todo o tráfego de saída para a internet. Em **Destino**, escolha **Gateway NAT** e, em seguida, escolha o gateway criado na etapa 4. Escolha **Salvar alterações** e **Fechar**.
1. No menu **Ações**, escolha **Editar associações de sub-redes**.
1. Escolha as sub-redes que você deseja que sejam privadas. Não escolha a sub-rede com o gateway NAT que você anotou anteriormente. Escolha **Salvar associações** ao concluir.
## Etapa 2: criar e configurar grupos de segurança.
Em seguida, configure os grupos de segurança para o banco de dados
**Como criar e configurar grupos de segurança**
1. Faça login no Console de gerenciamento da AWS e abra o console da Amazon VPC em. [https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/)
1. Na descrição da sua VPC, observe o IPv4 CIDR.
1. No painel de navegação, escolha **Grupos de segurança** e **Criar grupo de segurança**.
1. Em **Nome do grupo de segurança**, insira **DataSourceInboundSecurityGroup**. Forneça uma descrição e escolha a VPC na lista. Selecione **Criar grupo de segurança** e **Fechar**.
1. Escolha a guia **Regras de entrada**.
1. Selecione **Editar regras de entrada** e **Adicionar regra**.
1. Para banco de dados, insira o número da porta para **Intervalo de portas**. Por exemplo, para MySQL é **3306**, e para HTTPS é **443**. Em **Fonte**, insira o Encaminhamento Entre Domínios Sem Classificação (CIDR) da VPC. Escolha **Salvar regras** e escolha **Fechar**.
O grupo de segurança permite que qualquer pessoa dentro da VPC se conecte ao banco de dados e permite conexões de saída com a internet.
## Etapa 3: criar um banco de dados
Crie um banco de dados para armazenar os documentos ou use o banco de dados existente.
Consulte instruções sobre como criar um banco de dados MySQL em [https://docs.aws.amazon.com/kendra/latest/dg/data-source-mysql.html](https://docs.aws.amazon.com/kendra/latest/dg/data-source-mysql.html).
## Etapa 4: criar um conector de fonte de dados
Depois de configurar a VPC e criar o banco de dados, é possível criar um conector da fonte de dados para o banco de dados. Para obter informações sobre conectores de banco de dados que Amazon Kendra oferecem suporte, consulte [Conectores compatíveis](https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html).
Para o banco de dados, é necessário configurar a VPC, as sub-redes privadas criadas na VPC e o grupo de segurança também criado na VPC.
# Solução de problemas de conexão da VPC
Se você encontrar algum problema com sua conexão de nuvem privada virtual (VPC), verifique se IAM as permissões, as configurações do grupo de segurança e as tabelas de rotas da sub-rede estão configuradas corretamente.
Uma causa potencial de falha na sincronização do conector da fonte de dados é que a fonte de dados pode estar inacessível a partir da sub-rede à qual você atribuiu. Amazon Kendra Para solucionar esse problema, recomendamos que você crie uma Amazon EC2 instância com as mesmas Amazon VPC configurações. Em seguida, tente acessar a fonte de dados dessa Amazon EC2 instância usando chamadas da API REST ou outros métodos (com base no tipo específico da sua fonte de dados).
Se você acessar com êxito a fonte de dados da Amazon EC2 instância que você criou, isso significa que sua fonte de dados pode ser acessada por essa sub-rede. Portanto, seu problema de sincronização não está relacionado ao fato de sua fonte de dados estar inacessível pelo Amazon VPC.
Se você não conseguir acessar sua Amazon EC2 instância a partir da configuração da VPC e validá-la com a Amazon EC2 instância que você criou, precisará solucionar mais problemas. Por exemplo, se você tiver um Amazon S3 conector cuja sincronização falhou com erros sobre problemas de conexão, você pode configurar uma Amazon EC2 instância com a mesma Amazon VPC configuração que você atribuiu ao seu Amazon S3 conector. Depois, use essa instância do Amazon EC2 para testar se a Amazon VPC foi configurada corretamente.
Veja a seguir um exemplo de configuração de uma Amazon EC2 instância para solucionar problemas de Amazon VPC conexão com uma fonte de Amazon S3 dados.
**Topics**
+ [
## Etapa 1: executar uma Amazon EC2 instância
](#vpc-connector-troubleshoot-1)
+ [
## Etapa 2: conectar-se à Amazon EC2 instância
](#vpc-connector-troubleshoot-2)
+ [
## Etapa 3: testar o Amazon S3 acesso
](#vpc-connector-troubleshoot-3)
## Etapa 1: executar uma Amazon EC2 instância
1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon EC2 em. [https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/)
1. Selecione **Iniciar uma instância**.
1. Selecione **Configurações de rede**, **Editar** e faça o seguinte:
1. Escolha a mesma VPC e **sub-rede às quais você atribuiu**. Amazon Kendra
1. Em **Firewall (grupos de segurança)**, escolha **Selecionar grupo de segurança existente**. Em seguida, selecione o grupo de segurança ao qual você atribuiu Amazon Kendra.
**nota**
O grupo de segurança deve permitir o tráfego de saída para o Amazon S3.
1. Defina **Atribuição automática de IP público** como **Desativar**.
1. Na seção **Detalhes avançados**, faça o seguinte:
+ Em **Perfil de instância do IAM**, selecione **Criar novo perfil do IAM** para criar e anexar um perfil de IAM instância à sua instância. O perfil deve ter permissões para acessar o Amazon S3. Para obter mais informações, consulte [Como posso conceder acesso à minha Amazon EC2 instância a um Amazon S3 bucket?](https://repost.aws/knowledge-center/ec2-instance-access-s3-bucket) em AWS re:Post.
+ Deixe todas as outras configurações como o padrão.
1. Analise e execute a Amazon EC2 instância.
## Etapa 2: conectar-se à Amazon EC2 instância
Depois que sua Amazon EC2 instância estiver em execução, acesse a página de detalhes da instância e conecte-se à sua instância. Para isso, use as etapas em [Conectar-se às instâncias sem precisar de um endereço IPv4 público usando o EC2 Instance Connect Endpoint](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connect-with-ec2-instance-connect-endpoint.html) no *Guia do usuário do Amazon EC2 para instâncias do Linux*.
## Etapa 3: testar o Amazon S3 acesso
Depois de se conectar ao terminal da Amazon EC2 instância, execute um AWS CLI comando para testar a conexão dessa sub-rede privada com seu Amazon S3 bucket.
Para testar o Amazon S3 acesso, digite o seguinte AWS CLI comando no AWS CLI: `aws s3 ls`
Depois que o AWS CLI comando for executado, analise o seguinte:
+ Se você configurou IAM as permissões necessárias corretamente e sua Amazon S3 configuração está correta, você deve ver uma lista dos seus Amazon S3 buckets.
+ Se você ver erros de permissão`Access Denied`, como, é provável que sua configuração de VPC esteja correta, mas algo esteja errado com suas IAM permissões ou com sua política Amazon S3 de bucket.
Se o comando estiver atingindo o tempo limite, é provável que a conexão esteja expirando porque a configuração da VPC está incorreta e a instância do Amazon EC2 não pode acessar o Amazon S3 pela sub-rede. Reconfigure a VPC e tente novamente.