

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
<a name="API_DescribeTask"></a>

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
<a name="API_DescribeTask_RequestSyntax"></a>

```
{
   "TaskArn": "string"
}
```

## Paramètres de demande
<a name="API_DescribeTask_RequestParameters"></a>

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

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

 ** [TaskArn](#API_DescribeTask_RequestSyntax) **   <a name="DataSync-DescribeTask-request-TaskArn"></a>
Spécifie le nom de ressource Amazon (ARN) de la tâche de transfert sur laquelle vous souhaitez obtenir des informations.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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
<a name="API_DescribeTask_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeTask_ResponseElements"></a>

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](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-CloudWatchLogGroupArn"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html).  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 562.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` 

 ** [CreationTime](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-CreationTime"></a>
Heure à laquelle la tâche a été créée.  
Type : Timestamp

 ** [CurrentTaskExecutionArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-CurrentTaskExecutionArn"></a>
L'ARN de la dernière exécution de tâche.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-DestinationLocationArn"></a>
L'ARN du lieu de destination de votre transfert.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` 

 ** [DestinationNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-DestinationNetworkInterfaceArns"></a>
Les ARNs [interfaces réseau](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) 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](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ErrorCode"></a>
En cas de problème avec votre tâche, vous pouvez utiliser le code d'erreur pour vous aider à le résoudre. Pour plus d'informations, consultez la section [Résolution des problèmes liés aux DataSync transferts](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Type : Chaîne

 ** [ErrorDetail](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ErrorDetail"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Type : Chaîne

 ** [Excludes](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Excludes"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Type : tableau d’objets [FilterRule](API_FilterRule.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.

 ** [Includes](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Includes"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Type : tableau d’objets [FilterRule](API_FilterRule.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.

 ** [ManifestConfig](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ManifestConfig"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).  
Type : objet [ManifestConfig](API_ManifestConfig.md)

 ** [Name](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Name"></a>
Le nom de votre tâche.  
Type : Chaîne  
Contraintes de longueur : Longueur minimum de 0. Longueur maximum de 256.  
Modèle : `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Options](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Options"></a>
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](API_Options.md)

 ** [Schedule](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Schedule"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).  
Type : objet [TaskSchedule](API_TaskSchedule.md)

 ** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ScheduleDetails"></a>
Les détails concernant le [planning de vos tâches](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).  
Type : objet [TaskScheduleDetails](API_TaskScheduleDetails.md)

 ** [SourceLocationArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-SourceLocationArn"></a>
L'ARN de l'emplacement source de votre transfert.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` 

 ** [SourceNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-SourceNetworkInterfaceArns"></a>
Les ARNs [interfaces réseau](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) 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](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Status"></a>
État de votre tâche. Pour plus d'informations sur la signification de chaque statut, consultez la section [Statuts des tâches](https://docs.aws.amazon.com/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses).  
Type : Chaîne  
Valeurs valides : `AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE` 

 ** [TaskArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-TaskArn"></a>
L'ARN de votre tâche.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$` 

 ** [TaskMode](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-TaskMode"></a>
Le mode tâche que vous utilisez. Pour plus d'informations, consultez la section [Choix d'un mode de tâche pour le transfert de données](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Type : Chaîne  
Valeurs valides : `BASIC | ENHANCED` 

 ** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-TaskReportConfig"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Type : objet [TaskReportConfig](API_TaskReportConfig.md)

## Erreurs
<a name="API_DescribeTask_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** 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
<a name="API_DescribeTask_Examples"></a>

### Exemple de demande
<a name="API_DescribeTask_Example_1"></a>

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
<a name="API_DescribeTask_Example_2"></a>

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:*"
}
```

## Voir aussi
<a name="API_DescribeTask_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTask) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTask) 