

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Intégration Amazon S3
<a name="s3-integration"></a>

Grâce à l'intégration d'Amazon S3 dans Amazon Quick, vous pouvez créer des bases de connaissances à partir de documents stockés dans des compartiments S3. Cette intégration prend en charge les fonctionnalités d'ingestion de données pour l'indexation et la recherche de contenu S3.

**Note**  
Ce guide couvre l'intégration de l'ingestion de données Amazon S3 pour la création de bases de connaissances. Pour les connecteurs d'action Amazon S3 qui exécutent des opérations Amazon S3 telles que le chargement, le téléchargement et la suppression de fichiers, consultez[AWS connecteurs d'action de maintenance](builtin-services-integration.md). Les actions Amazon S3 ne sont prises en charge que pour Quick Automate.

## Actions possibles
<a name="s3-integration-capabilities"></a>

Les utilisateurs d'Amazon S3 peuvent poser des questions sur le contenu stocké dans leurs compartiments Amazon S3. Par exemple, les utilisateurs peuvent se renseigner sur les principaux résultats des documents, rechercher des informations spécifiques dans plusieurs types de fichiers ou analyser des modèles de données.

L'intégration permet aux utilisateurs d'accéder rapidement aux informations contenues dans leur contenu Amazon S3 et de les comprendre, quels que soient l'emplacement ou le type de fichier. Il fournit également des détails contextuels tels que les dates de modification et les métadonnées des fichiers, ce qui contribue à une découverte plus efficace des informations et à une prise de décision plus éclairée.

## Avant de commencer
<a name="s3-integration-prerequisites"></a>

Avant de configurer l'intégration avec Amazon S3, assurez-vous de disposer des éléments suivants :
+ AWS compte avec accès Amazon S3.
+ Compartiment Amazon S3 contenant les documents à indexer.
+ Abonnement Amazon Quick Enterprise.
+ Autorisations nécessaires pour créer des intégrations Amazon S3.
+ Votre administrateur doit accorder à Amazon Quick l'accès aux compartiments Amazon S3 que vous souhaitez utiliser. Pour de plus amples informations, veuillez consulter [Accorder à Amazon Quick l'accès aux compartiments Amazon S3](s3-admin-setup.md#s3-grant-bucket-access).

**Note**  
L'accès entre comptes Amazon S3 n'est pris en charge que dans la même AWS région.

# Configuration d’administrateur
<a name="s3-admin-setup"></a>

Avant que les utilisateurs puissent créer des intégrations et des bases de connaissances Amazon S3, un administrateur Amazon Quick doit effectuer les tâches de configuration suivantes.

## Accorder à Amazon Quick l'accès aux compartiments Amazon S3
<a name="s3-grant-bucket-access"></a>

Accordez à Amazon Quick l'accès aux compartiments Amazon S3 dont votre organisation a besoin. Cela s'applique que les buckets se trouvent sur le même AWS compte ou sur un compte différent.

1. Dans la console d'administration Amazon Quick, sous **Autorisations**, sélectionnez **AWS les ressources**.

1. Sous **Autoriser l'accès et la découverte automatique pour ces ressources**, cochez la case **Amazon S3**.

1. Choisissez **Sélectionner les compartiments S3**.

1. Dans la boîte de dialogue **Select Amazon S3 buckets**, choisissez l'onglet correspondant à l'emplacement de votre bucket :
   + **Compartiments S3 liés à un compte Quick** : sélectionnez les compartiments dans la liste auxquels vous souhaitez qu'Amazon Quick accède. Les compartiments sélectionnés disposent d'autorisations en lecture seule par défaut.
   + **Compartiments S3 auxquels vous pouvez accéder AWS—** Pour les compartiments multicomptes, assurez-vous que le propriétaire du compte a autorisé votre compte. Choisissez **Utiliser un compartiment différent**, entrez le nom du compartiment, puis choisissez **Ajouter un compartiment S3**.

1. (Facultatif) Pour les buckets multi-comptes, sélectionnez **Restreindre l'accès au bucket au créateur de la base de connaissances** pour limiter l'accès afin que seul l'utilisateur qui crée la base de connaissances puisse utiliser le bucket.

1. Choisissez **Finish** (Terminer).

Les compartiments sélectionnés sont désormais accessibles aux utilisateurs lors de la création de la base de connaissances.

## Préparation de la configuration des rôles et des politiques IAM
<a name="s3-integration-authentication"></a>

L'intégration Amazon S3 utilise AWS l'authentification pour accéder à vos compartiments Amazon S3. Préparez la configuration de votre rôle et de votre politique IAM avant que les utilisateurs ne configurent l'intégration.

### Autorisations IAM requises
<a name="s3-integration-iam-permissions"></a>

Assurez-vous que votre AWS compte dispose des autorisations minimales suivantes pour le compartiment Amazon S3 :
+ `s3:GetObject`— Lit des objets depuis le compartiment.
+ `s3:ListBucket`— Répertoriez le contenu du bucket.
+ `s3:GetBucketLocation`— Obtenez des informations sur la région du bucket.
+ `s3:GetObjectVersion`— Récupère les versions des objets.
+ `s3:ListBucketVersions`— Répertorie les versions des compartiments.

### Configurer les autorisations du compartiment Amazon S3 pour l'accès entre comptes
<a name="s3-cross-account-bucket-policy"></a>

Si vous accédez aux compartiments Amazon S3 via un autre AWS compte, vous devez configurer les politiques IAM dans le compte source AWS .

**Pour configurer les autorisations du compartiment Amazon S3 pour l'accès entre comptes**

1. Connectez-vous à la console AWS de gestion du compte qui contient le compartiment Amazon S3.

1. Ouvrez la console Amazon S3 à l'adresse [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/).

1. Choisissez le bucket auquel vous souhaitez accorder l'accès.

1. Choisissez **Autorisations**, puis **Stratégie de compartiment**.

1. Ajoutez une politique de compartiment contenant les éléments suivants :
   + `Version`— Réglé sur « 2012-10-17"
   + `Statement`— Tableau contenant des déclarations de politique avec :
     + `Sid`— « Accès AllowQuickSuite S3 »
     + `Effect`— « Autoriser »
     + `Principal`— AWS ARN pour le rôle de service Amazon Quick dans votre compte. Par exemple, le principal devrait ressembler à ceci : ` "Principal": { "AWS": "arn:aws:iam::<quick_account_id>:role/service-role/aws-quicksight-service-role-v0" }`
     + `Action`— Tableau des autorisations Amazon S3 : s3 :GetObject, s3 :ListBucket, s3 :GetBucketLocation, s3 :GetObjectVersion, s3 : ListBucketVersions
     + `Resource`— « \$1 » (s'applique à la clé actuelle), le chemin du compartiment Amazon S3 doit ressembler à ce qui suit : `"Resource": [ "arn:aws:s3:::bucket_name"]`

1. Sélectionnez **Enregistrer les modifications**.

### Configurer les autorisations relatives aux clés KMS (si votre compartiment utilise le chiffrement)
<a name="s3-kms-permissions"></a>

Si votre compartiment Amazon S3 utilise le chiffrement AWS KMS, procédez comme suit.

**Pour configurer les autorisations clés KMS**

1. Ouvrez la console du service de gestion des AWS clés (AWS KMS) à l'adresse [https://console.aws.amazon.com/kms.](https://console.aws.amazon.com/kms)

1. Choisissez la clé KMS utilisée pour chiffrer votre compartiment Amazon S3.

1. Choisissez **Key policy (Stratégie de clé)**, puis **Edit (Modifier)**.

1. Ajoutez une déclaration à la politique clé avec les éléments structurels suivants :
   + `Sid` – "AllowQuickSuiteKMSAccess"
   + `Effect`— « Autoriser »
   + `Principal`— AWS ARN pour le rôle de service Amazon Quick dans votre compte. Par exemple, le principal devrait ressembler à ceci : ` "Principal": { "AWS": "arn:aws:iam::<quick_account_id>:role/service-role/aws-quicksight-service-role-v0" }`
   + `Action`— Tableau d'autorisations KMS : kms: Déchiffrer, kms: DescribeKey
   + `Resource`— « \$1 » (s'applique à la clé actuelle), le chemin du compartiment Amazon S3 doit ressembler à ce qui suit : `"Resource": [ "arn:aws:s3:::bucket_name"]`

1. Sélectionnez **Enregistrer les modifications**.

1. Attendez 2 à 3 minutes pour que les modifications de politique se propagent.

## Configurer l'accès VPC pour le connecteur Amazon S3 dans Amazon Quick
<a name="s3-vpc-support"></a>

Les autorisations VPC garantissent qu'Amazon Quick ne peut accéder à votre compartiment Amazon S3 que par le biais de connexions VPC ou de point de terminaison VPC sécurisées.

### Modification de politique requise
<a name="s3-vpc-required-policy"></a>

Ajoutez cette déclaration à votre politique d'accès au compartiment pour permettre à Amazon Quick d'accéder à votre compartiment via des points de terminaison VPC :

```
{
  "Sid": "Allow-Quick-access"		 	 	 ,
  "Principal": "arn:aws:iam::Quick Account:role/service-role/aws-quicksight-service-role-v0",
  "Action": "s3:*",
  "Effect": "Allow",
  "Resource": [
    "arn:aws:s3:::amzn-s3-demo-bucket",
    "arn:aws:s3:::amzn-s3-demo-bucket/*"
  ],
  "Condition": {
    "Null": {
      "aws:SourceVpce": "false"
    }
  }
}
```
+ `amzn-s3-demo-bucket`Remplacez-le par le nom de votre compartiment.
+ `Quick Account`Remplacez-le par votre compte Amazon Quick.

Cette `"aws:SourceVpce": "false"` condition garantit qu'Amazon Quick ne peut accéder à votre compartiment que via des points de terminaison VPC, tout en respectant vos exigences de sécurité.

### Politiques de refus
<a name="s3-vpc-deny-policies"></a>

Si votre compartiment dispose d'une politique qui restreint le trafic vers un VPC ou un point de terminaison VPC spécifique via une politique de refus, vous devez inverser cette politique car les politiques de refus ont priorité sur les politiques d'autorisation.

Par exemple :

```
{
   "Version":"2012-10-17"		 	 	 ,                   
   "Id": "Policy1415115909152",
   "Statement": [
     {
       "Sid": "Access-to-specific-VPCE-only",
       "Principal": "*",
       "Action": "s3:*",
       "Effect": "Deny",
       "Resource": ["arn:aws:s3:::amzn-s3-demo-bucket",
                    "arn:aws:s3:::amzn-s3-demo-bucket/*"],
       "Condition": {
         "StringNotEquals": {
           "aws:SourceVpce": "vpce-0abcdef1234567890"
         }
       }
     }
   ]
}
```

Doit être inversé en :

```
{
   "Version":"2012-10-17"		 	 	 ,                   
   "Id": "Policy1415115909152",
   "Statement": [
     {
       "Sid": "Access-to-specific-VPCE-only",
       "Principal": "*",
       "Action": "s3:*",
       "Effect": "Allow",
       "Resource": ["arn:aws:s3:::amzn-s3-demo-bucket",
                    "arn:aws:s3:::amzn-s3-demo-bucket/*"],
       "Condition": {
         "StringEquals": {
           "aws:SourceVpce": "vpce-0abcdef1234567890"
         }
       }
     }
   ]
}
```

### Bonnes pratiques
<a name="s3-vpc-best-practices"></a>

**Restreindre l'accès à votre rôle Amazon Quick**

Les politiques d'accès doivent garantir que l'appelant est l'ARN de votre rôle Amazon Quick ou, au minimum, votre compte Amazon Quick. Cela garantit que, malgré l'autorisation du trafic VPC, les appels proviennent uniquement des sources attendues.

### Recommandations en matière de sécurité
<a name="s3-vpc-security-recommendations"></a>
+ Limitez les politiques à votre rôle Amazon Quick pour un trafic plus sécurisé
+ Passez régulièrement en revue vos politiques relatives aux compartiments pour vous assurer qu'elles respectent le principe du moindre privilège

## Restreindre l'accès au compartiment Amazon S3 avec des attributions de politiques IAM
<a name="s3-restrict-bucket-access"></a>

Vous pouvez contrôler les compartiments Amazon S3 que vos utilisateurs Amazon Quick peuvent utiliser pour créer des bases de connaissances en créant des politiques IAM et en les attribuant à des utilisateurs spécifiques, à des groupes ou à tous les utilisateurs via les attributions de politiques Amazon Quick IAM. Cela vous permet de limiter les personnes autorisées à créer des bases de connaissances par rapport à des compartiments spécifiques, y compris les bases de connaissances compatibles ACL.

**Note**  
Les politiques IAM attribuées via Amazon Quick ont priorité sur les politiques au niveau des AWS ressources. Pour vous assurer que vos exigences d'accès sont satisfaites, configurez vos politiques IAM de manière appropriée.

Par exemple, vous pouvez attribuer une politique restrictive à des utilisateurs spécifiques qui ont besoin d'accéder à des compartiments compatibles ACL, tout en assignant une politique plus large à tous les utilisateurs pour les compartiments non ACL.

### Étape 1 : créer une politique d'accès Amazon S3 dans IAM
<a name="s3-create-iam-policy"></a>

Créez une politique IAM dans la console AWS IAM qui définit les compartiments Amazon S3 auxquels les utilisateurs peuvent accéder pour créer une base de connaissances. L'exemple de politique suivant accorde l'accès à deux compartiments spécifiques :

```
{
    "Version": "2012-10-17"		 	 	 ,
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "s3:ListAllMyBuckets",
            "Resource": "arn:aws:s3:::*"
        },
        {
            "Action": [
                "s3:ListBucket"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:s3:::amzn-s3-demo-bucket-1",
                "arn:aws:s3:::amzn-s3-demo-bucket-2"
            ]
        },
        {
            "Action": [
                "s3:GetObject",
                "s3:GetObjectVersion"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:s3:::amzn-s3-demo-bucket-1/*",
                "arn:aws:s3:::amzn-s3-demo-bucket-2/*"
            ]
        },
        {
            "Action": [
                "s3:ListBucketMultipartUploads",
                "s3:GetBucketLocation"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:s3:::amzn-s3-demo-bucket-1",
                "arn:aws:s3:::amzn-s3-demo-bucket-2"
            ]
        },
        {
            "Action": [
                "s3:PutObject",
                "s3:AbortMultipartUpload",
                "s3:ListMultipartUploadParts"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:s3:::amzn-s3-demo-bucket-1/*",
                "arn:aws:s3:::amzn-s3-demo-bucket-2/*"
            ]
        }
    ]
}
```

Remplacez `amzn-s3-demo-bucket-1` et `amzn-s3-demo-bucket-2` par les noms des compartiments Amazon S3 auxquels vous souhaitez accorder l'accès.

### Étape 2 : attribuer la politique dans Amazon Quick
<a name="s3-assign-iam-policy"></a>

Après avoir créé la politique IAM, attribuez-la aux utilisateurs ou aux groupes Amazon Quick.

1. Dans la console d'administration Amazon Quick, sous **Autorisations**, choisissez les **attributions de politiques IAM**.

1. Choisissez **Ajouter une nouvelle mission**.

1. Entrez le nom de l'assignation.

1. Sur la page **Sélectionnez une stratégie IAM**, recherchez et sélectionnez la stratégie IAM que vous avez créée à l'étape 1. Choisissez **Suivant**.

1. Sur la page **Attribuer des utilisateurs et des groupes**, sélectionnez l'une des options suivantes :
   + Sélectionnez **Attribuer à tous les utilisateurs et groupes** pour appliquer la politique à tous les utilisateurs actuels et futurs.
   + Recherchez et sélectionnez des utilisateurs ou des groupes spécifiques auxquels attribuer la politique.

   Choisissez **Suivant**.

1. Sur la page **Vérifier et activer les modifications**, vérifiez les détails de votre affectation et choisissez **Enregistrer et activer**.

Les utilisateurs auxquels l'accès n'est pas explicitement accordé par le biais d'une attribution de politique IAM ne pourront pas accéder aux compartiments Amazon S3 restreints pour créer des intégrations ou des bases de connaissances.

# Au niveau du document ACLs
<a name="s3-acl"></a>

Vous pouvez activer les listes de contrôle d'accès (ACLs) au niveau de la base de connaissances Amazon S3 en utilisant l'une des deux méthodes de configuration, chacune optimisée pour différents cas d'utilisation.

**Important**  
La configuration de l'ACL au niveau du document est permanente. Vous ne pouvez pas ACLs l'activer sur les bases de connaissances créées sans le support ACL, et vous ne pouvez pas le désactiver ACLs une fois activé. Pour modifier la configuration de l'ACL, créez une nouvelle base de connaissances avec les paramètres souhaités dès le départ.

**Note**  
Pour les bases de connaissances compatibles ACL, les documents sans entrée ACL associée ne sont pas ingérés. Assurez-vous que chaque document possède une ACL définie soit dans le fichier ACL global, soit dans son fichier de métadonnées.

**Fichier de configuration ACL global**  
Créez un fichier centralisé unique qui définit les autorisations d'accès au niveau du dossier. Cela fournit un moyen simplifié de gérer les autorisations dans de grandes hiérarchies de documents. Cette méthode est idéale pour les organisations dotées de structures d'autorisation stables. Toute modification apportée au fichier global nécessite de réindexer l'intégralité du préfixe concerné, ce qui peut prendre des heures pour les bases de connaissances contenant des dizaines de millions de documents. Pour le format de fichier, consultez [Structure de fichier ACL globale](#s3-global-acl).

**Fichiers de métadonnées au niveau du document**  
Chaque document possède son propre fichier de métadonnées contenant des informations de contrôle d'accès spécifiques. Cette approche vous oblige à créer et à gérer des fichiers de métadonnées individuels pour chaque document. Il permet des mises à jour d'index nettement plus rapides lorsque les autorisations changent, car seuls les documents concernés doivent être réindexés plutôt que les structures de dossiers complètes. Pour plus d'informations sur la configuration ACLs dans les fichiers de métadonnées, consultez[Métadonnées du document](s3-metadata.md).

Choisissez la méthode qui répond le mieux à vos besoins opérationnels : gestion centralisée avec le fichier ACL global pour une administration simplifiée, ou fichiers de métadonnées au niveau du document pour des mises à jour plus rapides des autorisations et un contrôle plus précis.

Maintenez le niveau de votre document à ACLs jour en mettant régulièrement à jour la configuration de l'ACL Amazon S3 afin de répondre aux exigences d'accès de votre organisation. Pour plus d'informations sur les meilleures pratiques courantes, consultez[Bonnes pratiques de gestion ACLs dans les bases de connaissances](acl-best-practices-kb.md).

## Structure de fichier ACL globale
<a name="s3-global-acl"></a>

Le fichier global fournit une gestion centralisée du contrôle d'accès au niveau des dossiers. Chaque entrée du fichier fait correspondre un préfixe de clé Amazon S3 à un ensemble d'entrées ACL qui s'appliquent à tous les documents sous ce préfixe.

Le fichier ACL json global utilise la structure suivante :

```
[
    {
        "keyPrefix": "s3://BUCKETNAME/prefix1/",
        "aclEntries": [
            {
                "Name": "user1@example.com",
                "Type": "USER",
                "Access": "ALLOW"
            },
            {
                "Name": "group1",
                "Type": "GROUP",
                "Access": "DENY"
            }
        ]
    },
    {
        "keyPrefix": "s3://BUCKETNAME/prefix1/document_1.txt",
        "aclEntries": [
            {
                "Name": "user1@example.com",
                "Type": "USER",
                "Access": "ALLOW"
            },
            {
                "Name": "group1",
                "Type": "GROUP",
                "Access": "DENY"
            }
        ]
    },
    {
        "keyPrefix": "s3://BUCKETNAME/prefix2/",
        "aclEntries": [
            {
                "Name": "user2@example.com",
                "Type": "USER",
                "Access": "ALLOW"
            },
            {
                "Name": "user1@example.com",
                "Type": "USER",
                "Access": "DENY"
            },
            {
                "Name": "group1",
                "Type": "GROUP",
                "Access": "DENY"
            }
        ]
    }
]
```

Chaque entrée du tableau contient les champs suivants :

`keyPrefix`  
Le préfixe de chemin Amazon S3 auquel s'appliquent les entrées ACL. Tous les documents dotés de ce préfixe héritent des autorisations spécifiées.

`aclEntries`  
Un tableau d'entrées de contrôle d'accès, chacune contenant les champs suivants :  
+ `Name`— Pour le `USER` type, l'adresse e-mail de l'utilisateur dans Quick. Pour le `GROUP` type, le nom du groupe dans Quick.
+ `Type` – Soit `USER` ou `GROUP`.
+ `Access` – Soit `ALLOW` ou `DENY`.

# Métadonnées du document
<a name="s3-metadata"></a>

Vous pouvez ajouter des métadonnées aux documents de votre compartiment Amazon S3 afin de personnaliser les résultats du chat et de contrôler l'accès au niveau des documents. Les métadonnées sont des informations supplémentaires sur un document, telles que son titre, sa date de création et ses autorisations d'accès.

Amazon Quick prend en charge l'attribution des sources par le biais de citations. Si vous spécifiez le champ de `_source_uri` métadonnées, les liens d'attribution de source dans les résultats du chat dirigent les utilisateurs vers l'URL configurée. Si vous ne spécifiez pas un`_source_uri`, les utilisateurs peuvent toujours accéder aux documents sources via des liens de citation cliquables qui téléchargent le fichier au moment de la requête.

## Emplacement des métadonnées du document
<a name="s3-metadata-location"></a>

Dans Amazon S3, chaque fichier de métadonnées peut être associé à un document indexé. Vos fichiers de métadonnées doivent être stockés dans le même compartiment Amazon S3 que vos fichiers indexés. Vous pouvez spécifier un emplacement dans le compartiment Amazon S3 pour vos fichiers de métadonnées lors de la configuration de votre intégration Amazon S3 dans Amazon Quick.

Si vous ne spécifiez pas de préfixe Amazon S3, vos fichiers de métadonnées doivent être stockés au même endroit que vos documents indexés. Si vous spécifiez un préfixe Amazon S3 pour vos fichiers de métadonnées, ceux-ci doivent figurer dans une structure de répertoire parallèle à celle de vos documents indexés. Amazon Quick recherche uniquement vos métadonnées dans le répertoire indiqué. Si les métadonnées ne sont pas lues, vérifiez que l’emplacement du répertoire correspond à celui de vos métadonnées.

Les exemples suivants illustrent la manière dont l’emplacement du document indexé est mappé à l’emplacement du fichier de métadonnées. La clé Amazon S3 du document est ajoutée au préfixe Amazon S3 des métadonnées, puis suffixée `.metadata.json` pour former le chemin Amazon S3 du fichier de métadonnées.

**Note**  
La clé Amazon S3 combinée, le préfixe Amazon S3 des métadonnées et le `.metadata.json` suffixe ne doivent pas comporter plus de 1 024 caractères au total. Nous recommandons que votre clé Amazon S3 comporte moins de 1 000 caractères afin de prendre en compte les caractères supplémentaires lorsque vous combinez votre clé avec le préfixe et le suffixe.

**Example Exemple 1 : aucun chemin de métadonnées spécifié**  

```
Bucket name:
     s3://bucketName
Document path:
     documents
Metadata path:
     none
File mapping
     s3://bucketName/documents/file.txt -> 
        s3://bucketName/documents/file.txt.metadata.json
```

**Example Exemple 2 : chemin de métadonnées spécifié**  

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

## Structure des métadonnées du document
<a name="s3-metadata-structure"></a>

Vous définissez les métadonnées de votre document elles-mêmes dans un fichier JSON. Le fichier doit être un fichier texte UTF-8 sans marqueur BOM. Le nom du fichier JSON doit être `<document>.<extension>.metadata.json`. Dans cet exemple, `document` il s'agit du nom du document auquel s'appliquent les métadonnées et `extension` de l'extension de fichier du document. L’ID de document doit être unique dans `<document>.<extension>.metadata.json`.

Le contenu du fichier JSON utilise le modèle suivant :

```
{
    "DocumentId": "document ID",
    "Attributes": {
        "_authors": ["author of the document"],
        "_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
    },
    "AccessControlList": [
        {
            "Name": "user1@example.com",
            "Type": "GROUP | USER",
            "Access": "ALLOW | DENY"
        }
    ],
    "Title": "document title",
    "ContentType": "PDF | HTML | MS_WORD | PLAIN_TEXT | PPT | RTF | XML | XSLT | MS_EXCEL | CSV | JSON | MD"
}
```

Si vous indiquez un chemin de métadonnées, assurez-vous que la structure du répertoire de métadonnées correspond exactement à celle du fichier de données.

Par exemple, si l’emplacement du fichier de données est dans `s3://bucketName/documents/legal/file.txt`, l’emplacement du fichier de métadonnées doit être à `s3://bucketName/metadata/documents/legal/file.txt.metadata.json`.

Tous les attributs et champs sont facultatifs, il n’est donc pas nécessaire d’inclure tous les attributs. Cependant, vous devez fournir une valeur pour chaque attribut que vous souhaitez inclure ; la valeur ne peut pas être vide.

Les champs de métadonnées `_created_at` et `_last_updated_at` sont des dates codées ISO 8601. Par exemple, 2012-03-25T12:30:10\$101:00 est le format de date et d’heure ISO 8601 pour le 25 mars 2012 à 12 h 30 (plus 10 secondes) dans le fuseau horaire de l’heure d’Europe centrale.

Le `AccessControlList` champ est un tableau facultatif qui définit le contrôle d'accès au niveau du document. Chaque entrée du tableau contient les champs suivants :
+ `Name`— Pour le `USER` type, l'adresse e-mail de l'utilisateur dans Quick. Pour le `GROUP` type, le nom du groupe dans Quick.
+ `Type` – Soit `USER` ou `GROUP`.
+ `Access` – Soit `ALLOW` ou `DENY`.

**Note**  
Pour utiliser ce `AccessControlList` champ, vous devez activer le niveau du document ACLs lors de la création de la base de connaissances. Pour de plus amples informations, veuillez consulter [Au niveau du document ACLs](s3-acl.md).

# Configuration et gestion de l'intégration avec Amazon S3
<a name="s3-setup-manage"></a>

## Configuration de l'intégration avec Amazon S3
<a name="s3-integration-setup"></a>

Une fois que votre administrateur a terminé les tâches de configuration, suivez ces étapes pour créer votre base de connaissances Amazon S3.

1. Dans la console Amazon Quick, choisissez **Integrations.**

1. Sous **Amazon S3**, choisissez **Ajouter** (le bouton plus **\$1**).

1. Sur la page du **compartiment Connect S3**, choisissez votre source de données :
   + Pour réutiliser une source de données Amazon S3 existante, sélectionnez-la dans le menu déroulant. Choisissez ensuite **Next** pour passer à l'étape des détails de la base de connaissances.
   + Pour connecter un nouveau compartiment Amazon S3, choisissez **\$1 Ajouter un compte** dans la liste déroulante.

1. Si vous connectez un nouveau bucket, renseignez les informations de connexion :
   + **Nom : nom** descriptif de votre intégration Amazon S3.
   + **Emplacement du compartiment S3** : choisissez le **compte d'instance Quick Suite** pour accéder aux compartiments Amazon S3 dans le même AWS compte où Amazon Quick est activé, ou choisissez **Autre AWS compte** pour accéder aux compartiments d'un autre compte.
   + **URL du compartiment S3** : chemin du compartiment Amazon S3 contenant vos documents. Votre compartiment Amazon S3 doit se trouver dans la même région que votre région Amazon Quick.

   Choisissez **Suivant**. Le système valide votre configuration. Si des erreurs se produisent, consultez le message d'erreur pour connaître les étapes de correction spécifiques.
**Note**  
Si vous recevez une erreur d'accès, contactez votre administrateur pour vérifier que votre utilisateur dispose des autorisations requises pour le compartiment Amazon S3.

1. Sur la page **Créer une base de connaissances**, effectuez les opérations suivantes :
   + **Nom** : entrez un nom descriptif pour votre base de connaissances.
   + **Description** — Décrivez l'objectif de cette base de connaissances (facultatif).
   + **Contenu** : choisissez **Ajouter tout le contenu** pour synchroniser tout ce qui se trouve dans le compartiment, ou choisissez **Ajouter un contenu spécifique** pour spécifier les préfixes S3 pour les dossiers et les fichiers que vous souhaitez inclure. Les filtres font la distinction majuscules/minuscules.

1. Choisissez **Next : paramètres supplémentaires** pour configurer les options ACL et de métadonnées, ou choisissez **Create** pour créer la base de connaissances avec les paramètres par défaut.

1. Sur la page **Paramètres supplémentaires**, configurez la gestion des ACL et les métadonnées :
**Important**  
La décision d'activer ou de désactiver ACLs doit être prise lors de la création de la base de connaissances. Vous ne pouvez pas modifier cette option après cette étape. Pour plus d'informations sur ACLs, voir[Au niveau du document ACLs](s3-acl.md).
   + Pour activer le niveau du document ACLs, sélectionnez **Contrôler l'accès aux documents** avec. ACLs Lorsque cette option est activée, les options suivantes apparaissent :
     + **Emplacement du fichier ACL global** — Entrez le chemin Amazon S3 vers votre fichier ACL global (par exemple acl.json) si vous utilisez un fichier de configuration ACL global pour une gestion centralisée du contrôle d'accès au niveau des dossiers.
     + **Emplacement du dossier des fichiers de métadonnées** : entrez le chemin Amazon S3 vers votre dossier de métadonnées si vous utilisez des fichiers de métadonnées au niveau du document qui incluent des entrées ACL.
     + Si vos fichiers de métadonnées utilisent la méthode des sidecars (stockés dans le même dossier que les documents originaux), vous pouvez laisser les deux champs vides.
   + Vous pouvez éventuellement spécifier l'**emplacement d'un dossier de fichiers de métadonnées** même si ACLs cette option n'est pas activée.

1. Choisissez **Créer**.

Une fois que vous avez choisi Créer, la synchronisation des données démarre automatiquement.

## Gérer les bases de connaissances
<a name="s3-integration-knowledge-base"></a>

Après avoir configuré votre intégration Amazon S3, vous pouvez créer et gérer des bases de connaissances à partir de votre contenu Amazon S3.

### Modifier les bases de connaissances existantes
<a name="s3-edit-knowledge-base"></a>

Vous pouvez modifier vos bases de connaissances Amazon S3 existantes :

1. Dans la console Amazon Quick, sélectionnez **Knowledge bases**.

1. Sélectionnez votre base de connaissances Amazon S3 dans la liste.

1. Cliquez sur l'icône à trois points sous **Actions**, puis sélectionnez **Modifier la base de connaissances**.

1. Mettez à jour vos paramètres de configuration selon vos besoins et choisissez **Enregistrer**.

### Création de bases de connaissances supplémentaires
<a name="s3-create-additional-knowledge-base"></a>

Vous pouvez créer plusieurs bases de connaissances à partir de la même intégration Amazon S3 :

1. Dans la console Amazon Quick, choisissez **Integrations**, puis sélectionnez l'onglet **Data**.

1. Choisissez votre intégration Amazon S3 existante dans la liste.

1. Cliquez sur l'icône à trois points sous **Actions**, puis choisissez **Créer une base de connaissances**.

1. Configurez les paramètres de votre base de connaissances et choisissez **Create**.

Pour des informations détaillées sur les options de configuration de la base de connaissances, consultez[Paramètres de configuration courants](knowledge-base-integrations.md#common-configuration-settings).

**Note**  
Lorsque vous créez une base de connaissances dans Amazon Quick, par défaut, vous êtes le seul à pouvoir obtenir des informations à partir de cette base de connaissances. Pour le contenu partagé, vous pouvez donner accès à différents utilisateurs et groupes en mettant à jour les autorisations de la base de connaissances. Pour contrôler l'accès au niveau des documents au sein d'une base de connaissances, voir. [Au niveau du document ACLs](s3-acl.md)

# Résolution des problèmes d'intégration d'Amazon S3
<a name="s3-integration-troubleshooting"></a>

Si vous rencontrez des problèmes pour vous connecter à votre compartiment Amazon S3, examinez les causes courantes et les solutions suivantes.

## Documents n'apparaissant pas dans la base de connaissances activée par ACL
<a name="s3-troubleshooting-acl-documents-missing"></a>

**Problème :** les documents ne sont pas intégrés dans une base de connaissances compatible ACL.

**Solution :** Pour les bases de connaissances compatibles ACL, les documents sans entrée ACL associée ne sont pas ingérés. Vérifiez que chaque document possède une ACL définie soit par le biais du fichier ACL global, soit dans son fichier de métadonnées. Pour de plus amples informations, veuillez consulter [Au niveau du document ACLs](s3-acl.md).

## Accès entre comptes non configuré
<a name="s3-troubleshooting-cross-account"></a>

**Problème :** Votre administrateur n'a pas autorisé l'accès aux compartiments Amazon S3 à partir d'autres AWS comptes dans Amazon Quick.

**Solution :** demandez à votre administrateur d'accorder un accès multicompte à Amazon S3. Pour de plus amples informations, veuillez consulter [Accorder à Amazon Quick l'accès aux compartiments Amazon S3](s3-admin-setup.md#s3-grant-bucket-access).

## Le compartiment ne figure pas dans la liste approuvée
<a name="s3-troubleshooting-bucket-not-approved"></a>

**Problème :** Le bucket auquel vous essayez d'accéder n'a pas été autorisé par votre administrateur.

**Solution :**
+ Vérifiez que le nom du compartiment est correctement orthographié.
+ Vérifiez auprès de votre administrateur que le bucket est inclus dans la liste approuvée.
+ Demandez à votre administrateur d'ajouter le bucket à la liste des buckets autorisés si nécessaire.

## Autorisations IAM insuffisantes
<a name="s3-troubleshooting-iam-permissions"></a>

**Problème :** votre rôle ou utilisateur IAM ne dispose pas des autorisations nécessaires pour accéder au compartiment Amazon S3.

**Solution :**
+ Vérifiez que votre politique IAM inclut les autorisations Amazon S3 requises :
  + `s3:GetObject`
  + `s3:ListBucket`
  + `s3:GetBucketLocation`
  + `s3:GetObjectVersion`
  + `s3:ListBucketVersions`
+ Vérifiez vos propres compartiments pour détecter toute déclaration de refus explicite susceptible de bloquer l'accès.

**Note**  
L'ARN `arn:aws:iam::account-id:role/service-role/aws-quicksight-service-role-v0` est le rôle de service par défaut utilisé lorsqu'aucun rôle personnalisé n'a été créé. S'il existe un rôle de service personnalisé, contactez votre administrateur pour obtenir l'ARN du rôle de service personnalisé et utilisez-le à la place de l'ARN par défaut.

## Restrictions interrégionales
<a name="s3-troubleshooting-cross-region"></a>

**Problème :** Le compartiment Amazon S3 se trouve dans une AWS région différente de celle de votre compte ou service Amazon Quick.

**Solution :**
+ Vérifiez que la région du compartiment correspond à votre région de service Amazon Quick.
+ Vérifiez la région du bucket à l'aide de la AWS CLI : `aws s3api get-bucket-location --bucket bucket-name`
+ Utilisez un bucket situé dans la même région que votre service.

## Étapes de dépannage supplémentaires
<a name="s3-troubleshooting-additional-steps"></a>
+ **Testez l'accessibilité du bucket à l'**aide de la AWS CLI :

  ```
  aws s3 ls s3://bucket-name --profile your-profile
  ```
+ **Consultez CloudTrail les journaux** pour détecter AccessDenied les erreurs afin d'identifier le problème d'autorisation spécifique.
+ **Vérifiez les paramètres de blocage de l'accès public d'Amazon S3**. Bien qu'ils n'affectent généralement pas l'accès authentifié, vérifiez qu'ils n'interfèrent pas avec votre cas d'utilisation spécifique.
+ **Vérifiez la propriété du bucket** : assurez-vous que le bucket existe et que vous avez le bon nom de bucket.

# Limitations
<a name="s3-limitations"></a>

Lorsque vous utilisez les intégrations Amazon S3 dans Amazon Quick, tenez compte des limites suivantes :
+ Le compartiment Amazon S3 doit se trouver dans la même AWS région que votre application Amazon Quick.
+ Chaque document peut comporter un maximum de 2 500 entrées ACL individuelles ou de groupes.
+ Taille maximale du fichier de configuration ACL globale : 100 Mo.
+ Taille maximale du fichier de métadonnées du document : 5 Mo.

Pour plus d'informations sur les limites des ACL au niveau du document, consultez. [Limitations](acl-best-practices-kb.md#acl-limitations)