Defining AWS Batch Submit Job Properties

Batch Submit Jobs allow you to submit an AWS Batch job from a definition and, if required, to override parameters set in the job definition from Automic Automation.

To start a Submit Job successfully, you have to define all the relevant parameters. Optionally, you can also define other properties and parameters that you want to pass to the integration.

On the Submit Job page, you define the parameters relevant to run the job on your AWS Batch environment:

• Connection

  Batch Connection object containing the relevant information to connect to the application.

  To search for a Connection object, start typing its name to limit the list of the objects that match your input.

• Execution Type

  Choose if you want to define the job using Parameters or using a JSON Payload.

  Parameters

  • Job Queue

    Define the job queue where the job is submitted. You can click the browse button to the right of the field to open a picker dialog where you can select the relevant queue.

  • Job Definition

    Set the relevant job definition. You can click the browse button to the right of the field to open a picker dialog where you can select the relevant job definition.

    Important!

    The job definition list includes all revisions available for a job definition. It also shows if the respective definition is active or inactive. Please make sure the job definition you want to use is active, otherwise the job will fail.

  • Job Name

    Define the relevant Job name.

    This is the name that you want to use to execute the job. It can have up to 128 characters and can contain upper and lowercase, numbers, hyphens and underscores. However, you have to make sure that the first character is alphanumeric.

    You can also use variables for the job name definition.

    Example

    JOB&$RUNID#

    This allows you to use the Run ID of the execution as the Job Name.

  • Container Overrides (in JSON format)

    Define the properties that you want pass at runtime and that you want to use to override the default command for a container.

    Example

    

    The command in the Job definition is overridden by the definition of the Container Overrides field for the next execution.

  • Job Attempts

    Define the number of times a job should be retried (moved to the RUNNABLE status) after failing.

    Allowed values: 1 - 10

  • Execution Timeout (in seconds)

    Define the time duration after which AWS Batch terminates unfinished jobs.

  JSON Payload

  Allows you to pass the job definition to AWS Batch in JSON format.

  Important!
  

  When using the With JSON Payload option, you:

  • Must use the complete ARN for the Job Definition (arn:aws:batch:region:account:job-definition/definition-name:revision) and the Job Queue (arn:aws:batch:region:account:job-queue/queue-name).

  • Can also pass additional parameters to the job to replace parameter substitution placeholders that are set in the job definition. They are specified as a key and value pair mapping and override any corresponding parameter defaults from the job definition.

  Select one of the options available:

  • JSON

    Use the JSON field to enter the JSON payload definition.

    Note:

    When using a JSON definition, you can also pass job definition parameters to your Batch environment. They are specified as a key and value pair mapping and override any corresponding parameter defaults from the job definition.

    Example

    {
      "containerOverrides": {
        "command": [
          "echo",
          "hello world"
        ]
      },
      "jobDefinition": "arn:aws:batch:<region>:<account>:job-definition/withParam:1",
      "jobName": "job-with-param",
      "jobQueue": "arn:aws:batch:<region>:<account>:job-queue/<Job Queue>",
      "retryStrategy": {
        "attempts": 1
      },
      "parameters": {
        "key1": "demo",
        "key2": "123"
      },
      "timeout": {
        "attemptDurationSeconds": 60
      }
    }

  • File Path

    Use the JSON File Path field to define the path to the JSON file containing the attributes that you want to pass to the application. Make sure that the file is available on the Agent machine (host).

• Defining RA/Integration Reports Properties

• Defining Common Job Properties

• Executing AWS Batch Jobs

• Monitoring AWS Batch Jobs