@aws-sdk/client-batch 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist-types/commands/CancelJobCommand.d.ts +4 -0
  2. package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +7 -0
  3. package/dist-types/commands/CreateJobQueueCommand.d.ts +7 -0
  4. package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +7 -0
  5. package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +4 -0
  6. package/dist-types/commands/DeleteJobQueueCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteSchedulingPolicyCommand.d.ts +4 -0
  8. package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +4 -0
  9. package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +69 -0
  10. package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +321 -0
  11. package/dist-types/commands/DescribeJobQueuesCommand.d.ts +26 -0
  12. package/dist-types/commands/DescribeJobsCommand.d.ts +396 -0
  13. package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +24 -0
  14. package/dist-types/commands/ListJobsCommand.d.ts +32 -0
  15. package/dist-types/commands/ListSchedulingPoliciesCommand.d.ts +11 -0
  16. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  17. package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +8 -0
  18. package/dist-types/commands/SubmitJobCommand.d.ts +8 -0
  19. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  20. package/dist-types/commands/TerminateJobCommand.d.ts +4 -0
  21. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  22. package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +7 -0
  23. package/dist-types/commands/UpdateJobQueueCommand.d.ts +7 -0
  24. package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +4 -0
  25. package/package.json +3 -3
@@ -33,6 +33,400 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
33
33
  * };
34
34
  * const command = new DescribeJobsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeJobsResponse
37
+ * // jobs: [ // JobDetailList
38
+ * // { // JobDetail
39
+ * // jobArn: "STRING_VALUE",
40
+ * // jobName: "STRING_VALUE", // required
41
+ * // jobId: "STRING_VALUE", // required
42
+ * // jobQueue: "STRING_VALUE", // required
43
+ * // status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED", // required
44
+ * // shareIdentifier: "STRING_VALUE",
45
+ * // schedulingPriority: Number("int"),
46
+ * // attempts: [ // AttemptDetails
47
+ * // { // AttemptDetail
48
+ * // container: { // AttemptContainerDetail
49
+ * // containerInstanceArn: "STRING_VALUE",
50
+ * // taskArn: "STRING_VALUE",
51
+ * // exitCode: Number("int"),
52
+ * // reason: "STRING_VALUE",
53
+ * // logStreamName: "STRING_VALUE",
54
+ * // networkInterfaces: [ // NetworkInterfaceList
55
+ * // { // NetworkInterface
56
+ * // attachmentId: "STRING_VALUE",
57
+ * // ipv6Address: "STRING_VALUE",
58
+ * // privateIpv4Address: "STRING_VALUE",
59
+ * // },
60
+ * // ],
61
+ * // },
62
+ * // startedAt: Number("long"),
63
+ * // stoppedAt: Number("long"),
64
+ * // statusReason: "STRING_VALUE",
65
+ * // },
66
+ * // ],
67
+ * // statusReason: "STRING_VALUE",
68
+ * // createdAt: Number("long"),
69
+ * // retryStrategy: { // RetryStrategy
70
+ * // attempts: Number("int"),
71
+ * // evaluateOnExit: [ // EvaluateOnExitList
72
+ * // { // EvaluateOnExit
73
+ * // onStatusReason: "STRING_VALUE",
74
+ * // onReason: "STRING_VALUE",
75
+ * // onExitCode: "STRING_VALUE",
76
+ * // action: "RETRY" || "EXIT", // required
77
+ * // },
78
+ * // ],
79
+ * // },
80
+ * // startedAt: Number("long"), // required
81
+ * // stoppedAt: Number("long"),
82
+ * // dependsOn: [ // JobDependencyList
83
+ * // { // JobDependency
84
+ * // jobId: "STRING_VALUE",
85
+ * // type: "N_TO_N" || "SEQUENTIAL",
86
+ * // },
87
+ * // ],
88
+ * // jobDefinition: "STRING_VALUE", // required
89
+ * // parameters: { // ParametersMap
90
+ * // "<keys>": "STRING_VALUE",
91
+ * // },
92
+ * // container: { // ContainerDetail
93
+ * // image: "STRING_VALUE",
94
+ * // vcpus: Number("int"),
95
+ * // memory: Number("int"),
96
+ * // command: [ // StringList
97
+ * // "STRING_VALUE",
98
+ * // ],
99
+ * // jobRoleArn: "STRING_VALUE",
100
+ * // executionRoleArn: "STRING_VALUE",
101
+ * // volumes: [ // Volumes
102
+ * // { // Volume
103
+ * // host: { // Host
104
+ * // sourcePath: "STRING_VALUE",
105
+ * // },
106
+ * // name: "STRING_VALUE",
107
+ * // efsVolumeConfiguration: { // EFSVolumeConfiguration
108
+ * // fileSystemId: "STRING_VALUE", // required
109
+ * // rootDirectory: "STRING_VALUE",
110
+ * // transitEncryption: "ENABLED" || "DISABLED",
111
+ * // transitEncryptionPort: Number("int"),
112
+ * // authorizationConfig: { // EFSAuthorizationConfig
113
+ * // accessPointId: "STRING_VALUE",
114
+ * // iam: "ENABLED" || "DISABLED",
115
+ * // },
116
+ * // },
117
+ * // },
118
+ * // ],
119
+ * // environment: [ // EnvironmentVariables
120
+ * // { // KeyValuePair
121
+ * // name: "STRING_VALUE",
122
+ * // value: "STRING_VALUE",
123
+ * // },
124
+ * // ],
125
+ * // mountPoints: [ // MountPoints
126
+ * // { // MountPoint
127
+ * // containerPath: "STRING_VALUE",
128
+ * // readOnly: true || false,
129
+ * // sourceVolume: "STRING_VALUE",
130
+ * // },
131
+ * // ],
132
+ * // readonlyRootFilesystem: true || false,
133
+ * // ulimits: [ // Ulimits
134
+ * // { // Ulimit
135
+ * // hardLimit: Number("int"), // required
136
+ * // name: "STRING_VALUE", // required
137
+ * // softLimit: Number("int"), // required
138
+ * // },
139
+ * // ],
140
+ * // privileged: true || false,
141
+ * // user: "STRING_VALUE",
142
+ * // exitCode: Number("int"),
143
+ * // reason: "STRING_VALUE",
144
+ * // containerInstanceArn: "STRING_VALUE",
145
+ * // taskArn: "STRING_VALUE",
146
+ * // logStreamName: "STRING_VALUE",
147
+ * // instanceType: "STRING_VALUE",
148
+ * // networkInterfaces: [
149
+ * // {
150
+ * // attachmentId: "STRING_VALUE",
151
+ * // ipv6Address: "STRING_VALUE",
152
+ * // privateIpv4Address: "STRING_VALUE",
153
+ * // },
154
+ * // ],
155
+ * // resourceRequirements: [ // ResourceRequirements
156
+ * // { // ResourceRequirement
157
+ * // value: "STRING_VALUE", // required
158
+ * // type: "GPU" || "VCPU" || "MEMORY", // required
159
+ * // },
160
+ * // ],
161
+ * // linuxParameters: { // LinuxParameters
162
+ * // devices: [ // DevicesList
163
+ * // { // Device
164
+ * // hostPath: "STRING_VALUE", // required
165
+ * // containerPath: "STRING_VALUE",
166
+ * // permissions: [ // DeviceCgroupPermissions
167
+ * // "READ" || "WRITE" || "MKNOD",
168
+ * // ],
169
+ * // },
170
+ * // ],
171
+ * // initProcessEnabled: true || false,
172
+ * // sharedMemorySize: Number("int"),
173
+ * // tmpfs: [ // TmpfsList
174
+ * // { // Tmpfs
175
+ * // containerPath: "STRING_VALUE", // required
176
+ * // size: Number("int"), // required
177
+ * // mountOptions: [
178
+ * // "STRING_VALUE",
179
+ * // ],
180
+ * // },
181
+ * // ],
182
+ * // maxSwap: Number("int"),
183
+ * // swappiness: Number("int"),
184
+ * // },
185
+ * // logConfiguration: { // LogConfiguration
186
+ * // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
187
+ * // options: { // LogConfigurationOptionsMap
188
+ * // "<keys>": "STRING_VALUE",
189
+ * // },
190
+ * // secretOptions: [ // SecretList
191
+ * // { // Secret
192
+ * // name: "STRING_VALUE", // required
193
+ * // valueFrom: "STRING_VALUE", // required
194
+ * // },
195
+ * // ],
196
+ * // },
197
+ * // secrets: [
198
+ * // {
199
+ * // name: "STRING_VALUE", // required
200
+ * // valueFrom: "STRING_VALUE", // required
201
+ * // },
202
+ * // ],
203
+ * // networkConfiguration: { // NetworkConfiguration
204
+ * // assignPublicIp: "ENABLED" || "DISABLED",
205
+ * // },
206
+ * // fargatePlatformConfiguration: { // FargatePlatformConfiguration
207
+ * // platformVersion: "STRING_VALUE",
208
+ * // },
209
+ * // ephemeralStorage: { // EphemeralStorage
210
+ * // sizeInGiB: Number("int"), // required
211
+ * // },
212
+ * // },
213
+ * // nodeDetails: { // NodeDetails
214
+ * // nodeIndex: Number("int"),
215
+ * // isMainNode: true || false,
216
+ * // },
217
+ * // nodeProperties: { // NodeProperties
218
+ * // numNodes: Number("int"), // required
219
+ * // mainNode: Number("int"), // required
220
+ * // nodeRangeProperties: [ // NodeRangeProperties // required
221
+ * // { // NodeRangeProperty
222
+ * // targetNodes: "STRING_VALUE", // required
223
+ * // container: { // ContainerProperties
224
+ * // image: "STRING_VALUE",
225
+ * // vcpus: Number("int"),
226
+ * // memory: Number("int"),
227
+ * // command: [
228
+ * // "STRING_VALUE",
229
+ * // ],
230
+ * // jobRoleArn: "STRING_VALUE",
231
+ * // executionRoleArn: "STRING_VALUE",
232
+ * // volumes: [
233
+ * // {
234
+ * // host: {
235
+ * // sourcePath: "STRING_VALUE",
236
+ * // },
237
+ * // name: "STRING_VALUE",
238
+ * // efsVolumeConfiguration: {
239
+ * // fileSystemId: "STRING_VALUE", // required
240
+ * // rootDirectory: "STRING_VALUE",
241
+ * // transitEncryption: "ENABLED" || "DISABLED",
242
+ * // transitEncryptionPort: Number("int"),
243
+ * // authorizationConfig: {
244
+ * // accessPointId: "STRING_VALUE",
245
+ * // iam: "ENABLED" || "DISABLED",
246
+ * // },
247
+ * // },
248
+ * // },
249
+ * // ],
250
+ * // environment: [
251
+ * // {
252
+ * // name: "STRING_VALUE",
253
+ * // value: "STRING_VALUE",
254
+ * // },
255
+ * // ],
256
+ * // mountPoints: [
257
+ * // {
258
+ * // containerPath: "STRING_VALUE",
259
+ * // readOnly: true || false,
260
+ * // sourceVolume: "STRING_VALUE",
261
+ * // },
262
+ * // ],
263
+ * // readonlyRootFilesystem: true || false,
264
+ * // privileged: true || false,
265
+ * // ulimits: [
266
+ * // {
267
+ * // hardLimit: Number("int"), // required
268
+ * // name: "STRING_VALUE", // required
269
+ * // softLimit: Number("int"), // required
270
+ * // },
271
+ * // ],
272
+ * // user: "STRING_VALUE",
273
+ * // instanceType: "STRING_VALUE",
274
+ * // resourceRequirements: [
275
+ * // {
276
+ * // value: "STRING_VALUE", // required
277
+ * // type: "GPU" || "VCPU" || "MEMORY", // required
278
+ * // },
279
+ * // ],
280
+ * // linuxParameters: {
281
+ * // devices: [
282
+ * // {
283
+ * // hostPath: "STRING_VALUE", // required
284
+ * // containerPath: "STRING_VALUE",
285
+ * // permissions: [
286
+ * // "READ" || "WRITE" || "MKNOD",
287
+ * // ],
288
+ * // },
289
+ * // ],
290
+ * // initProcessEnabled: true || false,
291
+ * // sharedMemorySize: Number("int"),
292
+ * // tmpfs: [
293
+ * // {
294
+ * // containerPath: "STRING_VALUE", // required
295
+ * // size: Number("int"), // required
296
+ * // mountOptions: "<StringList>",
297
+ * // },
298
+ * // ],
299
+ * // maxSwap: Number("int"),
300
+ * // swappiness: Number("int"),
301
+ * // },
302
+ * // logConfiguration: {
303
+ * // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
304
+ * // options: {
305
+ * // "<keys>": "STRING_VALUE",
306
+ * // },
307
+ * // secretOptions: "<SecretList>",
308
+ * // },
309
+ * // secrets: "<SecretList>",
310
+ * // networkConfiguration: {
311
+ * // assignPublicIp: "ENABLED" || "DISABLED",
312
+ * // },
313
+ * // fargatePlatformConfiguration: {
314
+ * // platformVersion: "STRING_VALUE",
315
+ * // },
316
+ * // ephemeralStorage: {
317
+ * // sizeInGiB: Number("int"), // required
318
+ * // },
319
+ * // },
320
+ * // },
321
+ * // ],
322
+ * // },
323
+ * // arrayProperties: { // ArrayPropertiesDetail
324
+ * // statusSummary: { // ArrayJobStatusSummary
325
+ * // "<keys>": Number("int"),
326
+ * // },
327
+ * // size: Number("int"),
328
+ * // index: Number("int"),
329
+ * // },
330
+ * // timeout: { // JobTimeout
331
+ * // attemptDurationSeconds: Number("int"),
332
+ * // },
333
+ * // tags: { // TagrisTagsMap
334
+ * // "<keys>": "STRING_VALUE",
335
+ * // },
336
+ * // propagateTags: true || false,
337
+ * // platformCapabilities: [ // PlatformCapabilityList
338
+ * // "EC2" || "FARGATE",
339
+ * // ],
340
+ * // eksProperties: { // EksPropertiesDetail
341
+ * // podProperties: { // EksPodPropertiesDetail
342
+ * // serviceAccountName: "STRING_VALUE",
343
+ * // hostNetwork: true || false,
344
+ * // dnsPolicy: "STRING_VALUE",
345
+ * // containers: [ // EksContainerDetails
346
+ * // { // EksContainerDetail
347
+ * // name: "STRING_VALUE",
348
+ * // image: "STRING_VALUE",
349
+ * // imagePullPolicy: "STRING_VALUE",
350
+ * // command: "<StringList>",
351
+ * // args: "<StringList>",
352
+ * // env: [ // EksContainerEnvironmentVariables
353
+ * // { // EksContainerEnvironmentVariable
354
+ * // name: "STRING_VALUE", // required
355
+ * // value: "STRING_VALUE",
356
+ * // },
357
+ * // ],
358
+ * // resources: { // EksContainerResourceRequirements
359
+ * // limits: { // EksLimits
360
+ * // "<keys>": "STRING_VALUE",
361
+ * // },
362
+ * // requests: { // EksRequests
363
+ * // "<keys>": "STRING_VALUE",
364
+ * // },
365
+ * // },
366
+ * // exitCode: Number("int"),
367
+ * // reason: "STRING_VALUE",
368
+ * // volumeMounts: [ // EksContainerVolumeMounts
369
+ * // { // EksContainerVolumeMount
370
+ * // name: "STRING_VALUE",
371
+ * // mountPath: "STRING_VALUE",
372
+ * // readOnly: true || false,
373
+ * // },
374
+ * // ],
375
+ * // securityContext: { // EksContainerSecurityContext
376
+ * // runAsUser: Number("long"),
377
+ * // runAsGroup: Number("long"),
378
+ * // privileged: true || false,
379
+ * // readOnlyRootFilesystem: true || false,
380
+ * // runAsNonRoot: true || false,
381
+ * // },
382
+ * // },
383
+ * // ],
384
+ * // volumes: [ // EksVolumes
385
+ * // { // EksVolume
386
+ * // name: "STRING_VALUE", // required
387
+ * // hostPath: { // EksHostPath
388
+ * // path: "STRING_VALUE",
389
+ * // },
390
+ * // emptyDir: { // EksEmptyDir
391
+ * // medium: "STRING_VALUE",
392
+ * // sizeLimit: "STRING_VALUE",
393
+ * // },
394
+ * // secret: { // EksSecret
395
+ * // secretName: "STRING_VALUE", // required
396
+ * // optional: true || false,
397
+ * // },
398
+ * // },
399
+ * // ],
400
+ * // podName: "STRING_VALUE",
401
+ * // nodeName: "STRING_VALUE",
402
+ * // metadata: { // EksMetadata
403
+ * // labels: { // EksLabelsMap
404
+ * // "<keys>": "STRING_VALUE",
405
+ * // },
406
+ * // },
407
+ * // },
408
+ * // },
409
+ * // eksAttempts: [ // EksAttemptDetails
410
+ * // { // EksAttemptDetail
411
+ * // containers: [ // EksAttemptContainerDetails
412
+ * // { // EksAttemptContainerDetail
413
+ * // exitCode: Number("int"),
414
+ * // reason: "STRING_VALUE",
415
+ * // },
416
+ * // ],
417
+ * // podName: "STRING_VALUE",
418
+ * // nodeName: "STRING_VALUE",
419
+ * // startedAt: Number("long"),
420
+ * // stoppedAt: Number("long"),
421
+ * // statusReason: "STRING_VALUE",
422
+ * // },
423
+ * // ],
424
+ * // isCancelled: true || false,
425
+ * // isTerminated: true || false,
426
+ * // },
427
+ * // ],
428
+ * // };
429
+ *
36
430
  * ```
37
431
  *
38
432
  * @param DescribeJobsCommandInput - {@link DescribeJobsCommandInput}
@@ -49,6 +443,8 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
49
443
  * @throws {@link ServerException} (server fault)
50
444
  * <p>These errors are usually caused by a server issue.</p>
51
445
  *
446
+ * @throws {@link BatchServiceException}
447
+ * <p>Base exception class for all service exceptions from Batch service.</p>
52
448
  *
53
449
  * @example To describe a specific job
54
450
  * ```javascript
@@ -33,6 +33,28 @@ export interface DescribeSchedulingPoliciesCommandOutput extends DescribeSchedul
33
33
  * };
34
34
  * const command = new DescribeSchedulingPoliciesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeSchedulingPoliciesResponse
37
+ * // schedulingPolicies: [ // SchedulingPolicyDetailList
38
+ * // { // SchedulingPolicyDetail
39
+ * // name: "STRING_VALUE", // required
40
+ * // arn: "STRING_VALUE", // required
41
+ * // fairsharePolicy: { // FairsharePolicy
42
+ * // shareDecaySeconds: Number("int"),
43
+ * // computeReservation: Number("int"),
44
+ * // shareDistribution: [ // ShareAttributesList
45
+ * // { // ShareAttributes
46
+ * // shareIdentifier: "STRING_VALUE", // required
47
+ * // weightFactor: Number("float"),
48
+ * // },
49
+ * // ],
50
+ * // },
51
+ * // tags: { // TagrisTagsMap
52
+ * // "<keys>": "STRING_VALUE",
53
+ * // },
54
+ * // },
55
+ * // ],
56
+ * // };
57
+ *
36
58
  * ```
37
59
  *
38
60
  * @param DescribeSchedulingPoliciesCommandInput - {@link DescribeSchedulingPoliciesCommandInput}
@@ -49,6 +71,8 @@ export interface DescribeSchedulingPoliciesCommandOutput extends DescribeSchedul
49
71
  * @throws {@link ServerException} (server fault)
50
72
  * <p>These errors are usually caused by a server issue.</p>
51
73
  *
74
+ * @throws {@link BatchServiceException}
75
+ * <p>Base exception class for all service exceptions from Batch service.</p>
52
76
  *
53
77
  */
54
78
  export declare class DescribeSchedulingPoliciesCommand extends $Command<DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput, BatchClientResolvedConfig> {
@@ -58,6 +58,36 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
58
58
  * };
59
59
  * const command = new ListJobsCommand(input);
60
60
  * const response = await client.send(command);
61
+ * // { // ListJobsResponse
62
+ * // jobSummaryList: [ // JobSummaryList // required
63
+ * // { // JobSummary
64
+ * // jobArn: "STRING_VALUE",
65
+ * // jobId: "STRING_VALUE", // required
66
+ * // jobName: "STRING_VALUE", // required
67
+ * // createdAt: Number("long"),
68
+ * // status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED",
69
+ * // statusReason: "STRING_VALUE",
70
+ * // startedAt: Number("long"),
71
+ * // stoppedAt: Number("long"),
72
+ * // container: { // ContainerSummary
73
+ * // exitCode: Number("int"),
74
+ * // reason: "STRING_VALUE",
75
+ * // },
76
+ * // arrayProperties: { // ArrayPropertiesSummary
77
+ * // size: Number("int"),
78
+ * // index: Number("int"),
79
+ * // },
80
+ * // nodeProperties: { // NodePropertiesSummary
81
+ * // isMainNode: true || false,
82
+ * // numNodes: Number("int"),
83
+ * // nodeIndex: Number("int"),
84
+ * // },
85
+ * // jobDefinition: "STRING_VALUE",
86
+ * // },
87
+ * // ],
88
+ * // nextToken: "STRING_VALUE",
89
+ * // };
90
+ *
61
91
  * ```
62
92
  *
63
93
  * @param ListJobsCommandInput - {@link ListJobsCommandInput}
@@ -74,6 +104,8 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
74
104
  * @throws {@link ServerException} (server fault)
75
105
  * <p>These errors are usually caused by a server issue.</p>
76
106
  *
107
+ * @throws {@link BatchServiceException}
108
+ * <p>Base exception class for all service exceptions from Batch service.</p>
77
109
  *
78
110
  * @example To list running jobs
79
111
  * ```javascript
@@ -32,6 +32,15 @@ export interface ListSchedulingPoliciesCommandOutput extends ListSchedulingPolic
32
32
  * };
33
33
  * const command = new ListSchedulingPoliciesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListSchedulingPoliciesResponse
36
+ * // schedulingPolicies: [ // SchedulingPolicyListingDetailList
37
+ * // { // SchedulingPolicyListingDetail
38
+ * // arn: "STRING_VALUE", // required
39
+ * // },
40
+ * // ],
41
+ * // nextToken: "STRING_VALUE",
42
+ * // };
43
+ *
35
44
  * ```
36
45
  *
37
46
  * @param ListSchedulingPoliciesCommandInput - {@link ListSchedulingPoliciesCommandInput}
@@ -48,6 +57,8 @@ export interface ListSchedulingPoliciesCommandOutput extends ListSchedulingPolic
48
57
  * @throws {@link ServerException} (server fault)
49
58
  * <p>These errors are usually caused by a server issue.</p>
50
59
  *
60
+ * @throws {@link BatchServiceException}
61
+ * <p>Base exception class for all service exceptions from Batch service.</p>
51
62
  *
52
63
  */
53
64
  export declare class ListSchedulingPoliciesCommand extends $Command<ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput, BatchClientResolvedConfig> {
@@ -32,6 +32,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
32
32
  * };
33
33
  * const command = new ListTagsForResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListTagsForResourceResponse
36
+ * // tags: { // TagrisTagsMap
37
+ * // "<keys>": "STRING_VALUE",
38
+ * // },
39
+ * // };
40
+ *
35
41
  * ```
36
42
  *
37
43
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -48,6 +54,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
48
54
  * @throws {@link ServerException} (server fault)
49
55
  * <p>These errors are usually caused by a server issue.</p>
50
56
  *
57
+ * @throws {@link BatchServiceException}
58
+ * <p>Base exception class for all service exceptions from Batch service.</p>
51
59
  *
52
60
  * @example ListTagsForResource Example
53
61
  * ```javascript
@@ -337,6 +337,12 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
337
337
  * };
338
338
  * const command = new RegisterJobDefinitionCommand(input);
339
339
  * const response = await client.send(command);
340
+ * // { // RegisterJobDefinitionResponse
341
+ * // jobDefinitionName: "STRING_VALUE", // required
342
+ * // jobDefinitionArn: "STRING_VALUE", // required
343
+ * // revision: Number("int"), // required
344
+ * // };
345
+ *
340
346
  * ```
341
347
  *
342
348
  * @param RegisterJobDefinitionCommandInput - {@link RegisterJobDefinitionCommandInput}
@@ -353,6 +359,8 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
353
359
  * @throws {@link ServerException} (server fault)
354
360
  * <p>These errors are usually caused by a server issue.</p>
355
361
  *
362
+ * @throws {@link BatchServiceException}
363
+ * <p>Base exception class for all service exceptions from Batch service.</p>
356
364
  *
357
365
  * @example To register a job definition
358
366
  * ```javascript
@@ -159,6 +159,12 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
159
159
  * };
160
160
  * const command = new SubmitJobCommand(input);
161
161
  * const response = await client.send(command);
162
+ * // { // SubmitJobResponse
163
+ * // jobArn: "STRING_VALUE",
164
+ * // jobName: "STRING_VALUE", // required
165
+ * // jobId: "STRING_VALUE", // required
166
+ * // };
167
+ *
162
168
  * ```
163
169
  *
164
170
  * @param SubmitJobCommandInput - {@link SubmitJobCommandInput}
@@ -175,6 +181,8 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
175
181
  * @throws {@link ServerException} (server fault)
176
182
  * <p>These errors are usually caused by a server issue.</p>
177
183
  *
184
+ * @throws {@link BatchServiceException}
185
+ * <p>Base exception class for all service exceptions from Batch service.</p>
178
186
  *
179
187
  * @example To submit a job to a queue
180
188
  * ```javascript
@@ -37,6 +37,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
37
37
  * };
38
38
  * const command = new TagResourceCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -53,6 +55,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
53
55
  * @throws {@link ServerException} (server fault)
54
56
  * <p>These errors are usually caused by a server issue.</p>
55
57
  *
58
+ * @throws {@link BatchServiceException}
59
+ * <p>Base exception class for all service exceptions from Batch service.</p>
56
60
  *
57
61
  * @example TagResource Example
58
62
  * ```javascript
@@ -34,6 +34,8 @@ export interface TerminateJobCommandOutput extends TerminateJobResponse, __Metad
34
34
  * };
35
35
  * const command = new TerminateJobCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TerminateJobCommandInput - {@link TerminateJobCommandInput}
@@ -50,6 +52,8 @@ export interface TerminateJobCommandOutput extends TerminateJobResponse, __Metad
50
52
  * @throws {@link ServerException} (server fault)
51
53
  * <p>These errors are usually caused by a server issue.</p>
52
54
  *
55
+ * @throws {@link BatchServiceException}
56
+ * <p>Base exception class for all service exceptions from Batch service.</p>
53
57
  *
54
58
  * @example To terminate a job
55
59
  * ```javascript
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -50,6 +52,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
50
52
  * @throws {@link ServerException} (server fault)
51
53
  * <p>These errors are usually caused by a server issue.</p>
52
54
  *
55
+ * @throws {@link BatchServiceException}
56
+ * <p>Base exception class for all service exceptions from Batch service.</p>
53
57
  *
54
58
  * @example UntagResource Example
55
59
  * ```javascript
@@ -75,6 +75,11 @@ export interface UpdateComputeEnvironmentCommandOutput extends UpdateComputeEnvi
75
75
  * };
76
76
  * const command = new UpdateComputeEnvironmentCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // UpdateComputeEnvironmentResponse
79
+ * // computeEnvironmentName: "STRING_VALUE",
80
+ * // computeEnvironmentArn: "STRING_VALUE",
81
+ * // };
82
+ *
78
83
  * ```
79
84
  *
80
85
  * @param UpdateComputeEnvironmentCommandInput - {@link UpdateComputeEnvironmentCommandInput}
@@ -91,6 +96,8 @@ export interface UpdateComputeEnvironmentCommandOutput extends UpdateComputeEnvi
91
96
  * @throws {@link ServerException} (server fault)
92
97
  * <p>These errors are usually caused by a server issue.</p>
93
98
  *
99
+ * @throws {@link BatchServiceException}
100
+ * <p>Base exception class for all service exceptions from Batch service.</p>
94
101
  *
95
102
  * @example To update a compute environment
96
103
  * ```javascript