Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 tha the capability to submit new AWS Batch Jobs as well as read the status for an existing AWS Batch Job.

...

Software Requirements for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

...

Network and Connectivity Requirements

Extensions' Univesal 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.

...

  1. This Universal Task requires the Resolvable Credentials feature, check that the Resolvable Credentials Permitted system property has been set to true. For more information about Resolvable Credentials click here.

  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.

...

FieldInput typeDefault valueTypeDescription
ActionRequiredSubmit JobChoiceThe action Action performed upon the task execution. Available actions:
  • Submit Job
  • Read Job Status
AWS RegionRequired-TextRegion for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here.
AWS CredentialsRequired-CredentialsThe

AWS account credentials.

They are comprised of:

  • AWS access key ID
  • AWS secret access key
Role Based AccessOptionalFalseBoolean

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 ARNOptional-TextThe

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 NameOptional-TextThe name Name of the Batch Job that will be submitted.
Job DefinitionOptional-TextThe job

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 QueueOptional-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 TimeoutOptional-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

have not 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 ParametersOptional-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 IDOptional-Text

The Job ID of an already submitted Batch Job.

Required when Read Job Status action has been selected.

Use ProxyOptionalFalseBooleanFlag to indicate whether Proxy shall be used in the communication with AWS.
Proxy TypeOptionalHTTPChoiceType of proxy connection to be used.Available options are:
  • HTTP
  • HTTPS
  • HTTPS with password

Required when Use Proxy is checked.

ProxyOptional-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 FileOptional-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 CredentialsOptional-CredentialsCredentials 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".

Task Examples

Submit Job

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

...

NameLocationDescription
Universal Templateshttps://docs.stonebranch.com/confluence/display/U70U71/Universal+TemplatesUser documentation for creating Universal Templates in the Universal Controller user interface.
Universal Taskshttps://docs.stonebranch.com/confluence/display/UC70UC71/Universal+TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
AWS Batchhttps://docs.aws.amazon.com/batch/latest/userguide/what-is-batch.htmlUser guide for AWS Batch.
IAM RBAC authorization modelhttps://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_attribute-based-access-control.html#introduction_attribute-based-access-control_compare-rbacUser Documentation for Comparing ABAC to the traditional RBAC model.