ListExecutions - AWS Transfer Family
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseElé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.

ListExecutions

Répertorie toutes les exécutions en cours pour le flux de travail spécifié.

Note

Si l'ID de flux de travail spécifié est introuvable, ListExecutions renvoie une ResourceNotFound exception.

Syntaxe de la requête

{
   "MaxResults": number,
   "NextToken": "string",
   "WorkflowId": "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.

MaxResults

Spécifie le nombre maximum d'exécutions à renvoyer.

Type : entier

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

Obligatoire : non

NextToken

ListExecutionsrenvoie le NextToken paramètre dans la sortie. Vous pouvez ensuite transmettre le NextToken paramètre dans une commande suivante pour continuer à répertorier les exécutions supplémentaires.

C'est utile pour la pagination, par exemple. Si vous avez 100 exécutions pour un flux de travail, vous souhaiterez peut-être n'en répertorier que les 10 premières. Dans ce cas, appelez l'API en spécifiant max-results :

aws transfer list-executions --max-results 10

Cela renvoie les détails des 10 premières exécutions, ainsi que le pointeur (NextToken) vers la onzième exécution. Vous pouvez maintenant appeler à nouveau l'API en fournissant la NextToken valeur que vous avez reçue :

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

Cet appel renvoie les 10 prochaines exécutions, de la 11e à la 20e. Vous pouvez ensuite répéter l'appel jusqu'à ce que les détails des 100 exécutions aient été communiqués.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.

Obligatoire : non

WorkflowId

Un identifiant unique pour le flux de travail.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : w-([a-z0-9]{17})

Obligatoire : oui

Syntaxe de la réponse

{
   "Executions": [ 
      { 
         "ExecutionId": "string",
         "InitialFileLocation": { 
            "EfsFileLocation": { 
               "FileSystemId": "string",
               "Path": "string"
            },
            "S3FileLocation": { 
               "Bucket": "string",
               "Etag": "string",
               "Key": "string",
               "VersionId": "string"
            }
         },
         "ServiceMetadata": { 
            "UserDetails": { 
               "ServerId": "string",
               "SessionId": "string",
               "UserName": "string"
            }
         },
         "Status": "string"
      }
   ],
   "NextToken": "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 au format JSON par le service.

Executions

Renvoie les détails de chaque exécution, sous forme de ListedExecution tableau.

Type : tableau d’objets ListedExecution

NextToken

ListExecutionsrenvoie le NextToken paramètre dans la sortie. Vous pouvez ensuite transmettre le NextToken paramètre dans une commande suivante pour continuer à répertorier les exécutions supplémentaires.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.

WorkflowId

Un identifiant unique pour le flux de travail.

Type : chaîne

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.

Code d’état HTTP : 500

InvalidNextTokenException

Le NextToken paramètre transmis n'est pas valide.

Code d’état HTTP : 400

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

ResourceNotFoundException

Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

Code d’état HTTP : 500

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :