Registers an AWS Batch job definition.
batch_register_job_definition(jobDefinitionName, type, parameters,
containerProperties, nodeProperties, retryStrategy, propagateTags,
timeout, tags, platformCapabilities)A list with the following syntax:
list(
jobDefinitionName = "string",
jobDefinitionArn = "string",
revision = 123
)
[required] The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
[required] The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
If the job is run on Fargate resources, then multinode isn't
supported.
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.
An object with various properties specific to single-node
container-based jobs. If the job definition's type parameter is
container, then you must specify either containerProperties or
nodeProperties.
If the job runs on Fargate resources, then you must not specify
nodeProperties; use only containerProperties.
An object with various 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 AWS Batch User Guide. If the job definition's type parameter
is container, then you must specify either containerProperties or
nodeProperties.
If the job runs on Fargate resources, then you must not specify
nodeProperties; use containerProperties instead.
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.
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.
The timeout configuration for jobs that are submitted with this job
definition, after which AWS 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 AWS Batch User Guide.
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 AWS Resources in AWS Batch User Guide.
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.
svc$register_job_definition(
jobDefinitionName = "string",
type = "container"|"multinode",
parameters = list(
"string"
),
containerProperties = list(
image = "string",
vcpus = 123,
memory = 123,
command = list(
"string"
),
jobRoleArn = "string",
executionRoleArn = "string",
volumes = list(
list(
host = list(
sourcePath = "string"
),
name = "string"
)
),
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"
)
),
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"
)
),
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"
)
)
)
)
),
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"
)
)
if (FALSE) {
# 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",
memory = 128L,
vcpus = 1L
),
jobDefinitionName = "sleep10"
)
# This demonstrates calling the RegisterJobDefinition action, including
# tags.
svc$register_job_definition(
type = "container",
containerProperties = list(
command = list(
"sleep",
"30"
),
image = "busybox",
memory = 128L,
vcpus = 1L
),
jobDefinitionName = "sleep30",
tags = list(
Department = "Engineering",
User = "JaneDoe"
)
)
}
Run the code above in your browser using DataLab