...
The input fields for this Universal Extension are described below.
| Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
| Action | Required | Submit Job | Choice | The action performed upon the task execution. Available actions:
|
| AWS Region | Required | - | Text | Region for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here. |
| AWS Credentials | Required | - | Credentials | The AWS account credentials. They are comprised of:
|
| 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 | The Role Amazon Resource Name (ARN) to have access to the SQS queue.Role ARN format: arn:aws:iam::<AWS Account ID>:instance-profile/<Role name>.Required when Role Based Access has been checked. |
| Job Name | Optional | - | Text | The name of the Batch Job that will be submitted. |
| Job Definition | Optional | - | Text | The job definition used by this job. This value can be one of name , name:revision , or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used. Required when Submit Job action has been selected. |
| Job Queue | Optional | - | Text | The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. Required when Submit Job action has been selected. |
| Job Timeout | Optional | - | Integer | Can be filled when Action = Submit Job. The timeout configuration (in seconds) for this Submit Job operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. Optional when Submit Job action has been selected. |
| Additional Job Parameters | Optional | - | Array | Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. Optional when Submit Job action has been selected. |
| Job ID | Optional | - | Text | The Job ID of an already submitted Batch Job. Required when Read Job Status action has been selected. |
| 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.Available options are:
|
| 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 Password". |
| Proxy Credentials | Optional | - | Credentials | Credentials to be used for the proxy communication.They are comprised of:
|
Task Examples
Submit Job
Example of AWS Batch Universal Task for submitting a new AWS Batch Job.
...
The output parameters are set after every message processing. If they are 'preserved on re-run', they prevent a re-run of the task instance from restarting from scratch.
The output fields for this Universal Extension are described below.
| Field | Type | Preserved on re-run | Description |
|---|---|---|---|
| Job ARN | Text | False | ARN value of the newly submitted Batch Job. Generated in Submit Job action. |
| Job ID | Text | False | Id of the newly submitted Batch Job. Generated in Submit Job action. |
| Job Name | Text | False | Name of the Batch Job. Generated in Read Job Status action. |
| Job Status | Text | False | Status of the Batch Job. Generated in Read Job Status action. |
Exit Codes
The exit codes for AWS Batch Extension are described below.
| Exit Code | Status Classification Code | Status Classification Description | Status Description |
|---|---|---|---|
| 0 | SUCCESS | Successful Execution | SUCCESS: Successful Task execution |
| 1 | FAIL | Failed Execution | FAIL: < Error Description > |
| 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> |
| 21 | SUCCESS | Successful Execution | SUCCESS: Job is in FAILED state. |
| 22 | SUCCESS | Successful Execution | SUCCESS: Job is in RUNNING state. |
| 23 | SUCCESS | Successful Execution | SUCCESS: Job is in STARTING state. |
| 24 | SUCCESS | Successful Execution | SUCCESS: Job is in RUNNABLE state. |
| 25 | SUCCESS | Successful Execution | SUCCESS: Job is in SUBMITTED state. |
| 25 | SUCCESS | Successful Execution | SUCCESS: Job is in SUCCEEDED state. |
Extension Output
The Extension Output for AWS Batch Universal Task successful execution is described below.
...
This document references the following documents:
| Name | Location | Description |
|---|---|---|
| Universal Templates | https://docs.stonebranch.com/confluence/display/U70/Universal+Templates | User documentation for creating Universal Templates in the Universal Controller user interface. |
| Universal Tasks | https://docs.stonebranch.com/confluence/display/UC70/Universal+Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
| AWS Batch | https://docs.aws.amazon.com/batch/latest/userguide/what-is-batch.html | User guide for AWS Batch |
| IAM RBAC authorization model | https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_attribute-based-access-control.html#introduction_attribute-based-access-control_compare-rbac | User Documentation for Comparing ABAC to the traditional RBAC model |