...
| 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.
When AWS Credentials are not populated as part of the task definition, during task execution the integration will look for AWS Credentials on the task execution environment. Refer to configuration options for more information. |
| 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: 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. 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.
Required when Use Proxy is checked. |
| Proxy | Optional | - | Text | Comma separated list of Proxy servers. Valid formats: 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.
Required when Proxy Type isis configured for "HTTPS With Credentials". |
Task Examples
Start Asynchronous Execution
Example of AWS Step Functions Universal Task for triggering a Step Function with AWS Credentials and State Machine ARN only.
Start Asynchronous Execution With Proxy
...
- Environment Variables for AWS Region
- Input script
- Execution Name
- Proxy Type "HTTPS With Credentials"
Start Asynchronous Execution With IAM Role
...
- SUCCESS
- FAIL
- ABORTED
- TIMEOUT
Task Output
Cancellation logic
...
| 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 (2022-08-18)
Added: Basic Functionality for triggering an AWS Step Functions (#28543).