AWS Batch Connector 1.0.0.0

The AWS Batch Connector lets you list, import, and run AWS Batch job definitions.

Prerequisites

  • RunMyJobs 9.2.9 or higher.
  • Connection Management Extension 1.0.0.4 or later. This will be installed or updated automatically if necessary when you install the AWS Batch Connector.
  • AWS S3 Utilities 1.0.0.0 or later. This will be installed or updated automatically if necessary when you install the AWS Batch Connector.
  • An AWS Connection.
  • Privileges Required to Use the AWS Batch Connector.

Contents of the Component

Object Type Name Description
Application GLOBAL.Redwood.REDWOOD.AWS.REDWOOD.Batch Amazon Web Services Batch (1.0.0.0)
Constraint Definition REDWOOD.Redwood_AWS_Batch_JobDefinitionConstraint Constraint for AWS Batch Job Definition field
Constraint Definition REDWOOD.Redwood_AWS_Batch_JobQueueConstraint Constraint for AWS Batch Job Queue field
Job Definition REDWOOD.Redwood_AWS_Batch_ImportJobs Import jobs from AWS Batch
Job Definition REDWOOD.Redwood_AWS_Batch_ListJobDefinitions List AWS Job Definitions
Job Definition REDWOOD.Redwood_AWS_Batch_SubmitJob Submit AWS Batch Jobs
Job Definition REDWOOD.Redwood_AWS_Batch_SubmitJobTemplate Template definition to submit AWS Batch Jobs
Job Definition Type REDWOOD.Redwood_AWS_Batch Amazon Web Services Batch Connector
Library REDWOOD.Redwood_AWS_Batch Library for Amazon Web Services Batch connector

Redwood_AWS_Batch_ImportJobs

Lets you import jobs from AWS Batch.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection The name of the connection for AWS Batch. String In

Parameters regionName Region The name of the Region that the AWS Batch Job is located in. String In

Parameters jobDefinitionNameFilter Definition Name Filter Only return Job Definitions whose name matches the filter. Wildcards * and ? are supported. If omitted, all Job Definitions in the specified region will be returned. String In

Parameters revision Revision Whether to create a Process Definition for each revision of the matching jobs, or only import the latest available revision. String In Latest Latest, All
Generation Settings overwrite Overwrite Existing Definition

When set to Y, if a definition already exists with the same name as the name generated for the imported object, it will be overwritten with the new import.

When set to N, the import for that template will be skipped if a definition with the same name already exists.

 String In N Y, N
Generation Settings targetPartition Partition The Partition to create the new definitions in. String In

QueryFilter:User.Redwood System.Partition.Partition%2e;all
Generation Settings targetApplication Application The Application to create the new definitions in. String In

QueryFilter:User.Redwood System.Application.Application%2e;all
Generation Settings defaultQueue Default Queue The default Queue to assign to the generated definitions. String In

QueryFilter:User.Redwood System.Queue.Queue%2e;all
Generation Settings targetPrefix Definition Name Prefix The prefix to add onto the name of the imported AWS Batch Job to create the definition name. String In CUS_AWSB_

Redwood_AWS_Batch_ListJobDefinitions

Lists AWS job Definitions.

Parameters

Tab Name Description Documentation Data Type Direction
Parameters connection Connection The Connection object to use to connect to AWS Batch. String In
Parameters regionName Region The region that the Batch Job is in. String In
Parameters jobDefinitionNameFilter Definition Name Filter Only return Job Definitions whose name matches the filter. Wildcards * and ? are supported. If omitted, all Job Definitions in the specified region will be returned. String In
Parameters listing Definition Listing Link to the generated RTX file containing the listing output. Table Out

Redwood_AWS_Batch_SubmitJob

Lets you submit AWS Batch jobs.

Parameters

Tab Name Description Documentation Data Type Direction
Parameters connection Connection The name of the connection for AWS Batch. String In
Parameters regionName Region The name of the Region that the AWS Batch Job is located in. String In
Parameters jobDefinitionName Job Definition Name The name of the AWS Batch Job Definition to run. String In
Parameters queue Queue The name of the Queue to run the job on. String In
Parameters jobName Job Name The name to assign to the AWS Batch Job. String In
Parameters jobParameters Job Parameters The desired Job Parameters to submit with the job. Each entry in the array must be a key=value pair where the key is the Parameter name and the Value is the parameter value. String In
Parameters environmentVariables Environment Variables The desired Environment Variables to submit with the job. Each entry in the array must be a key=value pair where the key is the Environment Variable name and the Value is the Environment Variable value. String In
Parameters jobId Job Id The id of the job run String Out

Redwood_AWS_Batch_SubmitJobTemplate

Template definition to submit AWS Batch jobs.

Parameters

Tab Name Description Documentation Data Type Direction
Parameters connection Connection The name of the connection for AWS Batch. String In
Parameters regionName Region The name of the Region that the AWS Batch Job is located in. String In
Parameters jobDefinitionName Job Definition Name The name of the AWS Batch Job Definition to run. String In
Parameters queue Queue The name of the Queue to run the job on. String In
Parameters jobName Job Name The name of the AWS Batch Job. String In
Parameters jobParameters Job Parameters The desired Job Parameters to submit with the job. Each entry in the array must be a key=value pair where the key is the Parameter name and the Value is the parameter value. String In
Parameters environmentVariables Environment Variables The desired Environment Variables to submit with the job. Each entry in the array must be a key=value pair where the key is the Environment Variable name and the Value is the Environment Variable value. String In
Parameters jobId Job Id The id of the job run. String Out

Listing AWS Batch Job Definitions

You can use the Redwood_AWS_Batch_ListJobDefinitions Process Definition to query a particular AWS Batch instance. This Process Definition returns the contents of the bucket in RTX format, so that you can use it in a Chain Definition.

To list AWS Batch job definitions:

  1. In the AWS > Batch Application, submit the Redwood_AWS_Batch_ListJobDefinitions Process Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Batch jobs definitions are in.

  4. Optionally, to limit the results, enter a Definition Name Filter. You can use the wildcard characters ? and *.

  5. Submit the Process Definition.

  6. In the Process Monitor, select the process, then look at the Detail View. Under Files, the listing.rtx file contains the response (if any).

Importing AWS Batch Job Definitions

To import AWS Batch job definitions:

  1. In the AWS > Batch Application, submit the Redwood_AWS_Batch_ImportJobs Process Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Batch jobs definitions are in.

  4. Optionally, to limit the results, enter a Definition Name Filter. You can use the wildcard characters ? and *.

  5. Choose either Latest or All from the Revision dropdown list.

  6. Switch to the Generation Settings tab.

  7. To indicate whether to overwrite any matching AWS Batch job definitions you've already imported, choose an option from the Overwrite Existing Definition dropdown list.
  8. Optionally specify a Partition, Application, and Default Queue.
  9. To specify a prefix to be applied to the imported AWS Batch job definition(s), enter a value in the Definition Name Prefix field.

  10. Submit the Process Definition.

Running an AWS Batch Job

To run an imported AWS Batch job definition:

  1. In the AWS > Batch Application, submit the Redwood_AWS_Batch_SubmitJob Process Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Batch jobs definition is in.

  4. Enter the Job Definition Name defined in AWS Batch.

  5. Specify a Queue.

  6. Enter a Job Name to be assigned to the executed job definition.

  7. Enter any Job Parameters you want to use as key=value pairs.

  8. Enter any Environment Variables you want to use as key=value pairs.

  9. Submit the Process Definition.

Running an AWS Batch Job with a Template

To create a customized Process Definition, optionally with default values, for running an AWS Batch job:

  1. Right-click the Redwood_AWS_Batch_SubmitJobTemplate Process Definition and choose New (from Template) from the context menu. The New Process Definition pop-up window displays.

  2. Choose a Partition.

  3. Enter a Name.

  4. Delete the default Application value (if any) and substitute your own Application name if desired.

  5. In the Parameters tab, enter any Default Expressions you want to use.

    • When specifying the Connection value, use the format EXTCONNECTION:<partition>.<connection name>.

  6. Save and then submit the new Process Definition.