...
Template Name | Extension Name | Extension Version |
---|---|---|
AWS Batch | ue-aws-batch | 1.23.10 |
Refer to Changelog for version history information.
...
- Universal Agent for Windows x64 Version 7.02.0.0 and later with python options installed.
- Universal Agent for Linux Version 7.02.0.0 and later with python options installed.
...
Universal Controller Version 7.02.0.0 and later.
Network and Connectivity Requirements
...
This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
...
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. When AWS Region is not populated as part of the task definition, during task execution the integration will look for credentials on the task execution environment. Refer to configuration options for more information. |
AWS Credentials Optional since version 1.1.0 | 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) 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 Credentials". |
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 Credentials". |
Wait for Success or Failure Introduced in version 1.2.0 | Optional | False | Boolean | If selected, the task will continue running until Job reaches the "SUCCEDED" or "FAILED" state. Required for Action "Submit Job". |
Polling Interval Introduced in version 1.2.0 | Optional | 30 | Integer | The polling interval in seconds between checking for the Job status. Required when Wait for Success or Failure ="True". |
Task Examples
Note |
---|
There will be no specific cancel logic. In case of Retry, the Batch job will be re-submitted. |
Submit Job
...
Show full job information on Extension Output Introduced in version 1.3.0 | Optional | False | Boolean | Controls visibility on the latest Full Job Information as provided by AWS Batch Service. |
Task Examples
Submit Job
Example of AWS Batch Universal Task for submitting a new AWS Batch Job.
Submit Job with all optional input arguments
...
Environment Variables as AWS Region
Example of Universal Task for submitting a new AWS Batch Job providing no AWS Credentials in task definition and providing AWS Region as Environment Variable, leaving the respective input fields empty. AWS Credentials are expected in this case to be configured on the task execution environment. Please refer to AWS Credentials input field for more information.
Job Timeout
Container Overrides Script
Wait for Success or Failure
Proxy Type "HTTPS With Credentials"
Read Job Status with Role Based Access Enabled
Example of AWS Batch Universal Task for reading the status of an existing Batch Job by ID, Role Based Access and "HTTP Proxy" connection.
Task Output
Output Only Fields
...
Attribute | Type | Description |
---|---|---|
out_job_arn | string | ARN value of the newly submitted Batch Job. Generated in "Submit Job" Action. |
out_job_id | string | ID of the newly submitted Batch Job. Generated in "Submit Job" Action. |
out_job_name | string | Name of the Batch Job. Generated in "Read Job" Action Since 1.2.0: Generated for Action "Submit Job" with Wait for Success or Failure = "True", updating live during execution. |
out_job_status | string | Status of the Batch Job. Generated in "Read Job" Action Since 1.2.0: Generated for Action "Submit Job" with Wait for Success or Failure = "True", updating live during execution. |
job_info | JSON | Latest job information provided from Batch service Generated in "Read Job" and "Submit Job" Action |
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.23.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"
}
]
},
"wait_for_success_or_failure":true,
"polling_interval":3,
"full_job_info": true
}
},
"result":{
"out_job_name":"ue-aws-batch-demo-job",
"out_job_status":"SUCCEEDED",
"out_job_arn":"arn:aws:batch:us-east-1:123456789:job/1234-5678-90123-456-7890",
"out_job_id":"1111-11111-11111-11111-11111",
"job_info: [ ... ]
}
}
Cancelation and Re-Run
There will be no specific cancel logic. In case of Retry, the Batch job will be re-submitted.
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. Backward compatibility is not guaranteed.
...
Anchor | ||||
---|---|---|---|---|
|
Changelog
ue-aws-batch-1.3.0 (2023-12-11)
Enhancements
Added
: Extension Output is enhanced to provide the latest job information coming from the AWS Batch Service. (#33753)
ue-aws-batch-1.2.1 (2023-08-04)
...
ue-aws-batch-1.2.0 (2022-07-19)
Enhancements
Added
: Support Submit Batch Job and Wait until Job Reaches status "Succeeded" or "Failed (#29278)Added
: Output fields are updated during execution for the above scenario.Added
: Log payload response for Read and Submit Job Action on debug mode.
ue-aws-batch-1.1.0 (2022-06-09)
Enhancements
Added
: Provide the capabilty 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)
...