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.
DescribeExecution
Vous pouvez l'utiliser DescribeExecution pour vérifier les détails de l'exécution du flux de travail spécifié.
Note
Cet API appel renvoie uniquement les détails des flux de travail en cours.
Si vous fournissez un ID pour une exécution qui n'est pas en cours, ou si l'exécution ne correspond pas à l'ID de flux de travail spécifié, vous recevez une ResourceNotFound exception.
Syntaxe de la requête
{
"ExecutionId": "string",
"WorkflowId": "string"
}Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
La demande accepte le JSON format des données suivantes.
- ExecutionId
-
Identifiant unique pour l'exécution d'un flux de travail.
Type : String
Contraintes de longueur : longueur fixe de 36.
Modèle :
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}Obligatoire : oui
- WorkflowId
-
Un identifiant unique pour le flux de travail.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
w-([a-z0-9]{17})Obligatoire : oui
Syntaxe de la réponse
{
"Execution": {
"ExecutionId": "string",
"ExecutionRole": "string",
"InitialFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Etag": "string",
"Key": "string",
"VersionId": "string"
}
},
"LoggingConfiguration": {
"LoggingRole": "string",
"LogGroupName": "string"
},
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Results": {
"OnExceptionSteps": [
{
"Error": {
"Message": "string",
"Type": "string"
},
"Outputs": "string",
"StepType": "string"
}
],
"Steps": [
{
"Error": {
"Message": "string",
"Type": "string"
},
"Outputs": "string",
"StepType": "string"
}
]
},
"ServiceMetadata": {
"UserDetails": {
"ServerId": "string",
"SessionId": "string",
"UserName": "string"
}
},
"Status": "string"
},
"WorkflowId": "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 sous JSON forme formatée par le service.
- Execution
-
Structure qui contient les détails de l'exécution du flux de travail.
Type : objet DescribedExecution
- WorkflowId
-
Un identifiant unique pour le flux de travail.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
w-([a-z0-9]{17})
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- InternalServiceError
-
Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.
HTTPCode de statut : 500
- InvalidRequestException
-
Cette exception est levée lorsque le client soumet une demande mal formée.
HTTPCode de statut : 400
- ResourceNotFoundException
-
Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.
HTTPCode de statut : 400
- ServiceUnavailableException
-
La demande a échoué car le service AWS Transfer Family n'est pas disponible.
HTTPCode de statut : 500
consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :
