StartTaskExecution

Démarre une tâche AWS DataSync de transfert. 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 étapes. Pour plus d'informations, consultez la section Statuts d'exécution des tâches.

Important

Si vous prévoyez de transférer des données depuis ou vers un site Amazon S3, examinez comment cela DataSync peut affecter les frais de votre demande S3 et la page de DataSync tarification avant de commencer.

Syntaxe de la requête

{
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "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",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

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

Excludes

Spécifie une liste de règles de filtrage qui détermine les fichiers à exclure d'une tâche. La liste contient une chaîne de filtre unique qui contient les 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 filtrage 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

ManifestConfig

Configure un manifeste, qui est une liste de fichiers ou d'objets que vous souhaitez DataSync transférer. Pour plus d'informations et des exemples de configuration, voir Spécifier les DataSync transferts à l'aide d'un manifeste.

Lorsque vous utilisez ce paramètre, l'identité de votre appelant (le rôle DataSync avec lequel vous utilisez) doit être iam:PassRole autorisée. La AWSDataSyncFullAccesspolitique inclut cette autorisation.

Pour supprimer une configuration de manifeste, spécifiez ce paramètre avec une valeur vide.

Type : objet ManifestConfig

Obligatoire : non

OverrideOptions

Indique comment votre tâche de transfert est configurée. Ces options incluent le mode DataSync de gestion des fichiers, des objets et des métadonnées associées lors de votre transfert. Vous pouvez également spécifier comment vérifier l'intégrité des données, définir des limites de bande passante pour votre tâche, entre autres options.

Chaque option possède une valeur par défaut. À moins que vous n'en ayez besoin, vous n'avez pas à configurer d'option avant d'appeler StartTaskExecution.

Vous pouvez également remplacer vos options de tâche pour chaque exécution de tâche. Par exemple, vous souhaiterez peut-être ajuster le LogLevel pour une exécution individuelle.

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 permettent de gérer, de filtrer et de 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 le nom de ressource Amazon (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

TaskReportConfig

Spécifie la manière dont vous souhaitez configurer un rapport de tâches, qui fournit des informations détaillées sur votre DataSync transfert. Pour plus d'informations, consultez la section Surveillance de vos DataSync transferts à l'aide de rapports de tâches.

Lorsque vous utilisez ce paramètre, l'identité de votre appelant (le rôle DataSync avec lequel vous utilisez) doit être iam:PassRole autorisée. La AWSDataSyncFullAccesspolitique inclut cette autorisation.

Pour supprimer une configuration de rapport de tâches, spécifiez ce paramètre comme étant vide.

Type : objet TaskReportConfig

Obligatoire : non

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

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

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 courantes pour toutes les actions, consultez Erreurs 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 démarre l'exécution d'une tâche en utilisant les options par défaut pour 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 de StartTaskExecution.

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

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• AWS SDK pour C++

• AWS SDK pour Go v2

• AWS SDK pour Java V2

• AWS SDK pour V3 JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWS SDK pour Ruby V3