@aws-sdk/client-batch 3.687.0 → 3.691.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.
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +10 -0
- package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +10 -0
- package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +592 -501
- package/dist-types/ts3.4/models/models_0.d.ts +501 -494
- package/package.json +7 -7
|
@@ -21,7 +21,7 @@ export interface ArrayProperties {
|
|
|
21
21
|
* <p>The size of the array job.</p>
|
|
22
22
|
* @public
|
|
23
23
|
*/
|
|
24
|
-
size?: number;
|
|
24
|
+
size?: number | undefined;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
27
|
* <p>An object that represents the array properties of a job.</p>
|
|
@@ -33,18 +33,18 @@ export interface ArrayPropertiesDetail {
|
|
|
33
33
|
* is returned for parent array jobs.</p>
|
|
34
34
|
* @public
|
|
35
35
|
*/
|
|
36
|
-
statusSummary?: Record<string, number
|
|
36
|
+
statusSummary?: Record<string, number> | undefined;
|
|
37
37
|
/**
|
|
38
38
|
* <p>The size of the array job. This parameter is returned for parent array jobs.</p>
|
|
39
39
|
* @public
|
|
40
40
|
*/
|
|
41
|
-
size?: number;
|
|
41
|
+
size?: number | undefined;
|
|
42
42
|
/**
|
|
43
43
|
* <p>The job index within the array that's associated with this job. This parameter is returned
|
|
44
44
|
* for array job children.</p>
|
|
45
45
|
* @public
|
|
46
46
|
*/
|
|
47
|
-
index?: number;
|
|
47
|
+
index?: number | undefined;
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
50
|
* <p>An object that represents the array properties of a job.</p>
|
|
@@ -55,13 +55,13 @@ export interface ArrayPropertiesSummary {
|
|
|
55
55
|
* <p>The size of the array job. This parameter is returned for parent array jobs.</p>
|
|
56
56
|
* @public
|
|
57
57
|
*/
|
|
58
|
-
size?: number;
|
|
58
|
+
size?: number | undefined;
|
|
59
59
|
/**
|
|
60
60
|
* <p>The job index within the array that's associated with this job. This parameter is returned
|
|
61
61
|
* for children of array jobs.</p>
|
|
62
62
|
* @public
|
|
63
63
|
*/
|
|
64
|
-
index?: number;
|
|
64
|
+
index?: number | undefined;
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
67
|
* @public
|
|
@@ -85,17 +85,17 @@ export interface NetworkInterface {
|
|
|
85
85
|
* <p>The attachment ID for the network interface.</p>
|
|
86
86
|
* @public
|
|
87
87
|
*/
|
|
88
|
-
attachmentId?: string;
|
|
88
|
+
attachmentId?: string | undefined;
|
|
89
89
|
/**
|
|
90
90
|
* <p>The private IPv6 address for the network interface.</p>
|
|
91
91
|
* @public
|
|
92
92
|
*/
|
|
93
|
-
ipv6Address?: string;
|
|
93
|
+
ipv6Address?: string | undefined;
|
|
94
94
|
/**
|
|
95
95
|
* <p>The private IPv4 address for the network interface.</p>
|
|
96
96
|
* @public
|
|
97
97
|
*/
|
|
98
|
-
privateIpv4Address?: string;
|
|
98
|
+
privateIpv4Address?: string | undefined;
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
101
|
* <p>An object that represents the details of a container that's part of a job attempt.</p>
|
|
@@ -106,36 +106,36 @@ export interface AttemptContainerDetail {
|
|
|
106
106
|
* <p>The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.</p>
|
|
107
107
|
* @public
|
|
108
108
|
*/
|
|
109
|
-
containerInstanceArn?: string;
|
|
109
|
+
containerInstanceArn?: string | undefined;
|
|
110
110
|
/**
|
|
111
111
|
* <p>The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
|
|
112
112
|
* attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>
|
|
113
113
|
* @public
|
|
114
114
|
*/
|
|
115
|
-
taskArn?: string;
|
|
115
|
+
taskArn?: string | undefined;
|
|
116
116
|
/**
|
|
117
117
|
* <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
|
|
118
118
|
* @public
|
|
119
119
|
*/
|
|
120
|
-
exitCode?: number;
|
|
120
|
+
exitCode?: number | undefined;
|
|
121
121
|
/**
|
|
122
122
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
123
123
|
* running or stopped container.</p>
|
|
124
124
|
* @public
|
|
125
125
|
*/
|
|
126
|
-
reason?: string;
|
|
126
|
+
reason?: string | undefined;
|
|
127
127
|
/**
|
|
128
128
|
* <p>The name of the CloudWatch Logs log stream that's associated with the container. The log
|
|
129
129
|
* group for Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log
|
|
130
130
|
* stream name when they reach the <code>RUNNING</code> status.</p>
|
|
131
131
|
* @public
|
|
132
132
|
*/
|
|
133
|
-
logStreamName?: string;
|
|
133
|
+
logStreamName?: string | undefined;
|
|
134
134
|
/**
|
|
135
135
|
* <p>The network interfaces that are associated with the job attempt.</p>
|
|
136
136
|
* @public
|
|
137
137
|
*/
|
|
138
|
-
networkInterfaces?: NetworkInterface[];
|
|
138
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
139
139
|
}
|
|
140
140
|
/**
|
|
141
141
|
* <p>An object that represents the details of a container that's part of a job attempt.</p>
|
|
@@ -146,30 +146,30 @@ export interface AttemptTaskContainerDetails {
|
|
|
146
146
|
* <p>The exit code for the container’s attempt. A non-zero exit code is considered failed.</p>
|
|
147
147
|
* @public
|
|
148
148
|
*/
|
|
149
|
-
exitCode?: number;
|
|
149
|
+
exitCode?: number | undefined;
|
|
150
150
|
/**
|
|
151
151
|
* <p>The name of a container.</p>
|
|
152
152
|
* @public
|
|
153
153
|
*/
|
|
154
|
-
name?: string;
|
|
154
|
+
name?: string | undefined;
|
|
155
155
|
/**
|
|
156
156
|
* <p>A short (255 max characters) string that's easy to understand and provides additional details for a
|
|
157
157
|
* running or stopped container.</p>
|
|
158
158
|
* @public
|
|
159
159
|
*/
|
|
160
|
-
reason?: string;
|
|
160
|
+
reason?: string | undefined;
|
|
161
161
|
/**
|
|
162
162
|
* <p>The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log
|
|
163
163
|
* group for Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name
|
|
164
164
|
* when they reach the <code>RUNNING</code> status.</p>
|
|
165
165
|
* @public
|
|
166
166
|
*/
|
|
167
|
-
logStreamName?: string;
|
|
167
|
+
logStreamName?: string | undefined;
|
|
168
168
|
/**
|
|
169
169
|
* <p>The network interfaces that are associated with the job attempt.</p>
|
|
170
170
|
* @public
|
|
171
171
|
*/
|
|
172
|
-
networkInterfaces?: NetworkInterface[];
|
|
172
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
173
173
|
}
|
|
174
174
|
/**
|
|
175
175
|
* <p>An object that represents the details of a task.</p>
|
|
@@ -180,17 +180,17 @@ export interface AttemptEcsTaskDetails {
|
|
|
180
180
|
* <p>The Amazon Resource Name (ARN) of the container instance that hosts the task.</p>
|
|
181
181
|
* @public
|
|
182
182
|
*/
|
|
183
|
-
containerInstanceArn?: string;
|
|
183
|
+
containerInstanceArn?: string | undefined;
|
|
184
184
|
/**
|
|
185
185
|
* <p>The ARN of the Amazon ECS task.</p>
|
|
186
186
|
* @public
|
|
187
187
|
*/
|
|
188
|
-
taskArn?: string;
|
|
188
|
+
taskArn?: string | undefined;
|
|
189
189
|
/**
|
|
190
190
|
* <p>A list of containers that are included in the <code>taskProperties</code> list.</p>
|
|
191
191
|
* @public
|
|
192
192
|
*/
|
|
193
|
-
containers?: AttemptTaskContainerDetails[];
|
|
193
|
+
containers?: AttemptTaskContainerDetails[] | undefined;
|
|
194
194
|
}
|
|
195
195
|
/**
|
|
196
196
|
* <p>An object that represents a job attempt.</p>
|
|
@@ -201,32 +201,32 @@ export interface AttemptDetail {
|
|
|
201
201
|
* <p>The details for the container in this job attempt.</p>
|
|
202
202
|
* @public
|
|
203
203
|
*/
|
|
204
|
-
container?: AttemptContainerDetail;
|
|
204
|
+
container?: AttemptContainerDetail | undefined;
|
|
205
205
|
/**
|
|
206
206
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
|
|
207
207
|
* transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
|
|
208
208
|
* @public
|
|
209
209
|
*/
|
|
210
|
-
startedAt?: number;
|
|
210
|
+
startedAt?: number | undefined;
|
|
211
211
|
/**
|
|
212
212
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt
|
|
213
213
|
* transitioned from the <code>RUNNING</code> state to a terminal state, such as
|
|
214
214
|
* <code>SUCCEEDED</code> or <code>FAILED</code>).</p>
|
|
215
215
|
* @public
|
|
216
216
|
*/
|
|
217
|
-
stoppedAt?: number;
|
|
217
|
+
stoppedAt?: number | undefined;
|
|
218
218
|
/**
|
|
219
219
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
220
220
|
* job attempt.</p>
|
|
221
221
|
* @public
|
|
222
222
|
*/
|
|
223
|
-
statusReason?: string;
|
|
223
|
+
statusReason?: string | undefined;
|
|
224
224
|
/**
|
|
225
225
|
* <p>The properties for a task definition that describes the container and volume definitions of
|
|
226
226
|
* an Amazon ECS task.</p>
|
|
227
227
|
* @public
|
|
228
228
|
*/
|
|
229
|
-
taskProperties?: AttemptEcsTaskDetails[];
|
|
229
|
+
taskProperties?: AttemptEcsTaskDetails[] | undefined;
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
232
|
* <p>Contains the parameters for <code>CancelJob</code>.</p>
|
|
@@ -384,13 +384,93 @@ export interface Ec2Configuration {
|
|
|
384
384
|
* </note>
|
|
385
385
|
* @public
|
|
386
386
|
*/
|
|
387
|
-
imageIdOverride?: string;
|
|
387
|
+
imageIdOverride?: string | undefined;
|
|
388
388
|
/**
|
|
389
389
|
* <p>The Kubernetes version for the compute environment. If you don't specify a value, the latest
|
|
390
390
|
* version that Batch supports is used.</p>
|
|
391
391
|
* @public
|
|
392
392
|
*/
|
|
393
|
-
imageKubernetesVersion?: string;
|
|
393
|
+
imageKubernetesVersion?: string | undefined;
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* <p>An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not
|
|
397
|
+
* both.</p>
|
|
398
|
+
* <p>If security groups are specified using both the <code>securityGroupIds</code> parameter of
|
|
399
|
+
* <code>CreateComputeEnvironment</code> and the launch template, the values in the
|
|
400
|
+
* <code>securityGroupIds</code> parameter of <code>CreateComputeEnvironment</code> will be
|
|
401
|
+
* used.</p>
|
|
402
|
+
* <p>You can define up to ten (10) overrides for each compute environment.</p>
|
|
403
|
+
* <note>
|
|
404
|
+
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
405
|
+
* </note>
|
|
406
|
+
* <note>
|
|
407
|
+
* <p>To unset all override templates for a compute environment, you can pass an empty array to the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html">UpdateComputeEnvironment.overrides</a> parameter, or not include the <code>overrides</code> parameter when submitting the <code>UpdateComputeEnvironment</code> API operation.</p>
|
|
408
|
+
* </note>
|
|
409
|
+
* @public
|
|
410
|
+
*/
|
|
411
|
+
export interface LaunchTemplateSpecificationOverride {
|
|
412
|
+
/**
|
|
413
|
+
* <p>The ID of the launch template.</p>
|
|
414
|
+
* <p>
|
|
415
|
+
* <b>Note:</b> If you specify the <code>launchTemplateId</code> you can't specify the <code>launchTemplateName</code> as well.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
launchTemplateId?: string | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>The name of the launch template.</p>
|
|
421
|
+
* <p>
|
|
422
|
+
* <b>Note:</b> If you specify the <code>launchTemplateName</code> you can't specify the <code>launchTemplateId</code> as well.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
launchTemplateName?: string | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* <p>The version number of the launch template,
|
|
428
|
+
* <code>$Default</code>, or <code>$Latest</code>.</p>
|
|
429
|
+
* <p>If the value is <code>$Default</code>, the default version of the launch template is used. If the value is <code>$Latest</code>, the latest version of the launch template is used. </p>
|
|
430
|
+
* <important>
|
|
431
|
+
* <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI
|
|
432
|
+
* isn't changed when the compute environment is updated. It's only changed if the
|
|
433
|
+
* <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
|
|
434
|
+
* <code>true</code>. During an infrastructure update, if either <code>$Default</code> or <code>$Latest</code> is specified, Batch re-evaluates the launch template version, and it
|
|
435
|
+
* might use a different version of the launch template. This is the case even if the launch
|
|
436
|
+
* template isn't specified in the update. When updating a compute environment, changing the launch
|
|
437
|
+
* template requires an infrastructure update of the compute environment. For more information, see
|
|
438
|
+
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
|
|
439
|
+
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
440
|
+
* </important>
|
|
441
|
+
* <p>Default: <code>$Default</code>
|
|
442
|
+
* </p>
|
|
443
|
+
* <p>Latest: <code>$Latest</code>
|
|
444
|
+
* </p>
|
|
445
|
+
* @public
|
|
446
|
+
*/
|
|
447
|
+
version?: string | undefined;
|
|
448
|
+
/**
|
|
449
|
+
* <p>The instance type or family that this this override launch template should be applied to.</p>
|
|
450
|
+
* <p>This parameter is required when defining a launch template override.</p>
|
|
451
|
+
* <p>Information included in this parameter must meet the following requirements:</p>
|
|
452
|
+
* <ul>
|
|
453
|
+
* <li>
|
|
454
|
+
* <p>Must be a valid Amazon EC2 instance type or family.</p>
|
|
455
|
+
* </li>
|
|
456
|
+
* <li>
|
|
457
|
+
* <p>
|
|
458
|
+
* <code>optimal</code> isn't allowed.</p>
|
|
459
|
+
* </li>
|
|
460
|
+
* <li>
|
|
461
|
+
* <p>
|
|
462
|
+
* <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes">
|
|
463
|
+
* <code>ComputeResource.instanceTypes</code>
|
|
464
|
+
* </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p>
|
|
465
|
+
* </li>
|
|
466
|
+
* <li>
|
|
467
|
+
* <p>
|
|
468
|
+
* <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p>
|
|
469
|
+
* </li>
|
|
470
|
+
* </ul>
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
targetInstanceTypes?: string[] | undefined;
|
|
394
474
|
}
|
|
395
475
|
/**
|
|
396
476
|
* <p>An object that represents a launch template that's associated with a compute resource. You
|
|
@@ -410,33 +490,44 @@ export interface LaunchTemplateSpecification {
|
|
|
410
490
|
* <p>The ID of the launch template.</p>
|
|
411
491
|
* @public
|
|
412
492
|
*/
|
|
413
|
-
launchTemplateId?: string;
|
|
493
|
+
launchTemplateId?: string | undefined;
|
|
414
494
|
/**
|
|
415
495
|
* <p>The name of the launch template.</p>
|
|
416
496
|
* @public
|
|
417
497
|
*/
|
|
418
|
-
launchTemplateName?: string;
|
|
498
|
+
launchTemplateName?: string | undefined;
|
|
419
499
|
/**
|
|
420
|
-
* <p>The version number of the launch template,
|
|
421
|
-
* <code>$Default</code>.</p>
|
|
422
|
-
* <p>If the value is <code>$Latest</code>, the latest version of the launch template is used.
|
|
423
|
-
* the value is <code>$Default</code>, the default version of the launch template is used.</p>
|
|
500
|
+
* <p>The version number of the launch template,
|
|
501
|
+
* <code>$Default</code>, or <code>$Latest</code>.</p>
|
|
502
|
+
* <p>If the value is <code>$Default</code>, the default version of the launch template is used. If the value is <code>$Latest</code>, the latest version of the launch template is used. </p>
|
|
424
503
|
* <important>
|
|
425
504
|
* <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI
|
|
426
505
|
* isn't changed when the compute environment is updated. It's only changed if the
|
|
427
506
|
* <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
|
|
428
|
-
* <code>true</code>. During an infrastructure update, if either <code>$
|
|
429
|
-
* <code>$
|
|
507
|
+
* <code>true</code>. During an infrastructure update, if either <code>$Default</code> or
|
|
508
|
+
* <code>$Latest</code> is specified, Batch re-evaluates the launch template version, and it
|
|
430
509
|
* might use a different version of the launch template. This is the case even if the launch
|
|
431
510
|
* template isn't specified in the update. When updating a compute environment, changing the launch
|
|
432
511
|
* template requires an infrastructure update of the compute environment. For more information, see
|
|
433
512
|
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
|
|
434
513
|
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
435
514
|
* </important>
|
|
436
|
-
* <p>Default: <code>$Default</code
|
|
515
|
+
* <p>Default: <code>$Default</code>
|
|
516
|
+
* </p>
|
|
517
|
+
* <p>Latest: <code>$Latest</code>
|
|
518
|
+
* </p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
version?: string | undefined;
|
|
522
|
+
/**
|
|
523
|
+
* <p>A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.</p>
|
|
524
|
+
* <p>You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.</p>
|
|
525
|
+
* <note>
|
|
526
|
+
* <p>To unset all override templates for a compute environment, you can pass an empty array to the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html">UpdateComputeEnvironment.overrides</a> parameter, or not include the <code>overrides</code> parameter when submitting the <code>UpdateComputeEnvironment</code> API operation.</p>
|
|
527
|
+
* </note>
|
|
437
528
|
* @public
|
|
438
529
|
*/
|
|
439
|
-
|
|
530
|
+
overrides?: LaunchTemplateSpecificationOverride[] | undefined;
|
|
440
531
|
}
|
|
441
532
|
/**
|
|
442
533
|
* @public
|
|
@@ -520,7 +611,7 @@ export interface ComputeResource {
|
|
|
520
611
|
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
521
612
|
* @public
|
|
522
613
|
*/
|
|
523
|
-
allocationStrategy?: CRAllocationStrategy;
|
|
614
|
+
allocationStrategy?: CRAllocationStrategy | undefined;
|
|
524
615
|
/**
|
|
525
616
|
* <p>The minimum number of
|
|
526
617
|
* vCPUs that
|
|
@@ -532,7 +623,7 @@ export interface ComputeResource {
|
|
|
532
623
|
* </note>
|
|
533
624
|
* @public
|
|
534
625
|
*/
|
|
535
|
-
minvCpus?: number;
|
|
626
|
+
minvCpus?: number | undefined;
|
|
536
627
|
/**
|
|
537
628
|
* <p>The maximum number of
|
|
538
629
|
* vCPUs that a
|
|
@@ -559,7 +650,7 @@ export interface ComputeResource {
|
|
|
559
650
|
* </note>
|
|
560
651
|
* @public
|
|
561
652
|
*/
|
|
562
|
-
desiredvCpus?: number;
|
|
653
|
+
desiredvCpus?: number | undefined;
|
|
563
654
|
/**
|
|
564
655
|
* <p>The instances types that can be launched. You can specify instance families to launch any
|
|
565
656
|
* instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
|
|
@@ -581,7 +672,7 @@ export interface ComputeResource {
|
|
|
581
672
|
* </note>
|
|
582
673
|
* @public
|
|
583
674
|
*/
|
|
584
|
-
instanceTypes?: string[];
|
|
675
|
+
instanceTypes?: string[] | undefined;
|
|
585
676
|
/**
|
|
586
677
|
* @deprecated
|
|
587
678
|
*
|
|
@@ -601,7 +692,7 @@ export interface ComputeResource {
|
|
|
601
692
|
* </note>
|
|
602
693
|
* @public
|
|
603
694
|
*/
|
|
604
|
-
imageId?: string;
|
|
695
|
+
imageId?: string | undefined;
|
|
605
696
|
/**
|
|
606
697
|
* <p>The VPC subnets where the compute resources are launched. These subnets must be within the
|
|
607
698
|
* same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see
|
|
@@ -628,7 +719,7 @@ export interface ComputeResource {
|
|
|
628
719
|
* <code>launchTemplate</code>, the values in <code>securityGroupIds</code> are used.</p>
|
|
629
720
|
* @public
|
|
630
721
|
*/
|
|
631
|
-
securityGroupIds?: string[];
|
|
722
|
+
securityGroupIds?: string[] | undefined;
|
|
632
723
|
/**
|
|
633
724
|
* <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
|
|
634
725
|
* use this key pair to log in to your instances with SSH.</p>
|
|
@@ -637,7 +728,7 @@ export interface ComputeResource {
|
|
|
637
728
|
* </note>
|
|
638
729
|
* @public
|
|
639
730
|
*/
|
|
640
|
-
ec2KeyPair?: string;
|
|
731
|
+
ec2KeyPair?: string | undefined;
|
|
641
732
|
/**
|
|
642
733
|
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This
|
|
643
734
|
* parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)
|
|
@@ -652,7 +743,7 @@ export interface ComputeResource {
|
|
|
652
743
|
* </note>
|
|
653
744
|
* @public
|
|
654
745
|
*/
|
|
655
|
-
instanceRole?: string;
|
|
746
|
+
instanceRole?: string | undefined;
|
|
656
747
|
/**
|
|
657
748
|
* <p>Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
|
|
658
749
|
* environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
|
|
@@ -667,7 +758,7 @@ export interface ComputeResource {
|
|
|
667
758
|
* </note>
|
|
668
759
|
* @public
|
|
669
760
|
*/
|
|
670
|
-
tags?: Record<string, string
|
|
761
|
+
tags?: Record<string, string> | undefined;
|
|
671
762
|
/**
|
|
672
763
|
* <p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit
|
|
673
764
|
* multi-node parallel jobs to your compute environment, you should consider creating a cluster
|
|
@@ -680,7 +771,7 @@ export interface ComputeResource {
|
|
|
680
771
|
* </note>
|
|
681
772
|
* @public
|
|
682
773
|
*/
|
|
683
|
-
placementGroup?: string;
|
|
774
|
+
placementGroup?: string | undefined;
|
|
684
775
|
/**
|
|
685
776
|
* <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand
|
|
686
777
|
* price for that instance type before instances are launched. For example, if your maximum
|
|
@@ -694,7 +785,7 @@ export interface ComputeResource {
|
|
|
694
785
|
* </note>
|
|
695
786
|
* @public
|
|
696
787
|
*/
|
|
697
|
-
bidPercentage?: number;
|
|
788
|
+
bidPercentage?: number | undefined;
|
|
698
789
|
/**
|
|
699
790
|
* <p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute
|
|
700
791
|
* environment. This role is required if the allocation strategy set to <code>BEST_FIT</code> or if
|
|
@@ -712,7 +803,7 @@ export interface ComputeResource {
|
|
|
712
803
|
* </important>
|
|
713
804
|
* @public
|
|
714
805
|
*/
|
|
715
|
-
spotIamFleetRole?: string;
|
|
806
|
+
spotIamFleetRole?: string | undefined;
|
|
716
807
|
/**
|
|
717
808
|
* <p>The launch template to use for your compute resources. Any other compute resource parameters
|
|
718
809
|
* that you specify in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html">CreateComputeEnvironment</a> API operation override the same parameters in the launch
|
|
@@ -724,7 +815,7 @@ export interface ComputeResource {
|
|
|
724
815
|
* </note>
|
|
725
816
|
* @public
|
|
726
817
|
*/
|
|
727
|
-
launchTemplate?: LaunchTemplateSpecification;
|
|
818
|
+
launchTemplate?: LaunchTemplateSpecification | undefined;
|
|
728
819
|
/**
|
|
729
820
|
* <p>Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances
|
|
730
821
|
* in the compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
@@ -735,7 +826,7 @@ export interface ComputeResource {
|
|
|
735
826
|
* </note>
|
|
736
827
|
* @public
|
|
737
828
|
*/
|
|
738
|
-
ec2Configuration?: Ec2Configuration[];
|
|
829
|
+
ec2Configuration?: Ec2Configuration[] | undefined;
|
|
739
830
|
}
|
|
740
831
|
/**
|
|
741
832
|
* <p>Configuration for the Amazon EKS cluster that supports the Batch compute environment. The
|
|
@@ -825,7 +916,7 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
825
916
|
* instance.</p>
|
|
826
917
|
* @public
|
|
827
918
|
*/
|
|
828
|
-
state?: CEState;
|
|
919
|
+
state?: CEState | undefined;
|
|
829
920
|
/**
|
|
830
921
|
* <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only
|
|
831
922
|
* used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this
|
|
@@ -836,14 +927,14 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
836
927
|
* </note>
|
|
837
928
|
* @public
|
|
838
929
|
*/
|
|
839
|
-
unmanagedvCpus?: number;
|
|
930
|
+
unmanagedvCpus?: number | undefined;
|
|
840
931
|
/**
|
|
841
932
|
* <p>Details about the compute resources managed by the compute environment. This parameter is
|
|
842
933
|
* required for managed compute environments. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a>
|
|
843
934
|
* in the <i>Batch User Guide</i>.</p>
|
|
844
935
|
* @public
|
|
845
936
|
*/
|
|
846
|
-
computeResources?: ComputeResource;
|
|
937
|
+
computeResources?: ComputeResource | undefined;
|
|
847
938
|
/**
|
|
848
939
|
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
849
940
|
* services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the
|
|
@@ -868,7 +959,7 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
868
959
|
* </note>
|
|
869
960
|
* @public
|
|
870
961
|
*/
|
|
871
|
-
serviceRole?: string;
|
|
962
|
+
serviceRole?: string | undefined;
|
|
872
963
|
/**
|
|
873
964
|
* <p>The tags that you apply to the compute environment to help you categorize and organize
|
|
874
965
|
* your resources. Each tag consists of a key and an optional value. For more information, see
|
|
@@ -878,17 +969,17 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
878
969
|
* resources.</p>
|
|
879
970
|
* @public
|
|
880
971
|
*/
|
|
881
|
-
tags?: Record<string, string
|
|
972
|
+
tags?: Record<string, string> | undefined;
|
|
882
973
|
/**
|
|
883
974
|
* <p>The details for the Amazon EKS cluster that supports the compute environment.</p>
|
|
884
975
|
* @public
|
|
885
976
|
*/
|
|
886
|
-
eksConfiguration?: EksConfiguration;
|
|
977
|
+
eksConfiguration?: EksConfiguration | undefined;
|
|
887
978
|
/**
|
|
888
979
|
* <p>Reserved.</p>
|
|
889
980
|
* @public
|
|
890
981
|
*/
|
|
891
|
-
context?: string;
|
|
982
|
+
context?: string | undefined;
|
|
892
983
|
}
|
|
893
984
|
/**
|
|
894
985
|
* @public
|
|
@@ -899,12 +990,12 @@ export interface CreateComputeEnvironmentResponse {
|
|
|
899
990
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
900
991
|
* @public
|
|
901
992
|
*/
|
|
902
|
-
computeEnvironmentName?: string;
|
|
993
|
+
computeEnvironmentName?: string | undefined;
|
|
903
994
|
/**
|
|
904
995
|
* <p>The Amazon Resource Name (ARN) of the compute environment.</p>
|
|
905
996
|
* @public
|
|
906
997
|
*/
|
|
907
|
-
computeEnvironmentArn?: string;
|
|
998
|
+
computeEnvironmentArn?: string | undefined;
|
|
908
999
|
}
|
|
909
1000
|
/**
|
|
910
1001
|
* <p>The order that compute environments are tried in for job placement within a queue. Compute
|
|
@@ -1014,7 +1105,7 @@ export interface CreateJobQueueRequest {
|
|
|
1014
1105
|
* queue, but jobs already in the queue can finish.</p>
|
|
1015
1106
|
* @public
|
|
1016
1107
|
*/
|
|
1017
|
-
state?: JQState;
|
|
1108
|
+
state?: JQState | undefined;
|
|
1018
1109
|
/**
|
|
1019
1110
|
* <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. Job queues that don't have a scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a scheduling policy, it can be replaced but can't be removed.</p>
|
|
1020
1111
|
* <p>The format is
|
|
@@ -1025,7 +1116,7 @@ export interface CreateJobQueueRequest {
|
|
|
1025
1116
|
* <p>A job queue without a scheduling policy is scheduled as a FIFO job queue and can't have a scheduling policy added. Jobs queues with a scheduling policy can have a maximum of 500 active fair share identifiers. When the limit has been reached, submissions of any jobs that add a new fair share identifier fail.</p>
|
|
1026
1117
|
* @public
|
|
1027
1118
|
*/
|
|
1028
|
-
schedulingPolicyArn?: string;
|
|
1119
|
+
schedulingPolicyArn?: string | undefined;
|
|
1029
1120
|
/**
|
|
1030
1121
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
1031
1122
|
* value for the <code>priority</code> parameter) are evaluated first when associated with the
|
|
@@ -1059,12 +1150,12 @@ export interface CreateJobQueueRequest {
|
|
|
1059
1150
|
* in <i>Batch User Guide</i>.</p>
|
|
1060
1151
|
* @public
|
|
1061
1152
|
*/
|
|
1062
|
-
tags?: Record<string, string
|
|
1153
|
+
tags?: Record<string, string> | undefined;
|
|
1063
1154
|
/**
|
|
1064
1155
|
* <p>The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed. (<b>Note</b>: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)</p>
|
|
1065
1156
|
* @public
|
|
1066
1157
|
*/
|
|
1067
|
-
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
|
|
1158
|
+
jobStateTimeLimitActions?: JobStateTimeLimitAction[] | undefined;
|
|
1068
1159
|
}
|
|
1069
1160
|
/**
|
|
1070
1161
|
* @public
|
|
@@ -1107,7 +1198,7 @@ export interface ShareAttributes {
|
|
|
1107
1198
|
* <p>The smallest supported value is 0.0001, and the largest supported value is 999.9999.</p>
|
|
1108
1199
|
* @public
|
|
1109
1200
|
*/
|
|
1110
|
-
weightFactor?: number;
|
|
1201
|
+
weightFactor?: number | undefined;
|
|
1111
1202
|
}
|
|
1112
1203
|
/**
|
|
1113
1204
|
* <p>The fair share policy for a scheduling policy.</p>
|
|
@@ -1121,7 +1212,7 @@ export interface FairsharePolicy {
|
|
|
1121
1212
|
* maximum supported value is 604800 (1 week).</p>
|
|
1122
1213
|
* @public
|
|
1123
1214
|
*/
|
|
1124
|
-
shareDecaySeconds?: number;
|
|
1215
|
+
shareDecaySeconds?: number | undefined;
|
|
1125
1216
|
/**
|
|
1126
1217
|
* <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that
|
|
1127
1218
|
* aren't already used.</p>
|
|
@@ -1141,14 +1232,14 @@ export interface FairsharePolicy {
|
|
|
1141
1232
|
* <p>The minimum value is 0 and the maximum value is 99.</p>
|
|
1142
1233
|
* @public
|
|
1143
1234
|
*/
|
|
1144
|
-
computeReservation?: number;
|
|
1235
|
+
computeReservation?: number | undefined;
|
|
1145
1236
|
/**
|
|
1146
1237
|
* <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair
|
|
1147
1238
|
* share identifiers for the fair share policy. Fair share identifiers that aren't included have a
|
|
1148
1239
|
* default weight of <code>1.0</code>.</p>
|
|
1149
1240
|
* @public
|
|
1150
1241
|
*/
|
|
1151
|
-
shareDistribution?: ShareAttributes[];
|
|
1242
|
+
shareDistribution?: ShareAttributes[] | undefined;
|
|
1152
1243
|
}
|
|
1153
1244
|
/**
|
|
1154
1245
|
* <p>Contains the parameters for <code>CreateSchedulingPolicy</code>.</p>
|
|
@@ -1165,7 +1256,7 @@ export interface CreateSchedulingPolicyRequest {
|
|
|
1165
1256
|
* <p>The fair share policy of the scheduling policy.</p>
|
|
1166
1257
|
* @public
|
|
1167
1258
|
*/
|
|
1168
|
-
fairsharePolicy?: FairsharePolicy;
|
|
1259
|
+
fairsharePolicy?: FairsharePolicy | undefined;
|
|
1169
1260
|
/**
|
|
1170
1261
|
* <p>The tags that you apply to the scheduling policy to help you categorize and organize your
|
|
1171
1262
|
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
@@ -1173,7 +1264,7 @@ export interface CreateSchedulingPolicyRequest {
|
|
|
1173
1264
|
* <p>These tags can be updated or removed using the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html">TagResource</a> and <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html">UntagResource</a> API operations.</p>
|
|
1174
1265
|
* @public
|
|
1175
1266
|
*/
|
|
1176
|
-
tags?: Record<string, string
|
|
1267
|
+
tags?: Record<string, string> | undefined;
|
|
1177
1268
|
}
|
|
1178
1269
|
/**
|
|
1179
1270
|
* @public
|
|
@@ -1267,7 +1358,7 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1267
1358
|
* <p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.</p>
|
|
1268
1359
|
* @public
|
|
1269
1360
|
*/
|
|
1270
|
-
computeEnvironments?: string[];
|
|
1361
|
+
computeEnvironments?: string[] | undefined;
|
|
1271
1362
|
/**
|
|
1272
1363
|
* <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code>
|
|
1273
1364
|
* in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</code>
|
|
@@ -1280,7 +1371,7 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1280
1371
|
* applicable.</p>
|
|
1281
1372
|
* @public
|
|
1282
1373
|
*/
|
|
1283
|
-
maxResults?: number;
|
|
1374
|
+
maxResults?: number | undefined;
|
|
1284
1375
|
/**
|
|
1285
1376
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1286
1377
|
* <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and
|
|
@@ -1293,7 +1384,7 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1293
1384
|
* </note>
|
|
1294
1385
|
* @public
|
|
1295
1386
|
*/
|
|
1296
|
-
nextToken?: string;
|
|
1387
|
+
nextToken?: string | undefined;
|
|
1297
1388
|
}
|
|
1298
1389
|
/**
|
|
1299
1390
|
* @public
|
|
@@ -1335,13 +1426,13 @@ export interface UpdatePolicy {
|
|
|
1335
1426
|
* infrastructure is updated. The default value is <code>false</code>.</p>
|
|
1336
1427
|
* @public
|
|
1337
1428
|
*/
|
|
1338
|
-
terminateJobsOnUpdate?: boolean;
|
|
1429
|
+
terminateJobsOnUpdate?: boolean | undefined;
|
|
1339
1430
|
/**
|
|
1340
1431
|
* <p>Specifies the job timeout (in minutes) when the compute environment infrastructure is
|
|
1341
1432
|
* updated. The default value is 30.</p>
|
|
1342
1433
|
* @public
|
|
1343
1434
|
*/
|
|
1344
|
-
jobExecutionTimeoutMinutes?: number;
|
|
1435
|
+
jobExecutionTimeoutMinutes?: number | undefined;
|
|
1345
1436
|
}
|
|
1346
1437
|
/**
|
|
1347
1438
|
* <p>An object that represents an Batch compute environment.</p>
|
|
@@ -1363,23 +1454,23 @@ export interface ComputeEnvironmentDetail {
|
|
|
1363
1454
|
* <p>The maximum number of VCPUs expected to be used for an unmanaged compute environment.</p>
|
|
1364
1455
|
* @public
|
|
1365
1456
|
*/
|
|
1366
|
-
unmanagedvCpus?: number;
|
|
1457
|
+
unmanagedvCpus?: number | undefined;
|
|
1367
1458
|
/**
|
|
1368
1459
|
* <p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.</p>
|
|
1369
1460
|
* @public
|
|
1370
1461
|
*/
|
|
1371
|
-
ecsClusterArn?: string;
|
|
1462
|
+
ecsClusterArn?: string | undefined;
|
|
1372
1463
|
/**
|
|
1373
1464
|
* <p>The tags applied to the compute environment.</p>
|
|
1374
1465
|
* @public
|
|
1375
1466
|
*/
|
|
1376
|
-
tags?: Record<string, string
|
|
1467
|
+
tags?: Record<string, string> | undefined;
|
|
1377
1468
|
/**
|
|
1378
1469
|
* <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For
|
|
1379
1470
|
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
1380
1471
|
* @public
|
|
1381
1472
|
*/
|
|
1382
|
-
type?: CEType;
|
|
1473
|
+
type?: CEType | undefined;
|
|
1383
1474
|
/**
|
|
1384
1475
|
* <p>The state of the compute environment. The valid values are <code>ENABLED</code> or
|
|
1385
1476
|
* <code>DISABLED</code>.</p>
|
|
@@ -1403,61 +1494,61 @@ export interface ComputeEnvironmentDetail {
|
|
|
1403
1494
|
* instance.</p>
|
|
1404
1495
|
* @public
|
|
1405
1496
|
*/
|
|
1406
|
-
state?: CEState;
|
|
1497
|
+
state?: CEState | undefined;
|
|
1407
1498
|
/**
|
|
1408
1499
|
* <p>The current status of the compute environment (for example, <code>CREATING</code> or
|
|
1409
1500
|
* <code>VALID</code>).</p>
|
|
1410
1501
|
* @public
|
|
1411
1502
|
*/
|
|
1412
|
-
status?: CEStatus;
|
|
1503
|
+
status?: CEStatus | undefined;
|
|
1413
1504
|
/**
|
|
1414
1505
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
1415
1506
|
* compute environment.</p>
|
|
1416
1507
|
* @public
|
|
1417
1508
|
*/
|
|
1418
|
-
statusReason?: string;
|
|
1509
|
+
statusReason?: string | undefined;
|
|
1419
1510
|
/**
|
|
1420
1511
|
* <p>The compute resources defined for the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in
|
|
1421
1512
|
* the <i>Batch User Guide</i>.</p>
|
|
1422
1513
|
* @public
|
|
1423
1514
|
*/
|
|
1424
|
-
computeResources?: ComputeResource;
|
|
1515
|
+
computeResources?: ComputeResource | undefined;
|
|
1425
1516
|
/**
|
|
1426
1517
|
* <p>The service role that's associated with the compute environment that allows Batch to make
|
|
1427
1518
|
* calls to Amazon Web Services API operations on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the
|
|
1428
1519
|
* <i>Batch User Guide</i>.</p>
|
|
1429
1520
|
* @public
|
|
1430
1521
|
*/
|
|
1431
|
-
serviceRole?: string;
|
|
1522
|
+
serviceRole?: string | undefined;
|
|
1432
1523
|
/**
|
|
1433
1524
|
* <p>Specifies the infrastructure update policy for the compute environment. For more information
|
|
1434
1525
|
* about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
1435
1526
|
* <i>Batch User Guide</i>.</p>
|
|
1436
1527
|
* @public
|
|
1437
1528
|
*/
|
|
1438
|
-
updatePolicy?: UpdatePolicy;
|
|
1529
|
+
updatePolicy?: UpdatePolicy | undefined;
|
|
1439
1530
|
/**
|
|
1440
1531
|
* <p>The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only
|
|
1441
1532
|
* specify this parameter if the <code>containerOrchestrationType</code> is <code>EKS</code>.</p>
|
|
1442
1533
|
* @public
|
|
1443
1534
|
*/
|
|
1444
|
-
eksConfiguration?: EksConfiguration;
|
|
1535
|
+
eksConfiguration?: EksConfiguration | undefined;
|
|
1445
1536
|
/**
|
|
1446
1537
|
* <p>The orchestration type of the compute environment. The valid values are <code>ECS</code>
|
|
1447
1538
|
* (default) or <code>EKS</code>.</p>
|
|
1448
1539
|
* @public
|
|
1449
1540
|
*/
|
|
1450
|
-
containerOrchestrationType?: OrchestrationType;
|
|
1541
|
+
containerOrchestrationType?: OrchestrationType | undefined;
|
|
1451
1542
|
/**
|
|
1452
1543
|
* <p>Unique identifier for the compute environment.</p>
|
|
1453
1544
|
* @public
|
|
1454
1545
|
*/
|
|
1455
|
-
uuid?: string;
|
|
1546
|
+
uuid?: string | undefined;
|
|
1456
1547
|
/**
|
|
1457
1548
|
* <p>Reserved.</p>
|
|
1458
1549
|
* @public
|
|
1459
1550
|
*/
|
|
1460
|
-
context?: string;
|
|
1551
|
+
context?: string | undefined;
|
|
1461
1552
|
}
|
|
1462
1553
|
/**
|
|
1463
1554
|
* @public
|
|
@@ -1467,7 +1558,7 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
1467
1558
|
* <p>The list of compute environments.</p>
|
|
1468
1559
|
* @public
|
|
1469
1560
|
*/
|
|
1470
|
-
computeEnvironments?: ComputeEnvironmentDetail[];
|
|
1561
|
+
computeEnvironments?: ComputeEnvironmentDetail[] | undefined;
|
|
1471
1562
|
/**
|
|
1472
1563
|
* <p>The <code>nextToken</code> value to include in a future
|
|
1473
1564
|
* <code>DescribeComputeEnvironments</code> request. When the results of a
|
|
@@ -1476,7 +1567,7 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
1476
1567
|
* are no more results to return.</p>
|
|
1477
1568
|
* @public
|
|
1478
1569
|
*/
|
|
1479
|
-
nextToken?: string;
|
|
1570
|
+
nextToken?: string | undefined;
|
|
1480
1571
|
}
|
|
1481
1572
|
/**
|
|
1482
1573
|
* <p>Contains the parameters for <code>DescribeJobDefinitions</code>.</p>
|
|
@@ -1491,7 +1582,7 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1491
1582
|
* parameter can't be used with other parameters.</p>
|
|
1492
1583
|
* @public
|
|
1493
1584
|
*/
|
|
1494
|
-
jobDefinitions?: string[];
|
|
1585
|
+
jobDefinitions?: string[] | undefined;
|
|
1495
1586
|
/**
|
|
1496
1587
|
* <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated
|
|
1497
1588
|
* output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns
|
|
@@ -1503,17 +1594,17 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1503
1594
|
* a <code>nextToken</code> value if applicable.</p>
|
|
1504
1595
|
* @public
|
|
1505
1596
|
*/
|
|
1506
|
-
maxResults?: number;
|
|
1597
|
+
maxResults?: number | undefined;
|
|
1507
1598
|
/**
|
|
1508
1599
|
* <p>The name of the job definition to describe.</p>
|
|
1509
1600
|
* @public
|
|
1510
1601
|
*/
|
|
1511
|
-
jobDefinitionName?: string;
|
|
1602
|
+
jobDefinitionName?: string | undefined;
|
|
1512
1603
|
/**
|
|
1513
1604
|
* <p>The status used to filter job definitions.</p>
|
|
1514
1605
|
* @public
|
|
1515
1606
|
*/
|
|
1516
|
-
status?: string;
|
|
1607
|
+
status?: string | undefined;
|
|
1517
1608
|
/**
|
|
1518
1609
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1519
1610
|
* <code>DescribeJobDefinitions</code> request where <code>maxResults</code> was used and the
|
|
@@ -1526,7 +1617,7 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1526
1617
|
* </note>
|
|
1527
1618
|
* @public
|
|
1528
1619
|
*/
|
|
1529
|
-
nextToken?: string;
|
|
1620
|
+
nextToken?: string | undefined;
|
|
1530
1621
|
}
|
|
1531
1622
|
/**
|
|
1532
1623
|
* <p>A key-value pair object.</p>
|
|
@@ -1538,13 +1629,13 @@ export interface KeyValuePair {
|
|
|
1538
1629
|
* environment variable.</p>
|
|
1539
1630
|
* @public
|
|
1540
1631
|
*/
|
|
1541
|
-
name?: string;
|
|
1632
|
+
name?: string | undefined;
|
|
1542
1633
|
/**
|
|
1543
1634
|
* <p>The value of the key-value pair. For environment variables, this is the value of the
|
|
1544
1635
|
* environment variable.</p>
|
|
1545
1636
|
* @public
|
|
1546
1637
|
*/
|
|
1547
|
-
value?: string;
|
|
1638
|
+
value?: string | undefined;
|
|
1548
1639
|
}
|
|
1549
1640
|
/**
|
|
1550
1641
|
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
|
|
@@ -1574,7 +1665,7 @@ export interface FargatePlatformConfiguration {
|
|
|
1574
1665
|
* platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1575
1666
|
* @public
|
|
1576
1667
|
*/
|
|
1577
|
-
platformVersion?: string;
|
|
1668
|
+
platformVersion?: string | undefined;
|
|
1578
1669
|
}
|
|
1579
1670
|
/**
|
|
1580
1671
|
* @public
|
|
@@ -1608,14 +1699,14 @@ export interface Device {
|
|
|
1608
1699
|
* <code>hostPath</code> value is used.</p>
|
|
1609
1700
|
* @public
|
|
1610
1701
|
*/
|
|
1611
|
-
containerPath?: string;
|
|
1702
|
+
containerPath?: string | undefined;
|
|
1612
1703
|
/**
|
|
1613
1704
|
* <p>The explicit permissions to provide to the container for the device. By default, the
|
|
1614
1705
|
* container has permissions for <code>read</code>, <code>write</code>, and <code>mknod</code> for
|
|
1615
1706
|
* the device.</p>
|
|
1616
1707
|
* @public
|
|
1617
1708
|
*/
|
|
1618
|
-
permissions?: DeviceCgroupPermission[];
|
|
1709
|
+
permissions?: DeviceCgroupPermission[] | undefined;
|
|
1619
1710
|
}
|
|
1620
1711
|
/**
|
|
1621
1712
|
* <p>The container path, mount options, and size of the <code>tmpfs</code> mount.</p>
|
|
@@ -1650,7 +1741,7 @@ export interface Tmpfs {
|
|
|
1650
1741
|
* "<code>nr_blocks</code>" | "<code>mpol</code>"</p>
|
|
1651
1742
|
* @public
|
|
1652
1743
|
*/
|
|
1653
|
-
mountOptions?: string[];
|
|
1744
|
+
mountOptions?: string[] | undefined;
|
|
1654
1745
|
}
|
|
1655
1746
|
/**
|
|
1656
1747
|
* <p>Linux-specific modifications that are applied to the container, such as details for device
|
|
@@ -1669,7 +1760,7 @@ export interface LinuxParameters {
|
|
|
1669
1760
|
* </note>
|
|
1670
1761
|
* @public
|
|
1671
1762
|
*/
|
|
1672
|
-
devices?: Device[];
|
|
1763
|
+
devices?: Device[] | undefined;
|
|
1673
1764
|
/**
|
|
1674
1765
|
* <p>If true, run an <code>init</code> process inside the container that forwards signals and
|
|
1675
1766
|
* reaps processes. This parameter maps to the <code>--init</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. This parameter requires version 1.25 of the Docker Remote API or greater on your
|
|
@@ -1678,7 +1769,7 @@ export interface LinuxParameters {
|
|
|
1678
1769
|
* </p>
|
|
1679
1770
|
* @public
|
|
1680
1771
|
*/
|
|
1681
|
-
initProcessEnabled?: boolean;
|
|
1772
|
+
initProcessEnabled?: boolean | undefined;
|
|
1682
1773
|
/**
|
|
1683
1774
|
* <p>The value for the size (in MiB) of the <code>/dev/shm</code> volume. This parameter maps to
|
|
1684
1775
|
* the <code>--shm-size</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
@@ -1689,7 +1780,7 @@ export interface LinuxParameters {
|
|
|
1689
1780
|
* </note>
|
|
1690
1781
|
* @public
|
|
1691
1782
|
*/
|
|
1692
|
-
sharedMemorySize?: number;
|
|
1783
|
+
sharedMemorySize?: number | undefined;
|
|
1693
1784
|
/**
|
|
1694
1785
|
* <p>The container path, mount options, and size (in MiB) of the <code>tmpfs</code> mount. This
|
|
1695
1786
|
* parameter maps to the <code>--tmpfs</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
@@ -1700,7 +1791,7 @@ export interface LinuxParameters {
|
|
|
1700
1791
|
* </note>
|
|
1701
1792
|
* @public
|
|
1702
1793
|
*/
|
|
1703
|
-
tmpfs?: Tmpfs[];
|
|
1794
|
+
tmpfs?: Tmpfs[] | undefined;
|
|
1704
1795
|
/**
|
|
1705
1796
|
* <p>The total amount of swap memory (in MiB) a container can use. This parameter is translated
|
|
1706
1797
|
* to the <code>--memory-swap</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
@@ -1718,7 +1809,7 @@ export interface LinuxParameters {
|
|
|
1718
1809
|
* </note>
|
|
1719
1810
|
* @public
|
|
1720
1811
|
*/
|
|
1721
|
-
maxSwap?: number;
|
|
1812
|
+
maxSwap?: number | undefined;
|
|
1722
1813
|
/**
|
|
1723
1814
|
* <p>You can use this parameter to tune a container's memory swappiness behavior. A
|
|
1724
1815
|
* <code>swappiness</code> value of <code>0</code> causes swapping to not occur unless absolutely
|
|
@@ -1759,7 +1850,7 @@ export interface LinuxParameters {
|
|
|
1759
1850
|
* </note>
|
|
1760
1851
|
* @public
|
|
1761
1852
|
*/
|
|
1762
|
-
swappiness?: number;
|
|
1853
|
+
swappiness?: number | undefined;
|
|
1763
1854
|
}
|
|
1764
1855
|
/**
|
|
1765
1856
|
* @public
|
|
@@ -1893,13 +1984,13 @@ export interface LogConfiguration {
|
|
|
1893
1984
|
* </p>
|
|
1894
1985
|
* @public
|
|
1895
1986
|
*/
|
|
1896
|
-
options?: Record<string, string
|
|
1987
|
+
options?: Record<string, string> | undefined;
|
|
1897
1988
|
/**
|
|
1898
1989
|
* <p>The secrets to pass to the log configuration. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying sensitive
|
|
1899
1990
|
* data</a> in the <i>Batch User Guide</i>.</p>
|
|
1900
1991
|
* @public
|
|
1901
1992
|
*/
|
|
1902
|
-
secretOptions?: Secret[];
|
|
1993
|
+
secretOptions?: Secret[] | undefined;
|
|
1903
1994
|
}
|
|
1904
1995
|
/**
|
|
1905
1996
|
* <p>Details for a Docker volume mount point that's used in a job's container properties. This
|
|
@@ -1913,18 +2004,18 @@ export interface MountPoint {
|
|
|
1913
2004
|
* <p>The path on the container where the host volume is mounted.</p>
|
|
1914
2005
|
* @public
|
|
1915
2006
|
*/
|
|
1916
|
-
containerPath?: string;
|
|
2007
|
+
containerPath?: string | undefined;
|
|
1917
2008
|
/**
|
|
1918
2009
|
* <p>If this value is <code>true</code>, the container has read-only access to the volume.
|
|
1919
2010
|
* Otherwise, the container can write to the volume. The default value is <code>false</code>.</p>
|
|
1920
2011
|
* @public
|
|
1921
2012
|
*/
|
|
1922
|
-
readOnly?: boolean;
|
|
2013
|
+
readOnly?: boolean | undefined;
|
|
1923
2014
|
/**
|
|
1924
2015
|
* <p>The name of the volume to mount.</p>
|
|
1925
2016
|
* @public
|
|
1926
2017
|
*/
|
|
1927
|
-
sourceVolume?: string;
|
|
2018
|
+
sourceVolume?: string | undefined;
|
|
1928
2019
|
}
|
|
1929
2020
|
/**
|
|
1930
2021
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
@@ -1940,7 +2031,7 @@ export interface NetworkConfiguration {
|
|
|
1940
2031
|
* <i>Amazon Elastic Container Service Developer Guide</i>. The default value is "<code>DISABLED</code>".</p>
|
|
1941
2032
|
* @public
|
|
1942
2033
|
*/
|
|
1943
|
-
assignPublicIp?: AssignPublicIp;
|
|
2034
|
+
assignPublicIp?: AssignPublicIp | undefined;
|
|
1944
2035
|
}
|
|
1945
2036
|
/**
|
|
1946
2037
|
* <p>The repository credentials for private registry authentication.</p>
|
|
@@ -2184,7 +2275,7 @@ export interface RuntimePlatform {
|
|
|
2184
2275
|
* </note>
|
|
2185
2276
|
* @public
|
|
2186
2277
|
*/
|
|
2187
|
-
operatingSystemFamily?: string;
|
|
2278
|
+
operatingSystemFamily?: string | undefined;
|
|
2188
2279
|
/**
|
|
2189
2280
|
* <p> The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
|
|
2190
2281
|
* <code>X86_64</code> and <code>ARM64</code>.</p>
|
|
@@ -2202,7 +2293,7 @@ export interface RuntimePlatform {
|
|
|
2202
2293
|
* </note>
|
|
2203
2294
|
* @public
|
|
2204
2295
|
*/
|
|
2205
|
-
cpuArchitecture?: string;
|
|
2296
|
+
cpuArchitecture?: string | undefined;
|
|
2206
2297
|
}
|
|
2207
2298
|
/**
|
|
2208
2299
|
* <p>The <code>ulimit</code> settings to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html">Ulimit</a>.</p>
|
|
@@ -2258,7 +2349,7 @@ export interface EFSAuthorizationConfig {
|
|
|
2258
2349
|
* with Amazon EFS access points</a> in the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
2259
2350
|
* @public
|
|
2260
2351
|
*/
|
|
2261
|
-
accessPointId?: string;
|
|
2352
|
+
accessPointId?: string | undefined;
|
|
2262
2353
|
/**
|
|
2263
2354
|
* <p>Whether or not to use the Batch job IAM role defined in a job definition when mounting the
|
|
2264
2355
|
* Amazon EFS file system. If enabled, transit encryption must be enabled in the
|
|
@@ -2269,7 +2360,7 @@ export interface EFSAuthorizationConfig {
|
|
|
2269
2360
|
* specified.</p>
|
|
2270
2361
|
* @public
|
|
2271
2362
|
*/
|
|
2272
|
-
iam?: EFSAuthorizationConfigIAM;
|
|
2363
|
+
iam?: EFSAuthorizationConfigIAM | undefined;
|
|
2273
2364
|
}
|
|
2274
2365
|
/**
|
|
2275
2366
|
* @public
|
|
@@ -2307,7 +2398,7 @@ export interface EFSVolumeConfiguration {
|
|
|
2307
2398
|
* </important>
|
|
2308
2399
|
* @public
|
|
2309
2400
|
*/
|
|
2310
|
-
rootDirectory?: string;
|
|
2401
|
+
rootDirectory?: string | undefined;
|
|
2311
2402
|
/**
|
|
2312
2403
|
* <p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and
|
|
2313
2404
|
* the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If
|
|
@@ -2315,7 +2406,7 @@ export interface EFSVolumeConfiguration {
|
|
|
2315
2406
|
* information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html">Encrypting data in transit</a> in the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
2316
2407
|
* @public
|
|
2317
2408
|
*/
|
|
2318
|
-
transitEncryption?: EFSTransitEncryption;
|
|
2409
|
+
transitEncryption?: EFSTransitEncryption | undefined;
|
|
2319
2410
|
/**
|
|
2320
2411
|
* <p>The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If
|
|
2321
2412
|
* you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS
|
|
@@ -2323,12 +2414,12 @@ export interface EFSVolumeConfiguration {
|
|
|
2323
2414
|
* <i>Amazon Elastic File System User Guide</i>.</p>
|
|
2324
2415
|
* @public
|
|
2325
2416
|
*/
|
|
2326
|
-
transitEncryptionPort?: number;
|
|
2417
|
+
transitEncryptionPort?: number | undefined;
|
|
2327
2418
|
/**
|
|
2328
2419
|
* <p>The authorization configuration details for the Amazon EFS file system.</p>
|
|
2329
2420
|
* @public
|
|
2330
2421
|
*/
|
|
2331
|
-
authorizationConfig?: EFSAuthorizationConfig;
|
|
2422
|
+
authorizationConfig?: EFSAuthorizationConfig | undefined;
|
|
2332
2423
|
}
|
|
2333
2424
|
/**
|
|
2334
2425
|
* <p>Determine whether your data volume persists on the host container instance and where it's
|
|
@@ -2351,7 +2442,7 @@ export interface Host {
|
|
|
2351
2442
|
* </note>
|
|
2352
2443
|
* @public
|
|
2353
2444
|
*/
|
|
2354
|
-
sourcePath?: string;
|
|
2445
|
+
sourcePath?: string | undefined;
|
|
2355
2446
|
}
|
|
2356
2447
|
/**
|
|
2357
2448
|
* <p>A data volume that's used in a job's container properties.</p>
|
|
@@ -2369,21 +2460,21 @@ export interface Volume {
|
|
|
2369
2460
|
* </note>
|
|
2370
2461
|
* @public
|
|
2371
2462
|
*/
|
|
2372
|
-
host?: Host;
|
|
2463
|
+
host?: Host | undefined;
|
|
2373
2464
|
/**
|
|
2374
2465
|
* <p>The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,
|
|
2375
2466
|
* numbers, hyphens (-), and underscores (_). This name is referenced in the
|
|
2376
2467
|
* <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>
|
|
2377
2468
|
* @public
|
|
2378
2469
|
*/
|
|
2379
|
-
name?: string;
|
|
2470
|
+
name?: string | undefined;
|
|
2380
2471
|
/**
|
|
2381
2472
|
* <p>This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs
|
|
2382
2473
|
* that are running on Fargate resources must specify a <code>platformVersion</code> of at least
|
|
2383
2474
|
* <code>1.4.0</code>.</p>
|
|
2384
2475
|
* @public
|
|
2385
2476
|
*/
|
|
2386
|
-
efsVolumeConfiguration?: EFSVolumeConfiguration;
|
|
2477
|
+
efsVolumeConfiguration?: EFSVolumeConfiguration | undefined;
|
|
2387
2478
|
}
|
|
2388
2479
|
/**
|
|
2389
2480
|
* <p>Container properties are used
|
|
@@ -2436,7 +2527,7 @@ export interface ContainerProperties {
|
|
|
2436
2527
|
* </ul>
|
|
2437
2528
|
* @public
|
|
2438
2529
|
*/
|
|
2439
|
-
image?: string;
|
|
2530
|
+
image?: string | undefined;
|
|
2440
2531
|
/**
|
|
2441
2532
|
* @deprecated
|
|
2442
2533
|
*
|
|
@@ -2451,7 +2542,7 @@ export interface ContainerProperties {
|
|
|
2451
2542
|
* least once for each node.</p>
|
|
2452
2543
|
* @public
|
|
2453
2544
|
*/
|
|
2454
|
-
vcpus?: number;
|
|
2545
|
+
vcpus?: number | undefined;
|
|
2455
2546
|
/**
|
|
2456
2547
|
* @deprecated
|
|
2457
2548
|
*
|
|
@@ -2463,7 +2554,7 @@ export interface ContainerProperties {
|
|
|
2463
2554
|
* specified in several places. It must be specified for each node at least once.</p>
|
|
2464
2555
|
* @public
|
|
2465
2556
|
*/
|
|
2466
|
-
memory?: number;
|
|
2557
|
+
memory?: number | undefined;
|
|
2467
2558
|
/**
|
|
2468
2559
|
* <p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in the
|
|
2469
2560
|
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>COMMAND</code>
|
|
@@ -2471,26 +2562,26 @@ export interface ContainerProperties {
|
|
|
2471
2562
|
* <a href="https://docs.docker.com/engine/reference/builder/#cmd">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>
|
|
2472
2563
|
* @public
|
|
2473
2564
|
*/
|
|
2474
|
-
command?: string[];
|
|
2565
|
+
command?: string[] | undefined;
|
|
2475
2566
|
/**
|
|
2476
2567
|
* <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more
|
|
2477
2568
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the
|
|
2478
2569
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2479
2570
|
* @public
|
|
2480
2571
|
*/
|
|
2481
|
-
jobRoleArn?: string;
|
|
2572
|
+
jobRoleArn?: string | undefined;
|
|
2482
2573
|
/**
|
|
2483
2574
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate
|
|
2484
2575
|
* resources, you must provide an execution role. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a>
|
|
2485
2576
|
* in the <i>Batch User Guide</i>.</p>
|
|
2486
2577
|
* @public
|
|
2487
2578
|
*/
|
|
2488
|
-
executionRoleArn?: string;
|
|
2579
|
+
executionRoleArn?: string | undefined;
|
|
2489
2580
|
/**
|
|
2490
2581
|
* <p>A list of data volumes used in a job.</p>
|
|
2491
2582
|
* @public
|
|
2492
2583
|
*/
|
|
2493
|
-
volumes?: Volume[];
|
|
2584
|
+
volumes?: Volume[] | undefined;
|
|
2494
2585
|
/**
|
|
2495
2586
|
* <p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in
|
|
2496
2587
|
* the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
|
|
@@ -2505,7 +2596,7 @@ export interface ContainerProperties {
|
|
|
2505
2596
|
* </note>
|
|
2506
2597
|
* @public
|
|
2507
2598
|
*/
|
|
2508
|
-
environment?: KeyValuePair[];
|
|
2599
|
+
environment?: KeyValuePair[] | undefined;
|
|
2509
2600
|
/**
|
|
2510
2601
|
* <p>The mount points for data volumes in your container. This parameter maps to
|
|
2511
2602
|
* <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
|
|
@@ -2513,7 +2604,7 @@ export interface ContainerProperties {
|
|
|
2513
2604
|
* run</a>.</p>
|
|
2514
2605
|
* @public
|
|
2515
2606
|
*/
|
|
2516
|
-
mountPoints?: MountPoint[];
|
|
2607
|
+
mountPoints?: MountPoint[] | undefined;
|
|
2517
2608
|
/**
|
|
2518
2609
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
2519
2610
|
* system. This parameter maps to <code>ReadonlyRootfs</code> in the
|
|
@@ -2521,7 +2612,7 @@ export interface ContainerProperties {
|
|
|
2521
2612
|
* <code>--read-only</code> option to <code>docker run</code>.</p>
|
|
2522
2613
|
* @public
|
|
2523
2614
|
*/
|
|
2524
|
-
readonlyRootFilesystem?: boolean;
|
|
2615
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
2525
2616
|
/**
|
|
2526
2617
|
* <p>When this parameter is true, the container is given elevated permissions on the host
|
|
2527
2618
|
* container instance (similar to the <code>root</code> user). This parameter maps to
|
|
@@ -2533,7 +2624,7 @@ export interface ContainerProperties {
|
|
|
2533
2624
|
* </note>
|
|
2534
2625
|
* @public
|
|
2535
2626
|
*/
|
|
2536
|
-
privileged?: boolean;
|
|
2627
|
+
privileged?: boolean | undefined;
|
|
2537
2628
|
/**
|
|
2538
2629
|
* <p>A list of <code>ulimits</code> to set in the container. This parameter maps to
|
|
2539
2630
|
* <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
|
|
@@ -2545,14 +2636,14 @@ export interface ContainerProperties {
|
|
|
2545
2636
|
* </note>
|
|
2546
2637
|
* @public
|
|
2547
2638
|
*/
|
|
2548
|
-
ulimits?: Ulimit[];
|
|
2639
|
+
ulimits?: Ulimit[] | undefined;
|
|
2549
2640
|
/**
|
|
2550
2641
|
* <p>The user name to use inside the container. This parameter maps to <code>User</code> in the
|
|
2551
2642
|
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--user</code>
|
|
2552
2643
|
* option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
2553
2644
|
* @public
|
|
2554
2645
|
*/
|
|
2555
|
-
user?: string;
|
|
2646
|
+
user?: string | undefined;
|
|
2556
2647
|
/**
|
|
2557
2648
|
* <p>The instance type to use for a multi-node parallel job. All node groups in a multi-node
|
|
2558
2649
|
* parallel job must use the same instance type.</p>
|
|
@@ -2562,19 +2653,19 @@ export interface ContainerProperties {
|
|
|
2562
2653
|
* </note>
|
|
2563
2654
|
* @public
|
|
2564
2655
|
*/
|
|
2565
|
-
instanceType?: string;
|
|
2656
|
+
instanceType?: string | undefined;
|
|
2566
2657
|
/**
|
|
2567
2658
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
2568
2659
|
* <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
2569
2660
|
* @public
|
|
2570
2661
|
*/
|
|
2571
|
-
resourceRequirements?: ResourceRequirement[];
|
|
2662
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
2572
2663
|
/**
|
|
2573
2664
|
* <p>Linux-specific modifications that are applied to the container, such as details for device
|
|
2574
2665
|
* mappings.</p>
|
|
2575
2666
|
* @public
|
|
2576
2667
|
*/
|
|
2577
|
-
linuxParameters?: LinuxParameters;
|
|
2668
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
2578
2669
|
/**
|
|
2579
2670
|
* <p>The log configuration specification for the container.</p>
|
|
2580
2671
|
* <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
|
|
@@ -2602,43 +2693,43 @@ export interface ContainerProperties {
|
|
|
2602
2693
|
* </note>
|
|
2603
2694
|
* @public
|
|
2604
2695
|
*/
|
|
2605
|
-
logConfiguration?: LogConfiguration;
|
|
2696
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
2606
2697
|
/**
|
|
2607
2698
|
* <p>The secrets for the container. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying sensitive data</a> in the
|
|
2608
2699
|
* <i>Batch User Guide</i>.</p>
|
|
2609
2700
|
* @public
|
|
2610
2701
|
*/
|
|
2611
|
-
secrets?: Secret[];
|
|
2702
|
+
secrets?: Secret[] | undefined;
|
|
2612
2703
|
/**
|
|
2613
2704
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2614
2705
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2615
2706
|
* @public
|
|
2616
2707
|
*/
|
|
2617
|
-
networkConfiguration?: NetworkConfiguration;
|
|
2708
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
2618
2709
|
/**
|
|
2619
2710
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2620
2711
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2621
2712
|
* @public
|
|
2622
2713
|
*/
|
|
2623
|
-
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
2714
|
+
fargatePlatformConfiguration?: FargatePlatformConfiguration | undefined;
|
|
2624
2715
|
/**
|
|
2625
2716
|
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
|
|
2626
2717
|
* the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
|
|
2627
2718
|
* Fargate.</p>
|
|
2628
2719
|
* @public
|
|
2629
2720
|
*/
|
|
2630
|
-
ephemeralStorage?: EphemeralStorage;
|
|
2721
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
2631
2722
|
/**
|
|
2632
2723
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
2633
2724
|
* Fargate.</p>
|
|
2634
2725
|
* @public
|
|
2635
2726
|
*/
|
|
2636
|
-
runtimePlatform?: RuntimePlatform;
|
|
2727
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
2637
2728
|
/**
|
|
2638
2729
|
* <p>The private repository authentication credentials to use.</p>
|
|
2639
2730
|
* @public
|
|
2640
2731
|
*/
|
|
2641
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
2732
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
2642
2733
|
}
|
|
2643
2734
|
/**
|
|
2644
2735
|
* <p>A list of containers that this task depends on.</p>
|
|
@@ -2649,7 +2740,7 @@ export interface TaskContainerDependency {
|
|
|
2649
2740
|
* <p>A unique identifier for the container.</p>
|
|
2650
2741
|
* @public
|
|
2651
2742
|
*/
|
|
2652
|
-
containerName?: string;
|
|
2743
|
+
containerName?: string | undefined;
|
|
2653
2744
|
/**
|
|
2654
2745
|
* <p>The dependency condition of the container. The following are the available conditions and
|
|
2655
2746
|
* their behavior:</p>
|
|
@@ -2676,7 +2767,7 @@ export interface TaskContainerDependency {
|
|
|
2676
2767
|
* </ul>
|
|
2677
2768
|
* @public
|
|
2678
2769
|
*/
|
|
2679
|
-
condition?: string;
|
|
2770
|
+
condition?: string | undefined;
|
|
2680
2771
|
}
|
|
2681
2772
|
/**
|
|
2682
2773
|
* <p>Container properties are used for Amazon ECS-based job definitions. These properties to describe
|
|
@@ -2693,12 +2784,12 @@ export interface TaskContainerProperties {
|
|
|
2693
2784
|
* CMD</a>.</p>
|
|
2694
2785
|
* @public
|
|
2695
2786
|
*/
|
|
2696
|
-
command?: string[];
|
|
2787
|
+
command?: string[] | undefined;
|
|
2697
2788
|
/**
|
|
2698
2789
|
* <p>A list of containers that this container depends on.</p>
|
|
2699
2790
|
* @public
|
|
2700
2791
|
*/
|
|
2701
|
-
dependsOn?: TaskContainerDependency[];
|
|
2792
|
+
dependsOn?: TaskContainerDependency[] | undefined;
|
|
2702
2793
|
/**
|
|
2703
2794
|
* <p>The environment variables to pass to a container. This parameter maps to Env inthe <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
|
|
2704
2795
|
* section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
|
|
@@ -2713,7 +2804,7 @@ export interface TaskContainerProperties {
|
|
|
2713
2804
|
* </note>
|
|
2714
2805
|
* @public
|
|
2715
2806
|
*/
|
|
2716
|
-
environment?: KeyValuePair[];
|
|
2807
|
+
environment?: KeyValuePair[] | undefined;
|
|
2717
2808
|
/**
|
|
2718
2809
|
* <p>If the essential parameter of a container is marked as <code>true</code>, and that container
|
|
2719
2810
|
* fails or stops for any reason, all other containers that are part of the task are stopped. If the
|
|
@@ -2727,7 +2818,7 @@ export interface TaskContainerProperties {
|
|
|
2727
2818
|
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2728
2819
|
* @public
|
|
2729
2820
|
*/
|
|
2730
|
-
essential?: boolean;
|
|
2821
|
+
essential?: boolean | undefined;
|
|
2731
2822
|
/**
|
|
2732
2823
|
* <p>The image used to start a container. This string is passed directly to the Docker daemon. By
|
|
2733
2824
|
* default, images in the Docker Hub registry are available. Other repositories are specified with
|
|
@@ -2747,7 +2838,7 @@ export interface TaskContainerProperties {
|
|
|
2747
2838
|
* capabilities. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
|
|
2748
2839
|
* @public
|
|
2749
2840
|
*/
|
|
2750
|
-
linuxParameters?: LinuxParameters;
|
|
2841
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
2751
2842
|
/**
|
|
2752
2843
|
* <p>The log configuration specification for the container.</p>
|
|
2753
2844
|
* <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
@@ -2780,7 +2871,7 @@ export interface TaskContainerProperties {
|
|
|
2780
2871
|
* </note>
|
|
2781
2872
|
* @public
|
|
2782
2873
|
*/
|
|
2783
|
-
logConfiguration?: LogConfiguration;
|
|
2874
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
2784
2875
|
/**
|
|
2785
2876
|
* <p>The mount points for data volumes in your container.</p>
|
|
2786
2877
|
* <p>This parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
@@ -2792,13 +2883,13 @@ export interface TaskContainerProperties {
|
|
|
2792
2883
|
* and mount point can't be across drives.</p>
|
|
2793
2884
|
* @public
|
|
2794
2885
|
*/
|
|
2795
|
-
mountPoints?: MountPoint[];
|
|
2886
|
+
mountPoints?: MountPoint[] | undefined;
|
|
2796
2887
|
/**
|
|
2797
2888
|
* <p>The name of a container. The name can be used as a unique identifier to target your
|
|
2798
2889
|
* <code>dependsOn</code> and <code>Overrides</code> objects. </p>
|
|
2799
2890
|
* @public
|
|
2800
2891
|
*/
|
|
2801
|
-
name?: string;
|
|
2892
|
+
name?: string | undefined;
|
|
2802
2893
|
/**
|
|
2803
2894
|
* <p>When this parameter is <code>true</code>, the container is given elevated privileges on the
|
|
2804
2895
|
* host container instance (similar to the <code>root</code> user). This parameter maps to
|
|
@@ -2811,7 +2902,7 @@ export interface TaskContainerProperties {
|
|
|
2811
2902
|
* </note>
|
|
2812
2903
|
* @public
|
|
2813
2904
|
*/
|
|
2814
|
-
privileged?: boolean;
|
|
2905
|
+
privileged?: boolean | undefined;
|
|
2815
2906
|
/**
|
|
2816
2907
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
2817
2908
|
* system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
@@ -2823,24 +2914,24 @@ export interface TaskContainerProperties {
|
|
|
2823
2914
|
* </note>
|
|
2824
2915
|
* @public
|
|
2825
2916
|
*/
|
|
2826
|
-
readonlyRootFilesystem?: boolean;
|
|
2917
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
2827
2918
|
/**
|
|
2828
2919
|
* <p>The private repository authentication credentials to use.</p>
|
|
2829
2920
|
* @public
|
|
2830
2921
|
*/
|
|
2831
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
2922
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
2832
2923
|
/**
|
|
2833
2924
|
* <p>The type and amount of a resource to assign to a container. The only supported resource is a
|
|
2834
2925
|
* GPU.</p>
|
|
2835
2926
|
* @public
|
|
2836
2927
|
*/
|
|
2837
|
-
resourceRequirements?: ResourceRequirement[];
|
|
2928
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
2838
2929
|
/**
|
|
2839
2930
|
* <p>The secrets to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html">Specifying Sensitive
|
|
2840
2931
|
* Data</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
2841
2932
|
* @public
|
|
2842
2933
|
*/
|
|
2843
|
-
secrets?: Secret[];
|
|
2934
|
+
secrets?: Secret[] | undefined;
|
|
2844
2935
|
/**
|
|
2845
2936
|
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value is
|
|
2846
2937
|
* specified in a task definition, it overrides the default values set by Docker. This parameter
|
|
@@ -2863,7 +2954,7 @@ export interface TaskContainerProperties {
|
|
|
2863
2954
|
* </note>
|
|
2864
2955
|
* @public
|
|
2865
2956
|
*/
|
|
2866
|
-
ulimits?: Ulimit[];
|
|
2957
|
+
ulimits?: Ulimit[] | undefined;
|
|
2867
2958
|
/**
|
|
2868
2959
|
* <p>The user to use inside the container. This parameter maps to User in the Create a container
|
|
2869
2960
|
* section of the Docker Remote API and the --user option to docker run.</p>
|
|
@@ -2910,7 +3001,7 @@ export interface TaskContainerProperties {
|
|
|
2910
3001
|
* </note>
|
|
2911
3002
|
* @public
|
|
2912
3003
|
*/
|
|
2913
|
-
user?: string;
|
|
3004
|
+
user?: string | undefined;
|
|
2914
3005
|
}
|
|
2915
3006
|
/**
|
|
2916
3007
|
* <p>The properties for a task definition that describes the container and volume definitions of
|
|
@@ -2930,14 +3021,14 @@ export interface EcsTaskProperties {
|
|
|
2930
3021
|
* Fargate.</p>
|
|
2931
3022
|
* @public
|
|
2932
3023
|
*/
|
|
2933
|
-
ephemeralStorage?: EphemeralStorage;
|
|
3024
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
2934
3025
|
/**
|
|
2935
3026
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate
|
|
2936
3027
|
* resources, you must provide an execution role. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a>
|
|
2937
3028
|
* in the <i>Batch User Guide</i>.</p>
|
|
2938
3029
|
* @public
|
|
2939
3030
|
*/
|
|
2940
|
-
executionRoleArn?: string;
|
|
3031
|
+
executionRoleArn?: string | undefined;
|
|
2941
3032
|
/**
|
|
2942
3033
|
* <p>The Fargate platform version where the jobs are running. A platform version is specified
|
|
2943
3034
|
* only for jobs that are running on Fargate resources. If one isn't specified, the
|
|
@@ -2946,7 +3037,7 @@ export interface EcsTaskProperties {
|
|
|
2946
3037
|
* platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2947
3038
|
* @public
|
|
2948
3039
|
*/
|
|
2949
|
-
platformVersion?: string;
|
|
3040
|
+
platformVersion?: string | undefined;
|
|
2950
3041
|
/**
|
|
2951
3042
|
* <p>The IPC resource namespace to use for the containers in the task. The valid values are
|
|
2952
3043
|
* <code>host</code>, <code>task</code>, or <code>none</code>.</p>
|
|
@@ -2962,7 +3053,7 @@ export interface EcsTaskProperties {
|
|
|
2962
3053
|
* the Docker run reference.</p>
|
|
2963
3054
|
* @public
|
|
2964
3055
|
*/
|
|
2965
|
-
ipcMode?: string;
|
|
3056
|
+
ipcMode?: string | undefined;
|
|
2966
3057
|
/**
|
|
2967
3058
|
* <p>The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.</p>
|
|
2968
3059
|
* <note>
|
|
@@ -2970,7 +3061,7 @@ export interface EcsTaskProperties {
|
|
|
2970
3061
|
* </note>
|
|
2971
3062
|
* @public
|
|
2972
3063
|
*/
|
|
2973
|
-
taskRoleArn?: string;
|
|
3064
|
+
taskRoleArn?: string | undefined;
|
|
2974
3065
|
/**
|
|
2975
3066
|
* <p>The process namespace to use for the containers in the task. The valid values are
|
|
2976
3067
|
* <code>host</code> or <code>task</code>. For example, monitoring sidecars might need
|
|
@@ -2985,24 +3076,24 @@ export interface EcsTaskProperties {
|
|
|
2985
3076
|
* information, see <a href="https://docs.docker.com/engine/reference/run/#pid-settings---pid">PID settings</a> in the Docker run reference.</p>
|
|
2986
3077
|
* @public
|
|
2987
3078
|
*/
|
|
2988
|
-
pidMode?: string;
|
|
3079
|
+
pidMode?: string | undefined;
|
|
2989
3080
|
/**
|
|
2990
3081
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2991
3082
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2992
3083
|
* @public
|
|
2993
3084
|
*/
|
|
2994
|
-
networkConfiguration?: NetworkConfiguration;
|
|
3085
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
2995
3086
|
/**
|
|
2996
3087
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
2997
3088
|
* Fargate.</p>
|
|
2998
3089
|
* @public
|
|
2999
3090
|
*/
|
|
3000
|
-
runtimePlatform?: RuntimePlatform;
|
|
3091
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
3001
3092
|
/**
|
|
3002
3093
|
* <p>A list of volumes that are associated with the job.</p>
|
|
3003
3094
|
* @public
|
|
3004
3095
|
*/
|
|
3005
|
-
volumes?: Volume[];
|
|
3096
|
+
volumes?: Volume[] | undefined;
|
|
3006
3097
|
}
|
|
3007
3098
|
/**
|
|
3008
3099
|
* <p>An object that contains the properties for the Amazon ECS resources of a job.</p>
|
|
@@ -3032,7 +3123,7 @@ export interface EksContainerEnvironmentVariable {
|
|
|
3032
3123
|
* <p>The value of the environment variable.</p>
|
|
3033
3124
|
* @public
|
|
3034
3125
|
*/
|
|
3035
|
-
value?: string;
|
|
3126
|
+
value?: string | undefined;
|
|
3036
3127
|
}
|
|
3037
3128
|
/**
|
|
3038
3129
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
@@ -3080,7 +3171,7 @@ export interface EksContainerResourceRequirements {
|
|
|
3080
3171
|
* </dl>
|
|
3081
3172
|
* @public
|
|
3082
3173
|
*/
|
|
3083
|
-
limits?: Record<string, string
|
|
3174
|
+
limits?: Record<string, string> | undefined;
|
|
3084
3175
|
/**
|
|
3085
3176
|
* <p>The type and quantity of the resources to request for the container. The values vary based
|
|
3086
3177
|
* on the <code>name</code> that's specified. Resources can be requested by using either the
|
|
@@ -3119,7 +3210,7 @@ export interface EksContainerResourceRequirements {
|
|
|
3119
3210
|
* </dl>
|
|
3120
3211
|
* @public
|
|
3121
3212
|
*/
|
|
3122
|
-
requests?: Record<string, string
|
|
3213
|
+
requests?: Record<string, string> | undefined;
|
|
3123
3214
|
}
|
|
3124
3215
|
/**
|
|
3125
3216
|
* <p>The security context for a job. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">Configure a
|
|
@@ -3137,7 +3228,7 @@ export interface EksContainerSecurityContext {
|
|
|
3137
3228
|
* documentation</i>.</p>
|
|
3138
3229
|
* @public
|
|
3139
3230
|
*/
|
|
3140
|
-
runAsUser?: number;
|
|
3231
|
+
runAsUser?: number | undefined;
|
|
3141
3232
|
/**
|
|
3142
3233
|
* <p>When this parameter is specified, the container is run as the specified group ID
|
|
3143
3234
|
* (<code>gid</code>). If this parameter isn't specified, the default is the group that's specified
|
|
@@ -3147,7 +3238,7 @@ export interface EksContainerSecurityContext {
|
|
|
3147
3238
|
* documentation</i>.</p>
|
|
3148
3239
|
* @public
|
|
3149
3240
|
*/
|
|
3150
|
-
runAsGroup?: number;
|
|
3241
|
+
runAsGroup?: number | undefined;
|
|
3151
3242
|
/**
|
|
3152
3243
|
* <p>When this parameter is <code>true</code>, the container is given elevated permissions on the
|
|
3153
3244
|
* host container instance. The level of permissions are similar to the <code>root</code> user
|
|
@@ -3156,13 +3247,13 @@ export interface EksContainerSecurityContext {
|
|
|
3156
3247
|
* pod security policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3157
3248
|
* @public
|
|
3158
3249
|
*/
|
|
3159
|
-
privileged?: boolean;
|
|
3250
|
+
privileged?: boolean | undefined;
|
|
3160
3251
|
/**
|
|
3161
3252
|
* <p>Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent
|
|
3162
3253
|
* process. The default value is <code>false</code>.</p>
|
|
3163
3254
|
* @public
|
|
3164
3255
|
*/
|
|
3165
|
-
allowPrivilegeEscalation?: boolean;
|
|
3256
|
+
allowPrivilegeEscalation?: boolean | undefined;
|
|
3166
3257
|
/**
|
|
3167
3258
|
* <p>When this parameter is <code>true</code>, the container is given read-only access to its
|
|
3168
3259
|
* root file system. The default value is <code>false</code>. This parameter maps to
|
|
@@ -3170,7 +3261,7 @@ export interface EksContainerSecurityContext {
|
|
|
3170
3261
|
* documentation</i>.</p>
|
|
3171
3262
|
* @public
|
|
3172
3263
|
*/
|
|
3173
|
-
readOnlyRootFilesystem?: boolean;
|
|
3264
|
+
readOnlyRootFilesystem?: boolean | undefined;
|
|
3174
3265
|
/**
|
|
3175
3266
|
* <p>When this parameter is specified, the container is run as a user with a <code>uid</code>
|
|
3176
3267
|
* other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to
|
|
@@ -3179,7 +3270,7 @@ export interface EksContainerSecurityContext {
|
|
|
3179
3270
|
* documentation</i>.</p>
|
|
3180
3271
|
* @public
|
|
3181
3272
|
*/
|
|
3182
|
-
runAsNonRoot?: boolean;
|
|
3273
|
+
runAsNonRoot?: boolean | undefined;
|
|
3183
3274
|
}
|
|
3184
3275
|
/**
|
|
3185
3276
|
* <p>The volume mounts for a container for an Amazon EKS job. For more information about volumes and
|
|
@@ -3192,18 +3283,18 @@ export interface EksContainerVolumeMount {
|
|
|
3192
3283
|
* pod.</p>
|
|
3193
3284
|
* @public
|
|
3194
3285
|
*/
|
|
3195
|
-
name?: string;
|
|
3286
|
+
name?: string | undefined;
|
|
3196
3287
|
/**
|
|
3197
3288
|
* <p>The path on the container where the volume is mounted.</p>
|
|
3198
3289
|
* @public
|
|
3199
3290
|
*/
|
|
3200
|
-
mountPath?: string;
|
|
3291
|
+
mountPath?: string | undefined;
|
|
3201
3292
|
/**
|
|
3202
3293
|
* <p>If this value is <code>true</code>, the container has read-only access to the volume.
|
|
3203
3294
|
* Otherwise, the container can write to the volume. The default value is <code>false</code>.</p>
|
|
3204
3295
|
* @public
|
|
3205
3296
|
*/
|
|
3206
|
-
readOnly?: boolean;
|
|
3297
|
+
readOnly?: boolean | undefined;
|
|
3207
3298
|
}
|
|
3208
3299
|
/**
|
|
3209
3300
|
* <p>EKS container properties are used in job definitions for Amazon EKS based job definitions to
|
|
@@ -3217,7 +3308,7 @@ export interface EksContainer {
|
|
|
3217
3308
|
* "<code>Default</code>" is used. Each container in a pod must have a unique name.</p>
|
|
3218
3309
|
* @public
|
|
3219
3310
|
*/
|
|
3220
|
-
name?: string;
|
|
3311
|
+
name?: string | undefined;
|
|
3221
3312
|
/**
|
|
3222
3313
|
* <p>The Docker image used to start the container.</p>
|
|
3223
3314
|
* @public
|
|
@@ -3231,7 +3322,7 @@ export interface EksContainer {
|
|
|
3231
3322
|
* images</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3232
3323
|
* @public
|
|
3233
3324
|
*/
|
|
3234
|
-
imagePullPolicy?: string;
|
|
3325
|
+
imagePullPolicy?: string | undefined;
|
|
3235
3326
|
/**
|
|
3236
3327
|
* <p>The entrypoint for the container. This isn't run within a shell. If this isn't specified,
|
|
3237
3328
|
* the <code>ENTRYPOINT</code> of the container image is used. Environment variable references are
|
|
@@ -3245,7 +3336,7 @@ export interface EksContainer {
|
|
|
3245
3336
|
* information, see <a href="https://docs.docker.com/engine/reference/builder/#entrypoint">ENTRYPOINT</a> in the <i>Dockerfile reference</i> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command and arguments for a container</a> and <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3246
3337
|
* @public
|
|
3247
3338
|
*/
|
|
3248
|
-
command?: string[];
|
|
3339
|
+
command?: string[] | undefined;
|
|
3249
3340
|
/**
|
|
3250
3341
|
* <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of
|
|
3251
3342
|
* the container image is used. This corresponds to the <code>args</code> member in the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> portion of the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/">Pod</a>
|
|
@@ -3260,7 +3351,7 @@ export interface EksContainer {
|
|
|
3260
3351
|
* documentation</i>.</p>
|
|
3261
3352
|
* @public
|
|
3262
3353
|
*/
|
|
3263
|
-
args?: string[];
|
|
3354
|
+
args?: string[] | undefined;
|
|
3264
3355
|
/**
|
|
3265
3356
|
* <p>The environment variables to pass to a container.</p>
|
|
3266
3357
|
* <note>
|
|
@@ -3269,7 +3360,7 @@ export interface EksContainer {
|
|
|
3269
3360
|
* </note>
|
|
3270
3361
|
* @public
|
|
3271
3362
|
*/
|
|
3272
|
-
env?: EksContainerEnvironmentVariable[];
|
|
3363
|
+
env?: EksContainerEnvironmentVariable[] | undefined;
|
|
3273
3364
|
/**
|
|
3274
3365
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
3275
3366
|
* <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information,
|
|
@@ -3277,21 +3368,21 @@ export interface EksContainer {
|
|
|
3277
3368
|
* documentation</i>.</p>
|
|
3278
3369
|
* @public
|
|
3279
3370
|
*/
|
|
3280
|
-
resources?: EksContainerResourceRequirements;
|
|
3371
|
+
resources?: EksContainerResourceRequirements | undefined;
|
|
3281
3372
|
/**
|
|
3282
3373
|
* <p>The volume mounts for the container. Batch supports <code>emptyDir</code>,
|
|
3283
3374
|
* <code>hostPath</code>, and <code>secret</code> volume types. For more information about volumes
|
|
3284
3375
|
* and volume mounts in Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3285
3376
|
* @public
|
|
3286
3377
|
*/
|
|
3287
|
-
volumeMounts?: EksContainerVolumeMount[];
|
|
3378
|
+
volumeMounts?: EksContainerVolumeMount[] | undefined;
|
|
3288
3379
|
/**
|
|
3289
3380
|
* <p>The security context for a job. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">Configure a
|
|
3290
3381
|
* security context for a pod or container</a> in the <i>Kubernetes
|
|
3291
3382
|
* documentation</i>.</p>
|
|
3292
3383
|
* @public
|
|
3293
3384
|
*/
|
|
3294
|
-
securityContext?: EksContainerSecurityContext;
|
|
3385
|
+
securityContext?: EksContainerSecurityContext | undefined;
|
|
3295
3386
|
}
|
|
3296
3387
|
/**
|
|
3297
3388
|
* <p>References a Kubernetes secret resource. This name of the secret must start and end with an
|
|
@@ -3321,7 +3412,7 @@ export interface EksMetadata {
|
|
|
3321
3412
|
* unique for a given object.</p>
|
|
3322
3413
|
* @public
|
|
3323
3414
|
*/
|
|
3324
|
-
labels?: Record<string, string
|
|
3415
|
+
labels?: Record<string, string> | undefined;
|
|
3325
3416
|
}
|
|
3326
3417
|
/**
|
|
3327
3418
|
* <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. An
|
|
@@ -3353,12 +3444,12 @@ export interface EksEmptyDir {
|
|
|
3353
3444
|
* </dl>
|
|
3354
3445
|
* @public
|
|
3355
3446
|
*/
|
|
3356
|
-
medium?: string;
|
|
3447
|
+
medium?: string | undefined;
|
|
3357
3448
|
/**
|
|
3358
3449
|
* <p>The maximum size of the volume. By default, there's no maximum size defined.</p>
|
|
3359
3450
|
* @public
|
|
3360
3451
|
*/
|
|
3361
|
-
sizeLimit?: string;
|
|
3452
|
+
sizeLimit?: string | undefined;
|
|
3362
3453
|
}
|
|
3363
3454
|
/**
|
|
3364
3455
|
* <p>Specifies the configuration of a Kubernetes <code>hostPath</code> volume. A <code>hostPath</code>
|
|
@@ -3371,7 +3462,7 @@ export interface EksHostPath {
|
|
|
3371
3462
|
* <p>The path of the file or directory on the host to mount into containers on the pod.</p>
|
|
3372
3463
|
* @public
|
|
3373
3464
|
*/
|
|
3374
|
-
path?: string;
|
|
3465
|
+
path?: string | undefined;
|
|
3375
3466
|
}
|
|
3376
3467
|
/**
|
|
3377
3468
|
* <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see
|
|
@@ -3390,7 +3481,7 @@ export interface EksSecret {
|
|
|
3390
3481
|
* <p>Specifies whether the secret or the secret's keys must be defined.</p>
|
|
3391
3482
|
* @public
|
|
3392
3483
|
*/
|
|
3393
|
-
optional?: boolean;
|
|
3484
|
+
optional?: boolean | undefined;
|
|
3394
3485
|
}
|
|
3395
3486
|
/**
|
|
3396
3487
|
* <p>Specifies an Amazon EKS volume for a job definition.</p>
|
|
@@ -3409,21 +3500,21 @@ export interface EksVolume {
|
|
|
3409
3500
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
3410
3501
|
* @public
|
|
3411
3502
|
*/
|
|
3412
|
-
hostPath?: EksHostPath;
|
|
3503
|
+
hostPath?: EksHostPath | undefined;
|
|
3413
3504
|
/**
|
|
3414
3505
|
* <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. For more information,
|
|
3415
3506
|
* see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#emptydir">emptyDir</a>
|
|
3416
3507
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
3417
3508
|
* @public
|
|
3418
3509
|
*/
|
|
3419
|
-
emptyDir?: EksEmptyDir;
|
|
3510
|
+
emptyDir?: EksEmptyDir | undefined;
|
|
3420
3511
|
/**
|
|
3421
3512
|
* <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see
|
|
3422
3513
|
* <a href="https://kubernetes.io/docs/concepts/storage/volumes/#secret">secret</a> in the
|
|
3423
3514
|
* <i>Kubernetes documentation</i>.</p>
|
|
3424
3515
|
* @public
|
|
3425
3516
|
*/
|
|
3426
|
-
secret?: EksSecret;
|
|
3517
|
+
secret?: EksSecret | undefined;
|
|
3427
3518
|
}
|
|
3428
3519
|
/**
|
|
3429
3520
|
* <p>The properties for the pod.</p>
|
|
@@ -3438,7 +3529,7 @@ export interface EksPodProperties {
|
|
|
3438
3529
|
* documentation</i>.</p>
|
|
3439
3530
|
* @public
|
|
3440
3531
|
*/
|
|
3441
|
-
serviceAccountName?: string;
|
|
3532
|
+
serviceAccountName?: string | undefined;
|
|
3442
3533
|
/**
|
|
3443
3534
|
* <p>Indicates if the pod uses the hosts' network IP address. The default value is
|
|
3444
3535
|
* <code>true</code>. Setting this to <code>false</code> enables the Kubernetes pod networking model.
|
|
@@ -3448,7 +3539,7 @@ export interface EksPodProperties {
|
|
|
3448
3539
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
3449
3540
|
* @public
|
|
3450
3541
|
*/
|
|
3451
|
-
hostNetwork?: boolean;
|
|
3542
|
+
hostNetwork?: boolean | undefined;
|
|
3452
3543
|
/**
|
|
3453
3544
|
* <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the
|
|
3454
3545
|
* <code>hostNetwork</code> parameter is not specified, the default is
|
|
@@ -3460,7 +3551,7 @@ export interface EksPodProperties {
|
|
|
3460
3551
|
* </p>
|
|
3461
3552
|
* @public
|
|
3462
3553
|
*/
|
|
3463
|
-
dnsPolicy?: string;
|
|
3554
|
+
dnsPolicy?: string | undefined;
|
|
3464
3555
|
/**
|
|
3465
3556
|
* <p>References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain
|
|
3466
3557
|
* access to pull an images from a private registry.</p>
|
|
@@ -3468,7 +3559,7 @@ export interface EksPodProperties {
|
|
|
3468
3559
|
* <code>ImagePullSecret$name</code> is required when this object is used.</p>
|
|
3469
3560
|
* @public
|
|
3470
3561
|
*/
|
|
3471
|
-
imagePullSecrets?: ImagePullSecret[];
|
|
3562
|
+
imagePullSecrets?: ImagePullSecret[] | undefined;
|
|
3472
3563
|
/**
|
|
3473
3564
|
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
3474
3565
|
* <note>
|
|
@@ -3476,7 +3567,7 @@ export interface EksPodProperties {
|
|
|
3476
3567
|
* </note>
|
|
3477
3568
|
* @public
|
|
3478
3569
|
*/
|
|
3479
|
-
containers?: EksContainer[];
|
|
3570
|
+
containers?: EksContainer[] | undefined;
|
|
3480
3571
|
/**
|
|
3481
3572
|
* <p>These containers run before application containers, always runs to completion, and must
|
|
3482
3573
|
* complete successfully before the next container starts. These containers are registered with the
|
|
@@ -3488,12 +3579,12 @@ export interface EksPodProperties {
|
|
|
3488
3579
|
* </note>
|
|
3489
3580
|
* @public
|
|
3490
3581
|
*/
|
|
3491
|
-
initContainers?: EksContainer[];
|
|
3582
|
+
initContainers?: EksContainer[] | undefined;
|
|
3492
3583
|
/**
|
|
3493
3584
|
* <p>Specifies the volumes for a job definition that uses Amazon EKS resources.</p>
|
|
3494
3585
|
* @public
|
|
3495
3586
|
*/
|
|
3496
|
-
volumes?: EksVolume[];
|
|
3587
|
+
volumes?: EksVolume[] | undefined;
|
|
3497
3588
|
/**
|
|
3498
3589
|
* <p>Metadata about the
|
|
3499
3590
|
* Kubernetes
|
|
@@ -3502,14 +3593,14 @@ export interface EksPodProperties {
|
|
|
3502
3593
|
* documentation</i>.</p>
|
|
3503
3594
|
* @public
|
|
3504
3595
|
*/
|
|
3505
|
-
metadata?: EksMetadata;
|
|
3596
|
+
metadata?: EksMetadata | undefined;
|
|
3506
3597
|
/**
|
|
3507
3598
|
* <p>Indicates if the processes in a container are shared, or visible, to other containers in the
|
|
3508
3599
|
* same pod. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/">Share
|
|
3509
3600
|
* Process Namespace between Containers in a Pod</a>.</p>
|
|
3510
3601
|
* @public
|
|
3511
3602
|
*/
|
|
3512
|
-
shareProcessNamespace?: boolean;
|
|
3603
|
+
shareProcessNamespace?: boolean | undefined;
|
|
3513
3604
|
}
|
|
3514
3605
|
/**
|
|
3515
3606
|
* <p>An object that contains the properties for the Kubernetes resources of a job.</p>
|
|
@@ -3520,7 +3611,7 @@ export interface EksProperties {
|
|
|
3520
3611
|
* <p>The properties for the Kubernetes pod resources of a job.</p>
|
|
3521
3612
|
* @public
|
|
3522
3613
|
*/
|
|
3523
|
-
podProperties?: EksPodProperties;
|
|
3614
|
+
podProperties?: EksPodProperties | undefined;
|
|
3524
3615
|
}
|
|
3525
3616
|
/**
|
|
3526
3617
|
* <p>This is an object that represents the properties of the node range for a multi-node parallel
|
|
@@ -3543,7 +3634,7 @@ export interface NodeRangeProperty {
|
|
|
3543
3634
|
* <p>The container details for the node range.</p>
|
|
3544
3635
|
* @public
|
|
3545
3636
|
*/
|
|
3546
|
-
container?: ContainerProperties;
|
|
3637
|
+
container?: ContainerProperties | undefined;
|
|
3547
3638
|
/**
|
|
3548
3639
|
* <p>The instance types of the underlying host infrastructure of a multi-node parallel
|
|
3549
3640
|
* job.</p>
|
|
@@ -3553,18 +3644,18 @@ export interface NodeRangeProperty {
|
|
|
3553
3644
|
* </note>
|
|
3554
3645
|
* @public
|
|
3555
3646
|
*/
|
|
3556
|
-
instanceTypes?: string[];
|
|
3647
|
+
instanceTypes?: string[] | undefined;
|
|
3557
3648
|
/**
|
|
3558
3649
|
* <p>This is an object that represents the properties of the node range for a multi-node parallel
|
|
3559
3650
|
* job.</p>
|
|
3560
3651
|
* @public
|
|
3561
3652
|
*/
|
|
3562
|
-
ecsProperties?: EcsProperties;
|
|
3653
|
+
ecsProperties?: EcsProperties | undefined;
|
|
3563
3654
|
/**
|
|
3564
3655
|
* <p>This is an object that represents the properties of the node range for a multi-node parallel job.</p>
|
|
3565
3656
|
* @public
|
|
3566
3657
|
*/
|
|
3567
|
-
eksProperties?: EksProperties;
|
|
3658
|
+
eksProperties?: EksProperties | undefined;
|
|
3568
3659
|
}
|
|
3569
3660
|
/**
|
|
3570
3661
|
* <p>An object that represents the node properties of a multi-node parallel job.</p>
|
|
@@ -3633,7 +3724,7 @@ export interface EvaluateOnExit {
|
|
|
3633
3724
|
* match.</p>
|
|
3634
3725
|
* @public
|
|
3635
3726
|
*/
|
|
3636
|
-
onStatusReason?: string;
|
|
3727
|
+
onStatusReason?: string | undefined;
|
|
3637
3728
|
/**
|
|
3638
3729
|
* <p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The
|
|
3639
3730
|
* pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons
|
|
@@ -3641,7 +3732,7 @@ export interface EvaluateOnExit {
|
|
|
3641
3732
|
* that only the start of the string needs to be an exact match.</p>
|
|
3642
3733
|
* @public
|
|
3643
3734
|
*/
|
|
3644
|
-
onReason?: string;
|
|
3735
|
+
onReason?: string | undefined;
|
|
3645
3736
|
/**
|
|
3646
3737
|
* <p>Contains a glob pattern to match against the decimal representation of the
|
|
3647
3738
|
* <code>ExitCode</code> returned for a job. The pattern can be up to 512 characters long. It can
|
|
@@ -3650,7 +3741,7 @@ export interface EvaluateOnExit {
|
|
|
3650
3741
|
* <p>The string can contain up to 512 characters.</p>
|
|
3651
3742
|
* @public
|
|
3652
3743
|
*/
|
|
3653
|
-
onExitCode?: string;
|
|
3744
|
+
onExitCode?: string | undefined;
|
|
3654
3745
|
/**
|
|
3655
3746
|
* <p>Specifies the action to take if all of the specified conditions
|
|
3656
3747
|
* (<code>onStatusReason</code>, <code>onReason</code>, and <code>onExitCode</code>) are met. The
|
|
@@ -3671,14 +3762,14 @@ export interface RetryStrategy {
|
|
|
3671
3762
|
* retried on failure the same number of attempts as the value.</p>
|
|
3672
3763
|
* @public
|
|
3673
3764
|
*/
|
|
3674
|
-
attempts?: number;
|
|
3765
|
+
attempts?: number | undefined;
|
|
3675
3766
|
/**
|
|
3676
3767
|
* <p>Array of up to 5 objects that specify the conditions where jobs are retried or failed. If
|
|
3677
3768
|
* this parameter is specified, then the <code>attempts</code> parameter must also be specified. If
|
|
3678
3769
|
* none of the listed conditions match, then the job is retried.</p>
|
|
3679
3770
|
* @public
|
|
3680
3771
|
*/
|
|
3681
|
-
evaluateOnExit?: EvaluateOnExit[];
|
|
3772
|
+
evaluateOnExit?: EvaluateOnExit[] | undefined;
|
|
3682
3773
|
}
|
|
3683
3774
|
/**
|
|
3684
3775
|
* <p>An object that represents a job timeout configuration.</p>
|
|
@@ -3694,7 +3785,7 @@ export interface JobTimeout {
|
|
|
3694
3785
|
* individual nodes.</p>
|
|
3695
3786
|
* @public
|
|
3696
3787
|
*/
|
|
3697
|
-
attemptDurationSeconds?: number;
|
|
3788
|
+
attemptDurationSeconds?: number | undefined;
|
|
3698
3789
|
}
|
|
3699
3790
|
/**
|
|
3700
3791
|
* <p>An object that represents an Batch job definition.</p>
|
|
@@ -3720,7 +3811,7 @@ export interface JobDefinition {
|
|
|
3720
3811
|
* <p>The status of the job definition.</p>
|
|
3721
3812
|
* @public
|
|
3722
3813
|
*/
|
|
3723
|
-
status?: string;
|
|
3814
|
+
status?: string | undefined;
|
|
3724
3815
|
/**
|
|
3725
3816
|
* <p>The type of job definition. It's either <code>container</code> or <code>multinode</code>. If
|
|
3726
3817
|
* the job is run on Fargate resources, then <code>multinode</code> isn't supported. For more
|
|
@@ -3735,7 +3826,7 @@ export interface JobDefinition {
|
|
|
3735
3826
|
* scheduling priority.</p>
|
|
3736
3827
|
* @public
|
|
3737
3828
|
*/
|
|
3738
|
-
schedulingPriority?: number;
|
|
3829
|
+
schedulingPriority?: number | undefined;
|
|
3739
3830
|
/**
|
|
3740
3831
|
* <p>Default parameters or parameter substitution placeholders that are set in the job
|
|
3741
3832
|
* definition. Parameters are specified as a key-value pair mapping. Parameters in a
|
|
@@ -3744,26 +3835,26 @@ export interface JobDefinition {
|
|
|
3744
3835
|
* <i>Batch User Guide</i>.</p>
|
|
3745
3836
|
* @public
|
|
3746
3837
|
*/
|
|
3747
|
-
parameters?: Record<string, string
|
|
3838
|
+
parameters?: Record<string, string> | undefined;
|
|
3748
3839
|
/**
|
|
3749
3840
|
* <p>The retry strategy to use for failed jobs that are submitted with this job
|
|
3750
3841
|
* definition.</p>
|
|
3751
3842
|
* @public
|
|
3752
3843
|
*/
|
|
3753
|
-
retryStrategy?: RetryStrategy;
|
|
3844
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
3754
3845
|
/**
|
|
3755
3846
|
* <p>An object with properties specific to Amazon ECS-based jobs. When
|
|
3756
3847
|
* <code>containerProperties</code> is used in the job definition, it can't be used in addition to
|
|
3757
3848
|
* <code>eksProperties</code>, <code>ecsProperties</code>, or <code>nodeProperties</code>.</p>
|
|
3758
3849
|
* @public
|
|
3759
3850
|
*/
|
|
3760
|
-
containerProperties?: ContainerProperties;
|
|
3851
|
+
containerProperties?: ContainerProperties | undefined;
|
|
3761
3852
|
/**
|
|
3762
3853
|
* <p>The timeout time for jobs that are submitted with this job definition. After the amount of
|
|
3763
3854
|
* time you specify passes, Batch terminates your jobs if they aren't finished.</p>
|
|
3764
3855
|
* @public
|
|
3765
3856
|
*/
|
|
3766
|
-
timeout?: JobTimeout;
|
|
3857
|
+
timeout?: JobTimeout | undefined;
|
|
3767
3858
|
/**
|
|
3768
3859
|
* <p>An object with properties that are specific to multi-node parallel jobs. When
|
|
3769
3860
|
* <code>nodeProperties</code> is used in the job definition, it can't be used in addition to
|
|
@@ -3775,12 +3866,12 @@ export interface JobDefinition {
|
|
|
3775
3866
|
* </note>
|
|
3776
3867
|
* @public
|
|
3777
3868
|
*/
|
|
3778
|
-
nodeProperties?: NodeProperties;
|
|
3869
|
+
nodeProperties?: NodeProperties | undefined;
|
|
3779
3870
|
/**
|
|
3780
3871
|
* <p>The tags that are applied to the job definition.</p>
|
|
3781
3872
|
* @public
|
|
3782
3873
|
*/
|
|
3783
|
-
tags?: Record<string, string
|
|
3874
|
+
tags?: Record<string, string> | undefined;
|
|
3784
3875
|
/**
|
|
3785
3876
|
* <p>Specifies whether to propagate the tags from the job or job definition to the corresponding
|
|
3786
3877
|
* Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
|
|
@@ -3789,14 +3880,14 @@ export interface JobDefinition {
|
|
|
3789
3880
|
* is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
3790
3881
|
* @public
|
|
3791
3882
|
*/
|
|
3792
|
-
propagateTags?: boolean;
|
|
3883
|
+
propagateTags?: boolean | undefined;
|
|
3793
3884
|
/**
|
|
3794
3885
|
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
3795
3886
|
* defaults to <code>EC2</code>. Jobs run on Fargate resources specify
|
|
3796
3887
|
* <code>FARGATE</code>.</p>
|
|
3797
3888
|
* @public
|
|
3798
3889
|
*/
|
|
3799
|
-
platformCapabilities?: PlatformCapability[];
|
|
3890
|
+
platformCapabilities?: PlatformCapability[] | undefined;
|
|
3800
3891
|
/**
|
|
3801
3892
|
* <p>An object that contains the properties for the Amazon ECS resources of a job.When
|
|
3802
3893
|
* <code>ecsProperties</code> is used in the job definition, it can't be used in addition to
|
|
@@ -3804,7 +3895,7 @@ export interface JobDefinition {
|
|
|
3804
3895
|
* <code>nodeProperties</code>.</p>
|
|
3805
3896
|
* @public
|
|
3806
3897
|
*/
|
|
3807
|
-
ecsProperties?: EcsProperties;
|
|
3898
|
+
ecsProperties?: EcsProperties | undefined;
|
|
3808
3899
|
/**
|
|
3809
3900
|
* <p>An object with properties that are specific to Amazon EKS-based jobs. When
|
|
3810
3901
|
* <code>eksProperties</code> is used in the job definition, it can't be used in addition to
|
|
@@ -3812,13 +3903,13 @@ export interface JobDefinition {
|
|
|
3812
3903
|
* <code>nodeProperties</code>.</p>
|
|
3813
3904
|
* @public
|
|
3814
3905
|
*/
|
|
3815
|
-
eksProperties?: EksProperties;
|
|
3906
|
+
eksProperties?: EksProperties | undefined;
|
|
3816
3907
|
/**
|
|
3817
3908
|
* <p>The orchestration type of the compute environment. The valid values are <code>ECS</code>
|
|
3818
3909
|
* (default) or <code>EKS</code>.</p>
|
|
3819
3910
|
* @public
|
|
3820
3911
|
*/
|
|
3821
|
-
containerOrchestrationType?: OrchestrationType;
|
|
3912
|
+
containerOrchestrationType?: OrchestrationType | undefined;
|
|
3822
3913
|
}
|
|
3823
3914
|
/**
|
|
3824
3915
|
* @public
|
|
@@ -3828,7 +3919,7 @@ export interface DescribeJobDefinitionsResponse {
|
|
|
3828
3919
|
* <p>The list of job definitions.</p>
|
|
3829
3920
|
* @public
|
|
3830
3921
|
*/
|
|
3831
|
-
jobDefinitions?: JobDefinition[];
|
|
3922
|
+
jobDefinitions?: JobDefinition[] | undefined;
|
|
3832
3923
|
/**
|
|
3833
3924
|
* <p>The <code>nextToken</code> value to include in a future
|
|
3834
3925
|
* <code>DescribeJobDefinitions</code> request. When the results of a
|
|
@@ -3837,7 +3928,7 @@ export interface DescribeJobDefinitionsResponse {
|
|
|
3837
3928
|
* no more results to return.</p>
|
|
3838
3929
|
* @public
|
|
3839
3930
|
*/
|
|
3840
|
-
nextToken?: string;
|
|
3931
|
+
nextToken?: string | undefined;
|
|
3841
3932
|
}
|
|
3842
3933
|
/**
|
|
3843
3934
|
* <p>Contains the parameters for <code>DescribeJobQueues</code>.</p>
|
|
@@ -3848,7 +3939,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
3848
3939
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.</p>
|
|
3849
3940
|
* @public
|
|
3850
3941
|
*/
|
|
3851
|
-
jobQueues?: string[];
|
|
3942
|
+
jobQueues?: string[] | undefined;
|
|
3852
3943
|
/**
|
|
3853
3944
|
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated
|
|
3854
3945
|
* output. When this parameter is used, <code>DescribeJobQueues</code> only returns
|
|
@@ -3860,7 +3951,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
3860
3951
|
* <code>nextToken</code> value if applicable.</p>
|
|
3861
3952
|
* @public
|
|
3862
3953
|
*/
|
|
3863
|
-
maxResults?: number;
|
|
3954
|
+
maxResults?: number | undefined;
|
|
3864
3955
|
/**
|
|
3865
3956
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
3866
3957
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used and the
|
|
@@ -3873,7 +3964,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
3873
3964
|
* </note>
|
|
3874
3965
|
* @public
|
|
3875
3966
|
*/
|
|
3876
|
-
nextToken?: string;
|
|
3967
|
+
nextToken?: string | undefined;
|
|
3877
3968
|
}
|
|
3878
3969
|
/**
|
|
3879
3970
|
* @public
|
|
@@ -3921,19 +4012,19 @@ export interface JobQueueDetail {
|
|
|
3921
4012
|
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
3922
4013
|
* @public
|
|
3923
4014
|
*/
|
|
3924
|
-
schedulingPolicyArn?: string;
|
|
4015
|
+
schedulingPolicyArn?: string | undefined;
|
|
3925
4016
|
/**
|
|
3926
4017
|
* <p>The status of the job queue (for example, <code>CREATING</code> or
|
|
3927
4018
|
* <code>VALID</code>).</p>
|
|
3928
4019
|
* @public
|
|
3929
4020
|
*/
|
|
3930
|
-
status?: JQStatus;
|
|
4021
|
+
status?: JQStatus | undefined;
|
|
3931
4022
|
/**
|
|
3932
4023
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
3933
4024
|
* job queue.</p>
|
|
3934
4025
|
* @public
|
|
3935
4026
|
*/
|
|
3936
|
-
statusReason?: string;
|
|
4027
|
+
statusReason?: string | undefined;
|
|
3937
4028
|
/**
|
|
3938
4029
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and Fargate compute environments can't be mixed.</p>
|
|
3939
4030
|
* @public
|
|
@@ -3950,12 +4041,12 @@ export interface JobQueueDetail {
|
|
|
3950
4041
|
* <i>Batch User Guide</i>.</p>
|
|
3951
4042
|
* @public
|
|
3952
4043
|
*/
|
|
3953
|
-
tags?: Record<string, string
|
|
4044
|
+
tags?: Record<string, string> | undefined;
|
|
3954
4045
|
/**
|
|
3955
4046
|
* <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
|
|
3956
4047
|
* @public
|
|
3957
4048
|
*/
|
|
3958
|
-
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
|
|
4049
|
+
jobStateTimeLimitActions?: JobStateTimeLimitAction[] | undefined;
|
|
3959
4050
|
}
|
|
3960
4051
|
/**
|
|
3961
4052
|
* @public
|
|
@@ -3965,7 +4056,7 @@ export interface DescribeJobQueuesResponse {
|
|
|
3965
4056
|
* <p>The list of job queues.</p>
|
|
3966
4057
|
* @public
|
|
3967
4058
|
*/
|
|
3968
|
-
jobQueues?: JobQueueDetail[];
|
|
4059
|
+
jobQueues?: JobQueueDetail[] | undefined;
|
|
3969
4060
|
/**
|
|
3970
4061
|
* <p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code>
|
|
3971
4062
|
* request. When the results of a <code>DescribeJobQueues</code> request exceed
|
|
@@ -3973,7 +4064,7 @@ export interface DescribeJobQueuesResponse {
|
|
|
3973
4064
|
* value is <code>null</code> when there are no more results to return.</p>
|
|
3974
4065
|
* @public
|
|
3975
4066
|
*/
|
|
3976
|
-
nextToken?: string;
|
|
4067
|
+
nextToken?: string | undefined;
|
|
3977
4068
|
}
|
|
3978
4069
|
/**
|
|
3979
4070
|
* <p>Contains the parameters for <code>DescribeJobs</code>.</p>
|
|
@@ -3995,7 +4086,7 @@ export interface ContainerDetail {
|
|
|
3995
4086
|
* <p>The image used to start the container.</p>
|
|
3996
4087
|
* @public
|
|
3997
4088
|
*/
|
|
3998
|
-
image?: string;
|
|
4089
|
+
image?: string | undefined;
|
|
3999
4090
|
/**
|
|
4000
4091
|
* <p>The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you
|
|
4001
4092
|
* can specify the vCPU requirement for the job using <code>resourceRequirements</code>, but you
|
|
@@ -4012,24 +4103,24 @@ export interface ContainerDetail {
|
|
|
4012
4103
|
* </note>
|
|
4013
4104
|
* @public
|
|
4014
4105
|
*/
|
|
4015
|
-
vcpus?: number;
|
|
4106
|
+
vcpus?: number | undefined;
|
|
4016
4107
|
/**
|
|
4017
4108
|
* <p>For jobs running on Amazon EC2 resources that didn't specify memory requirements using
|
|
4018
4109
|
* <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other
|
|
4019
4110
|
* jobs, including all run on Fargate resources, see <code>resourceRequirements</code>.</p>
|
|
4020
4111
|
* @public
|
|
4021
4112
|
*/
|
|
4022
|
-
memory?: number;
|
|
4113
|
+
memory?: number | undefined;
|
|
4023
4114
|
/**
|
|
4024
4115
|
* <p>The command that's passed to the container.</p>
|
|
4025
4116
|
* @public
|
|
4026
4117
|
*/
|
|
4027
|
-
command?: string[];
|
|
4118
|
+
command?: string[] | undefined;
|
|
4028
4119
|
/**
|
|
4029
4120
|
* <p>The Amazon Resource Name (ARN) that's associated with the job when run.</p>
|
|
4030
4121
|
* @public
|
|
4031
4122
|
*/
|
|
4032
|
-
jobRoleArn?: string;
|
|
4123
|
+
jobRoleArn?: string | undefined;
|
|
4033
4124
|
/**
|
|
4034
4125
|
* <p>The Amazon Resource Name (ARN) of the
|
|
4035
4126
|
* execution
|
|
@@ -4038,12 +4129,12 @@ export interface ContainerDetail {
|
|
|
4038
4129
|
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
4039
4130
|
* @public
|
|
4040
4131
|
*/
|
|
4041
|
-
executionRoleArn?: string;
|
|
4132
|
+
executionRoleArn?: string | undefined;
|
|
4042
4133
|
/**
|
|
4043
4134
|
* <p>A list of volumes that are associated with the job.</p>
|
|
4044
4135
|
* @public
|
|
4045
4136
|
*/
|
|
4046
|
-
volumes?: Volume[];
|
|
4137
|
+
volumes?: Volume[] | undefined;
|
|
4047
4138
|
/**
|
|
4048
4139
|
* <p>The environment variables to pass to a container.</p>
|
|
4049
4140
|
* <note>
|
|
@@ -4052,12 +4143,12 @@ export interface ContainerDetail {
|
|
|
4052
4143
|
* </note>
|
|
4053
4144
|
* @public
|
|
4054
4145
|
*/
|
|
4055
|
-
environment?: KeyValuePair[];
|
|
4146
|
+
environment?: KeyValuePair[] | undefined;
|
|
4056
4147
|
/**
|
|
4057
4148
|
* <p>The mount points for data volumes in your container.</p>
|
|
4058
4149
|
* @public
|
|
4059
4150
|
*/
|
|
4060
|
-
mountPoints?: MountPoint[];
|
|
4151
|
+
mountPoints?: MountPoint[] | undefined;
|
|
4061
4152
|
/**
|
|
4062
4153
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
4063
4154
|
* system. This parameter maps to <code>ReadonlyRootfs</code> in the
|
|
@@ -4068,7 +4159,7 @@ export interface ContainerDetail {
|
|
|
4068
4159
|
* </a>.</p>
|
|
4069
4160
|
* @public
|
|
4070
4161
|
*/
|
|
4071
|
-
readonlyRootFilesystem?: boolean;
|
|
4162
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
4072
4163
|
/**
|
|
4073
4164
|
* <p>A list of <code>ulimit</code> values to set in the container. This parameter maps to
|
|
4074
4165
|
* <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
|
|
@@ -4079,7 +4170,7 @@ export interface ContainerDetail {
|
|
|
4079
4170
|
* </note>
|
|
4080
4171
|
* @public
|
|
4081
4172
|
*/
|
|
4082
|
-
ulimits?: Ulimit[];
|
|
4173
|
+
ulimits?: Ulimit[] | undefined;
|
|
4083
4174
|
/**
|
|
4084
4175
|
* <p>When this parameter is true, the container is given elevated permissions on the host
|
|
4085
4176
|
* container instance (similar to the <code>root</code> user). The default value is
|
|
@@ -4090,43 +4181,43 @@ export interface ContainerDetail {
|
|
|
4090
4181
|
* </note>
|
|
4091
4182
|
* @public
|
|
4092
4183
|
*/
|
|
4093
|
-
privileged?: boolean;
|
|
4184
|
+
privileged?: boolean | undefined;
|
|
4094
4185
|
/**
|
|
4095
4186
|
* <p>The user name to use inside the container. This parameter maps to <code>User</code> in the
|
|
4096
4187
|
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--user</code>
|
|
4097
4188
|
* option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
4098
4189
|
* @public
|
|
4099
4190
|
*/
|
|
4100
|
-
user?: string;
|
|
4191
|
+
user?: string | undefined;
|
|
4101
4192
|
/**
|
|
4102
4193
|
* <p>The exit code returned upon completion.</p>
|
|
4103
4194
|
* @public
|
|
4104
4195
|
*/
|
|
4105
|
-
exitCode?: number;
|
|
4196
|
+
exitCode?: number | undefined;
|
|
4106
4197
|
/**
|
|
4107
4198
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4108
4199
|
* running or stopped container.</p>
|
|
4109
4200
|
* @public
|
|
4110
4201
|
*/
|
|
4111
|
-
reason?: string;
|
|
4202
|
+
reason?: string | undefined;
|
|
4112
4203
|
/**
|
|
4113
4204
|
* <p>The Amazon Resource Name (ARN) of the container instance that the container is running on.</p>
|
|
4114
4205
|
* @public
|
|
4115
4206
|
*/
|
|
4116
|
-
containerInstanceArn?: string;
|
|
4207
|
+
containerInstanceArn?: string | undefined;
|
|
4117
4208
|
/**
|
|
4118
4209
|
* <p>The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container
|
|
4119
4210
|
* attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>
|
|
4120
4211
|
* @public
|
|
4121
4212
|
*/
|
|
4122
|
-
taskArn?: string;
|
|
4213
|
+
taskArn?: string | undefined;
|
|
4123
4214
|
/**
|
|
4124
4215
|
* <p>The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for
|
|
4125
4216
|
* Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name
|
|
4126
4217
|
* when they reach the <code>RUNNING</code> status.</p>
|
|
4127
4218
|
* @public
|
|
4128
4219
|
*/
|
|
4129
|
-
logStreamName?: string;
|
|
4220
|
+
logStreamName?: string | undefined;
|
|
4130
4221
|
/**
|
|
4131
4222
|
* <p>The instance type of the underlying host infrastructure of a multi-node parallel job.</p>
|
|
4132
4223
|
* <note>
|
|
@@ -4134,24 +4225,24 @@ export interface ContainerDetail {
|
|
|
4134
4225
|
* </note>
|
|
4135
4226
|
* @public
|
|
4136
4227
|
*/
|
|
4137
|
-
instanceType?: string;
|
|
4228
|
+
instanceType?: string | undefined;
|
|
4138
4229
|
/**
|
|
4139
4230
|
* <p>The network interfaces that are associated with the job.</p>
|
|
4140
4231
|
* @public
|
|
4141
4232
|
*/
|
|
4142
|
-
networkInterfaces?: NetworkInterface[];
|
|
4233
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
4143
4234
|
/**
|
|
4144
4235
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
4145
4236
|
* <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
4146
4237
|
* @public
|
|
4147
4238
|
*/
|
|
4148
|
-
resourceRequirements?: ResourceRequirement[];
|
|
4239
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
4149
4240
|
/**
|
|
4150
4241
|
* <p>Linux-specific modifications that are applied to the container, such as details for device
|
|
4151
4242
|
* mappings.</p>
|
|
4152
4243
|
* @public
|
|
4153
4244
|
*/
|
|
4154
|
-
linuxParameters?: LinuxParameters;
|
|
4245
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
4155
4246
|
/**
|
|
4156
4247
|
* <p>The log configuration specification for the container.</p>
|
|
4157
4248
|
* <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
|
|
@@ -4181,43 +4272,43 @@ export interface ContainerDetail {
|
|
|
4181
4272
|
* </note>
|
|
4182
4273
|
* @public
|
|
4183
4274
|
*/
|
|
4184
|
-
logConfiguration?: LogConfiguration;
|
|
4275
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
4185
4276
|
/**
|
|
4186
4277
|
* <p>The secrets to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying sensitive data</a> in the
|
|
4187
4278
|
* <i>Batch User Guide</i>.</p>
|
|
4188
4279
|
* @public
|
|
4189
4280
|
*/
|
|
4190
|
-
secrets?: Secret[];
|
|
4281
|
+
secrets?: Secret[] | undefined;
|
|
4191
4282
|
/**
|
|
4192
4283
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4193
4284
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4194
4285
|
* @public
|
|
4195
4286
|
*/
|
|
4196
|
-
networkConfiguration?: NetworkConfiguration;
|
|
4287
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
4197
4288
|
/**
|
|
4198
4289
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4199
4290
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4200
4291
|
* @public
|
|
4201
4292
|
*/
|
|
4202
|
-
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
4293
|
+
fargatePlatformConfiguration?: FargatePlatformConfiguration | undefined;
|
|
4203
4294
|
/**
|
|
4204
4295
|
* <p>The amount of ephemeral storage allocated for the task. This parameter is used to expand the
|
|
4205
4296
|
* total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
|
|
4206
4297
|
* Fargate.</p>
|
|
4207
4298
|
* @public
|
|
4208
4299
|
*/
|
|
4209
|
-
ephemeralStorage?: EphemeralStorage;
|
|
4300
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
4210
4301
|
/**
|
|
4211
4302
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4212
4303
|
* Fargate.</p>
|
|
4213
4304
|
* @public
|
|
4214
4305
|
*/
|
|
4215
|
-
runtimePlatform?: RuntimePlatform;
|
|
4306
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
4216
4307
|
/**
|
|
4217
4308
|
* <p>The private repository authentication credentials to use.</p>
|
|
4218
4309
|
* @public
|
|
4219
4310
|
*/
|
|
4220
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
4311
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
4221
4312
|
}
|
|
4222
4313
|
/**
|
|
4223
4314
|
* <p>An object that represents an Batch job dependency.</p>
|
|
@@ -4228,12 +4319,12 @@ export interface JobDependency {
|
|
|
4228
4319
|
* <p>The job ID of the Batch job that's associated with this dependency.</p>
|
|
4229
4320
|
* @public
|
|
4230
4321
|
*/
|
|
4231
|
-
jobId?: string;
|
|
4322
|
+
jobId?: string | undefined;
|
|
4232
4323
|
/**
|
|
4233
4324
|
* <p>The type of the job dependency.</p>
|
|
4234
4325
|
* @public
|
|
4235
4326
|
*/
|
|
4236
|
-
type?: ArrayJobDependency;
|
|
4327
|
+
type?: ArrayJobDependency | undefined;
|
|
4237
4328
|
}
|
|
4238
4329
|
/**
|
|
4239
4330
|
* <p>The details for the container in this task attempt.</p>
|
|
@@ -4247,12 +4338,12 @@ export interface TaskContainerDetails {
|
|
|
4247
4338
|
* <a href="https://docs.docker.com/engine/reference/builder/#cmd">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>
|
|
4248
4339
|
* @public
|
|
4249
4340
|
*/
|
|
4250
|
-
command?: string[];
|
|
4341
|
+
command?: string[] | undefined;
|
|
4251
4342
|
/**
|
|
4252
4343
|
* <p>A list of containers that this container depends on.</p>
|
|
4253
4344
|
* @public
|
|
4254
4345
|
*/
|
|
4255
|
-
dependsOn?: TaskContainerDependency[];
|
|
4346
|
+
dependsOn?: TaskContainerDependency[] | undefined;
|
|
4256
4347
|
/**
|
|
4257
4348
|
* <p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in
|
|
4258
4349
|
* the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
|
|
@@ -4263,7 +4354,7 @@ export interface TaskContainerDetails {
|
|
|
4263
4354
|
* </important>
|
|
4264
4355
|
* @public
|
|
4265
4356
|
*/
|
|
4266
|
-
environment?: KeyValuePair[];
|
|
4357
|
+
environment?: KeyValuePair[] | undefined;
|
|
4267
4358
|
/**
|
|
4268
4359
|
* <p>If the essential parameter of a container is marked as <code>true</code>, and that container
|
|
4269
4360
|
* fails or stops for any reason, all other containers that are part of the task are stopped. If the
|
|
@@ -4277,7 +4368,7 @@ export interface TaskContainerDetails {
|
|
|
4277
4368
|
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4278
4369
|
* @public
|
|
4279
4370
|
*/
|
|
4280
|
-
essential?: boolean;
|
|
4371
|
+
essential?: boolean | undefined;
|
|
4281
4372
|
/**
|
|
4282
4373
|
* <p>The image used to start a container. This string is passed directly to the Docker daemon. By
|
|
4283
4374
|
* default, images in the Docker Hub registry are available. Other repositories are specified with
|
|
@@ -4291,7 +4382,7 @@ export interface TaskContainerDetails {
|
|
|
4291
4382
|
* </a>.</p>
|
|
4292
4383
|
* @public
|
|
4293
4384
|
*/
|
|
4294
|
-
image?: string;
|
|
4385
|
+
image?: string | undefined;
|
|
4295
4386
|
/**
|
|
4296
4387
|
* <p>Linux-specific modifications that are applied to the container, such as Linux kernel
|
|
4297
4388
|
* capabilities. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
|
|
@@ -4300,7 +4391,7 @@ export interface TaskContainerDetails {
|
|
|
4300
4391
|
* </note>
|
|
4301
4392
|
* @public
|
|
4302
4393
|
*/
|
|
4303
|
-
linuxParameters?: LinuxParameters;
|
|
4394
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
4304
4395
|
/**
|
|
4305
4396
|
* <p>The log configuration specification for the container.</p>
|
|
4306
4397
|
* <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
@@ -4333,7 +4424,7 @@ export interface TaskContainerDetails {
|
|
|
4333
4424
|
* </note>
|
|
4334
4425
|
* @public
|
|
4335
4426
|
*/
|
|
4336
|
-
logConfiguration?: LogConfiguration;
|
|
4427
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
4337
4428
|
/**
|
|
4338
4429
|
* <p>The mount points for data volumes in your container.</p>
|
|
4339
4430
|
* <p>This parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
@@ -4345,12 +4436,12 @@ export interface TaskContainerDetails {
|
|
|
4345
4436
|
* and mount point can't be across drives.</p>
|
|
4346
4437
|
* @public
|
|
4347
4438
|
*/
|
|
4348
|
-
mountPoints?: MountPoint[];
|
|
4439
|
+
mountPoints?: MountPoint[] | undefined;
|
|
4349
4440
|
/**
|
|
4350
4441
|
* <p>The name of a container.</p>
|
|
4351
4442
|
* @public
|
|
4352
4443
|
*/
|
|
4353
|
-
name?: string;
|
|
4444
|
+
name?: string | undefined;
|
|
4354
4445
|
/**
|
|
4355
4446
|
* <p>When this parameter is <code>true</code>, the container is given elevated privileges on the
|
|
4356
4447
|
* host container instance (similar to the <code>root</code> user). This parameter maps to
|
|
@@ -4363,7 +4454,7 @@ export interface TaskContainerDetails {
|
|
|
4363
4454
|
* </note>
|
|
4364
4455
|
* @public
|
|
4365
4456
|
*/
|
|
4366
|
-
privileged?: boolean;
|
|
4457
|
+
privileged?: boolean | undefined;
|
|
4367
4458
|
/**
|
|
4368
4459
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
4369
4460
|
* system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
@@ -4375,24 +4466,24 @@ export interface TaskContainerDetails {
|
|
|
4375
4466
|
* </note>
|
|
4376
4467
|
* @public
|
|
4377
4468
|
*/
|
|
4378
|
-
readonlyRootFilesystem?: boolean;
|
|
4469
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
4379
4470
|
/**
|
|
4380
4471
|
* <p>The private repository authentication credentials to use.</p>
|
|
4381
4472
|
* @public
|
|
4382
4473
|
*/
|
|
4383
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
4474
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
4384
4475
|
/**
|
|
4385
4476
|
* <p>The type and amount of a resource to assign to a container. The only supported resource is a
|
|
4386
4477
|
* GPU.</p>
|
|
4387
4478
|
* @public
|
|
4388
4479
|
*/
|
|
4389
|
-
resourceRequirements?: ResourceRequirement[];
|
|
4480
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
4390
4481
|
/**
|
|
4391
4482
|
* <p>The secrets to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html">Specifying Sensitive
|
|
4392
4483
|
* Data</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
4393
4484
|
* @public
|
|
4394
4485
|
*/
|
|
4395
|
-
secrets?: Secret[];
|
|
4486
|
+
secrets?: Secret[] | undefined;
|
|
4396
4487
|
/**
|
|
4397
4488
|
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value is
|
|
4398
4489
|
* specified in a task definition, it overrides the default values set by Docker. This parameter
|
|
@@ -4415,7 +4506,7 @@ export interface TaskContainerDetails {
|
|
|
4415
4506
|
* </note>
|
|
4416
4507
|
* @public
|
|
4417
4508
|
*/
|
|
4418
|
-
ulimits?: Ulimit[];
|
|
4509
|
+
ulimits?: Ulimit[] | undefined;
|
|
4419
4510
|
/**
|
|
4420
4511
|
* <p>The user to use inside the container. This parameter maps to User in the Create a container
|
|
4421
4512
|
* section of the Docker Remote API and the --user option to docker run.</p>
|
|
@@ -4467,30 +4558,30 @@ export interface TaskContainerDetails {
|
|
|
4467
4558
|
* </note>
|
|
4468
4559
|
* @public
|
|
4469
4560
|
*/
|
|
4470
|
-
user?: string;
|
|
4561
|
+
user?: string | undefined;
|
|
4471
4562
|
/**
|
|
4472
4563
|
* <p>The exit code returned upon completion.</p>
|
|
4473
4564
|
* @public
|
|
4474
4565
|
*/
|
|
4475
|
-
exitCode?: number;
|
|
4566
|
+
exitCode?: number | undefined;
|
|
4476
4567
|
/**
|
|
4477
4568
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4478
4569
|
* running or stopped container.</p>
|
|
4479
4570
|
* @public
|
|
4480
4571
|
*/
|
|
4481
|
-
reason?: string;
|
|
4572
|
+
reason?: string | undefined;
|
|
4482
4573
|
/**
|
|
4483
4574
|
* <p>The name of the CloudWatch Logs log stream that's associated with the container. The log group for
|
|
4484
4575
|
* Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach
|
|
4485
4576
|
* the <code>RUNNING</code> status. </p>
|
|
4486
4577
|
* @public
|
|
4487
4578
|
*/
|
|
4488
|
-
logStreamName?: string;
|
|
4579
|
+
logStreamName?: string | undefined;
|
|
4489
4580
|
/**
|
|
4490
4581
|
* <p>The network interfaces that are associated with the job.</p>
|
|
4491
4582
|
* @public
|
|
4492
4583
|
*/
|
|
4493
|
-
networkInterfaces?: NetworkInterface[];
|
|
4584
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
4494
4585
|
}
|
|
4495
4586
|
/**
|
|
4496
4587
|
* <p>The details of a task definition that describes the container and volume definitions of an
|
|
@@ -4502,39 +4593,39 @@ export interface EcsTaskDetails {
|
|
|
4502
4593
|
* <p>A list of containers that are included in the <code>taskProperties</code> list.</p>
|
|
4503
4594
|
* @public
|
|
4504
4595
|
*/
|
|
4505
|
-
containers?: TaskContainerDetails[];
|
|
4596
|
+
containers?: TaskContainerDetails[] | undefined;
|
|
4506
4597
|
/**
|
|
4507
4598
|
* <p>The Amazon Resource Name (ARN) of the container instance that hosts the task.</p>
|
|
4508
4599
|
* @public
|
|
4509
4600
|
*/
|
|
4510
|
-
containerInstanceArn?: string;
|
|
4601
|
+
containerInstanceArn?: string | undefined;
|
|
4511
4602
|
/**
|
|
4512
4603
|
* <p>The ARN of the Amazon ECS task.</p>
|
|
4513
4604
|
* @public
|
|
4514
4605
|
*/
|
|
4515
|
-
taskArn?: string;
|
|
4606
|
+
taskArn?: string | undefined;
|
|
4516
4607
|
/**
|
|
4517
4608
|
* <p>The amount of ephemeral storage allocated for the task.</p>
|
|
4518
4609
|
* @public
|
|
4519
4610
|
*/
|
|
4520
|
-
ephemeralStorage?: EphemeralStorage;
|
|
4611
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
4521
4612
|
/**
|
|
4522
4613
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see
|
|
4523
4614
|
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM
|
|
4524
4615
|
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
4525
4616
|
* @public
|
|
4526
4617
|
*/
|
|
4527
|
-
executionRoleArn?: string;
|
|
4618
|
+
executionRoleArn?: string | undefined;
|
|
4528
4619
|
/**
|
|
4529
4620
|
* <p>The Fargate platform version where the jobs are running.</p>
|
|
4530
4621
|
* @public
|
|
4531
4622
|
*/
|
|
4532
|
-
platformVersion?: string;
|
|
4623
|
+
platformVersion?: string | undefined;
|
|
4533
4624
|
/**
|
|
4534
4625
|
* <p>The IPC resource namespace to use for the containers in the task.</p>
|
|
4535
4626
|
* @public
|
|
4536
4627
|
*/
|
|
4537
|
-
ipcMode?: string;
|
|
4628
|
+
ipcMode?: string | undefined;
|
|
4538
4629
|
/**
|
|
4539
4630
|
* <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more
|
|
4540
4631
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the
|
|
@@ -4544,29 +4635,29 @@ export interface EcsTaskDetails {
|
|
|
4544
4635
|
* </note>
|
|
4545
4636
|
* @public
|
|
4546
4637
|
*/
|
|
4547
|
-
taskRoleArn?: string;
|
|
4638
|
+
taskRoleArn?: string | undefined;
|
|
4548
4639
|
/**
|
|
4549
4640
|
* <p>The process namespace to use for the containers in the task.</p>
|
|
4550
4641
|
* @public
|
|
4551
4642
|
*/
|
|
4552
|
-
pidMode?: string;
|
|
4643
|
+
pidMode?: string | undefined;
|
|
4553
4644
|
/**
|
|
4554
4645
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4555
4646
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4556
4647
|
* @public
|
|
4557
4648
|
*/
|
|
4558
|
-
networkConfiguration?: NetworkConfiguration;
|
|
4649
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
4559
4650
|
/**
|
|
4560
4651
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4561
4652
|
* Fargate.</p>
|
|
4562
4653
|
* @public
|
|
4563
4654
|
*/
|
|
4564
|
-
runtimePlatform?: RuntimePlatform;
|
|
4655
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
4565
4656
|
/**
|
|
4566
4657
|
* <p>A list of data volumes used in a job.</p>
|
|
4567
4658
|
* @public
|
|
4568
4659
|
*/
|
|
4569
|
-
volumes?: Volume[];
|
|
4660
|
+
volumes?: Volume[] | undefined;
|
|
4570
4661
|
}
|
|
4571
4662
|
/**
|
|
4572
4663
|
* <p>An object that contains the details for the Amazon ECS resources of a job.</p>
|
|
@@ -4577,7 +4668,7 @@ export interface EcsPropertiesDetail {
|
|
|
4577
4668
|
* <p>The properties for the Amazon ECS task definition of a job.</p>
|
|
4578
4669
|
* @public
|
|
4579
4670
|
*/
|
|
4580
|
-
taskProperties?: EcsTaskDetails[];
|
|
4671
|
+
taskProperties?: EcsTaskDetails[] | undefined;
|
|
4581
4672
|
}
|
|
4582
4673
|
/**
|
|
4583
4674
|
* <p>An object that represents the details for an attempt for a job attempt that an Amazon EKS
|
|
@@ -4589,24 +4680,24 @@ export interface EksAttemptContainerDetail {
|
|
|
4589
4680
|
* <p>The name of a container.</p>
|
|
4590
4681
|
* @public
|
|
4591
4682
|
*/
|
|
4592
|
-
name?: string;
|
|
4683
|
+
name?: string | undefined;
|
|
4593
4684
|
/**
|
|
4594
4685
|
* <p>The ID for the container.</p>
|
|
4595
4686
|
* @public
|
|
4596
4687
|
*/
|
|
4597
|
-
containerID?: string;
|
|
4688
|
+
containerID?: string | undefined;
|
|
4598
4689
|
/**
|
|
4599
4690
|
* <p>The exit code returned for the job attempt. A non-zero exit code is considered
|
|
4600
4691
|
* failed.</p>
|
|
4601
4692
|
* @public
|
|
4602
4693
|
*/
|
|
4603
|
-
exitCode?: number;
|
|
4694
|
+
exitCode?: number | undefined;
|
|
4604
4695
|
/**
|
|
4605
4696
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4606
4697
|
* running or stopped container.</p>
|
|
4607
4698
|
* @public
|
|
4608
4699
|
*/
|
|
4609
|
-
reason?: string;
|
|
4700
|
+
reason?: string | undefined;
|
|
4610
4701
|
}
|
|
4611
4702
|
/**
|
|
4612
4703
|
* <p>An object that represents the details of a job attempt for a job attempt by an Amazon EKS
|
|
@@ -4618,51 +4709,51 @@ export interface EksAttemptDetail {
|
|
|
4618
4709
|
* <p>The details for the final status of the containers for this job attempt.</p>
|
|
4619
4710
|
* @public
|
|
4620
4711
|
*/
|
|
4621
|
-
containers?: EksAttemptContainerDetail[];
|
|
4712
|
+
containers?: EksAttemptContainerDetail[] | undefined;
|
|
4622
4713
|
/**
|
|
4623
4714
|
* <p>The details for the init containers.</p>
|
|
4624
4715
|
* @public
|
|
4625
4716
|
*/
|
|
4626
|
-
initContainers?: EksAttemptContainerDetail[];
|
|
4717
|
+
initContainers?: EksAttemptContainerDetail[] | undefined;
|
|
4627
4718
|
/**
|
|
4628
4719
|
* <p>The Amazon Resource Name (ARN) of the Amazon EKS cluster.</p>
|
|
4629
4720
|
* @public
|
|
4630
4721
|
*/
|
|
4631
|
-
eksClusterArn?: string;
|
|
4722
|
+
eksClusterArn?: string | undefined;
|
|
4632
4723
|
/**
|
|
4633
4724
|
* <p>The name of the pod for this job attempt.</p>
|
|
4634
4725
|
* @public
|
|
4635
4726
|
*/
|
|
4636
|
-
podName?: string;
|
|
4727
|
+
podName?: string | undefined;
|
|
4637
4728
|
/**
|
|
4638
4729
|
* <p>The namespace of the Amazon EKS cluster that the pod exists in.</p>
|
|
4639
4730
|
* @public
|
|
4640
4731
|
*/
|
|
4641
|
-
podNamespace?: string;
|
|
4732
|
+
podNamespace?: string | undefined;
|
|
4642
4733
|
/**
|
|
4643
4734
|
* <p>The name of the node for this job attempt.</p>
|
|
4644
4735
|
* @public
|
|
4645
4736
|
*/
|
|
4646
|
-
nodeName?: string;
|
|
4737
|
+
nodeName?: string | undefined;
|
|
4647
4738
|
/**
|
|
4648
4739
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
|
|
4649
4740
|
* transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
|
|
4650
4741
|
* @public
|
|
4651
4742
|
*/
|
|
4652
|
-
startedAt?: number;
|
|
4743
|
+
startedAt?: number | undefined;
|
|
4653
4744
|
/**
|
|
4654
4745
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the
|
|
4655
4746
|
* attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as
|
|
4656
4747
|
* <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
4657
4748
|
* @public
|
|
4658
4749
|
*/
|
|
4659
|
-
stoppedAt?: number;
|
|
4750
|
+
stoppedAt?: number | undefined;
|
|
4660
4751
|
/**
|
|
4661
4752
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
4662
4753
|
* job attempt.</p>
|
|
4663
4754
|
* @public
|
|
4664
4755
|
*/
|
|
4665
|
-
statusReason?: string;
|
|
4756
|
+
statusReason?: string | undefined;
|
|
4666
4757
|
}
|
|
4667
4758
|
/**
|
|
4668
4759
|
* <p>The details for container properties that are returned by <code>DescribeJobs</code> for jobs
|
|
@@ -4675,12 +4766,12 @@ export interface EksContainerDetail {
|
|
|
4675
4766
|
* "<code>Default</code>" is used. Each container in a pod must have a unique name.</p>
|
|
4676
4767
|
* @public
|
|
4677
4768
|
*/
|
|
4678
|
-
name?: string;
|
|
4769
|
+
name?: string | undefined;
|
|
4679
4770
|
/**
|
|
4680
4771
|
* <p>The Docker image used to start the container.</p>
|
|
4681
4772
|
* @public
|
|
4682
4773
|
*/
|
|
4683
|
-
image?: string;
|
|
4774
|
+
image?: string | undefined;
|
|
4684
4775
|
/**
|
|
4685
4776
|
* <p>The image pull policy for the container. Supported values are <code>Always</code>,
|
|
4686
4777
|
* <code>IfNotPresent</code>, and <code>Never</code>. This parameter defaults to
|
|
@@ -4689,12 +4780,12 @@ export interface EksContainerDetail {
|
|
|
4689
4780
|
* images</a> in the <i>Kubernetes documentation</i>.</p>
|
|
4690
4781
|
* @public
|
|
4691
4782
|
*/
|
|
4692
|
-
imagePullPolicy?: string;
|
|
4783
|
+
imagePullPolicy?: string | undefined;
|
|
4693
4784
|
/**
|
|
4694
4785
|
* <p>The entrypoint for the container. For more information, see <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> in the <i>Kubernetes documentation</i>.</p>
|
|
4695
4786
|
* @public
|
|
4696
4787
|
*/
|
|
4697
|
-
command?: string[];
|
|
4788
|
+
command?: string[] | undefined;
|
|
4698
4789
|
/**
|
|
4699
4790
|
* <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of
|
|
4700
4791
|
* the container image is used. This corresponds to the <code>args</code> member in the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> portion of the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/">Pod</a>
|
|
@@ -4709,7 +4800,7 @@ export interface EksContainerDetail {
|
|
|
4709
4800
|
* documentation</i>.</p>
|
|
4710
4801
|
* @public
|
|
4711
4802
|
*/
|
|
4712
|
-
args?: string[];
|
|
4803
|
+
args?: string[] | undefined;
|
|
4713
4804
|
/**
|
|
4714
4805
|
* <p>The environment variables to pass to a container.</p>
|
|
4715
4806
|
* <note>
|
|
@@ -4718,7 +4809,7 @@ export interface EksContainerDetail {
|
|
|
4718
4809
|
* </note>
|
|
4719
4810
|
* @public
|
|
4720
4811
|
*/
|
|
4721
|
-
env?: EksContainerEnvironmentVariable[];
|
|
4812
|
+
env?: EksContainerEnvironmentVariable[] | undefined;
|
|
4722
4813
|
/**
|
|
4723
4814
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
4724
4815
|
* <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information,
|
|
@@ -4726,33 +4817,33 @@ export interface EksContainerDetail {
|
|
|
4726
4817
|
* documentation</i>.</p>
|
|
4727
4818
|
* @public
|
|
4728
4819
|
*/
|
|
4729
|
-
resources?: EksContainerResourceRequirements;
|
|
4820
|
+
resources?: EksContainerResourceRequirements | undefined;
|
|
4730
4821
|
/**
|
|
4731
4822
|
* <p>The exit code returned for the job attempt. A non-zero exit code is considered
|
|
4732
4823
|
* failed.</p>
|
|
4733
4824
|
* @public
|
|
4734
4825
|
*/
|
|
4735
|
-
exitCode?: number;
|
|
4826
|
+
exitCode?: number | undefined;
|
|
4736
4827
|
/**
|
|
4737
4828
|
* <p>A short human-readable string to provide additional details for a running or stopped
|
|
4738
4829
|
* container. It can be up to 255 characters long.</p>
|
|
4739
4830
|
* @public
|
|
4740
4831
|
*/
|
|
4741
|
-
reason?: string;
|
|
4832
|
+
reason?: string | undefined;
|
|
4742
4833
|
/**
|
|
4743
4834
|
* <p>The volume mounts for the container. Batch supports <code>emptyDir</code>,
|
|
4744
4835
|
* <code>hostPath</code>, and <code>secret</code> volume types. For more information about volumes
|
|
4745
4836
|
* and volume mounts in Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes documentation</i>.</p>
|
|
4746
4837
|
* @public
|
|
4747
4838
|
*/
|
|
4748
|
-
volumeMounts?: EksContainerVolumeMount[];
|
|
4839
|
+
volumeMounts?: EksContainerVolumeMount[] | undefined;
|
|
4749
4840
|
/**
|
|
4750
4841
|
* <p>The security context for a job. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">Configure a
|
|
4751
4842
|
* security context for a pod or container</a> in the <i>Kubernetes
|
|
4752
4843
|
* documentation</i>.</p>
|
|
4753
4844
|
* @public
|
|
4754
4845
|
*/
|
|
4755
|
-
securityContext?: EksContainerSecurityContext;
|
|
4846
|
+
securityContext?: EksContainerSecurityContext | undefined;
|
|
4756
4847
|
}
|
|
4757
4848
|
/**
|
|
4758
4849
|
* <p>The details for the pod.</p>
|
|
@@ -4767,7 +4858,7 @@ export interface EksPodPropertiesDetail {
|
|
|
4767
4858
|
* documentation</i>.</p>
|
|
4768
4859
|
* @public
|
|
4769
4860
|
*/
|
|
4770
|
-
serviceAccountName?: string;
|
|
4861
|
+
serviceAccountName?: string | undefined;
|
|
4771
4862
|
/**
|
|
4772
4863
|
* <p>Indicates if the pod uses the hosts' network IP address. The default value is
|
|
4773
4864
|
* <code>true</code>. Setting this to <code>false</code> enables the Kubernetes pod networking model.
|
|
@@ -4777,7 +4868,7 @@ export interface EksPodPropertiesDetail {
|
|
|
4777
4868
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
4778
4869
|
* @public
|
|
4779
4870
|
*/
|
|
4780
|
-
hostNetwork?: boolean;
|
|
4871
|
+
hostNetwork?: boolean | undefined;
|
|
4781
4872
|
/**
|
|
4782
4873
|
* <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the
|
|
4783
4874
|
* <code>hostNetwork</code> parameter is not specified, the default is
|
|
@@ -4793,53 +4884,53 @@ export interface EksPodPropertiesDetail {
|
|
|
4793
4884
|
* </p>
|
|
4794
4885
|
* @public
|
|
4795
4886
|
*/
|
|
4796
|
-
dnsPolicy?: string;
|
|
4887
|
+
dnsPolicy?: string | undefined;
|
|
4797
4888
|
/**
|
|
4798
4889
|
* <p>Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain
|
|
4799
4890
|
* access to pull an images from a private registry.</p>
|
|
4800
4891
|
* @public
|
|
4801
4892
|
*/
|
|
4802
|
-
imagePullSecrets?: ImagePullSecret[];
|
|
4893
|
+
imagePullSecrets?: ImagePullSecret[] | undefined;
|
|
4803
4894
|
/**
|
|
4804
4895
|
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
4805
4896
|
* @public
|
|
4806
4897
|
*/
|
|
4807
|
-
containers?: EksContainerDetail[];
|
|
4898
|
+
containers?: EksContainerDetail[] | undefined;
|
|
4808
4899
|
/**
|
|
4809
4900
|
* <p>The container registered with the Amazon EKS Connector agent and persists the registration
|
|
4810
4901
|
* information in the Kubernetes backend data store.</p>
|
|
4811
4902
|
* @public
|
|
4812
4903
|
*/
|
|
4813
|
-
initContainers?: EksContainerDetail[];
|
|
4904
|
+
initContainers?: EksContainerDetail[] | undefined;
|
|
4814
4905
|
/**
|
|
4815
4906
|
* <p>Specifies the volumes for a job definition using Amazon EKS resources.</p>
|
|
4816
4907
|
* @public
|
|
4817
4908
|
*/
|
|
4818
|
-
volumes?: EksVolume[];
|
|
4909
|
+
volumes?: EksVolume[] | undefined;
|
|
4819
4910
|
/**
|
|
4820
4911
|
* <p>The name of the pod for this job.</p>
|
|
4821
4912
|
* @public
|
|
4822
4913
|
*/
|
|
4823
|
-
podName?: string;
|
|
4914
|
+
podName?: string | undefined;
|
|
4824
4915
|
/**
|
|
4825
4916
|
* <p>The name of the node for this job.</p>
|
|
4826
4917
|
* @public
|
|
4827
4918
|
*/
|
|
4828
|
-
nodeName?: string;
|
|
4919
|
+
nodeName?: string | undefined;
|
|
4829
4920
|
/**
|
|
4830
4921
|
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment that
|
|
4831
4922
|
* a pod runs in or the <code>jobID</code> for a job running in the pod. For more information, see
|
|
4832
4923
|
* <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes documentation</i>.</p>
|
|
4833
4924
|
* @public
|
|
4834
4925
|
*/
|
|
4835
|
-
metadata?: EksMetadata;
|
|
4926
|
+
metadata?: EksMetadata | undefined;
|
|
4836
4927
|
/**
|
|
4837
4928
|
* <p>Indicates if the processes in a container are shared, or visible, to other containers in the
|
|
4838
4929
|
* same pod. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/">Share
|
|
4839
4930
|
* Process Namespace between Containers in a Pod</a>.</p>
|
|
4840
4931
|
* @public
|
|
4841
4932
|
*/
|
|
4842
|
-
shareProcessNamespace?: boolean;
|
|
4933
|
+
shareProcessNamespace?: boolean | undefined;
|
|
4843
4934
|
}
|
|
4844
4935
|
/**
|
|
4845
4936
|
* <p>An object that contains the details for the Kubernetes resources of a job.</p>
|
|
@@ -4850,7 +4941,7 @@ export interface EksPropertiesDetail {
|
|
|
4850
4941
|
* <p>The properties for the Kubernetes pod resources of a job.</p>
|
|
4851
4942
|
* @public
|
|
4852
4943
|
*/
|
|
4853
|
-
podProperties?: EksPodPropertiesDetail;
|
|
4944
|
+
podProperties?: EksPodPropertiesDetail | undefined;
|
|
4854
4945
|
}
|
|
4855
4946
|
/**
|
|
4856
4947
|
* <p>An object that represents the details of a multi-node parallel job node.</p>
|
|
@@ -4862,12 +4953,12 @@ export interface NodeDetails {
|
|
|
4862
4953
|
* available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
|
|
4863
4954
|
* @public
|
|
4864
4955
|
*/
|
|
4865
|
-
nodeIndex?: number;
|
|
4956
|
+
nodeIndex?: number | undefined;
|
|
4866
4957
|
/**
|
|
4867
4958
|
* <p>Specifies whether the current node is the main node for a multi-node parallel job.</p>
|
|
4868
4959
|
* @public
|
|
4869
4960
|
*/
|
|
4870
|
-
isMainNode?: boolean;
|
|
4961
|
+
isMainNode?: boolean | undefined;
|
|
4871
4962
|
}
|
|
4872
4963
|
/**
|
|
4873
4964
|
* @public
|
|
@@ -4895,7 +4986,7 @@ export interface JobDetail {
|
|
|
4895
4986
|
* <p>The Amazon Resource Name (ARN) of the job.</p>
|
|
4896
4987
|
* @public
|
|
4897
4988
|
*/
|
|
4898
|
-
jobArn?: string;
|
|
4989
|
+
jobArn?: string | undefined;
|
|
4899
4990
|
/**
|
|
4900
4991
|
* <p>The job name.</p>
|
|
4901
4992
|
* @public
|
|
@@ -4925,19 +5016,19 @@ export interface JobDetail {
|
|
|
4925
5016
|
* <p>The share identifier for the job.</p>
|
|
4926
5017
|
* @public
|
|
4927
5018
|
*/
|
|
4928
|
-
shareIdentifier?: string;
|
|
5019
|
+
shareIdentifier?: string | undefined;
|
|
4929
5020
|
/**
|
|
4930
5021
|
* <p>The scheduling policy of the job definition. This only affects jobs in job queues with a
|
|
4931
5022
|
* fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
4932
5023
|
* scheduling priority.</p>
|
|
4933
5024
|
* @public
|
|
4934
5025
|
*/
|
|
4935
|
-
schedulingPriority?: number;
|
|
5026
|
+
schedulingPriority?: number | undefined;
|
|
4936
5027
|
/**
|
|
4937
5028
|
* <p>A list of job attempts that are associated with this job.</p>
|
|
4938
5029
|
* @public
|
|
4939
5030
|
*/
|
|
4940
|
-
attempts?: AttemptDetail[];
|
|
5031
|
+
attempts?: AttemptDetail[] | undefined;
|
|
4941
5032
|
/**
|
|
4942
5033
|
* <p>A short, human-readable string to provide more details for the current status of the
|
|
4943
5034
|
* job.</p>
|
|
@@ -4965,7 +5056,7 @@ export interface JobDetail {
|
|
|
4965
5056
|
* </ul>
|
|
4966
5057
|
* @public
|
|
4967
5058
|
*/
|
|
4968
|
-
statusReason?: string;
|
|
5059
|
+
statusReason?: string | undefined;
|
|
4969
5060
|
/**
|
|
4970
5061
|
* <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
|
|
4971
5062
|
* parent array jobs, this is when the job entered the <code>SUBMITTED</code> state. This is
|
|
@@ -4974,12 +5065,12 @@ export interface JobDetail {
|
|
|
4974
5065
|
* state.</p>
|
|
4975
5066
|
* @public
|
|
4976
5067
|
*/
|
|
4977
|
-
createdAt?: number;
|
|
5068
|
+
createdAt?: number | undefined;
|
|
4978
5069
|
/**
|
|
4979
5070
|
* <p>The retry strategy to use for this job if an attempt fails.</p>
|
|
4980
5071
|
* @public
|
|
4981
5072
|
*/
|
|
4982
|
-
retryStrategy?: RetryStrategy;
|
|
5073
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
4983
5074
|
/**
|
|
4984
5075
|
* <p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's
|
|
4985
5076
|
* when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.
|
|
@@ -4993,12 +5084,12 @@ export interface JobDetail {
|
|
|
4993
5084
|
* <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
4994
5085
|
* @public
|
|
4995
5086
|
*/
|
|
4996
|
-
stoppedAt?: number;
|
|
5087
|
+
stoppedAt?: number | undefined;
|
|
4997
5088
|
/**
|
|
4998
5089
|
* <p>A list of job IDs that this job depends on.</p>
|
|
4999
5090
|
* @public
|
|
5000
5091
|
*/
|
|
5001
|
-
dependsOn?: JobDependency[];
|
|
5092
|
+
dependsOn?: JobDependency[] | undefined;
|
|
5002
5093
|
/**
|
|
5003
5094
|
* <p>The Amazon Resource Name (ARN) of the job definition that this job uses.</p>
|
|
5004
5095
|
* @public
|
|
@@ -5009,19 +5100,19 @@ export interface JobDetail {
|
|
|
5009
5100
|
* placeholders or override any corresponding parameter defaults from the job definition.</p>
|
|
5010
5101
|
* @public
|
|
5011
5102
|
*/
|
|
5012
|
-
parameters?: Record<string, string
|
|
5103
|
+
parameters?: Record<string, string> | undefined;
|
|
5013
5104
|
/**
|
|
5014
5105
|
* <p>An object that represents the details for the container that's associated with the job. If
|
|
5015
5106
|
* the details are for a multiple-container job, this object will be empty. </p>
|
|
5016
5107
|
* @public
|
|
5017
5108
|
*/
|
|
5018
|
-
container?: ContainerDetail;
|
|
5109
|
+
container?: ContainerDetail | undefined;
|
|
5019
5110
|
/**
|
|
5020
5111
|
* <p>An object that represents the details of a node that's associated with a multi-node parallel
|
|
5021
5112
|
* job.</p>
|
|
5022
5113
|
* @public
|
|
5023
5114
|
*/
|
|
5024
|
-
nodeDetails?: NodeDetails;
|
|
5115
|
+
nodeDetails?: NodeDetails | undefined;
|
|
5025
5116
|
/**
|
|
5026
5117
|
* <p>An object that represents the node properties of a multi-node parallel job.</p>
|
|
5027
5118
|
* <note>
|
|
@@ -5029,22 +5120,22 @@ export interface JobDetail {
|
|
|
5029
5120
|
* </note>
|
|
5030
5121
|
* @public
|
|
5031
5122
|
*/
|
|
5032
|
-
nodeProperties?: NodeProperties;
|
|
5123
|
+
nodeProperties?: NodeProperties | undefined;
|
|
5033
5124
|
/**
|
|
5034
5125
|
* <p>The array properties of the job, if it's an array job.</p>
|
|
5035
5126
|
* @public
|
|
5036
5127
|
*/
|
|
5037
|
-
arrayProperties?: ArrayPropertiesDetail;
|
|
5128
|
+
arrayProperties?: ArrayPropertiesDetail | undefined;
|
|
5038
5129
|
/**
|
|
5039
5130
|
* <p>The timeout configuration for the job.</p>
|
|
5040
5131
|
* @public
|
|
5041
5132
|
*/
|
|
5042
|
-
timeout?: JobTimeout;
|
|
5133
|
+
timeout?: JobTimeout | undefined;
|
|
5043
5134
|
/**
|
|
5044
5135
|
* <p>The tags that are applied to the job.</p>
|
|
5045
5136
|
* @public
|
|
5046
5137
|
*/
|
|
5047
|
-
tags?: Record<string, string
|
|
5138
|
+
tags?: Record<string, string> | undefined;
|
|
5048
5139
|
/**
|
|
5049
5140
|
* <p>Specifies whether to propagate the tags from the job or job definition to the corresponding
|
|
5050
5141
|
* Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
|
|
@@ -5053,39 +5144,39 @@ export interface JobDetail {
|
|
|
5053
5144
|
* is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
5054
5145
|
* @public
|
|
5055
5146
|
*/
|
|
5056
|
-
propagateTags?: boolean;
|
|
5147
|
+
propagateTags?: boolean | undefined;
|
|
5057
5148
|
/**
|
|
5058
5149
|
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
5059
5150
|
* defaults to <code>EC2</code>. Jobs run on Fargate resources specify
|
|
5060
5151
|
* <code>FARGATE</code>.</p>
|
|
5061
5152
|
* @public
|
|
5062
5153
|
*/
|
|
5063
|
-
platformCapabilities?: PlatformCapability[];
|
|
5154
|
+
platformCapabilities?: PlatformCapability[] | undefined;
|
|
5064
5155
|
/**
|
|
5065
5156
|
* <p>An object with various properties that are specific to Amazon EKS based jobs. </p>
|
|
5066
5157
|
* @public
|
|
5067
5158
|
*/
|
|
5068
|
-
eksProperties?: EksPropertiesDetail;
|
|
5159
|
+
eksProperties?: EksPropertiesDetail | undefined;
|
|
5069
5160
|
/**
|
|
5070
5161
|
* <p>A list of job attempts that are associated with this job.</p>
|
|
5071
5162
|
* @public
|
|
5072
5163
|
*/
|
|
5073
|
-
eksAttempts?: EksAttemptDetail[];
|
|
5164
|
+
eksAttempts?: EksAttemptDetail[] | undefined;
|
|
5074
5165
|
/**
|
|
5075
5166
|
* <p>An object with properties that are specific to Amazon ECS-based jobs. </p>
|
|
5076
5167
|
* @public
|
|
5077
5168
|
*/
|
|
5078
|
-
ecsProperties?: EcsPropertiesDetail;
|
|
5169
|
+
ecsProperties?: EcsPropertiesDetail | undefined;
|
|
5079
5170
|
/**
|
|
5080
5171
|
* <p>Indicates whether the job is canceled.</p>
|
|
5081
5172
|
* @public
|
|
5082
5173
|
*/
|
|
5083
|
-
isCancelled?: boolean;
|
|
5174
|
+
isCancelled?: boolean | undefined;
|
|
5084
5175
|
/**
|
|
5085
5176
|
* <p>Indicates whether the job is terminated.</p>
|
|
5086
5177
|
* @public
|
|
5087
5178
|
*/
|
|
5088
|
-
isTerminated?: boolean;
|
|
5179
|
+
isTerminated?: boolean | undefined;
|
|
5089
5180
|
}
|
|
5090
5181
|
/**
|
|
5091
5182
|
* @public
|
|
@@ -5095,7 +5186,7 @@ export interface DescribeJobsResponse {
|
|
|
5095
5186
|
* <p>The list of jobs.</p>
|
|
5096
5187
|
* @public
|
|
5097
5188
|
*/
|
|
5098
|
-
jobs?: JobDetail[];
|
|
5189
|
+
jobs?: JobDetail[] | undefined;
|
|
5099
5190
|
}
|
|
5100
5191
|
/**
|
|
5101
5192
|
* <p>Contains the parameters for <code>DescribeSchedulingPolicies</code>.</p>
|
|
@@ -5129,14 +5220,14 @@ export interface SchedulingPolicyDetail {
|
|
|
5129
5220
|
* <p>The fair share policy for the scheduling policy.</p>
|
|
5130
5221
|
* @public
|
|
5131
5222
|
*/
|
|
5132
|
-
fairsharePolicy?: FairsharePolicy;
|
|
5223
|
+
fairsharePolicy?: FairsharePolicy | undefined;
|
|
5133
5224
|
/**
|
|
5134
5225
|
* <p>The tags that you apply to the scheduling policy to categorize and organize your resources.
|
|
5135
5226
|
* Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
|
|
5136
5227
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
5137
5228
|
* @public
|
|
5138
5229
|
*/
|
|
5139
|
-
tags?: Record<string, string
|
|
5230
|
+
tags?: Record<string, string> | undefined;
|
|
5140
5231
|
}
|
|
5141
5232
|
/**
|
|
5142
5233
|
* @public
|
|
@@ -5146,7 +5237,7 @@ export interface DescribeSchedulingPoliciesResponse {
|
|
|
5146
5237
|
* <p>The list of scheduling policies.</p>
|
|
5147
5238
|
* @public
|
|
5148
5239
|
*/
|
|
5149
|
-
schedulingPolicies?: SchedulingPolicyDetail[];
|
|
5240
|
+
schedulingPolicies?: SchedulingPolicyDetail[] | undefined;
|
|
5150
5241
|
}
|
|
5151
5242
|
/**
|
|
5152
5243
|
* @public
|
|
@@ -5167,12 +5258,12 @@ export interface FrontOfQueueJobSummary {
|
|
|
5167
5258
|
* <p>The ARN for a job in a named job queue.</p>
|
|
5168
5259
|
* @public
|
|
5169
5260
|
*/
|
|
5170
|
-
jobArn?: string;
|
|
5261
|
+
jobArn?: string | undefined;
|
|
5171
5262
|
/**
|
|
5172
5263
|
* <p>The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.</p>
|
|
5173
5264
|
* @public
|
|
5174
5265
|
*/
|
|
5175
|
-
earliestTimeAtPosition?: number;
|
|
5266
|
+
earliestTimeAtPosition?: number | undefined;
|
|
5176
5267
|
}
|
|
5177
5268
|
/**
|
|
5178
5269
|
* <p>Contains a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
|
|
@@ -5183,12 +5274,12 @@ export interface FrontOfQueueDetail {
|
|
|
5183
5274
|
* <p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
|
|
5184
5275
|
* @public
|
|
5185
5276
|
*/
|
|
5186
|
-
jobs?: FrontOfQueueJobSummary[];
|
|
5277
|
+
jobs?: FrontOfQueueJobSummary[] | undefined;
|
|
5187
5278
|
/**
|
|
5188
5279
|
* <p>The Unix timestamp (in milliseconds) for when each of the first 100 <code>RUNNABLE</code> jobs were last updated. </p>
|
|
5189
5280
|
* @public
|
|
5190
5281
|
*/
|
|
5191
|
-
lastUpdatedAt?: number;
|
|
5282
|
+
lastUpdatedAt?: number | undefined;
|
|
5192
5283
|
}
|
|
5193
5284
|
/**
|
|
5194
5285
|
* @public
|
|
@@ -5198,7 +5289,7 @@ export interface GetJobQueueSnapshotResponse {
|
|
|
5198
5289
|
* <p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
|
|
5199
5290
|
* @public
|
|
5200
5291
|
*/
|
|
5201
|
-
frontOfQueue?: FrontOfQueueDetail;
|
|
5292
|
+
frontOfQueue?: FrontOfQueueDetail | undefined;
|
|
5202
5293
|
}
|
|
5203
5294
|
/**
|
|
5204
5295
|
* <p>A filter name and value pair that's used to return a more specific list of results from a
|
|
@@ -5210,12 +5301,12 @@ export interface KeyValuesPair {
|
|
|
5210
5301
|
* <p>The name of the filter. Filter names are case sensitive.</p>
|
|
5211
5302
|
* @public
|
|
5212
5303
|
*/
|
|
5213
|
-
name?: string;
|
|
5304
|
+
name?: string | undefined;
|
|
5214
5305
|
/**
|
|
5215
5306
|
* <p>The filter values.</p>
|
|
5216
5307
|
* @public
|
|
5217
5308
|
*/
|
|
5218
|
-
values?: string[];
|
|
5309
|
+
values?: string[] | undefined;
|
|
5219
5310
|
}
|
|
5220
5311
|
/**
|
|
5221
5312
|
* <p>Contains the parameters for <code>ListJobs</code>.</p>
|
|
@@ -5226,19 +5317,19 @@ export interface ListJobsRequest {
|
|
|
5226
5317
|
* <p>The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.</p>
|
|
5227
5318
|
* @public
|
|
5228
5319
|
*/
|
|
5229
|
-
jobQueue?: string;
|
|
5320
|
+
jobQueue?: string | undefined;
|
|
5230
5321
|
/**
|
|
5231
5322
|
* <p>The job ID for an array job. Specifying an array job ID with this parameter lists all
|
|
5232
5323
|
* child jobs from within the specified array.</p>
|
|
5233
5324
|
* @public
|
|
5234
5325
|
*/
|
|
5235
|
-
arrayJobId?: string;
|
|
5326
|
+
arrayJobId?: string | undefined;
|
|
5236
5327
|
/**
|
|
5237
5328
|
* <p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with
|
|
5238
5329
|
* this parameter lists all nodes that are associated with the specified job.</p>
|
|
5239
5330
|
* @public
|
|
5240
5331
|
*/
|
|
5241
|
-
multiNodeJobId?: string;
|
|
5332
|
+
multiNodeJobId?: string | undefined;
|
|
5242
5333
|
/**
|
|
5243
5334
|
* <p>The job status used to filter jobs in the specified queue. If the <code>filters</code>
|
|
5244
5335
|
* parameter is specified, the <code>jobStatus</code> parameter is ignored and jobs with any
|
|
@@ -5246,7 +5337,7 @@ export interface ListJobsRequest {
|
|
|
5246
5337
|
* returned.</p>
|
|
5247
5338
|
* @public
|
|
5248
5339
|
*/
|
|
5249
|
-
jobStatus?: JobStatus;
|
|
5340
|
+
jobStatus?: JobStatus | undefined;
|
|
5250
5341
|
/**
|
|
5251
5342
|
* <p>The maximum number of results returned by <code>ListJobs</code> in a paginated output. When this parameter is used, <code>ListJobs</code> returns up to <code>maxResults</code> results in a single page and a <code>nextToken</code> response element, if applicable. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value.</p>
|
|
5252
5343
|
* <p>The following outlines key parameters and limitations:</p>
|
|
@@ -5267,7 +5358,7 @@ export interface ListJobsRequest {
|
|
|
5267
5358
|
* </ul>
|
|
5268
5359
|
* @public
|
|
5269
5360
|
*/
|
|
5270
|
-
maxResults?: number;
|
|
5361
|
+
maxResults?: number | undefined;
|
|
5271
5362
|
/**
|
|
5272
5363
|
* <p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code>
|
|
5273
5364
|
* request where <code>maxResults</code> was used and the results exceeded the value of that
|
|
@@ -5280,7 +5371,7 @@ export interface ListJobsRequest {
|
|
|
5280
5371
|
* </note>
|
|
5281
5372
|
* @public
|
|
5282
5373
|
*/
|
|
5283
|
-
nextToken?: string;
|
|
5374
|
+
nextToken?: string | undefined;
|
|
5284
5375
|
/**
|
|
5285
5376
|
* <p>The filter to apply to the query. Only one filter can be used at a time. When the filter
|
|
5286
5377
|
* is used, <code>jobStatus</code> is ignored. The filter doesn't apply to child jobs in an array
|
|
@@ -5327,7 +5418,7 @@ export interface ListJobsRequest {
|
|
|
5327
5418
|
* </dl>
|
|
5328
5419
|
* @public
|
|
5329
5420
|
*/
|
|
5330
|
-
filters?: KeyValuesPair[];
|
|
5421
|
+
filters?: KeyValuesPair[] | undefined;
|
|
5331
5422
|
}
|
|
5332
5423
|
/**
|
|
5333
5424
|
* <p>An object that represents summary details of a container within a job.</p>
|
|
@@ -5338,13 +5429,13 @@ export interface ContainerSummary {
|
|
|
5338
5429
|
* <p>The exit code to return upon completion.</p>
|
|
5339
5430
|
* @public
|
|
5340
5431
|
*/
|
|
5341
|
-
exitCode?: number;
|
|
5432
|
+
exitCode?: number | undefined;
|
|
5342
5433
|
/**
|
|
5343
5434
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
5344
5435
|
* running or stopped container.</p>
|
|
5345
5436
|
* @public
|
|
5346
5437
|
*/
|
|
5347
|
-
reason?: string;
|
|
5438
|
+
reason?: string | undefined;
|
|
5348
5439
|
}
|
|
5349
5440
|
/**
|
|
5350
5441
|
* <p>An object that represents the properties of a node that's associated with a multi-node
|
|
@@ -5356,18 +5447,18 @@ export interface NodePropertiesSummary {
|
|
|
5356
5447
|
* <p>Specifies whether the current node is the main node for a multi-node parallel job.</p>
|
|
5357
5448
|
* @public
|
|
5358
5449
|
*/
|
|
5359
|
-
isMainNode?: boolean;
|
|
5450
|
+
isMainNode?: boolean | undefined;
|
|
5360
5451
|
/**
|
|
5361
5452
|
* <p>The number of nodes that are associated with a multi-node parallel job.</p>
|
|
5362
5453
|
* @public
|
|
5363
5454
|
*/
|
|
5364
|
-
numNodes?: number;
|
|
5455
|
+
numNodes?: number | undefined;
|
|
5365
5456
|
/**
|
|
5366
5457
|
* <p>The node index for the node. Node index numbering begins at zero. This index is also
|
|
5367
5458
|
* available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
|
|
5368
5459
|
* @public
|
|
5369
5460
|
*/
|
|
5370
|
-
nodeIndex?: number;
|
|
5461
|
+
nodeIndex?: number | undefined;
|
|
5371
5462
|
}
|
|
5372
5463
|
/**
|
|
5373
5464
|
* <p>An object that represents summary details of a job.</p>
|
|
@@ -5378,7 +5469,7 @@ export interface JobSummary {
|
|
|
5378
5469
|
* <p>The Amazon Resource Name (ARN) of the job.</p>
|
|
5379
5470
|
* @public
|
|
5380
5471
|
*/
|
|
5381
|
-
jobArn?: string;
|
|
5472
|
+
jobArn?: string | undefined;
|
|
5382
5473
|
/**
|
|
5383
5474
|
* <p>The job ID.</p>
|
|
5384
5475
|
* @public
|
|
@@ -5397,42 +5488,42 @@ export interface JobSummary {
|
|
|
5397
5488
|
* entered the <code>PENDING</code> state.</p>
|
|
5398
5489
|
* @public
|
|
5399
5490
|
*/
|
|
5400
|
-
createdAt?: number;
|
|
5491
|
+
createdAt?: number | undefined;
|
|
5401
5492
|
/**
|
|
5402
5493
|
* <p>The current status for the job.</p>
|
|
5403
5494
|
* @public
|
|
5404
5495
|
*/
|
|
5405
|
-
status?: JobStatus;
|
|
5496
|
+
status?: JobStatus | undefined;
|
|
5406
5497
|
/**
|
|
5407
5498
|
* <p>A short, human-readable string to provide more details for the current status of the
|
|
5408
5499
|
* job.</p>
|
|
5409
5500
|
* @public
|
|
5410
5501
|
*/
|
|
5411
|
-
statusReason?: string;
|
|
5502
|
+
statusReason?: string | undefined;
|
|
5412
5503
|
/**
|
|
5413
5504
|
* <p>The Unix timestamp for when the job was started. More specifically, it's when the job
|
|
5414
5505
|
* transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.</p>
|
|
5415
5506
|
* @public
|
|
5416
5507
|
*/
|
|
5417
|
-
startedAt?: number;
|
|
5508
|
+
startedAt?: number | undefined;
|
|
5418
5509
|
/**
|
|
5419
5510
|
* <p>The Unix timestamp for when the job was stopped. More specifically, it's when the job
|
|
5420
5511
|
* transitioned from the <code>RUNNING</code> state to a terminal state, such as
|
|
5421
5512
|
* <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
5422
5513
|
* @public
|
|
5423
5514
|
*/
|
|
5424
|
-
stoppedAt?: number;
|
|
5515
|
+
stoppedAt?: number | undefined;
|
|
5425
5516
|
/**
|
|
5426
5517
|
* <p>An object that represents the details of the container that's associated with the
|
|
5427
5518
|
* job.</p>
|
|
5428
5519
|
* @public
|
|
5429
5520
|
*/
|
|
5430
|
-
container?: ContainerSummary;
|
|
5521
|
+
container?: ContainerSummary | undefined;
|
|
5431
5522
|
/**
|
|
5432
5523
|
* <p>The array properties of the job, if it's an array job.</p>
|
|
5433
5524
|
* @public
|
|
5434
5525
|
*/
|
|
5435
|
-
arrayProperties?: ArrayPropertiesSummary;
|
|
5526
|
+
arrayProperties?: ArrayPropertiesSummary | undefined;
|
|
5436
5527
|
/**
|
|
5437
5528
|
* <p>The node properties for a single node in a job summary list.</p>
|
|
5438
5529
|
* <note>
|
|
@@ -5440,12 +5531,12 @@ export interface JobSummary {
|
|
|
5440
5531
|
* </note>
|
|
5441
5532
|
* @public
|
|
5442
5533
|
*/
|
|
5443
|
-
nodeProperties?: NodePropertiesSummary;
|
|
5534
|
+
nodeProperties?: NodePropertiesSummary | undefined;
|
|
5444
5535
|
/**
|
|
5445
5536
|
* <p>The Amazon Resource Name (ARN) of the job definition.</p>
|
|
5446
5537
|
* @public
|
|
5447
5538
|
*/
|
|
5448
|
-
jobDefinition?: string;
|
|
5539
|
+
jobDefinition?: string | undefined;
|
|
5449
5540
|
}
|
|
5450
5541
|
/**
|
|
5451
5542
|
* @public
|
|
@@ -5463,7 +5554,7 @@ export interface ListJobsResponse {
|
|
|
5463
5554
|
* are no more results to return.</p>
|
|
5464
5555
|
* @public
|
|
5465
5556
|
*/
|
|
5466
|
-
nextToken?: string;
|
|
5557
|
+
nextToken?: string | undefined;
|
|
5467
5558
|
}
|
|
5468
5559
|
/**
|
|
5469
5560
|
* <p>Contains the parameters for <code>ListSchedulingPolicies</code>.</p>
|
|
@@ -5481,7 +5572,7 @@ export interface ListSchedulingPoliciesRequest {
|
|
|
5481
5572
|
* <code>nextToken</code> value if applicable.</p>
|
|
5482
5573
|
* @public
|
|
5483
5574
|
*/
|
|
5484
|
-
maxResults?: number;
|
|
5575
|
+
maxResults?: number | undefined;
|
|
5485
5576
|
/**
|
|
5486
5577
|
* <p>The <code>nextToken</code> value that's returned from a previous paginated
|
|
5487
5578
|
* <code>ListSchedulingPolicies</code> request where <code>maxResults</code> was used and the
|
|
@@ -5494,7 +5585,7 @@ export interface ListSchedulingPoliciesRequest {
|
|
|
5494
5585
|
* </note>
|
|
5495
5586
|
* @public
|
|
5496
5587
|
*/
|
|
5497
|
-
nextToken?: string;
|
|
5588
|
+
nextToken?: string | undefined;
|
|
5498
5589
|
}
|
|
5499
5590
|
/**
|
|
5500
5591
|
* <p>An object that contains the details of a scheduling policy that's returned in a
|
|
@@ -5516,7 +5607,7 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
5516
5607
|
* <p>A list of scheduling policies that match the request.</p>
|
|
5517
5608
|
* @public
|
|
5518
5609
|
*/
|
|
5519
|
-
schedulingPolicies?: SchedulingPolicyListingDetail[];
|
|
5610
|
+
schedulingPolicies?: SchedulingPolicyListingDetail[] | undefined;
|
|
5520
5611
|
/**
|
|
5521
5612
|
* <p>The <code>nextToken</code> value to include in a future
|
|
5522
5613
|
* <code>ListSchedulingPolicies</code> request. When the results of a
|
|
@@ -5525,7 +5616,7 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
5525
5616
|
* no more results to return.</p>
|
|
5526
5617
|
* @public
|
|
5527
5618
|
*/
|
|
5528
|
-
nextToken?: string;
|
|
5619
|
+
nextToken?: string | undefined;
|
|
5529
5620
|
}
|
|
5530
5621
|
/**
|
|
5531
5622
|
* <p>Contains the parameters for <code>ListTagsForResource</code>.</p>
|
|
@@ -5547,7 +5638,7 @@ export interface ListTagsForResourceResponse {
|
|
|
5547
5638
|
* <p>The tags for the resource.</p>
|
|
5548
5639
|
* @public
|
|
5549
5640
|
*/
|
|
5550
|
-
tags?: Record<string, string
|
|
5641
|
+
tags?: Record<string, string> | undefined;
|
|
5551
5642
|
}
|
|
5552
5643
|
/**
|
|
5553
5644
|
* @public
|
|
@@ -5596,7 +5687,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5596
5687
|
* any corresponding parameter defaults from the job definition.</p>
|
|
5597
5688
|
* @public
|
|
5598
5689
|
*/
|
|
5599
|
-
parameters?: Record<string, string
|
|
5690
|
+
parameters?: Record<string, string> | undefined;
|
|
5600
5691
|
/**
|
|
5601
5692
|
* <p>The scheduling priority for jobs that are submitted with this job definition. This only
|
|
5602
5693
|
* affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority
|
|
@@ -5604,7 +5695,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5604
5695
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
5605
5696
|
* @public
|
|
5606
5697
|
*/
|
|
5607
|
-
schedulingPriority?: number;
|
|
5698
|
+
schedulingPriority?: number | undefined;
|
|
5608
5699
|
/**
|
|
5609
5700
|
* <p>An object with properties specific to Amazon ECS-based single-node container-based jobs. If the
|
|
5610
5701
|
* job definition's <code>type</code> parameter is <code>container</code>, then you must specify
|
|
@@ -5616,7 +5707,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5616
5707
|
* </note>
|
|
5617
5708
|
* @public
|
|
5618
5709
|
*/
|
|
5619
|
-
containerProperties?: ContainerProperties;
|
|
5710
|
+
containerProperties?: ContainerProperties | undefined;
|
|
5620
5711
|
/**
|
|
5621
5712
|
* <p>An object with properties specific to multi-node parallel jobs. If you specify node
|
|
5622
5713
|
* properties for a job, it becomes a multi-node parallel job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html">Multi-node Parallel
|
|
@@ -5631,14 +5722,14 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5631
5722
|
* </note>
|
|
5632
5723
|
* @public
|
|
5633
5724
|
*/
|
|
5634
|
-
nodeProperties?: NodeProperties;
|
|
5725
|
+
nodeProperties?: NodeProperties | undefined;
|
|
5635
5726
|
/**
|
|
5636
5727
|
* <p>The retry strategy to use for failed jobs that are submitted with this job definition. Any
|
|
5637
5728
|
* retry strategy that's specified during a <a>SubmitJob</a> operation overrides the
|
|
5638
5729
|
* retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.</p>
|
|
5639
5730
|
* @public
|
|
5640
5731
|
*/
|
|
5641
|
-
retryStrategy?: RetryStrategy;
|
|
5732
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
5642
5733
|
/**
|
|
5643
5734
|
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
5644
5735
|
* corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only
|
|
@@ -5651,7 +5742,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5651
5742
|
* </note>
|
|
5652
5743
|
* @public
|
|
5653
5744
|
*/
|
|
5654
|
-
propagateTags?: boolean;
|
|
5745
|
+
propagateTags?: boolean | undefined;
|
|
5655
5746
|
/**
|
|
5656
5747
|
* <p>The timeout configuration for jobs that are submitted with this job definition, after
|
|
5657
5748
|
* which Batch terminates your jobs if they have not finished. If a job is terminated due to a
|
|
@@ -5661,14 +5752,14 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5661
5752
|
* <i>Batch User Guide</i>.</p>
|
|
5662
5753
|
* @public
|
|
5663
5754
|
*/
|
|
5664
|
-
timeout?: JobTimeout;
|
|
5755
|
+
timeout?: JobTimeout | undefined;
|
|
5665
5756
|
/**
|
|
5666
5757
|
* <p>The tags that you apply to the job definition to help you categorize and organize your
|
|
5667
5758
|
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging Amazon Web Services Resources</a> in
|
|
5668
5759
|
* <i>Batch User Guide</i>.</p>
|
|
5669
5760
|
* @public
|
|
5670
5761
|
*/
|
|
5671
|
-
tags?: Record<string, string
|
|
5762
|
+
tags?: Record<string, string> | undefined;
|
|
5672
5763
|
/**
|
|
5673
5764
|
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
5674
5765
|
* defaults to <code>EC2</code>. To run the job on Fargate resources, specify
|
|
@@ -5679,19 +5770,19 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5679
5770
|
* </note>
|
|
5680
5771
|
* @public
|
|
5681
5772
|
*/
|
|
5682
|
-
platformCapabilities?: PlatformCapability[];
|
|
5773
|
+
platformCapabilities?: PlatformCapability[] | undefined;
|
|
5683
5774
|
/**
|
|
5684
5775
|
* <p>An object with properties that are specific to Amazon EKS-based jobs. This must not be
|
|
5685
5776
|
* specified for Amazon ECS based job definitions.</p>
|
|
5686
5777
|
* @public
|
|
5687
5778
|
*/
|
|
5688
|
-
eksProperties?: EksProperties;
|
|
5779
|
+
eksProperties?: EksProperties | undefined;
|
|
5689
5780
|
/**
|
|
5690
5781
|
* <p>An object with properties that are specific to Amazon ECS-based jobs. This must not be
|
|
5691
5782
|
* specified for Amazon EKS-based job definitions.</p>
|
|
5692
5783
|
* @public
|
|
5693
5784
|
*/
|
|
5694
|
-
ecsProperties?: EcsProperties;
|
|
5785
|
+
ecsProperties?: EcsProperties | undefined;
|
|
5695
5786
|
}
|
|
5696
5787
|
/**
|
|
5697
5788
|
* @public
|
|
@@ -5735,7 +5826,7 @@ export interface ContainerOverrides {
|
|
|
5735
5826
|
* definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
5736
5827
|
* @public
|
|
5737
5828
|
*/
|
|
5738
|
-
vcpus?: number;
|
|
5829
|
+
vcpus?: number | undefined;
|
|
5739
5830
|
/**
|
|
5740
5831
|
* @deprecated
|
|
5741
5832
|
*
|
|
@@ -5751,7 +5842,7 @@ export interface ContainerOverrides {
|
|
|
5751
5842
|
* definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
5752
5843
|
* @public
|
|
5753
5844
|
*/
|
|
5754
|
-
memory?: number;
|
|
5845
|
+
memory?: number | undefined;
|
|
5755
5846
|
/**
|
|
5756
5847
|
* <p>The command to send to the container that overrides the default command from the Docker
|
|
5757
5848
|
* image or the job definition.</p>
|
|
@@ -5760,7 +5851,7 @@ export interface ContainerOverrides {
|
|
|
5760
5851
|
* </note>
|
|
5761
5852
|
* @public
|
|
5762
5853
|
*/
|
|
5763
|
-
command?: string[];
|
|
5854
|
+
command?: string[] | undefined;
|
|
5764
5855
|
/**
|
|
5765
5856
|
* <p>The instance type to use for a multi-node parallel job.</p>
|
|
5766
5857
|
* <note>
|
|
@@ -5769,7 +5860,7 @@ export interface ContainerOverrides {
|
|
|
5769
5860
|
* </note>
|
|
5770
5861
|
* @public
|
|
5771
5862
|
*/
|
|
5772
|
-
instanceType?: string;
|
|
5863
|
+
instanceType?: string | undefined;
|
|
5773
5864
|
/**
|
|
5774
5865
|
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5775
5866
|
* which are added to the container at launch, or you can override the existing environment
|
|
@@ -5780,14 +5871,14 @@ export interface ContainerOverrides {
|
|
|
5780
5871
|
* </note>
|
|
5781
5872
|
* @public
|
|
5782
5873
|
*/
|
|
5783
|
-
environment?: KeyValuePair[];
|
|
5874
|
+
environment?: KeyValuePair[] | undefined;
|
|
5784
5875
|
/**
|
|
5785
5876
|
* <p>The type and amount of resources to assign to a container. This overrides the settings in
|
|
5786
5877
|
* the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and
|
|
5787
5878
|
* <code>VCPU</code>.</p>
|
|
5788
5879
|
* @public
|
|
5789
5880
|
*/
|
|
5790
|
-
resourceRequirements?: ResourceRequirement[];
|
|
5881
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
5791
5882
|
}
|
|
5792
5883
|
/**
|
|
5793
5884
|
* <p>The overrides that should be sent to a container.</p>
|
|
@@ -5804,7 +5895,7 @@ export interface TaskContainerOverrides {
|
|
|
5804
5895
|
* </note>
|
|
5805
5896
|
* @public
|
|
5806
5897
|
*/
|
|
5807
|
-
command?: string[];
|
|
5898
|
+
command?: string[] | undefined;
|
|
5808
5899
|
/**
|
|
5809
5900
|
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5810
5901
|
* which are added to the container at launch, or you can override the existing environment
|
|
@@ -5815,20 +5906,20 @@ export interface TaskContainerOverrides {
|
|
|
5815
5906
|
* </note>
|
|
5816
5907
|
* @public
|
|
5817
5908
|
*/
|
|
5818
|
-
environment?: KeyValuePair[];
|
|
5909
|
+
environment?: KeyValuePair[] | undefined;
|
|
5819
5910
|
/**
|
|
5820
5911
|
* <p>A pointer to the container that you want to override. The container's name provides a unique
|
|
5821
5912
|
* identifier for the container being used.</p>
|
|
5822
5913
|
* @public
|
|
5823
5914
|
*/
|
|
5824
|
-
name?: string;
|
|
5915
|
+
name?: string | undefined;
|
|
5825
5916
|
/**
|
|
5826
5917
|
* <p>The type and amount of resources to assign to a container. This overrides the settings in
|
|
5827
5918
|
* the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and
|
|
5828
5919
|
* <code>VCPU</code>.</p>
|
|
5829
5920
|
* @public
|
|
5830
5921
|
*/
|
|
5831
|
-
resourceRequirements?: ResourceRequirement[];
|
|
5922
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
5832
5923
|
}
|
|
5833
5924
|
/**
|
|
5834
5925
|
* <p>An object that contains overrides for the task definition of a job.</p>
|
|
@@ -5839,7 +5930,7 @@ export interface TaskPropertiesOverride {
|
|
|
5839
5930
|
* <p>The overrides for the container definition of a job.</p>
|
|
5840
5931
|
* @public
|
|
5841
5932
|
*/
|
|
5842
|
-
containers?: TaskContainerOverrides[];
|
|
5933
|
+
containers?: TaskContainerOverrides[] | undefined;
|
|
5843
5934
|
}
|
|
5844
5935
|
/**
|
|
5845
5936
|
* <p>An object that contains overrides for the Amazon ECS task definition of a job.</p>
|
|
@@ -5853,7 +5944,7 @@ export interface EcsPropertiesOverride {
|
|
|
5853
5944
|
* </note>
|
|
5854
5945
|
* @public
|
|
5855
5946
|
*/
|
|
5856
|
-
taskProperties?: TaskPropertiesOverride[];
|
|
5947
|
+
taskProperties?: TaskPropertiesOverride[] | undefined;
|
|
5857
5948
|
}
|
|
5858
5949
|
/**
|
|
5859
5950
|
* <p>Object representing any Kubernetes overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
|
|
@@ -5866,18 +5957,18 @@ export interface EksContainerOverride {
|
|
|
5866
5957
|
* name that you wish to override.</p>
|
|
5867
5958
|
* @public
|
|
5868
5959
|
*/
|
|
5869
|
-
name?: string;
|
|
5960
|
+
name?: string | undefined;
|
|
5870
5961
|
/**
|
|
5871
5962
|
* <p>The override of the Docker image that's used to start the container.</p>
|
|
5872
5963
|
* @public
|
|
5873
5964
|
*/
|
|
5874
|
-
image?: string;
|
|
5965
|
+
image?: string | undefined;
|
|
5875
5966
|
/**
|
|
5876
5967
|
* <p>The command to send to the container that overrides the default command from the Docker
|
|
5877
5968
|
* image or the job definition.</p>
|
|
5878
5969
|
* @public
|
|
5879
5970
|
*/
|
|
5880
|
-
command?: string[];
|
|
5971
|
+
command?: string[] | undefined;
|
|
5881
5972
|
/**
|
|
5882
5973
|
* <p>The arguments to the entrypoint to send to the container that overrides the default
|
|
5883
5974
|
* arguments from the Docker image or the job definition. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">Dockerfile reference: CMD</a>
|
|
@@ -5885,7 +5976,7 @@ export interface EksContainerOverride {
|
|
|
5885
5976
|
* documentation</i>.</p>
|
|
5886
5977
|
* @public
|
|
5887
5978
|
*/
|
|
5888
|
-
args?: string[];
|
|
5979
|
+
args?: string[] | undefined;
|
|
5889
5980
|
/**
|
|
5890
5981
|
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5891
5982
|
* which are added to the container at launch. Or, you can override the existing environment
|
|
@@ -5896,7 +5987,7 @@ export interface EksContainerOverride {
|
|
|
5896
5987
|
* </note>
|
|
5897
5988
|
* @public
|
|
5898
5989
|
*/
|
|
5899
|
-
env?: EksContainerEnvironmentVariable[];
|
|
5990
|
+
env?: EksContainerEnvironmentVariable[] | undefined;
|
|
5900
5991
|
/**
|
|
5901
5992
|
* <p>The type and amount of resources to assign to a container. These override the settings in
|
|
5902
5993
|
* the job definition. The supported resources include <code>memory</code>, <code>cpu</code>, and
|
|
@@ -5905,7 +5996,7 @@ export interface EksContainerOverride {
|
|
|
5905
5996
|
* documentation</i>.</p>
|
|
5906
5997
|
* @public
|
|
5907
5998
|
*/
|
|
5908
|
-
resources?: EksContainerResourceRequirements;
|
|
5999
|
+
resources?: EksContainerResourceRequirements | undefined;
|
|
5909
6000
|
}
|
|
5910
6001
|
/**
|
|
5911
6002
|
* <p>An object that contains overrides for the Kubernetes pod properties of a job.</p>
|
|
@@ -5916,7 +6007,7 @@ export interface EksPodPropertiesOverride {
|
|
|
5916
6007
|
* <p>The overrides for the container that's used on the Amazon EKS pod.</p>
|
|
5917
6008
|
* @public
|
|
5918
6009
|
*/
|
|
5919
|
-
containers?: EksContainerOverride[];
|
|
6010
|
+
containers?: EksContainerOverride[] | undefined;
|
|
5920
6011
|
/**
|
|
5921
6012
|
* <p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before
|
|
5922
6013
|
* application containers, always runs to completion, and must complete successfully before the next
|
|
@@ -5925,13 +6016,13 @@ export interface EksPodPropertiesOverride {
|
|
|
5925
6016
|
* Containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
5926
6017
|
* @public
|
|
5927
6018
|
*/
|
|
5928
|
-
initContainers?: EksContainerOverride[];
|
|
6019
|
+
initContainers?: EksContainerOverride[] | undefined;
|
|
5929
6020
|
/**
|
|
5930
6021
|
* <p>Metadata about the
|
|
5931
6022
|
* overrides for the container that's used on the Amazon EKS pod.</p>
|
|
5932
6023
|
* @public
|
|
5933
6024
|
*/
|
|
5934
|
-
metadata?: EksMetadata;
|
|
6025
|
+
metadata?: EksMetadata | undefined;
|
|
5935
6026
|
}
|
|
5936
6027
|
/**
|
|
5937
6028
|
* <p>An object that contains overrides for the Kubernetes resources of a job.</p>
|
|
@@ -5942,7 +6033,7 @@ export interface EksPropertiesOverride {
|
|
|
5942
6033
|
* <p>The overrides for the Kubernetes pod resources of a job.</p>
|
|
5943
6034
|
* @public
|
|
5944
6035
|
*/
|
|
5945
|
-
podProperties?: EksPodPropertiesOverride;
|
|
6036
|
+
podProperties?: EksPodPropertiesOverride | undefined;
|
|
5946
6037
|
}
|
|
5947
6038
|
/**
|
|
5948
6039
|
* <p>The object that represents any node overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
|
|
@@ -5963,24 +6054,24 @@ export interface NodePropertyOverride {
|
|
|
5963
6054
|
* <p>The overrides that are sent to a node range.</p>
|
|
5964
6055
|
* @public
|
|
5965
6056
|
*/
|
|
5966
|
-
containerOverrides?: ContainerOverrides;
|
|
6057
|
+
containerOverrides?: ContainerOverrides | undefined;
|
|
5967
6058
|
/**
|
|
5968
6059
|
* <p>An object that contains the properties that you want to replace for the existing Amazon ECS
|
|
5969
6060
|
* resources of a job.</p>
|
|
5970
6061
|
* @public
|
|
5971
6062
|
*/
|
|
5972
|
-
ecsPropertiesOverride?: EcsPropertiesOverride;
|
|
6063
|
+
ecsPropertiesOverride?: EcsPropertiesOverride | undefined;
|
|
5973
6064
|
/**
|
|
5974
6065
|
* <p>An object that contains the instance types that you want to replace for the existing
|
|
5975
6066
|
* resources of a job.</p>
|
|
5976
6067
|
* @public
|
|
5977
6068
|
*/
|
|
5978
|
-
instanceTypes?: string[];
|
|
6069
|
+
instanceTypes?: string[] | undefined;
|
|
5979
6070
|
/**
|
|
5980
6071
|
* <p>An object that contains the properties that you want to replace for the existing Amazon EKS resources of a job.</p>
|
|
5981
6072
|
* @public
|
|
5982
6073
|
*/
|
|
5983
|
-
eksPropertiesOverride?: EksPropertiesOverride;
|
|
6074
|
+
eksPropertiesOverride?: EksPropertiesOverride | undefined;
|
|
5984
6075
|
}
|
|
5985
6076
|
/**
|
|
5986
6077
|
* <p>An object that represents any node overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
|
|
@@ -6012,12 +6103,12 @@ export interface NodeOverrides {
|
|
|
6012
6103
|
* </ul>
|
|
6013
6104
|
* @public
|
|
6014
6105
|
*/
|
|
6015
|
-
numNodes?: number;
|
|
6106
|
+
numNodes?: number | undefined;
|
|
6016
6107
|
/**
|
|
6017
6108
|
* <p>The node property overrides for the job.</p>
|
|
6018
6109
|
* @public
|
|
6019
6110
|
*/
|
|
6020
|
-
nodePropertyOverrides?: NodePropertyOverride[];
|
|
6111
|
+
nodePropertyOverrides?: NodePropertyOverride[] | undefined;
|
|
6021
6112
|
}
|
|
6022
6113
|
/**
|
|
6023
6114
|
* <p>Contains the parameters for <code>SubmitJob</code>.</p>
|
|
@@ -6045,7 +6136,7 @@ export interface SubmitJobRequest {
|
|
|
6045
6136
|
* (*).</p>
|
|
6046
6137
|
* @public
|
|
6047
6138
|
*/
|
|
6048
|
-
shareIdentifier?: string;
|
|
6139
|
+
shareIdentifier?: string | undefined;
|
|
6049
6140
|
/**
|
|
6050
6141
|
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair
|
|
6051
6142
|
* share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
@@ -6056,14 +6147,14 @@ export interface SubmitJobRequest {
|
|
|
6056
6147
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
6057
6148
|
* @public
|
|
6058
6149
|
*/
|
|
6059
|
-
schedulingPriorityOverride?: number;
|
|
6150
|
+
schedulingPriorityOverride?: number | undefined;
|
|
6060
6151
|
/**
|
|
6061
6152
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
6062
6153
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
6063
6154
|
* job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html">Array Jobs</a> in the <i>Batch User Guide</i>.</p>
|
|
6064
6155
|
* @public
|
|
6065
6156
|
*/
|
|
6066
|
-
arrayProperties?: ArrayProperties;
|
|
6157
|
+
arrayProperties?: ArrayProperties | undefined;
|
|
6067
6158
|
/**
|
|
6068
6159
|
* <p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can
|
|
6069
6160
|
* specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs
|
|
@@ -6073,7 +6164,7 @@ export interface SubmitJobRequest {
|
|
|
6073
6164
|
* before it can begin.</p>
|
|
6074
6165
|
* @public
|
|
6075
6166
|
*/
|
|
6076
|
-
dependsOn?: JobDependency[];
|
|
6167
|
+
dependsOn?: JobDependency[] | undefined;
|
|
6077
6168
|
/**
|
|
6078
6169
|
* <p>The job definition used by this job. This value can be one of
|
|
6079
6170
|
* <code>definition-name</code>, <code>definition-name:revision</code>, or the Amazon Resource Name (ARN) for the
|
|
@@ -6094,7 +6185,7 @@ export interface SubmitJobRequest {
|
|
|
6094
6185
|
* from the job definition.</p>
|
|
6095
6186
|
* @public
|
|
6096
6187
|
*/
|
|
6097
|
-
parameters?: Record<string, string
|
|
6188
|
+
parameters?: Record<string, string> | undefined;
|
|
6098
6189
|
/**
|
|
6099
6190
|
* <p>An object with properties that override the defaults for the job definition that specify
|
|
6100
6191
|
* the name of a container in the specified job definition and the overrides it should receive.
|
|
@@ -6104,7 +6195,7 @@ export interface SubmitJobRequest {
|
|
|
6104
6195
|
* <code>environment</code> override.</p>
|
|
6105
6196
|
* @public
|
|
6106
6197
|
*/
|
|
6107
|
-
containerOverrides?: ContainerOverrides;
|
|
6198
|
+
containerOverrides?: ContainerOverrides | undefined;
|
|
6108
6199
|
/**
|
|
6109
6200
|
* <p>A list of node overrides in JSON format that specify the node range to target and the
|
|
6110
6201
|
* container overrides for that node range.</p>
|
|
@@ -6114,14 +6205,14 @@ export interface SubmitJobRequest {
|
|
|
6114
6205
|
* </note>
|
|
6115
6206
|
* @public
|
|
6116
6207
|
*/
|
|
6117
|
-
nodeOverrides?: NodeOverrides;
|
|
6208
|
+
nodeOverrides?: NodeOverrides | undefined;
|
|
6118
6209
|
/**
|
|
6119
6210
|
* <p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation.
|
|
6120
6211
|
* When a retry strategy is specified here, it overrides the retry strategy defined in the job
|
|
6121
6212
|
* definition.</p>
|
|
6122
6213
|
* @public
|
|
6123
6214
|
*/
|
|
6124
|
-
retryStrategy?: RetryStrategy;
|
|
6215
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
6125
6216
|
/**
|
|
6126
6217
|
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
6127
6218
|
* corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only
|
|
@@ -6131,7 +6222,7 @@ export interface SubmitJobRequest {
|
|
|
6131
6222
|
* specified, this overrides the tag propagation setting in the job definition.</p>
|
|
6132
6223
|
* @public
|
|
6133
6224
|
*/
|
|
6134
|
-
propagateTags?: boolean;
|
|
6225
|
+
propagateTags?: boolean | undefined;
|
|
6135
6226
|
/**
|
|
6136
6227
|
* <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify
|
|
6137
6228
|
* a timeout duration after which Batch terminates your jobs if they haven't finished. If a job
|
|
@@ -6142,24 +6233,24 @@ export interface SubmitJobRequest {
|
|
|
6142
6233
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6143
6234
|
* @public
|
|
6144
6235
|
*/
|
|
6145
|
-
timeout?: JobTimeout;
|
|
6236
|
+
timeout?: JobTimeout | undefined;
|
|
6146
6237
|
/**
|
|
6147
6238
|
* <p>The tags that you apply to the job request to help you categorize and organize your
|
|
6148
6239
|
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
6149
6240
|
* Resources</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
6150
6241
|
* @public
|
|
6151
6242
|
*/
|
|
6152
|
-
tags?: Record<string, string
|
|
6243
|
+
tags?: Record<string, string> | undefined;
|
|
6153
6244
|
/**
|
|
6154
6245
|
* <p>An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.</p>
|
|
6155
6246
|
* @public
|
|
6156
6247
|
*/
|
|
6157
|
-
eksPropertiesOverride?: EksPropertiesOverride;
|
|
6248
|
+
eksPropertiesOverride?: EksPropertiesOverride | undefined;
|
|
6158
6249
|
/**
|
|
6159
6250
|
* <p>An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.</p>
|
|
6160
6251
|
* @public
|
|
6161
6252
|
*/
|
|
6162
|
-
ecsPropertiesOverride?: EcsPropertiesOverride;
|
|
6253
|
+
ecsPropertiesOverride?: EcsPropertiesOverride | undefined;
|
|
6163
6254
|
}
|
|
6164
6255
|
/**
|
|
6165
6256
|
* @public
|
|
@@ -6169,7 +6260,7 @@ export interface SubmitJobResponse {
|
|
|
6169
6260
|
* <p>The Amazon Resource Name (ARN) for the job.</p>
|
|
6170
6261
|
* @public
|
|
6171
6262
|
*/
|
|
6172
|
-
jobArn?: string;
|
|
6263
|
+
jobArn?: string | undefined;
|
|
6173
6264
|
/**
|
|
6174
6265
|
* <p>The name of the job.</p>
|
|
6175
6266
|
* @public
|
|
@@ -6280,7 +6371,7 @@ export interface ComputeResourceUpdate {
|
|
|
6280
6371
|
* </note>
|
|
6281
6372
|
* @public
|
|
6282
6373
|
*/
|
|
6283
|
-
minvCpus?: number;
|
|
6374
|
+
minvCpus?: number | undefined;
|
|
6284
6375
|
/**
|
|
6285
6376
|
* <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
|
|
6286
6377
|
* <note>
|
|
@@ -6293,7 +6384,7 @@ export interface ComputeResourceUpdate {
|
|
|
6293
6384
|
* </note>
|
|
6294
6385
|
* @public
|
|
6295
6386
|
*/
|
|
6296
|
-
maxvCpus?: number;
|
|
6387
|
+
maxvCpus?: number | undefined;
|
|
6297
6388
|
/**
|
|
6298
6389
|
* <p>The desired number of
|
|
6299
6390
|
* vCPUS in the
|
|
@@ -6315,7 +6406,7 @@ export interface ComputeResourceUpdate {
|
|
|
6315
6406
|
* </note>
|
|
6316
6407
|
* @public
|
|
6317
6408
|
*/
|
|
6318
|
-
desiredvCpus?: number;
|
|
6409
|
+
desiredvCpus?: number | undefined;
|
|
6319
6410
|
/**
|
|
6320
6411
|
* <p>The VPC subnets where the compute resources are launched. Fargate compute resources can
|
|
6321
6412
|
* contain up to 16 subnets. For Fargate compute resources, providing an empty list will be
|
|
@@ -6336,7 +6427,7 @@ export interface ComputeResourceUpdate {
|
|
|
6336
6427
|
* </note>
|
|
6337
6428
|
* @public
|
|
6338
6429
|
*/
|
|
6339
|
-
subnets?: string[];
|
|
6430
|
+
subnets?: string[] | undefined;
|
|
6340
6431
|
/**
|
|
6341
6432
|
* <p>The Amazon EC2 security groups that are associated with instances launched in the compute
|
|
6342
6433
|
* environment. This parameter is required for Fargate compute resources, where it can contain up
|
|
@@ -6348,7 +6439,7 @@ export interface ComputeResourceUpdate {
|
|
|
6348
6439
|
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
6349
6440
|
* @public
|
|
6350
6441
|
*/
|
|
6351
|
-
securityGroupIds?: string[];
|
|
6442
|
+
securityGroupIds?: string[] | undefined;
|
|
6352
6443
|
/**
|
|
6353
6444
|
* <p>The allocation strategy to use for the compute resource if there's not enough instances of
|
|
6354
6445
|
* the best fitting instance type that can be allocated. This might be because of availability of
|
|
@@ -6392,7 +6483,7 @@ export interface ComputeResourceUpdate {
|
|
|
6392
6483
|
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
6393
6484
|
* @public
|
|
6394
6485
|
*/
|
|
6395
|
-
allocationStrategy?: CRUpdateAllocationStrategy;
|
|
6486
|
+
allocationStrategy?: CRUpdateAllocationStrategy | undefined;
|
|
6396
6487
|
/**
|
|
6397
6488
|
* <p>The instances types that can be launched. You can specify instance families to launch any
|
|
6398
6489
|
* instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
|
|
@@ -6417,7 +6508,7 @@ export interface ComputeResourceUpdate {
|
|
|
6417
6508
|
* </note>
|
|
6418
6509
|
* @public
|
|
6419
6510
|
*/
|
|
6420
|
-
instanceTypes?: string[];
|
|
6511
|
+
instanceTypes?: string[] | undefined;
|
|
6421
6512
|
/**
|
|
6422
6513
|
* <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
|
|
6423
6514
|
* use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this
|
|
@@ -6430,7 +6521,7 @@ export interface ComputeResourceUpdate {
|
|
|
6430
6521
|
* </note>
|
|
6431
6522
|
* @public
|
|
6432
6523
|
*/
|
|
6433
|
-
ec2KeyPair?: string;
|
|
6524
|
+
ec2KeyPair?: string | undefined;
|
|
6434
6525
|
/**
|
|
6435
6526
|
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
|
6436
6527
|
* Required for Amazon EC2
|
|
@@ -6449,7 +6540,7 @@ export interface ComputeResourceUpdate {
|
|
|
6449
6540
|
* </note>
|
|
6450
6541
|
* @public
|
|
6451
6542
|
*/
|
|
6452
|
-
instanceRole?: string;
|
|
6543
|
+
instanceRole?: string | undefined;
|
|
6453
6544
|
/**
|
|
6454
6545
|
* <p>Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
|
|
6455
6546
|
* environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
|
|
@@ -6465,7 +6556,7 @@ export interface ComputeResourceUpdate {
|
|
|
6465
6556
|
* </note>
|
|
6466
6557
|
* @public
|
|
6467
6558
|
*/
|
|
6468
|
-
tags?: Record<string, string
|
|
6559
|
+
tags?: Record<string, string> | undefined;
|
|
6469
6560
|
/**
|
|
6470
6561
|
* <p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit
|
|
6471
6562
|
* multi-node parallel jobs to your compute environment, you should consider creating a cluster
|
|
@@ -6481,7 +6572,7 @@ export interface ComputeResourceUpdate {
|
|
|
6481
6572
|
* </note>
|
|
6482
6573
|
* @public
|
|
6483
6574
|
*/
|
|
6484
|
-
placementGroup?: string;
|
|
6575
|
+
placementGroup?: string | undefined;
|
|
6485
6576
|
/**
|
|
6486
6577
|
* <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand
|
|
6487
6578
|
* price for that instance type before instances are launched. For example, if your maximum
|
|
@@ -6497,7 +6588,7 @@ export interface ComputeResourceUpdate {
|
|
|
6497
6588
|
* </note>
|
|
6498
6589
|
* @public
|
|
6499
6590
|
*/
|
|
6500
|
-
bidPercentage?: number;
|
|
6591
|
+
bidPercentage?: number | undefined;
|
|
6501
6592
|
/**
|
|
6502
6593
|
* <p>The updated launch template to use for your compute resources. You must specify either the
|
|
6503
6594
|
* launch template ID or launch template name in the request, but not both. For more information,
|
|
@@ -6516,7 +6607,7 @@ export interface ComputeResourceUpdate {
|
|
|
6516
6607
|
* </note>
|
|
6517
6608
|
* @public
|
|
6518
6609
|
*/
|
|
6519
|
-
launchTemplate?: LaunchTemplateSpecification;
|
|
6610
|
+
launchTemplate?: LaunchTemplateSpecification | undefined;
|
|
6520
6611
|
/**
|
|
6521
6612
|
* <p>Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the
|
|
6522
6613
|
* compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
@@ -6531,7 +6622,7 @@ export interface ComputeResourceUpdate {
|
|
|
6531
6622
|
* </note>
|
|
6532
6623
|
* @public
|
|
6533
6624
|
*/
|
|
6534
|
-
ec2Configuration?: Ec2Configuration[];
|
|
6625
|
+
ec2Configuration?: Ec2Configuration[] | undefined;
|
|
6535
6626
|
/**
|
|
6536
6627
|
* <p>Specifies whether the AMI ID is updated to the latest one that's supported by Batch when
|
|
6537
6628
|
* the compute environment has an infrastructure update. The default value is
|
|
@@ -6549,7 +6640,7 @@ export interface ComputeResourceUpdate {
|
|
|
6549
6640
|
* <i>Batch User Guide</i>.</p>
|
|
6550
6641
|
* @public
|
|
6551
6642
|
*/
|
|
6552
|
-
updateToLatestImageVersion?: boolean;
|
|
6643
|
+
updateToLatestImageVersion?: boolean | undefined;
|
|
6553
6644
|
/**
|
|
6554
6645
|
* <p>The type of compute environment: <code>EC2</code>, <code>SPOT</code>, <code>FARGATE</code>,
|
|
6555
6646
|
* or <code>FARGATE_SPOT</code>. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the
|
|
@@ -6562,7 +6653,7 @@ export interface ComputeResourceUpdate {
|
|
|
6562
6653
|
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
6563
6654
|
* @public
|
|
6564
6655
|
*/
|
|
6565
|
-
type?: CRType;
|
|
6656
|
+
type?: CRType | undefined;
|
|
6566
6657
|
/**
|
|
6567
6658
|
* <p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
|
|
6568
6659
|
* This parameter is overridden by the <code>imageIdOverride</code> member of the
|
|
@@ -6584,7 +6675,7 @@ export interface ComputeResourceUpdate {
|
|
|
6584
6675
|
* </note>
|
|
6585
6676
|
* @public
|
|
6586
6677
|
*/
|
|
6587
|
-
imageId?: string;
|
|
6678
|
+
imageId?: string | undefined;
|
|
6588
6679
|
}
|
|
6589
6680
|
/**
|
|
6590
6681
|
* <p>Contains the parameters for <code>UpdateComputeEnvironment</code>.</p>
|
|
@@ -6620,7 +6711,7 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
6620
6711
|
* instance.</p>
|
|
6621
6712
|
* @public
|
|
6622
6713
|
*/
|
|
6623
|
-
state?: CEState;
|
|
6714
|
+
state?: CEState | undefined;
|
|
6624
6715
|
/**
|
|
6625
6716
|
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
|
6626
6717
|
* Don't specify this parameter for a managed compute environment. This parameter is only used
|
|
@@ -6628,14 +6719,14 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
6628
6719
|
* parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>
|
|
6629
6720
|
* @public
|
|
6630
6721
|
*/
|
|
6631
|
-
unmanagedvCpus?: number;
|
|
6722
|
+
unmanagedvCpus?: number | undefined;
|
|
6632
6723
|
/**
|
|
6633
6724
|
* <p>Details of the compute resources managed by the compute environment. Required for a
|
|
6634
6725
|
* managed compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a> in the
|
|
6635
6726
|
* <i>Batch User Guide</i>.</p>
|
|
6636
6727
|
* @public
|
|
6637
6728
|
*/
|
|
6638
|
-
computeResources?: ComputeResourceUpdate;
|
|
6729
|
+
computeResources?: ComputeResourceUpdate | undefined;
|
|
6639
6730
|
/**
|
|
6640
6731
|
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
6641
6732
|
* services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the
|
|
@@ -6659,19 +6750,19 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
6659
6750
|
* </note>
|
|
6660
6751
|
* @public
|
|
6661
6752
|
*/
|
|
6662
|
-
serviceRole?: string;
|
|
6753
|
+
serviceRole?: string | undefined;
|
|
6663
6754
|
/**
|
|
6664
6755
|
* <p>Specifies the updated infrastructure update policy for the compute environment. For more
|
|
6665
6756
|
* information about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in
|
|
6666
6757
|
* the <i>Batch User Guide</i>.</p>
|
|
6667
6758
|
* @public
|
|
6668
6759
|
*/
|
|
6669
|
-
updatePolicy?: UpdatePolicy;
|
|
6760
|
+
updatePolicy?: UpdatePolicy | undefined;
|
|
6670
6761
|
/**
|
|
6671
6762
|
* <p>Reserved.</p>
|
|
6672
6763
|
* @public
|
|
6673
6764
|
*/
|
|
6674
|
-
context?: string;
|
|
6765
|
+
context?: string | undefined;
|
|
6675
6766
|
}
|
|
6676
6767
|
/**
|
|
6677
6768
|
* @public
|
|
@@ -6682,12 +6773,12 @@ export interface UpdateComputeEnvironmentResponse {
|
|
|
6682
6773
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
6683
6774
|
* @public
|
|
6684
6775
|
*/
|
|
6685
|
-
computeEnvironmentName?: string;
|
|
6776
|
+
computeEnvironmentName?: string | undefined;
|
|
6686
6777
|
/**
|
|
6687
6778
|
* <p>The Amazon Resource Name (ARN) of the compute environment.</p>
|
|
6688
6779
|
* @public
|
|
6689
6780
|
*/
|
|
6690
|
-
computeEnvironmentArn?: string;
|
|
6781
|
+
computeEnvironmentArn?: string | undefined;
|
|
6691
6782
|
}
|
|
6692
6783
|
/**
|
|
6693
6784
|
* <p>Contains the parameters for <code>UpdateJobQueue</code>.</p>
|
|
@@ -6705,7 +6796,7 @@ export interface UpdateJobQueueRequest {
|
|
|
6705
6796
|
* new jobs can't be added to the queue, but jobs already in the queue can finish.</p>
|
|
6706
6797
|
* @public
|
|
6707
6798
|
*/
|
|
6708
|
-
state?: JQState;
|
|
6799
|
+
state?: JQState | undefined;
|
|
6709
6800
|
/**
|
|
6710
6801
|
* <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
|
|
6711
6802
|
* scheduling policy can be replaced but not removed. The format is
|
|
@@ -6715,7 +6806,7 @@ export interface UpdateJobQueueRequest {
|
|
|
6715
6806
|
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
6716
6807
|
* @public
|
|
6717
6808
|
*/
|
|
6718
|
-
schedulingPolicyArn?: string;
|
|
6809
|
+
schedulingPolicyArn?: string | undefined;
|
|
6719
6810
|
/**
|
|
6720
6811
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
6721
6812
|
* value for the <code>priority</code> parameter) are evaluated first when associated with the
|
|
@@ -6726,7 +6817,7 @@ export interface UpdateJobQueueRequest {
|
|
|
6726
6817
|
* <code>FARGATE_SPOT</code>). EC2 and Fargate compute environments can't be mixed.</p>
|
|
6727
6818
|
* @public
|
|
6728
6819
|
*/
|
|
6729
|
-
priority?: number;
|
|
6820
|
+
priority?: number | undefined;
|
|
6730
6821
|
/**
|
|
6731
6822
|
* <p>Details the set of compute environments mapped to a job queue and their order relative to
|
|
6732
6823
|
* each other. This is one of the parameters used by the job scheduler to determine which compute
|
|
@@ -6741,12 +6832,12 @@ export interface UpdateJobQueueRequest {
|
|
|
6741
6832
|
* </note>
|
|
6742
6833
|
* @public
|
|
6743
6834
|
*/
|
|
6744
|
-
computeEnvironmentOrder?: ComputeEnvironmentOrder[];
|
|
6835
|
+
computeEnvironmentOrder?: ComputeEnvironmentOrder[] | undefined;
|
|
6745
6836
|
/**
|
|
6746
6837
|
* <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed. (<b>Note</b>: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)</p>
|
|
6747
6838
|
* @public
|
|
6748
6839
|
*/
|
|
6749
|
-
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
|
|
6840
|
+
jobStateTimeLimitActions?: JobStateTimeLimitAction[] | undefined;
|
|
6750
6841
|
}
|
|
6751
6842
|
/**
|
|
6752
6843
|
* @public
|
|
@@ -6756,12 +6847,12 @@ export interface UpdateJobQueueResponse {
|
|
|
6756
6847
|
* <p>The name of the job queue.</p>
|
|
6757
6848
|
* @public
|
|
6758
6849
|
*/
|
|
6759
|
-
jobQueueName?: string;
|
|
6850
|
+
jobQueueName?: string | undefined;
|
|
6760
6851
|
/**
|
|
6761
6852
|
* <p>The Amazon Resource Name (ARN) of the job queue.</p>
|
|
6762
6853
|
* @public
|
|
6763
6854
|
*/
|
|
6764
|
-
jobQueueArn?: string;
|
|
6855
|
+
jobQueueArn?: string | undefined;
|
|
6765
6856
|
}
|
|
6766
6857
|
/**
|
|
6767
6858
|
* <p>Contains the parameters for <code>UpdateSchedulingPolicy</code>.</p>
|
|
@@ -6777,7 +6868,7 @@ export interface UpdateSchedulingPolicyRequest {
|
|
|
6777
6868
|
* <p>The fair share policy.</p>
|
|
6778
6869
|
* @public
|
|
6779
6870
|
*/
|
|
6780
|
-
fairsharePolicy?: FairsharePolicy;
|
|
6871
|
+
fairsharePolicy?: FairsharePolicy | undefined;
|
|
6781
6872
|
}
|
|
6782
6873
|
/**
|
|
6783
6874
|
* @public
|