CreateTask - 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.

CreateTask

Configure une tâche, qui définit où et commentAWS DataSynctransatoire.

Une tâche inclut un emplacement source, un emplacement de destination et les préférences relatives au mode et au moment où vous souhaitez transférer vos données (telles que les limites de bande passante, la planification, entre autres options).

Lorsque vous créez une tâche qui transfère des données entreAWSservices dans différentsRégions AWS, l'un de vos sites doit résider dans la région dans laquelle vous utilisez DataSync.

Pour plus d'informations, consultez les rubriques suivantes :

Syntaxe de la requête

{ "CloudWatchLogGroupArn": "string", "DestinationLocationArn": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "Name": "string", "Options": { "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" }, "Schedule": { "ScheduleExpression": "string" }, "SourceLocationArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Paramètres de demande

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

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

CloudWatchLogGroupArn

Amazon Resource Name (ARN) de CloudWatch de journaux utilisé pour surveiller et consigner les événements de la tâche.

Pour plus d'informations sur l'utilisation de CloudWatch Bûches avec DataSync, see Surveillance de votre tâchedans le AWS DataSyncGuide de l'utilisateur .

Pour plus d'informations sur ces groupes, consultez.Gestion des groupes de journaux et des flux de journauxdans leAmazon CloudWatch Logs.

Type : Chaîne

Contraintes de longueur Longueur maximale de 562.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]*:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

Obligatoire Non

DestinationLocationArn

Amazon Resource Name (ARN) d'unAWSl'emplacement de la ressource de stockage.

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}:location/loc-[0-9a-z]{17}$

Obligatoire Oui

Excludes

Liste de règles de filtre qui détermine les fichiers à exclure d'une tâche. La liste doit contenir 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 : Grappe 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 contient 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 : Grappe deFilterRuleobjets

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

Obligatoire Non

Name

Nom d'une tâche. Cette valeur est une référence de texte utilisée pour identifier la tâche dans la console.

Type : Chaîne

Contraintes de longueur Longueur minimale de 1. Longueur maximum de 256.

Modèle : ^[a-zA-Z0-9\s+=._:@/-]+$

Obligatoire Non

Options

Ensemble d'options de configuration qui contrôlent le comportement d'une exécution unique de la tâche qui se produit lorsque vous appelez StartTaskExecution. Vous pouvez configurer ces options pour préserver les métadonnées telles que l'ID utilisateur (UID) et l'ID de groupe (GID), les autorisations de fichier, la vérification de l'intégrité des données, etc.

Pour chaque exécution de tâche individuelle, vous pouvez remplacer ces options en spécifiant OverrideOptions avant de commencer l'exécution de la tâche. Pour plus d'informations, consultez le .StartTaskExecution.

Type : objet Options

Obligatoire Non

Schedule

Spécifie une planification utilisée pour transférer périodiquement des fichiers d'une source vers un emplacement de destination. La planification doit être spécifiée selon le fuseau UTC. Pour de plus amples informations, veuillez consulterPlanification de tâche.

Type : objet TaskSchedule

Obligatoire Non

SourceLocationArn

Amazon Resource Name (ARN) de l'emplacement source de la tâche.

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}:location/loc-[0-9a-z]{17}$

Obligatoire Oui

Tags

Paire clé-valeur qui représente la balise que vous souhaitez ajouter à la ressource. La valeur peut être une chaîne vide.

Type : Grappe deTagListEntryobjets

Membres de tableau Nombre minimal de 0 éléments. Nombre maximal de 50 éléments.

Obligatoire Non

Syntaxe de la réponse

{ "TaskArn": "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.

TaskArn

Amazon Resource Name (ARN) de la tâche.

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}$

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs 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 non conforme.

Code d'état HTTP 400

Exemples

Exemple

L'exemple suivant crée une tâche à l'aide d'emplacements source et de destination.

Exemple de demande

{ "Options": { "Atime": "BEST_EFFORT", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT", }, "Schedule": { "ScheduleExpression": "0 12 ? * SUN,WED *" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb", "Name": "MyTask", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0f01451b140b2af49", "Tags": [ { "Key": "Name", "Value": "Task-1" } ] }

Exemple

La réponse suivante renvoie l'Amazon Resource Name (ARN) de la tâche.

Exemple de réponse

{ "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" }

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 :