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
Renvoie les métadonnées relatives à une tâche.
Syntaxe de la requête
{
"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.
- TaskArn
-
Amazon Resource Name (ARN) tâche à décrire.
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"
}
],
"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"
},
"SourceLocationArn": "string",
"SourceNetworkInterfaceArns": [ "string" ],
"Status": "string",
"TaskArn": "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
-
Amazon Resource Name (ARN) du groupe de CloudWatch journaux Amazon utilisé pour surveiller et consigner les événements de la tâche.
Pour plus d'informations, consultez Gestion des groupes de journaux et des flux de journaux dans le Guide Amazon CloudWatch User Guide.
Type : String
Contraintes de longueur : Longueur maximum 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
-
Amazon Resource Name (ARN) de l'exécution de tâche qui transfère les fichiers.
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
-
Amazon Resource Name (ARN) de l'emplacement de la ressource de AWS stockage.
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
-
Amazon Resource Name (ARN) des interfaces réseau créées pour votre emplacement de destination. Pour en savoir plus, consultez Exigences relatives à l'interface réseau.
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
-
Erreurs AWS DataSync rencontrées lors de l'exécution de la tâche. Vous pouvez utiliser ces codes d'erreur pour résoudre les problèmes.
Type : String
- ErrorDetail
-
Description détaillée d'une erreur qui s'est produite lors de l'exécution de la tâche. Vous pouvez utiliser ces informations pour résoudre les problèmes.
Type : String
- Excludes
-
Liste des règles de filtre qui excluent des données spécifiques lors de votre transfert. Pour plus d'informations et des exemples, consultez Filtrage des données transférées par DataSync.
Type : tableau d’objets FilterRule
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.
- Includes
-
Liste des règles de filtre qui incluent des données spécifiques lors de votre transfert. Pour plus d'informations et des exemples, consultez Filtrage des données transférées par DataSync.
Type : tableau d’objets FilterRule
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.
- Name
-
Nom de tâche décrite.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 256.
Modèle :
^[a-zA-Z0-9\s+=._:@/-]+$ - Options
-
Les options de configuration qui contrôlent le comportement de l'
StartTaskExecutionopération. Certaines options incluent la préservation des métadonnées de fichiers ou d'objets et la vérification de l'intégrité des données.Vous pouvez remplacer ces options pour chaque exécution de tâche. Pour plus d'informations, reportez-vous à la section StartTaskExecution.
Type : objet Options
- Schedule
-
Planification utilisée pour transférer périodiquement des fichiers d'une source vers un emplacement de destination.
Type : objet TaskSchedule
- SourceLocationArn
-
Amazon Resource Name (ARN) de l'emplacement du système de fichiers source.
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
-
Amazon Resource Name (ARN) des interfaces réseau créées pour votre emplacement source. Pour en savoir plus, consultez Exigences relatives à l'interface réseau.
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
-
Statut de la tâche décrite.
Pour des informations détaillées sur les statuts d'exécution des tâches, voir Comprendre les statuts des tâches dans le Guide de l'AWS DataSyncutilisateur.
Type : String
Valeurs valides :
AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE - TaskArn
-
Amazon Resource Name (ARN) tâche décrite.
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}$
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
L'exemple suivant renvoie des informations relatives à la tâche spécifiée dans l'exemple de demande.
Exemple de demande
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}Exemple
Cet exemple illustre une utilisation deDescribeTask.
Exemple de réponse
{
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group"
"CreationTime": 1532660733.39,
"CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
"Options": {
"Atime": "BEST_EFFORT",
"BytesPerSecond": 1000,
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb",
"ErrorCode": "???????",
"ErrorDetail": "??????",
"Name": "MyTask",
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa",
"Status": "CREATING",
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}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 :
