Skip to content

Register Job Definition

batch_register_job_definition R Documentation

Registers an Batch job definition

Description

Registers an Batch job definition.

Usage

batch_register_job_definition(jobDefinitionName, type, parameters,
  schedulingPriority, containerProperties, nodeProperties, retryStrategy,
  propagateTags, timeout, tags, platformCapabilities, eksProperties,
  ecsProperties)

Arguments

jobDefinitionName

[required] The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

type

[required] The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

  • If the value is container, then one of the following is required: containerProperties, ecsProperties, or eksProperties.

  • If the value is multinode, then nodeProperties is required.

If the job is run on Fargate resources, then multinode isn't supported.

parameters

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a submit_job request override any corresponding parameter defaults from the job definition.

schedulingPriority

The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

containerProperties

An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS-based job definitions.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

nodeProperties

An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

If the job runs on Amazon EKS resources, then you must not specify nodeProperties.

retryStrategy

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a submit_job operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

propagateTags

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

If the job runs on Amazon EKS resources, then you must not specify propagateTags.

timeout

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they 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. Any timeout configuration that's specified during a submit_job operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

tags

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

platformCapabilities

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.

eksProperties

An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.

ecsProperties

An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.

Value

A list with the following syntax: 

list(
  jobDefinitionName = "string",
  jobDefinitionArn = "string",
  revision = 123
)

Request syntax

svc$register_job_definition(
  jobDefinitionName = "string",
  type = "container"|"multinode",
  parameters = list(
    "string"
  ),
  schedulingPriority = 123,
  containerProperties = list(
    image = "string",
    vcpus = 123,
    memory = 123,
    command = list(
      "string"
    ),
    jobRoleArn = "string",
    executionRoleArn = "string",
    volumes = list(
      list(
        host = list(
          sourcePath = "string"
        ),
        name = "string",
        efsVolumeConfiguration = list(
          fileSystemId = "string",
          rootDirectory = "string",
          transitEncryption = "ENABLED"|"DISABLED",
          transitEncryptionPort = 123,
          authorizationConfig = list(
            accessPointId = "string",
            iam = "ENABLED"|"DISABLED"
          )
        )
      )
    ),
    environment = list(
      list(
        name = "string",
        value = "string"
      )
    ),
    mountPoints = list(
      list(
        containerPath = "string",
        readOnly = TRUE|FALSE,
        sourceVolume = "string"
      )
    ),
    readonlyRootFilesystem = TRUE|FALSE,
    privileged = TRUE|FALSE,
    ulimits = list(
      list(
        hardLimit = 123,
        name = "string",
        softLimit = 123
      )
    ),
    user = "string",
    instanceType = "string",
    resourceRequirements = list(
      list(
        value = "string",
        type = "GPU"|"VCPU"|"MEMORY"
      )
    ),
    linuxParameters = list(
      devices = list(
        list(
          hostPath = "string",
          containerPath = "string",
          permissions = list(
            "READ"|"WRITE"|"MKNOD"
          )
        )
      ),
      initProcessEnabled = TRUE|FALSE,
      sharedMemorySize = 123,
      tmpfs = list(
        list(
          containerPath = "string",
          size = 123,
          mountOptions = list(
            "string"
          )
        )
      ),
      maxSwap = 123,
      swappiness = 123
    ),
    logConfiguration = list(
      logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
      options = list(
        "string"
      ),
      secretOptions = list(
        list(
          name = "string",
          valueFrom = "string"
        )
      )
    ),
    secrets = list(
      list(
        name = "string",
        valueFrom = "string"
      )
    ),
    networkConfiguration = list(
      assignPublicIp = "ENABLED"|"DISABLED"
    ),
    fargatePlatformConfiguration = list(
      platformVersion = "string"
    ),
    ephemeralStorage = list(
      sizeInGiB = 123
    ),
    runtimePlatform = list(
      operatingSystemFamily = "string",
      cpuArchitecture = "string"
    ),
    repositoryCredentials = list(
      credentialsParameter = "string"
    )
  ),
  nodeProperties = list(
    numNodes = 123,
    mainNode = 123,
    nodeRangeProperties = list(
      list(
        targetNodes = "string",
        container = list(
          image = "string",
          vcpus = 123,
          memory = 123,
          command = list(
            "string"
          ),
          jobRoleArn = "string",
          executionRoleArn = "string",
          volumes = list(
            list(
              host = list(
                sourcePath = "string"
              ),
              name = "string",
              efsVolumeConfiguration = list(
                fileSystemId = "string",
                rootDirectory = "string",
                transitEncryption = "ENABLED"|"DISABLED",
                transitEncryptionPort = 123,
                authorizationConfig = list(
                  accessPointId = "string",
                  iam = "ENABLED"|"DISABLED"
                )
              )
            )
          ),
          environment = list(
            list(
              name = "string",
              value = "string"
            )
          ),
          mountPoints = list(
            list(
              containerPath = "string",
              readOnly = TRUE|FALSE,
              sourceVolume = "string"
            )
          ),
          readonlyRootFilesystem = TRUE|FALSE,
          privileged = TRUE|FALSE,
          ulimits = list(
            list(
              hardLimit = 123,
              name = "string",
              softLimit = 123
            )
          ),
          user = "string",
          instanceType = "string",
          resourceRequirements = list(
            list(
              value = "string",
              type = "GPU"|"VCPU"|"MEMORY"
            )
          ),
          linuxParameters = list(
            devices = list(
              list(
                hostPath = "string",
                containerPath = "string",
                permissions = list(
                  "READ"|"WRITE"|"MKNOD"
                )
              )
            ),
            initProcessEnabled = TRUE|FALSE,
            sharedMemorySize = 123,
            tmpfs = list(
              list(
                containerPath = "string",
                size = 123,
                mountOptions = list(
                  "string"
                )
              )
            ),
            maxSwap = 123,
            swappiness = 123
          ),
          logConfiguration = list(
            logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
            options = list(
              "string"
            ),
            secretOptions = list(
              list(
                name = "string",
                valueFrom = "string"
              )
            )
          ),
          secrets = list(
            list(
              name = "string",
              valueFrom = "string"
            )
          ),
          networkConfiguration = list(
            assignPublicIp = "ENABLED"|"DISABLED"
          ),
          fargatePlatformConfiguration = list(
            platformVersion = "string"
          ),
          ephemeralStorage = list(
            sizeInGiB = 123
          ),
          runtimePlatform = list(
            operatingSystemFamily = "string",
            cpuArchitecture = "string"
          ),
          repositoryCredentials = list(
            credentialsParameter = "string"
          )
        ),
        instanceTypes = list(
          "string"
        ),
        ecsProperties = list(
          taskProperties = list(
            list(
              containers = list(
                list(
                  command = list(
                    "string"
                  ),
                  dependsOn = list(
                    list(
                      containerName = "string",
                      condition = "string"
                    )
                  ),
                  environment = list(
                    list(
                      name = "string",
                      value = "string"
                    )
                  ),
                  essential = TRUE|FALSE,
                  image = "string",
                  linuxParameters = list(
                    devices = list(
                      list(
                        hostPath = "string",
                        containerPath = "string",
                        permissions = list(
                          "READ"|"WRITE"|"MKNOD"
                        )
                      )
                    ),
                    initProcessEnabled = TRUE|FALSE,
                    sharedMemorySize = 123,
                    tmpfs = list(
                      list(
                        containerPath = "string",
                        size = 123,
                        mountOptions = list(
                          "string"
                        )
                      )
                    ),
                    maxSwap = 123,
                    swappiness = 123
                  ),
                  logConfiguration = list(
                    logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
                    options = list(
                      "string"
                    ),
                    secretOptions = list(
                      list(
                        name = "string",
                        valueFrom = "string"
                      )
                    )
                  ),
                  mountPoints = list(
                    list(
                      containerPath = "string",
                      readOnly = TRUE|FALSE,
                      sourceVolume = "string"
                    )
                  ),
                  name = "string",
                  privileged = TRUE|FALSE,
                  readonlyRootFilesystem = TRUE|FALSE,
                  repositoryCredentials = list(
                    credentialsParameter = "string"
                  ),
                  resourceRequirements = list(
                    list(
                      value = "string",
                      type = "GPU"|"VCPU"|"MEMORY"
                    )
                  ),
                  secrets = list(
                    list(
                      name = "string",
                      valueFrom = "string"
                    )
                  ),
                  ulimits = list(
                    list(
                      hardLimit = 123,
                      name = "string",
                      softLimit = 123
                    )
                  ),
                  user = "string"
                )
              ),
              ephemeralStorage = list(
                sizeInGiB = 123
              ),
              executionRoleArn = "string",
              platformVersion = "string",
              ipcMode = "string",
              taskRoleArn = "string",
              pidMode = "string",
              networkConfiguration = list(
                assignPublicIp = "ENABLED"|"DISABLED"
              ),
              runtimePlatform = list(
                operatingSystemFamily = "string",
                cpuArchitecture = "string"
              ),
              volumes = list(
                list(
                  host = list(
                    sourcePath = "string"
                  ),
                  name = "string",
                  efsVolumeConfiguration = list(
                    fileSystemId = "string",
                    rootDirectory = "string",
                    transitEncryption = "ENABLED"|"DISABLED",
                    transitEncryptionPort = 123,
                    authorizationConfig = list(
                      accessPointId = "string",
                      iam = "ENABLED"|"DISABLED"
                    )
                  )
                )
              )
            )
          )
        ),
        eksProperties = list(
          podProperties = list(
            serviceAccountName = "string",
            hostNetwork = TRUE|FALSE,
            dnsPolicy = "string",
            imagePullSecrets = list(
              list(
                name = "string"
              )
            ),
            containers = list(
              list(
                name = "string",
                image = "string",
                imagePullPolicy = "string",
                command = list(
                  "string"
                ),
                args = list(
                  "string"
                ),
                env = list(
                  list(
                    name = "string",
                    value = "string"
                  )
                ),
                resources = list(
                  limits = list(
                    "string"
                  ),
                  requests = list(
                    "string"
                  )
                ),
                volumeMounts = list(
                  list(
                    name = "string",
                    mountPath = "string",
                    readOnly = TRUE|FALSE
                  )
                ),
                securityContext = list(
                  runAsUser = 123,
                  runAsGroup = 123,
                  privileged = TRUE|FALSE,
                  allowPrivilegeEscalation = TRUE|FALSE,
                  readOnlyRootFilesystem = TRUE|FALSE,
                  runAsNonRoot = TRUE|FALSE
                )
              )
            ),
            initContainers = list(
              list(
                name = "string",
                image = "string",
                imagePullPolicy = "string",
                command = list(
                  "string"
                ),
                args = list(
                  "string"
                ),
                env = list(
                  list(
                    name = "string",
                    value = "string"
                  )
                ),
                resources = list(
                  limits = list(
                    "string"
                  ),
                  requests = list(
                    "string"
                  )
                ),
                volumeMounts = list(
                  list(
                    name = "string",
                    mountPath = "string",
                    readOnly = TRUE|FALSE
                  )
                ),
                securityContext = list(
                  runAsUser = 123,
                  runAsGroup = 123,
                  privileged = TRUE|FALSE,
                  allowPrivilegeEscalation = TRUE|FALSE,
                  readOnlyRootFilesystem = TRUE|FALSE,
                  runAsNonRoot = TRUE|FALSE
                )
              )
            ),
            volumes = list(
              list(
                name = "string",
                hostPath = list(
                  path = "string"
                ),
                emptyDir = list(
                  medium = "string",
                  sizeLimit = "string"
                ),
                secret = list(
                  secretName = "string",
                  optional = TRUE|FALSE
                )
              )
            ),
            metadata = list(
              labels = list(
                "string"
              )
            ),
            shareProcessNamespace = TRUE|FALSE
          )
        )
      )
    )
  ),
  retryStrategy = list(
    attempts = 123,
    evaluateOnExit = list(
      list(
        onStatusReason = "string",
        onReason = "string",
        onExitCode = "string",
        action = "RETRY"|"EXIT"
      )
    )
  ),
  propagateTags = TRUE|FALSE,
  timeout = list(
    attemptDurationSeconds = 123
  ),
  tags = list(
    "string"
  ),
  platformCapabilities = list(
    "EC2"|"FARGATE"
  ),
  eksProperties = list(
    podProperties = list(
      serviceAccountName = "string",
      hostNetwork = TRUE|FALSE,
      dnsPolicy = "string",
      imagePullSecrets = list(
        list(
          name = "string"
        )
      ),
      containers = list(
        list(
          name = "string",
          image = "string",
          imagePullPolicy = "string",
          command = list(
            "string"
          ),
          args = list(
            "string"
          ),
          env = list(
            list(
              name = "string",
              value = "string"
            )
          ),
          resources = list(
            limits = list(
              "string"
            ),
            requests = list(
              "string"
            )
          ),
          volumeMounts = list(
            list(
              name = "string",
              mountPath = "string",
              readOnly = TRUE|FALSE
            )
          ),
          securityContext = list(
            runAsUser = 123,
            runAsGroup = 123,
            privileged = TRUE|FALSE,
            allowPrivilegeEscalation = TRUE|FALSE,
            readOnlyRootFilesystem = TRUE|FALSE,
            runAsNonRoot = TRUE|FALSE
          )
        )
      ),
      initContainers = list(
        list(
          name = "string",
          image = "string",
          imagePullPolicy = "string",
          command = list(
            "string"
          ),
          args = list(
            "string"
          ),
          env = list(
            list(
              name = "string",
              value = "string"
            )
          ),
          resources = list(
            limits = list(
              "string"
            ),
            requests = list(
              "string"
            )
          ),
          volumeMounts = list(
            list(
              name = "string",
              mountPath = "string",
              readOnly = TRUE|FALSE
            )
          ),
          securityContext = list(
            runAsUser = 123,
            runAsGroup = 123,
            privileged = TRUE|FALSE,
            allowPrivilegeEscalation = TRUE|FALSE,
            readOnlyRootFilesystem = TRUE|FALSE,
            runAsNonRoot = TRUE|FALSE
          )
        )
      ),
      volumes = list(
        list(
          name = "string",
          hostPath = list(
            path = "string"
          ),
          emptyDir = list(
            medium = "string",
            sizeLimit = "string"
          ),
          secret = list(
            secretName = "string",
            optional = TRUE|FALSE
          )
        )
      ),
      metadata = list(
        labels = list(
          "string"
        )
      ),
      shareProcessNamespace = TRUE|FALSE
    )
  ),
  ecsProperties = list(
    taskProperties = list(
      list(
        containers = list(
          list(
            command = list(
              "string"
            ),
            dependsOn = list(
              list(
                containerName = "string",
                condition = "string"
              )
            ),
            environment = list(
              list(
                name = "string",
                value = "string"
              )
            ),
            essential = TRUE|FALSE,
            image = "string",
            linuxParameters = list(
              devices = list(
                list(
                  hostPath = "string",
                  containerPath = "string",
                  permissions = list(
                    "READ"|"WRITE"|"MKNOD"
                  )
                )
              ),
              initProcessEnabled = TRUE|FALSE,
              sharedMemorySize = 123,
              tmpfs = list(
                list(
                  containerPath = "string",
                  size = 123,
                  mountOptions = list(
                    "string"
                  )
                )
              ),
              maxSwap = 123,
              swappiness = 123
            ),
            logConfiguration = list(
              logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
              options = list(
                "string"
              ),
              secretOptions = list(
                list(
                  name = "string",
                  valueFrom = "string"
                )
              )
            ),
            mountPoints = list(
              list(
                containerPath = "string",
                readOnly = TRUE|FALSE,
                sourceVolume = "string"
              )
            ),
            name = "string",
            privileged = TRUE|FALSE,
            readonlyRootFilesystem = TRUE|FALSE,
            repositoryCredentials = list(
              credentialsParameter = "string"
            ),
            resourceRequirements = list(
              list(
                value = "string",
                type = "GPU"|"VCPU"|"MEMORY"
              )
            ),
            secrets = list(
              list(
                name = "string",
                valueFrom = "string"
              )
            ),
            ulimits = list(
              list(
                hardLimit = 123,
                name = "string",
                softLimit = 123
              )
            ),
            user = "string"
          )
        ),
        ephemeralStorage = list(
          sizeInGiB = 123
        ),
        executionRoleArn = "string",
        platformVersion = "string",
        ipcMode = "string",
        taskRoleArn = "string",
        pidMode = "string",
        networkConfiguration = list(
          assignPublicIp = "ENABLED"|"DISABLED"
        ),
        runtimePlatform = list(
          operatingSystemFamily = "string",
          cpuArchitecture = "string"
        ),
        volumes = list(
          list(
            host = list(
              sourcePath = "string"
            ),
            name = "string",
            efsVolumeConfiguration = list(
              fileSystemId = "string",
              rootDirectory = "string",
              transitEncryption = "ENABLED"|"DISABLED",
              transitEncryptionPort = 123,
              authorizationConfig = list(
                accessPointId = "string",
                iam = "ENABLED"|"DISABLED"
              )
            )
          )
        )
      )
    )
  )
)

Examples

## Not run: 
# This example registers a job definition for a simple container job.
svc$register_job_definition(
  type = "container",
  containerProperties = list(
    command = list(
      "sleep",
      "10"
    ),
    image = "busybox",
    resourceRequirements = list(
      list(
        type = "MEMORY",
        value = "128"
      ),
      list(
        type = "VCPU",
        value = "1"
      )
    )
  ),
  jobDefinitionName = "sleep10"
)

# This demonstrates calling the RegisterJobDefinition action, including
# tags.
svc$register_job_definition(
  type = "container",
  containerProperties = list(
    command = list(
      "sleep",
      "30"
    ),
    image = "busybox",
    resourceRequirements = list(
      list(
        type = "MEMORY",
        value = "128"
      ),
      list(
        type = "VCPU",
        value = "1"
      )
    )
  ),
  jobDefinitionName = "sleep30",
  tags = list(
    Department = "Engineering",
    User = "JaneDoe"
  )
)

## End(Not run)