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 comment AWS DataSync transférer vos données.

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

Important

Si vous envisagez de transférer des données vers ou depuis un emplacement Amazon S3, découvrez comment cela DataSync peut affecter les frais de votre demande S3 et consultez la page de DataSync tarification avant de commencer.

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, voir Paramètres communs.

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

CloudWatchLogGroupArn

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

Pour plus d'informations sur l'utilisation des CloudWatch journaux avecDataSync, consultez la section Surveillance de votre tâche dans le Guide de AWS DataSync l'utilisateur.

Pour plus d'informations, consultez Gestion des groupes de journaux et des flux de CloudWatchjournaux dans le Guide de l'utilisateur Amazon Logs.

Type : String

Contraintes de longueur : Longueur maximum 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

L'Amazon Resource Name (ARN) d'un l'emplacement de la ressource de stockage AWS.

Type : String

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

Spécifie une liste de règles de filtre qui excluent des données spécifiques lors de votre transfert. Pour plus d'informations et des exemples, consultez Filtrage des données transférées par DataSync.

Type : tableau d’objets FilterRule

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.

Obligatoire : non

Includes

Spécifie une liste de règles de filtre qui incluent des données spécifiques lors de votre transfert. Pour plus d'informations et des exemples, consultez Filtrage des données transférées par DataSync.

Type : tableau d’objets FilterRule

Membres du tableau : nombre minimum de 0 élément. 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 : String

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 256.

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

Obligatoire : non

Options

Spécifie les options de configuration d'une tâche. Certaines options incluent la préservation des métadonnées de fichiers ou d'objets et la vérification de l'intégrité des données.

Vous pouvez également ignorer ces options avant de démarrer l'exécution individuelle d'une tâche (également appelée exécution de tâche). Pour plus d'informations, consultez 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 plus d'informations, veuillez consulter la rubrique Planification de votre tâche.

Type : objet TaskSchedule

Obligatoire : non

SourceLocationArn

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

Type : String

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

Spécifie les balises que vous souhaitez appliquer à l'Amazon Resource Name (ARN) représentant la tâche.

Les balises sont des paires clé-valeur qui vous aident à gérer, filtrer et rechercher vos DataSync ressources.

Type : tableau d’objets TagListEntry

Membres du tableau : nombre minimum de 0 élément. 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 : String

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, reportez-vous à la sectionErreurs courantes.

InternalException

Cette exception est levée lorsqu'une erreur se produit dans le AWS DataSync service.

Code d'état HTTP : 500

InvalidRequestException

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

Code d'état HTTP : 400

Exemples

Exemple de demande

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

{ "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 de réponse

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

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