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
AWS Batch is a set of batch management capabilities that enables developers, scientists, and engineers to easily and efficiently run hundreds of thousands of batch computing jobs on AWS.
This Universal Extension provides the capability to submit new AWS Batch Jobs as well as read the status for an existing AWS Batch Job.
Version Information
Extension Name | Extension Version | Template Name |
---|---|---|
ue-aws-batch | 1.1.0 | AWS Batch |
Software Requirements
This integration requires a Universal Agent and a Python runtime to execute the Universal Task.
Software Requirements for Universal Template and Universal Task
Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.
Software Requirements for Universal Agent
Both Windows and Linux agents are supported:
- Universal Agent for Windows x64 Version 7.0.0.0 and later with python options installed.
- Universal Agent for Linux Version 7.0.0.0 and later with python options installed.
Software Requirements for Universal Controller
Universal Controller Version 7.0.0.0 and later.
Network and Connectivity Requirements
Extensions' Universal Agent host should be able to reach AWS Batch REST endpoints, through the configured VPC.
More information on setting up AWS Batch VPC, can be found in the AWS Batch official user guide.
Key Features
This Universal Extension provides the following key features:
- Support to submit a new Batch Job, with option to Terminate Job after a timeout period.
- Support to read Batch Job status for an existing Job ID.
- Support for authorization via IAM Role-Based Access Control (RBAC) strategy.
- Support for Proxy communication via HTTP/HTTPS protocol.
Import Universal Template
To use the Universal Template, you first must perform the following steps:
- This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
Download the provided ZIP file.
In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.
Click Import Template.
Select the template ZIP file and Import.
When the template has been imported successfully, the Universal Template will appear on the list, refresh your Navigation Tree to see these tasks in the Automation Center Menu.
Configure Universal Task
For the new Universal Task type AWS Batch, create a new task, and enter the task-specific details that were created in the Universal Template.
Input Fields
The input fields for this Universal Extension are described below.
Field | Input type | Default value | Type | Description |
---|---|---|---|---|
Action | Required | Submit Job | Choice | Action performed upon the task execution. Available actions:
|
AWS Region Optional since version 1.1.0 | Optional | - | Text | Region for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here. |
AWS Credentials Optional since version 1.1.0 | Optional | - | Credentials | 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 | Role Amazon Resource Name (ARN) to have access to the SQS queue.Role ARN format: Required when Role Based Access has been checked. |
Job Name | Optional | - | Text | Name of the Batch Job that will be submitted. |
Job Definition | Optional | - | Text | 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 have not finished. If a job is terminated due to a timeout, it is not 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. |
Container Overrides Script Introduced in version 1.1.0 | Optional | - | Script Field | The overrides that user want to apply on the container. The script payload should be in JSON format. |
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:
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 Password". |
Proxy Credentials | Optional | - | Credentials | Credentials to be used for the proxy communication.They are comprised of:
Required when Proxy Type is configured for "HTTPS" or "HTTPS With Password". |
Task Examples
Submit Job
Example of AWS Batch Universal Task for submitting a new AWS Batch Job.
Read Job Status
Example of AWS Batch Universal Task for reading the status of an existing Batch Job by id.
Submit Job with Role Based Access Enabled
Example of AWS Batch Universal Task for submitting a new AWS Batch Job, with Role Based Access enabled.
HTTP Proxy Type Task Configuration
Example of AWS Batch Universal Task for reading job status through HTTP
proxy connection.
HTTPS Proxy Type Task Configuration
Example of AWS Batch Universal Task for reading job status through HTTPS
proxy connection.
HTTPS with password Proxy Type Task Configuration
Example of AWS Batch Universal Task for reading job status through HTTPS with password
proxy connection.
Submit Job with Container Overrides payload
Example of AWS Batch Universal Task for submitting a new AWS Batch Job and setting a payload for containerOverrides parameter.
Task Output
Output Only Fields
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.
{
"exit_code": 0,
"status_description": "SUCCESS: AWS Batch Task submitted successfully",
"changed": true,
"invocation": {
"extension": "ue-aws-batch",
"version": "1.1.0",
"fields": {
"action": "Submit Job",
"credentials_user": "****",
"credentials_password": "****",
"region": "us-east-1",
"role_based_access": false,
"role_arn": null,
"job_name": "ue-aws-batch-demo-job",
"job_definition": "ue-aws-batch-job-definition",
"job_queue": "ue-aws-batch-test-queue",
"job_timeout": 100,
"additional_job_parameters": [],
"job_id": null,
"use_proxy": false,
"proxy_type": null,
"proxy": null,
"proxy_credentials_user": null,
"proxy_credentials_password": null,
"proxy_ca_bundle_file": null,
"container_overrides_script": {
"environment": [
{
"name": "ENV_VAR1",
"value": "value 1"
},
{
"name": "ENV_VAR2",
"value": "value 2"
}
]
}
}
},
"result": {
"out_job_arn": "arn:aws:batch:us-east-1:123456789:job/3c50a3f7-02de-46bc-bd67-490d5ceb2bc2",
"out_job_id": "3c50a3f7-02de-46bc-bd67-490d5ceb2bc2"
}
}
Attribute result
contains the following sub-attributes.
Attribute | Output Type | Mandatory | Description |
---|---|---|---|
out_job_arn | String | No | Submitted job ARN Available when Action is "Submit Job" |
out_job_id | String | No | Submitted job Id Available when Action is "Submit Job" |
out_job_name | String | No | Job Name Available when Action is "Read Job Status" |
out_job_status | String | No | Job Status Available when Action is "Read Job Status" |
STDOUT and STDERR
STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice.
Document References
This document references the following documents:
Name | Location | Description |
---|---|---|
Universal Templates | https://docs.stonebranch.com/confluence/display/UC72x/Universal+Templates | User documentation for creating Universal Templates in the Universal Controller user interface. |
Universal Tasks | https://docs.stonebranch.com/confluence/display/UC72x/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. |
Changelog
ue-aws-batch-1.1.0 (2022-06-09)
Enhancements
Added
: Provide the capability to rely on AWS credentials set-up on the environment where the extension is running and therefore it is not mandatory to be passed on the task definition as input fields. The same applies to AWS Region. (#28286)Added
: AWS Region can be resolved from environment variables. (#28286)Added
: Support for "containerOverrides" parameter. (#28860)
ue-aws-batch-1.0.1 (2022-03-14)
Enhancements
Added
: Update of extension icon. (#27753)
Fixes
Fixed
Fix wrong exit code when invalid ARN is provided. (#27736)Fixed
Fix response message when status is SUCCESS. (#27730)