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.

...

Field	Input type	Default value	Type	Description
Action	Required	Submit Job	Choice	Action performed upon the task execution. Available actions: Submit Job Read Job Status
AWS Region Required 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 Required Optional since version 1.1.0	Optional	-	Credentials	AWS account credentials. They are comprised of: AWS access key ID AWS secret access key
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: `arn:aws:iam::<AWS Account ID>:instance-profile/<Role name>`. 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: HTTP HTTPS HTTPS with password Required when Use Proxy is checked.
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: username password Required when Proxy Type is configured for "HTTPS" or "HTTPS With Password".

...

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.

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 described below.

...

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

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)

Versions Compared

Old Version 16

New Version 17

Key

Version Information

Software Requirements

Submit Job with Container Overrides payload

Task Output

Output Only Fields

STDOUT and STDERR

Document References

Changelog

ue-aws-batch-1.1.0 (2022-06-03)

Enhancements

ue-aws-batch-1.0.1 (2022-03-14)

Enhancements

Fixes

Page Comparison

Versions Compared

Old Version 16

New Version 17

Key

Version Information

Software Requirements

Submit Job with Container Overrides payload

Task Output

Output Only Fields

STDOUT and STDERR

Document References

Changelog

ue-aws-batch-1.1.0 (2022-06-03)

Enhancements

ue-aws-batch-1.0.1 (2022-03-14)

Enhancements

Fixes