Actions AWS S3

Cette page fournit une référence pour les actions AWS S3 disponibles dans le catalogue des actions d'automatisation workflow. Utilisez ces actions pour lister, récupérer, charger, et supprimer des objets dans les buckets Amazon S3.

Prérequis

Pour les prérequis et la configuration des identifiants, consultez Configurer les identifiants AWS.

Lister les objets dans un bucket

L’identifiant de l’action est aws.s3.listObjectsV2.

Renvoie une partie ou la totalité (jusqu’à 1000) des objets d’un bucket avec leurs métadonnées. Il s’agit de la version recommandée de listObjects.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS du bucket cible.	`us-east-2`
`bucket`	Chaîne	Obligatoire. Nom du bucket S3 à partir duquel lister les objets.	`examplebucket`
`prefix`	Chaîne	Facultatif. Limite la réponse aux clés qui commencent par ce préfixe.	`path/to/folder/`
`maxKeys`	Entier	Facultatif. Nombre maximum de clés à renvoyer (jusqu'à 1000).	`100`
`continuationToken`	Chaîne	Facultatif. Jeton d'une réponse précédente pour récupérer la page de résultats suivante.	`some-token`
`parameters`	Carte	Facultatif. Paramètres boto3 supplémentaires à passer à l'appel d'API.	`{"Delimiter": "/"}`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "response", "expression": ".response"}]`

Des champs boto3 facultatifs supplémentaires (EncodingType, FetchOwner, StartAfter, RequestPayer, ExpectedBucketOwner, OptionalObjectAttributes, Delimiter) sont disponibles via l’entrée parameters. Consultez la référence list_objects_v2 de boto3 pour plus de détails.

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`response`	Objet	Voir la référence boto3 list_objects_v2 .
`success`	Booléen	`true` ou `false`
`errorMessage`	Chaîne	`"Parameter validation failed: Invalid bucket name"`

Sortir

Type

Exemple

response

Objet

Voir la

référence boto3 list_objects_v2

success

Booléen

true

false

errorMessage

Chaîne

"Parameter validation failed: Invalid bucket name"

Exemple de workflow

name: aws-s3-list-objects-v2
description: 'List Objects in an AWS S3 Bucket'
steps:
  - name: aws_s3_listObjectsV2_1
    type: action
    action: aws.s3.listObjectsV2
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      prefix: "path/to/folder/"
      maxKeys: 100
    next: end

Supprimer un objet d'un bucket

L’identifiant de l’action est aws.s3.deleteObject.

Supprime définitivement un seul objet d'un bucket. Pour les buckets versionnés, cette opération insère un marqueur de suppression, qui masque l'objet sans le supprimer définitivement à moins qu'un VersionId ne soit spécifié.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS du bucket cible.	`us-east-2`
`bucket`	Chaîne	Obligatoire. Nom du bucket S3 contenant l'objet.	`examplebucket`
`key`	Chaîne	Obligatoire. Clé complète (chemin) de l'objet à supprimer.	`path/to/object.txt`
`parameters`	Carte	Facultatif. Paramètres boto3 supplémentaires à passer à l'appel d'API.	`{"VersionId": "testVersion", "MFA": "Test"}`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "response", "expression": ".response"}]`

Des champs boto3 facultatifs supplémentaires (RequestPayer, BypassGovernanceRetention, ExpectedBucketOwner, IfMatch, VersionId, MFA) sont disponibles via l’entrée parameters. Consultez la référence boto3 delete_object pour plus de détails.

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`response`	Objet	Consultez la référence boto3 delete_object .
`success`	Booléen	`true` ou `false`
`errorMessage`	Chaîne	`"Parameter validation failed: Invalid bucket name"`

Sortir

Type

Exemple

response

Objet

Consultez la

référence boto3 delete_object

success

Booléen

true

false

errorMessage

Chaîne

"Parameter validation failed: Invalid bucket name"

Exemple de workflow

name: aws-s3-delete-object
description: 'Delete an AWS S3 Object'
steps:
  - name: aws_s3_deleteObject_1
    type: action
    action: aws.s3.deleteObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-west-2"
      bucket: "my-bucket"
      key: "path/to/object.txt"
    next: end

Ajouter un objet à un bucket

L’identifiant de l’action est aws.s3.putObject.

Ajoute un objet à un bucket. Amazon S3 est un système distribué : s'il reçoit plusieurs requests d'écriture pour le même objet simultanément, il écrase tout sauf le dernier objet écrit.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS du bucket cible.	`us-east-2`
`bucket`	Chaîne	Obligatoire. Nom du bucket S3 vers lequel charger l'objet.	`examplebucket`
`key`	Chaîne	Obligatoire. Clé complète (chemin) de l'objet dans le bucket.	`path/to/object.txt`
`body`	Chaîne	Obligatoire. Les données de l'objet à téléverser.	`file content`
`contentType`	Chaîne	Obligatoire. Type MIME standard de l'objet.	`plain/text`
`tagging`	Chaîne	Facultatif. Ensemble de tags encodé en URL à appliquer à l’objet.	`key1=value1`
`parameters`	Carte	Facultatif. Paramètres boto3 supplémentaires à passer à l'appel d'API.	`{"ServerSideEncryption": "AES256", "Metadata": {"metadata1": "value1"}}`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "response", "expression": ".response"}]`

Des champs boto3 facultatifs supplémentaires sont disponibles via l’entrée parameters. Consultez la référence boto3 put_object pour la liste complète.

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`response`	Objet	Consultez la référence boto3 put_object .
`success`	Booléen	`true` ou `false`
`errorMessage`	Chaîne	`"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"`

Sortir

Type

Exemple

response

Objet

Consultez la

référence boto3 put_object

success

Booléen

true

false

errorMessage

Chaîne

"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"

Exemple de workflow

name: s3-put-object
description: 'Put an AWS S3 Object'
steps:
  - name: aws_s3_putObject_1
    type: action
    action: aws.s3.putObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      key: "path/to/object.txt"
      body: "Hello world"
      contentType: "plain/text"
      tagging: "key1=value1"
    next: end

Récupérer un objet depuis un bucket

L’identifiant de l’action est aws.s3.getObject.

Récupère un objet depuis Amazon S3. Spécifiez le nom de clé complet pour l’objet dans la requête.

Important

Cette action échoue si l’objet est supérieur à 100 Ko.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS du bucket cible.	`us-east-2`
`bucket`	Chaîne	Obligatoire. Nom du bucket S3 contenant l'objet.	`examplebucket`
`key`	Chaîne	Obligatoire. Clé complète (chemin) de l'objet à récupérer.	`path/to/object.txt`
`versionId`	Chaîne	Facultatif. ID de version de l’objet à récupérer. En cas d’omission, la version actuelle est renvoyée.	`some-version-id`
`range`	Chaîne	Facultatif. En-tête de plage HTTP pour récupérer une plage d’octets spécifique de l’objet.	`bytes=0-99`
`parameters`	Carte	Facultatif. Paramètres boto3 supplémentaires à passer à l'appel d'API.	`{"ChecksumMode": "ENABLED"}`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "response", "expression": ".response"}]`

Des champs boto3 facultatifs supplémentaires sont disponibles via l’entrée parameters. Consultez la référence boto3 get_object pour obtenir la liste complète.

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`response`	Objet	Consultez la référence boto3 get_object .
`success`	Booléen	`true` ou `false`
`errorMessage`	Chaîne	`"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"`

Sortir

Type

Exemple

response

Objet

Consultez la

référence boto3 get_object

success

Booléen

true

false

errorMessage

Chaîne

"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"

Exemple de workflow

name: s3-get-object
description: 'Get an AWS S3 Object'
steps:
  - name: aws_s3_getObject_1
    type: action
    action: aws.s3.getObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      key: "path/to/object.txt"
    next: end

Cette traduction automatique est fournie pour votre commodité.

Prérequis.css-21sua1{background:none;border:none;width:0;padding:0;}

Lister les objets dans un bucket

Supprimer un objet d'un bucket

Ajouter un objet à un bucket

Récupérer un objet depuis un bucket

Important

Prérequis