Exporter des fichiers vers Amazon S3

🤖/s3/store exporte les résultats d’encodage vers Amazon S3.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "UploadAndAbortWithinPrefix",
      "Effect": "Allow",
      "Action": ["s3:PutObject", "s3:AbortMultipartUpload"],
      "Resource": "arn:aws:s3:::{BUCKET_NAME}/uploads/*"
    }
  ]
}

Exemple d’utilisation

{
  "steps": {
    "exported": {
      "credentials": "YOUR_AWS_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}",
      "robot": "/s3/store",
      "use": ":original"
    }
  }
}

Paramètres

• interpolate

  boolean | Record<string, boolean>

  Détermine si les Assembly Variables sont interpolées pour chaque champ d’instruction.

  Par défaut, la plupart des champs d’instruction des Robots interpolent les Assembly Variables. Définissez ce paramètre sur false pour traiter tous les champs d’instruction comme du texte littéral, ou définissez le chemin d’un champ individuel sur false pour traiter uniquement ce champ comme du texte littéral. Pour les champs propres à un Robot qui sont littéraux par défaut, définissez ce paramètre sur true ou définissez le chemin de ce champ sur true pour réactiver l’interpolation.

  Utilisez des noms de champs tels que path, ou des chemins avec points tels que ffmpeg.vf pour les objets imbriqués.

• output_meta

  Record<string, boolean> | boolean | Array<string>

  Permet de spécifier un ensemble de métadonnées dont le calcul est plus coûteux en puissance CPU et qui sont donc désactivées par défaut afin que le traitement de vos Assemblies reste rapide.

  Pour les images, vous pouvez ajouter "has_transparency": true dans cet objet pour déterminer si l’image contient des parties transparentes, et "dominant_colors": true pour extraire de l’image un tableau de codes couleur hexadécimaux.

  Pour les images, vous pouvez également ajouter "blurhash": true pour extraire une chaîne BlurHash⁠ — une représentation compacte d’un espace réservé pour l’image, utile pour afficher un aperçu flou pendant le chargement de l’image complète.

  Pour les images, "thumbhash": true extrait plutôt un ThumbHash⁠ encodé en base64 dans meta.thumbhash, accompagné de meta.has_alpha (qui indique si un canal alpha existe, même lorsque l’image est entièrement opaque). Il décrit les pixels orientés selon les données EXIF et utilise la première image des images animées. L’extraction est effectuée au mieux : les images de plus de 40 mégapixels, les formats non pris en charge ou un décodage échoué ou limité ne produisent aucun espace réservé. Une extraction réussie ajoute des frais de métadonnées équivalents à 20 % des octets de ce fichier. Aucun supplément ThumbHash ne s’applique lorsque l’option est désactivée ou lorsqu’aucun hash n’est produit.

  Définissez cette option sur le Step qui produit l’image, par exemple /upload/handle pour les originaux téléversés ou /image/resize pour les sorties traitées. La définir uniquement sur /transloadit/store ne déclenche pas l’extraction : le stockage conserve les métadonnées du Step producteur. Transloadit Storage conserve un hash généré avec sa version immuable et le renvoie dans les résultats stockés et lors des lectures natives de ressources. Les téléversements directs vers S3 ne génèrent pas d’espaces réservés. Un espace réservé contient des informations sur l’image : protégez-le donc avec les mêmes contrôles d’accès que l’image complète.

  Pour les vidéos, vous pouvez ajouter le paramètre "colorspace": true pour extraire l’espace colorimétrique de la vidéo de sortie.

  Pour les vidéos, vous pouvez également ajouter "interlaced": true pour détecter si la vidéo est entrelacée. Cette option combine l’indicateur ffprobe peu coûteux field_order avec une passe d’échantillonnage idet limitée sur les premières images de la source, et expose interlaced, field_order ainsi qu’un objet de diagnostic interlace_detection sous file.meta. Cette opération est coûteuse en calcul et facturée en conséquence.

  Pour l’audio, vous pouvez ajouter "mean_volume": true pour obtenir une valeur unique représentant le volume moyen du fichier audio.

  Vous pouvez également définir cette option sur false pour ignorer l’extraction des métadonnées et accélérer le transcodage.

• user_meta

  Record<string, any>(par défaut : {})

  Ajoute des métadonnées JSON personnalisées à chaque fichier émis sans modifier son contenu. Les objets et tableaux imbriqués sont pris en charge.

  L’héritage dépend du Robot. Les valeurs sont fusionnées avec la valeur user_meta existante du fichier de sortie ; le Step actuel remplace les clés de premier niveau correspondantes. Attribuez explicitement les clés requises lorsqu’un Robot crée de nouvelles sorties.

  Dans les Steps de traitement, ${file.*} désigne la première entrée et ${result.*} le fichier émis. Les valeurs sont évaluées pour chaque sortie après l’exécution du Robot, avant l’extraction ultérieure des métadonnées et le stockage temporaire. Sur :original, les valeurs sont évaluées pour chaque téléversement avant l’extraction des métadonnées.

  Les Steps en aval lisent ${file.user_meta.key}. Consultez Métadonnées personnalisées pour un exemple complet et les règles d’héritage.

• result

  boolean(par défaut : false)

  Indique si les résultats de ce Step doivent figurer dans l’Assembly Status JSON

• queue

  batch

  Définir la file d’attente sur « batch » abaisse manuellement la priorité des Jobs de ce Step afin d’éviter de consommer des emplacements prioritaires de Jobs pour des Jobs qui n’ont pas besoin d’un temps d’attente nul dans la file

• force_accept

  boolean(par défaut : false)

  Forcer un Robot à accepter un type de fichier qu’il aurait ignoré.

  Par défaut, les Robots ignorent les fichiers qu’ils ne connaissent pas. Le Robot 🤖/video/encode, par exemple, ignorera volontiers les images en entrée.

  Avec le paramètre force_accept défini sur true, vous pouvez forcer les Robots à accepter tous les fichiers qui leur sont envoyés. Cela entraîne généralement des erreurs et ne doit être utilisé que pour le débogage ou pour traiter des cas limites.

• ignore_errors

  boolean | Array<meta | execute>(par défaut : [])

  Ignore les erreurs pendant certaines phases du traitement.

  Si vous définissez cette valeur sur ["meta"], le Robot ignorera les erreurs lors de l’extraction des métadonnées.

  Si vous définissez cette valeur sur ["execute"], le Robot ignorera les erreurs lors de la phase d’exécution principale.

  Définir cette valeur sur true équivaut à ["meta", "execute"] : les erreurs seront alors ignorées dans les deux phases.

• use

  string | Array<string> | Array<object> | object

  Indique quel(s) Step(s) utiliser comme entrée.

  • Vous pouvez choisir n’importe quel nom pour les Steps, sauf ":original" (réservé aux téléversements des utilisateurs gérés par Transloadit)
  • Vous pouvez fournir plusieurs Steps en entrée à l’aide de tableaux :

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  • Vous pouvez également étiqueter les Steps d’entrée avec as pour transmettre une intention sémantique aux Robots :

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Astuce

  C’est probablement tout ce que vous devez savoir sur use, mais vous pouvez consulter les cas d’utilisation avancés.

• credentials

  string

  Veuillez créer l’ensemble d’informations d’identification de Template associé dans votre compte Transloadit et utiliser le nom de cet ensemble d’informations d’identification de Template comme valeur de ce paramètre. Cet ensemble contiendra les valeurs S3 suivantes : bucket, key, secret et bucket_region.

  Bien que nous recommandions d’utiliser systématiquement des informations d’identification de Template, certains cas d’usage exigent des identifiants dynamiques, pour lesquels l’utilisation d’informations d’identification de Template est trop contraignante en raison de leur nature statique. Si c’est votre cas, vous pouvez utiliser à la place les paramètres suivants : "bucket", "bucket_region" (par exemple : "us-east-1" ou "eu-west-2"), "key", "secret".

• path

  string(par défaut : "${unique_prefix}/${file.url_name}")

  Le chemin auquel le fichier doit être stocké. Il peut inclure toute Assembly Variable disponible. Le chemin ne doit pas être un répertoire.

• url_prefix

  string(par défaut : "http://{bucket}.s3.amazonaws.com/")

  Le préfixe d’URL utilisé pour l’URL renvoyée, par exemple "http://my.cdn.com/some/path/".

• acl

  authenticated-read | aws-exec-read | bucket-default | bucket-owner-full-control | bucket-owner-read | private | public | 2 de plus ↓(par défaut : "public-read")

  L’ACL utilisée pour ce fichier. Prend en charge les ACL prédéfinies d’AWS pour les objets⁠. D’autres fournisseurs compatibles S3 peuvent prendre en charge d’autres ACL. La valeur par défaut reste "public-read", ce qui peut entrer en conflit avec S3 Block Public Access et les ACL désactivées. Pour les buckets privés modernes, définissez explicitement "bucket-default" afin d’omettre l’en-tête ACL généré, et ne fournissez pas d’en-têtes ACL/grant dans headers. "private" envoie quand même une ACL.

• check_integrity

  boolean(par défaut : false)

  Calcule et transmet la somme de contrôle du fichier afin que S3 vérifie son intégrité après le téléversement, ce qui peut aider à résoudre d’occasionnels problèmes de corruption de fichiers.

  Activer cette option augmente la durée d’exécution globale, car la vérification de l’intégrité peut solliciter fortement le CPU, en particulier pour les fichiers plus volumineux.

• headers

  Record<string, string>(par défaut : {"Content-Type":"${file.mime}"})

  Un objet contenant une liste d’en-têtes à définir pour ce fichier sur S3, comme { FileURL: "${file.url_name}" }. Cet objet peut également inclure toutes les Assembly Variables disponibles. Vous trouverez une liste des en-têtes disponibles ici⁠.

  Les métadonnées des objets peuvent être spécifiées à l’aide des en-têtes x-amz-meta-*. Notez que ces en-têtes ne prennent pas en charge les valeurs de métadonnées non ASCII⁠.

• tags

  Record<string, string>(par défaut : {})

  Le balisage d’objets vous permet de catégoriser le stockage. Vous pouvez associer jusqu’à 10 balises à un objet. Les balises associées à un objet doivent avoir des clés de balise uniques.

• host

  string(par défaut : "s3.amazonaws.com")

  L’hôte du service de stockage utilisé. Il ne doit être défini que si le service de stockage utilisé n’est pas Amazon S3, mais dispose d’une API compatible (comme hosteurope.de). Le protocole utilisé par défaut est HTTP ; pour tout autre protocole, celui-ci doit être indiqué explicitement. Par exemple, préfixez l’hôte avec https:// ou s3:// pour utiliser le protocole correspondant.

• no_vhost

  boolean(par défaut : false)

  Définissez ce paramètre sur true si vous utilisez un hôte personnalisé et rencontrez des erreurs d’accès refusé.

• sign_urls_for

  string | number

  Ce paramètre fournit des URL signées dans le JSON de résultat (dans les propriétés signed_url et signed_ssl_url). La valeur que vous attribuez à ce paramètre correspond au délai d’expiration de l’URL, en secondes. Si ce paramètre n’est pas utilisé, aucune signature d’URL n’est effectuée.

• session_token

  string

  Le jeton de session associé à l’ID de clé d’accès temporaire et à la clé d’accès secrète fournis pour ce téléversement vers S3 ou un service compatible tel que R2. Le Robot n’assume aucun rôle et ne rafraîchit pas ces informations d’identification ; elles doivent rester valides pendant le téléversement.

Démonstrations

Articles de blog associés