StartTaskExecution - AWS DataSync

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.

StartTaskExecution

Démarre un appel spécifique d'une tâche. UNTaskExecutionvalue représente une exécution individuelle d'une tâche. Chaque tâche peut avoir au plus uneTaskExecutionà la fois.

TaskExecutioncomporte les phases de transition suivantes : INITIALISATION | PRÉPARATION | TRANSFERT | VÉRIFICATION | RÉUSSITE/ÉCHEC.

Pour plus d'informations, consultez Exécution de tâche dansComposants et terminologiedans le AWS DataSyncGuide de l'utilisateur.

Syntaxe de la demande

{ "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "OverrideOptions": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "TaskArn": "string" }

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, voirParamètres courants.

Cette demande accepte les données suivantes au format JSON.

Excludes

Liste de règles de filtre qui détermine les fichiers à exclure d'une tâche. La liste contient une seule chaîne de filtre composée des motifs à exclure. Les motifs sont délimités par « | » (c'est-à-dire une barre verticale), par exemple, "/folder1|/folder2".

Type : Array deFilterRuleobjets

Membres de tableau : Nombre minimal de 0 éléments. Nombre maximum de 1 élément.

Obligatoire Non

Includes

Liste de règles de filtre qui détermine les fichiers à inclure lors de l'exécution d'une tâche. Le modèle doit contenir une seule chaîne de filtre composée des motifs à inclure. Les motifs sont délimités par « | » (c'est-à-dire une barre verticale), par exemple, "/folder1|/folder2".

Type : Array deFilterRuleobjets

Membres de tableau : Nombre minimal de 0 éléments. Nombre maximum de 1 élément.

Obligatoire Non

OverrideOptions

Représente les options disponibles pour contrôler le comportement d'unStartTaskExecution. Le comportement inclut la conservation des métadonnées telles que l'ID utilisateur (UID), l'ID de groupe (GID) et les autorisations de fichiers, ainsi que le remplacement des fichiers dans la destination, la vérification de l'intégrité des données, etc.

Un ensemble d'options par défaut est associé à une tâche. Si vous ne spécifiez aucune option dansStartTaskExecution, la valeur par défaut est utilisée. Vous pouvez remplacer les options par défaut de chaque exécution de tâche en spécifiant un remplacementOptionsvaleur pourStartTaskExecution.

Type : objet Options

Obligatoire Non

TaskArn

Amazon Resource Name (ARN) de la tâche à démarrer.

Type : Chaîne

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

Obligatoire Oui

Syntaxe de la réponse

{ "TaskExecutionArn": "string" }

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

TaskExecutionArn

Amazon Resource Name (ARN) de l'exécution de tâche spécifique démarrée.

Type : Chaîne

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, voirErreurs courantes.

InternalException

Cette exception est renvoyée lorsqu'une erreur se produit dans leAWS DataSyncservice.

Code d'état HTTP : 500

InvalidRequestException

Cette exception est renvoyée lorsque le client soumet une demande mal formée.

Code d'état HTTP : 400

Exemples

Exemple

L'exemple suivant démarre une exécution de tâche à l'aide des options par défaut et de la tâche spécifiée.

Exemple de demande

{ "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" }

Exemple

Cet exemple illustre une utilisation de StartTaskExecution.

Exemple de réponse

{ "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" }

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :