UpdateTask - AWS DataSync
Syntaxe de la requêteParamètres de demandeÉléments de réponseErreursconsultez 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.

UpdateTask

Met à jour la configuration d'une tâche, qui définit où et comment AWS DataSync vos données sont transférées.

Syntaxe de la requête

{
   "CloudWatchLogGroupArn": "string",
   "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"
         }
      }
   },
   "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",
      "Status": "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.

CloudWatchLogGroupArn

Spécifie le nom de ressource Amazon (ARN) d'un groupe de CloudWatch journaux Amazon pour surveiller votre tâche.

Pour les tâches en mode amélioré, vous devez utiliser /aws/datasync comme nom de groupe de journaux. Par exemple :

arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*

Pour plus d'informations, consultez la section Surveillance des transferts de données à l'aide CloudWatch des journaux.

Type : String

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

Excludes

Spécifie les filtres d'exclusion qui définissent les fichiers, les objets et les dossiers de votre emplacement source que vous ne DataSync souhaitez pas transférer. Pour plus d'informations et des exemples, voir Spécifier les DataSync transferts à l'aide de filtres.

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 que les filtres d'inclusion définissent les fichiers, les objets et les dossiers que vous souhaitez DataSync transférer dans votre emplacement source. Pour plus d'informations et des exemples, voir Spécifier les DataSync transferts à l'aide de filtres.

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 IAM DataSync avec lequel vous utilisez) doit être autorisée. iam:PassRole La AWSDataSyncFullAccesspolitique inclut cette autorisation.

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

Type : objet ManifestConfig

Obligatoire : non

Name

Spécifie le nom de votre tâche.

Type : String

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

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

Obligatoire : non

Options

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

Schedule

Spécifie le calendrier d'exécution de la tâche. Pour plus d'informations, veuillez consulter la rubrique Planification de votre tâche.

Type : objet TaskSchedule

Obligatoire : non

TaskArn

Spécifie l'ARN de la tâche que vous souhaitez mettre à jour.

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 IAM DataSync avec lequel vous utilisez) doit être autorisée. iam:PassRole 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

Éléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

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

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 :