Extension Amazon S3

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation Apigee X. info

Version : 2.0.1

Gérez les fichiers dans un bucket Amazon S3. Cette extension vous permet de lister, de télécharger et de supprimer des fichiers. Vous pouvez également générer une URL signée pour télécharger un fichier.

Chaque instance configurée de cette extension fonctionne avec un bucket spécifique. Pour plusieurs buckets, utilisez une instance configurée de cette extension pour chaque bucket.

Prérequis

Avant d'utiliser l'extension à partir d'un proxy d'API à l'aide de la règle ExtensionCallout, vous devez :

• Obtenez l'ID de clé d'accès et la clé d'accès secrète pour le bucket Amazon S3 que vous allez utiliser.

Vous en aurez besoin, ainsi que du nom du bucket AWS et de la région AWS, pour configurer cette extension.

À propos d'Amazon S3

Amazon Simple Storage Service (Amazon S3) est un service de stockage d'objets.

Actions

deleteFile

Supprime le fichier spécifié d'un bucket S3.

<Action>deleteFile</Action>
<Input><![CDATA[
{
  "fileName" : "name-of-file-to-delete"
}
]]>
</Input>

<Action>deleteFile</Action>
<Input><![CDATA[
{
  "fileName" : "names.tmp"
}
]]>
</Input>

Paramètres de requête

Réponse

Aucune.

Propriétés de la réponse

Aucune.

downloadFile

Télécharge le fichier spécifié à partir d'un bucket S3.

<Action>downloadFile</Action>
<Input><![CDATA[
{
  "fileName" : "filename"
}
]]>
</Input>
<Output>flow-variable</Output>

<Action>downloadFile</Action>
<Input><![CDATA[
{
  "fileName" : "product-sheet.pdf"
}
]]>
</Input>
<Output>downloaded.file</Output>

Paramètres de requête

Réponse

JSON avec une propriété content contenant le contenu du fichier.

{
  "content":"Hello World!"
}

Propriétés de la réponse

generateSignedURL

Génère une URL signée pour télécharger le fichier spécifié à partir d'un bucket S3.

<Action>generateSignedURL</Action>
<Input><![CDATA[
{
  "fileName": "filename",
  "expiresIn": duration-in-seconds
}
]]>
</Input>
<Output>flow-variable</Output>

<Action>generateSignedURL</Action>
<Input><![CDATA[
{
  "fileName": "product-info.pdf",
  "expiresIn": 3600
}
]]>
</Input>
<Output>download.url</Output>

Paramètres de requête

Réponse

JSON avec une propriété de chaîne url contenant l'URL générée.

{
  "url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}

Propriétés de la réponse

listFiles

Appelle l'exécution d'une fonction AWS Lambda.

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>

Vous devez spécifier parsed="false" dans l'élément <Output> si vous souhaitez que la variable contienne le code JSON brut. Sinon, la variable ne peut pas être utilisée.

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output parsed="false">listFilesOutput</Output>

Paramètres de requête

Aucune.

Réponse

Tableau de noms de fichiers S3.

["hello_world.txt"]

Propriétés de la réponse

Aucune.

Documentation de référence sur la configuration

Utilisez les éléments suivants lorsque vous configurez et déployez cette extension pour l'utiliser dans des proxys d'API. Pour savoir comment configurer une extension à l'aide de la console Apigee, consultez Ajouter et configurer une extension.

Propriétés d'extension courantes

Les propriétés suivantes sont présentes pour chaque extension.

Propriétés de ce package d'extension

Spécifiez les valeurs des propriétés de configuration suivantes, spécifiques à cette extension.