Esta página proporciona una referencia de las acciones de AWS Step Functions disponibles en el catálogo de acciones de automatización del flujo de trabajo. Utilice estas acciones para iniciar, detener, reimpulsar e inspeccionar las ejecuciones de Step Functions y las máquinas de estado desde las definiciones del flujo de trabajo.
Requisitos previos
Antes de usar las acciones de AWS Step Functions en la automatización del flujo de trabajo, asegúrese de tener:
- Una cuenta de AWS con las licencias adecuadas.
- Credenciales de AWS configuradas (credenciales de usuario de IAM, ARN de rol de IAM o credenciales de sesión).
- Los permisos de IAM necesarios para las operaciones de Step Functions.
Consulte Configurar credenciales de AWS para obtener información sobre cómo crear usuarios y roles de IAM, y configurar credenciales de AWS estáticas y de sesión para la integración con las acciones de AWS de automatización de flujos de trabajo.
Licencias IAM requeridos
Los permisos que necesita dependen de las acciones de Step Functions a las que llame el flujo de trabajo. Use el siguiente ejemplo como plantilla para una política de privilegios mínimos que cubra las siete acciones.
{ "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>:*" } ]}Importante
Reemplace <region> y <account-id> con los valores reales y restrinja Resource a los ARN de máquina de estado o de ejecución específicos donde sea posible.
Iniciar una ejecución de Step Functions
El identificador de la acción es aws.stepFunctions.startExecution.
Inicia una ejecución de una máquina de estado de AWS Step Functions. Si se realiza correctamente, devuelve el executionArn de la nueva ejecución, que puede pasar a aws.stepFunctions.describeExecution para consultar su estado.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS donde está desplegada la máquina de estado. |
|
stateMachineArn | Cadena | Requerido. ARN de la máquina de estado a ejecutar. |
|
nombre | Cadena | Opcional. Nombre de ejecución. Debe ser único por máquina de estado. Se genera automáticamente como un UUID si se omite. En las máquinas de estado
, reutilizar el nombre de una ejecución en curso con una entrada diferente devuelve
. En las máquinas de estado
, los nombres se pueden reutilizar inmediatamente. |
|
entrada | Cadena | Opcional. Cadena JSON para pasar como entrada a la ejecución. |
|
traceHeader | Cadena | Opcional. Encabezado de rastreo de X-Ray para propagar en la ejecución. |
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Respuesta de la API de AWS Step Functions. |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si la ejecución no se pudo iniciar.
en caso de éxito. |
El siguiente ejemplo inicia una ejecución de corrección y captura el ARN de ejecución para los pasos posteriores.
Ejemplo de flujo de trabajo |
|---|
|
Detener una ejecución de Step Functions
El identificador de la acción es aws.stepFunctions.stopExecution.
Detiene una ejecución de Step Functions en curso. AWS marca la ejecución como ABORTED una vez que se detiene.
Importante
Esta acción solo es compatible con las máquinas de estado STANDARD. No puede detener EXPRESS ejecuciones.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS donde se está ejecutando la ejecución. |
|
executionArn | Cadena | Requerido. ARN de la ejecución a detener. |
|
error | Cadena | Opcional. Código de error corto que describe por qué se detuvo la ejecución. |
|
causa | Cadena | Opcional. Explicación legible por humanos de por qué se detuvo la ejecución. |
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Respuesta de la API de AWS Step Functions. |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si falló la detención de la ejecución.
en caso de éxito. |
El siguiente ejemplo aborta una ejecución que ha superado el SLA.
Ejemplo de flujo de trabajo |
|---|
|
Reimpulsar una ejecución de Step Functions
El identificador de la acción es aws.stepFunctions.redriveExecution.
Reimpulsa una ejecución de Step Functions fallida, con tiempo de espera agotado o cancelada, reanudándola desde el último estado no exitoso sin comenzar de nuevo desde el principio.
Importante
Esta acción solo es compatible con las máquinas de estado STANDARD. Una ejecución solo se puede reimpulsar si no ha SUCCEEDED, está dentro de los 14 días posteriores a su finalización y tiene menos de 24 999 eventos de historial.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS donde se realizó la ejecución. |
|
executionArn | Cadena | Requerido. ARN de la ejecución que se va a reimpulsar. |
|
clientToken | Cadena | Opcional. Token de idempotencia para la solicitud de redrive. Autogenerado por el SDK si se omite. |
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Respuesta de la API de AWS Step Functions. |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si el redrive falló.
en caso de éxito. |
El siguiente ejemplo reimpulsa una ejecución fallida para reanudarla desde su último estado no exitoso.
Ejemplo de flujo de trabajo |
|---|
|
Describir una ejecución de Step Functions
El identificador de la acción es aws.stepFunctions.describeExecution.
Devuelve el estado, la entrada, la salida y los timestamp para una ejecución de Step Functions. Utilice esta acción para sondear el resultado de una ejecución iniciada por aws.stepFunctions.startExecution.
Importante
Esta acción admite STANDARD ejecuciones de máquinas de estado directamente. Solo puede describir EXPRESS ejecuciones que despachó un Map Run.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS donde se realizó la ejecución. |
|
executionArn | Cadena | Requerido. ARN de la ejecución a describir. |
|
includedData | Enumeración | Opcional. Controla si se devuelve la definición de la ejecución. Utilice
para omitir el descifrado de la definición cuando el permiso
no esté disponible. Por defecto es
. |
o
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Detalles de la ejecución de la API de AWS Step Functions. En las ejecuciones |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si la solicitud falló.
en caso de éxito. |
El siguiente ejemplo sondea el estado de una ejecución y captura la salida para los pasos posteriores.
Ejemplo de flujo de trabajo |
|---|
|
Listar ejecuciones de Step Functions
El identificador de la acción es aws.stepFunctions.listExecutions.
Enumera las ejecuciones de una máquina de estado de AWS Step Functions o una ejecución de mapa, opcionalmente filtradas por estado. Los resultados se ordenan con los más recientes primero.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS en la que enumerar las ejecuciones. |
|
stateMachineArn | Cadena | Opcional. ARN de la máquina de estado cuyas ejecuciones se van a enumerar. Proporcione esto o
, no ambos. Las máquinas de estado
no se pueden enumerar directamente —en su lugar, use
para enumerar sus ejecuciones secundarias desde un mapa distribuido. |
|
mapRunArn | Cadena | Opcional. ARN de la ejecución de mapa cuyas ejecuciones secundarias enumerar. Proporcione esto o
, no ambos. Requerido al usar
. |
|
statusFilter | Enumeración | Opcional. Filtre las ejecuciones por estado.
requiere
. |
|
|
|
|
|
|
resultados máximos | En t | Opcional. Número máximo de ejecuciones que se devolverán. El valor predeterminado es 100, el máximo es 1000. |
|
nextToken | Cadena | Opcional. Token de paginación del
de una llamada anterior. Caduca después de 24 horas. |
|
redriveFilter | Enumeración | Opcional. Filtre las ejecuciones según si se han reimpulsado. |
o
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Lista de ejecuciones de la API de AWS Step Functions. |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si la solicitud falló.
en caso de éxito. |
El siguiente ejemplo enumera las ejecuciones actualmente en curso para una máquina de estado.
Ejemplo de flujo de trabajo |
|---|
|
Describir una máquina de estado
El identificador de la acción es aws.stepFunctions.describeStateMachine.
Devuelve la definición, el rol de IAM, la configuración de registro, el tipo (STANDARD o EXPRESS) y el estado de una máquina de estado de AWS Step Functions.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS donde está desplegada la máquina de estado. |
|
stateMachineArn | Cadena | Requerido. ARN de la máquina de estado que se va a describir. También acepta un ARN de versión. |
|
includedData | Enumeración | Opcional. Utilice
para omitir la devolución de la definición de la máquina de estado y evitar necesitar
cuando la definición está cifrada con KMS. Por defecto es
. |
o
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Detalles de la máquina de estado de la API de AWS Step Functions. El campo |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si la solicitud falló.
en caso de éxito. |
El siguiente ejemplo recupera el tipo y la definición de una máquina de estado.
Ejemplo de flujo de trabajo |
|---|
|
Enumerar máquinas de estado
El identificador de la acción es aws.stepFunctions.listStateMachines.
Enumera las máquinas de estado de AWS Step Functions en una cuenta y región. Use entradas de paginación para recuperar conjuntos de resultados grandes.
La siguiente tabla describe todos los campos de entrada disponibles para esta acción.
Aporte | Tipo | Descripción | Ejemplo |
|---|---|---|---|
awsRoleArn | Cadena | Opcional. ARN del rol de IAM a asumir. Recomendado. Tiene prioridad sobre las credenciales basadas en claves cuando se proporcionan ambas. |
|
awsAccessKeyId | Cadena (secreta) | Opcional. ID de clave de acceso de AWS. Debe pasarse como un secreto. |
|
awsSecretAccessKey | Cadena (secreta) | Opcional. Clave de acceso secreta de AWS. Debe pasarse como un secreto. |
|
awsSessionToken | Cadena (secreta) | Opcional. Token de sesión de AWS para credenciales temporales. Debe pasarse como un secreto. |
|
región | Cadena | Requerido. Región de AWS en la que enumerar las máquinas de estado. |
|
resultados máximos | En t | Opcional. Número máximo de máquinas de estado a devolver. El valor predeterminado es 100, el máximo es 1000. |
|
nextToken | Cadena | Opcional. Token de paginación del
de una llamada anterior. Caduca después de 24 horas. |
|
selectors | Lista | Opcional. Selectores JQ para extraer campos específicos de la salida de la acción. |
|
La siguiente tabla describe todos los campos de salida devueltos por esta acción.
Producción | Tipo | Descripción |
|---|---|---|
response | Objeto | Lista de máquinas de estado de la API de AWS Step Functions. |
success | Booleano |
en caso de éxito,
en caso de falla. |
errorMessage | Cadena | Mensaje de error si la solicitud falló.
en caso de éxito. |
El siguiente ejemplo enumera las máquinas de estado en la cuenta y captura el resultado para los pasos posteriores.
Ejemplo de flujo de trabajo |
|---|
|
Que sigue
Para continuar trabajando con las acciones de AWS y la automatización del flujo de trabajo, consulte los siguientes recursos.
- Configuración de credenciales de AWS: configure los roles de IAM y las claves de acceso para usarlos con las acciones de AWS.
- AWS Execute API: llamada API a cualquier API de AWS directamente cuando no haya una acción dedicada disponible.
- Ejemplos de flujos de trabajo: consulte ejemplos de flujos de trabajo del mundo real utilizando acciones de AWS.