| Panel | |
|---|---|
|
Disclaimer
Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/
Overview
This integration allows customers to execute AWS Step Functions from Universal Controller.
Version Information
| Template Name | Extension Name | Extension Version |
|---|---|---|
| AWS Step Functions | ue-aws-stepfunctions | 1.0.0 |
Refer to Changelog for version history information.
...
The input fields for this Universal Extension are described below.
| Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
| Action | Required | Start Asynchronous Execution | Choice | Action performed upon the task execution. Available actions are as follows.
|
| AWS Region | Optional | - | Text | Region for the Amazon Web Service. When AWS Region is not populated as part of the task definition, during task execution the integration will look for the region as configured on the task execution environment. Refer to configuration options for more information. |
| AWS Credentials | Optional | - | Credentials | The Credentials definition should be as follows.
|
| Role Based Access | Optional | False | Boolean | Special type of authorization is provided by Role Assumption where the client sends his own credentials and the role he wants to assume from another user. If allowed, the client receives temporary credentials with limited time access to some resources. |
| Role ARN | Optional | - | Text | Role Amazon Resource Name (ARN) that will be used to access and execute the Step Function.Role ARN format: arn:aws:iam::<AWS Account ID>:instance-profile/<Role name>.Required when Role Based Access has been checked. |
| State Machine Arn | Required | - | Text | The Amazon Resource Name (ARN) of the state function to execute. |
| Execution Name | Optional | - | Text | The name of the execution. For more information and restrictions refer to Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. If empty when execution, the Universal Task will generate a unique value for each instance. Visible only when Action = “Start Asynchronous Execution”. |
| Input | Optional | - | Script | The string that contains the JSON input data for the execution. |
| Wait for Success or Failure | Optional | False | Boolean | If selected, the task will continue running until the task reaches the "SUCCEEDED", "FAILED", "ABORTED" or "TIMEOUT" state. Required when Action is "Start Asynchronous Execution". |
| Polling Interval | Optional | 10 | Integer | The polling interval in seconds between checking for the Step Function status. Required when Wait for Success or Failure ="True". |
| Use Proxy | Optional | False | Boolean | Flag to indicate whether Proxy shall be used in the communication with AWS. |
| Proxy Type | Optional | HTTP | Choice | Type of proxy connection to be used. The following options are available.
|
| Proxy | Optional | - | Text | Comma separated list of Proxy servers. Valid formats: http://proxyip:port or http://proxyip:port,https://proxyip:port. Required when Use Proxy is checked. |
| Proxy CA Bundle File | Optional | - | Text | The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy. Used when Proxy Type is configured for "HTTPS" or "HTTPS With Credentials". |
| Proxy Credentials | Optional | - | Credentials | Credentials to be used for the proxy communication. Credential definition should be as follows.
|
Task Examples
Start Asynchronous Execution
...
The output fields for this Universal Extension are described below.
| Field | Type | Preserved on re-run | Description |
|---|---|---|---|
| Execution Arn | Text | False | The Amazon Resource Name (ARN) that identifies the execution. |
| Execution Status | Text | False | The current status of the execution. |
Exit Codes
The exit codes for AWS Step Functions Extension are described below.
| Exit Code | Status Classification Code | Status Classification Description | Status Description |
|---|---|---|---|
| 0 | SUCCESS | Successful Execution | SUCCESS: AWS Step Functions workflow executed successfully. If the Wait for Success or Failure = "True" the SUCCESS exit code means the AWS Step Functions was successfully executed. |
| 0 | SUCCESS | Successful Execution | SUCCESS: SUCCESS: AWS Step Functions workflow started successfully If the Wait for Success or Failure = "False" the RUNNING exit code means the AWS Step Functions was successfully triggered. |
| 1 | FAIL | Failed Execution | FAIL: Unexpected error. Execute in Debug for more information. |
| 2 | AUTHENTICATION_ERROR | Bad credentials | AUTHENTICATION_ERROR: Account cannot be authenticated. |
| 3 | AUTHORIZATION_ERROR | Insufficient Permissions | AUTHORIZATION_ERROR: Account is not authorized to perform the requested action. |
| 10 | CONNECTION_ERROR | Bad connection data or connection timed out | CONNECTION_ERROR: < Error Description > |
| 11 | CONNECTION_ERROR | Extension specific connection error | CONNECTION_ERROR: ProxyConnectionError: Failed to connect to proxy URL <url> |
| 20 | DATA_VALIDATION_ERROR | Failed Execution | DATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDOUT for more details |
| 23 | FAIL | Successful Execution | FAILED: Step Function is in FAILED state. |
| 24 | FAIL | Successful Execution | FAILED: Step Function is in ABORTED state. |
| 25 | FAIL | Successful Execution | FAILED: Step Function is in TIMEOUT state. |
Extension Output
In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.
...
The Extension output contains attribute result. Attribute result contains the following sub-attributes.
| Attribute | Type | Description |
|---|---|---|
| executionArn | string | The Amazon Resource Name (ARN) that identifies the execution. |
| stateMachineArn | string | The Amazon Resource Name (ARN) that identifies the state machine. |
| name | string | The name of the execution. |
| startDate | string | The date the execution is started. |
| stopDate | string | If the execution has already ended, the date the execution stopped. Visible only when Wait for Success or Failure is selected |
| status | string | The current status of the execution. |
| output | string | The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. Visible only when Wait for Success or Failure is selected |
| outputDetails | object | Provides details about execution input or output. Include indicates whether output was included in the response. Always true for API calls. Visible only when Wait for Success or Failure is selected |
An example of the Extension Output for a successful execution an AWS Step Function with the Wait For Success or Failure option selected is presented below.
...
This document references the following documents.
| Document Link | Description |
|---|---|
| Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
| Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
| AWS Step Functions | User guide for AWS Step Functions. |
| IAM RBAC authorization model | User Documentation for Comparing ABAC to the traditional RBAC model. |
Changelog
ue-aws-stepfunctions-1.0.0
...