StartTaskExecution - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesVoir aussi

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 une AWS DataSync tâche. Pour chaque tâche, vous ne pouvez exécuter qu'une seule tâche à la fois.

L'exécution d'une tâche comporte plusieurs phases. Pour plus d'informations, consultez États d'exécution de tâches.

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

{
   "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"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TaskArn": "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.

Excludes

Spécifie une 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 modèles à exclure. Les motifs sont délimités par « | » (c'est-à-dire une barre verticale), par exemple, "/folder1|/folder2".

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 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 modèles à inclure. Les motifs sont délimités par « | » (c'est-à-dire une barre verticale), par exemple, "/folder1|/folder2".

Type : tableau d’objets FilterRule

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

Obligatoire : non

OverrideOptions

Configure les paramètres de vos AWS DataSync tâches. Ces options incluent la façon DataSync dont sont gérés les fichiers, les objets et leurs métadonnées associées. Vous pouvez également spécifier comment DataSync vérifier l'intégrité des données, définir des limites de bande passante pour votre tâche, entre autres options.

Chaque paramètre de tâche dispose d'une valeur par défaut. À moins que vous n'en ayez besoin, vous n'avez pas à les configurer Options avant de commencer votre tâche.

Type : objet Options

Obligatoire : non

Tags

Spécifie les balises que vous souhaitez appliquer à l'Amazon Resource Name (ARN) représentant l'exécution de 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

TaskArn

Spécifie l'Amazon Resource Name (ARN) de la tâche que vous souhaitez démarrer.

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

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

ARN de l'exécution de la tâche en cours d'état.

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}/execution/exec-[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 lance l'exécution d'une tâche à l'aide des options par défaut de la tâche spécifiée.

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

Cet exemple illustre une utilisation deStartTaskExecution.

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