@aws-sdk/client-batch 3.688.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/models/models_0.d.ts +499 -499
- package/dist-types/ts3.4/models/models_0.d.ts +499 -499
- 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,13 @@ 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
394
|
}
|
|
395
395
|
/**
|
|
396
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
|
|
@@ -415,14 +415,14 @@ export interface LaunchTemplateSpecificationOverride {
|
|
|
415
415
|
* <b>Note:</b> If you specify the <code>launchTemplateId</code> you can't specify the <code>launchTemplateName</code> as well.</p>
|
|
416
416
|
* @public
|
|
417
417
|
*/
|
|
418
|
-
launchTemplateId?: string;
|
|
418
|
+
launchTemplateId?: string | undefined;
|
|
419
419
|
/**
|
|
420
420
|
* <p>The name of the launch template.</p>
|
|
421
421
|
* <p>
|
|
422
422
|
* <b>Note:</b> If you specify the <code>launchTemplateName</code> you can't specify the <code>launchTemplateId</code> as well.</p>
|
|
423
423
|
* @public
|
|
424
424
|
*/
|
|
425
|
-
launchTemplateName?: string;
|
|
425
|
+
launchTemplateName?: string | undefined;
|
|
426
426
|
/**
|
|
427
427
|
* <p>The version number of the launch template,
|
|
428
428
|
* <code>$Default</code>, or <code>$Latest</code>.</p>
|
|
@@ -444,7 +444,7 @@ export interface LaunchTemplateSpecificationOverride {
|
|
|
444
444
|
* </p>
|
|
445
445
|
* @public
|
|
446
446
|
*/
|
|
447
|
-
version?: string;
|
|
447
|
+
version?: string | undefined;
|
|
448
448
|
/**
|
|
449
449
|
* <p>The instance type or family that this this override launch template should be applied to.</p>
|
|
450
450
|
* <p>This parameter is required when defining a launch template override.</p>
|
|
@@ -470,7 +470,7 @@ export interface LaunchTemplateSpecificationOverride {
|
|
|
470
470
|
* </ul>
|
|
471
471
|
* @public
|
|
472
472
|
*/
|
|
473
|
-
targetInstanceTypes?: string[];
|
|
473
|
+
targetInstanceTypes?: string[] | undefined;
|
|
474
474
|
}
|
|
475
475
|
/**
|
|
476
476
|
* <p>An object that represents a launch template that's associated with a compute resource. You
|
|
@@ -490,12 +490,12 @@ export interface LaunchTemplateSpecification {
|
|
|
490
490
|
* <p>The ID of the launch template.</p>
|
|
491
491
|
* @public
|
|
492
492
|
*/
|
|
493
|
-
launchTemplateId?: string;
|
|
493
|
+
launchTemplateId?: string | undefined;
|
|
494
494
|
/**
|
|
495
495
|
* <p>The name of the launch template.</p>
|
|
496
496
|
* @public
|
|
497
497
|
*/
|
|
498
|
-
launchTemplateName?: string;
|
|
498
|
+
launchTemplateName?: string | undefined;
|
|
499
499
|
/**
|
|
500
500
|
* <p>The version number of the launch template,
|
|
501
501
|
* <code>$Default</code>, or <code>$Latest</code>.</p>
|
|
@@ -518,7 +518,7 @@ export interface LaunchTemplateSpecification {
|
|
|
518
518
|
* </p>
|
|
519
519
|
* @public
|
|
520
520
|
*/
|
|
521
|
-
version?: string;
|
|
521
|
+
version?: string | undefined;
|
|
522
522
|
/**
|
|
523
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
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>
|
|
@@ -527,7 +527,7 @@ export interface LaunchTemplateSpecification {
|
|
|
527
527
|
* </note>
|
|
528
528
|
* @public
|
|
529
529
|
*/
|
|
530
|
-
overrides?: LaunchTemplateSpecificationOverride[];
|
|
530
|
+
overrides?: LaunchTemplateSpecificationOverride[] | undefined;
|
|
531
531
|
}
|
|
532
532
|
/**
|
|
533
533
|
* @public
|
|
@@ -611,7 +611,7 @@ export interface ComputeResource {
|
|
|
611
611
|
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
612
612
|
* @public
|
|
613
613
|
*/
|
|
614
|
-
allocationStrategy?: CRAllocationStrategy;
|
|
614
|
+
allocationStrategy?: CRAllocationStrategy | undefined;
|
|
615
615
|
/**
|
|
616
616
|
* <p>The minimum number of
|
|
617
617
|
* vCPUs that
|
|
@@ -623,7 +623,7 @@ export interface ComputeResource {
|
|
|
623
623
|
* </note>
|
|
624
624
|
* @public
|
|
625
625
|
*/
|
|
626
|
-
minvCpus?: number;
|
|
626
|
+
minvCpus?: number | undefined;
|
|
627
627
|
/**
|
|
628
628
|
* <p>The maximum number of
|
|
629
629
|
* vCPUs that a
|
|
@@ -650,7 +650,7 @@ export interface ComputeResource {
|
|
|
650
650
|
* </note>
|
|
651
651
|
* @public
|
|
652
652
|
*/
|
|
653
|
-
desiredvCpus?: number;
|
|
653
|
+
desiredvCpus?: number | undefined;
|
|
654
654
|
/**
|
|
655
655
|
* <p>The instances types that can be launched. You can specify instance families to launch any
|
|
656
656
|
* instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
|
|
@@ -672,7 +672,7 @@ export interface ComputeResource {
|
|
|
672
672
|
* </note>
|
|
673
673
|
* @public
|
|
674
674
|
*/
|
|
675
|
-
instanceTypes?: string[];
|
|
675
|
+
instanceTypes?: string[] | undefined;
|
|
676
676
|
/**
|
|
677
677
|
* @deprecated
|
|
678
678
|
*
|
|
@@ -692,7 +692,7 @@ export interface ComputeResource {
|
|
|
692
692
|
* </note>
|
|
693
693
|
* @public
|
|
694
694
|
*/
|
|
695
|
-
imageId?: string;
|
|
695
|
+
imageId?: string | undefined;
|
|
696
696
|
/**
|
|
697
697
|
* <p>The VPC subnets where the compute resources are launched. These subnets must be within the
|
|
698
698
|
* same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see
|
|
@@ -719,7 +719,7 @@ export interface ComputeResource {
|
|
|
719
719
|
* <code>launchTemplate</code>, the values in <code>securityGroupIds</code> are used.</p>
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
722
|
-
securityGroupIds?: string[];
|
|
722
|
+
securityGroupIds?: string[] | undefined;
|
|
723
723
|
/**
|
|
724
724
|
* <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
|
|
725
725
|
* use this key pair to log in to your instances with SSH.</p>
|
|
@@ -728,7 +728,7 @@ export interface ComputeResource {
|
|
|
728
728
|
* </note>
|
|
729
729
|
* @public
|
|
730
730
|
*/
|
|
731
|
-
ec2KeyPair?: string;
|
|
731
|
+
ec2KeyPair?: string | undefined;
|
|
732
732
|
/**
|
|
733
733
|
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This
|
|
734
734
|
* parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)
|
|
@@ -743,7 +743,7 @@ export interface ComputeResource {
|
|
|
743
743
|
* </note>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
instanceRole?: string;
|
|
746
|
+
instanceRole?: string | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
|
|
749
749
|
* environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
|
|
@@ -758,7 +758,7 @@ export interface ComputeResource {
|
|
|
758
758
|
* </note>
|
|
759
759
|
* @public
|
|
760
760
|
*/
|
|
761
|
-
tags?: Record<string, string
|
|
761
|
+
tags?: Record<string, string> | undefined;
|
|
762
762
|
/**
|
|
763
763
|
* <p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit
|
|
764
764
|
* multi-node parallel jobs to your compute environment, you should consider creating a cluster
|
|
@@ -771,7 +771,7 @@ export interface ComputeResource {
|
|
|
771
771
|
* </note>
|
|
772
772
|
* @public
|
|
773
773
|
*/
|
|
774
|
-
placementGroup?: string;
|
|
774
|
+
placementGroup?: string | undefined;
|
|
775
775
|
/**
|
|
776
776
|
* <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand
|
|
777
777
|
* price for that instance type before instances are launched. For example, if your maximum
|
|
@@ -785,7 +785,7 @@ export interface ComputeResource {
|
|
|
785
785
|
* </note>
|
|
786
786
|
* @public
|
|
787
787
|
*/
|
|
788
|
-
bidPercentage?: number;
|
|
788
|
+
bidPercentage?: number | undefined;
|
|
789
789
|
/**
|
|
790
790
|
* <p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute
|
|
791
791
|
* environment. This role is required if the allocation strategy set to <code>BEST_FIT</code> or if
|
|
@@ -803,7 +803,7 @@ export interface ComputeResource {
|
|
|
803
803
|
* </important>
|
|
804
804
|
* @public
|
|
805
805
|
*/
|
|
806
|
-
spotIamFleetRole?: string;
|
|
806
|
+
spotIamFleetRole?: string | undefined;
|
|
807
807
|
/**
|
|
808
808
|
* <p>The launch template to use for your compute resources. Any other compute resource parameters
|
|
809
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
|
|
@@ -815,7 +815,7 @@ export interface ComputeResource {
|
|
|
815
815
|
* </note>
|
|
816
816
|
* @public
|
|
817
817
|
*/
|
|
818
|
-
launchTemplate?: LaunchTemplateSpecification;
|
|
818
|
+
launchTemplate?: LaunchTemplateSpecification | undefined;
|
|
819
819
|
/**
|
|
820
820
|
* <p>Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances
|
|
821
821
|
* in the compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
@@ -826,7 +826,7 @@ export interface ComputeResource {
|
|
|
826
826
|
* </note>
|
|
827
827
|
* @public
|
|
828
828
|
*/
|
|
829
|
-
ec2Configuration?: Ec2Configuration[];
|
|
829
|
+
ec2Configuration?: Ec2Configuration[] | undefined;
|
|
830
830
|
}
|
|
831
831
|
/**
|
|
832
832
|
* <p>Configuration for the Amazon EKS cluster that supports the Batch compute environment. The
|
|
@@ -916,7 +916,7 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
916
916
|
* instance.</p>
|
|
917
917
|
* @public
|
|
918
918
|
*/
|
|
919
|
-
state?: CEState;
|
|
919
|
+
state?: CEState | undefined;
|
|
920
920
|
/**
|
|
921
921
|
* <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only
|
|
922
922
|
* used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this
|
|
@@ -927,14 +927,14 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
927
927
|
* </note>
|
|
928
928
|
* @public
|
|
929
929
|
*/
|
|
930
|
-
unmanagedvCpus?: number;
|
|
930
|
+
unmanagedvCpus?: number | undefined;
|
|
931
931
|
/**
|
|
932
932
|
* <p>Details about the compute resources managed by the compute environment. This parameter is
|
|
933
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>
|
|
934
934
|
* in the <i>Batch User Guide</i>.</p>
|
|
935
935
|
* @public
|
|
936
936
|
*/
|
|
937
|
-
computeResources?: ComputeResource;
|
|
937
|
+
computeResources?: ComputeResource | undefined;
|
|
938
938
|
/**
|
|
939
939
|
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
940
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
|
|
@@ -959,7 +959,7 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
959
959
|
* </note>
|
|
960
960
|
* @public
|
|
961
961
|
*/
|
|
962
|
-
serviceRole?: string;
|
|
962
|
+
serviceRole?: string | undefined;
|
|
963
963
|
/**
|
|
964
964
|
* <p>The tags that you apply to the compute environment to help you categorize and organize
|
|
965
965
|
* your resources. Each tag consists of a key and an optional value. For more information, see
|
|
@@ -969,17 +969,17 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
969
969
|
* resources.</p>
|
|
970
970
|
* @public
|
|
971
971
|
*/
|
|
972
|
-
tags?: Record<string, string
|
|
972
|
+
tags?: Record<string, string> | undefined;
|
|
973
973
|
/**
|
|
974
974
|
* <p>The details for the Amazon EKS cluster that supports the compute environment.</p>
|
|
975
975
|
* @public
|
|
976
976
|
*/
|
|
977
|
-
eksConfiguration?: EksConfiguration;
|
|
977
|
+
eksConfiguration?: EksConfiguration | undefined;
|
|
978
978
|
/**
|
|
979
979
|
* <p>Reserved.</p>
|
|
980
980
|
* @public
|
|
981
981
|
*/
|
|
982
|
-
context?: string;
|
|
982
|
+
context?: string | undefined;
|
|
983
983
|
}
|
|
984
984
|
/**
|
|
985
985
|
* @public
|
|
@@ -990,12 +990,12 @@ export interface CreateComputeEnvironmentResponse {
|
|
|
990
990
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
991
991
|
* @public
|
|
992
992
|
*/
|
|
993
|
-
computeEnvironmentName?: string;
|
|
993
|
+
computeEnvironmentName?: string | undefined;
|
|
994
994
|
/**
|
|
995
995
|
* <p>The Amazon Resource Name (ARN) of the compute environment.</p>
|
|
996
996
|
* @public
|
|
997
997
|
*/
|
|
998
|
-
computeEnvironmentArn?: string;
|
|
998
|
+
computeEnvironmentArn?: string | undefined;
|
|
999
999
|
}
|
|
1000
1000
|
/**
|
|
1001
1001
|
* <p>The order that compute environments are tried in for job placement within a queue. Compute
|
|
@@ -1105,7 +1105,7 @@ export interface CreateJobQueueRequest {
|
|
|
1105
1105
|
* queue, but jobs already in the queue can finish.</p>
|
|
1106
1106
|
* @public
|
|
1107
1107
|
*/
|
|
1108
|
-
state?: JQState;
|
|
1108
|
+
state?: JQState | undefined;
|
|
1109
1109
|
/**
|
|
1110
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>
|
|
1111
1111
|
* <p>The format is
|
|
@@ -1116,7 +1116,7 @@ export interface CreateJobQueueRequest {
|
|
|
1116
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>
|
|
1117
1117
|
* @public
|
|
1118
1118
|
*/
|
|
1119
|
-
schedulingPolicyArn?: string;
|
|
1119
|
+
schedulingPolicyArn?: string | undefined;
|
|
1120
1120
|
/**
|
|
1121
1121
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
1122
1122
|
* value for the <code>priority</code> parameter) are evaluated first when associated with the
|
|
@@ -1150,12 +1150,12 @@ export interface CreateJobQueueRequest {
|
|
|
1150
1150
|
* in <i>Batch User Guide</i>.</p>
|
|
1151
1151
|
* @public
|
|
1152
1152
|
*/
|
|
1153
|
-
tags?: Record<string, string
|
|
1153
|
+
tags?: Record<string, string> | undefined;
|
|
1154
1154
|
/**
|
|
1155
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>
|
|
1156
1156
|
* @public
|
|
1157
1157
|
*/
|
|
1158
|
-
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
|
|
1158
|
+
jobStateTimeLimitActions?: JobStateTimeLimitAction[] | undefined;
|
|
1159
1159
|
}
|
|
1160
1160
|
/**
|
|
1161
1161
|
* @public
|
|
@@ -1198,7 +1198,7 @@ export interface ShareAttributes {
|
|
|
1198
1198
|
* <p>The smallest supported value is 0.0001, and the largest supported value is 999.9999.</p>
|
|
1199
1199
|
* @public
|
|
1200
1200
|
*/
|
|
1201
|
-
weightFactor?: number;
|
|
1201
|
+
weightFactor?: number | undefined;
|
|
1202
1202
|
}
|
|
1203
1203
|
/**
|
|
1204
1204
|
* <p>The fair share policy for a scheduling policy.</p>
|
|
@@ -1212,7 +1212,7 @@ export interface FairsharePolicy {
|
|
|
1212
1212
|
* maximum supported value is 604800 (1 week).</p>
|
|
1213
1213
|
* @public
|
|
1214
1214
|
*/
|
|
1215
|
-
shareDecaySeconds?: number;
|
|
1215
|
+
shareDecaySeconds?: number | undefined;
|
|
1216
1216
|
/**
|
|
1217
1217
|
* <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that
|
|
1218
1218
|
* aren't already used.</p>
|
|
@@ -1232,14 +1232,14 @@ export interface FairsharePolicy {
|
|
|
1232
1232
|
* <p>The minimum value is 0 and the maximum value is 99.</p>
|
|
1233
1233
|
* @public
|
|
1234
1234
|
*/
|
|
1235
|
-
computeReservation?: number;
|
|
1235
|
+
computeReservation?: number | undefined;
|
|
1236
1236
|
/**
|
|
1237
1237
|
* <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair
|
|
1238
1238
|
* share identifiers for the fair share policy. Fair share identifiers that aren't included have a
|
|
1239
1239
|
* default weight of <code>1.0</code>.</p>
|
|
1240
1240
|
* @public
|
|
1241
1241
|
*/
|
|
1242
|
-
shareDistribution?: ShareAttributes[];
|
|
1242
|
+
shareDistribution?: ShareAttributes[] | undefined;
|
|
1243
1243
|
}
|
|
1244
1244
|
/**
|
|
1245
1245
|
* <p>Contains the parameters for <code>CreateSchedulingPolicy</code>.</p>
|
|
@@ -1256,7 +1256,7 @@ export interface CreateSchedulingPolicyRequest {
|
|
|
1256
1256
|
* <p>The fair share policy of the scheduling policy.</p>
|
|
1257
1257
|
* @public
|
|
1258
1258
|
*/
|
|
1259
|
-
fairsharePolicy?: FairsharePolicy;
|
|
1259
|
+
fairsharePolicy?: FairsharePolicy | undefined;
|
|
1260
1260
|
/**
|
|
1261
1261
|
* <p>The tags that you apply to the scheduling policy to help you categorize and organize your
|
|
1262
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
|
|
@@ -1264,7 +1264,7 @@ export interface CreateSchedulingPolicyRequest {
|
|
|
1264
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>
|
|
1265
1265
|
* @public
|
|
1266
1266
|
*/
|
|
1267
|
-
tags?: Record<string, string
|
|
1267
|
+
tags?: Record<string, string> | undefined;
|
|
1268
1268
|
}
|
|
1269
1269
|
/**
|
|
1270
1270
|
* @public
|
|
@@ -1358,7 +1358,7 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1358
1358
|
* <p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.</p>
|
|
1359
1359
|
* @public
|
|
1360
1360
|
*/
|
|
1361
|
-
computeEnvironments?: string[];
|
|
1361
|
+
computeEnvironments?: string[] | undefined;
|
|
1362
1362
|
/**
|
|
1363
1363
|
* <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code>
|
|
1364
1364
|
* in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</code>
|
|
@@ -1371,7 +1371,7 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1371
1371
|
* applicable.</p>
|
|
1372
1372
|
* @public
|
|
1373
1373
|
*/
|
|
1374
|
-
maxResults?: number;
|
|
1374
|
+
maxResults?: number | undefined;
|
|
1375
1375
|
/**
|
|
1376
1376
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1377
1377
|
* <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and
|
|
@@ -1384,7 +1384,7 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1384
1384
|
* </note>
|
|
1385
1385
|
* @public
|
|
1386
1386
|
*/
|
|
1387
|
-
nextToken?: string;
|
|
1387
|
+
nextToken?: string | undefined;
|
|
1388
1388
|
}
|
|
1389
1389
|
/**
|
|
1390
1390
|
* @public
|
|
@@ -1426,13 +1426,13 @@ export interface UpdatePolicy {
|
|
|
1426
1426
|
* infrastructure is updated. The default value is <code>false</code>.</p>
|
|
1427
1427
|
* @public
|
|
1428
1428
|
*/
|
|
1429
|
-
terminateJobsOnUpdate?: boolean;
|
|
1429
|
+
terminateJobsOnUpdate?: boolean | undefined;
|
|
1430
1430
|
/**
|
|
1431
1431
|
* <p>Specifies the job timeout (in minutes) when the compute environment infrastructure is
|
|
1432
1432
|
* updated. The default value is 30.</p>
|
|
1433
1433
|
* @public
|
|
1434
1434
|
*/
|
|
1435
|
-
jobExecutionTimeoutMinutes?: number;
|
|
1435
|
+
jobExecutionTimeoutMinutes?: number | undefined;
|
|
1436
1436
|
}
|
|
1437
1437
|
/**
|
|
1438
1438
|
* <p>An object that represents an Batch compute environment.</p>
|
|
@@ -1454,23 +1454,23 @@ export interface ComputeEnvironmentDetail {
|
|
|
1454
1454
|
* <p>The maximum number of VCPUs expected to be used for an unmanaged compute environment.</p>
|
|
1455
1455
|
* @public
|
|
1456
1456
|
*/
|
|
1457
|
-
unmanagedvCpus?: number;
|
|
1457
|
+
unmanagedvCpus?: number | undefined;
|
|
1458
1458
|
/**
|
|
1459
1459
|
* <p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.</p>
|
|
1460
1460
|
* @public
|
|
1461
1461
|
*/
|
|
1462
|
-
ecsClusterArn?: string;
|
|
1462
|
+
ecsClusterArn?: string | undefined;
|
|
1463
1463
|
/**
|
|
1464
1464
|
* <p>The tags applied to the compute environment.</p>
|
|
1465
1465
|
* @public
|
|
1466
1466
|
*/
|
|
1467
|
-
tags?: Record<string, string
|
|
1467
|
+
tags?: Record<string, string> | undefined;
|
|
1468
1468
|
/**
|
|
1469
1469
|
* <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For
|
|
1470
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>
|
|
1471
1471
|
* @public
|
|
1472
1472
|
*/
|
|
1473
|
-
type?: CEType;
|
|
1473
|
+
type?: CEType | undefined;
|
|
1474
1474
|
/**
|
|
1475
1475
|
* <p>The state of the compute environment. The valid values are <code>ENABLED</code> or
|
|
1476
1476
|
* <code>DISABLED</code>.</p>
|
|
@@ -1494,61 +1494,61 @@ export interface ComputeEnvironmentDetail {
|
|
|
1494
1494
|
* instance.</p>
|
|
1495
1495
|
* @public
|
|
1496
1496
|
*/
|
|
1497
|
-
state?: CEState;
|
|
1497
|
+
state?: CEState | undefined;
|
|
1498
1498
|
/**
|
|
1499
1499
|
* <p>The current status of the compute environment (for example, <code>CREATING</code> or
|
|
1500
1500
|
* <code>VALID</code>).</p>
|
|
1501
1501
|
* @public
|
|
1502
1502
|
*/
|
|
1503
|
-
status?: CEStatus;
|
|
1503
|
+
status?: CEStatus | undefined;
|
|
1504
1504
|
/**
|
|
1505
1505
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
1506
1506
|
* compute environment.</p>
|
|
1507
1507
|
* @public
|
|
1508
1508
|
*/
|
|
1509
|
-
statusReason?: string;
|
|
1509
|
+
statusReason?: string | undefined;
|
|
1510
1510
|
/**
|
|
1511
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
|
|
1512
1512
|
* the <i>Batch User Guide</i>.</p>
|
|
1513
1513
|
* @public
|
|
1514
1514
|
*/
|
|
1515
|
-
computeResources?: ComputeResource;
|
|
1515
|
+
computeResources?: ComputeResource | undefined;
|
|
1516
1516
|
/**
|
|
1517
1517
|
* <p>The service role that's associated with the compute environment that allows Batch to make
|
|
1518
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
|
|
1519
1519
|
* <i>Batch User Guide</i>.</p>
|
|
1520
1520
|
* @public
|
|
1521
1521
|
*/
|
|
1522
|
-
serviceRole?: string;
|
|
1522
|
+
serviceRole?: string | undefined;
|
|
1523
1523
|
/**
|
|
1524
1524
|
* <p>Specifies the infrastructure update policy for the compute environment. For more information
|
|
1525
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
|
|
1526
1526
|
* <i>Batch User Guide</i>.</p>
|
|
1527
1527
|
* @public
|
|
1528
1528
|
*/
|
|
1529
|
-
updatePolicy?: UpdatePolicy;
|
|
1529
|
+
updatePolicy?: UpdatePolicy | undefined;
|
|
1530
1530
|
/**
|
|
1531
1531
|
* <p>The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only
|
|
1532
1532
|
* specify this parameter if the <code>containerOrchestrationType</code> is <code>EKS</code>.</p>
|
|
1533
1533
|
* @public
|
|
1534
1534
|
*/
|
|
1535
|
-
eksConfiguration?: EksConfiguration;
|
|
1535
|
+
eksConfiguration?: EksConfiguration | undefined;
|
|
1536
1536
|
/**
|
|
1537
1537
|
* <p>The orchestration type of the compute environment. The valid values are <code>ECS</code>
|
|
1538
1538
|
* (default) or <code>EKS</code>.</p>
|
|
1539
1539
|
* @public
|
|
1540
1540
|
*/
|
|
1541
|
-
containerOrchestrationType?: OrchestrationType;
|
|
1541
|
+
containerOrchestrationType?: OrchestrationType | undefined;
|
|
1542
1542
|
/**
|
|
1543
1543
|
* <p>Unique identifier for the compute environment.</p>
|
|
1544
1544
|
* @public
|
|
1545
1545
|
*/
|
|
1546
|
-
uuid?: string;
|
|
1546
|
+
uuid?: string | undefined;
|
|
1547
1547
|
/**
|
|
1548
1548
|
* <p>Reserved.</p>
|
|
1549
1549
|
* @public
|
|
1550
1550
|
*/
|
|
1551
|
-
context?: string;
|
|
1551
|
+
context?: string | undefined;
|
|
1552
1552
|
}
|
|
1553
1553
|
/**
|
|
1554
1554
|
* @public
|
|
@@ -1558,7 +1558,7 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
1558
1558
|
* <p>The list of compute environments.</p>
|
|
1559
1559
|
* @public
|
|
1560
1560
|
*/
|
|
1561
|
-
computeEnvironments?: ComputeEnvironmentDetail[];
|
|
1561
|
+
computeEnvironments?: ComputeEnvironmentDetail[] | undefined;
|
|
1562
1562
|
/**
|
|
1563
1563
|
* <p>The <code>nextToken</code> value to include in a future
|
|
1564
1564
|
* <code>DescribeComputeEnvironments</code> request. When the results of a
|
|
@@ -1567,7 +1567,7 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
1567
1567
|
* are no more results to return.</p>
|
|
1568
1568
|
* @public
|
|
1569
1569
|
*/
|
|
1570
|
-
nextToken?: string;
|
|
1570
|
+
nextToken?: string | undefined;
|
|
1571
1571
|
}
|
|
1572
1572
|
/**
|
|
1573
1573
|
* <p>Contains the parameters for <code>DescribeJobDefinitions</code>.</p>
|
|
@@ -1582,7 +1582,7 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1582
1582
|
* parameter can't be used with other parameters.</p>
|
|
1583
1583
|
* @public
|
|
1584
1584
|
*/
|
|
1585
|
-
jobDefinitions?: string[];
|
|
1585
|
+
jobDefinitions?: string[] | undefined;
|
|
1586
1586
|
/**
|
|
1587
1587
|
* <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated
|
|
1588
1588
|
* output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns
|
|
@@ -1594,17 +1594,17 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1594
1594
|
* a <code>nextToken</code> value if applicable.</p>
|
|
1595
1595
|
* @public
|
|
1596
1596
|
*/
|
|
1597
|
-
maxResults?: number;
|
|
1597
|
+
maxResults?: number | undefined;
|
|
1598
1598
|
/**
|
|
1599
1599
|
* <p>The name of the job definition to describe.</p>
|
|
1600
1600
|
* @public
|
|
1601
1601
|
*/
|
|
1602
|
-
jobDefinitionName?: string;
|
|
1602
|
+
jobDefinitionName?: string | undefined;
|
|
1603
1603
|
/**
|
|
1604
1604
|
* <p>The status used to filter job definitions.</p>
|
|
1605
1605
|
* @public
|
|
1606
1606
|
*/
|
|
1607
|
-
status?: string;
|
|
1607
|
+
status?: string | undefined;
|
|
1608
1608
|
/**
|
|
1609
1609
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1610
1610
|
* <code>DescribeJobDefinitions</code> request where <code>maxResults</code> was used and the
|
|
@@ -1617,7 +1617,7 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1617
1617
|
* </note>
|
|
1618
1618
|
* @public
|
|
1619
1619
|
*/
|
|
1620
|
-
nextToken?: string;
|
|
1620
|
+
nextToken?: string | undefined;
|
|
1621
1621
|
}
|
|
1622
1622
|
/**
|
|
1623
1623
|
* <p>A key-value pair object.</p>
|
|
@@ -1629,13 +1629,13 @@ export interface KeyValuePair {
|
|
|
1629
1629
|
* environment variable.</p>
|
|
1630
1630
|
* @public
|
|
1631
1631
|
*/
|
|
1632
|
-
name?: string;
|
|
1632
|
+
name?: string | undefined;
|
|
1633
1633
|
/**
|
|
1634
1634
|
* <p>The value of the key-value pair. For environment variables, this is the value of the
|
|
1635
1635
|
* environment variable.</p>
|
|
1636
1636
|
* @public
|
|
1637
1637
|
*/
|
|
1638
|
-
value?: string;
|
|
1638
|
+
value?: string | undefined;
|
|
1639
1639
|
}
|
|
1640
1640
|
/**
|
|
1641
1641
|
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
|
|
@@ -1665,7 +1665,7 @@ export interface FargatePlatformConfiguration {
|
|
|
1665
1665
|
* platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1666
1666
|
* @public
|
|
1667
1667
|
*/
|
|
1668
|
-
platformVersion?: string;
|
|
1668
|
+
platformVersion?: string | undefined;
|
|
1669
1669
|
}
|
|
1670
1670
|
/**
|
|
1671
1671
|
* @public
|
|
@@ -1699,14 +1699,14 @@ export interface Device {
|
|
|
1699
1699
|
* <code>hostPath</code> value is used.</p>
|
|
1700
1700
|
* @public
|
|
1701
1701
|
*/
|
|
1702
|
-
containerPath?: string;
|
|
1702
|
+
containerPath?: string | undefined;
|
|
1703
1703
|
/**
|
|
1704
1704
|
* <p>The explicit permissions to provide to the container for the device. By default, the
|
|
1705
1705
|
* container has permissions for <code>read</code>, <code>write</code>, and <code>mknod</code> for
|
|
1706
1706
|
* the device.</p>
|
|
1707
1707
|
* @public
|
|
1708
1708
|
*/
|
|
1709
|
-
permissions?: DeviceCgroupPermission[];
|
|
1709
|
+
permissions?: DeviceCgroupPermission[] | undefined;
|
|
1710
1710
|
}
|
|
1711
1711
|
/**
|
|
1712
1712
|
* <p>The container path, mount options, and size of the <code>tmpfs</code> mount.</p>
|
|
@@ -1741,7 +1741,7 @@ export interface Tmpfs {
|
|
|
1741
1741
|
* "<code>nr_blocks</code>" | "<code>mpol</code>"</p>
|
|
1742
1742
|
* @public
|
|
1743
1743
|
*/
|
|
1744
|
-
mountOptions?: string[];
|
|
1744
|
+
mountOptions?: string[] | undefined;
|
|
1745
1745
|
}
|
|
1746
1746
|
/**
|
|
1747
1747
|
* <p>Linux-specific modifications that are applied to the container, such as details for device
|
|
@@ -1760,7 +1760,7 @@ export interface LinuxParameters {
|
|
|
1760
1760
|
* </note>
|
|
1761
1761
|
* @public
|
|
1762
1762
|
*/
|
|
1763
|
-
devices?: Device[];
|
|
1763
|
+
devices?: Device[] | undefined;
|
|
1764
1764
|
/**
|
|
1765
1765
|
* <p>If true, run an <code>init</code> process inside the container that forwards signals and
|
|
1766
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
|
|
@@ -1769,7 +1769,7 @@ export interface LinuxParameters {
|
|
|
1769
1769
|
* </p>
|
|
1770
1770
|
* @public
|
|
1771
1771
|
*/
|
|
1772
|
-
initProcessEnabled?: boolean;
|
|
1772
|
+
initProcessEnabled?: boolean | undefined;
|
|
1773
1773
|
/**
|
|
1774
1774
|
* <p>The value for the size (in MiB) of the <code>/dev/shm</code> volume. This parameter maps to
|
|
1775
1775
|
* the <code>--shm-size</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
@@ -1780,7 +1780,7 @@ export interface LinuxParameters {
|
|
|
1780
1780
|
* </note>
|
|
1781
1781
|
* @public
|
|
1782
1782
|
*/
|
|
1783
|
-
sharedMemorySize?: number;
|
|
1783
|
+
sharedMemorySize?: number | undefined;
|
|
1784
1784
|
/**
|
|
1785
1785
|
* <p>The container path, mount options, and size (in MiB) of the <code>tmpfs</code> mount. This
|
|
1786
1786
|
* parameter maps to the <code>--tmpfs</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
@@ -1791,7 +1791,7 @@ export interface LinuxParameters {
|
|
|
1791
1791
|
* </note>
|
|
1792
1792
|
* @public
|
|
1793
1793
|
*/
|
|
1794
|
-
tmpfs?: Tmpfs[];
|
|
1794
|
+
tmpfs?: Tmpfs[] | undefined;
|
|
1795
1795
|
/**
|
|
1796
1796
|
* <p>The total amount of swap memory (in MiB) a container can use. This parameter is translated
|
|
1797
1797
|
* to the <code>--memory-swap</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
@@ -1809,7 +1809,7 @@ export interface LinuxParameters {
|
|
|
1809
1809
|
* </note>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
|
-
maxSwap?: number;
|
|
1812
|
+
maxSwap?: number | undefined;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* <p>You can use this parameter to tune a container's memory swappiness behavior. A
|
|
1815
1815
|
* <code>swappiness</code> value of <code>0</code> causes swapping to not occur unless absolutely
|
|
@@ -1850,7 +1850,7 @@ export interface LinuxParameters {
|
|
|
1850
1850
|
* </note>
|
|
1851
1851
|
* @public
|
|
1852
1852
|
*/
|
|
1853
|
-
swappiness?: number;
|
|
1853
|
+
swappiness?: number | undefined;
|
|
1854
1854
|
}
|
|
1855
1855
|
/**
|
|
1856
1856
|
* @public
|
|
@@ -1984,13 +1984,13 @@ export interface LogConfiguration {
|
|
|
1984
1984
|
* </p>
|
|
1985
1985
|
* @public
|
|
1986
1986
|
*/
|
|
1987
|
-
options?: Record<string, string
|
|
1987
|
+
options?: Record<string, string> | undefined;
|
|
1988
1988
|
/**
|
|
1989
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
|
|
1990
1990
|
* data</a> in the <i>Batch User Guide</i>.</p>
|
|
1991
1991
|
* @public
|
|
1992
1992
|
*/
|
|
1993
|
-
secretOptions?: Secret[];
|
|
1993
|
+
secretOptions?: Secret[] | undefined;
|
|
1994
1994
|
}
|
|
1995
1995
|
/**
|
|
1996
1996
|
* <p>Details for a Docker volume mount point that's used in a job's container properties. This
|
|
@@ -2004,18 +2004,18 @@ export interface MountPoint {
|
|
|
2004
2004
|
* <p>The path on the container where the host volume is mounted.</p>
|
|
2005
2005
|
* @public
|
|
2006
2006
|
*/
|
|
2007
|
-
containerPath?: string;
|
|
2007
|
+
containerPath?: string | undefined;
|
|
2008
2008
|
/**
|
|
2009
2009
|
* <p>If this value is <code>true</code>, the container has read-only access to the volume.
|
|
2010
2010
|
* Otherwise, the container can write to the volume. The default value is <code>false</code>.</p>
|
|
2011
2011
|
* @public
|
|
2012
2012
|
*/
|
|
2013
|
-
readOnly?: boolean;
|
|
2013
|
+
readOnly?: boolean | undefined;
|
|
2014
2014
|
/**
|
|
2015
2015
|
* <p>The name of the volume to mount.</p>
|
|
2016
2016
|
* @public
|
|
2017
2017
|
*/
|
|
2018
|
-
sourceVolume?: string;
|
|
2018
|
+
sourceVolume?: string | undefined;
|
|
2019
2019
|
}
|
|
2020
2020
|
/**
|
|
2021
2021
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
@@ -2031,7 +2031,7 @@ export interface NetworkConfiguration {
|
|
|
2031
2031
|
* <i>Amazon Elastic Container Service Developer Guide</i>. The default value is "<code>DISABLED</code>".</p>
|
|
2032
2032
|
* @public
|
|
2033
2033
|
*/
|
|
2034
|
-
assignPublicIp?: AssignPublicIp;
|
|
2034
|
+
assignPublicIp?: AssignPublicIp | undefined;
|
|
2035
2035
|
}
|
|
2036
2036
|
/**
|
|
2037
2037
|
* <p>The repository credentials for private registry authentication.</p>
|
|
@@ -2275,7 +2275,7 @@ export interface RuntimePlatform {
|
|
|
2275
2275
|
* </note>
|
|
2276
2276
|
* @public
|
|
2277
2277
|
*/
|
|
2278
|
-
operatingSystemFamily?: string;
|
|
2278
|
+
operatingSystemFamily?: string | undefined;
|
|
2279
2279
|
/**
|
|
2280
2280
|
* <p> The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
|
|
2281
2281
|
* <code>X86_64</code> and <code>ARM64</code>.</p>
|
|
@@ -2293,7 +2293,7 @@ export interface RuntimePlatform {
|
|
|
2293
2293
|
* </note>
|
|
2294
2294
|
* @public
|
|
2295
2295
|
*/
|
|
2296
|
-
cpuArchitecture?: string;
|
|
2296
|
+
cpuArchitecture?: string | undefined;
|
|
2297
2297
|
}
|
|
2298
2298
|
/**
|
|
2299
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>
|
|
@@ -2349,7 +2349,7 @@ export interface EFSAuthorizationConfig {
|
|
|
2349
2349
|
* with Amazon EFS access points</a> in the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
2350
2350
|
* @public
|
|
2351
2351
|
*/
|
|
2352
|
-
accessPointId?: string;
|
|
2352
|
+
accessPointId?: string | undefined;
|
|
2353
2353
|
/**
|
|
2354
2354
|
* <p>Whether or not to use the Batch job IAM role defined in a job definition when mounting the
|
|
2355
2355
|
* Amazon EFS file system. If enabled, transit encryption must be enabled in the
|
|
@@ -2360,7 +2360,7 @@ export interface EFSAuthorizationConfig {
|
|
|
2360
2360
|
* specified.</p>
|
|
2361
2361
|
* @public
|
|
2362
2362
|
*/
|
|
2363
|
-
iam?: EFSAuthorizationConfigIAM;
|
|
2363
|
+
iam?: EFSAuthorizationConfigIAM | undefined;
|
|
2364
2364
|
}
|
|
2365
2365
|
/**
|
|
2366
2366
|
* @public
|
|
@@ -2398,7 +2398,7 @@ export interface EFSVolumeConfiguration {
|
|
|
2398
2398
|
* </important>
|
|
2399
2399
|
* @public
|
|
2400
2400
|
*/
|
|
2401
|
-
rootDirectory?: string;
|
|
2401
|
+
rootDirectory?: string | undefined;
|
|
2402
2402
|
/**
|
|
2403
2403
|
* <p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and
|
|
2404
2404
|
* the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If
|
|
@@ -2406,7 +2406,7 @@ export interface EFSVolumeConfiguration {
|
|
|
2406
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>
|
|
2407
2407
|
* @public
|
|
2408
2408
|
*/
|
|
2409
|
-
transitEncryption?: EFSTransitEncryption;
|
|
2409
|
+
transitEncryption?: EFSTransitEncryption | undefined;
|
|
2410
2410
|
/**
|
|
2411
2411
|
* <p>The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If
|
|
2412
2412
|
* you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS
|
|
@@ -2414,12 +2414,12 @@ export interface EFSVolumeConfiguration {
|
|
|
2414
2414
|
* <i>Amazon Elastic File System User Guide</i>.</p>
|
|
2415
2415
|
* @public
|
|
2416
2416
|
*/
|
|
2417
|
-
transitEncryptionPort?: number;
|
|
2417
|
+
transitEncryptionPort?: number | undefined;
|
|
2418
2418
|
/**
|
|
2419
2419
|
* <p>The authorization configuration details for the Amazon EFS file system.</p>
|
|
2420
2420
|
* @public
|
|
2421
2421
|
*/
|
|
2422
|
-
authorizationConfig?: EFSAuthorizationConfig;
|
|
2422
|
+
authorizationConfig?: EFSAuthorizationConfig | undefined;
|
|
2423
2423
|
}
|
|
2424
2424
|
/**
|
|
2425
2425
|
* <p>Determine whether your data volume persists on the host container instance and where it's
|
|
@@ -2442,7 +2442,7 @@ export interface Host {
|
|
|
2442
2442
|
* </note>
|
|
2443
2443
|
* @public
|
|
2444
2444
|
*/
|
|
2445
|
-
sourcePath?: string;
|
|
2445
|
+
sourcePath?: string | undefined;
|
|
2446
2446
|
}
|
|
2447
2447
|
/**
|
|
2448
2448
|
* <p>A data volume that's used in a job's container properties.</p>
|
|
@@ -2460,21 +2460,21 @@ export interface Volume {
|
|
|
2460
2460
|
* </note>
|
|
2461
2461
|
* @public
|
|
2462
2462
|
*/
|
|
2463
|
-
host?: Host;
|
|
2463
|
+
host?: Host | undefined;
|
|
2464
2464
|
/**
|
|
2465
2465
|
* <p>The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,
|
|
2466
2466
|
* numbers, hyphens (-), and underscores (_). This name is referenced in the
|
|
2467
2467
|
* <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>
|
|
2468
2468
|
* @public
|
|
2469
2469
|
*/
|
|
2470
|
-
name?: string;
|
|
2470
|
+
name?: string | undefined;
|
|
2471
2471
|
/**
|
|
2472
2472
|
* <p>This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs
|
|
2473
2473
|
* that are running on Fargate resources must specify a <code>platformVersion</code> of at least
|
|
2474
2474
|
* <code>1.4.0</code>.</p>
|
|
2475
2475
|
* @public
|
|
2476
2476
|
*/
|
|
2477
|
-
efsVolumeConfiguration?: EFSVolumeConfiguration;
|
|
2477
|
+
efsVolumeConfiguration?: EFSVolumeConfiguration | undefined;
|
|
2478
2478
|
}
|
|
2479
2479
|
/**
|
|
2480
2480
|
* <p>Container properties are used
|
|
@@ -2527,7 +2527,7 @@ export interface ContainerProperties {
|
|
|
2527
2527
|
* </ul>
|
|
2528
2528
|
* @public
|
|
2529
2529
|
*/
|
|
2530
|
-
image?: string;
|
|
2530
|
+
image?: string | undefined;
|
|
2531
2531
|
/**
|
|
2532
2532
|
* @deprecated
|
|
2533
2533
|
*
|
|
@@ -2542,7 +2542,7 @@ export interface ContainerProperties {
|
|
|
2542
2542
|
* least once for each node.</p>
|
|
2543
2543
|
* @public
|
|
2544
2544
|
*/
|
|
2545
|
-
vcpus?: number;
|
|
2545
|
+
vcpus?: number | undefined;
|
|
2546
2546
|
/**
|
|
2547
2547
|
* @deprecated
|
|
2548
2548
|
*
|
|
@@ -2554,7 +2554,7 @@ export interface ContainerProperties {
|
|
|
2554
2554
|
* specified in several places. It must be specified for each node at least once.</p>
|
|
2555
2555
|
* @public
|
|
2556
2556
|
*/
|
|
2557
|
-
memory?: number;
|
|
2557
|
+
memory?: number | undefined;
|
|
2558
2558
|
/**
|
|
2559
2559
|
* <p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in the
|
|
2560
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>
|
|
@@ -2562,26 +2562,26 @@ export interface ContainerProperties {
|
|
|
2562
2562
|
* <a href="https://docs.docker.com/engine/reference/builder/#cmd">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>
|
|
2563
2563
|
* @public
|
|
2564
2564
|
*/
|
|
2565
|
-
command?: string[];
|
|
2565
|
+
command?: string[] | undefined;
|
|
2566
2566
|
/**
|
|
2567
2567
|
* <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more
|
|
2568
2568
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the
|
|
2569
2569
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2570
2570
|
* @public
|
|
2571
2571
|
*/
|
|
2572
|
-
jobRoleArn?: string;
|
|
2572
|
+
jobRoleArn?: string | undefined;
|
|
2573
2573
|
/**
|
|
2574
2574
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate
|
|
2575
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>
|
|
2576
2576
|
* in the <i>Batch User Guide</i>.</p>
|
|
2577
2577
|
* @public
|
|
2578
2578
|
*/
|
|
2579
|
-
executionRoleArn?: string;
|
|
2579
|
+
executionRoleArn?: string | undefined;
|
|
2580
2580
|
/**
|
|
2581
2581
|
* <p>A list of data volumes used in a job.</p>
|
|
2582
2582
|
* @public
|
|
2583
2583
|
*/
|
|
2584
|
-
volumes?: Volume[];
|
|
2584
|
+
volumes?: Volume[] | undefined;
|
|
2585
2585
|
/**
|
|
2586
2586
|
* <p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in
|
|
2587
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
|
|
@@ -2596,7 +2596,7 @@ export interface ContainerProperties {
|
|
|
2596
2596
|
* </note>
|
|
2597
2597
|
* @public
|
|
2598
2598
|
*/
|
|
2599
|
-
environment?: KeyValuePair[];
|
|
2599
|
+
environment?: KeyValuePair[] | undefined;
|
|
2600
2600
|
/**
|
|
2601
2601
|
* <p>The mount points for data volumes in your container. This parameter maps to
|
|
2602
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>
|
|
@@ -2604,7 +2604,7 @@ export interface ContainerProperties {
|
|
|
2604
2604
|
* run</a>.</p>
|
|
2605
2605
|
* @public
|
|
2606
2606
|
*/
|
|
2607
|
-
mountPoints?: MountPoint[];
|
|
2607
|
+
mountPoints?: MountPoint[] | undefined;
|
|
2608
2608
|
/**
|
|
2609
2609
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
2610
2610
|
* system. This parameter maps to <code>ReadonlyRootfs</code> in the
|
|
@@ -2612,7 +2612,7 @@ export interface ContainerProperties {
|
|
|
2612
2612
|
* <code>--read-only</code> option to <code>docker run</code>.</p>
|
|
2613
2613
|
* @public
|
|
2614
2614
|
*/
|
|
2615
|
-
readonlyRootFilesystem?: boolean;
|
|
2615
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
2616
2616
|
/**
|
|
2617
2617
|
* <p>When this parameter is true, the container is given elevated permissions on the host
|
|
2618
2618
|
* container instance (similar to the <code>root</code> user). This parameter maps to
|
|
@@ -2624,7 +2624,7 @@ export interface ContainerProperties {
|
|
|
2624
2624
|
* </note>
|
|
2625
2625
|
* @public
|
|
2626
2626
|
*/
|
|
2627
|
-
privileged?: boolean;
|
|
2627
|
+
privileged?: boolean | undefined;
|
|
2628
2628
|
/**
|
|
2629
2629
|
* <p>A list of <code>ulimits</code> to set in the container. This parameter maps to
|
|
2630
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>
|
|
@@ -2636,14 +2636,14 @@ export interface ContainerProperties {
|
|
|
2636
2636
|
* </note>
|
|
2637
2637
|
* @public
|
|
2638
2638
|
*/
|
|
2639
|
-
ulimits?: Ulimit[];
|
|
2639
|
+
ulimits?: Ulimit[] | undefined;
|
|
2640
2640
|
/**
|
|
2641
2641
|
* <p>The user name to use inside the container. This parameter maps to <code>User</code> in the
|
|
2642
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>
|
|
2643
2643
|
* option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
2644
2644
|
* @public
|
|
2645
2645
|
*/
|
|
2646
|
-
user?: string;
|
|
2646
|
+
user?: string | undefined;
|
|
2647
2647
|
/**
|
|
2648
2648
|
* <p>The instance type to use for a multi-node parallel job. All node groups in a multi-node
|
|
2649
2649
|
* parallel job must use the same instance type.</p>
|
|
@@ -2653,19 +2653,19 @@ export interface ContainerProperties {
|
|
|
2653
2653
|
* </note>
|
|
2654
2654
|
* @public
|
|
2655
2655
|
*/
|
|
2656
|
-
instanceType?: string;
|
|
2656
|
+
instanceType?: string | undefined;
|
|
2657
2657
|
/**
|
|
2658
2658
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
2659
2659
|
* <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
2660
2660
|
* @public
|
|
2661
2661
|
*/
|
|
2662
|
-
resourceRequirements?: ResourceRequirement[];
|
|
2662
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
2663
2663
|
/**
|
|
2664
2664
|
* <p>Linux-specific modifications that are applied to the container, such as details for device
|
|
2665
2665
|
* mappings.</p>
|
|
2666
2666
|
* @public
|
|
2667
2667
|
*/
|
|
2668
|
-
linuxParameters?: LinuxParameters;
|
|
2668
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
2669
2669
|
/**
|
|
2670
2670
|
* <p>The log configuration specification for the container.</p>
|
|
2671
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>
|
|
@@ -2693,43 +2693,43 @@ export interface ContainerProperties {
|
|
|
2693
2693
|
* </note>
|
|
2694
2694
|
* @public
|
|
2695
2695
|
*/
|
|
2696
|
-
logConfiguration?: LogConfiguration;
|
|
2696
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
2697
2697
|
/**
|
|
2698
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
|
|
2699
2699
|
* <i>Batch User Guide</i>.</p>
|
|
2700
2700
|
* @public
|
|
2701
2701
|
*/
|
|
2702
|
-
secrets?: Secret[];
|
|
2702
|
+
secrets?: Secret[] | undefined;
|
|
2703
2703
|
/**
|
|
2704
2704
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2705
2705
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2706
2706
|
* @public
|
|
2707
2707
|
*/
|
|
2708
|
-
networkConfiguration?: NetworkConfiguration;
|
|
2708
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
2709
2709
|
/**
|
|
2710
2710
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2711
2711
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2712
2712
|
* @public
|
|
2713
2713
|
*/
|
|
2714
|
-
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
2714
|
+
fargatePlatformConfiguration?: FargatePlatformConfiguration | undefined;
|
|
2715
2715
|
/**
|
|
2716
2716
|
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
|
|
2717
2717
|
* the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
|
|
2718
2718
|
* Fargate.</p>
|
|
2719
2719
|
* @public
|
|
2720
2720
|
*/
|
|
2721
|
-
ephemeralStorage?: EphemeralStorage;
|
|
2721
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
2722
2722
|
/**
|
|
2723
2723
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
2724
2724
|
* Fargate.</p>
|
|
2725
2725
|
* @public
|
|
2726
2726
|
*/
|
|
2727
|
-
runtimePlatform?: RuntimePlatform;
|
|
2727
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
2728
2728
|
/**
|
|
2729
2729
|
* <p>The private repository authentication credentials to use.</p>
|
|
2730
2730
|
* @public
|
|
2731
2731
|
*/
|
|
2732
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
2732
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
2733
2733
|
}
|
|
2734
2734
|
/**
|
|
2735
2735
|
* <p>A list of containers that this task depends on.</p>
|
|
@@ -2740,7 +2740,7 @@ export interface TaskContainerDependency {
|
|
|
2740
2740
|
* <p>A unique identifier for the container.</p>
|
|
2741
2741
|
* @public
|
|
2742
2742
|
*/
|
|
2743
|
-
containerName?: string;
|
|
2743
|
+
containerName?: string | undefined;
|
|
2744
2744
|
/**
|
|
2745
2745
|
* <p>The dependency condition of the container. The following are the available conditions and
|
|
2746
2746
|
* their behavior:</p>
|
|
@@ -2767,7 +2767,7 @@ export interface TaskContainerDependency {
|
|
|
2767
2767
|
* </ul>
|
|
2768
2768
|
* @public
|
|
2769
2769
|
*/
|
|
2770
|
-
condition?: string;
|
|
2770
|
+
condition?: string | undefined;
|
|
2771
2771
|
}
|
|
2772
2772
|
/**
|
|
2773
2773
|
* <p>Container properties are used for Amazon ECS-based job definitions. These properties to describe
|
|
@@ -2784,12 +2784,12 @@ export interface TaskContainerProperties {
|
|
|
2784
2784
|
* CMD</a>.</p>
|
|
2785
2785
|
* @public
|
|
2786
2786
|
*/
|
|
2787
|
-
command?: string[];
|
|
2787
|
+
command?: string[] | undefined;
|
|
2788
2788
|
/**
|
|
2789
2789
|
* <p>A list of containers that this container depends on.</p>
|
|
2790
2790
|
* @public
|
|
2791
2791
|
*/
|
|
2792
|
-
dependsOn?: TaskContainerDependency[];
|
|
2792
|
+
dependsOn?: TaskContainerDependency[] | undefined;
|
|
2793
2793
|
/**
|
|
2794
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>
|
|
2795
2795
|
* section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
|
|
@@ -2804,7 +2804,7 @@ export interface TaskContainerProperties {
|
|
|
2804
2804
|
* </note>
|
|
2805
2805
|
* @public
|
|
2806
2806
|
*/
|
|
2807
|
-
environment?: KeyValuePair[];
|
|
2807
|
+
environment?: KeyValuePair[] | undefined;
|
|
2808
2808
|
/**
|
|
2809
2809
|
* <p>If the essential parameter of a container is marked as <code>true</code>, and that container
|
|
2810
2810
|
* fails or stops for any reason, all other containers that are part of the task are stopped. If the
|
|
@@ -2818,7 +2818,7 @@ export interface TaskContainerProperties {
|
|
|
2818
2818
|
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2819
2819
|
* @public
|
|
2820
2820
|
*/
|
|
2821
|
-
essential?: boolean;
|
|
2821
|
+
essential?: boolean | undefined;
|
|
2822
2822
|
/**
|
|
2823
2823
|
* <p>The image used to start a container. This string is passed directly to the Docker daemon. By
|
|
2824
2824
|
* default, images in the Docker Hub registry are available. Other repositories are specified with
|
|
@@ -2838,7 +2838,7 @@ export interface TaskContainerProperties {
|
|
|
2838
2838
|
* capabilities. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
|
|
2839
2839
|
* @public
|
|
2840
2840
|
*/
|
|
2841
|
-
linuxParameters?: LinuxParameters;
|
|
2841
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
2842
2842
|
/**
|
|
2843
2843
|
* <p>The log configuration specification for the container.</p>
|
|
2844
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
|
|
@@ -2871,7 +2871,7 @@ export interface TaskContainerProperties {
|
|
|
2871
2871
|
* </note>
|
|
2872
2872
|
* @public
|
|
2873
2873
|
*/
|
|
2874
|
-
logConfiguration?: LogConfiguration;
|
|
2874
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
2875
2875
|
/**
|
|
2876
2876
|
* <p>The mount points for data volumes in your container.</p>
|
|
2877
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
|
|
@@ -2883,13 +2883,13 @@ export interface TaskContainerProperties {
|
|
|
2883
2883
|
* and mount point can't be across drives.</p>
|
|
2884
2884
|
* @public
|
|
2885
2885
|
*/
|
|
2886
|
-
mountPoints?: MountPoint[];
|
|
2886
|
+
mountPoints?: MountPoint[] | undefined;
|
|
2887
2887
|
/**
|
|
2888
2888
|
* <p>The name of a container. The name can be used as a unique identifier to target your
|
|
2889
2889
|
* <code>dependsOn</code> and <code>Overrides</code> objects. </p>
|
|
2890
2890
|
* @public
|
|
2891
2891
|
*/
|
|
2892
|
-
name?: string;
|
|
2892
|
+
name?: string | undefined;
|
|
2893
2893
|
/**
|
|
2894
2894
|
* <p>When this parameter is <code>true</code>, the container is given elevated privileges on the
|
|
2895
2895
|
* host container instance (similar to the <code>root</code> user). This parameter maps to
|
|
@@ -2902,7 +2902,7 @@ export interface TaskContainerProperties {
|
|
|
2902
2902
|
* </note>
|
|
2903
2903
|
* @public
|
|
2904
2904
|
*/
|
|
2905
|
-
privileged?: boolean;
|
|
2905
|
+
privileged?: boolean | undefined;
|
|
2906
2906
|
/**
|
|
2907
2907
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
2908
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
|
|
@@ -2914,24 +2914,24 @@ export interface TaskContainerProperties {
|
|
|
2914
2914
|
* </note>
|
|
2915
2915
|
* @public
|
|
2916
2916
|
*/
|
|
2917
|
-
readonlyRootFilesystem?: boolean;
|
|
2917
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
2918
2918
|
/**
|
|
2919
2919
|
* <p>The private repository authentication credentials to use.</p>
|
|
2920
2920
|
* @public
|
|
2921
2921
|
*/
|
|
2922
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
2922
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
2923
2923
|
/**
|
|
2924
2924
|
* <p>The type and amount of a resource to assign to a container. The only supported resource is a
|
|
2925
2925
|
* GPU.</p>
|
|
2926
2926
|
* @public
|
|
2927
2927
|
*/
|
|
2928
|
-
resourceRequirements?: ResourceRequirement[];
|
|
2928
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
2929
2929
|
/**
|
|
2930
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
|
|
2931
2931
|
* Data</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
2932
2932
|
* @public
|
|
2933
2933
|
*/
|
|
2934
|
-
secrets?: Secret[];
|
|
2934
|
+
secrets?: Secret[] | undefined;
|
|
2935
2935
|
/**
|
|
2936
2936
|
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value is
|
|
2937
2937
|
* specified in a task definition, it overrides the default values set by Docker. This parameter
|
|
@@ -2954,7 +2954,7 @@ export interface TaskContainerProperties {
|
|
|
2954
2954
|
* </note>
|
|
2955
2955
|
* @public
|
|
2956
2956
|
*/
|
|
2957
|
-
ulimits?: Ulimit[];
|
|
2957
|
+
ulimits?: Ulimit[] | undefined;
|
|
2958
2958
|
/**
|
|
2959
2959
|
* <p>The user to use inside the container. This parameter maps to User in the Create a container
|
|
2960
2960
|
* section of the Docker Remote API and the --user option to docker run.</p>
|
|
@@ -3001,7 +3001,7 @@ export interface TaskContainerProperties {
|
|
|
3001
3001
|
* </note>
|
|
3002
3002
|
* @public
|
|
3003
3003
|
*/
|
|
3004
|
-
user?: string;
|
|
3004
|
+
user?: string | undefined;
|
|
3005
3005
|
}
|
|
3006
3006
|
/**
|
|
3007
3007
|
* <p>The properties for a task definition that describes the container and volume definitions of
|
|
@@ -3021,14 +3021,14 @@ export interface EcsTaskProperties {
|
|
|
3021
3021
|
* Fargate.</p>
|
|
3022
3022
|
* @public
|
|
3023
3023
|
*/
|
|
3024
|
-
ephemeralStorage?: EphemeralStorage;
|
|
3024
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
3025
3025
|
/**
|
|
3026
3026
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate
|
|
3027
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>
|
|
3028
3028
|
* in the <i>Batch User Guide</i>.</p>
|
|
3029
3029
|
* @public
|
|
3030
3030
|
*/
|
|
3031
|
-
executionRoleArn?: string;
|
|
3031
|
+
executionRoleArn?: string | undefined;
|
|
3032
3032
|
/**
|
|
3033
3033
|
* <p>The Fargate platform version where the jobs are running. A platform version is specified
|
|
3034
3034
|
* only for jobs that are running on Fargate resources. If one isn't specified, the
|
|
@@ -3037,7 +3037,7 @@ export interface EcsTaskProperties {
|
|
|
3037
3037
|
* platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3038
3038
|
* @public
|
|
3039
3039
|
*/
|
|
3040
|
-
platformVersion?: string;
|
|
3040
|
+
platformVersion?: string | undefined;
|
|
3041
3041
|
/**
|
|
3042
3042
|
* <p>The IPC resource namespace to use for the containers in the task. The valid values are
|
|
3043
3043
|
* <code>host</code>, <code>task</code>, or <code>none</code>.</p>
|
|
@@ -3053,7 +3053,7 @@ export interface EcsTaskProperties {
|
|
|
3053
3053
|
* the Docker run reference.</p>
|
|
3054
3054
|
* @public
|
|
3055
3055
|
*/
|
|
3056
|
-
ipcMode?: string;
|
|
3056
|
+
ipcMode?: string | undefined;
|
|
3057
3057
|
/**
|
|
3058
3058
|
* <p>The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.</p>
|
|
3059
3059
|
* <note>
|
|
@@ -3061,7 +3061,7 @@ export interface EcsTaskProperties {
|
|
|
3061
3061
|
* </note>
|
|
3062
3062
|
* @public
|
|
3063
3063
|
*/
|
|
3064
|
-
taskRoleArn?: string;
|
|
3064
|
+
taskRoleArn?: string | undefined;
|
|
3065
3065
|
/**
|
|
3066
3066
|
* <p>The process namespace to use for the containers in the task. The valid values are
|
|
3067
3067
|
* <code>host</code> or <code>task</code>. For example, monitoring sidecars might need
|
|
@@ -3076,24 +3076,24 @@ export interface EcsTaskProperties {
|
|
|
3076
3076
|
* information, see <a href="https://docs.docker.com/engine/reference/run/#pid-settings---pid">PID settings</a> in the Docker run reference.</p>
|
|
3077
3077
|
* @public
|
|
3078
3078
|
*/
|
|
3079
|
-
pidMode?: string;
|
|
3079
|
+
pidMode?: string | undefined;
|
|
3080
3080
|
/**
|
|
3081
3081
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
3082
3082
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
3083
3083
|
* @public
|
|
3084
3084
|
*/
|
|
3085
|
-
networkConfiguration?: NetworkConfiguration;
|
|
3085
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
3086
3086
|
/**
|
|
3087
3087
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
3088
3088
|
* Fargate.</p>
|
|
3089
3089
|
* @public
|
|
3090
3090
|
*/
|
|
3091
|
-
runtimePlatform?: RuntimePlatform;
|
|
3091
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
3092
3092
|
/**
|
|
3093
3093
|
* <p>A list of volumes that are associated with the job.</p>
|
|
3094
3094
|
* @public
|
|
3095
3095
|
*/
|
|
3096
|
-
volumes?: Volume[];
|
|
3096
|
+
volumes?: Volume[] | undefined;
|
|
3097
3097
|
}
|
|
3098
3098
|
/**
|
|
3099
3099
|
* <p>An object that contains the properties for the Amazon ECS resources of a job.</p>
|
|
@@ -3123,7 +3123,7 @@ export interface EksContainerEnvironmentVariable {
|
|
|
3123
3123
|
* <p>The value of the environment variable.</p>
|
|
3124
3124
|
* @public
|
|
3125
3125
|
*/
|
|
3126
|
-
value?: string;
|
|
3126
|
+
value?: string | undefined;
|
|
3127
3127
|
}
|
|
3128
3128
|
/**
|
|
3129
3129
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
@@ -3171,7 +3171,7 @@ export interface EksContainerResourceRequirements {
|
|
|
3171
3171
|
* </dl>
|
|
3172
3172
|
* @public
|
|
3173
3173
|
*/
|
|
3174
|
-
limits?: Record<string, string
|
|
3174
|
+
limits?: Record<string, string> | undefined;
|
|
3175
3175
|
/**
|
|
3176
3176
|
* <p>The type and quantity of the resources to request for the container. The values vary based
|
|
3177
3177
|
* on the <code>name</code> that's specified. Resources can be requested by using either the
|
|
@@ -3210,7 +3210,7 @@ export interface EksContainerResourceRequirements {
|
|
|
3210
3210
|
* </dl>
|
|
3211
3211
|
* @public
|
|
3212
3212
|
*/
|
|
3213
|
-
requests?: Record<string, string
|
|
3213
|
+
requests?: Record<string, string> | undefined;
|
|
3214
3214
|
}
|
|
3215
3215
|
/**
|
|
3216
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
|
|
@@ -3228,7 +3228,7 @@ export interface EksContainerSecurityContext {
|
|
|
3228
3228
|
* documentation</i>.</p>
|
|
3229
3229
|
* @public
|
|
3230
3230
|
*/
|
|
3231
|
-
runAsUser?: number;
|
|
3231
|
+
runAsUser?: number | undefined;
|
|
3232
3232
|
/**
|
|
3233
3233
|
* <p>When this parameter is specified, the container is run as the specified group ID
|
|
3234
3234
|
* (<code>gid</code>). If this parameter isn't specified, the default is the group that's specified
|
|
@@ -3238,7 +3238,7 @@ export interface EksContainerSecurityContext {
|
|
|
3238
3238
|
* documentation</i>.</p>
|
|
3239
3239
|
* @public
|
|
3240
3240
|
*/
|
|
3241
|
-
runAsGroup?: number;
|
|
3241
|
+
runAsGroup?: number | undefined;
|
|
3242
3242
|
/**
|
|
3243
3243
|
* <p>When this parameter is <code>true</code>, the container is given elevated permissions on the
|
|
3244
3244
|
* host container instance. The level of permissions are similar to the <code>root</code> user
|
|
@@ -3247,13 +3247,13 @@ export interface EksContainerSecurityContext {
|
|
|
3247
3247
|
* pod security policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3248
3248
|
* @public
|
|
3249
3249
|
*/
|
|
3250
|
-
privileged?: boolean;
|
|
3250
|
+
privileged?: boolean | undefined;
|
|
3251
3251
|
/**
|
|
3252
3252
|
* <p>Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent
|
|
3253
3253
|
* process. The default value is <code>false</code>.</p>
|
|
3254
3254
|
* @public
|
|
3255
3255
|
*/
|
|
3256
|
-
allowPrivilegeEscalation?: boolean;
|
|
3256
|
+
allowPrivilegeEscalation?: boolean | undefined;
|
|
3257
3257
|
/**
|
|
3258
3258
|
* <p>When this parameter is <code>true</code>, the container is given read-only access to its
|
|
3259
3259
|
* root file system. The default value is <code>false</code>. This parameter maps to
|
|
@@ -3261,7 +3261,7 @@ export interface EksContainerSecurityContext {
|
|
|
3261
3261
|
* documentation</i>.</p>
|
|
3262
3262
|
* @public
|
|
3263
3263
|
*/
|
|
3264
|
-
readOnlyRootFilesystem?: boolean;
|
|
3264
|
+
readOnlyRootFilesystem?: boolean | undefined;
|
|
3265
3265
|
/**
|
|
3266
3266
|
* <p>When this parameter is specified, the container is run as a user with a <code>uid</code>
|
|
3267
3267
|
* other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to
|
|
@@ -3270,7 +3270,7 @@ export interface EksContainerSecurityContext {
|
|
|
3270
3270
|
* documentation</i>.</p>
|
|
3271
3271
|
* @public
|
|
3272
3272
|
*/
|
|
3273
|
-
runAsNonRoot?: boolean;
|
|
3273
|
+
runAsNonRoot?: boolean | undefined;
|
|
3274
3274
|
}
|
|
3275
3275
|
/**
|
|
3276
3276
|
* <p>The volume mounts for a container for an Amazon EKS job. For more information about volumes and
|
|
@@ -3283,18 +3283,18 @@ export interface EksContainerVolumeMount {
|
|
|
3283
3283
|
* pod.</p>
|
|
3284
3284
|
* @public
|
|
3285
3285
|
*/
|
|
3286
|
-
name?: string;
|
|
3286
|
+
name?: string | undefined;
|
|
3287
3287
|
/**
|
|
3288
3288
|
* <p>The path on the container where the volume is mounted.</p>
|
|
3289
3289
|
* @public
|
|
3290
3290
|
*/
|
|
3291
|
-
mountPath?: string;
|
|
3291
|
+
mountPath?: string | undefined;
|
|
3292
3292
|
/**
|
|
3293
3293
|
* <p>If this value is <code>true</code>, the container has read-only access to the volume.
|
|
3294
3294
|
* Otherwise, the container can write to the volume. The default value is <code>false</code>.</p>
|
|
3295
3295
|
* @public
|
|
3296
3296
|
*/
|
|
3297
|
-
readOnly?: boolean;
|
|
3297
|
+
readOnly?: boolean | undefined;
|
|
3298
3298
|
}
|
|
3299
3299
|
/**
|
|
3300
3300
|
* <p>EKS container properties are used in job definitions for Amazon EKS based job definitions to
|
|
@@ -3308,7 +3308,7 @@ export interface EksContainer {
|
|
|
3308
3308
|
* "<code>Default</code>" is used. Each container in a pod must have a unique name.</p>
|
|
3309
3309
|
* @public
|
|
3310
3310
|
*/
|
|
3311
|
-
name?: string;
|
|
3311
|
+
name?: string | undefined;
|
|
3312
3312
|
/**
|
|
3313
3313
|
* <p>The Docker image used to start the container.</p>
|
|
3314
3314
|
* @public
|
|
@@ -3322,7 +3322,7 @@ export interface EksContainer {
|
|
|
3322
3322
|
* images</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3323
3323
|
* @public
|
|
3324
3324
|
*/
|
|
3325
|
-
imagePullPolicy?: string;
|
|
3325
|
+
imagePullPolicy?: string | undefined;
|
|
3326
3326
|
/**
|
|
3327
3327
|
* <p>The entrypoint for the container. This isn't run within a shell. If this isn't specified,
|
|
3328
3328
|
* the <code>ENTRYPOINT</code> of the container image is used. Environment variable references are
|
|
@@ -3336,7 +3336,7 @@ export interface EksContainer {
|
|
|
3336
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>
|
|
3337
3337
|
* @public
|
|
3338
3338
|
*/
|
|
3339
|
-
command?: string[];
|
|
3339
|
+
command?: string[] | undefined;
|
|
3340
3340
|
/**
|
|
3341
3341
|
* <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of
|
|
3342
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>
|
|
@@ -3351,7 +3351,7 @@ export interface EksContainer {
|
|
|
3351
3351
|
* documentation</i>.</p>
|
|
3352
3352
|
* @public
|
|
3353
3353
|
*/
|
|
3354
|
-
args?: string[];
|
|
3354
|
+
args?: string[] | undefined;
|
|
3355
3355
|
/**
|
|
3356
3356
|
* <p>The environment variables to pass to a container.</p>
|
|
3357
3357
|
* <note>
|
|
@@ -3360,7 +3360,7 @@ export interface EksContainer {
|
|
|
3360
3360
|
* </note>
|
|
3361
3361
|
* @public
|
|
3362
3362
|
*/
|
|
3363
|
-
env?: EksContainerEnvironmentVariable[];
|
|
3363
|
+
env?: EksContainerEnvironmentVariable[] | undefined;
|
|
3364
3364
|
/**
|
|
3365
3365
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
3366
3366
|
* <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information,
|
|
@@ -3368,21 +3368,21 @@ export interface EksContainer {
|
|
|
3368
3368
|
* documentation</i>.</p>
|
|
3369
3369
|
* @public
|
|
3370
3370
|
*/
|
|
3371
|
-
resources?: EksContainerResourceRequirements;
|
|
3371
|
+
resources?: EksContainerResourceRequirements | undefined;
|
|
3372
3372
|
/**
|
|
3373
3373
|
* <p>The volume mounts for the container. Batch supports <code>emptyDir</code>,
|
|
3374
3374
|
* <code>hostPath</code>, and <code>secret</code> volume types. For more information about volumes
|
|
3375
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>
|
|
3376
3376
|
* @public
|
|
3377
3377
|
*/
|
|
3378
|
-
volumeMounts?: EksContainerVolumeMount[];
|
|
3378
|
+
volumeMounts?: EksContainerVolumeMount[] | undefined;
|
|
3379
3379
|
/**
|
|
3380
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
|
|
3381
3381
|
* security context for a pod or container</a> in the <i>Kubernetes
|
|
3382
3382
|
* documentation</i>.</p>
|
|
3383
3383
|
* @public
|
|
3384
3384
|
*/
|
|
3385
|
-
securityContext?: EksContainerSecurityContext;
|
|
3385
|
+
securityContext?: EksContainerSecurityContext | undefined;
|
|
3386
3386
|
}
|
|
3387
3387
|
/**
|
|
3388
3388
|
* <p>References a Kubernetes secret resource. This name of the secret must start and end with an
|
|
@@ -3412,7 +3412,7 @@ export interface EksMetadata {
|
|
|
3412
3412
|
* unique for a given object.</p>
|
|
3413
3413
|
* @public
|
|
3414
3414
|
*/
|
|
3415
|
-
labels?: Record<string, string
|
|
3415
|
+
labels?: Record<string, string> | undefined;
|
|
3416
3416
|
}
|
|
3417
3417
|
/**
|
|
3418
3418
|
* <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. An
|
|
@@ -3444,12 +3444,12 @@ export interface EksEmptyDir {
|
|
|
3444
3444
|
* </dl>
|
|
3445
3445
|
* @public
|
|
3446
3446
|
*/
|
|
3447
|
-
medium?: string;
|
|
3447
|
+
medium?: string | undefined;
|
|
3448
3448
|
/**
|
|
3449
3449
|
* <p>The maximum size of the volume. By default, there's no maximum size defined.</p>
|
|
3450
3450
|
* @public
|
|
3451
3451
|
*/
|
|
3452
|
-
sizeLimit?: string;
|
|
3452
|
+
sizeLimit?: string | undefined;
|
|
3453
3453
|
}
|
|
3454
3454
|
/**
|
|
3455
3455
|
* <p>Specifies the configuration of a Kubernetes <code>hostPath</code> volume. A <code>hostPath</code>
|
|
@@ -3462,7 +3462,7 @@ export interface EksHostPath {
|
|
|
3462
3462
|
* <p>The path of the file or directory on the host to mount into containers on the pod.</p>
|
|
3463
3463
|
* @public
|
|
3464
3464
|
*/
|
|
3465
|
-
path?: string;
|
|
3465
|
+
path?: string | undefined;
|
|
3466
3466
|
}
|
|
3467
3467
|
/**
|
|
3468
3468
|
* <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see
|
|
@@ -3481,7 +3481,7 @@ export interface EksSecret {
|
|
|
3481
3481
|
* <p>Specifies whether the secret or the secret's keys must be defined.</p>
|
|
3482
3482
|
* @public
|
|
3483
3483
|
*/
|
|
3484
|
-
optional?: boolean;
|
|
3484
|
+
optional?: boolean | undefined;
|
|
3485
3485
|
}
|
|
3486
3486
|
/**
|
|
3487
3487
|
* <p>Specifies an Amazon EKS volume for a job definition.</p>
|
|
@@ -3500,21 +3500,21 @@ export interface EksVolume {
|
|
|
3500
3500
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
3501
3501
|
* @public
|
|
3502
3502
|
*/
|
|
3503
|
-
hostPath?: EksHostPath;
|
|
3503
|
+
hostPath?: EksHostPath | undefined;
|
|
3504
3504
|
/**
|
|
3505
3505
|
* <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. For more information,
|
|
3506
3506
|
* see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#emptydir">emptyDir</a>
|
|
3507
3507
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
3508
3508
|
* @public
|
|
3509
3509
|
*/
|
|
3510
|
-
emptyDir?: EksEmptyDir;
|
|
3510
|
+
emptyDir?: EksEmptyDir | undefined;
|
|
3511
3511
|
/**
|
|
3512
3512
|
* <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see
|
|
3513
3513
|
* <a href="https://kubernetes.io/docs/concepts/storage/volumes/#secret">secret</a> in the
|
|
3514
3514
|
* <i>Kubernetes documentation</i>.</p>
|
|
3515
3515
|
* @public
|
|
3516
3516
|
*/
|
|
3517
|
-
secret?: EksSecret;
|
|
3517
|
+
secret?: EksSecret | undefined;
|
|
3518
3518
|
}
|
|
3519
3519
|
/**
|
|
3520
3520
|
* <p>The properties for the pod.</p>
|
|
@@ -3529,7 +3529,7 @@ export interface EksPodProperties {
|
|
|
3529
3529
|
* documentation</i>.</p>
|
|
3530
3530
|
* @public
|
|
3531
3531
|
*/
|
|
3532
|
-
serviceAccountName?: string;
|
|
3532
|
+
serviceAccountName?: string | undefined;
|
|
3533
3533
|
/**
|
|
3534
3534
|
* <p>Indicates if the pod uses the hosts' network IP address. The default value is
|
|
3535
3535
|
* <code>true</code>. Setting this to <code>false</code> enables the Kubernetes pod networking model.
|
|
@@ -3539,7 +3539,7 @@ export interface EksPodProperties {
|
|
|
3539
3539
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
3540
3540
|
* @public
|
|
3541
3541
|
*/
|
|
3542
|
-
hostNetwork?: boolean;
|
|
3542
|
+
hostNetwork?: boolean | undefined;
|
|
3543
3543
|
/**
|
|
3544
3544
|
* <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the
|
|
3545
3545
|
* <code>hostNetwork</code> parameter is not specified, the default is
|
|
@@ -3551,7 +3551,7 @@ export interface EksPodProperties {
|
|
|
3551
3551
|
* </p>
|
|
3552
3552
|
* @public
|
|
3553
3553
|
*/
|
|
3554
|
-
dnsPolicy?: string;
|
|
3554
|
+
dnsPolicy?: string | undefined;
|
|
3555
3555
|
/**
|
|
3556
3556
|
* <p>References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain
|
|
3557
3557
|
* access to pull an images from a private registry.</p>
|
|
@@ -3559,7 +3559,7 @@ export interface EksPodProperties {
|
|
|
3559
3559
|
* <code>ImagePullSecret$name</code> is required when this object is used.</p>
|
|
3560
3560
|
* @public
|
|
3561
3561
|
*/
|
|
3562
|
-
imagePullSecrets?: ImagePullSecret[];
|
|
3562
|
+
imagePullSecrets?: ImagePullSecret[] | undefined;
|
|
3563
3563
|
/**
|
|
3564
3564
|
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
3565
3565
|
* <note>
|
|
@@ -3567,7 +3567,7 @@ export interface EksPodProperties {
|
|
|
3567
3567
|
* </note>
|
|
3568
3568
|
* @public
|
|
3569
3569
|
*/
|
|
3570
|
-
containers?: EksContainer[];
|
|
3570
|
+
containers?: EksContainer[] | undefined;
|
|
3571
3571
|
/**
|
|
3572
3572
|
* <p>These containers run before application containers, always runs to completion, and must
|
|
3573
3573
|
* complete successfully before the next container starts. These containers are registered with the
|
|
@@ -3579,12 +3579,12 @@ export interface EksPodProperties {
|
|
|
3579
3579
|
* </note>
|
|
3580
3580
|
* @public
|
|
3581
3581
|
*/
|
|
3582
|
-
initContainers?: EksContainer[];
|
|
3582
|
+
initContainers?: EksContainer[] | undefined;
|
|
3583
3583
|
/**
|
|
3584
3584
|
* <p>Specifies the volumes for a job definition that uses Amazon EKS resources.</p>
|
|
3585
3585
|
* @public
|
|
3586
3586
|
*/
|
|
3587
|
-
volumes?: EksVolume[];
|
|
3587
|
+
volumes?: EksVolume[] | undefined;
|
|
3588
3588
|
/**
|
|
3589
3589
|
* <p>Metadata about the
|
|
3590
3590
|
* Kubernetes
|
|
@@ -3593,14 +3593,14 @@ export interface EksPodProperties {
|
|
|
3593
3593
|
* documentation</i>.</p>
|
|
3594
3594
|
* @public
|
|
3595
3595
|
*/
|
|
3596
|
-
metadata?: EksMetadata;
|
|
3596
|
+
metadata?: EksMetadata | undefined;
|
|
3597
3597
|
/**
|
|
3598
3598
|
* <p>Indicates if the processes in a container are shared, or visible, to other containers in the
|
|
3599
3599
|
* same pod. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/">Share
|
|
3600
3600
|
* Process Namespace between Containers in a Pod</a>.</p>
|
|
3601
3601
|
* @public
|
|
3602
3602
|
*/
|
|
3603
|
-
shareProcessNamespace?: boolean;
|
|
3603
|
+
shareProcessNamespace?: boolean | undefined;
|
|
3604
3604
|
}
|
|
3605
3605
|
/**
|
|
3606
3606
|
* <p>An object that contains the properties for the Kubernetes resources of a job.</p>
|
|
@@ -3611,7 +3611,7 @@ export interface EksProperties {
|
|
|
3611
3611
|
* <p>The properties for the Kubernetes pod resources of a job.</p>
|
|
3612
3612
|
* @public
|
|
3613
3613
|
*/
|
|
3614
|
-
podProperties?: EksPodProperties;
|
|
3614
|
+
podProperties?: EksPodProperties | undefined;
|
|
3615
3615
|
}
|
|
3616
3616
|
/**
|
|
3617
3617
|
* <p>This is an object that represents the properties of the node range for a multi-node parallel
|
|
@@ -3634,7 +3634,7 @@ export interface NodeRangeProperty {
|
|
|
3634
3634
|
* <p>The container details for the node range.</p>
|
|
3635
3635
|
* @public
|
|
3636
3636
|
*/
|
|
3637
|
-
container?: ContainerProperties;
|
|
3637
|
+
container?: ContainerProperties | undefined;
|
|
3638
3638
|
/**
|
|
3639
3639
|
* <p>The instance types of the underlying host infrastructure of a multi-node parallel
|
|
3640
3640
|
* job.</p>
|
|
@@ -3644,18 +3644,18 @@ export interface NodeRangeProperty {
|
|
|
3644
3644
|
* </note>
|
|
3645
3645
|
* @public
|
|
3646
3646
|
*/
|
|
3647
|
-
instanceTypes?: string[];
|
|
3647
|
+
instanceTypes?: string[] | undefined;
|
|
3648
3648
|
/**
|
|
3649
3649
|
* <p>This is an object that represents the properties of the node range for a multi-node parallel
|
|
3650
3650
|
* job.</p>
|
|
3651
3651
|
* @public
|
|
3652
3652
|
*/
|
|
3653
|
-
ecsProperties?: EcsProperties;
|
|
3653
|
+
ecsProperties?: EcsProperties | undefined;
|
|
3654
3654
|
/**
|
|
3655
3655
|
* <p>This is an object that represents the properties of the node range for a multi-node parallel job.</p>
|
|
3656
3656
|
* @public
|
|
3657
3657
|
*/
|
|
3658
|
-
eksProperties?: EksProperties;
|
|
3658
|
+
eksProperties?: EksProperties | undefined;
|
|
3659
3659
|
}
|
|
3660
3660
|
/**
|
|
3661
3661
|
* <p>An object that represents the node properties of a multi-node parallel job.</p>
|
|
@@ -3724,7 +3724,7 @@ export interface EvaluateOnExit {
|
|
|
3724
3724
|
* match.</p>
|
|
3725
3725
|
* @public
|
|
3726
3726
|
*/
|
|
3727
|
-
onStatusReason?: string;
|
|
3727
|
+
onStatusReason?: string | undefined;
|
|
3728
3728
|
/**
|
|
3729
3729
|
* <p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The
|
|
3730
3730
|
* pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons
|
|
@@ -3732,7 +3732,7 @@ export interface EvaluateOnExit {
|
|
|
3732
3732
|
* that only the start of the string needs to be an exact match.</p>
|
|
3733
3733
|
* @public
|
|
3734
3734
|
*/
|
|
3735
|
-
onReason?: string;
|
|
3735
|
+
onReason?: string | undefined;
|
|
3736
3736
|
/**
|
|
3737
3737
|
* <p>Contains a glob pattern to match against the decimal representation of the
|
|
3738
3738
|
* <code>ExitCode</code> returned for a job. The pattern can be up to 512 characters long. It can
|
|
@@ -3741,7 +3741,7 @@ export interface EvaluateOnExit {
|
|
|
3741
3741
|
* <p>The string can contain up to 512 characters.</p>
|
|
3742
3742
|
* @public
|
|
3743
3743
|
*/
|
|
3744
|
-
onExitCode?: string;
|
|
3744
|
+
onExitCode?: string | undefined;
|
|
3745
3745
|
/**
|
|
3746
3746
|
* <p>Specifies the action to take if all of the specified conditions
|
|
3747
3747
|
* (<code>onStatusReason</code>, <code>onReason</code>, and <code>onExitCode</code>) are met. The
|
|
@@ -3762,14 +3762,14 @@ export interface RetryStrategy {
|
|
|
3762
3762
|
* retried on failure the same number of attempts as the value.</p>
|
|
3763
3763
|
* @public
|
|
3764
3764
|
*/
|
|
3765
|
-
attempts?: number;
|
|
3765
|
+
attempts?: number | undefined;
|
|
3766
3766
|
/**
|
|
3767
3767
|
* <p>Array of up to 5 objects that specify the conditions where jobs are retried or failed. If
|
|
3768
3768
|
* this parameter is specified, then the <code>attempts</code> parameter must also be specified. If
|
|
3769
3769
|
* none of the listed conditions match, then the job is retried.</p>
|
|
3770
3770
|
* @public
|
|
3771
3771
|
*/
|
|
3772
|
-
evaluateOnExit?: EvaluateOnExit[];
|
|
3772
|
+
evaluateOnExit?: EvaluateOnExit[] | undefined;
|
|
3773
3773
|
}
|
|
3774
3774
|
/**
|
|
3775
3775
|
* <p>An object that represents a job timeout configuration.</p>
|
|
@@ -3785,7 +3785,7 @@ export interface JobTimeout {
|
|
|
3785
3785
|
* individual nodes.</p>
|
|
3786
3786
|
* @public
|
|
3787
3787
|
*/
|
|
3788
|
-
attemptDurationSeconds?: number;
|
|
3788
|
+
attemptDurationSeconds?: number | undefined;
|
|
3789
3789
|
}
|
|
3790
3790
|
/**
|
|
3791
3791
|
* <p>An object that represents an Batch job definition.</p>
|
|
@@ -3811,7 +3811,7 @@ export interface JobDefinition {
|
|
|
3811
3811
|
* <p>The status of the job definition.</p>
|
|
3812
3812
|
* @public
|
|
3813
3813
|
*/
|
|
3814
|
-
status?: string;
|
|
3814
|
+
status?: string | undefined;
|
|
3815
3815
|
/**
|
|
3816
3816
|
* <p>The type of job definition. It's either <code>container</code> or <code>multinode</code>. If
|
|
3817
3817
|
* the job is run on Fargate resources, then <code>multinode</code> isn't supported. For more
|
|
@@ -3826,7 +3826,7 @@ export interface JobDefinition {
|
|
|
3826
3826
|
* scheduling priority.</p>
|
|
3827
3827
|
* @public
|
|
3828
3828
|
*/
|
|
3829
|
-
schedulingPriority?: number;
|
|
3829
|
+
schedulingPriority?: number | undefined;
|
|
3830
3830
|
/**
|
|
3831
3831
|
* <p>Default parameters or parameter substitution placeholders that are set in the job
|
|
3832
3832
|
* definition. Parameters are specified as a key-value pair mapping. Parameters in a
|
|
@@ -3835,26 +3835,26 @@ export interface JobDefinition {
|
|
|
3835
3835
|
* <i>Batch User Guide</i>.</p>
|
|
3836
3836
|
* @public
|
|
3837
3837
|
*/
|
|
3838
|
-
parameters?: Record<string, string
|
|
3838
|
+
parameters?: Record<string, string> | undefined;
|
|
3839
3839
|
/**
|
|
3840
3840
|
* <p>The retry strategy to use for failed jobs that are submitted with this job
|
|
3841
3841
|
* definition.</p>
|
|
3842
3842
|
* @public
|
|
3843
3843
|
*/
|
|
3844
|
-
retryStrategy?: RetryStrategy;
|
|
3844
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
3845
3845
|
/**
|
|
3846
3846
|
* <p>An object with properties specific to Amazon ECS-based jobs. When
|
|
3847
3847
|
* <code>containerProperties</code> is used in the job definition, it can't be used in addition to
|
|
3848
3848
|
* <code>eksProperties</code>, <code>ecsProperties</code>, or <code>nodeProperties</code>.</p>
|
|
3849
3849
|
* @public
|
|
3850
3850
|
*/
|
|
3851
|
-
containerProperties?: ContainerProperties;
|
|
3851
|
+
containerProperties?: ContainerProperties | undefined;
|
|
3852
3852
|
/**
|
|
3853
3853
|
* <p>The timeout time for jobs that are submitted with this job definition. After the amount of
|
|
3854
3854
|
* time you specify passes, Batch terminates your jobs if they aren't finished.</p>
|
|
3855
3855
|
* @public
|
|
3856
3856
|
*/
|
|
3857
|
-
timeout?: JobTimeout;
|
|
3857
|
+
timeout?: JobTimeout | undefined;
|
|
3858
3858
|
/**
|
|
3859
3859
|
* <p>An object with properties that are specific to multi-node parallel jobs. When
|
|
3860
3860
|
* <code>nodeProperties</code> is used in the job definition, it can't be used in addition to
|
|
@@ -3866,12 +3866,12 @@ export interface JobDefinition {
|
|
|
3866
3866
|
* </note>
|
|
3867
3867
|
* @public
|
|
3868
3868
|
*/
|
|
3869
|
-
nodeProperties?: NodeProperties;
|
|
3869
|
+
nodeProperties?: NodeProperties | undefined;
|
|
3870
3870
|
/**
|
|
3871
3871
|
* <p>The tags that are applied to the job definition.</p>
|
|
3872
3872
|
* @public
|
|
3873
3873
|
*/
|
|
3874
|
-
tags?: Record<string, string
|
|
3874
|
+
tags?: Record<string, string> | undefined;
|
|
3875
3875
|
/**
|
|
3876
3876
|
* <p>Specifies whether to propagate the tags from the job or job definition to the corresponding
|
|
3877
3877
|
* Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
|
|
@@ -3880,14 +3880,14 @@ export interface JobDefinition {
|
|
|
3880
3880
|
* is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
3881
3881
|
* @public
|
|
3882
3882
|
*/
|
|
3883
|
-
propagateTags?: boolean;
|
|
3883
|
+
propagateTags?: boolean | undefined;
|
|
3884
3884
|
/**
|
|
3885
3885
|
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
3886
3886
|
* defaults to <code>EC2</code>. Jobs run on Fargate resources specify
|
|
3887
3887
|
* <code>FARGATE</code>.</p>
|
|
3888
3888
|
* @public
|
|
3889
3889
|
*/
|
|
3890
|
-
platformCapabilities?: PlatformCapability[];
|
|
3890
|
+
platformCapabilities?: PlatformCapability[] | undefined;
|
|
3891
3891
|
/**
|
|
3892
3892
|
* <p>An object that contains the properties for the Amazon ECS resources of a job.When
|
|
3893
3893
|
* <code>ecsProperties</code> is used in the job definition, it can't be used in addition to
|
|
@@ -3895,7 +3895,7 @@ export interface JobDefinition {
|
|
|
3895
3895
|
* <code>nodeProperties</code>.</p>
|
|
3896
3896
|
* @public
|
|
3897
3897
|
*/
|
|
3898
|
-
ecsProperties?: EcsProperties;
|
|
3898
|
+
ecsProperties?: EcsProperties | undefined;
|
|
3899
3899
|
/**
|
|
3900
3900
|
* <p>An object with properties that are specific to Amazon EKS-based jobs. When
|
|
3901
3901
|
* <code>eksProperties</code> is used in the job definition, it can't be used in addition to
|
|
@@ -3903,13 +3903,13 @@ export interface JobDefinition {
|
|
|
3903
3903
|
* <code>nodeProperties</code>.</p>
|
|
3904
3904
|
* @public
|
|
3905
3905
|
*/
|
|
3906
|
-
eksProperties?: EksProperties;
|
|
3906
|
+
eksProperties?: EksProperties | undefined;
|
|
3907
3907
|
/**
|
|
3908
3908
|
* <p>The orchestration type of the compute environment. The valid values are <code>ECS</code>
|
|
3909
3909
|
* (default) or <code>EKS</code>.</p>
|
|
3910
3910
|
* @public
|
|
3911
3911
|
*/
|
|
3912
|
-
containerOrchestrationType?: OrchestrationType;
|
|
3912
|
+
containerOrchestrationType?: OrchestrationType | undefined;
|
|
3913
3913
|
}
|
|
3914
3914
|
/**
|
|
3915
3915
|
* @public
|
|
@@ -3919,7 +3919,7 @@ export interface DescribeJobDefinitionsResponse {
|
|
|
3919
3919
|
* <p>The list of job definitions.</p>
|
|
3920
3920
|
* @public
|
|
3921
3921
|
*/
|
|
3922
|
-
jobDefinitions?: JobDefinition[];
|
|
3922
|
+
jobDefinitions?: JobDefinition[] | undefined;
|
|
3923
3923
|
/**
|
|
3924
3924
|
* <p>The <code>nextToken</code> value to include in a future
|
|
3925
3925
|
* <code>DescribeJobDefinitions</code> request. When the results of a
|
|
@@ -3928,7 +3928,7 @@ export interface DescribeJobDefinitionsResponse {
|
|
|
3928
3928
|
* no more results to return.</p>
|
|
3929
3929
|
* @public
|
|
3930
3930
|
*/
|
|
3931
|
-
nextToken?: string;
|
|
3931
|
+
nextToken?: string | undefined;
|
|
3932
3932
|
}
|
|
3933
3933
|
/**
|
|
3934
3934
|
* <p>Contains the parameters for <code>DescribeJobQueues</code>.</p>
|
|
@@ -3939,7 +3939,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
3939
3939
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.</p>
|
|
3940
3940
|
* @public
|
|
3941
3941
|
*/
|
|
3942
|
-
jobQueues?: string[];
|
|
3942
|
+
jobQueues?: string[] | undefined;
|
|
3943
3943
|
/**
|
|
3944
3944
|
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated
|
|
3945
3945
|
* output. When this parameter is used, <code>DescribeJobQueues</code> only returns
|
|
@@ -3951,7 +3951,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
3951
3951
|
* <code>nextToken</code> value if applicable.</p>
|
|
3952
3952
|
* @public
|
|
3953
3953
|
*/
|
|
3954
|
-
maxResults?: number;
|
|
3954
|
+
maxResults?: number | undefined;
|
|
3955
3955
|
/**
|
|
3956
3956
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
3957
3957
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used and the
|
|
@@ -3964,7 +3964,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
3964
3964
|
* </note>
|
|
3965
3965
|
* @public
|
|
3966
3966
|
*/
|
|
3967
|
-
nextToken?: string;
|
|
3967
|
+
nextToken?: string | undefined;
|
|
3968
3968
|
}
|
|
3969
3969
|
/**
|
|
3970
3970
|
* @public
|
|
@@ -4012,19 +4012,19 @@ export interface JobQueueDetail {
|
|
|
4012
4012
|
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
4013
4013
|
* @public
|
|
4014
4014
|
*/
|
|
4015
|
-
schedulingPolicyArn?: string;
|
|
4015
|
+
schedulingPolicyArn?: string | undefined;
|
|
4016
4016
|
/**
|
|
4017
4017
|
* <p>The status of the job queue (for example, <code>CREATING</code> or
|
|
4018
4018
|
* <code>VALID</code>).</p>
|
|
4019
4019
|
* @public
|
|
4020
4020
|
*/
|
|
4021
|
-
status?: JQStatus;
|
|
4021
|
+
status?: JQStatus | undefined;
|
|
4022
4022
|
/**
|
|
4023
4023
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
4024
4024
|
* job queue.</p>
|
|
4025
4025
|
* @public
|
|
4026
4026
|
*/
|
|
4027
|
-
statusReason?: string;
|
|
4027
|
+
statusReason?: string | undefined;
|
|
4028
4028
|
/**
|
|
4029
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>
|
|
4030
4030
|
* @public
|
|
@@ -4041,12 +4041,12 @@ export interface JobQueueDetail {
|
|
|
4041
4041
|
* <i>Batch User Guide</i>.</p>
|
|
4042
4042
|
* @public
|
|
4043
4043
|
*/
|
|
4044
|
-
tags?: Record<string, string
|
|
4044
|
+
tags?: Record<string, string> | undefined;
|
|
4045
4045
|
/**
|
|
4046
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>
|
|
4047
4047
|
* @public
|
|
4048
4048
|
*/
|
|
4049
|
-
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
|
|
4049
|
+
jobStateTimeLimitActions?: JobStateTimeLimitAction[] | undefined;
|
|
4050
4050
|
}
|
|
4051
4051
|
/**
|
|
4052
4052
|
* @public
|
|
@@ -4056,7 +4056,7 @@ export interface DescribeJobQueuesResponse {
|
|
|
4056
4056
|
* <p>The list of job queues.</p>
|
|
4057
4057
|
* @public
|
|
4058
4058
|
*/
|
|
4059
|
-
jobQueues?: JobQueueDetail[];
|
|
4059
|
+
jobQueues?: JobQueueDetail[] | undefined;
|
|
4060
4060
|
/**
|
|
4061
4061
|
* <p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code>
|
|
4062
4062
|
* request. When the results of a <code>DescribeJobQueues</code> request exceed
|
|
@@ -4064,7 +4064,7 @@ export interface DescribeJobQueuesResponse {
|
|
|
4064
4064
|
* value is <code>null</code> when there are no more results to return.</p>
|
|
4065
4065
|
* @public
|
|
4066
4066
|
*/
|
|
4067
|
-
nextToken?: string;
|
|
4067
|
+
nextToken?: string | undefined;
|
|
4068
4068
|
}
|
|
4069
4069
|
/**
|
|
4070
4070
|
* <p>Contains the parameters for <code>DescribeJobs</code>.</p>
|
|
@@ -4086,7 +4086,7 @@ export interface ContainerDetail {
|
|
|
4086
4086
|
* <p>The image used to start the container.</p>
|
|
4087
4087
|
* @public
|
|
4088
4088
|
*/
|
|
4089
|
-
image?: string;
|
|
4089
|
+
image?: string | undefined;
|
|
4090
4090
|
/**
|
|
4091
4091
|
* <p>The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you
|
|
4092
4092
|
* can specify the vCPU requirement for the job using <code>resourceRequirements</code>, but you
|
|
@@ -4103,24 +4103,24 @@ export interface ContainerDetail {
|
|
|
4103
4103
|
* </note>
|
|
4104
4104
|
* @public
|
|
4105
4105
|
*/
|
|
4106
|
-
vcpus?: number;
|
|
4106
|
+
vcpus?: number | undefined;
|
|
4107
4107
|
/**
|
|
4108
4108
|
* <p>For jobs running on Amazon EC2 resources that didn't specify memory requirements using
|
|
4109
4109
|
* <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other
|
|
4110
4110
|
* jobs, including all run on Fargate resources, see <code>resourceRequirements</code>.</p>
|
|
4111
4111
|
* @public
|
|
4112
4112
|
*/
|
|
4113
|
-
memory?: number;
|
|
4113
|
+
memory?: number | undefined;
|
|
4114
4114
|
/**
|
|
4115
4115
|
* <p>The command that's passed to the container.</p>
|
|
4116
4116
|
* @public
|
|
4117
4117
|
*/
|
|
4118
|
-
command?: string[];
|
|
4118
|
+
command?: string[] | undefined;
|
|
4119
4119
|
/**
|
|
4120
4120
|
* <p>The Amazon Resource Name (ARN) that's associated with the job when run.</p>
|
|
4121
4121
|
* @public
|
|
4122
4122
|
*/
|
|
4123
|
-
jobRoleArn?: string;
|
|
4123
|
+
jobRoleArn?: string | undefined;
|
|
4124
4124
|
/**
|
|
4125
4125
|
* <p>The Amazon Resource Name (ARN) of the
|
|
4126
4126
|
* execution
|
|
@@ -4129,12 +4129,12 @@ export interface ContainerDetail {
|
|
|
4129
4129
|
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
4130
4130
|
* @public
|
|
4131
4131
|
*/
|
|
4132
|
-
executionRoleArn?: string;
|
|
4132
|
+
executionRoleArn?: string | undefined;
|
|
4133
4133
|
/**
|
|
4134
4134
|
* <p>A list of volumes that are associated with the job.</p>
|
|
4135
4135
|
* @public
|
|
4136
4136
|
*/
|
|
4137
|
-
volumes?: Volume[];
|
|
4137
|
+
volumes?: Volume[] | undefined;
|
|
4138
4138
|
/**
|
|
4139
4139
|
* <p>The environment variables to pass to a container.</p>
|
|
4140
4140
|
* <note>
|
|
@@ -4143,12 +4143,12 @@ export interface ContainerDetail {
|
|
|
4143
4143
|
* </note>
|
|
4144
4144
|
* @public
|
|
4145
4145
|
*/
|
|
4146
|
-
environment?: KeyValuePair[];
|
|
4146
|
+
environment?: KeyValuePair[] | undefined;
|
|
4147
4147
|
/**
|
|
4148
4148
|
* <p>The mount points for data volumes in your container.</p>
|
|
4149
4149
|
* @public
|
|
4150
4150
|
*/
|
|
4151
|
-
mountPoints?: MountPoint[];
|
|
4151
|
+
mountPoints?: MountPoint[] | undefined;
|
|
4152
4152
|
/**
|
|
4153
4153
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
4154
4154
|
* system. This parameter maps to <code>ReadonlyRootfs</code> in the
|
|
@@ -4159,7 +4159,7 @@ export interface ContainerDetail {
|
|
|
4159
4159
|
* </a>.</p>
|
|
4160
4160
|
* @public
|
|
4161
4161
|
*/
|
|
4162
|
-
readonlyRootFilesystem?: boolean;
|
|
4162
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
4163
4163
|
/**
|
|
4164
4164
|
* <p>A list of <code>ulimit</code> values to set in the container. This parameter maps to
|
|
4165
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>
|
|
@@ -4170,7 +4170,7 @@ export interface ContainerDetail {
|
|
|
4170
4170
|
* </note>
|
|
4171
4171
|
* @public
|
|
4172
4172
|
*/
|
|
4173
|
-
ulimits?: Ulimit[];
|
|
4173
|
+
ulimits?: Ulimit[] | undefined;
|
|
4174
4174
|
/**
|
|
4175
4175
|
* <p>When this parameter is true, the container is given elevated permissions on the host
|
|
4176
4176
|
* container instance (similar to the <code>root</code> user). The default value is
|
|
@@ -4181,43 +4181,43 @@ export interface ContainerDetail {
|
|
|
4181
4181
|
* </note>
|
|
4182
4182
|
* @public
|
|
4183
4183
|
*/
|
|
4184
|
-
privileged?: boolean;
|
|
4184
|
+
privileged?: boolean | undefined;
|
|
4185
4185
|
/**
|
|
4186
4186
|
* <p>The user name to use inside the container. This parameter maps to <code>User</code> in the
|
|
4187
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>
|
|
4188
4188
|
* option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
4189
4189
|
* @public
|
|
4190
4190
|
*/
|
|
4191
|
-
user?: string;
|
|
4191
|
+
user?: string | undefined;
|
|
4192
4192
|
/**
|
|
4193
4193
|
* <p>The exit code returned upon completion.</p>
|
|
4194
4194
|
* @public
|
|
4195
4195
|
*/
|
|
4196
|
-
exitCode?: number;
|
|
4196
|
+
exitCode?: number | undefined;
|
|
4197
4197
|
/**
|
|
4198
4198
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4199
4199
|
* running or stopped container.</p>
|
|
4200
4200
|
* @public
|
|
4201
4201
|
*/
|
|
4202
|
-
reason?: string;
|
|
4202
|
+
reason?: string | undefined;
|
|
4203
4203
|
/**
|
|
4204
4204
|
* <p>The Amazon Resource Name (ARN) of the container instance that the container is running on.</p>
|
|
4205
4205
|
* @public
|
|
4206
4206
|
*/
|
|
4207
|
-
containerInstanceArn?: string;
|
|
4207
|
+
containerInstanceArn?: string | undefined;
|
|
4208
4208
|
/**
|
|
4209
4209
|
* <p>The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container
|
|
4210
4210
|
* attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>
|
|
4211
4211
|
* @public
|
|
4212
4212
|
*/
|
|
4213
|
-
taskArn?: string;
|
|
4213
|
+
taskArn?: string | undefined;
|
|
4214
4214
|
/**
|
|
4215
4215
|
* <p>The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for
|
|
4216
4216
|
* Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name
|
|
4217
4217
|
* when they reach the <code>RUNNING</code> status.</p>
|
|
4218
4218
|
* @public
|
|
4219
4219
|
*/
|
|
4220
|
-
logStreamName?: string;
|
|
4220
|
+
logStreamName?: string | undefined;
|
|
4221
4221
|
/**
|
|
4222
4222
|
* <p>The instance type of the underlying host infrastructure of a multi-node parallel job.</p>
|
|
4223
4223
|
* <note>
|
|
@@ -4225,24 +4225,24 @@ export interface ContainerDetail {
|
|
|
4225
4225
|
* </note>
|
|
4226
4226
|
* @public
|
|
4227
4227
|
*/
|
|
4228
|
-
instanceType?: string;
|
|
4228
|
+
instanceType?: string | undefined;
|
|
4229
4229
|
/**
|
|
4230
4230
|
* <p>The network interfaces that are associated with the job.</p>
|
|
4231
4231
|
* @public
|
|
4232
4232
|
*/
|
|
4233
|
-
networkInterfaces?: NetworkInterface[];
|
|
4233
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
4234
4234
|
/**
|
|
4235
4235
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
4236
4236
|
* <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
4237
4237
|
* @public
|
|
4238
4238
|
*/
|
|
4239
|
-
resourceRequirements?: ResourceRequirement[];
|
|
4239
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
4240
4240
|
/**
|
|
4241
4241
|
* <p>Linux-specific modifications that are applied to the container, such as details for device
|
|
4242
4242
|
* mappings.</p>
|
|
4243
4243
|
* @public
|
|
4244
4244
|
*/
|
|
4245
|
-
linuxParameters?: LinuxParameters;
|
|
4245
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
4246
4246
|
/**
|
|
4247
4247
|
* <p>The log configuration specification for the container.</p>
|
|
4248
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>
|
|
@@ -4272,43 +4272,43 @@ export interface ContainerDetail {
|
|
|
4272
4272
|
* </note>
|
|
4273
4273
|
* @public
|
|
4274
4274
|
*/
|
|
4275
|
-
logConfiguration?: LogConfiguration;
|
|
4275
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
4276
4276
|
/**
|
|
4277
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
|
|
4278
4278
|
* <i>Batch User Guide</i>.</p>
|
|
4279
4279
|
* @public
|
|
4280
4280
|
*/
|
|
4281
|
-
secrets?: Secret[];
|
|
4281
|
+
secrets?: Secret[] | undefined;
|
|
4282
4282
|
/**
|
|
4283
4283
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4284
4284
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4285
4285
|
* @public
|
|
4286
4286
|
*/
|
|
4287
|
-
networkConfiguration?: NetworkConfiguration;
|
|
4287
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
4288
4288
|
/**
|
|
4289
4289
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4290
4290
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4291
4291
|
* @public
|
|
4292
4292
|
*/
|
|
4293
|
-
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
4293
|
+
fargatePlatformConfiguration?: FargatePlatformConfiguration | undefined;
|
|
4294
4294
|
/**
|
|
4295
4295
|
* <p>The amount of ephemeral storage allocated for the task. This parameter is used to expand the
|
|
4296
4296
|
* total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
|
|
4297
4297
|
* Fargate.</p>
|
|
4298
4298
|
* @public
|
|
4299
4299
|
*/
|
|
4300
|
-
ephemeralStorage?: EphemeralStorage;
|
|
4300
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
4301
4301
|
/**
|
|
4302
4302
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4303
4303
|
* Fargate.</p>
|
|
4304
4304
|
* @public
|
|
4305
4305
|
*/
|
|
4306
|
-
runtimePlatform?: RuntimePlatform;
|
|
4306
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
4307
4307
|
/**
|
|
4308
4308
|
* <p>The private repository authentication credentials to use.</p>
|
|
4309
4309
|
* @public
|
|
4310
4310
|
*/
|
|
4311
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
4311
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
4312
4312
|
}
|
|
4313
4313
|
/**
|
|
4314
4314
|
* <p>An object that represents an Batch job dependency.</p>
|
|
@@ -4319,12 +4319,12 @@ export interface JobDependency {
|
|
|
4319
4319
|
* <p>The job ID of the Batch job that's associated with this dependency.</p>
|
|
4320
4320
|
* @public
|
|
4321
4321
|
*/
|
|
4322
|
-
jobId?: string;
|
|
4322
|
+
jobId?: string | undefined;
|
|
4323
4323
|
/**
|
|
4324
4324
|
* <p>The type of the job dependency.</p>
|
|
4325
4325
|
* @public
|
|
4326
4326
|
*/
|
|
4327
|
-
type?: ArrayJobDependency;
|
|
4327
|
+
type?: ArrayJobDependency | undefined;
|
|
4328
4328
|
}
|
|
4329
4329
|
/**
|
|
4330
4330
|
* <p>The details for the container in this task attempt.</p>
|
|
@@ -4338,12 +4338,12 @@ export interface TaskContainerDetails {
|
|
|
4338
4338
|
* <a href="https://docs.docker.com/engine/reference/builder/#cmd">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>
|
|
4339
4339
|
* @public
|
|
4340
4340
|
*/
|
|
4341
|
-
command?: string[];
|
|
4341
|
+
command?: string[] | undefined;
|
|
4342
4342
|
/**
|
|
4343
4343
|
* <p>A list of containers that this container depends on.</p>
|
|
4344
4344
|
* @public
|
|
4345
4345
|
*/
|
|
4346
|
-
dependsOn?: TaskContainerDependency[];
|
|
4346
|
+
dependsOn?: TaskContainerDependency[] | undefined;
|
|
4347
4347
|
/**
|
|
4348
4348
|
* <p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in
|
|
4349
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
|
|
@@ -4354,7 +4354,7 @@ export interface TaskContainerDetails {
|
|
|
4354
4354
|
* </important>
|
|
4355
4355
|
* @public
|
|
4356
4356
|
*/
|
|
4357
|
-
environment?: KeyValuePair[];
|
|
4357
|
+
environment?: KeyValuePair[] | undefined;
|
|
4358
4358
|
/**
|
|
4359
4359
|
* <p>If the essential parameter of a container is marked as <code>true</code>, and that container
|
|
4360
4360
|
* fails or stops for any reason, all other containers that are part of the task are stopped. If the
|
|
@@ -4368,7 +4368,7 @@ export interface TaskContainerDetails {
|
|
|
4368
4368
|
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4369
4369
|
* @public
|
|
4370
4370
|
*/
|
|
4371
|
-
essential?: boolean;
|
|
4371
|
+
essential?: boolean | undefined;
|
|
4372
4372
|
/**
|
|
4373
4373
|
* <p>The image used to start a container. This string is passed directly to the Docker daemon. By
|
|
4374
4374
|
* default, images in the Docker Hub registry are available. Other repositories are specified with
|
|
@@ -4382,7 +4382,7 @@ export interface TaskContainerDetails {
|
|
|
4382
4382
|
* </a>.</p>
|
|
4383
4383
|
* @public
|
|
4384
4384
|
*/
|
|
4385
|
-
image?: string;
|
|
4385
|
+
image?: string | undefined;
|
|
4386
4386
|
/**
|
|
4387
4387
|
* <p>Linux-specific modifications that are applied to the container, such as Linux kernel
|
|
4388
4388
|
* capabilities. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
|
|
@@ -4391,7 +4391,7 @@ export interface TaskContainerDetails {
|
|
|
4391
4391
|
* </note>
|
|
4392
4392
|
* @public
|
|
4393
4393
|
*/
|
|
4394
|
-
linuxParameters?: LinuxParameters;
|
|
4394
|
+
linuxParameters?: LinuxParameters | undefined;
|
|
4395
4395
|
/**
|
|
4396
4396
|
* <p>The log configuration specification for the container.</p>
|
|
4397
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
|
|
@@ -4424,7 +4424,7 @@ export interface TaskContainerDetails {
|
|
|
4424
4424
|
* </note>
|
|
4425
4425
|
* @public
|
|
4426
4426
|
*/
|
|
4427
|
-
logConfiguration?: LogConfiguration;
|
|
4427
|
+
logConfiguration?: LogConfiguration | undefined;
|
|
4428
4428
|
/**
|
|
4429
4429
|
* <p>The mount points for data volumes in your container.</p>
|
|
4430
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
|
|
@@ -4436,12 +4436,12 @@ export interface TaskContainerDetails {
|
|
|
4436
4436
|
* and mount point can't be across drives.</p>
|
|
4437
4437
|
* @public
|
|
4438
4438
|
*/
|
|
4439
|
-
mountPoints?: MountPoint[];
|
|
4439
|
+
mountPoints?: MountPoint[] | undefined;
|
|
4440
4440
|
/**
|
|
4441
4441
|
* <p>The name of a container.</p>
|
|
4442
4442
|
* @public
|
|
4443
4443
|
*/
|
|
4444
|
-
name?: string;
|
|
4444
|
+
name?: string | undefined;
|
|
4445
4445
|
/**
|
|
4446
4446
|
* <p>When this parameter is <code>true</code>, the container is given elevated privileges on the
|
|
4447
4447
|
* host container instance (similar to the <code>root</code> user). This parameter maps to
|
|
@@ -4454,7 +4454,7 @@ export interface TaskContainerDetails {
|
|
|
4454
4454
|
* </note>
|
|
4455
4455
|
* @public
|
|
4456
4456
|
*/
|
|
4457
|
-
privileged?: boolean;
|
|
4457
|
+
privileged?: boolean | undefined;
|
|
4458
4458
|
/**
|
|
4459
4459
|
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
4460
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
|
|
@@ -4466,24 +4466,24 @@ export interface TaskContainerDetails {
|
|
|
4466
4466
|
* </note>
|
|
4467
4467
|
* @public
|
|
4468
4468
|
*/
|
|
4469
|
-
readonlyRootFilesystem?: boolean;
|
|
4469
|
+
readonlyRootFilesystem?: boolean | undefined;
|
|
4470
4470
|
/**
|
|
4471
4471
|
* <p>The private repository authentication credentials to use.</p>
|
|
4472
4472
|
* @public
|
|
4473
4473
|
*/
|
|
4474
|
-
repositoryCredentials?: RepositoryCredentials;
|
|
4474
|
+
repositoryCredentials?: RepositoryCredentials | undefined;
|
|
4475
4475
|
/**
|
|
4476
4476
|
* <p>The type and amount of a resource to assign to a container. The only supported resource is a
|
|
4477
4477
|
* GPU.</p>
|
|
4478
4478
|
* @public
|
|
4479
4479
|
*/
|
|
4480
|
-
resourceRequirements?: ResourceRequirement[];
|
|
4480
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
4481
4481
|
/**
|
|
4482
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
|
|
4483
4483
|
* Data</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
4484
4484
|
* @public
|
|
4485
4485
|
*/
|
|
4486
|
-
secrets?: Secret[];
|
|
4486
|
+
secrets?: Secret[] | undefined;
|
|
4487
4487
|
/**
|
|
4488
4488
|
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value is
|
|
4489
4489
|
* specified in a task definition, it overrides the default values set by Docker. This parameter
|
|
@@ -4506,7 +4506,7 @@ export interface TaskContainerDetails {
|
|
|
4506
4506
|
* </note>
|
|
4507
4507
|
* @public
|
|
4508
4508
|
*/
|
|
4509
|
-
ulimits?: Ulimit[];
|
|
4509
|
+
ulimits?: Ulimit[] | undefined;
|
|
4510
4510
|
/**
|
|
4511
4511
|
* <p>The user to use inside the container. This parameter maps to User in the Create a container
|
|
4512
4512
|
* section of the Docker Remote API and the --user option to docker run.</p>
|
|
@@ -4558,30 +4558,30 @@ export interface TaskContainerDetails {
|
|
|
4558
4558
|
* </note>
|
|
4559
4559
|
* @public
|
|
4560
4560
|
*/
|
|
4561
|
-
user?: string;
|
|
4561
|
+
user?: string | undefined;
|
|
4562
4562
|
/**
|
|
4563
4563
|
* <p>The exit code returned upon completion.</p>
|
|
4564
4564
|
* @public
|
|
4565
4565
|
*/
|
|
4566
|
-
exitCode?: number;
|
|
4566
|
+
exitCode?: number | undefined;
|
|
4567
4567
|
/**
|
|
4568
4568
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4569
4569
|
* running or stopped container.</p>
|
|
4570
4570
|
* @public
|
|
4571
4571
|
*/
|
|
4572
|
-
reason?: string;
|
|
4572
|
+
reason?: string | undefined;
|
|
4573
4573
|
/**
|
|
4574
4574
|
* <p>The name of the CloudWatch Logs log stream that's associated with the container. The log group for
|
|
4575
4575
|
* Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach
|
|
4576
4576
|
* the <code>RUNNING</code> status. </p>
|
|
4577
4577
|
* @public
|
|
4578
4578
|
*/
|
|
4579
|
-
logStreamName?: string;
|
|
4579
|
+
logStreamName?: string | undefined;
|
|
4580
4580
|
/**
|
|
4581
4581
|
* <p>The network interfaces that are associated with the job.</p>
|
|
4582
4582
|
* @public
|
|
4583
4583
|
*/
|
|
4584
|
-
networkInterfaces?: NetworkInterface[];
|
|
4584
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
4585
4585
|
}
|
|
4586
4586
|
/**
|
|
4587
4587
|
* <p>The details of a task definition that describes the container and volume definitions of an
|
|
@@ -4593,39 +4593,39 @@ export interface EcsTaskDetails {
|
|
|
4593
4593
|
* <p>A list of containers that are included in the <code>taskProperties</code> list.</p>
|
|
4594
4594
|
* @public
|
|
4595
4595
|
*/
|
|
4596
|
-
containers?: TaskContainerDetails[];
|
|
4596
|
+
containers?: TaskContainerDetails[] | undefined;
|
|
4597
4597
|
/**
|
|
4598
4598
|
* <p>The Amazon Resource Name (ARN) of the container instance that hosts the task.</p>
|
|
4599
4599
|
* @public
|
|
4600
4600
|
*/
|
|
4601
|
-
containerInstanceArn?: string;
|
|
4601
|
+
containerInstanceArn?: string | undefined;
|
|
4602
4602
|
/**
|
|
4603
4603
|
* <p>The ARN of the Amazon ECS task.</p>
|
|
4604
4604
|
* @public
|
|
4605
4605
|
*/
|
|
4606
|
-
taskArn?: string;
|
|
4606
|
+
taskArn?: string | undefined;
|
|
4607
4607
|
/**
|
|
4608
4608
|
* <p>The amount of ephemeral storage allocated for the task.</p>
|
|
4609
4609
|
* @public
|
|
4610
4610
|
*/
|
|
4611
|
-
ephemeralStorage?: EphemeralStorage;
|
|
4611
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
4612
4612
|
/**
|
|
4613
4613
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see
|
|
4614
4614
|
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM
|
|
4615
4615
|
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
4616
4616
|
* @public
|
|
4617
4617
|
*/
|
|
4618
|
-
executionRoleArn?: string;
|
|
4618
|
+
executionRoleArn?: string | undefined;
|
|
4619
4619
|
/**
|
|
4620
4620
|
* <p>The Fargate platform version where the jobs are running.</p>
|
|
4621
4621
|
* @public
|
|
4622
4622
|
*/
|
|
4623
|
-
platformVersion?: string;
|
|
4623
|
+
platformVersion?: string | undefined;
|
|
4624
4624
|
/**
|
|
4625
4625
|
* <p>The IPC resource namespace to use for the containers in the task.</p>
|
|
4626
4626
|
* @public
|
|
4627
4627
|
*/
|
|
4628
|
-
ipcMode?: string;
|
|
4628
|
+
ipcMode?: string | undefined;
|
|
4629
4629
|
/**
|
|
4630
4630
|
* <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more
|
|
4631
4631
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the
|
|
@@ -4635,29 +4635,29 @@ export interface EcsTaskDetails {
|
|
|
4635
4635
|
* </note>
|
|
4636
4636
|
* @public
|
|
4637
4637
|
*/
|
|
4638
|
-
taskRoleArn?: string;
|
|
4638
|
+
taskRoleArn?: string | undefined;
|
|
4639
4639
|
/**
|
|
4640
4640
|
* <p>The process namespace to use for the containers in the task.</p>
|
|
4641
4641
|
* @public
|
|
4642
4642
|
*/
|
|
4643
|
-
pidMode?: string;
|
|
4643
|
+
pidMode?: string | undefined;
|
|
4644
4644
|
/**
|
|
4645
4645
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4646
4646
|
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4647
4647
|
* @public
|
|
4648
4648
|
*/
|
|
4649
|
-
networkConfiguration?: NetworkConfiguration;
|
|
4649
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
4650
4650
|
/**
|
|
4651
4651
|
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4652
4652
|
* Fargate.</p>
|
|
4653
4653
|
* @public
|
|
4654
4654
|
*/
|
|
4655
|
-
runtimePlatform?: RuntimePlatform;
|
|
4655
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
4656
4656
|
/**
|
|
4657
4657
|
* <p>A list of data volumes used in a job.</p>
|
|
4658
4658
|
* @public
|
|
4659
4659
|
*/
|
|
4660
|
-
volumes?: Volume[];
|
|
4660
|
+
volumes?: Volume[] | undefined;
|
|
4661
4661
|
}
|
|
4662
4662
|
/**
|
|
4663
4663
|
* <p>An object that contains the details for the Amazon ECS resources of a job.</p>
|
|
@@ -4668,7 +4668,7 @@ export interface EcsPropertiesDetail {
|
|
|
4668
4668
|
* <p>The properties for the Amazon ECS task definition of a job.</p>
|
|
4669
4669
|
* @public
|
|
4670
4670
|
*/
|
|
4671
|
-
taskProperties?: EcsTaskDetails[];
|
|
4671
|
+
taskProperties?: EcsTaskDetails[] | undefined;
|
|
4672
4672
|
}
|
|
4673
4673
|
/**
|
|
4674
4674
|
* <p>An object that represents the details for an attempt for a job attempt that an Amazon EKS
|
|
@@ -4680,24 +4680,24 @@ export interface EksAttemptContainerDetail {
|
|
|
4680
4680
|
* <p>The name of a container.</p>
|
|
4681
4681
|
* @public
|
|
4682
4682
|
*/
|
|
4683
|
-
name?: string;
|
|
4683
|
+
name?: string | undefined;
|
|
4684
4684
|
/**
|
|
4685
4685
|
* <p>The ID for the container.</p>
|
|
4686
4686
|
* @public
|
|
4687
4687
|
*/
|
|
4688
|
-
containerID?: string;
|
|
4688
|
+
containerID?: string | undefined;
|
|
4689
4689
|
/**
|
|
4690
4690
|
* <p>The exit code returned for the job attempt. A non-zero exit code is considered
|
|
4691
4691
|
* failed.</p>
|
|
4692
4692
|
* @public
|
|
4693
4693
|
*/
|
|
4694
|
-
exitCode?: number;
|
|
4694
|
+
exitCode?: number | undefined;
|
|
4695
4695
|
/**
|
|
4696
4696
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4697
4697
|
* running or stopped container.</p>
|
|
4698
4698
|
* @public
|
|
4699
4699
|
*/
|
|
4700
|
-
reason?: string;
|
|
4700
|
+
reason?: string | undefined;
|
|
4701
4701
|
}
|
|
4702
4702
|
/**
|
|
4703
4703
|
* <p>An object that represents the details of a job attempt for a job attempt by an Amazon EKS
|
|
@@ -4709,51 +4709,51 @@ export interface EksAttemptDetail {
|
|
|
4709
4709
|
* <p>The details for the final status of the containers for this job attempt.</p>
|
|
4710
4710
|
* @public
|
|
4711
4711
|
*/
|
|
4712
|
-
containers?: EksAttemptContainerDetail[];
|
|
4712
|
+
containers?: EksAttemptContainerDetail[] | undefined;
|
|
4713
4713
|
/**
|
|
4714
4714
|
* <p>The details for the init containers.</p>
|
|
4715
4715
|
* @public
|
|
4716
4716
|
*/
|
|
4717
|
-
initContainers?: EksAttemptContainerDetail[];
|
|
4717
|
+
initContainers?: EksAttemptContainerDetail[] | undefined;
|
|
4718
4718
|
/**
|
|
4719
4719
|
* <p>The Amazon Resource Name (ARN) of the Amazon EKS cluster.</p>
|
|
4720
4720
|
* @public
|
|
4721
4721
|
*/
|
|
4722
|
-
eksClusterArn?: string;
|
|
4722
|
+
eksClusterArn?: string | undefined;
|
|
4723
4723
|
/**
|
|
4724
4724
|
* <p>The name of the pod for this job attempt.</p>
|
|
4725
4725
|
* @public
|
|
4726
4726
|
*/
|
|
4727
|
-
podName?: string;
|
|
4727
|
+
podName?: string | undefined;
|
|
4728
4728
|
/**
|
|
4729
4729
|
* <p>The namespace of the Amazon EKS cluster that the pod exists in.</p>
|
|
4730
4730
|
* @public
|
|
4731
4731
|
*/
|
|
4732
|
-
podNamespace?: string;
|
|
4732
|
+
podNamespace?: string | undefined;
|
|
4733
4733
|
/**
|
|
4734
4734
|
* <p>The name of the node for this job attempt.</p>
|
|
4735
4735
|
* @public
|
|
4736
4736
|
*/
|
|
4737
|
-
nodeName?: string;
|
|
4737
|
+
nodeName?: string | undefined;
|
|
4738
4738
|
/**
|
|
4739
4739
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
|
|
4740
4740
|
* transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
|
|
4741
4741
|
* @public
|
|
4742
4742
|
*/
|
|
4743
|
-
startedAt?: number;
|
|
4743
|
+
startedAt?: number | undefined;
|
|
4744
4744
|
/**
|
|
4745
4745
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the
|
|
4746
4746
|
* attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as
|
|
4747
4747
|
* <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
4748
4748
|
* @public
|
|
4749
4749
|
*/
|
|
4750
|
-
stoppedAt?: number;
|
|
4750
|
+
stoppedAt?: number | undefined;
|
|
4751
4751
|
/**
|
|
4752
4752
|
* <p>A short, human-readable string to provide additional details for the current status of the
|
|
4753
4753
|
* job attempt.</p>
|
|
4754
4754
|
* @public
|
|
4755
4755
|
*/
|
|
4756
|
-
statusReason?: string;
|
|
4756
|
+
statusReason?: string | undefined;
|
|
4757
4757
|
}
|
|
4758
4758
|
/**
|
|
4759
4759
|
* <p>The details for container properties that are returned by <code>DescribeJobs</code> for jobs
|
|
@@ -4766,12 +4766,12 @@ export interface EksContainerDetail {
|
|
|
4766
4766
|
* "<code>Default</code>" is used. Each container in a pod must have a unique name.</p>
|
|
4767
4767
|
* @public
|
|
4768
4768
|
*/
|
|
4769
|
-
name?: string;
|
|
4769
|
+
name?: string | undefined;
|
|
4770
4770
|
/**
|
|
4771
4771
|
* <p>The Docker image used to start the container.</p>
|
|
4772
4772
|
* @public
|
|
4773
4773
|
*/
|
|
4774
|
-
image?: string;
|
|
4774
|
+
image?: string | undefined;
|
|
4775
4775
|
/**
|
|
4776
4776
|
* <p>The image pull policy for the container. Supported values are <code>Always</code>,
|
|
4777
4777
|
* <code>IfNotPresent</code>, and <code>Never</code>. This parameter defaults to
|
|
@@ -4780,12 +4780,12 @@ export interface EksContainerDetail {
|
|
|
4780
4780
|
* images</a> in the <i>Kubernetes documentation</i>.</p>
|
|
4781
4781
|
* @public
|
|
4782
4782
|
*/
|
|
4783
|
-
imagePullPolicy?: string;
|
|
4783
|
+
imagePullPolicy?: string | undefined;
|
|
4784
4784
|
/**
|
|
4785
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>
|
|
4786
4786
|
* @public
|
|
4787
4787
|
*/
|
|
4788
|
-
command?: string[];
|
|
4788
|
+
command?: string[] | undefined;
|
|
4789
4789
|
/**
|
|
4790
4790
|
* <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of
|
|
4791
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>
|
|
@@ -4800,7 +4800,7 @@ export interface EksContainerDetail {
|
|
|
4800
4800
|
* documentation</i>.</p>
|
|
4801
4801
|
* @public
|
|
4802
4802
|
*/
|
|
4803
|
-
args?: string[];
|
|
4803
|
+
args?: string[] | undefined;
|
|
4804
4804
|
/**
|
|
4805
4805
|
* <p>The environment variables to pass to a container.</p>
|
|
4806
4806
|
* <note>
|
|
@@ -4809,7 +4809,7 @@ export interface EksContainerDetail {
|
|
|
4809
4809
|
* </note>
|
|
4810
4810
|
* @public
|
|
4811
4811
|
*/
|
|
4812
|
-
env?: EksContainerEnvironmentVariable[];
|
|
4812
|
+
env?: EksContainerEnvironmentVariable[] | undefined;
|
|
4813
4813
|
/**
|
|
4814
4814
|
* <p>The type and amount of resources to assign to a container. The supported resources include
|
|
4815
4815
|
* <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information,
|
|
@@ -4817,33 +4817,33 @@ export interface EksContainerDetail {
|
|
|
4817
4817
|
* documentation</i>.</p>
|
|
4818
4818
|
* @public
|
|
4819
4819
|
*/
|
|
4820
|
-
resources?: EksContainerResourceRequirements;
|
|
4820
|
+
resources?: EksContainerResourceRequirements | undefined;
|
|
4821
4821
|
/**
|
|
4822
4822
|
* <p>The exit code returned for the job attempt. A non-zero exit code is considered
|
|
4823
4823
|
* failed.</p>
|
|
4824
4824
|
* @public
|
|
4825
4825
|
*/
|
|
4826
|
-
exitCode?: number;
|
|
4826
|
+
exitCode?: number | undefined;
|
|
4827
4827
|
/**
|
|
4828
4828
|
* <p>A short human-readable string to provide additional details for a running or stopped
|
|
4829
4829
|
* container. It can be up to 255 characters long.</p>
|
|
4830
4830
|
* @public
|
|
4831
4831
|
*/
|
|
4832
|
-
reason?: string;
|
|
4832
|
+
reason?: string | undefined;
|
|
4833
4833
|
/**
|
|
4834
4834
|
* <p>The volume mounts for the container. Batch supports <code>emptyDir</code>,
|
|
4835
4835
|
* <code>hostPath</code>, and <code>secret</code> volume types. For more information about volumes
|
|
4836
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>
|
|
4837
4837
|
* @public
|
|
4838
4838
|
*/
|
|
4839
|
-
volumeMounts?: EksContainerVolumeMount[];
|
|
4839
|
+
volumeMounts?: EksContainerVolumeMount[] | undefined;
|
|
4840
4840
|
/**
|
|
4841
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
|
|
4842
4842
|
* security context for a pod or container</a> in the <i>Kubernetes
|
|
4843
4843
|
* documentation</i>.</p>
|
|
4844
4844
|
* @public
|
|
4845
4845
|
*/
|
|
4846
|
-
securityContext?: EksContainerSecurityContext;
|
|
4846
|
+
securityContext?: EksContainerSecurityContext | undefined;
|
|
4847
4847
|
}
|
|
4848
4848
|
/**
|
|
4849
4849
|
* <p>The details for the pod.</p>
|
|
@@ -4858,7 +4858,7 @@ export interface EksPodPropertiesDetail {
|
|
|
4858
4858
|
* documentation</i>.</p>
|
|
4859
4859
|
* @public
|
|
4860
4860
|
*/
|
|
4861
|
-
serviceAccountName?: string;
|
|
4861
|
+
serviceAccountName?: string | undefined;
|
|
4862
4862
|
/**
|
|
4863
4863
|
* <p>Indicates if the pod uses the hosts' network IP address. The default value is
|
|
4864
4864
|
* <code>true</code>. Setting this to <code>false</code> enables the Kubernetes pod networking model.
|
|
@@ -4868,7 +4868,7 @@ export interface EksPodPropertiesDetail {
|
|
|
4868
4868
|
* in the <i>Kubernetes documentation</i>.</p>
|
|
4869
4869
|
* @public
|
|
4870
4870
|
*/
|
|
4871
|
-
hostNetwork?: boolean;
|
|
4871
|
+
hostNetwork?: boolean | undefined;
|
|
4872
4872
|
/**
|
|
4873
4873
|
* <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the
|
|
4874
4874
|
* <code>hostNetwork</code> parameter is not specified, the default is
|
|
@@ -4884,53 +4884,53 @@ export interface EksPodPropertiesDetail {
|
|
|
4884
4884
|
* </p>
|
|
4885
4885
|
* @public
|
|
4886
4886
|
*/
|
|
4887
|
-
dnsPolicy?: string;
|
|
4887
|
+
dnsPolicy?: string | undefined;
|
|
4888
4888
|
/**
|
|
4889
4889
|
* <p>Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain
|
|
4890
4890
|
* access to pull an images from a private registry.</p>
|
|
4891
4891
|
* @public
|
|
4892
4892
|
*/
|
|
4893
|
-
imagePullSecrets?: ImagePullSecret[];
|
|
4893
|
+
imagePullSecrets?: ImagePullSecret[] | undefined;
|
|
4894
4894
|
/**
|
|
4895
4895
|
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
4896
4896
|
* @public
|
|
4897
4897
|
*/
|
|
4898
|
-
containers?: EksContainerDetail[];
|
|
4898
|
+
containers?: EksContainerDetail[] | undefined;
|
|
4899
4899
|
/**
|
|
4900
4900
|
* <p>The container registered with the Amazon EKS Connector agent and persists the registration
|
|
4901
4901
|
* information in the Kubernetes backend data store.</p>
|
|
4902
4902
|
* @public
|
|
4903
4903
|
*/
|
|
4904
|
-
initContainers?: EksContainerDetail[];
|
|
4904
|
+
initContainers?: EksContainerDetail[] | undefined;
|
|
4905
4905
|
/**
|
|
4906
4906
|
* <p>Specifies the volumes for a job definition using Amazon EKS resources.</p>
|
|
4907
4907
|
* @public
|
|
4908
4908
|
*/
|
|
4909
|
-
volumes?: EksVolume[];
|
|
4909
|
+
volumes?: EksVolume[] | undefined;
|
|
4910
4910
|
/**
|
|
4911
4911
|
* <p>The name of the pod for this job.</p>
|
|
4912
4912
|
* @public
|
|
4913
4913
|
*/
|
|
4914
|
-
podName?: string;
|
|
4914
|
+
podName?: string | undefined;
|
|
4915
4915
|
/**
|
|
4916
4916
|
* <p>The name of the node for this job.</p>
|
|
4917
4917
|
* @public
|
|
4918
4918
|
*/
|
|
4919
|
-
nodeName?: string;
|
|
4919
|
+
nodeName?: string | undefined;
|
|
4920
4920
|
/**
|
|
4921
4921
|
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment that
|
|
4922
4922
|
* a pod runs in or the <code>jobID</code> for a job running in the pod. For more information, see
|
|
4923
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>
|
|
4924
4924
|
* @public
|
|
4925
4925
|
*/
|
|
4926
|
-
metadata?: EksMetadata;
|
|
4926
|
+
metadata?: EksMetadata | undefined;
|
|
4927
4927
|
/**
|
|
4928
4928
|
* <p>Indicates if the processes in a container are shared, or visible, to other containers in the
|
|
4929
4929
|
* same pod. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/">Share
|
|
4930
4930
|
* Process Namespace between Containers in a Pod</a>.</p>
|
|
4931
4931
|
* @public
|
|
4932
4932
|
*/
|
|
4933
|
-
shareProcessNamespace?: boolean;
|
|
4933
|
+
shareProcessNamespace?: boolean | undefined;
|
|
4934
4934
|
}
|
|
4935
4935
|
/**
|
|
4936
4936
|
* <p>An object that contains the details for the Kubernetes resources of a job.</p>
|
|
@@ -4941,7 +4941,7 @@ export interface EksPropertiesDetail {
|
|
|
4941
4941
|
* <p>The properties for the Kubernetes pod resources of a job.</p>
|
|
4942
4942
|
* @public
|
|
4943
4943
|
*/
|
|
4944
|
-
podProperties?: EksPodPropertiesDetail;
|
|
4944
|
+
podProperties?: EksPodPropertiesDetail | undefined;
|
|
4945
4945
|
}
|
|
4946
4946
|
/**
|
|
4947
4947
|
* <p>An object that represents the details of a multi-node parallel job node.</p>
|
|
@@ -4953,12 +4953,12 @@ export interface NodeDetails {
|
|
|
4953
4953
|
* available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
|
|
4954
4954
|
* @public
|
|
4955
4955
|
*/
|
|
4956
|
-
nodeIndex?: number;
|
|
4956
|
+
nodeIndex?: number | undefined;
|
|
4957
4957
|
/**
|
|
4958
4958
|
* <p>Specifies whether the current node is the main node for a multi-node parallel job.</p>
|
|
4959
4959
|
* @public
|
|
4960
4960
|
*/
|
|
4961
|
-
isMainNode?: boolean;
|
|
4961
|
+
isMainNode?: boolean | undefined;
|
|
4962
4962
|
}
|
|
4963
4963
|
/**
|
|
4964
4964
|
* @public
|
|
@@ -4986,7 +4986,7 @@ export interface JobDetail {
|
|
|
4986
4986
|
* <p>The Amazon Resource Name (ARN) of the job.</p>
|
|
4987
4987
|
* @public
|
|
4988
4988
|
*/
|
|
4989
|
-
jobArn?: string;
|
|
4989
|
+
jobArn?: string | undefined;
|
|
4990
4990
|
/**
|
|
4991
4991
|
* <p>The job name.</p>
|
|
4992
4992
|
* @public
|
|
@@ -5016,19 +5016,19 @@ export interface JobDetail {
|
|
|
5016
5016
|
* <p>The share identifier for the job.</p>
|
|
5017
5017
|
* @public
|
|
5018
5018
|
*/
|
|
5019
|
-
shareIdentifier?: string;
|
|
5019
|
+
shareIdentifier?: string | undefined;
|
|
5020
5020
|
/**
|
|
5021
5021
|
* <p>The scheduling policy of the job definition. This only affects jobs in job queues with a
|
|
5022
5022
|
* fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
5023
5023
|
* scheduling priority.</p>
|
|
5024
5024
|
* @public
|
|
5025
5025
|
*/
|
|
5026
|
-
schedulingPriority?: number;
|
|
5026
|
+
schedulingPriority?: number | undefined;
|
|
5027
5027
|
/**
|
|
5028
5028
|
* <p>A list of job attempts that are associated with this job.</p>
|
|
5029
5029
|
* @public
|
|
5030
5030
|
*/
|
|
5031
|
-
attempts?: AttemptDetail[];
|
|
5031
|
+
attempts?: AttemptDetail[] | undefined;
|
|
5032
5032
|
/**
|
|
5033
5033
|
* <p>A short, human-readable string to provide more details for the current status of the
|
|
5034
5034
|
* job.</p>
|
|
@@ -5056,7 +5056,7 @@ export interface JobDetail {
|
|
|
5056
5056
|
* </ul>
|
|
5057
5057
|
* @public
|
|
5058
5058
|
*/
|
|
5059
|
-
statusReason?: string;
|
|
5059
|
+
statusReason?: string | undefined;
|
|
5060
5060
|
/**
|
|
5061
5061
|
* <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
|
|
5062
5062
|
* parent array jobs, this is when the job entered the <code>SUBMITTED</code> state. This is
|
|
@@ -5065,12 +5065,12 @@ export interface JobDetail {
|
|
|
5065
5065
|
* state.</p>
|
|
5066
5066
|
* @public
|
|
5067
5067
|
*/
|
|
5068
|
-
createdAt?: number;
|
|
5068
|
+
createdAt?: number | undefined;
|
|
5069
5069
|
/**
|
|
5070
5070
|
* <p>The retry strategy to use for this job if an attempt fails.</p>
|
|
5071
5071
|
* @public
|
|
5072
5072
|
*/
|
|
5073
|
-
retryStrategy?: RetryStrategy;
|
|
5073
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
5074
5074
|
/**
|
|
5075
5075
|
* <p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's
|
|
5076
5076
|
* when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.
|
|
@@ -5084,12 +5084,12 @@ export interface JobDetail {
|
|
|
5084
5084
|
* <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
5085
5085
|
* @public
|
|
5086
5086
|
*/
|
|
5087
|
-
stoppedAt?: number;
|
|
5087
|
+
stoppedAt?: number | undefined;
|
|
5088
5088
|
/**
|
|
5089
5089
|
* <p>A list of job IDs that this job depends on.</p>
|
|
5090
5090
|
* @public
|
|
5091
5091
|
*/
|
|
5092
|
-
dependsOn?: JobDependency[];
|
|
5092
|
+
dependsOn?: JobDependency[] | undefined;
|
|
5093
5093
|
/**
|
|
5094
5094
|
* <p>The Amazon Resource Name (ARN) of the job definition that this job uses.</p>
|
|
5095
5095
|
* @public
|
|
@@ -5100,19 +5100,19 @@ export interface JobDetail {
|
|
|
5100
5100
|
* placeholders or override any corresponding parameter defaults from the job definition.</p>
|
|
5101
5101
|
* @public
|
|
5102
5102
|
*/
|
|
5103
|
-
parameters?: Record<string, string
|
|
5103
|
+
parameters?: Record<string, string> | undefined;
|
|
5104
5104
|
/**
|
|
5105
5105
|
* <p>An object that represents the details for the container that's associated with the job. If
|
|
5106
5106
|
* the details are for a multiple-container job, this object will be empty. </p>
|
|
5107
5107
|
* @public
|
|
5108
5108
|
*/
|
|
5109
|
-
container?: ContainerDetail;
|
|
5109
|
+
container?: ContainerDetail | undefined;
|
|
5110
5110
|
/**
|
|
5111
5111
|
* <p>An object that represents the details of a node that's associated with a multi-node parallel
|
|
5112
5112
|
* job.</p>
|
|
5113
5113
|
* @public
|
|
5114
5114
|
*/
|
|
5115
|
-
nodeDetails?: NodeDetails;
|
|
5115
|
+
nodeDetails?: NodeDetails | undefined;
|
|
5116
5116
|
/**
|
|
5117
5117
|
* <p>An object that represents the node properties of a multi-node parallel job.</p>
|
|
5118
5118
|
* <note>
|
|
@@ -5120,22 +5120,22 @@ export interface JobDetail {
|
|
|
5120
5120
|
* </note>
|
|
5121
5121
|
* @public
|
|
5122
5122
|
*/
|
|
5123
|
-
nodeProperties?: NodeProperties;
|
|
5123
|
+
nodeProperties?: NodeProperties | undefined;
|
|
5124
5124
|
/**
|
|
5125
5125
|
* <p>The array properties of the job, if it's an array job.</p>
|
|
5126
5126
|
* @public
|
|
5127
5127
|
*/
|
|
5128
|
-
arrayProperties?: ArrayPropertiesDetail;
|
|
5128
|
+
arrayProperties?: ArrayPropertiesDetail | undefined;
|
|
5129
5129
|
/**
|
|
5130
5130
|
* <p>The timeout configuration for the job.</p>
|
|
5131
5131
|
* @public
|
|
5132
5132
|
*/
|
|
5133
|
-
timeout?: JobTimeout;
|
|
5133
|
+
timeout?: JobTimeout | undefined;
|
|
5134
5134
|
/**
|
|
5135
5135
|
* <p>The tags that are applied to the job.</p>
|
|
5136
5136
|
* @public
|
|
5137
5137
|
*/
|
|
5138
|
-
tags?: Record<string, string
|
|
5138
|
+
tags?: Record<string, string> | undefined;
|
|
5139
5139
|
/**
|
|
5140
5140
|
* <p>Specifies whether to propagate the tags from the job or job definition to the corresponding
|
|
5141
5141
|
* Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
|
|
@@ -5144,39 +5144,39 @@ export interface JobDetail {
|
|
|
5144
5144
|
* is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
5145
5145
|
* @public
|
|
5146
5146
|
*/
|
|
5147
|
-
propagateTags?: boolean;
|
|
5147
|
+
propagateTags?: boolean | undefined;
|
|
5148
5148
|
/**
|
|
5149
5149
|
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
5150
5150
|
* defaults to <code>EC2</code>. Jobs run on Fargate resources specify
|
|
5151
5151
|
* <code>FARGATE</code>.</p>
|
|
5152
5152
|
* @public
|
|
5153
5153
|
*/
|
|
5154
|
-
platformCapabilities?: PlatformCapability[];
|
|
5154
|
+
platformCapabilities?: PlatformCapability[] | undefined;
|
|
5155
5155
|
/**
|
|
5156
5156
|
* <p>An object with various properties that are specific to Amazon EKS based jobs. </p>
|
|
5157
5157
|
* @public
|
|
5158
5158
|
*/
|
|
5159
|
-
eksProperties?: EksPropertiesDetail;
|
|
5159
|
+
eksProperties?: EksPropertiesDetail | undefined;
|
|
5160
5160
|
/**
|
|
5161
5161
|
* <p>A list of job attempts that are associated with this job.</p>
|
|
5162
5162
|
* @public
|
|
5163
5163
|
*/
|
|
5164
|
-
eksAttempts?: EksAttemptDetail[];
|
|
5164
|
+
eksAttempts?: EksAttemptDetail[] | undefined;
|
|
5165
5165
|
/**
|
|
5166
5166
|
* <p>An object with properties that are specific to Amazon ECS-based jobs. </p>
|
|
5167
5167
|
* @public
|
|
5168
5168
|
*/
|
|
5169
|
-
ecsProperties?: EcsPropertiesDetail;
|
|
5169
|
+
ecsProperties?: EcsPropertiesDetail | undefined;
|
|
5170
5170
|
/**
|
|
5171
5171
|
* <p>Indicates whether the job is canceled.</p>
|
|
5172
5172
|
* @public
|
|
5173
5173
|
*/
|
|
5174
|
-
isCancelled?: boolean;
|
|
5174
|
+
isCancelled?: boolean | undefined;
|
|
5175
5175
|
/**
|
|
5176
5176
|
* <p>Indicates whether the job is terminated.</p>
|
|
5177
5177
|
* @public
|
|
5178
5178
|
*/
|
|
5179
|
-
isTerminated?: boolean;
|
|
5179
|
+
isTerminated?: boolean | undefined;
|
|
5180
5180
|
}
|
|
5181
5181
|
/**
|
|
5182
5182
|
* @public
|
|
@@ -5186,7 +5186,7 @@ export interface DescribeJobsResponse {
|
|
|
5186
5186
|
* <p>The list of jobs.</p>
|
|
5187
5187
|
* @public
|
|
5188
5188
|
*/
|
|
5189
|
-
jobs?: JobDetail[];
|
|
5189
|
+
jobs?: JobDetail[] | undefined;
|
|
5190
5190
|
}
|
|
5191
5191
|
/**
|
|
5192
5192
|
* <p>Contains the parameters for <code>DescribeSchedulingPolicies</code>.</p>
|
|
@@ -5220,14 +5220,14 @@ export interface SchedulingPolicyDetail {
|
|
|
5220
5220
|
* <p>The fair share policy for the scheduling policy.</p>
|
|
5221
5221
|
* @public
|
|
5222
5222
|
*/
|
|
5223
|
-
fairsharePolicy?: FairsharePolicy;
|
|
5223
|
+
fairsharePolicy?: FairsharePolicy | undefined;
|
|
5224
5224
|
/**
|
|
5225
5225
|
* <p>The tags that you apply to the scheduling policy to categorize and organize your resources.
|
|
5226
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
|
|
5227
5227
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
5228
5228
|
* @public
|
|
5229
5229
|
*/
|
|
5230
|
-
tags?: Record<string, string
|
|
5230
|
+
tags?: Record<string, string> | undefined;
|
|
5231
5231
|
}
|
|
5232
5232
|
/**
|
|
5233
5233
|
* @public
|
|
@@ -5237,7 +5237,7 @@ export interface DescribeSchedulingPoliciesResponse {
|
|
|
5237
5237
|
* <p>The list of scheduling policies.</p>
|
|
5238
5238
|
* @public
|
|
5239
5239
|
*/
|
|
5240
|
-
schedulingPolicies?: SchedulingPolicyDetail[];
|
|
5240
|
+
schedulingPolicies?: SchedulingPolicyDetail[] | undefined;
|
|
5241
5241
|
}
|
|
5242
5242
|
/**
|
|
5243
5243
|
* @public
|
|
@@ -5258,12 +5258,12 @@ export interface FrontOfQueueJobSummary {
|
|
|
5258
5258
|
* <p>The ARN for a job in a named job queue.</p>
|
|
5259
5259
|
* @public
|
|
5260
5260
|
*/
|
|
5261
|
-
jobArn?: string;
|
|
5261
|
+
jobArn?: string | undefined;
|
|
5262
5262
|
/**
|
|
5263
5263
|
* <p>The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.</p>
|
|
5264
5264
|
* @public
|
|
5265
5265
|
*/
|
|
5266
|
-
earliestTimeAtPosition?: number;
|
|
5266
|
+
earliestTimeAtPosition?: number | undefined;
|
|
5267
5267
|
}
|
|
5268
5268
|
/**
|
|
5269
5269
|
* <p>Contains a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
|
|
@@ -5274,12 +5274,12 @@ export interface FrontOfQueueDetail {
|
|
|
5274
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>
|
|
5275
5275
|
* @public
|
|
5276
5276
|
*/
|
|
5277
|
-
jobs?: FrontOfQueueJobSummary[];
|
|
5277
|
+
jobs?: FrontOfQueueJobSummary[] | undefined;
|
|
5278
5278
|
/**
|
|
5279
5279
|
* <p>The Unix timestamp (in milliseconds) for when each of the first 100 <code>RUNNABLE</code> jobs were last updated. </p>
|
|
5280
5280
|
* @public
|
|
5281
5281
|
*/
|
|
5282
|
-
lastUpdatedAt?: number;
|
|
5282
|
+
lastUpdatedAt?: number | undefined;
|
|
5283
5283
|
}
|
|
5284
5284
|
/**
|
|
5285
5285
|
* @public
|
|
@@ -5289,7 +5289,7 @@ export interface GetJobQueueSnapshotResponse {
|
|
|
5289
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>
|
|
5290
5290
|
* @public
|
|
5291
5291
|
*/
|
|
5292
|
-
frontOfQueue?: FrontOfQueueDetail;
|
|
5292
|
+
frontOfQueue?: FrontOfQueueDetail | undefined;
|
|
5293
5293
|
}
|
|
5294
5294
|
/**
|
|
5295
5295
|
* <p>A filter name and value pair that's used to return a more specific list of results from a
|
|
@@ -5301,12 +5301,12 @@ export interface KeyValuesPair {
|
|
|
5301
5301
|
* <p>The name of the filter. Filter names are case sensitive.</p>
|
|
5302
5302
|
* @public
|
|
5303
5303
|
*/
|
|
5304
|
-
name?: string;
|
|
5304
|
+
name?: string | undefined;
|
|
5305
5305
|
/**
|
|
5306
5306
|
* <p>The filter values.</p>
|
|
5307
5307
|
* @public
|
|
5308
5308
|
*/
|
|
5309
|
-
values?: string[];
|
|
5309
|
+
values?: string[] | undefined;
|
|
5310
5310
|
}
|
|
5311
5311
|
/**
|
|
5312
5312
|
* <p>Contains the parameters for <code>ListJobs</code>.</p>
|
|
@@ -5317,19 +5317,19 @@ export interface ListJobsRequest {
|
|
|
5317
5317
|
* <p>The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.</p>
|
|
5318
5318
|
* @public
|
|
5319
5319
|
*/
|
|
5320
|
-
jobQueue?: string;
|
|
5320
|
+
jobQueue?: string | undefined;
|
|
5321
5321
|
/**
|
|
5322
5322
|
* <p>The job ID for an array job. Specifying an array job ID with this parameter lists all
|
|
5323
5323
|
* child jobs from within the specified array.</p>
|
|
5324
5324
|
* @public
|
|
5325
5325
|
*/
|
|
5326
|
-
arrayJobId?: string;
|
|
5326
|
+
arrayJobId?: string | undefined;
|
|
5327
5327
|
/**
|
|
5328
5328
|
* <p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with
|
|
5329
5329
|
* this parameter lists all nodes that are associated with the specified job.</p>
|
|
5330
5330
|
* @public
|
|
5331
5331
|
*/
|
|
5332
|
-
multiNodeJobId?: string;
|
|
5332
|
+
multiNodeJobId?: string | undefined;
|
|
5333
5333
|
/**
|
|
5334
5334
|
* <p>The job status used to filter jobs in the specified queue. If the <code>filters</code>
|
|
5335
5335
|
* parameter is specified, the <code>jobStatus</code> parameter is ignored and jobs with any
|
|
@@ -5337,7 +5337,7 @@ export interface ListJobsRequest {
|
|
|
5337
5337
|
* returned.</p>
|
|
5338
5338
|
* @public
|
|
5339
5339
|
*/
|
|
5340
|
-
jobStatus?: JobStatus;
|
|
5340
|
+
jobStatus?: JobStatus | undefined;
|
|
5341
5341
|
/**
|
|
5342
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>
|
|
5343
5343
|
* <p>The following outlines key parameters and limitations:</p>
|
|
@@ -5358,7 +5358,7 @@ export interface ListJobsRequest {
|
|
|
5358
5358
|
* </ul>
|
|
5359
5359
|
* @public
|
|
5360
5360
|
*/
|
|
5361
|
-
maxResults?: number;
|
|
5361
|
+
maxResults?: number | undefined;
|
|
5362
5362
|
/**
|
|
5363
5363
|
* <p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code>
|
|
5364
5364
|
* request where <code>maxResults</code> was used and the results exceeded the value of that
|
|
@@ -5371,7 +5371,7 @@ export interface ListJobsRequest {
|
|
|
5371
5371
|
* </note>
|
|
5372
5372
|
* @public
|
|
5373
5373
|
*/
|
|
5374
|
-
nextToken?: string;
|
|
5374
|
+
nextToken?: string | undefined;
|
|
5375
5375
|
/**
|
|
5376
5376
|
* <p>The filter to apply to the query. Only one filter can be used at a time. When the filter
|
|
5377
5377
|
* is used, <code>jobStatus</code> is ignored. The filter doesn't apply to child jobs in an array
|
|
@@ -5418,7 +5418,7 @@ export interface ListJobsRequest {
|
|
|
5418
5418
|
* </dl>
|
|
5419
5419
|
* @public
|
|
5420
5420
|
*/
|
|
5421
|
-
filters?: KeyValuesPair[];
|
|
5421
|
+
filters?: KeyValuesPair[] | undefined;
|
|
5422
5422
|
}
|
|
5423
5423
|
/**
|
|
5424
5424
|
* <p>An object that represents summary details of a container within a job.</p>
|
|
@@ -5429,13 +5429,13 @@ export interface ContainerSummary {
|
|
|
5429
5429
|
* <p>The exit code to return upon completion.</p>
|
|
5430
5430
|
* @public
|
|
5431
5431
|
*/
|
|
5432
|
-
exitCode?: number;
|
|
5432
|
+
exitCode?: number | undefined;
|
|
5433
5433
|
/**
|
|
5434
5434
|
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
5435
5435
|
* running or stopped container.</p>
|
|
5436
5436
|
* @public
|
|
5437
5437
|
*/
|
|
5438
|
-
reason?: string;
|
|
5438
|
+
reason?: string | undefined;
|
|
5439
5439
|
}
|
|
5440
5440
|
/**
|
|
5441
5441
|
* <p>An object that represents the properties of a node that's associated with a multi-node
|
|
@@ -5447,18 +5447,18 @@ export interface NodePropertiesSummary {
|
|
|
5447
5447
|
* <p>Specifies whether the current node is the main node for a multi-node parallel job.</p>
|
|
5448
5448
|
* @public
|
|
5449
5449
|
*/
|
|
5450
|
-
isMainNode?: boolean;
|
|
5450
|
+
isMainNode?: boolean | undefined;
|
|
5451
5451
|
/**
|
|
5452
5452
|
* <p>The number of nodes that are associated with a multi-node parallel job.</p>
|
|
5453
5453
|
* @public
|
|
5454
5454
|
*/
|
|
5455
|
-
numNodes?: number;
|
|
5455
|
+
numNodes?: number | undefined;
|
|
5456
5456
|
/**
|
|
5457
5457
|
* <p>The node index for the node. Node index numbering begins at zero. This index is also
|
|
5458
5458
|
* available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
|
|
5459
5459
|
* @public
|
|
5460
5460
|
*/
|
|
5461
|
-
nodeIndex?: number;
|
|
5461
|
+
nodeIndex?: number | undefined;
|
|
5462
5462
|
}
|
|
5463
5463
|
/**
|
|
5464
5464
|
* <p>An object that represents summary details of a job.</p>
|
|
@@ -5469,7 +5469,7 @@ export interface JobSummary {
|
|
|
5469
5469
|
* <p>The Amazon Resource Name (ARN) of the job.</p>
|
|
5470
5470
|
* @public
|
|
5471
5471
|
*/
|
|
5472
|
-
jobArn?: string;
|
|
5472
|
+
jobArn?: string | undefined;
|
|
5473
5473
|
/**
|
|
5474
5474
|
* <p>The job ID.</p>
|
|
5475
5475
|
* @public
|
|
@@ -5488,42 +5488,42 @@ export interface JobSummary {
|
|
|
5488
5488
|
* entered the <code>PENDING</code> state.</p>
|
|
5489
5489
|
* @public
|
|
5490
5490
|
*/
|
|
5491
|
-
createdAt?: number;
|
|
5491
|
+
createdAt?: number | undefined;
|
|
5492
5492
|
/**
|
|
5493
5493
|
* <p>The current status for the job.</p>
|
|
5494
5494
|
* @public
|
|
5495
5495
|
*/
|
|
5496
|
-
status?: JobStatus;
|
|
5496
|
+
status?: JobStatus | undefined;
|
|
5497
5497
|
/**
|
|
5498
5498
|
* <p>A short, human-readable string to provide more details for the current status of the
|
|
5499
5499
|
* job.</p>
|
|
5500
5500
|
* @public
|
|
5501
5501
|
*/
|
|
5502
|
-
statusReason?: string;
|
|
5502
|
+
statusReason?: string | undefined;
|
|
5503
5503
|
/**
|
|
5504
5504
|
* <p>The Unix timestamp for when the job was started. More specifically, it's when the job
|
|
5505
5505
|
* transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.</p>
|
|
5506
5506
|
* @public
|
|
5507
5507
|
*/
|
|
5508
|
-
startedAt?: number;
|
|
5508
|
+
startedAt?: number | undefined;
|
|
5509
5509
|
/**
|
|
5510
5510
|
* <p>The Unix timestamp for when the job was stopped. More specifically, it's when the job
|
|
5511
5511
|
* transitioned from the <code>RUNNING</code> state to a terminal state, such as
|
|
5512
5512
|
* <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
5513
5513
|
* @public
|
|
5514
5514
|
*/
|
|
5515
|
-
stoppedAt?: number;
|
|
5515
|
+
stoppedAt?: number | undefined;
|
|
5516
5516
|
/**
|
|
5517
5517
|
* <p>An object that represents the details of the container that's associated with the
|
|
5518
5518
|
* job.</p>
|
|
5519
5519
|
* @public
|
|
5520
5520
|
*/
|
|
5521
|
-
container?: ContainerSummary;
|
|
5521
|
+
container?: ContainerSummary | undefined;
|
|
5522
5522
|
/**
|
|
5523
5523
|
* <p>The array properties of the job, if it's an array job.</p>
|
|
5524
5524
|
* @public
|
|
5525
5525
|
*/
|
|
5526
|
-
arrayProperties?: ArrayPropertiesSummary;
|
|
5526
|
+
arrayProperties?: ArrayPropertiesSummary | undefined;
|
|
5527
5527
|
/**
|
|
5528
5528
|
* <p>The node properties for a single node in a job summary list.</p>
|
|
5529
5529
|
* <note>
|
|
@@ -5531,12 +5531,12 @@ export interface JobSummary {
|
|
|
5531
5531
|
* </note>
|
|
5532
5532
|
* @public
|
|
5533
5533
|
*/
|
|
5534
|
-
nodeProperties?: NodePropertiesSummary;
|
|
5534
|
+
nodeProperties?: NodePropertiesSummary | undefined;
|
|
5535
5535
|
/**
|
|
5536
5536
|
* <p>The Amazon Resource Name (ARN) of the job definition.</p>
|
|
5537
5537
|
* @public
|
|
5538
5538
|
*/
|
|
5539
|
-
jobDefinition?: string;
|
|
5539
|
+
jobDefinition?: string | undefined;
|
|
5540
5540
|
}
|
|
5541
5541
|
/**
|
|
5542
5542
|
* @public
|
|
@@ -5554,7 +5554,7 @@ export interface ListJobsResponse {
|
|
|
5554
5554
|
* are no more results to return.</p>
|
|
5555
5555
|
* @public
|
|
5556
5556
|
*/
|
|
5557
|
-
nextToken?: string;
|
|
5557
|
+
nextToken?: string | undefined;
|
|
5558
5558
|
}
|
|
5559
5559
|
/**
|
|
5560
5560
|
* <p>Contains the parameters for <code>ListSchedulingPolicies</code>.</p>
|
|
@@ -5572,7 +5572,7 @@ export interface ListSchedulingPoliciesRequest {
|
|
|
5572
5572
|
* <code>nextToken</code> value if applicable.</p>
|
|
5573
5573
|
* @public
|
|
5574
5574
|
*/
|
|
5575
|
-
maxResults?: number;
|
|
5575
|
+
maxResults?: number | undefined;
|
|
5576
5576
|
/**
|
|
5577
5577
|
* <p>The <code>nextToken</code> value that's returned from a previous paginated
|
|
5578
5578
|
* <code>ListSchedulingPolicies</code> request where <code>maxResults</code> was used and the
|
|
@@ -5585,7 +5585,7 @@ export interface ListSchedulingPoliciesRequest {
|
|
|
5585
5585
|
* </note>
|
|
5586
5586
|
* @public
|
|
5587
5587
|
*/
|
|
5588
|
-
nextToken?: string;
|
|
5588
|
+
nextToken?: string | undefined;
|
|
5589
5589
|
}
|
|
5590
5590
|
/**
|
|
5591
5591
|
* <p>An object that contains the details of a scheduling policy that's returned in a
|
|
@@ -5607,7 +5607,7 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
5607
5607
|
* <p>A list of scheduling policies that match the request.</p>
|
|
5608
5608
|
* @public
|
|
5609
5609
|
*/
|
|
5610
|
-
schedulingPolicies?: SchedulingPolicyListingDetail[];
|
|
5610
|
+
schedulingPolicies?: SchedulingPolicyListingDetail[] | undefined;
|
|
5611
5611
|
/**
|
|
5612
5612
|
* <p>The <code>nextToken</code> value to include in a future
|
|
5613
5613
|
* <code>ListSchedulingPolicies</code> request. When the results of a
|
|
@@ -5616,7 +5616,7 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
5616
5616
|
* no more results to return.</p>
|
|
5617
5617
|
* @public
|
|
5618
5618
|
*/
|
|
5619
|
-
nextToken?: string;
|
|
5619
|
+
nextToken?: string | undefined;
|
|
5620
5620
|
}
|
|
5621
5621
|
/**
|
|
5622
5622
|
* <p>Contains the parameters for <code>ListTagsForResource</code>.</p>
|
|
@@ -5638,7 +5638,7 @@ export interface ListTagsForResourceResponse {
|
|
|
5638
5638
|
* <p>The tags for the resource.</p>
|
|
5639
5639
|
* @public
|
|
5640
5640
|
*/
|
|
5641
|
-
tags?: Record<string, string
|
|
5641
|
+
tags?: Record<string, string> | undefined;
|
|
5642
5642
|
}
|
|
5643
5643
|
/**
|
|
5644
5644
|
* @public
|
|
@@ -5687,7 +5687,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5687
5687
|
* any corresponding parameter defaults from the job definition.</p>
|
|
5688
5688
|
* @public
|
|
5689
5689
|
*/
|
|
5690
|
-
parameters?: Record<string, string
|
|
5690
|
+
parameters?: Record<string, string> | undefined;
|
|
5691
5691
|
/**
|
|
5692
5692
|
* <p>The scheduling priority for jobs that are submitted with this job definition. This only
|
|
5693
5693
|
* affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority
|
|
@@ -5695,7 +5695,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5695
5695
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
5696
5696
|
* @public
|
|
5697
5697
|
*/
|
|
5698
|
-
schedulingPriority?: number;
|
|
5698
|
+
schedulingPriority?: number | undefined;
|
|
5699
5699
|
/**
|
|
5700
5700
|
* <p>An object with properties specific to Amazon ECS-based single-node container-based jobs. If the
|
|
5701
5701
|
* job definition's <code>type</code> parameter is <code>container</code>, then you must specify
|
|
@@ -5707,7 +5707,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5707
5707
|
* </note>
|
|
5708
5708
|
* @public
|
|
5709
5709
|
*/
|
|
5710
|
-
containerProperties?: ContainerProperties;
|
|
5710
|
+
containerProperties?: ContainerProperties | undefined;
|
|
5711
5711
|
/**
|
|
5712
5712
|
* <p>An object with properties specific to multi-node parallel jobs. If you specify node
|
|
5713
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
|
|
@@ -5722,14 +5722,14 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5722
5722
|
* </note>
|
|
5723
5723
|
* @public
|
|
5724
5724
|
*/
|
|
5725
|
-
nodeProperties?: NodeProperties;
|
|
5725
|
+
nodeProperties?: NodeProperties | undefined;
|
|
5726
5726
|
/**
|
|
5727
5727
|
* <p>The retry strategy to use for failed jobs that are submitted with this job definition. Any
|
|
5728
5728
|
* retry strategy that's specified during a <a>SubmitJob</a> operation overrides the
|
|
5729
5729
|
* retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.</p>
|
|
5730
5730
|
* @public
|
|
5731
5731
|
*/
|
|
5732
|
-
retryStrategy?: RetryStrategy;
|
|
5732
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
5733
5733
|
/**
|
|
5734
5734
|
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
5735
5735
|
* corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only
|
|
@@ -5742,7 +5742,7 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5742
5742
|
* </note>
|
|
5743
5743
|
* @public
|
|
5744
5744
|
*/
|
|
5745
|
-
propagateTags?: boolean;
|
|
5745
|
+
propagateTags?: boolean | undefined;
|
|
5746
5746
|
/**
|
|
5747
5747
|
* <p>The timeout configuration for jobs that are submitted with this job definition, after
|
|
5748
5748
|
* which Batch terminates your jobs if they have not finished. If a job is terminated due to a
|
|
@@ -5752,14 +5752,14 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5752
5752
|
* <i>Batch User Guide</i>.</p>
|
|
5753
5753
|
* @public
|
|
5754
5754
|
*/
|
|
5755
|
-
timeout?: JobTimeout;
|
|
5755
|
+
timeout?: JobTimeout | undefined;
|
|
5756
5756
|
/**
|
|
5757
5757
|
* <p>The tags that you apply to the job definition to help you categorize and organize your
|
|
5758
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
|
|
5759
5759
|
* <i>Batch User Guide</i>.</p>
|
|
5760
5760
|
* @public
|
|
5761
5761
|
*/
|
|
5762
|
-
tags?: Record<string, string
|
|
5762
|
+
tags?: Record<string, string> | undefined;
|
|
5763
5763
|
/**
|
|
5764
5764
|
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
5765
5765
|
* defaults to <code>EC2</code>. To run the job on Fargate resources, specify
|
|
@@ -5770,19 +5770,19 @@ export interface RegisterJobDefinitionRequest {
|
|
|
5770
5770
|
* </note>
|
|
5771
5771
|
* @public
|
|
5772
5772
|
*/
|
|
5773
|
-
platformCapabilities?: PlatformCapability[];
|
|
5773
|
+
platformCapabilities?: PlatformCapability[] | undefined;
|
|
5774
5774
|
/**
|
|
5775
5775
|
* <p>An object with properties that are specific to Amazon EKS-based jobs. This must not be
|
|
5776
5776
|
* specified for Amazon ECS based job definitions.</p>
|
|
5777
5777
|
* @public
|
|
5778
5778
|
*/
|
|
5779
|
-
eksProperties?: EksProperties;
|
|
5779
|
+
eksProperties?: EksProperties | undefined;
|
|
5780
5780
|
/**
|
|
5781
5781
|
* <p>An object with properties that are specific to Amazon ECS-based jobs. This must not be
|
|
5782
5782
|
* specified for Amazon EKS-based job definitions.</p>
|
|
5783
5783
|
* @public
|
|
5784
5784
|
*/
|
|
5785
|
-
ecsProperties?: EcsProperties;
|
|
5785
|
+
ecsProperties?: EcsProperties | undefined;
|
|
5786
5786
|
}
|
|
5787
5787
|
/**
|
|
5788
5788
|
* @public
|
|
@@ -5826,7 +5826,7 @@ export interface ContainerOverrides {
|
|
|
5826
5826
|
* definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
5827
5827
|
* @public
|
|
5828
5828
|
*/
|
|
5829
|
-
vcpus?: number;
|
|
5829
|
+
vcpus?: number | undefined;
|
|
5830
5830
|
/**
|
|
5831
5831
|
* @deprecated
|
|
5832
5832
|
*
|
|
@@ -5842,7 +5842,7 @@ export interface ContainerOverrides {
|
|
|
5842
5842
|
* definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
5843
5843
|
* @public
|
|
5844
5844
|
*/
|
|
5845
|
-
memory?: number;
|
|
5845
|
+
memory?: number | undefined;
|
|
5846
5846
|
/**
|
|
5847
5847
|
* <p>The command to send to the container that overrides the default command from the Docker
|
|
5848
5848
|
* image or the job definition.</p>
|
|
@@ -5851,7 +5851,7 @@ export interface ContainerOverrides {
|
|
|
5851
5851
|
* </note>
|
|
5852
5852
|
* @public
|
|
5853
5853
|
*/
|
|
5854
|
-
command?: string[];
|
|
5854
|
+
command?: string[] | undefined;
|
|
5855
5855
|
/**
|
|
5856
5856
|
* <p>The instance type to use for a multi-node parallel job.</p>
|
|
5857
5857
|
* <note>
|
|
@@ -5860,7 +5860,7 @@ export interface ContainerOverrides {
|
|
|
5860
5860
|
* </note>
|
|
5861
5861
|
* @public
|
|
5862
5862
|
*/
|
|
5863
|
-
instanceType?: string;
|
|
5863
|
+
instanceType?: string | undefined;
|
|
5864
5864
|
/**
|
|
5865
5865
|
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5866
5866
|
* which are added to the container at launch, or you can override the existing environment
|
|
@@ -5871,14 +5871,14 @@ export interface ContainerOverrides {
|
|
|
5871
5871
|
* </note>
|
|
5872
5872
|
* @public
|
|
5873
5873
|
*/
|
|
5874
|
-
environment?: KeyValuePair[];
|
|
5874
|
+
environment?: KeyValuePair[] | undefined;
|
|
5875
5875
|
/**
|
|
5876
5876
|
* <p>The type and amount of resources to assign to a container. This overrides the settings in
|
|
5877
5877
|
* the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and
|
|
5878
5878
|
* <code>VCPU</code>.</p>
|
|
5879
5879
|
* @public
|
|
5880
5880
|
*/
|
|
5881
|
-
resourceRequirements?: ResourceRequirement[];
|
|
5881
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
5882
5882
|
}
|
|
5883
5883
|
/**
|
|
5884
5884
|
* <p>The overrides that should be sent to a container.</p>
|
|
@@ -5895,7 +5895,7 @@ export interface TaskContainerOverrides {
|
|
|
5895
5895
|
* </note>
|
|
5896
5896
|
* @public
|
|
5897
5897
|
*/
|
|
5898
|
-
command?: string[];
|
|
5898
|
+
command?: string[] | undefined;
|
|
5899
5899
|
/**
|
|
5900
5900
|
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5901
5901
|
* which are added to the container at launch, or you can override the existing environment
|
|
@@ -5906,20 +5906,20 @@ export interface TaskContainerOverrides {
|
|
|
5906
5906
|
* </note>
|
|
5907
5907
|
* @public
|
|
5908
5908
|
*/
|
|
5909
|
-
environment?: KeyValuePair[];
|
|
5909
|
+
environment?: KeyValuePair[] | undefined;
|
|
5910
5910
|
/**
|
|
5911
5911
|
* <p>A pointer to the container that you want to override. The container's name provides a unique
|
|
5912
5912
|
* identifier for the container being used.</p>
|
|
5913
5913
|
* @public
|
|
5914
5914
|
*/
|
|
5915
|
-
name?: string;
|
|
5915
|
+
name?: string | undefined;
|
|
5916
5916
|
/**
|
|
5917
5917
|
* <p>The type and amount of resources to assign to a container. This overrides the settings in
|
|
5918
5918
|
* the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and
|
|
5919
5919
|
* <code>VCPU</code>.</p>
|
|
5920
5920
|
* @public
|
|
5921
5921
|
*/
|
|
5922
|
-
resourceRequirements?: ResourceRequirement[];
|
|
5922
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
5923
5923
|
}
|
|
5924
5924
|
/**
|
|
5925
5925
|
* <p>An object that contains overrides for the task definition of a job.</p>
|
|
@@ -5930,7 +5930,7 @@ export interface TaskPropertiesOverride {
|
|
|
5930
5930
|
* <p>The overrides for the container definition of a job.</p>
|
|
5931
5931
|
* @public
|
|
5932
5932
|
*/
|
|
5933
|
-
containers?: TaskContainerOverrides[];
|
|
5933
|
+
containers?: TaskContainerOverrides[] | undefined;
|
|
5934
5934
|
}
|
|
5935
5935
|
/**
|
|
5936
5936
|
* <p>An object that contains overrides for the Amazon ECS task definition of a job.</p>
|
|
@@ -5944,7 +5944,7 @@ export interface EcsPropertiesOverride {
|
|
|
5944
5944
|
* </note>
|
|
5945
5945
|
* @public
|
|
5946
5946
|
*/
|
|
5947
|
-
taskProperties?: TaskPropertiesOverride[];
|
|
5947
|
+
taskProperties?: TaskPropertiesOverride[] | undefined;
|
|
5948
5948
|
}
|
|
5949
5949
|
/**
|
|
5950
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
|
|
@@ -5957,18 +5957,18 @@ export interface EksContainerOverride {
|
|
|
5957
5957
|
* name that you wish to override.</p>
|
|
5958
5958
|
* @public
|
|
5959
5959
|
*/
|
|
5960
|
-
name?: string;
|
|
5960
|
+
name?: string | undefined;
|
|
5961
5961
|
/**
|
|
5962
5962
|
* <p>The override of the Docker image that's used to start the container.</p>
|
|
5963
5963
|
* @public
|
|
5964
5964
|
*/
|
|
5965
|
-
image?: string;
|
|
5965
|
+
image?: string | undefined;
|
|
5966
5966
|
/**
|
|
5967
5967
|
* <p>The command to send to the container that overrides the default command from the Docker
|
|
5968
5968
|
* image or the job definition.</p>
|
|
5969
5969
|
* @public
|
|
5970
5970
|
*/
|
|
5971
|
-
command?: string[];
|
|
5971
|
+
command?: string[] | undefined;
|
|
5972
5972
|
/**
|
|
5973
5973
|
* <p>The arguments to the entrypoint to send to the container that overrides the default
|
|
5974
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>
|
|
@@ -5976,7 +5976,7 @@ export interface EksContainerOverride {
|
|
|
5976
5976
|
* documentation</i>.</p>
|
|
5977
5977
|
* @public
|
|
5978
5978
|
*/
|
|
5979
|
-
args?: string[];
|
|
5979
|
+
args?: string[] | undefined;
|
|
5980
5980
|
/**
|
|
5981
5981
|
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5982
5982
|
* which are added to the container at launch. Or, you can override the existing environment
|
|
@@ -5987,7 +5987,7 @@ export interface EksContainerOverride {
|
|
|
5987
5987
|
* </note>
|
|
5988
5988
|
* @public
|
|
5989
5989
|
*/
|
|
5990
|
-
env?: EksContainerEnvironmentVariable[];
|
|
5990
|
+
env?: EksContainerEnvironmentVariable[] | undefined;
|
|
5991
5991
|
/**
|
|
5992
5992
|
* <p>The type and amount of resources to assign to a container. These override the settings in
|
|
5993
5993
|
* the job definition. The supported resources include <code>memory</code>, <code>cpu</code>, and
|
|
@@ -5996,7 +5996,7 @@ export interface EksContainerOverride {
|
|
|
5996
5996
|
* documentation</i>.</p>
|
|
5997
5997
|
* @public
|
|
5998
5998
|
*/
|
|
5999
|
-
resources?: EksContainerResourceRequirements;
|
|
5999
|
+
resources?: EksContainerResourceRequirements | undefined;
|
|
6000
6000
|
}
|
|
6001
6001
|
/**
|
|
6002
6002
|
* <p>An object that contains overrides for the Kubernetes pod properties of a job.</p>
|
|
@@ -6007,7 +6007,7 @@ export interface EksPodPropertiesOverride {
|
|
|
6007
6007
|
* <p>The overrides for the container that's used on the Amazon EKS pod.</p>
|
|
6008
6008
|
* @public
|
|
6009
6009
|
*/
|
|
6010
|
-
containers?: EksContainerOverride[];
|
|
6010
|
+
containers?: EksContainerOverride[] | undefined;
|
|
6011
6011
|
/**
|
|
6012
6012
|
* <p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before
|
|
6013
6013
|
* application containers, always runs to completion, and must complete successfully before the next
|
|
@@ -6016,13 +6016,13 @@ export interface EksPodPropertiesOverride {
|
|
|
6016
6016
|
* Containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
6017
6017
|
* @public
|
|
6018
6018
|
*/
|
|
6019
|
-
initContainers?: EksContainerOverride[];
|
|
6019
|
+
initContainers?: EksContainerOverride[] | undefined;
|
|
6020
6020
|
/**
|
|
6021
6021
|
* <p>Metadata about the
|
|
6022
6022
|
* overrides for the container that's used on the Amazon EKS pod.</p>
|
|
6023
6023
|
* @public
|
|
6024
6024
|
*/
|
|
6025
|
-
metadata?: EksMetadata;
|
|
6025
|
+
metadata?: EksMetadata | undefined;
|
|
6026
6026
|
}
|
|
6027
6027
|
/**
|
|
6028
6028
|
* <p>An object that contains overrides for the Kubernetes resources of a job.</p>
|
|
@@ -6033,7 +6033,7 @@ export interface EksPropertiesOverride {
|
|
|
6033
6033
|
* <p>The overrides for the Kubernetes pod resources of a job.</p>
|
|
6034
6034
|
* @public
|
|
6035
6035
|
*/
|
|
6036
|
-
podProperties?: EksPodPropertiesOverride;
|
|
6036
|
+
podProperties?: EksPodPropertiesOverride | undefined;
|
|
6037
6037
|
}
|
|
6038
6038
|
/**
|
|
6039
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
|
|
@@ -6054,24 +6054,24 @@ export interface NodePropertyOverride {
|
|
|
6054
6054
|
* <p>The overrides that are sent to a node range.</p>
|
|
6055
6055
|
* @public
|
|
6056
6056
|
*/
|
|
6057
|
-
containerOverrides?: ContainerOverrides;
|
|
6057
|
+
containerOverrides?: ContainerOverrides | undefined;
|
|
6058
6058
|
/**
|
|
6059
6059
|
* <p>An object that contains the properties that you want to replace for the existing Amazon ECS
|
|
6060
6060
|
* resources of a job.</p>
|
|
6061
6061
|
* @public
|
|
6062
6062
|
*/
|
|
6063
|
-
ecsPropertiesOverride?: EcsPropertiesOverride;
|
|
6063
|
+
ecsPropertiesOverride?: EcsPropertiesOverride | undefined;
|
|
6064
6064
|
/**
|
|
6065
6065
|
* <p>An object that contains the instance types that you want to replace for the existing
|
|
6066
6066
|
* resources of a job.</p>
|
|
6067
6067
|
* @public
|
|
6068
6068
|
*/
|
|
6069
|
-
instanceTypes?: string[];
|
|
6069
|
+
instanceTypes?: string[] | undefined;
|
|
6070
6070
|
/**
|
|
6071
6071
|
* <p>An object that contains the properties that you want to replace for the existing Amazon EKS resources of a job.</p>
|
|
6072
6072
|
* @public
|
|
6073
6073
|
*/
|
|
6074
|
-
eksPropertiesOverride?: EksPropertiesOverride;
|
|
6074
|
+
eksPropertiesOverride?: EksPropertiesOverride | undefined;
|
|
6075
6075
|
}
|
|
6076
6076
|
/**
|
|
6077
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
|
|
@@ -6103,12 +6103,12 @@ export interface NodeOverrides {
|
|
|
6103
6103
|
* </ul>
|
|
6104
6104
|
* @public
|
|
6105
6105
|
*/
|
|
6106
|
-
numNodes?: number;
|
|
6106
|
+
numNodes?: number | undefined;
|
|
6107
6107
|
/**
|
|
6108
6108
|
* <p>The node property overrides for the job.</p>
|
|
6109
6109
|
* @public
|
|
6110
6110
|
*/
|
|
6111
|
-
nodePropertyOverrides?: NodePropertyOverride[];
|
|
6111
|
+
nodePropertyOverrides?: NodePropertyOverride[] | undefined;
|
|
6112
6112
|
}
|
|
6113
6113
|
/**
|
|
6114
6114
|
* <p>Contains the parameters for <code>SubmitJob</code>.</p>
|
|
@@ -6136,7 +6136,7 @@ export interface SubmitJobRequest {
|
|
|
6136
6136
|
* (*).</p>
|
|
6137
6137
|
* @public
|
|
6138
6138
|
*/
|
|
6139
|
-
shareIdentifier?: string;
|
|
6139
|
+
shareIdentifier?: string | undefined;
|
|
6140
6140
|
/**
|
|
6141
6141
|
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair
|
|
6142
6142
|
* share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
@@ -6147,14 +6147,14 @@ export interface SubmitJobRequest {
|
|
|
6147
6147
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
6148
6148
|
* @public
|
|
6149
6149
|
*/
|
|
6150
|
-
schedulingPriorityOverride?: number;
|
|
6150
|
+
schedulingPriorityOverride?: number | undefined;
|
|
6151
6151
|
/**
|
|
6152
6152
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
6153
6153
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
6154
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>
|
|
6155
6155
|
* @public
|
|
6156
6156
|
*/
|
|
6157
|
-
arrayProperties?: ArrayProperties;
|
|
6157
|
+
arrayProperties?: ArrayProperties | undefined;
|
|
6158
6158
|
/**
|
|
6159
6159
|
* <p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can
|
|
6160
6160
|
* specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs
|
|
@@ -6164,7 +6164,7 @@ export interface SubmitJobRequest {
|
|
|
6164
6164
|
* before it can begin.</p>
|
|
6165
6165
|
* @public
|
|
6166
6166
|
*/
|
|
6167
|
-
dependsOn?: JobDependency[];
|
|
6167
|
+
dependsOn?: JobDependency[] | undefined;
|
|
6168
6168
|
/**
|
|
6169
6169
|
* <p>The job definition used by this job. This value can be one of
|
|
6170
6170
|
* <code>definition-name</code>, <code>definition-name:revision</code>, or the Amazon Resource Name (ARN) for the
|
|
@@ -6185,7 +6185,7 @@ export interface SubmitJobRequest {
|
|
|
6185
6185
|
* from the job definition.</p>
|
|
6186
6186
|
* @public
|
|
6187
6187
|
*/
|
|
6188
|
-
parameters?: Record<string, string
|
|
6188
|
+
parameters?: Record<string, string> | undefined;
|
|
6189
6189
|
/**
|
|
6190
6190
|
* <p>An object with properties that override the defaults for the job definition that specify
|
|
6191
6191
|
* the name of a container in the specified job definition and the overrides it should receive.
|
|
@@ -6195,7 +6195,7 @@ export interface SubmitJobRequest {
|
|
|
6195
6195
|
* <code>environment</code> override.</p>
|
|
6196
6196
|
* @public
|
|
6197
6197
|
*/
|
|
6198
|
-
containerOverrides?: ContainerOverrides;
|
|
6198
|
+
containerOverrides?: ContainerOverrides | undefined;
|
|
6199
6199
|
/**
|
|
6200
6200
|
* <p>A list of node overrides in JSON format that specify the node range to target and the
|
|
6201
6201
|
* container overrides for that node range.</p>
|
|
@@ -6205,14 +6205,14 @@ export interface SubmitJobRequest {
|
|
|
6205
6205
|
* </note>
|
|
6206
6206
|
* @public
|
|
6207
6207
|
*/
|
|
6208
|
-
nodeOverrides?: NodeOverrides;
|
|
6208
|
+
nodeOverrides?: NodeOverrides | undefined;
|
|
6209
6209
|
/**
|
|
6210
6210
|
* <p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation.
|
|
6211
6211
|
* When a retry strategy is specified here, it overrides the retry strategy defined in the job
|
|
6212
6212
|
* definition.</p>
|
|
6213
6213
|
* @public
|
|
6214
6214
|
*/
|
|
6215
|
-
retryStrategy?: RetryStrategy;
|
|
6215
|
+
retryStrategy?: RetryStrategy | undefined;
|
|
6216
6216
|
/**
|
|
6217
6217
|
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
6218
6218
|
* corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only
|
|
@@ -6222,7 +6222,7 @@ export interface SubmitJobRequest {
|
|
|
6222
6222
|
* specified, this overrides the tag propagation setting in the job definition.</p>
|
|
6223
6223
|
* @public
|
|
6224
6224
|
*/
|
|
6225
|
-
propagateTags?: boolean;
|
|
6225
|
+
propagateTags?: boolean | undefined;
|
|
6226
6226
|
/**
|
|
6227
6227
|
* <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify
|
|
6228
6228
|
* a timeout duration after which Batch terminates your jobs if they haven't finished. If a job
|
|
@@ -6233,24 +6233,24 @@ export interface SubmitJobRequest {
|
|
|
6233
6233
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6234
6234
|
* @public
|
|
6235
6235
|
*/
|
|
6236
|
-
timeout?: JobTimeout;
|
|
6236
|
+
timeout?: JobTimeout | undefined;
|
|
6237
6237
|
/**
|
|
6238
6238
|
* <p>The tags that you apply to the job request to help you categorize and organize your
|
|
6239
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
|
|
6240
6240
|
* Resources</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
6241
6241
|
* @public
|
|
6242
6242
|
*/
|
|
6243
|
-
tags?: Record<string, string
|
|
6243
|
+
tags?: Record<string, string> | undefined;
|
|
6244
6244
|
/**
|
|
6245
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>
|
|
6246
6246
|
* @public
|
|
6247
6247
|
*/
|
|
6248
|
-
eksPropertiesOverride?: EksPropertiesOverride;
|
|
6248
|
+
eksPropertiesOverride?: EksPropertiesOverride | undefined;
|
|
6249
6249
|
/**
|
|
6250
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>
|
|
6251
6251
|
* @public
|
|
6252
6252
|
*/
|
|
6253
|
-
ecsPropertiesOverride?: EcsPropertiesOverride;
|
|
6253
|
+
ecsPropertiesOverride?: EcsPropertiesOverride | undefined;
|
|
6254
6254
|
}
|
|
6255
6255
|
/**
|
|
6256
6256
|
* @public
|
|
@@ -6260,7 +6260,7 @@ export interface SubmitJobResponse {
|
|
|
6260
6260
|
* <p>The Amazon Resource Name (ARN) for the job.</p>
|
|
6261
6261
|
* @public
|
|
6262
6262
|
*/
|
|
6263
|
-
jobArn?: string;
|
|
6263
|
+
jobArn?: string | undefined;
|
|
6264
6264
|
/**
|
|
6265
6265
|
* <p>The name of the job.</p>
|
|
6266
6266
|
* @public
|
|
@@ -6371,7 +6371,7 @@ export interface ComputeResourceUpdate {
|
|
|
6371
6371
|
* </note>
|
|
6372
6372
|
* @public
|
|
6373
6373
|
*/
|
|
6374
|
-
minvCpus?: number;
|
|
6374
|
+
minvCpus?: number | undefined;
|
|
6375
6375
|
/**
|
|
6376
6376
|
* <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
|
|
6377
6377
|
* <note>
|
|
@@ -6384,7 +6384,7 @@ export interface ComputeResourceUpdate {
|
|
|
6384
6384
|
* </note>
|
|
6385
6385
|
* @public
|
|
6386
6386
|
*/
|
|
6387
|
-
maxvCpus?: number;
|
|
6387
|
+
maxvCpus?: number | undefined;
|
|
6388
6388
|
/**
|
|
6389
6389
|
* <p>The desired number of
|
|
6390
6390
|
* vCPUS in the
|
|
@@ -6406,7 +6406,7 @@ export interface ComputeResourceUpdate {
|
|
|
6406
6406
|
* </note>
|
|
6407
6407
|
* @public
|
|
6408
6408
|
*/
|
|
6409
|
-
desiredvCpus?: number;
|
|
6409
|
+
desiredvCpus?: number | undefined;
|
|
6410
6410
|
/**
|
|
6411
6411
|
* <p>The VPC subnets where the compute resources are launched. Fargate compute resources can
|
|
6412
6412
|
* contain up to 16 subnets. For Fargate compute resources, providing an empty list will be
|
|
@@ -6427,7 +6427,7 @@ export interface ComputeResourceUpdate {
|
|
|
6427
6427
|
* </note>
|
|
6428
6428
|
* @public
|
|
6429
6429
|
*/
|
|
6430
|
-
subnets?: string[];
|
|
6430
|
+
subnets?: string[] | undefined;
|
|
6431
6431
|
/**
|
|
6432
6432
|
* <p>The Amazon EC2 security groups that are associated with instances launched in the compute
|
|
6433
6433
|
* environment. This parameter is required for Fargate compute resources, where it can contain up
|
|
@@ -6439,7 +6439,7 @@ export interface ComputeResourceUpdate {
|
|
|
6439
6439
|
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
6440
6440
|
* @public
|
|
6441
6441
|
*/
|
|
6442
|
-
securityGroupIds?: string[];
|
|
6442
|
+
securityGroupIds?: string[] | undefined;
|
|
6443
6443
|
/**
|
|
6444
6444
|
* <p>The allocation strategy to use for the compute resource if there's not enough instances of
|
|
6445
6445
|
* the best fitting instance type that can be allocated. This might be because of availability of
|
|
@@ -6483,7 +6483,7 @@ export interface ComputeResourceUpdate {
|
|
|
6483
6483
|
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
6484
6484
|
* @public
|
|
6485
6485
|
*/
|
|
6486
|
-
allocationStrategy?: CRUpdateAllocationStrategy;
|
|
6486
|
+
allocationStrategy?: CRUpdateAllocationStrategy | undefined;
|
|
6487
6487
|
/**
|
|
6488
6488
|
* <p>The instances types that can be launched. You can specify instance families to launch any
|
|
6489
6489
|
* instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
|
|
@@ -6508,7 +6508,7 @@ export interface ComputeResourceUpdate {
|
|
|
6508
6508
|
* </note>
|
|
6509
6509
|
* @public
|
|
6510
6510
|
*/
|
|
6511
|
-
instanceTypes?: string[];
|
|
6511
|
+
instanceTypes?: string[] | undefined;
|
|
6512
6512
|
/**
|
|
6513
6513
|
* <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
|
|
6514
6514
|
* use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this
|
|
@@ -6521,7 +6521,7 @@ export interface ComputeResourceUpdate {
|
|
|
6521
6521
|
* </note>
|
|
6522
6522
|
* @public
|
|
6523
6523
|
*/
|
|
6524
|
-
ec2KeyPair?: string;
|
|
6524
|
+
ec2KeyPair?: string | undefined;
|
|
6525
6525
|
/**
|
|
6526
6526
|
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
|
6527
6527
|
* Required for Amazon EC2
|
|
@@ -6540,7 +6540,7 @@ export interface ComputeResourceUpdate {
|
|
|
6540
6540
|
* </note>
|
|
6541
6541
|
* @public
|
|
6542
6542
|
*/
|
|
6543
|
-
instanceRole?: string;
|
|
6543
|
+
instanceRole?: string | undefined;
|
|
6544
6544
|
/**
|
|
6545
6545
|
* <p>Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
|
|
6546
6546
|
* environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
|
|
@@ -6556,7 +6556,7 @@ export interface ComputeResourceUpdate {
|
|
|
6556
6556
|
* </note>
|
|
6557
6557
|
* @public
|
|
6558
6558
|
*/
|
|
6559
|
-
tags?: Record<string, string
|
|
6559
|
+
tags?: Record<string, string> | undefined;
|
|
6560
6560
|
/**
|
|
6561
6561
|
* <p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit
|
|
6562
6562
|
* multi-node parallel jobs to your compute environment, you should consider creating a cluster
|
|
@@ -6572,7 +6572,7 @@ export interface ComputeResourceUpdate {
|
|
|
6572
6572
|
* </note>
|
|
6573
6573
|
* @public
|
|
6574
6574
|
*/
|
|
6575
|
-
placementGroup?: string;
|
|
6575
|
+
placementGroup?: string | undefined;
|
|
6576
6576
|
/**
|
|
6577
6577
|
* <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand
|
|
6578
6578
|
* price for that instance type before instances are launched. For example, if your maximum
|
|
@@ -6588,7 +6588,7 @@ export interface ComputeResourceUpdate {
|
|
|
6588
6588
|
* </note>
|
|
6589
6589
|
* @public
|
|
6590
6590
|
*/
|
|
6591
|
-
bidPercentage?: number;
|
|
6591
|
+
bidPercentage?: number | undefined;
|
|
6592
6592
|
/**
|
|
6593
6593
|
* <p>The updated launch template to use for your compute resources. You must specify either the
|
|
6594
6594
|
* launch template ID or launch template name in the request, but not both. For more information,
|
|
@@ -6607,7 +6607,7 @@ export interface ComputeResourceUpdate {
|
|
|
6607
6607
|
* </note>
|
|
6608
6608
|
* @public
|
|
6609
6609
|
*/
|
|
6610
|
-
launchTemplate?: LaunchTemplateSpecification;
|
|
6610
|
+
launchTemplate?: LaunchTemplateSpecification | undefined;
|
|
6611
6611
|
/**
|
|
6612
6612
|
* <p>Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the
|
|
6613
6613
|
* compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
@@ -6622,7 +6622,7 @@ export interface ComputeResourceUpdate {
|
|
|
6622
6622
|
* </note>
|
|
6623
6623
|
* @public
|
|
6624
6624
|
*/
|
|
6625
|
-
ec2Configuration?: Ec2Configuration[];
|
|
6625
|
+
ec2Configuration?: Ec2Configuration[] | undefined;
|
|
6626
6626
|
/**
|
|
6627
6627
|
* <p>Specifies whether the AMI ID is updated to the latest one that's supported by Batch when
|
|
6628
6628
|
* the compute environment has an infrastructure update. The default value is
|
|
@@ -6640,7 +6640,7 @@ export interface ComputeResourceUpdate {
|
|
|
6640
6640
|
* <i>Batch User Guide</i>.</p>
|
|
6641
6641
|
* @public
|
|
6642
6642
|
*/
|
|
6643
|
-
updateToLatestImageVersion?: boolean;
|
|
6643
|
+
updateToLatestImageVersion?: boolean | undefined;
|
|
6644
6644
|
/**
|
|
6645
6645
|
* <p>The type of compute environment: <code>EC2</code>, <code>SPOT</code>, <code>FARGATE</code>,
|
|
6646
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
|
|
@@ -6653,7 +6653,7 @@ export interface ComputeResourceUpdate {
|
|
|
6653
6653
|
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
6654
6654
|
* @public
|
|
6655
6655
|
*/
|
|
6656
|
-
type?: CRType;
|
|
6656
|
+
type?: CRType | undefined;
|
|
6657
6657
|
/**
|
|
6658
6658
|
* <p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
|
|
6659
6659
|
* This parameter is overridden by the <code>imageIdOverride</code> member of the
|
|
@@ -6675,7 +6675,7 @@ export interface ComputeResourceUpdate {
|
|
|
6675
6675
|
* </note>
|
|
6676
6676
|
* @public
|
|
6677
6677
|
*/
|
|
6678
|
-
imageId?: string;
|
|
6678
|
+
imageId?: string | undefined;
|
|
6679
6679
|
}
|
|
6680
6680
|
/**
|
|
6681
6681
|
* <p>Contains the parameters for <code>UpdateComputeEnvironment</code>.</p>
|
|
@@ -6711,7 +6711,7 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
6711
6711
|
* instance.</p>
|
|
6712
6712
|
* @public
|
|
6713
6713
|
*/
|
|
6714
|
-
state?: CEState;
|
|
6714
|
+
state?: CEState | undefined;
|
|
6715
6715
|
/**
|
|
6716
6716
|
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
|
6717
6717
|
* Don't specify this parameter for a managed compute environment. This parameter is only used
|
|
@@ -6719,14 +6719,14 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
6719
6719
|
* parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>
|
|
6720
6720
|
* @public
|
|
6721
6721
|
*/
|
|
6722
|
-
unmanagedvCpus?: number;
|
|
6722
|
+
unmanagedvCpus?: number | undefined;
|
|
6723
6723
|
/**
|
|
6724
6724
|
* <p>Details of the compute resources managed by the compute environment. Required for a
|
|
6725
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
|
|
6726
6726
|
* <i>Batch User Guide</i>.</p>
|
|
6727
6727
|
* @public
|
|
6728
6728
|
*/
|
|
6729
|
-
computeResources?: ComputeResourceUpdate;
|
|
6729
|
+
computeResources?: ComputeResourceUpdate | undefined;
|
|
6730
6730
|
/**
|
|
6731
6731
|
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
6732
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
|
|
@@ -6750,19 +6750,19 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
6750
6750
|
* </note>
|
|
6751
6751
|
* @public
|
|
6752
6752
|
*/
|
|
6753
|
-
serviceRole?: string;
|
|
6753
|
+
serviceRole?: string | undefined;
|
|
6754
6754
|
/**
|
|
6755
6755
|
* <p>Specifies the updated infrastructure update policy for the compute environment. For more
|
|
6756
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
|
|
6757
6757
|
* the <i>Batch User Guide</i>.</p>
|
|
6758
6758
|
* @public
|
|
6759
6759
|
*/
|
|
6760
|
-
updatePolicy?: UpdatePolicy;
|
|
6760
|
+
updatePolicy?: UpdatePolicy | undefined;
|
|
6761
6761
|
/**
|
|
6762
6762
|
* <p>Reserved.</p>
|
|
6763
6763
|
* @public
|
|
6764
6764
|
*/
|
|
6765
|
-
context?: string;
|
|
6765
|
+
context?: string | undefined;
|
|
6766
6766
|
}
|
|
6767
6767
|
/**
|
|
6768
6768
|
* @public
|
|
@@ -6773,12 +6773,12 @@ export interface UpdateComputeEnvironmentResponse {
|
|
|
6773
6773
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
6774
6774
|
* @public
|
|
6775
6775
|
*/
|
|
6776
|
-
computeEnvironmentName?: string;
|
|
6776
|
+
computeEnvironmentName?: string | undefined;
|
|
6777
6777
|
/**
|
|
6778
6778
|
* <p>The Amazon Resource Name (ARN) of the compute environment.</p>
|
|
6779
6779
|
* @public
|
|
6780
6780
|
*/
|
|
6781
|
-
computeEnvironmentArn?: string;
|
|
6781
|
+
computeEnvironmentArn?: string | undefined;
|
|
6782
6782
|
}
|
|
6783
6783
|
/**
|
|
6784
6784
|
* <p>Contains the parameters for <code>UpdateJobQueue</code>.</p>
|
|
@@ -6796,7 +6796,7 @@ export interface UpdateJobQueueRequest {
|
|
|
6796
6796
|
* new jobs can't be added to the queue, but jobs already in the queue can finish.</p>
|
|
6797
6797
|
* @public
|
|
6798
6798
|
*/
|
|
6799
|
-
state?: JQState;
|
|
6799
|
+
state?: JQState | undefined;
|
|
6800
6800
|
/**
|
|
6801
6801
|
* <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
|
|
6802
6802
|
* scheduling policy can be replaced but not removed. The format is
|
|
@@ -6806,7 +6806,7 @@ export interface UpdateJobQueueRequest {
|
|
|
6806
6806
|
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
6807
6807
|
* @public
|
|
6808
6808
|
*/
|
|
6809
|
-
schedulingPolicyArn?: string;
|
|
6809
|
+
schedulingPolicyArn?: string | undefined;
|
|
6810
6810
|
/**
|
|
6811
6811
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
6812
6812
|
* value for the <code>priority</code> parameter) are evaluated first when associated with the
|
|
@@ -6817,7 +6817,7 @@ export interface UpdateJobQueueRequest {
|
|
|
6817
6817
|
* <code>FARGATE_SPOT</code>). EC2 and Fargate compute environments can't be mixed.</p>
|
|
6818
6818
|
* @public
|
|
6819
6819
|
*/
|
|
6820
|
-
priority?: number;
|
|
6820
|
+
priority?: number | undefined;
|
|
6821
6821
|
/**
|
|
6822
6822
|
* <p>Details the set of compute environments mapped to a job queue and their order relative to
|
|
6823
6823
|
* each other. This is one of the parameters used by the job scheduler to determine which compute
|
|
@@ -6832,12 +6832,12 @@ export interface UpdateJobQueueRequest {
|
|
|
6832
6832
|
* </note>
|
|
6833
6833
|
* @public
|
|
6834
6834
|
*/
|
|
6835
|
-
computeEnvironmentOrder?: ComputeEnvironmentOrder[];
|
|
6835
|
+
computeEnvironmentOrder?: ComputeEnvironmentOrder[] | undefined;
|
|
6836
6836
|
/**
|
|
6837
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>
|
|
6838
6838
|
* @public
|
|
6839
6839
|
*/
|
|
6840
|
-
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
|
|
6840
|
+
jobStateTimeLimitActions?: JobStateTimeLimitAction[] | undefined;
|
|
6841
6841
|
}
|
|
6842
6842
|
/**
|
|
6843
6843
|
* @public
|
|
@@ -6847,12 +6847,12 @@ export interface UpdateJobQueueResponse {
|
|
|
6847
6847
|
* <p>The name of the job queue.</p>
|
|
6848
6848
|
* @public
|
|
6849
6849
|
*/
|
|
6850
|
-
jobQueueName?: string;
|
|
6850
|
+
jobQueueName?: string | undefined;
|
|
6851
6851
|
/**
|
|
6852
6852
|
* <p>The Amazon Resource Name (ARN) of the job queue.</p>
|
|
6853
6853
|
* @public
|
|
6854
6854
|
*/
|
|
6855
|
-
jobQueueArn?: string;
|
|
6855
|
+
jobQueueArn?: string | undefined;
|
|
6856
6856
|
}
|
|
6857
6857
|
/**
|
|
6858
6858
|
* <p>Contains the parameters for <code>UpdateSchedulingPolicy</code>.</p>
|
|
@@ -6868,7 +6868,7 @@ export interface UpdateSchedulingPolicyRequest {
|
|
|
6868
6868
|
* <p>The fair share policy.</p>
|
|
6869
6869
|
* @public
|
|
6870
6870
|
*/
|
|
6871
|
-
fairsharePolicy?: FairsharePolicy;
|
|
6871
|
+
fairsharePolicy?: FairsharePolicy | undefined;
|
|
6872
6872
|
}
|
|
6873
6873
|
/**
|
|
6874
6874
|
* @public
|