batch_register_job_definition: Registers an AWS Batch job definition

Description Usage Arguments Value Request syntax Examples

View source: R/batch_operations.R

Description

Registers an AWS Batch job definition.

Usage

1
2
3
batch_register_job_definition(jobDefinitionName, type, parameters,
  containerProperties, nodeProperties, retryStrategy, propagateTags,
  timeout, tags, platformCapabilities)

Arguments

jobDefinitionName

[required] The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

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 AWS Batch User Guide.

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.

containerProperties

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.

nodeProperties

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.

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.

timeout

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.

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 AWS Resources in AWS 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.

Value

A list with the following syntax:

1
2
3
4
5
list(
  jobDefinitionName = "string",
  jobDefinitionArn = "string",
  revision = 123
)

Request syntax

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
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"
  )
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
## 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",
    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"
  )
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.