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.
DescribeTask
Fournit des informations sur une tâche, qui définit où et comment AWS DataSync vos données sont transférées.
Syntaxe de la requête
{
"TaskArn": "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.
- TaskArn
-
Spécifie le nom de ressource Amazon (ARN) de la tâche de transfert sur laquelle vous souhaitez obtenir des informations.
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
{
"CloudWatchLogGroupArn": "string",
"CreationTime": number,
"CurrentTaskExecutionArn": "string",
"DestinationLocationArn": "string",
"DestinationNetworkInterfaceArns": [ "string" ],
"ErrorCode": "string",
"ErrorDetail": "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"
},
"ScheduleDetails": {
"DisabledBy": "string",
"DisabledReason": "string",
"StatusUpdateTime": number
},
"SourceLocationArn": "string",
"SourceNetworkInterfaceArns": [ "string" ],
"Status": "string",
"TaskArn": "string",
"TaskMode": "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"
}
}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.
- CloudWatchLogGroupArn
-
Le nom de ressource Amazon (ARN) d'un groupe de CloudWatch journaux Amazon pour le suivi de votre tâche.
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:([^:\*]*)(:\*)?$ - CreationTime
-
Heure à laquelle la tâche a été créée.
Type : Timestamp
- CurrentTaskExecutionArn
-
L'ARN de la dernière exécution de 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}/execution/exec-[0-9a-f]{17}$ - DestinationLocationArn
-
L'ARN du lieu de destination de votre transfert.
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}$ - DestinationNetworkInterfaceArns
-
Les ARNs interfaces réseau DataSync créées pour votre emplacement de destination.
Type : tableau de chaînes
Contraintes de longueur : Longueur maximum de 128.
Modèle :
^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$ - ErrorCode
-
En cas de problème avec votre tâche, vous pouvez utiliser le code d'erreur pour résoudre le problème. Pour plus d'informations, consultez la section Résolution des problèmes liés aux DataSync transferts.
Type : String
- ErrorDetail
-
En cas de problème avec votre tâche, vous pouvez utiliser les détails de l'erreur pour résoudre le problème. Pour plus d'informations, consultez la section Résolution des problèmes liés aux DataSync transferts.
Type : String
- Excludes
-
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.
- Includes
-
Ils incluent des filtres qui 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.
- ManifestConfig
-
Configuration du manifeste qui répertorie les fichiers ou les objets que vous DataSync souhaitez transférer. Pour plus d'informations, voir Spécifier les DataSync transferts à l'aide d'un manifeste.
Type : objet ManifestConfig
- Name
-
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+=._:@/-]+$ - Options
-
Les paramètres de la tâche. Par exemple, quelles métadonnées de fichier sont préservées, comment l'intégrité des données est vérifiée à la fin du transfert, limites de bande passante, entre autres options.
Type : objet Options
- Schedule
-
Le calendrier selon lequel vous souhaitez que votre tâche soit exécutée. Pour plus d'informations, veuillez consulter la rubrique Planification de votre tâche.
Type : objet TaskSchedule
- ScheduleDetails
-
Les détails de votre planning de tâches.
Type : objet TaskScheduleDetails
- SourceLocationArn
-
L'ARN de l'emplacement source de votre transfert.
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}$ - SourceNetworkInterfaceArns
-
Les ARNs interfaces réseau DataSync créées pour votre emplacement source.
Type : tableau de chaînes
Contraintes de longueur : Longueur maximum de 128.
Modèle :
^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$ - Status
-
État de votre tâche. Pour plus d'informations sur la signification de chaque statut, consultez la section Statuts des tâches.
Type : String
Valeurs valides :
AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE - TaskArn
-
L'ARN de votre 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}$ - TaskMode
-
Le mode tâche que vous utilisez. Pour plus d'informations, voir Choisir un mode de tâche pour le transfert de données.
Type : String
Valeurs valides :
BASIC | ENHANCED - TaskReportConfig
-
La configuration de votre 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.
Type : objet TaskReportConfig
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 indique l'ARN d'une DataSync tâche sur laquelle vous souhaitez obtenir des informations.
{ "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" }
Exemple de réponse
L'exemple suivant montre une DescribeTask réponse.
{ "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026", "Name": "MyTask", "TaskMode": "BASIC", "Status": "RUNNING", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "CreationTime": 1532660733.39, "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*" }
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 :
