Amazon S3

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

  Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
  • List
  • Get
  • Create
  • Update
  • Delete

  Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Actions

Dans cette section, vous trouverez une liste non exhaustive des actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action CopyObject

Cette action vous permet de copier un objet d'un bucket vers un autre ou dans le même bucket.

Paramètres d'entrée de l'action CopyObject

Paramètres de sortie de l'action CopyObject

Si la copie aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action CopyObject, consultez Exemples d'actions.

Action DownloadObjects

Cette action récupère un ou plusieurs objets d'un bucket.

Paramètres d'entrée de l'action DownloadObjects

Paramètres de sortie de l'action DownloadObjects

Si le téléchargement aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action DownloadObjects, consultez Exemples d'actions.

Action UploadObject

Cette action permet d'importer un objet dans un bucket.

Paramètres d'entrée de l'action UploadObject

Paramètres de sortie de l'action UploadObject

Si l'importation de l'objet aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action UploadObject, consultez Exemples d'actions.

Action DeleteObject

Cette action permet de supprimer un objet d'un bucket.

Paramètres d'entrée de l'action DeleteObject

Paramètres de sortie de l'action DeleteObject

Si la suppression aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action DeleteObject, consultez Exemples d'actions.

Action MoveObject

Cette action permet aux utilisateurs de déplacer un objet existant d'un bucket spécifique vers un autre bucket ou dans le même bucket.

Paramètres d'entrée de l'action MoveObject

Paramètres de sortie de l'action MoveObject

Si l'opération de déplacement aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action MoveObject, consultez Exemples d'actions.

Action PutBucketAcl

Cette action permet de mettre à jour la liste de contrôle d'accès (LCA) d'un bucket.

Paramètres d'entrée de l'action PutBucketAcl

Paramètres de sortie de l'action PutBucketAcl

Si la mise à jour de la LCA du bucket aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action PutBucketAcl, consultez Exemples d'actions.

Action PutObjectAcl

Cette action permet de mettre à jour la liste de contrôle d'accès (LCA) d'un objet dans un bucket.

Paramètres d'entrée de l'action PutObjectAcl

Paramètres de sortie de l'action PutObjectAcl

Si la mise à jour de la LCA de l'objet aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action PutObjectAcl, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Copier un objet

Cet exemple copie un objet d'un bucket vers un autre.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CopyObject, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "pic.jpg",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "new_pic.jpg"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CopyObject aura une valeur semblable à la suivante :

[{
"Status": "Success"
}]

Exemple : Télécharger un objet

Cet exemple télécharge un objet à partir du bucket spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DownloadObjects, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Bucket": "aws-s3-bucket-source",
   "HasBytes": true
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DownloadObjects aura une valeur semblable à la suivante :

[{
"Success": "True",
"RemoteFile": "prefix1%2Faws-s3-bucket-source%2Finventory-test-1%2F2023-09-10T01-00Z%2Fmanifest.json",
"ContentBytes": "ewogICJzb3VyY2VCdWNrZXQiIDogImF3cy1zMy1idWNrZXQtYmNvbmUiLAogICJnOK"
},
{
"Success": "True",
"RemoteFile": "upload1.txt",
"ContentBytes": "VGhpcyBpcyBhIHRlc3RpbmcgZmlsZQ=="
}]

Exemple : Importer un objet

Cet exemple importe un objet dans le bucket spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UploadObject, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Bucket": "aws-s3-bucket-source",
   "FileName": "upload_1.txt",
   "Content": "This is a testing file",
   "AccessPolicy": "PUBLIC"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UploadObject aura une valeur semblable à la suivante :

[{
"Status": "success",
"bucket": "aws-s3-bucket-source",
"rss:title": "Object 'upload_1.txt' was created in the bucket: aws-s3-bucket-source",
"object": "upload_1.txt"
}]

Exemple : Supprimer un objet

Cet exemple supprime un objet du bucket spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DeleteObject, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Bucket": "aws-s3-bucket-source",
   "Object": "abc.png"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DeleteObject aura une valeur semblable à la suivante :

[{
"Status": "Success"
}]

Exemple : Déplacer un objet

Cet exemple déplace un objet d'un bucket à un autre.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action MoveObject, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "abc.png",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "moved.png"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche MoveObject aura une valeur semblable à la suivante :

[{
"Status": "Success"
}]

Exemple : Mettre à jour la LCA d'un bucket

Cet exemple met à jour les autorisations liées au contrôle des accès pour un bucket.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action PutBucketAcl, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "BucketSource": "aws-s3-bucket-source",
   "ACL": "public-read"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche PutBucketAcl aura une valeur semblable à la suivante :

[{
"Status": "Success"
}]

Exemple : Mettre à jour la LCA d'un objet

Cet exemple met à jour les autorisations liées au contrôle des accès pour un objet d'un bucket.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action PutObjectAcl, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Bucket": "aws-s3-bucket-source",
   "ACL": "aws-exec-read",
   "Key": "AWS_S3_BusinessCase_V2.xlsx"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche PutObjectAcl aura une valeur semblable à la suivante :

[{
"Status": "Success"
}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister les métadonnées de tous les objets

Cet exemple extrait les métadonnées de tous les objets de l'entité Object.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Object dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Indiquez toujours la valeur de la clause de filtre entre guillemets simples ('). Par exemple : Bucket='test-bucket'. Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques. Par exemple, Bucket='test-bucket' and OwnerId='b1ecc809ad8467088afb'.

Exemple : Récupérer les métadonnées d'un bucket

Cet exemple récupère les métadonnées du bucket ayant l'ID spécifié à partir de l'entité Bucket.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Bucket dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez demo_replication dans le champ Valeur par défaut.

   Ici, demo_replication est un ID de bucket unique dans l'entité Bucket.

Exemple : Créer un bucket

Cet exemple crée un bucket dans l'entité Bucket.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Bucket dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Bucket": "Demo1697528098686"
   }

   Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

   [{
   "Bucket": "Demo1697528098686"
   }]

Exemple : Supprimer un bucket

Cet exemple supprime le bucket ayant l'ID spécifié dans l'entité Bucket.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Bucket dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez demo1697528098686 dans le champ Valeur par défaut.