Referencia de acciones de invocación de AWS Step Functions

Acción de AWS CodePipeline que hace lo siguiente:

Tipo de acción

Parámetros de configuración

Artefactos de entrada

Artefactos de salida

Variables de salida

Esta acción produce variables de salida a las que se puede hacer referencia en la configuración de una acción descendente de la canalización.

Para obtener más información, consulte Referencia de variables.

Permisos del rol de servicio: acción StepFunctions

A continuación se indican los permisos mínimos que se necesitan en StepFunctions para crear canalizaciones con una acción de invocación de Step Functions.

{
    "Effect": "Allow",
    "Action": [
        "states:DescribeStateMachine",
        "states:DescribeExecution",
        "states:StartExecution"
    ],
    "Resource": "resource_ARN"
},

Ejemplo de configuración de una acción

Ejemplo de una entrada predeterminada

YAML

Name: ActionName
ActionTypeId:
  Category: Invoke
  Owner: AWS
  Version: 1
  Provider: StepFunctions
OutputArtifacts:
  - Name: myOutputArtifact
Configuration:
  StateMachineArn: arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine
  ExecutionNamePrefix: my-prefix

JSON

{
    "Name": "ActionName",
    "ActionTypeId": {
        "Category": "Invoke",
        "Owner": "AWS",
        "Version": 1,
        "Provider": "StepFunctions"
    },
    "OutputArtifacts": [
        {
            "Name": "myOutputArtifact"
        }
    ],
    "Configuration": {
        "StateMachineArn": "arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine",
        "ExecutionNamePrefix": "my-prefix"
    }
}

Ejemplo de una entrada literal

YAML

Name: ActionName
ActionTypeId:
  Category: Invoke
  Owner: AWS
  Version: 1
  Provider: StepFunctions
OutputArtifacts:
  - Name: myOutputArtifact
Configuration:
  StateMachineArn: arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine
  ExecutionNamePrefix: my-prefix
  Input: '{"action": "test"}'

JSON

{
    "Name": "ActionName",
    "ActionTypeId": {
        "Category": "Invoke",
        "Owner": "AWS",
        "Version": 1,
        "Provider": "StepFunctions"
    },
    "OutputArtifacts": [
        {
            "Name": "myOutputArtifact"
        }
    ],
    "Configuration": {
        "StateMachineArn": "arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine",
        "ExecutionNamePrefix": "my-prefix",
        "Input": "{\"action\": \"test\"}"
    }
}

Ejemplo de un archivo de entrada

YAML

Name: ActionName
InputArtifacts:
  - Name: myInputArtifact
ActionTypeId:
  Category: Invoke
  Owner: AWS
  Version: 1
  Provider: StepFunctions
OutputArtifacts:
  - Name: myOutputArtifact
Configuration:
  StateMachineArn: 'arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine'
  ExecutionNamePrefix: my-prefix
  InputType: FilePath
  Input: assets/input.json

JSON

{
    "Name": "ActionName",
    "InputArtifacts": [
        {
            "Name": "myInputArtifact"
        }
    ],
    "ActionTypeId": {
        "Category": "Invoke",
        "Owner": "AWS",
        "Version": 1,
        "Provider": "StepFunctions"
    },
    "OutputArtifacts": [
        {
            "Name": "myOutputArtifact"
        }
    ],
    "Configuration": {
        "StateMachineArn": "arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine",
        "ExecutionNamePrefix": "my-prefix",
        "InputType": "FilePath",
        "Input": "assets/input.json"
    }
}

Comportamiento

Durante un lanzamiento, CodePipeline ejecuta la máquina de estado configurada utilizando la entrada especificada en la configuración de la acción.

Cuando InputType está establecido en Literal, el contenido del campo Input de la configuración de la acción se utiliza como entrada de la máquina de estados. Cuando no se proporciona una entrada literal, la ejecución de la máquina de estados utiliza un objeto JSON vacío, {}. Para obtener más información sobre la ejecución de una máquina de estados sin entrada, consulte la API StartExecution de Step Functions.

Cuando InputType está establecido en FilePath, la acción descomprime el artefacto de entrada y utiliza el contenido del archivo especificado en el campo Input de la configuración de la acción como entrada de la máquina de estados. Cuando se especifica FilePath, el campo Input es obligatorio y debe existir un artefacto de entrada; de lo contrario, la acción no se ejecutará correctamente.

Después de una ejecución de inicio correcta, el comportamiento será distinto en los dos tipos de máquina de estados, estándar y rápida.

Máquinas de estados estándar

Si la ejecución de la máquina de estados estándar se inició correctamente, CodePipeline sondeará la API DescribeExecution hasta que la ejecución alcance un estado terminal. Si la ejecución se completa correctamente, la acción será correcta; de lo contrario, se producirá un error.

Si hay un artefacto de salida configurado, contendrá el valor de retorno de la máquina de estados. Esta información se obtiene de la propiedad output de la respuesta de la API DescribeExecution de Step Functions una vez que la ejecución de la máquina de estados se completa correctamente. Tenga en cuenta que existen restricciones en la longitud de salida de esta API.

Gestión de errores

Máquinas de estados rápidas

Si la ejecución de la máquina de estados rápida se inició correctamente, la ejecución de la acción de invocación también se realizará correctamente.

Consideraciones sobre las acciones configuradas para máquinas de estados rápidas:

Gestión de errores

Véase también

Los recursos relacionados siguientes pueden serle de ayuda cuando trabaje con esta acción.