Cette page fournit une référence pour les actions AWS Step Functions disponibles dans le catalogue des actions de Workflow Automation. Utilisez ces actions pour démarrer, arrêter, relancer, et inspecter les exécutions et les machines à états Step Functions depuis vos définitions de workflow.
Prérequis
Avant d'utiliser les actions AWS Step Functions dans Workflow Automation, assurez-vous d'avoir :
- Un compte AWS disposant des autorisations appropriées.
- Informations d'identification AWS configurées (informations d'identification de l'utilisateur IAM, ARN du rôle IAM ou informations d'identification de session).
- Les autorisations IAM nécessaires pour les opérations Step Functions.
Consultez la section Configurer les identifiants AWS pour savoir comment créer des utilisateurs et des rôles IAM, et configurer des identifiants AWS statiques et de session pour l'intégration aux actions AWS de Workflow Automation.
Autorisations IAM requises
Les autorisations dont vous avez besoin dépendent des actions Step Functions que votre workflow appelle. Utilisez l’exemple ci-dessous comme modèle pour une politique de moindre privilège couvrant les sept actions.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "states:StartExecution", "states:StopExecution", "states:RedriveExecution", "states:DescribeExecution", "states:ListExecutions", "states:DescribeStateMachine", "states:ListStateMachines" ], "Resource": "arn:aws:states:<region>:<account-id>:*" } ]}Important
Remplacez <region> et <account-id> par vos valeurs réelles, et restreignez le Resource à des ARN de machine à états ou d'exécution spécifiques dans la mesure du possible.
Démarrer une exécution Step Functions
L’identifiant de l’action est aws.stepFunctions.startExecution.
Démarre une exécution d’une machine à états AWS Step Functions. En cas de succès, renvoie le executionArn de la nouvelle exécution, que vous pouvez transmettre à aws.stepFunctions.describeExecution pour interroger son statut.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS où la machine à états est déployée. |
|
stateMachineArn | Chaîne | Obligatoire. ARN de la machine à états à exécuter. |
|
name | Chaîne | Facultatif. Nom de l’exécution. Doit être unique par machine à états. Généré automatiquement en tant qu’UUID s’il est omis. Sur les machines à états
, la réutilisation du nom d’une exécution en cours avec une entrée différente renvoie
. Sur les machines à états
, les noms peuvent être réutilisés immédiatement. |
|
input | Chaîne | Facultatif. Chaîne JSON à passer en entrée à l’exécution. |
|
traceHeader | Chaîne | Facultatif. En-tête de la trace X-Ray à propager dans l’exécution. |
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Réponse de l’API AWS Step Functions. |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si l’exécution n’a pas pu démarrer.
en cas de succès. |
L’exemple suivant démarre une exécution de remédiation et capture l’ARN d’exécution pour les étapes en aval.
Exemple de workflow |
|---|
|
Arrêter une exécution Step Functions
L’identifiant de l’action est aws.stepFunctions.stopExecution.
Arrête une exécution Step Functions en cours. AWS marque l’exécution comme ABORTED une fois qu’elle s’arrête.
Important
Cette action est prise en charge uniquement sur les machines d’état STANDARD. Il ne peut pas arrêter les exécutions EXPRESS.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS où l’exécution est en cours. |
|
executionArn | Chaîne | Obligatoire. ARN de l'exécution à arrêter. |
|
erreur | Chaîne | Facultatif. Code d’erreur court décrivant pourquoi l’exécution a été arrêtée. |
|
cause | Chaîne | Facultatif. Explication lisible par un humain de la raison pour laquelle l’exécution a été arrêtée. |
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Réponse de l’API AWS Step Functions. |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si l’arrêt de l’exécution a échoué.
en cas de succès. |
L’exemple suivant abandonne une exécution qui a dépassé son SLA.
Exemple de workflow |
|---|
|
Relancer une exécution Step Functions
L’identifiant de l’action est aws.stepFunctions.redriveExecution.
Relance une exécution Step Functions ayant échoué, ayant expiré ou ayant été abandonnée, en la reprenant à partir du dernier état infructueux sans recommencer depuis le début.
Important
Cette action est prise en charge uniquement sur les machines d’état STANDARD. Une exécution ne peut être relancée que si elle n’a pas SUCCEEDED, si elle se situe dans les 14 jours suivant son achèvement et si elle compte moins de 24 999 événements d’historique.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS où l'exécution a eu lieu. |
|
executionArn | Chaîne | Obligatoire. ARN de l’exécution à relancer. |
|
clientToken | Chaîne | Facultatif. Jeton d’idempotence pour la requête de redrive. Généré automatiquement par le SDK si omis. |
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Réponse de l’API AWS Step Functions. |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si le redrive a échoué.
en cas de succès. |
L'exemple suivant relance une exécution échouée pour la reprendre à partir de son dernier état d'échec.
Exemple de workflow |
|---|
|
Décrire une exécution Step Functions
L’identifiant de l’action est aws.stepFunctions.describeExecution.
Renvoie le statut, l’entrée, la sortie et les horodatages d’une exécution Step Functions. Utilisez cette action pour interroger le résultat d’une exécution démarrée par aws.stepFunctions.startExecution.
Important
Cette action prend en charge directement les exécutions de machine d’état STANDARD. Vous ne pouvez décrire que les exécutions EXPRESS qu’une exécution Map Run a réparties.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS où l'exécution a eu lieu. |
|
executionArn | Chaîne | Obligatoire. ARN de l’exécution à décrire. |
|
includedData | Énumération | Facultatif. Contrôle si la définition de l’exécution est renvoyée. Utilisez
pour ignorer le déchiffrement de la définition lorsque l’autorisation
n’est pas disponible. Par défaut
. |
ou
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Détails de l’exécution provenant de l’API AWS Step Functions. Sur les exécutions |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si la requête a échoué.
en cas de succès. |
L’exemple suivant interroge le statut d’une exécution et capture la sortie pour les étapes en aval.
Exemple de workflow |
|---|
|
Lister les exécutions Step Functions
L’identifiant de l’action est aws.stepFunctions.listExecutions.
Répertorie les exécutions d’une machine à états AWS Step Functions ou d’une exécution Map Run, éventuellement filtrées par statut. Les résultats sont triés du plus récent au plus ancien.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS dans laquelle lister les exécutions. |
|
stateMachineArn | Chaîne | Facultatif. ARN de la machine à états dont il faut lister les exécutions. Fournissez ceci ou
, pas les deux. Les machines à états
ne peuvent pas être listées directement : utilisez plutôt
pour lister leurs exécutions enfants à partir d'un Distributed Map. |
|
mapRunArn | Chaîne | Facultatif. ARN de l’exécution Map dont il faut lister les exécutions enfants. Fournissez ceci ou
, pas les deux. Requis lors de l’utilisation de
. |
|
statusFilter | Énumération | Facultatif. Filtrer les exécutions par statut.
nécessite
. |
|
|
|
|
|
|
maxResults | Int | Facultatif. Nombre maximum d’exécutions à renvoyer. Par défaut 100, maximum 1000. |
|
nextToken | Chaîne | Facultatif. Jeton de pagination du
d’un appel précédent. Expire après 24 heures. |
|
redriveFilter | Énumération | Facultatif. Filtrer les exécutions selon qu’elles ont été réexécutées. |
ou
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Liste des exécutions provenant de l’API AWS Step Functions. |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si la requête a échoué.
en cas de succès. |
L'exemple suivant liste les exécutions en cours pour une machine à états.
Exemple de workflow |
|---|
|
Décrire une machine à états
L’identifiant de l’action est aws.stepFunctions.describeStateMachine.
Renvoie la définition, le rôle IAM, la configuration de logging, le type (STANDARD ou EXPRESS), et le statut d'une machine à états AWS Step Functions.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS où la machine à états est déployée. |
|
stateMachineArn | Chaîne | Obligatoire. ARN de la machine à états à décrire. Accepte également un ARN de version. |
|
includedData | Énumération | Facultatif. Utilisez
pour ignorer le renvoi de la définition de la machine d’état et éviter d’avoir besoin de
lorsque la définition est chiffrée par KMS. Par défaut
. |
ou
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Détails de la machine à états provenant de l’API AWS Step Functions. Le champ |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si la requête a échoué.
en cas de succès. |
L’exemple suivant récupère le type et la définition d’une machine à états.
Exemple de workflow |
|---|
|
Lister les machines à états
L’identifiant de l’action est aws.stepFunctions.listStateMachines.
Répertorie les machines à états AWS Step Functions dans un compte et une région. Utilisez les entrées de pagination pour récupérer de grands ensembles de résultats.
Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
awsRoleArn | Chaîne | Facultatif. ARN du rôle IAM à assumer. Recommandé. Prend le pas sur les informations d’identification basées sur des clés lorsque vous fournissez les deux. |
|
awsAccessKeyId | Chaîne (secret) | Facultatif. ID de clé d’accès AWS. Doit être transmis en tant que secret. |
|
awsSecretAccessKey | Chaîne (secret) | Facultatif. Clé d’accès secrète AWS. Doit être transmis en tant que secret. |
|
awsSessionToken | Chaîne (secret) | Facultatif. Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que secret. |
|
région | Chaîne | Obligatoire. Région AWS dans laquelle lister les machines à états. |
|
maxResults | Int | Facultatif. Nombre maximal de machines à états à retourner. Par défaut 100, maximum 1000. |
|
nextToken | Chaîne | Facultatif. Jeton de pagination du
d’un appel précédent. Expire après 24 heures. |
|
selectors | List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.
Sortir | Type | Description |
|---|---|---|
response | Objet | Liste des machines à états de l'API AWS Step Functions. |
success | Booléen |
en cas de succès,
en cas d’échec. |
errorMessage | Chaîne | Message d’erreur si la requête a échoué.
en cas de succès. |
L’exemple suivant liste les machines à états du compte et capture le résultat pour les étapes en aval.
Exemple de workflow |
|---|
|
Et ensuite ?
Pour continuer à travailler avec les actions AWS et Workflow Automation, consultez les ressources suivantes.
- Configuration des identifiants AWS: configurez les rôles IAM et les clés d’accès à utiliser avec les actions AWS.
- AWS Execute API: appel d’API direct pour n’importe quelle API AWS lorsqu’une action dédiée n’est pas disponible.
- Exemples de workflow: consultez des exemples de workflow concrets utilisant des actions AWS.