...

Refer to Changelog for version history information.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

...

• Support to submit a new Batch Job, with option to Terminate Job after a timeout period.
• Support to submit a new Batch Job and wait until it reaches state "success" or "failed".
• 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.

...

To use the Universal Template, you first must perform the following steps:

1. This Universal Task requires the Resolvable Credentials feature

   . Check

   , check that the Resolvable Credentials Permitted system property has been set to true.

2. Download the provided ZIP file.

3. In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.

4. Click Import Template.

5. Select the template ZIP file and Import.

...

1. For more information about Resolvable Credentials click here.

2. To import the Universal Template into your Controller, follow the instructions here.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list

...

1. .

Configure Universal Task

For the a new Universal Task type AWS Batch, create a new task, and enter the task-specific details that were created in the Universal Templaterequired input fields.

Input Fields

The input fields for this Universal Extension are described below.

Task Examples

Submit Job

Example of AWS Batch Universal Task for submitting a new AWS Batch Job.

Image Removed

Read Job Status

Example of AWS Batch Universal Task for reading the status of an existing Batch Job by id.

Image Removed

Submit Job with Role Based Access Enabled

...

Task Examples

Submit Job

Example of AWS Batch Universal Task for submitting a new AWS Batch Job, with Role Based Access enabled.

Image Removed

...

Image Added

Submit Job with all optional input arguments

Example of AWS Batch Universal Task for reading job status through HTTP proxy connection.

Image Removed

...

submitting a new AWS Batch with the following arguments.

• Environment Variables as AWS Region

  Example of

...

• Universal Task for

...

Image Removed

HTTPS with password Proxy Type Task Configuration

Example of AWS Batch Universal Task for reading job status through HTTPS with password proxy connection.

Image Removed

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.

...

• 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"

Image Added

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.

Image Added

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 fields for this Universal Extension are described below.

Exit Codes

The exit codes for AWS Batch Extension are described below.

Exit Codes

The exit codes for AWS Batch Extension are described below.

Attribute changed is populated as follows

• true, in case Action "Submit Job" is executed successfully.
• false, in case Action "Read Job" is executed.

The Extension output contains attribute result. Attribute result contains the following sub-attributes:

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.12.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": [],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": [           "environment":[
         {      {
                  "name": "ENV_VAR1",
                        "value": "value 1"
    
               },
 
                  {
     
                  "name": "ENV_VAR2",
    
                   "value": "value 2"
                    }
               }
]            ]
}         },
    },     "resultwait_for_success_or_failure":true,
{         "outpolling_job_arninterval": "arn:aws:batch:us-east-1:123456789:job/3c50a3f7-02de-46bc-bd67-490d5ceb2bc2"3
      }
   },
   "result":{
      "out_job_idname": "3c50a3f7ue-02deaws-46bcbatch-bd67demo-490d5ceb2bc2job",
    }
}

Attribute result contains the following sub-attributes.

...

  "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"
   }
}

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.

Document References

This document references the following documents:.

...

Anchor
Changelog Changelog

Changelog

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 capability 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)

Fixes

• Fixed Fix wrong exit code when invalid ARN is provided. (#27736)
• Fixed Fix response message when status is SUCCESS. (#27730)

...