@aws-sdk/client-batch 3.194.0 → 3.196.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/CHANGELOG.md +19 -0
- package/README.md +5 -5
- package/dist-cjs/BatchClient.js +11 -8
- package/dist-cjs/commands/CancelJobCommand.js +10 -0
- package/dist-cjs/commands/CreateComputeEnvironmentCommand.js +10 -0
- package/dist-cjs/commands/CreateJobQueueCommand.js +10 -0
- package/dist-cjs/commands/CreateSchedulingPolicyCommand.js +10 -0
- package/dist-cjs/commands/DeleteComputeEnvironmentCommand.js +10 -0
- package/dist-cjs/commands/DeleteJobQueueCommand.js +10 -0
- package/dist-cjs/commands/DeleteSchedulingPolicyCommand.js +10 -0
- package/dist-cjs/commands/DeregisterJobDefinitionCommand.js +10 -0
- package/dist-cjs/commands/DescribeComputeEnvironmentsCommand.js +10 -0
- package/dist-cjs/commands/DescribeJobDefinitionsCommand.js +10 -0
- package/dist-cjs/commands/DescribeJobQueuesCommand.js +10 -0
- package/dist-cjs/commands/DescribeJobsCommand.js +10 -0
- package/dist-cjs/commands/DescribeSchedulingPoliciesCommand.js +10 -0
- package/dist-cjs/commands/ListJobsCommand.js +10 -0
- package/dist-cjs/commands/ListSchedulingPoliciesCommand.js +10 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +10 -0
- package/dist-cjs/commands/RegisterJobDefinitionCommand.js +10 -0
- package/dist-cjs/commands/SubmitJobCommand.js +10 -0
- package/dist-cjs/commands/TagResourceCommand.js +10 -0
- package/dist-cjs/commands/TerminateJobCommand.js +10 -0
- package/dist-cjs/commands/UntagResourceCommand.js +10 -0
- package/dist-cjs/commands/UpdateComputeEnvironmentCommand.js +10 -0
- package/dist-cjs/commands/UpdateJobQueueCommand.js +10 -0
- package/dist-cjs/commands/UpdateSchedulingPolicyCommand.js +10 -0
- package/dist-cjs/endpoint/EndpointParameters.js +13 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +368 -0
- package/dist-cjs/models/models_0.js +88 -3
- package/dist-cjs/protocols/Aws_restJson1.js +448 -0
- package/dist-cjs/runtimeConfig.shared.js +3 -3
- package/dist-es/BatchClient.js +12 -9
- package/dist-es/commands/CancelJobCommand.js +10 -0
- package/dist-es/commands/CreateComputeEnvironmentCommand.js +10 -0
- package/dist-es/commands/CreateJobQueueCommand.js +10 -0
- package/dist-es/commands/CreateSchedulingPolicyCommand.js +10 -0
- package/dist-es/commands/DeleteComputeEnvironmentCommand.js +10 -0
- package/dist-es/commands/DeleteJobQueueCommand.js +10 -0
- package/dist-es/commands/DeleteSchedulingPolicyCommand.js +10 -0
- package/dist-es/commands/DeregisterJobDefinitionCommand.js +10 -0
- package/dist-es/commands/DescribeComputeEnvironmentsCommand.js +10 -0
- package/dist-es/commands/DescribeJobDefinitionsCommand.js +10 -0
- package/dist-es/commands/DescribeJobQueuesCommand.js +10 -0
- package/dist-es/commands/DescribeJobsCommand.js +10 -0
- package/dist-es/commands/DescribeSchedulingPoliciesCommand.js +10 -0
- package/dist-es/commands/ListJobsCommand.js +10 -0
- package/dist-es/commands/ListSchedulingPoliciesCommand.js +10 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +10 -0
- package/dist-es/commands/RegisterJobDefinitionCommand.js +10 -0
- package/dist-es/commands/SubmitJobCommand.js +10 -0
- package/dist-es/commands/TagResourceCommand.js +10 -0
- package/dist-es/commands/TerminateJobCommand.js +10 -0
- package/dist-es/commands/UntagResourceCommand.js +10 -0
- package/dist-es/commands/UpdateComputeEnvironmentCommand.js +10 -0
- package/dist-es/commands/UpdateJobQueueCommand.js +10 -0
- package/dist-es/commands/UpdateSchedulingPolicyCommand.js +10 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +365 -0
- package/dist-es/models/models_0.js +65 -0
- package/dist-es/protocols/Aws_restJson1.js +448 -0
- package/dist-es/runtimeConfig.shared.js +2 -2
- package/dist-types/Batch.d.ts +30 -30
- package/dist-types/BatchClient.d.ts +11 -14
- package/dist-types/commands/CancelJobCommand.d.ts +5 -3
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +22 -20
- package/dist-types/commands/CreateJobQueueCommand.d.ts +2 -0
- package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +2 -0
- package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +2 -0
- package/dist-types/commands/DeleteJobQueueCommand.d.ts +2 -0
- package/dist-types/commands/DeleteSchedulingPolicyCommand.d.ts +2 -0
- package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +2 -0
- package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +2 -0
- package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +2 -0
- package/dist-types/commands/DescribeJobQueuesCommand.d.ts +2 -0
- package/dist-types/commands/DescribeJobsCommand.d.ts +2 -0
- package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +2 -0
- package/dist-types/commands/ListJobsCommand.d.ts +2 -0
- package/dist-types/commands/ListSchedulingPoliciesCommand.d.ts +2 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -1
- package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +2 -0
- package/dist-types/commands/SubmitJobCommand.d.ts +2 -0
- package/dist-types/commands/TagResourceCommand.d.ts +3 -1
- package/dist-types/commands/TerminateJobCommand.d.ts +2 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -0
- package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +2 -0
- package/dist-types/commands/UpdateJobQueueCommand.d.ts +2 -0
- package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +2 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +1322 -552
- package/dist-types/runtimeConfig.browser.d.ts +4 -2
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +4 -2
- package/dist-types/runtimeConfig.shared.d.ts +3 -1
- package/dist-types/ts3.4/BatchClient.d.ts +15 -8
- package/dist-types/ts3.4/commands/CancelJobCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateComputeEnvironmentCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateJobQueueCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateSchedulingPolicyCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteComputeEnvironmentCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteJobQueueCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteSchedulingPolicyCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeregisterJobDefinitionCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DescribeComputeEnvironmentsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DescribeJobDefinitionsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DescribeJobQueuesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DescribeJobsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DescribeSchedulingPoliciesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListSchedulingPoliciesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/RegisterJobDefinitionCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/SubmitJobCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/TerminateJobCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateComputeEnvironmentCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateJobQueueCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateSchedulingPolicyCommand.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +26 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +177 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +14 -4
- package/dist-types/ts3.4/runtimeConfig.d.ts +14 -4
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +14 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +6 -1
- package/package.json +5 -3
- package/dist-cjs/endpoints.js +0 -185
- package/dist-es/endpoints.js +0 -181
- package/dist-types/endpoints.d.ts +0 -2
- package/dist-types/ts3.4/endpoints.d.ts +0 -2
|
@@ -5,7 +5,7 @@ export declare enum ArrayJobDependency {
|
|
|
5
5
|
SEQUENTIAL = "SEQUENTIAL"
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* <p>An object
|
|
8
|
+
* <p>An object that represents an Batch array job.</p>
|
|
9
9
|
*/
|
|
10
10
|
export interface ArrayProperties {
|
|
11
11
|
/**
|
|
@@ -14,7 +14,7 @@ export interface ArrayProperties {
|
|
|
14
14
|
size?: number;
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>An object
|
|
17
|
+
* <p>An object that represents the array properties of a job.</p>
|
|
18
18
|
*/
|
|
19
19
|
export interface ArrayPropertiesDetail {
|
|
20
20
|
/**
|
|
@@ -33,7 +33,7 @@ export interface ArrayPropertiesDetail {
|
|
|
33
33
|
index?: number;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
* <p>An object
|
|
36
|
+
* <p>An object that represents the array properties of a job.</p>
|
|
37
37
|
*/
|
|
38
38
|
export interface ArrayPropertiesSummary {
|
|
39
39
|
/**
|
|
@@ -51,7 +51,7 @@ export declare enum AssignPublicIp {
|
|
|
51
51
|
ENABLED = "ENABLED"
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
|
-
* <p>An object
|
|
54
|
+
* <p>An object that represents the elastic network interface for a multi-node parallel job node.</p>
|
|
55
55
|
*/
|
|
56
56
|
export interface NetworkInterface {
|
|
57
57
|
/**
|
|
@@ -68,7 +68,7 @@ export interface NetworkInterface {
|
|
|
68
68
|
privateIpv4Address?: string;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* <p>An object
|
|
71
|
+
* <p>An object that represents the details of a container that's part of a job attempt.</p>
|
|
72
72
|
*/
|
|
73
73
|
export interface AttemptContainerDetail {
|
|
74
74
|
/**
|
|
@@ -81,45 +81,45 @@ export interface AttemptContainerDetail {
|
|
|
81
81
|
*/
|
|
82
82
|
taskArn?: string;
|
|
83
83
|
/**
|
|
84
|
-
* <p>The exit code for the job attempt. A non-zero exit code is considered
|
|
84
|
+
* <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
|
|
85
85
|
*/
|
|
86
86
|
exitCode?: number;
|
|
87
87
|
/**
|
|
88
|
-
* <p>A short (255 max characters) human-readable string to provide additional details
|
|
88
|
+
* <p>A short (255 max characters) human-readable string to provide additional details for a running or stopped
|
|
89
89
|
* container.</p>
|
|
90
90
|
*/
|
|
91
91
|
reason?: string;
|
|
92
92
|
/**
|
|
93
|
-
* <p>The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs
|
|
94
|
-
*
|
|
95
|
-
*
|
|
93
|
+
* <p>The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs
|
|
94
|
+
* is <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the
|
|
95
|
+
* <code>RUNNING</code> status.</p>
|
|
96
96
|
*/
|
|
97
97
|
logStreamName?: string;
|
|
98
98
|
/**
|
|
99
|
-
* <p>The network interfaces associated with the job attempt.</p>
|
|
99
|
+
* <p>The network interfaces that are associated with the job attempt.</p>
|
|
100
100
|
*/
|
|
101
101
|
networkInterfaces?: NetworkInterface[];
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* <p>An object
|
|
104
|
+
* <p>An object that represents a job attempt.</p>
|
|
105
105
|
*/
|
|
106
106
|
export interface AttemptDetail {
|
|
107
107
|
/**
|
|
108
|
-
* <p>
|
|
108
|
+
* <p>The details for the container in this job attempt.</p>
|
|
109
109
|
*/
|
|
110
110
|
container?: AttemptContainerDetail;
|
|
111
111
|
/**
|
|
112
112
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the
|
|
113
|
-
*
|
|
113
|
+
* <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
|
|
114
114
|
*/
|
|
115
115
|
startedAt?: number;
|
|
116
116
|
/**
|
|
117
117
|
* <p>The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the
|
|
118
|
-
*
|
|
118
|
+
* <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>
|
|
119
119
|
*/
|
|
120
120
|
stoppedAt?: number;
|
|
121
121
|
/**
|
|
122
|
-
* <p>A short, human-readable string to provide additional details
|
|
122
|
+
* <p>A short, human-readable string to provide additional details for the current status of the job attempt.</p>
|
|
123
123
|
*/
|
|
124
124
|
statusReason?: string;
|
|
125
125
|
}
|
|
@@ -141,8 +141,9 @@ export interface CancelJobRequest {
|
|
|
141
141
|
export interface CancelJobResponse {
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* <p>These errors are usually caused by a client action
|
|
145
|
-
* doesn't have permissions to use the action or resource
|
|
144
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
145
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
146
|
+
* that's not valid.</p>
|
|
146
147
|
*/
|
|
147
148
|
export declare class ClientException extends __BaseException {
|
|
148
149
|
readonly name: "ClientException";
|
|
@@ -170,36 +171,64 @@ export declare enum CRAllocationStrategy {
|
|
|
170
171
|
}
|
|
171
172
|
/**
|
|
172
173
|
* <p>Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If
|
|
173
|
-
*
|
|
174
|
+
* <code>Ec2Configuration</code> isn't specified, the default is <code>ECS_AL2</code> (<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon Linux 2</a>).</p>
|
|
174
175
|
* <note>
|
|
175
176
|
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
176
177
|
* </note>
|
|
177
178
|
*/
|
|
178
179
|
export interface Ec2Configuration {
|
|
179
180
|
/**
|
|
180
|
-
* <p>The image type to match with the instance type to select an AMI.
|
|
181
|
-
*
|
|
182
|
-
* (<code>ECS_AL2</code>) is used. If a new image type is specified in an update, but neither an <code>imageId</code> nor a <code>imageIdOverride</code> parameter is specified, then the latest Amazon ECS optimized AMI for that image type
|
|
183
|
-
* that's supported by Batch is used.</p>
|
|
181
|
+
* <p>The image type to match with the instance type to select an AMI. The supported values are different for
|
|
182
|
+
* <code>ECS</code> and <code>EKS</code> resources.</p>
|
|
184
183
|
* <dl>
|
|
185
|
-
* <dt>
|
|
184
|
+
* <dt>ECS</dt>
|
|
186
185
|
* <dd>
|
|
187
|
-
* <p>
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
186
|
+
* <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon ECS-optimized Amazon Linux 2 AMI</a>
|
|
187
|
+
* (<code>ECS_AL2</code>) is used. If a new image type is specified in an update, but neither an <code>imageId</code>
|
|
188
|
+
* nor a <code>imageIdOverride</code> parameter is specified, then the latest Amazon ECS optimized AMI for that image type
|
|
189
|
+
* that's supported by Batch is used.</p>
|
|
190
|
+
* <dl>
|
|
191
|
+
* <dt>ECS_AL2</dt>
|
|
192
|
+
* <dd>
|
|
193
|
+
* <p>
|
|
194
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon
|
|
195
|
+
* Linux 2</a>: Default for all non-GPU instance families.</p>
|
|
196
|
+
* </dd>
|
|
197
|
+
* <dt>ECS_AL2_NVIDIA</dt>
|
|
198
|
+
* <dd>
|
|
199
|
+
* <p>
|
|
200
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami">Amazon
|
|
201
|
+
* Linux 2 (GPU)</a>: Default for all GPU instance families (for example <code>P4</code> and <code>G4</code>)
|
|
202
|
+
* and can be used for all non Amazon Web Services Graviton-based instance types.</p>
|
|
203
|
+
* </dd>
|
|
204
|
+
* <dt>ECS_AL1</dt>
|
|
205
|
+
* <dd>
|
|
206
|
+
* <p>
|
|
207
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami">Amazon Linux</a>. Amazon Linux has reached the end-of-life of standard support. For more information, see <a href="http://aws.amazon.com/amazon-linux-ami/">Amazon Linux AMI</a>.</p>
|
|
208
|
+
* </dd>
|
|
209
|
+
* </dl>
|
|
197
210
|
* </dd>
|
|
198
|
-
* <dt>
|
|
211
|
+
* <dt>EKS</dt>
|
|
199
212
|
* <dd>
|
|
200
|
-
* <p>
|
|
201
|
-
*
|
|
202
|
-
*
|
|
213
|
+
* <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon EKS-optimized Amazon Linux AMI</a>
|
|
214
|
+
* (<code>EKS_AL2</code>) is used. If a new image type is specified in an update, but neither an <code>imageId</code>
|
|
215
|
+
* nor a <code>imageIdOverride</code> parameter is specified, then the latest Amazon EKS optimized AMI for that image type
|
|
216
|
+
* that Batch supports is used.</p>
|
|
217
|
+
* <dl>
|
|
218
|
+
* <dt>EKS_AL2</dt>
|
|
219
|
+
* <dd>
|
|
220
|
+
* <p>
|
|
221
|
+
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon
|
|
222
|
+
* Linux 2</a>: Default for all non-GPU instance families.</p>
|
|
223
|
+
* </dd>
|
|
224
|
+
* <dt>EKS_AL2_NVIDIA</dt>
|
|
225
|
+
* <dd>
|
|
226
|
+
* <p>
|
|
227
|
+
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon Linux 2
|
|
228
|
+
* (accelerated)</a>: Default for all GPU instance families (for example, <code>P4</code> and
|
|
229
|
+
* <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based instance types.</p>
|
|
230
|
+
* </dd>
|
|
231
|
+
* </dl>
|
|
203
232
|
* </dd>
|
|
204
233
|
* </dl>
|
|
205
234
|
*/
|
|
@@ -217,12 +246,17 @@ export interface Ec2Configuration {
|
|
|
217
246
|
* </note>
|
|
218
247
|
*/
|
|
219
248
|
imageIdOverride?: string;
|
|
249
|
+
/**
|
|
250
|
+
* <p>The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch
|
|
251
|
+
* supports is used.</p>
|
|
252
|
+
*/
|
|
253
|
+
imageKubernetesVersion?: string;
|
|
220
254
|
}
|
|
221
255
|
/**
|
|
222
|
-
* <p>An object
|
|
223
|
-
* template ID or launch template name in the request, but not both.</p>
|
|
256
|
+
* <p>An object that represents a launch template that's associated with a compute resource. You must specify either
|
|
257
|
+
* the launch template ID or launch template name in the request, but not both.</p>
|
|
224
258
|
* <p>If security groups are specified using both the <code>securityGroupIds</code> parameter of
|
|
225
|
-
*
|
|
259
|
+
* <code>CreateComputeEnvironment</code> and the launch template, the values in the <code>securityGroupIds</code>
|
|
226
260
|
* parameter of <code>CreateComputeEnvironment</code> will be used.</p>
|
|
227
261
|
* <note>
|
|
228
262
|
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
@@ -240,16 +274,16 @@ export interface LaunchTemplateSpecification {
|
|
|
240
274
|
/**
|
|
241
275
|
* <p>The version number of the launch template, <code>$Latest</code>, or <code>$Default</code>.</p>
|
|
242
276
|
* <p>If the value is <code>$Latest</code>, the latest version of the launch template is used. If the value is
|
|
243
|
-
*
|
|
277
|
+
* <code>$Default</code>, the default version of the launch template is used.</p>
|
|
244
278
|
* <important>
|
|
245
279
|
* <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the
|
|
246
|
-
* compute environment is updated. It's only changed if the <code>updateToLatestImageVersion</code> parameter for the
|
|
247
|
-
* environment is set to <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or
|
|
248
|
-
*
|
|
280
|
+
* compute environment is updated. It's only changed if the <code>updateToLatestImageVersion</code> parameter for the
|
|
281
|
+
* compute environment is set to <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or
|
|
282
|
+
* <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it might use a different
|
|
249
283
|
* version of the launch template. This is the case even if the launch template isn't specified in the update. When
|
|
250
284
|
* updating a compute environment, changing the launch template requires an infrastructure update of the compute
|
|
251
285
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
252
|
-
*
|
|
286
|
+
* <i>Batch User Guide</i>.</p>
|
|
253
287
|
* </important>
|
|
254
288
|
* <p>Default: <code>$Default</code>.</p>
|
|
255
289
|
*/
|
|
@@ -262,16 +296,16 @@ export declare enum CRType {
|
|
|
262
296
|
SPOT = "SPOT"
|
|
263
297
|
}
|
|
264
298
|
/**
|
|
265
|
-
* <p>An object
|
|
299
|
+
* <p>An object that represents an Batch compute resource. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the
|
|
266
300
|
* <i>Batch User Guide</i>.</p>
|
|
267
301
|
*/
|
|
268
302
|
export interface ComputeResource {
|
|
269
303
|
/**
|
|
270
304
|
* <p>The type of compute environment: <code>EC2</code>, <code>SPOT</code>, <code>FARGATE</code>, or
|
|
271
|
-
*
|
|
305
|
+
* <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
|
|
272
306
|
* <i>Batch User Guide</i>.</p>
|
|
273
307
|
* <p> If you choose <code>SPOT</code>, you must also specify an Amazon EC2 Spot Fleet role with the
|
|
274
|
-
*
|
|
308
|
+
* <code>spotIamFleetRole</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html">Amazon EC2 spot fleet role</a> in the
|
|
275
309
|
* <i>Batch User Guide</i>.</p>
|
|
276
310
|
*/
|
|
277
311
|
type: CRType | string | undefined;
|
|
@@ -281,54 +315,52 @@ export interface ComputeResource {
|
|
|
281
315
|
* information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html">Allocation strategies</a>
|
|
282
316
|
* in the <i>Batch User Guide</i>.</p>
|
|
283
317
|
* <note>
|
|
284
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
285
|
-
* specified.</p>
|
|
318
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
286
319
|
* </note>
|
|
287
320
|
* <dl>
|
|
288
321
|
* <dt>BEST_FIT (default)</dt>
|
|
289
322
|
* <dd>
|
|
290
323
|
* <p>Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
|
|
291
324
|
* instance type. If additional instances of the selected instance type aren't available, Batch waits for the
|
|
292
|
-
* additional instances to be available. If there aren't enough instances available
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
* <i>Batch User Guide</i>.</p>
|
|
325
|
+
* additional instances to be available. If there aren't enough instances available or the user is reaching <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html">Amazon EC2 service limits</a>,
|
|
326
|
+
* additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs
|
|
327
|
+
* lower but can limit scaling. If you're using Spot Fleets with <code>BEST_FIT</code>, the Spot Fleet IAM Role must
|
|
328
|
+
* be specified. Compute resources that use a <code>BEST_FIT</code> allocation strategy don't support infrastructure
|
|
329
|
+
* updates and can't update some parameters. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
330
|
+
* <i>Batch User Guide</i>.</p>
|
|
299
331
|
* </dd>
|
|
300
332
|
* <dt>BEST_FIT_PROGRESSIVE</dt>
|
|
301
333
|
* <dd>
|
|
302
|
-
* <p>Batch
|
|
303
|
-
*
|
|
304
|
-
*
|
|
334
|
+
* <p>Batch selects additional instance types that are large enough to meet the requirements of the jobs in the
|
|
335
|
+
* queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously
|
|
336
|
+
* selected instance types aren't available, Batch selects new instance types.</p>
|
|
305
337
|
* </dd>
|
|
306
338
|
* <dt>SPOT_CAPACITY_OPTIMIZED</dt>
|
|
307
339
|
* <dd>
|
|
308
|
-
* <p>Batch
|
|
309
|
-
*
|
|
310
|
-
*
|
|
340
|
+
* <p>Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the
|
|
341
|
+
* queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is
|
|
342
|
+
* only available for Spot Instance compute resources.</p>
|
|
311
343
|
* </dd>
|
|
312
344
|
* </dl>
|
|
313
|
-
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> strategies
|
|
314
|
-
*
|
|
315
|
-
* <code>maxvCpus</code>
|
|
345
|
+
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> strategies using On-Demand
|
|
346
|
+
* or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
347
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds <code>maxvCpus</code>
|
|
348
|
+
* by more than a single instance.</p>
|
|
316
349
|
*/
|
|
317
350
|
allocationStrategy?: CRAllocationStrategy | string;
|
|
318
351
|
/**
|
|
319
352
|
* <p>The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
|
|
320
|
-
*
|
|
353
|
+
* <code>DISABLED</code>).</p>
|
|
321
354
|
* <note>
|
|
322
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
323
|
-
* specified.</p>
|
|
355
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
324
356
|
* </note>
|
|
325
357
|
*/
|
|
326
358
|
minvCpus?: number;
|
|
327
359
|
/**
|
|
328
360
|
* <p>The maximum number of Amazon EC2 vCPUs that a compute environment can reach.</p>
|
|
329
361
|
* <note>
|
|
330
|
-
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies
|
|
331
|
-
* Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never
|
|
362
|
+
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies
|
|
363
|
+
* using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never
|
|
332
364
|
* exceeds <code>maxvCpus</code> by more than a single instance. For example, no more than a single instance from among
|
|
333
365
|
* those specified in your compute environment is allocated.</p>
|
|
334
366
|
* </note>
|
|
@@ -336,10 +368,9 @@ export interface ComputeResource {
|
|
|
336
368
|
maxvCpus: number | undefined;
|
|
337
369
|
/**
|
|
338
370
|
* <p>The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum
|
|
339
|
-
* and maximum values
|
|
371
|
+
* and maximum values based on job queue demand.</p>
|
|
340
372
|
* <note>
|
|
341
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
342
|
-
* specified.</p>
|
|
373
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
343
374
|
* </note>
|
|
344
375
|
*/
|
|
345
376
|
desiredvCpus?: number;
|
|
@@ -349,8 +380,7 @@ export interface ComputeResource {
|
|
|
349
380
|
* (such as <code>c5.8xlarge</code>). You can also choose <code>optimal</code> to select instance types (from the C4,
|
|
350
381
|
* M4, and R4 instance families) that match the demand of your job queues.</p>
|
|
351
382
|
* <note>
|
|
352
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
353
|
-
* specified.</p>
|
|
383
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
354
384
|
* </note>
|
|
355
385
|
* <note>
|
|
356
386
|
* <p>When you create a compute environment, the instance types that you select for the compute environment must
|
|
@@ -359,7 +389,7 @@ export interface ComputeResource {
|
|
|
359
389
|
* </note>
|
|
360
390
|
* <note>
|
|
361
391
|
* <p>Currently, <code>optimal</code> uses instance types from the C4, M4, and R4 instance families. In Regions that
|
|
362
|
-
* don't have instance types from those instance families, instance types from the C5, M5
|
|
392
|
+
* don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are
|
|
363
393
|
* used.</p>
|
|
364
394
|
* </note>
|
|
365
395
|
*/
|
|
@@ -370,8 +400,7 @@ export interface ComputeResource {
|
|
|
370
400
|
* <p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
|
|
371
401
|
* overridden by the <code>imageIdOverride</code> member of the <code>Ec2Configuration</code> structure.</p>
|
|
372
402
|
* <note>
|
|
373
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
374
|
-
* specified.</p>
|
|
403
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
375
404
|
* </note>
|
|
376
405
|
* <note>
|
|
377
406
|
* <p>The AMI that you choose for a compute environment must match the architecture of the instance types that
|
|
@@ -386,13 +415,13 @@ export interface ComputeResource {
|
|
|
386
415
|
/**
|
|
387
416
|
* <p>The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate
|
|
388
417
|
* compute resources can contain up to 16 subnets. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and subnets</a> in the <i>Amazon VPC User
|
|
389
|
-
*
|
|
418
|
+
* Guide</i>.</p>
|
|
390
419
|
*/
|
|
391
420
|
subnets: string[] | undefined;
|
|
392
421
|
/**
|
|
393
|
-
* <p>The Amazon EC2 security groups associated with instances launched in the compute environment. One or more
|
|
394
|
-
* groups must be specified, either in <code>securityGroupIds</code> or using a launch template referenced in
|
|
395
|
-
*
|
|
422
|
+
* <p>The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more
|
|
423
|
+
* security groups must be specified, either in <code>securityGroupIds</code> or using a launch template referenced in
|
|
424
|
+
* <code>launchTemplate</code>. This parameter is required for jobs that are running on Fargate resources and must
|
|
396
425
|
* contain at least one security group. Fargate doesn't support launch templates. If security groups are specified
|
|
397
426
|
* using both <code>securityGroupIds</code> and <code>launchTemplate</code>, the values in <code>securityGroupIds</code>
|
|
398
427
|
* are used.</p>
|
|
@@ -402,38 +431,34 @@ export interface ComputeResource {
|
|
|
402
431
|
* <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to
|
|
403
432
|
* log in to your instances with SSH.</p>
|
|
404
433
|
* <note>
|
|
405
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
406
|
-
* specified.</p>
|
|
434
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
407
435
|
* </note>
|
|
408
436
|
*/
|
|
409
437
|
ec2KeyPair?: string;
|
|
410
438
|
/**
|
|
411
439
|
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name
|
|
412
|
-
* or full Amazon Resource Name (ARN) of an instance profile. For example,
|
|
413
|
-
* <code>
|
|
440
|
+
* or full Amazon Resource Name (ARN) of an instance profile. For example, <code>
|
|
414
441
|
* <i>ecsInstanceRole</i>
|
|
415
442
|
* </code> or
|
|
416
|
-
*
|
|
443
|
+
* <code>arn:aws:iam::<i><aws_account_id></i>:instance-profile/<i>ecsInstanceRole</i>
|
|
417
444
|
* </code>.
|
|
418
445
|
* For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html">Amazon ECS instance
|
|
419
|
-
*
|
|
446
|
+
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
420
447
|
* <note>
|
|
421
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
422
|
-
* specified.</p>
|
|
448
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
423
449
|
* </note>
|
|
424
450
|
*/
|
|
425
451
|
instanceRole?: string;
|
|
426
452
|
/**
|
|
427
453
|
* <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
|
|
428
|
-
* these take the form of "String1": "String2"
|
|
429
|
-
* example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is
|
|
430
|
-
* instances in the Amazon EC2 console. Updating these tags requires an infrastructure
|
|
431
|
-
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
* <note>
|
|
435
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
436
|
-
* specified.</p>
|
|
454
|
+
* these take the form of <code>"String1": "String2"</code>, where <code>String1</code> is the tag key and
|
|
455
|
+
* <code>String2</code> is the tag value-for example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is
|
|
456
|
+
* helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure
|
|
457
|
+
* update to the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
458
|
+
* <i>Batch User Guide</i>. These tags aren't seen when using the Batch <code>ListTagsForResource</code>
|
|
459
|
+
* API operation.</p>
|
|
460
|
+
* <note>
|
|
461
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
437
462
|
* </note>
|
|
438
463
|
*/
|
|
439
464
|
tags?: Record<string, string>;
|
|
@@ -442,10 +467,9 @@ export interface ComputeResource {
|
|
|
442
467
|
* jobs to your compute environment, you should consider creating a cluster placement group and associate it with your
|
|
443
468
|
* compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single
|
|
444
469
|
* Availability Zone with high network flow potential. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide for
|
|
445
|
-
*
|
|
470
|
+
* Linux Instances</i>.</p>
|
|
446
471
|
* <note>
|
|
447
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
448
|
-
* specified.</p>
|
|
472
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
449
473
|
* </note>
|
|
450
474
|
*/
|
|
451
475
|
placementGroup?: string;
|
|
@@ -456,8 +480,7 @@ export interface ComputeResource {
|
|
|
456
480
|
* never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand
|
|
457
481
|
* price.</p>
|
|
458
482
|
* <note>
|
|
459
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
460
|
-
* specified.</p>
|
|
483
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
461
484
|
* </note>
|
|
462
485
|
*/
|
|
463
486
|
bidPercentage?: number;
|
|
@@ -465,15 +488,14 @@ export interface ComputeResource {
|
|
|
465
488
|
* <p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment. This role is
|
|
466
489
|
* required if the allocation strategy set to <code>BEST_FIT</code> or if the allocation strategy isn't specified. For
|
|
467
490
|
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html">Amazon EC2 spot fleet
|
|
468
|
-
*
|
|
491
|
+
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
469
492
|
* <note>
|
|
470
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
471
|
-
* specified.</p>
|
|
493
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
472
494
|
* </note>
|
|
473
495
|
* <important>
|
|
474
496
|
* <p>To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer <b>AmazonEC2SpotFleetTaggingRole</b> managed policy. The previously recommended <b>AmazonEC2SpotFleetRole</b> managed policy doesn't have the required permissions to tag Spot
|
|
475
497
|
* Instances. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag">Spot instances not tagged on creation</a> in the
|
|
476
|
-
*
|
|
498
|
+
* <i>Batch User Guide</i>.</p>
|
|
477
499
|
* </important>
|
|
478
500
|
*/
|
|
479
501
|
spotIamFleetRole?: string;
|
|
@@ -484,22 +506,40 @@ export interface ComputeResource {
|
|
|
484
506
|
* information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html">Launch template support</a> in
|
|
485
507
|
* the <i>Batch User Guide</i>.</p>
|
|
486
508
|
* <note>
|
|
487
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
488
|
-
* specified.</p>
|
|
509
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
489
510
|
* </note>
|
|
490
511
|
*/
|
|
491
512
|
launchTemplate?: LaunchTemplateSpecification;
|
|
492
513
|
/**
|
|
493
|
-
* <p>Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
|
|
494
|
-
* If <code>Ec2Configuration</code> isn't specified, the default is <code>ECS_AL2</code>.</p>
|
|
514
|
+
* <p>Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
|
|
515
|
+
* environment. If <code>Ec2Configuration</code> isn't specified, the default is <code>ECS_AL2</code>.</p>
|
|
495
516
|
* <p>One or two values can be provided.</p>
|
|
496
517
|
* <note>
|
|
497
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
498
|
-
* specified.</p>
|
|
518
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
499
519
|
* </note>
|
|
500
520
|
*/
|
|
501
521
|
ec2Configuration?: Ec2Configuration[];
|
|
502
522
|
}
|
|
523
|
+
/**
|
|
524
|
+
* <p>Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before
|
|
525
|
+
* the compute environment can be created.</p>
|
|
526
|
+
*/
|
|
527
|
+
export interface EksConfiguration {
|
|
528
|
+
/**
|
|
529
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is
|
|
530
|
+
* <code>arn:<i>aws</i>:eks:<i>us-east-1</i>:<i>123456789012</i>:cluster/<i>ClusterForBatch</i>
|
|
531
|
+
* </code>.
|
|
532
|
+
* </p>
|
|
533
|
+
*/
|
|
534
|
+
eksClusterArn: string | undefined;
|
|
535
|
+
/**
|
|
536
|
+
* <p>The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or
|
|
537
|
+
* null. It must be fewer than 64 characters long, can't be set to <code>default</code>, can't start with
|
|
538
|
+
* "<code>kube-</code>," and must match this regular expression: <code>^[a-z0-9]([-a-z0-9]*[a-z0-9])?$</code>. For more
|
|
539
|
+
* information, see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/">Namespaces</a> in the Kubernetes documentation.</p>
|
|
540
|
+
*/
|
|
541
|
+
kubernetesNamespace: string | undefined;
|
|
542
|
+
}
|
|
503
543
|
export declare enum CEState {
|
|
504
544
|
DISABLED = "DISABLED",
|
|
505
545
|
ENABLED = "ENABLED"
|
|
@@ -513,7 +553,7 @@ export declare enum CEType {
|
|
|
513
553
|
*/
|
|
514
554
|
export interface CreateComputeEnvironmentRequest {
|
|
515
555
|
/**
|
|
516
|
-
* <p>The name for your compute environment. It can be up to 128
|
|
556
|
+
* <p>The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and
|
|
517
557
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
518
558
|
*/
|
|
519
559
|
computeEnvironmentName: string | undefined;
|
|
@@ -561,8 +601,8 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
561
601
|
* </important>
|
|
562
602
|
* <p>If your specified role has a path other than <code>/</code>, then you must specify either the full role ARN
|
|
563
603
|
* (recommended) or prefix the role name with the path. For example, if a role with the name <code>bar</code> has a path
|
|
564
|
-
* of <code>/foo/</code
|
|
565
|
-
*
|
|
604
|
+
* of <code>/foo/</code>, specify <code>/foo/bar</code> as the role name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names">Friendly names
|
|
605
|
+
* and paths</a> in the <i>IAM User Guide</i>.</p>
|
|
566
606
|
* <note>
|
|
567
607
|
* <p>Depending on how you created your Batch service role, its ARN might contain the <code>service-role</code>
|
|
568
608
|
* path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
|
|
@@ -579,10 +619,14 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
579
619
|
* propagate to the underlying compute resources.</p>
|
|
580
620
|
*/
|
|
581
621
|
tags?: Record<string, string>;
|
|
622
|
+
/**
|
|
623
|
+
* <p>The details for the Amazon EKS cluster that supports the compute environment.</p>
|
|
624
|
+
*/
|
|
625
|
+
eksConfiguration?: EksConfiguration;
|
|
582
626
|
}
|
|
583
627
|
export interface CreateComputeEnvironmentResponse {
|
|
584
628
|
/**
|
|
585
|
-
* <p>The name of the compute environment. It can be up to 128
|
|
629
|
+
* <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
|
|
586
630
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
587
631
|
*/
|
|
588
632
|
computeEnvironmentName?: string;
|
|
@@ -592,10 +636,10 @@ export interface CreateComputeEnvironmentResponse {
|
|
|
592
636
|
computeEnvironmentArn?: string;
|
|
593
637
|
}
|
|
594
638
|
/**
|
|
595
|
-
* <p>The order
|
|
639
|
+
* <p>The order that compute environments are tried in for job placement within a queue. Compute environments are
|
|
596
640
|
* tried in ascending order. For example, if two compute environments are associated with a job queue, the compute
|
|
597
641
|
* environment with a lower order integer value is tried for job placement first. Compute environments must be in the
|
|
598
|
-
*
|
|
642
|
+
* <code>VALID</code> state before you can associate them with a job queue. All of the compute environments must be
|
|
599
643
|
* either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>);
|
|
600
644
|
* EC2 and Fargate compute environments can't be mixed.</p>
|
|
601
645
|
* <note>
|
|
@@ -642,7 +686,7 @@ export interface CreateJobQueueRequest {
|
|
|
642
686
|
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
643
687
|
* </code>.
|
|
644
688
|
* An example is
|
|
645
|
-
* <code>aws:aws:batch:us-west-2:
|
|
689
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
646
690
|
*/
|
|
647
691
|
schedulingPolicyArn?: string;
|
|
648
692
|
/**
|
|
@@ -691,11 +735,11 @@ export interface ShareAttributes {
|
|
|
691
735
|
/**
|
|
692
736
|
* <p>A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry
|
|
693
737
|
* specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share
|
|
694
|
-
* identifiers in a fair share policy
|
|
695
|
-
*
|
|
696
|
-
*
|
|
738
|
+
* identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a
|
|
739
|
+
* <code>shareIdentifier</code> of <code>UserA*</code> and another that specifies a <code>shareIdentifier</code> of
|
|
740
|
+
* <code>UserA-1</code>.</p>
|
|
697
741
|
* <p>There can be no more than 500 fair share identifiers active in a job queue.</p>
|
|
698
|
-
* <p>The string is limited to 255 alphanumeric characters,
|
|
742
|
+
* <p>The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).</p>
|
|
699
743
|
*/
|
|
700
744
|
shareIdentifier: string | undefined;
|
|
701
745
|
/**
|
|
@@ -711,25 +755,25 @@ export interface ShareAttributes {
|
|
|
711
755
|
*/
|
|
712
756
|
export interface FairsharePolicy {
|
|
713
757
|
/**
|
|
714
|
-
* <p>The time
|
|
715
|
-
* value of zero (0) indicates that only current usage
|
|
758
|
+
* <p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in
|
|
759
|
+
* use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs
|
|
716
760
|
* to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).</p>
|
|
717
761
|
*/
|
|
718
762
|
shareDecaySeconds?: number;
|
|
719
763
|
/**
|
|
720
|
-
* <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that
|
|
764
|
+
* <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already
|
|
721
765
|
* used.</p>
|
|
722
766
|
* <p>The reserved ratio is
|
|
723
|
-
*
|
|
767
|
+
* <code>(<i>computeReservation</i>/100)^<i>ActiveFairShares</i>
|
|
724
768
|
* </code> where
|
|
725
|
-
*
|
|
769
|
+
* <code>
|
|
726
770
|
* <i>ActiveFairShares</i>
|
|
727
771
|
* </code> is the number of active fair share identifiers.</p>
|
|
728
|
-
* <p>For example, a <code>computeReservation</code> value of 50 indicates that
|
|
729
|
-
*
|
|
730
|
-
* 12.5% if there are three fair share identifiers. A <code>computeReservation</code> value of 25 indicates
|
|
731
|
-
* should reserve 25% of the maximum available vCPU if there
|
|
732
|
-
* fair share identifiers, and 1.56% if there are three fair share identifiers.</p>
|
|
772
|
+
* <p>For example, a <code>computeReservation</code> value of 50 indicates that Batchreserves 50% of the maximum
|
|
773
|
+
* available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It
|
|
774
|
+
* reserves 12.5% if there are three fair share identifiers. A <code>computeReservation</code> value of 25 indicates
|
|
775
|
+
* that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if
|
|
776
|
+
* there are two fair share identifiers, and 1.56% if there are three fair share identifiers.</p>
|
|
733
777
|
* <p>The minimum value is 0 and the maximum value is 99.</p>
|
|
734
778
|
*/
|
|
735
779
|
computeReservation?: number;
|
|
@@ -770,7 +814,7 @@ export interface CreateSchedulingPolicyResponse {
|
|
|
770
814
|
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
771
815
|
* </code>.
|
|
772
816
|
* For example,
|
|
773
|
-
* <code>aws:aws:batch:us-west-2:
|
|
817
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
774
818
|
*/
|
|
775
819
|
arn: string | undefined;
|
|
776
820
|
}
|
|
@@ -839,12 +883,16 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
839
883
|
* continues from the end of the previous results that returned the <code>nextToken</code> value. This value is
|
|
840
884
|
* <code>null</code> when there are no more results to return.</p>
|
|
841
885
|
* <note>
|
|
842
|
-
* <p>
|
|
886
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
843
887
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
844
888
|
* </note>
|
|
845
889
|
*/
|
|
846
890
|
nextToken?: string;
|
|
847
891
|
}
|
|
892
|
+
export declare enum OrchestrationType {
|
|
893
|
+
ECS = "ECS",
|
|
894
|
+
EKS = "EKS"
|
|
895
|
+
}
|
|
848
896
|
export declare enum CEStatus {
|
|
849
897
|
CREATING = "CREATING",
|
|
850
898
|
DELETED = "DELETED",
|
|
@@ -855,8 +903,8 @@ export declare enum CEStatus {
|
|
|
855
903
|
}
|
|
856
904
|
/**
|
|
857
905
|
* <p>Specifies the infrastructure update policy for the compute environment. For more information about
|
|
858
|
-
* infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/infrastructure-updates.html">Infrastructure
|
|
859
|
-
* in the <i>Batch User Guide</i>.</p>
|
|
906
|
+
* infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/infrastructure-updates.html">Infrastructure
|
|
907
|
+
* updates</a> in the <i>Batch User Guide</i>.</p>
|
|
860
908
|
*/
|
|
861
909
|
export interface UpdatePolicy {
|
|
862
910
|
/**
|
|
@@ -865,17 +913,17 @@ export interface UpdatePolicy {
|
|
|
865
913
|
*/
|
|
866
914
|
terminateJobsOnUpdate?: boolean;
|
|
867
915
|
/**
|
|
868
|
-
* <p>Specifies the job timeout
|
|
916
|
+
* <p>Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value
|
|
869
917
|
* is 30.</p>
|
|
870
918
|
*/
|
|
871
919
|
jobExecutionTimeoutMinutes?: number;
|
|
872
920
|
}
|
|
873
921
|
/**
|
|
874
|
-
* <p>An object
|
|
922
|
+
* <p>An object that represents an Batch compute environment.</p>
|
|
875
923
|
*/
|
|
876
924
|
export interface ComputeEnvironmentDetail {
|
|
877
925
|
/**
|
|
878
|
-
* <p>The name of the compute environment. It can be up to 128
|
|
926
|
+
* <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
|
|
879
927
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
880
928
|
*/
|
|
881
929
|
computeEnvironmentName: string | undefined;
|
|
@@ -888,7 +936,7 @@ export interface ComputeEnvironmentDetail {
|
|
|
888
936
|
*/
|
|
889
937
|
unmanagedvCpus?: number;
|
|
890
938
|
/**
|
|
891
|
-
* <p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster
|
|
939
|
+
* <p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.</p>
|
|
892
940
|
*/
|
|
893
941
|
ecsClusterArn?: string;
|
|
894
942
|
/**
|
|
@@ -897,19 +945,19 @@ export interface ComputeEnvironmentDetail {
|
|
|
897
945
|
tags?: Record<string, string>;
|
|
898
946
|
/**
|
|
899
947
|
* <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For more information, see
|
|
900
|
-
*
|
|
901
|
-
*
|
|
948
|
+
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the
|
|
949
|
+
* <i>Batch User Guide</i>.</p>
|
|
902
950
|
*/
|
|
903
951
|
type?: CEType | string;
|
|
904
952
|
/**
|
|
905
953
|
* <p>The state of the compute environment. The valid values are <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
906
954
|
* <p>If the state is <code>ENABLED</code>, then the Batch scheduler can attempt to place jobs from an associated
|
|
907
955
|
* job queue on the compute resources within the environment. If the compute environment is managed, then it can scale
|
|
908
|
-
* its instances out or in automatically
|
|
956
|
+
* its instances out or in automatically based on the job queue demand.</p>
|
|
909
957
|
* <p>If the state is <code>DISABLED</code>, then the Batch scheduler doesn't attempt to place jobs within the
|
|
910
958
|
* environment. Jobs in a <code>STARTING</code> or <code>RUNNING</code> state continue to progress normally. Managed
|
|
911
959
|
* compute environments in the <code>DISABLED</code> state don't scale out. However, they scale in to
|
|
912
|
-
*
|
|
960
|
+
* <code>minvCpus</code> value after instances become idle.</p>
|
|
913
961
|
*/
|
|
914
962
|
state?: CEState | string;
|
|
915
963
|
/**
|
|
@@ -917,7 +965,7 @@ export interface ComputeEnvironmentDetail {
|
|
|
917
965
|
*/
|
|
918
966
|
status?: CEStatus | string;
|
|
919
967
|
/**
|
|
920
|
-
* <p>A short, human-readable string to provide additional details
|
|
968
|
+
* <p>A short, human-readable string to provide additional details for the current status of the compute
|
|
921
969
|
* environment.</p>
|
|
922
970
|
*/
|
|
923
971
|
statusReason?: string;
|
|
@@ -927,17 +975,31 @@ export interface ComputeEnvironmentDetail {
|
|
|
927
975
|
*/
|
|
928
976
|
computeResources?: ComputeResource;
|
|
929
977
|
/**
|
|
930
|
-
* <p>The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API
|
|
978
|
+
* <p>The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API
|
|
931
979
|
* 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
|
|
932
980
|
* <i>Batch User Guide</i>.</p>
|
|
933
981
|
*/
|
|
934
982
|
serviceRole?: string;
|
|
935
983
|
/**
|
|
936
984
|
* <p>Specifies the infrastructure update policy for the compute environment. For more information about
|
|
937
|
-
* infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating
|
|
938
|
-
*
|
|
985
|
+
* infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating
|
|
986
|
+
* compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
939
987
|
*/
|
|
940
988
|
updatePolicy?: UpdatePolicy;
|
|
989
|
+
/**
|
|
990
|
+
* <p>The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this
|
|
991
|
+
* parameter if the <code>containerOrchestrationType</code> is <code>EKS</code>.</p>
|
|
992
|
+
*/
|
|
993
|
+
eksConfiguration?: EksConfiguration;
|
|
994
|
+
/**
|
|
995
|
+
* <p>The orchestration type of the compute environment. The valid values are <code>ECS</code> (default) or
|
|
996
|
+
* <code>EKS</code>.</p>
|
|
997
|
+
*/
|
|
998
|
+
containerOrchestrationType?: OrchestrationType | string;
|
|
999
|
+
/**
|
|
1000
|
+
* <p>Unique identifier for the compute environment.</p>
|
|
1001
|
+
*/
|
|
1002
|
+
uuid?: string;
|
|
941
1003
|
}
|
|
942
1004
|
export interface DescribeComputeEnvironmentsResponse {
|
|
943
1005
|
/**
|
|
@@ -986,7 +1048,7 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
986
1048
|
* from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code>
|
|
987
1049
|
* when there are no more results to return.</p>
|
|
988
1050
|
* <note>
|
|
989
|
-
* <p>
|
|
1051
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
990
1052
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
991
1053
|
* </note>
|
|
992
1054
|
*/
|
|
@@ -1025,7 +1087,7 @@ export declare enum DeviceCgroupPermission {
|
|
|
1025
1087
|
WRITE = "WRITE"
|
|
1026
1088
|
}
|
|
1027
1089
|
/**
|
|
1028
|
-
* <p>An object
|
|
1090
|
+
* <p>An object that represents a container instance host device.</p>
|
|
1029
1091
|
* <note>
|
|
1030
1092
|
* <p>This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.</p>
|
|
1031
1093
|
* </note>
|
|
@@ -1047,30 +1109,30 @@ export interface Device {
|
|
|
1047
1109
|
permissions?: (DeviceCgroupPermission | string)[];
|
|
1048
1110
|
}
|
|
1049
1111
|
/**
|
|
1050
|
-
* <p>The container path, mount options, and size of the tmpfs mount.</p>
|
|
1112
|
+
* <p>The container path, mount options, and size of the <code>tmpfs</code> mount.</p>
|
|
1051
1113
|
* <note>
|
|
1052
1114
|
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
1053
1115
|
* </note>
|
|
1054
1116
|
*/
|
|
1055
1117
|
export interface Tmpfs {
|
|
1056
1118
|
/**
|
|
1057
|
-
* <p>The absolute file path in the container where the tmpfs volume is mounted.</p>
|
|
1119
|
+
* <p>The absolute file path in the container where the <code>tmpfs</code> volume is mounted.</p>
|
|
1058
1120
|
*/
|
|
1059
1121
|
containerPath: string | undefined;
|
|
1060
1122
|
/**
|
|
1061
|
-
* <p>The size (in MiB) of the tmpfs volume.</p>
|
|
1123
|
+
* <p>The size (in MiB) of the <code>tmpfs</code> volume.</p>
|
|
1062
1124
|
*/
|
|
1063
1125
|
size: number | undefined;
|
|
1064
1126
|
/**
|
|
1065
|
-
* <p>The list of tmpfs volume mount options.</p>
|
|
1127
|
+
* <p>The list of <code>tmpfs</code> volume mount options.</p>
|
|
1066
1128
|
* <p>Valid values: "<code>defaults</code>" | "<code>ro</code>" | "<code>rw</code>" | "<code>suid</code>" |
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1073
|
-
*
|
|
1129
|
+
* "<code>nosuid</code>" | "<code>dev</code>" | "<code>nodev</code>" | "<code>exec</code>" | "<code>noexec</code>" |
|
|
1130
|
+
* "<code>sync</code>" | "<code>async</code>" | "<code>dirsync</code>" | "<code>remount</code>" | "<code>mand</code>" |
|
|
1131
|
+
* "<code>nomand</code>" | "<code>atime</code>" | "<code>noatime</code>" | "<code>diratime</code>" |
|
|
1132
|
+
* "<code>nodiratime</code>" | "<code>bind</code>" | "<code>rbind" | "unbindable" | "runbindable" | "private" |
|
|
1133
|
+
* "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime</code>" | "<code>norelatime</code>" |
|
|
1134
|
+
* "<code>strictatime</code>" | "<code>nostrictatime</code>" | "<code>mode</code>" | "<code>uid</code>" |
|
|
1135
|
+
* "<code>gid</code>" | "<code>nr_inodes</code>" | "<code>nr_blocks</code>" | "<code>mpol</code>"</p>
|
|
1074
1136
|
*/
|
|
1075
1137
|
mountOptions?: string[];
|
|
1076
1138
|
}
|
|
@@ -1079,11 +1141,11 @@ export interface Tmpfs {
|
|
|
1079
1141
|
*/
|
|
1080
1142
|
export interface LinuxParameters {
|
|
1081
1143
|
/**
|
|
1082
|
-
* <p>Any host devices to expose to the container. This parameter maps to <code>Devices</code> in the
|
|
1144
|
+
* <p>Any of the host devices to expose to the container. This parameter maps to <code>Devices</code> in the
|
|
1083
1145
|
* <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>--device</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
1084
1146
|
* <note>
|
|
1085
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
1086
|
-
*
|
|
1147
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
|
|
1148
|
+
* jobs.</p>
|
|
1087
1149
|
* </note>
|
|
1088
1150
|
*/
|
|
1089
1151
|
devices?: Device[];
|
|
@@ -1091,61 +1153,61 @@ export interface LinuxParameters {
|
|
|
1091
1153
|
* <p>If true, run an <code>init</code> process inside the container that forwards signals and reaps processes. This
|
|
1092
1154
|
* parameter maps to the <code>--init</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.
|
|
1093
1155
|
* This parameter requires version 1.25 of the Docker Remote API or greater on your
|
|
1094
|
-
* container instance. To check the Docker Remote API version on your container instance, log
|
|
1156
|
+
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
1095
1157
|
* container instance and run the following command: <code>sudo docker version | grep "Server API version"</code>
|
|
1096
1158
|
* </p>
|
|
1097
1159
|
*/
|
|
1098
1160
|
initProcessEnabled?: boolean;
|
|
1099
1161
|
/**
|
|
1100
1162
|
* <p>The value for the size (in MiB) of the <code>/dev/shm</code> volume. This parameter maps to the
|
|
1101
|
-
*
|
|
1163
|
+
* <code>--shm-size</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
1102
1164
|
* <note>
|
|
1103
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
1104
|
-
*
|
|
1165
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
|
|
1166
|
+
* jobs.</p>
|
|
1105
1167
|
* </note>
|
|
1106
1168
|
*/
|
|
1107
1169
|
sharedMemorySize?: number;
|
|
1108
1170
|
/**
|
|
1109
|
-
* <p>The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
|
|
1110
|
-
*
|
|
1171
|
+
* <p>The container path, mount options, and size (in MiB) of the <code>tmpfs</code> mount. This parameter maps to the
|
|
1172
|
+
* <code>--tmpfs</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
1111
1173
|
* <note>
|
|
1112
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
1113
|
-
*
|
|
1174
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter
|
|
1175
|
+
* for this resource type.</p>
|
|
1114
1176
|
* </note>
|
|
1115
1177
|
*/
|
|
1116
1178
|
tmpfs?: Tmpfs[];
|
|
1117
1179
|
/**
|
|
1118
1180
|
* <p>The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
|
|
1119
|
-
*
|
|
1181
|
+
* <code>--memory-swap</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a> where the value is the
|
|
1120
1182
|
* sum of the container memory plus the <code>maxSwap</code> value. For more information, see <a href="https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details">
|
|
1121
1183
|
* <code>--memory-swap</code> details</a> in the Docker documentation.</p>
|
|
1122
1184
|
* <p>If a <code>maxSwap</code> value of <code>0</code> is specified, the container doesn't use swap. Accepted values
|
|
1123
1185
|
* are <code>0</code> or any positive integer. If the <code>maxSwap</code> parameter is omitted, the container doesn't
|
|
1124
|
-
* use the swap configuration for the container instance it
|
|
1125
|
-
* the <code>swappiness</code> parameter to be used.</p>
|
|
1186
|
+
* use the swap configuration for the container instance that it's running on. A <code>maxSwap</code> value must be set
|
|
1187
|
+
* for the <code>swappiness</code> parameter to be used.</p>
|
|
1126
1188
|
* <note>
|
|
1127
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
1128
|
-
*
|
|
1189
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
|
|
1190
|
+
* jobs.</p>
|
|
1129
1191
|
* </note>
|
|
1130
1192
|
*/
|
|
1131
1193
|
maxSwap?: number;
|
|
1132
1194
|
/**
|
|
1133
|
-
* <p>
|
|
1134
|
-
*
|
|
1135
|
-
*
|
|
1136
|
-
*
|
|
1137
|
-
*
|
|
1138
|
-
*
|
|
1139
|
-
*
|
|
1195
|
+
* <p>You can use this parameter to tune a container's memory swappiness behavior. A <code>swappiness</code> value of
|
|
1196
|
+
* <code>0</code> causes swapping to not occur unless absolutely necessary. A <code>swappiness</code> value of
|
|
1197
|
+
* <code>100</code> causes pages to be swapped aggressively. Valid values are whole numbers between <code>0</code> and
|
|
1198
|
+
* <code>100</code>. If the <code>swappiness</code> parameter isn't specified, a default value of <code>60</code> is
|
|
1199
|
+
* used. If a value isn't specified for <code>maxSwap</code>, then this parameter is ignored. If <code>maxSwap</code> is
|
|
1200
|
+
* set to 0, the container doesn't use swap. This parameter maps to the <code>--memory-swappiness</code> option to
|
|
1201
|
+
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
1140
1202
|
* <p>Consider the following when you use a per-container swap configuration.</p>
|
|
1141
1203
|
* <ul>
|
|
1142
1204
|
* <li>
|
|
1143
1205
|
* <p>Swap space must be enabled and allocated on the container instance for the containers to use.</p>
|
|
1144
1206
|
* <note>
|
|
1145
|
-
* <p>
|
|
1146
|
-
* feature. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html">Instance store swap volumes</a> in the
|
|
1147
|
-
*
|
|
1148
|
-
*
|
|
1207
|
+
* <p>By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use
|
|
1208
|
+
* this feature. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html">Instance store swap volumes</a> in the
|
|
1209
|
+
* <i>Amazon EC2 User Guide for Linux Instances</i> or <a href="http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/">How do I allocate memory to work as swap space in an
|
|
1210
|
+
* Amazon EC2 instance by using a swap file?</a>
|
|
1149
1211
|
* </p>
|
|
1150
1212
|
* </note>
|
|
1151
1213
|
* </li>
|
|
@@ -1154,13 +1216,13 @@ export interface LinuxParameters {
|
|
|
1154
1216
|
* </li>
|
|
1155
1217
|
* <li>
|
|
1156
1218
|
* <p>If the <code>maxSwap</code> and <code>swappiness</code> parameters are omitted from a job definition, each
|
|
1157
|
-
* container
|
|
1158
|
-
*
|
|
1219
|
+
* container has a default <code>swappiness</code> value of 60. Moreover, the total swap usage is limited to two times
|
|
1220
|
+
* the memory reservation of the container.</p>
|
|
1159
1221
|
* </li>
|
|
1160
1222
|
* </ul>
|
|
1161
1223
|
* <note>
|
|
1162
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
1163
|
-
*
|
|
1224
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
|
|
1225
|
+
* jobs.</p>
|
|
1164
1226
|
* </note>
|
|
1165
1227
|
*/
|
|
1166
1228
|
swappiness?: number;
|
|
@@ -1175,7 +1237,7 @@ export declare enum LogDriver {
|
|
|
1175
1237
|
SYSLOG = "syslog"
|
|
1176
1238
|
}
|
|
1177
1239
|
/**
|
|
1178
|
-
* <p>An object
|
|
1240
|
+
* <p>An object that represents the secret to expose to your container. Secrets can be exposed to a container in the
|
|
1179
1241
|
* following ways:</p>
|
|
1180
1242
|
* <ul>
|
|
1181
1243
|
* <li>
|
|
@@ -1188,7 +1250,7 @@ export declare enum LogDriver {
|
|
|
1188
1250
|
* </li>
|
|
1189
1251
|
* </ul>
|
|
1190
1252
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying
|
|
1191
|
-
*
|
|
1253
|
+
* sensitive data</a> in the <i>Batch User Guide</i>.</p>
|
|
1192
1254
|
*/
|
|
1193
1255
|
export interface Secret {
|
|
1194
1256
|
/**
|
|
@@ -1196,12 +1258,12 @@ export interface Secret {
|
|
|
1196
1258
|
*/
|
|
1197
1259
|
name: string | undefined;
|
|
1198
1260
|
/**
|
|
1199
|
-
* <p>The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or
|
|
1200
|
-
* full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.</p>
|
|
1261
|
+
* <p>The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or
|
|
1262
|
+
* the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.</p>
|
|
1201
1263
|
* <note>
|
|
1202
1264
|
* <p>If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use
|
|
1203
|
-
* either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN
|
|
1204
|
-
* be specified.</p>
|
|
1265
|
+
* either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN
|
|
1266
|
+
* must be specified.</p>
|
|
1205
1267
|
* </note>
|
|
1206
1268
|
*/
|
|
1207
1269
|
valueFrom: string | undefined;
|
|
@@ -1211,10 +1273,10 @@ export interface Secret {
|
|
|
1211
1273
|
*/
|
|
1212
1274
|
export interface LogConfiguration {
|
|
1213
1275
|
/**
|
|
1214
|
-
* <p>The log driver to use for the container. The valid values listed for this parameter are log drivers
|
|
1215
|
-
* Amazon ECS container agent can communicate with by default.</p>
|
|
1276
|
+
* <p>The log driver to use for the container. The valid values that are listed for this parameter are log drivers
|
|
1277
|
+
* that the Amazon ECS container agent can communicate with by default.</p>
|
|
1216
1278
|
* <p>The supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>,
|
|
1217
|
-
*
|
|
1279
|
+
* <code>json-file</code>, <code>journald</code>, <code>logentries</code>, <code>syslog</code>, and
|
|
1218
1280
|
* <code>splunk</code>.</p>
|
|
1219
1281
|
* <note>
|
|
1220
1282
|
* <p>Jobs that are running on Fargate resources are restricted to the <code>awslogs</code> and <code>splunk</code>
|
|
@@ -1224,70 +1286,71 @@ export interface LogConfiguration {
|
|
|
1224
1286
|
* <dt>awslogs</dt>
|
|
1225
1287
|
* <dd>
|
|
1226
1288
|
* <p>Specifies the Amazon CloudWatch Logs logging driver. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html">Using the awslogs log driver</a> in the
|
|
1227
|
-
*
|
|
1289
|
+
* <i>Batch User Guide</i> and <a href="https://docs.docker.com/config/containers/logging/awslogs/">Amazon CloudWatch Logs logging driver</a> in the Docker documentation.</p>
|
|
1228
1290
|
* </dd>
|
|
1229
1291
|
* <dt>fluentd</dt>
|
|
1230
1292
|
* <dd>
|
|
1231
|
-
* <p>Specifies the Fluentd logging driver. For more information
|
|
1232
|
-
* documentation
|
|
1293
|
+
* <p>Specifies the Fluentd logging driver. For more information including usage and options, see <a href="https://docs.docker.com/config/containers/logging/fluentd/">Fluentd logging driver</a> in the
|
|
1294
|
+
* <i>Docker documentation</i>.</p>
|
|
1233
1295
|
* </dd>
|
|
1234
1296
|
* <dt>gelf</dt>
|
|
1235
1297
|
* <dd>
|
|
1236
|
-
* <p>Specifies the Graylog Extended Format (GELF) logging driver. For more information
|
|
1298
|
+
* <p>Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and
|
|
1237
1299
|
* options, see <a href="https://docs.docker.com/config/containers/logging/gelf/">Graylog Extended Format logging
|
|
1238
|
-
*
|
|
1300
|
+
* driver</a> in the <i>Docker documentation</i>.</p>
|
|
1239
1301
|
* </dd>
|
|
1240
1302
|
* <dt>journald</dt>
|
|
1241
1303
|
* <dd>
|
|
1242
|
-
* <p>Specifies the journald logging driver. For more information
|
|
1243
|
-
* documentation
|
|
1304
|
+
* <p>Specifies the journald logging driver. For more information including usage and options, see <a href="https://docs.docker.com/config/containers/logging/journald/">Journald logging driver</a> in the
|
|
1305
|
+
* <i>Docker documentation</i>.</p>
|
|
1244
1306
|
* </dd>
|
|
1245
1307
|
* <dt>json-file</dt>
|
|
1246
1308
|
* <dd>
|
|
1247
|
-
* <p>Specifies the JSON file logging driver. For more information
|
|
1248
|
-
* documentation
|
|
1309
|
+
* <p>Specifies the JSON file logging driver. For more information including usage and options, see <a href="https://docs.docker.com/config/containers/logging/json-file/">JSON File logging driver</a> in the
|
|
1310
|
+
* <i>Docker documentation</i>.</p>
|
|
1249
1311
|
* </dd>
|
|
1250
1312
|
* <dt>splunk</dt>
|
|
1251
1313
|
* <dd>
|
|
1252
|
-
* <p>Specifies the Splunk logging driver. For more information
|
|
1253
|
-
* documentation
|
|
1314
|
+
* <p>Specifies the Splunk logging driver. For more information including usage and options, see <a href="https://docs.docker.com/config/containers/logging/splunk/">Splunk logging driver</a> in the
|
|
1315
|
+
* <i>Docker documentation</i>.</p>
|
|
1254
1316
|
* </dd>
|
|
1255
1317
|
* <dt>syslog</dt>
|
|
1256
1318
|
* <dd>
|
|
1257
|
-
* <p>Specifies the syslog logging driver. For more information
|
|
1258
|
-
* documentation
|
|
1319
|
+
* <p>Specifies the syslog logging driver. For more information including usage and options, see <a href="https://docs.docker.com/config/containers/logging/syslog/">Syslog logging driver</a> in the
|
|
1320
|
+
* <i>Docker documentation</i>.</p>
|
|
1259
1321
|
* </dd>
|
|
1260
1322
|
* </dl>
|
|
1261
1323
|
* <note>
|
|
1262
1324
|
* <p>If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you
|
|
1263
1325
|
* can fork the Amazon ECS container agent project that's <a href="https://github.com/aws/amazon-ecs-agent">available on
|
|
1264
|
-
*
|
|
1326
|
+
* GitHub</a> and customize it to work with that driver. We encourage you to submit pull requests for changes that
|
|
1265
1327
|
* you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this
|
|
1266
1328
|
* software.</p>
|
|
1267
1329
|
* </note>
|
|
1268
1330
|
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your
|
|
1269
|
-
* container instance. To check the Docker Remote API version on your container instance, log
|
|
1331
|
+
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
1270
1332
|
* container instance and run the following command: <code>sudo docker version | grep "Server API version"</code>
|
|
1271
1333
|
* </p>
|
|
1272
1334
|
*/
|
|
1273
1335
|
logDriver: LogDriver | string | undefined;
|
|
1274
1336
|
/**
|
|
1275
1337
|
* <p>The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your
|
|
1276
|
-
* container instance. To check the Docker Remote API version on your container instance, log
|
|
1338
|
+
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
1277
1339
|
* container instance and run the following command: <code>sudo docker version | grep "Server API version"</code>
|
|
1278
1340
|
* </p>
|
|
1279
1341
|
*/
|
|
1280
1342
|
options?: Record<string, string>;
|
|
1281
1343
|
/**
|
|
1282
1344
|
* <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 data</a> in the
|
|
1283
|
-
*
|
|
1345
|
+
* <i>Batch User Guide</i>.</p>
|
|
1284
1346
|
*/
|
|
1285
1347
|
secretOptions?: Secret[];
|
|
1286
1348
|
}
|
|
1287
1349
|
/**
|
|
1288
|
-
* <p>Details
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1350
|
+
* <p>Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to
|
|
1351
|
+
* <code>Volumes</code> in the <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container">Create a
|
|
1352
|
+
* container</a> section of the <i>Docker Remote API</i> and the <code>--volume</code> option to
|
|
1353
|
+
* docker run.</p>
|
|
1291
1354
|
*/
|
|
1292
1355
|
export interface MountPoint {
|
|
1293
1356
|
/**
|
|
@@ -1310,10 +1373,10 @@ export interface MountPoint {
|
|
|
1310
1373
|
*/
|
|
1311
1374
|
export interface NetworkConfiguration {
|
|
1312
1375
|
/**
|
|
1313
|
-
* <p>Indicates whether the job
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
* default value is "DISABLED".</p>
|
|
1376
|
+
* <p>Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
|
|
1377
|
+
* subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires
|
|
1378
|
+
* a NAT gateway be attached to route requests to the internet. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Amazon ECS task networking</a> in the
|
|
1379
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>. The default value is "<code>DISABLED</code>".</p>
|
|
1317
1380
|
*/
|
|
1318
1381
|
assignPublicIp?: AssignPublicIp | string;
|
|
1319
1382
|
}
|
|
@@ -1324,19 +1387,20 @@ export declare enum ResourceType {
|
|
|
1324
1387
|
}
|
|
1325
1388
|
/**
|
|
1326
1389
|
* <p>The type and amount of a resource to assign to a container. The supported resources include <code>GPU</code>,
|
|
1327
|
-
*
|
|
1390
|
+
* <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
1328
1391
|
*/
|
|
1329
1392
|
export interface ResourceRequirement {
|
|
1330
1393
|
/**
|
|
1331
1394
|
* <p>The quantity of the specified resource to reserve for the container. The values vary based on the
|
|
1332
|
-
*
|
|
1395
|
+
* <code>type</code> specified.</p>
|
|
1333
1396
|
* <dl>
|
|
1334
1397
|
* <dt>type="GPU"</dt>
|
|
1335
1398
|
* <dd>
|
|
1336
|
-
* <p>The number of physical GPUs to reserve for the container.
|
|
1337
|
-
* job
|
|
1399
|
+
* <p>The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all
|
|
1400
|
+
* containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched
|
|
1401
|
+
* on.</p>
|
|
1338
1402
|
* <note>
|
|
1339
|
-
* <p>GPUs
|
|
1403
|
+
* <p>GPUs aren't available for jobs that are running on Fargate resources.</p>
|
|
1340
1404
|
* </note>
|
|
1341
1405
|
* </dd>
|
|
1342
1406
|
* <dt>type="MEMORY"</dt>
|
|
@@ -1347,12 +1411,12 @@ export interface ResourceRequirement {
|
|
|
1347
1411
|
* <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--memory</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.
|
|
1348
1412
|
* You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for
|
|
1349
1413
|
* multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to
|
|
1350
|
-
*
|
|
1351
|
-
*
|
|
1414
|
+
* <code>Memory</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> and the
|
|
1415
|
+
* <code>--memory</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
1352
1416
|
* <note>
|
|
1353
1417
|
* <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for
|
|
1354
1418
|
* a particular instance type, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html">Memory
|
|
1355
|
-
*
|
|
1419
|
+
* management</a> in the <i>Batch User Guide</i>.</p>
|
|
1356
1420
|
* </note>
|
|
1357
1421
|
* <p>For jobs that are running on Fargate resources, then <code>value</code> is the hard limit (in MiB), and
|
|
1358
1422
|
* must match one of the supported values and the <code>VCPU</code> values must be one of the values supported for
|
|
@@ -1409,7 +1473,7 @@ export interface ResourceRequirement {
|
|
|
1409
1473
|
* <dd>
|
|
1410
1474
|
* <p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the
|
|
1411
1475
|
* <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>--cpu-shares</code> option to
|
|
1412
|
-
*
|
|
1476
|
+
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. For EC2
|
|
1413
1477
|
* resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be
|
|
1414
1478
|
* specified for each node at least once.</p>
|
|
1415
1479
|
* <p>For jobs that are running on Fargate resources, then <code>value</code> must match one of the supported
|
|
@@ -1449,7 +1513,7 @@ export interface ResourceRequirement {
|
|
|
1449
1513
|
value: string | undefined;
|
|
1450
1514
|
/**
|
|
1451
1515
|
* <p>The type of resource to assign to a container. The supported resources include <code>GPU</code>,
|
|
1452
|
-
*
|
|
1516
|
+
* <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
1453
1517
|
*/
|
|
1454
1518
|
type: ResourceType | string | undefined;
|
|
1455
1519
|
}
|
|
@@ -1483,18 +1547,18 @@ export declare enum EFSAuthorizationConfigIAM {
|
|
|
1483
1547
|
export interface EFSAuthorizationConfig {
|
|
1484
1548
|
/**
|
|
1485
1549
|
* <p>The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
|
|
1486
|
-
*
|
|
1487
|
-
*
|
|
1488
|
-
*
|
|
1489
|
-
*
|
|
1550
|
+
* <code>EFSVolumeConfiguration</code> must either be omitted or set to <code>/</code> which enforces the path set on
|
|
1551
|
+
* the EFS access point. If an access point is used, transit encryption must be enabled in the
|
|
1552
|
+
* <code>EFSVolumeConfiguration</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Working with Amazon EFS access points</a> in the
|
|
1553
|
+
* <i>Amazon Elastic File System User Guide</i>.</p>
|
|
1490
1554
|
*/
|
|
1491
1555
|
accessPointId?: string;
|
|
1492
1556
|
/**
|
|
1493
1557
|
* <p>Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.
|
|
1494
1558
|
* If enabled, transit encryption must be enabled in the <code>EFSVolumeConfiguration</code>. If this parameter is
|
|
1495
1559
|
* omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints">Using Amazon EFS access points</a> in the
|
|
1496
|
-
*
|
|
1497
|
-
*
|
|
1560
|
+
* <i>Batch User Guide</i>. EFS IAM authorization requires that <code>TransitEncryption</code> be
|
|
1561
|
+
* <code>ENABLED</code> and that a <code>JobRoleArn</code> is specified.</p>
|
|
1498
1562
|
*/
|
|
1499
1563
|
iam?: EFSAuthorizationConfigIAM | string;
|
|
1500
1564
|
}
|
|
@@ -1504,7 +1568,7 @@ export declare enum EFSTransitEncryption {
|
|
|
1504
1568
|
}
|
|
1505
1569
|
/**
|
|
1506
1570
|
* <p>This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html">Amazon EFS Volumes</a> in the
|
|
1507
|
-
*
|
|
1571
|
+
* <i>Batch User Guide</i>.</p>
|
|
1508
1572
|
*/
|
|
1509
1573
|
export interface EFSVolumeConfiguration {
|
|
1510
1574
|
/**
|
|
@@ -1525,7 +1589,7 @@ export interface EFSVolumeConfiguration {
|
|
|
1525
1589
|
* <p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
|
|
1526
1590
|
* Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default
|
|
1527
1591
|
* value of <code>DISABLED</code> is used. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html">Encrypting data in transit</a> in the
|
|
1528
|
-
*
|
|
1592
|
+
* <i>Amazon Elastic File System User Guide</i>.</p>
|
|
1529
1593
|
*/
|
|
1530
1594
|
transitEncryption?: EFSTransitEncryption | string;
|
|
1531
1595
|
/**
|
|
@@ -1540,9 +1604,9 @@ export interface EFSVolumeConfiguration {
|
|
|
1540
1604
|
authorizationConfig?: EFSAuthorizationConfig;
|
|
1541
1605
|
}
|
|
1542
1606
|
/**
|
|
1543
|
-
* <p>Determine whether your data volume persists on the host container instance and where it
|
|
1544
|
-
* parameter is empty, then the Docker daemon assigns a host path for your data volume,
|
|
1545
|
-
* persist after the containers associated with it stop running.</p>
|
|
1607
|
+
* <p>Determine whether your data volume persists on the host container instance and where it's stored. If this
|
|
1608
|
+
* parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't
|
|
1609
|
+
* guaranteed to persist after the containers that are associated with it stop running.</p>
|
|
1546
1610
|
*/
|
|
1547
1611
|
export interface Host {
|
|
1548
1612
|
/**
|
|
@@ -1552,20 +1616,21 @@ export interface Host {
|
|
|
1552
1616
|
* location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the
|
|
1553
1617
|
* contents of the source path folder are exported.</p>
|
|
1554
1618
|
* <note>
|
|
1555
|
-
* <p>This parameter isn't applicable to jobs that run on Fargate resources
|
|
1619
|
+
* <p>This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these
|
|
1620
|
+
* jobs.</p>
|
|
1556
1621
|
* </note>
|
|
1557
1622
|
*/
|
|
1558
1623
|
sourcePath?: string;
|
|
1559
1624
|
}
|
|
1560
1625
|
/**
|
|
1561
|
-
* <p>A data volume used in a job's container properties.</p>
|
|
1626
|
+
* <p>A data volume that's used in a job's container properties.</p>
|
|
1562
1627
|
*/
|
|
1563
1628
|
export interface Volume {
|
|
1564
1629
|
/**
|
|
1565
1630
|
* <p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host
|
|
1566
|
-
* container instance and where it
|
|
1567
|
-
* for your data volume. However, the data isn't guaranteed to persist after the containers associated with it
|
|
1568
|
-
* running.</p>
|
|
1631
|
+
* container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path
|
|
1632
|
+
* for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it
|
|
1633
|
+
* stop running.</p>
|
|
1569
1634
|
* <note>
|
|
1570
1635
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be
|
|
1571
1636
|
* provided.</p>
|
|
@@ -1573,30 +1638,32 @@ export interface Volume {
|
|
|
1573
1638
|
*/
|
|
1574
1639
|
host?: Host;
|
|
1575
1640
|
/**
|
|
1576
|
-
* <p>The name of the volume. It can be up to 255
|
|
1641
|
+
* <p>The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,
|
|
1577
1642
|
* numbers, hyphens (-), and underscores (_). This name is referenced in the <code>sourceVolume</code>
|
|
1578
1643
|
* parameter of container definition <code>mountPoints</code>.</p>
|
|
1579
1644
|
*/
|
|
1580
1645
|
name?: string;
|
|
1581
1646
|
/**
|
|
1582
|
-
* <p>This parameter is specified when you
|
|
1583
|
-
*
|
|
1647
|
+
* <p>This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on
|
|
1648
|
+
* Fargate resources must specify a <code>platformVersion</code> of at least <code>1.4.0</code>.</p>
|
|
1584
1649
|
*/
|
|
1585
1650
|
efsVolumeConfiguration?: EFSVolumeConfiguration;
|
|
1586
1651
|
}
|
|
1587
1652
|
/**
|
|
1588
|
-
* <p>Container properties are used
|
|
1589
|
-
*
|
|
1653
|
+
* <p>Container properties are used
|
|
1654
|
+
* for
|
|
1655
|
+
* Amazon ECS based job definitions. These properties to describe the container that's launched as part of
|
|
1656
|
+
* a job.</p>
|
|
1590
1657
|
*/
|
|
1591
1658
|
export interface ContainerProperties {
|
|
1592
1659
|
/**
|
|
1593
1660
|
* <p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker
|
|
1594
1661
|
* Hub registry are available by default. Other repositories are specified with
|
|
1595
|
-
*
|
|
1662
|
+
* <code>
|
|
1596
1663
|
* <i>repository-url</i>/<i>image</i>:<i>tag</i>
|
|
1597
1664
|
* </code>.
|
|
1598
|
-
*
|
|
1599
|
-
* periods, forward slashes, and number signs
|
|
1665
|
+
* It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,
|
|
1666
|
+
* hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to <code>Image</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of
|
|
1600
1667
|
* the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href="https://docs.docker.com/engine/reference/run/">docker
|
|
1601
1668
|
* run</a>.</p>
|
|
1602
1669
|
* <note>
|
|
@@ -1606,25 +1673,25 @@ export interface ContainerProperties {
|
|
|
1606
1673
|
* <ul>
|
|
1607
1674
|
* <li>
|
|
1608
1675
|
* <p>Images in Amazon ECR Public repositories use the full <code>registry/repository[:tag]</code> or
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1676
|
+
* <code>registry/repository[@digest]</code> naming conventions. For example,
|
|
1677
|
+
* <code>public.ecr.aws/<i>registry_alias</i>/<i>my-web-app</i>:<i>latest</i>
|
|
1611
1678
|
* </code>.</p>
|
|
1612
1679
|
* </li>
|
|
1613
1680
|
* <li>
|
|
1614
1681
|
* <p>Images in Amazon ECR repositories use the full registry and repository URI (for example,
|
|
1615
|
-
*
|
|
1682
|
+
* <code>123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name></code>).</p>
|
|
1616
1683
|
* </li>
|
|
1617
1684
|
* <li>
|
|
1618
1685
|
* <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or
|
|
1619
|
-
*
|
|
1686
|
+
* <code>mongo</code>).</p>
|
|
1620
1687
|
* </li>
|
|
1621
1688
|
* <li>
|
|
1622
1689
|
* <p>Images in other repositories on Docker Hub are qualified with an organization name (for example,
|
|
1623
|
-
*
|
|
1690
|
+
* <code>amazon/amazon-ecs-agent</code>).</p>
|
|
1624
1691
|
* </li>
|
|
1625
1692
|
* <li>
|
|
1626
1693
|
* <p>Images in other online repositories are qualified further by a domain name (for example,
|
|
1627
|
-
*
|
|
1694
|
+
* <code>quay.io/assemblyline/ubuntu</code>).</p>
|
|
1628
1695
|
* </li>
|
|
1629
1696
|
* </ul>
|
|
1630
1697
|
*/
|
|
@@ -1637,15 +1704,15 @@ export interface ContainerProperties {
|
|
|
1637
1704
|
* the number of vCPUs reserved for the job.</p>
|
|
1638
1705
|
* <p>Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to <code>CpuShares</code> in the
|
|
1639
1706
|
* <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>--cpu-shares</code> option to
|
|
1640
|
-
*
|
|
1641
|
-
*
|
|
1707
|
+
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. The number of vCPUs must be specified but can be specified in
|
|
1708
|
+
* several places. You must specify it at least once for each node.</p>
|
|
1642
1709
|
*/
|
|
1643
1710
|
vcpus?: number;
|
|
1644
1711
|
/**
|
|
1645
1712
|
* @deprecated
|
|
1646
1713
|
*
|
|
1647
1714
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the memory requirements for the
|
|
1648
|
-
* job definition. It's not supported for jobs running on Fargate resources. For jobs
|
|
1715
|
+
* job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it
|
|
1649
1716
|
* specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number,
|
|
1650
1717
|
* it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can
|
|
1651
1718
|
* be specified in several places. It must be specified for each node at least once.</p>
|
|
@@ -1658,14 +1725,14 @@ export interface ContainerProperties {
|
|
|
1658
1725
|
command?: string[];
|
|
1659
1726
|
/**
|
|
1660
1727
|
* <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see
|
|
1661
|
-
*
|
|
1728
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a>
|
|
1662
1729
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1663
1730
|
*/
|
|
1664
1731
|
jobRoleArn?: string;
|
|
1665
1732
|
/**
|
|
1666
1733
|
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must
|
|
1667
1734
|
* 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> in the
|
|
1668
|
-
*
|
|
1735
|
+
* <i>Batch User Guide</i>.</p>
|
|
1669
1736
|
*/
|
|
1670
1737
|
executionRoleArn?: string;
|
|
1671
1738
|
/**
|
|
@@ -1680,8 +1747,8 @@ export interface ContainerProperties {
|
|
|
1680
1747
|
* data.</p>
|
|
1681
1748
|
* </important>
|
|
1682
1749
|
* <note>
|
|
1683
|
-
* <p>Environment variables
|
|
1684
|
-
* convention is reserved for variables that
|
|
1750
|
+
* <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
|
|
1751
|
+
* convention is reserved for variables that Batch sets.</p>
|
|
1685
1752
|
* </note>
|
|
1686
1753
|
*/
|
|
1687
1754
|
environment?: KeyValuePair[];
|
|
@@ -1700,7 +1767,7 @@ export interface ContainerProperties {
|
|
|
1700
1767
|
* <p>When this parameter is true, the container is given elevated permissions on the host container instance (similar
|
|
1701
1768
|
* to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the
|
|
1702
1769
|
* <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>--privileged</code> option to
|
|
1703
|
-
*
|
|
1770
|
+
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. The default value is false.</p>
|
|
1704
1771
|
* <note>
|
|
1705
1772
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or
|
|
1706
1773
|
* specified as false.</p>
|
|
@@ -1732,7 +1799,7 @@ export interface ContainerProperties {
|
|
|
1732
1799
|
instanceType?: string;
|
|
1733
1800
|
/**
|
|
1734
1801
|
* <p>The type and amount of resources to assign to a container. The supported resources include <code>GPU</code>,
|
|
1735
|
-
*
|
|
1802
|
+
* <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
1736
1803
|
*/
|
|
1737
1804
|
resourceRequirements?: ResourceRequirement[];
|
|
1738
1805
|
/**
|
|
@@ -1748,25 +1815,25 @@ export interface ContainerProperties {
|
|
|
1748
1815
|
* definition. To use a different logging driver for a container, the log system must be configured properly on the
|
|
1749
1816
|
* container instance (or on a different log server for remote logging options). For more information on the options for
|
|
1750
1817
|
* different supported log drivers, see <a href="https://docs.docker.com/engine/admin/logging/overview/">Configure
|
|
1751
|
-
*
|
|
1818
|
+
* logging drivers</a> in the Docker documentation.</p>
|
|
1752
1819
|
* <note>
|
|
1753
1820
|
* <p>Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type).</p>
|
|
1754
1821
|
* </note>
|
|
1755
1822
|
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your
|
|
1756
|
-
* container instance. To check the Docker Remote API version on your container instance, log
|
|
1823
|
+
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
1757
1824
|
* container instance and run the following command: <code>sudo docker version | grep "Server API version"</code>
|
|
1758
1825
|
* </p>
|
|
1759
1826
|
* <note>
|
|
1760
1827
|
* <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that
|
|
1761
1828
|
* instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that
|
|
1762
1829
|
* instance can use these log configuration options. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS container agent configuration</a> in the
|
|
1763
|
-
*
|
|
1830
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1764
1831
|
* </note>
|
|
1765
1832
|
*/
|
|
1766
1833
|
logConfiguration?: LogConfiguration;
|
|
1767
1834
|
/**
|
|
1768
1835
|
* <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
|
|
1769
|
-
*
|
|
1836
|
+
* <i>Batch User Guide</i>.</p>
|
|
1770
1837
|
*/
|
|
1771
1838
|
secrets?: Secret[];
|
|
1772
1839
|
/**
|
|
@@ -1781,15 +1848,370 @@ export interface ContainerProperties {
|
|
|
1781
1848
|
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
1782
1849
|
}
|
|
1783
1850
|
/**
|
|
1784
|
-
* <p>An
|
|
1851
|
+
* <p>An environment variable.</p>
|
|
1852
|
+
*/
|
|
1853
|
+
export interface EksContainerEnvironmentVariable {
|
|
1854
|
+
/**
|
|
1855
|
+
* <p>The name of the environment variable.</p>
|
|
1856
|
+
*/
|
|
1857
|
+
name: string | undefined;
|
|
1858
|
+
/**
|
|
1859
|
+
* <p>The value of the environment variable.</p>
|
|
1860
|
+
*/
|
|
1861
|
+
value?: string;
|
|
1862
|
+
}
|
|
1863
|
+
/**
|
|
1864
|
+
* <p>The type and amount of resources to assign to a container. The supported resources include <code>memory</code>,
|
|
1865
|
+
* <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods
|
|
1866
|
+
* and containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1867
|
+
*/
|
|
1868
|
+
export interface EksContainerResourceRequirements {
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>The type and quantity of the resources to reserve for the container. The values vary based on the
|
|
1871
|
+
* <code>name</code> that's specified. Resources can be requested using either the <code>limits</code> or the
|
|
1872
|
+
* <code>requests</code> objects.</p>
|
|
1873
|
+
* <dl>
|
|
1874
|
+
* <dt>memory</dt>
|
|
1875
|
+
* <dd>
|
|
1876
|
+
* <p>The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container
|
|
1877
|
+
* attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory
|
|
1878
|
+
* for a job. <code>memory</code> can be specified in <code>limits</code>, <code>requests</code>, or both. If
|
|
1879
|
+
* <code>memory</code> is specified in both places, then the value that's specified in <code>limits</code> must be
|
|
1880
|
+
* equal to the value that's specified in <code>requests</code>.</p>
|
|
1881
|
+
* <note>
|
|
1882
|
+
* <p>To maximize your resource utilization, provide your jobs with as much memory as possible for the specific
|
|
1883
|
+
* instance type that you are using. To learn how, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html">Memory management</a> in the
|
|
1884
|
+
* <i>Batch User Guide</i>.</p>
|
|
1885
|
+
* </note>
|
|
1886
|
+
* </dd>
|
|
1887
|
+
* <dt>cpu</dt>
|
|
1888
|
+
* <dd>
|
|
1889
|
+
* <p>The number of CPUs that's reserved for the container. Values must be an even multiple of <code>0.25</code>.
|
|
1890
|
+
* <code>cpu</code> can be specified in <code>limits</code>, <code>requests</code>, or both. If <code>cpu</code> is
|
|
1891
|
+
* specified in both places, then the value that's specified in <code>limits</code> must be at least as large as the
|
|
1892
|
+
* value that's specified in <code>requests</code>.</p>
|
|
1893
|
+
* </dd>
|
|
1894
|
+
* <dt>nvidia.com/gpu</dt>
|
|
1895
|
+
* <dd>
|
|
1896
|
+
* <p>The number of GPUs that's reserved for the container. Values must be a whole integer. <code>memory</code> can
|
|
1897
|
+
* be specified in <code>limits</code>, <code>requests</code>, or both. If <code>memory</code> is specified in both
|
|
1898
|
+
* places, then the value that's specified in <code>limits</code> must be equal to the value that's specified in
|
|
1899
|
+
* <code>requests</code>.</p>
|
|
1900
|
+
* </dd>
|
|
1901
|
+
* </dl>
|
|
1902
|
+
*/
|
|
1903
|
+
limits?: Record<string, string>;
|
|
1904
|
+
/**
|
|
1905
|
+
* <p>The type and quantity of the resources to request for the container. The values vary based on the
|
|
1906
|
+
* <code>name</code> that's specified. Resources can be requested by using either the <code>limits</code> or the
|
|
1907
|
+
* <code>requests</code> objects.</p>
|
|
1908
|
+
* <dl>
|
|
1909
|
+
* <dt>memory</dt>
|
|
1910
|
+
* <dd>
|
|
1911
|
+
* <p>The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container
|
|
1912
|
+
* attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory
|
|
1913
|
+
* for a job. <code>memory</code> can be specified in <code>limits</code>, <code>requests</code>, or both. If
|
|
1914
|
+
* <code>memory</code> is specified in both, then the value that's specified in <code>limits</code> must be equal to
|
|
1915
|
+
* the value that's specified in <code>requests</code>.</p>
|
|
1916
|
+
* <note>
|
|
1917
|
+
* <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for
|
|
1918
|
+
* a particular instance type, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html">Memory
|
|
1919
|
+
* management</a> in the <i>Batch User Guide</i>.</p>
|
|
1920
|
+
* </note>
|
|
1921
|
+
* </dd>
|
|
1922
|
+
* <dt>cpu</dt>
|
|
1923
|
+
* <dd>
|
|
1924
|
+
* <p>The number of CPUs that are reserved for the container. Values must be an even multiple of <code>0.25</code>.
|
|
1925
|
+
* <code>cpu</code> can be specified in <code>limits</code>, <code>requests</code>, or both. If <code>cpu</code> is
|
|
1926
|
+
* specified in both, then the value that's specified in <code>limits</code> must be at least as large as the value
|
|
1927
|
+
* that's specified in <code>requests</code>.</p>
|
|
1928
|
+
* </dd>
|
|
1929
|
+
* <dt>nvidia.com/gpu</dt>
|
|
1930
|
+
* <dd>
|
|
1931
|
+
* <p>The number of GPUs that are reserved for the container. Values must be a whole integer.
|
|
1932
|
+
* <code>nvidia.com/gpu</code> can be specified in <code>limits</code>, <code>requests</code>, or both. If
|
|
1933
|
+
* <code>nvidia.com/gpu</code> is specified in both, then the value that's specified in <code>limits</code> must be
|
|
1934
|
+
* equal to the value that's specified in <code>requests</code>.</p>
|
|
1935
|
+
* </dd>
|
|
1936
|
+
* </dl>
|
|
1937
|
+
*/
|
|
1938
|
+
requests?: Record<string, string>;
|
|
1939
|
+
}
|
|
1940
|
+
/**
|
|
1941
|
+
* <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 security context for a
|
|
1942
|
+
* pod or container</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1943
|
+
*/
|
|
1944
|
+
export interface EksContainerSecurityContext {
|
|
1945
|
+
/**
|
|
1946
|
+
* <p>When this parameter is specified, the container is run as the specified user ID (<code>uid</code>). If this
|
|
1947
|
+
* parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to
|
|
1948
|
+
* <code>RunAsUser</code> and <code>MustRanAs</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups">Users and groups pod
|
|
1949
|
+
* security policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1950
|
+
*/
|
|
1951
|
+
runAsUser?: number;
|
|
1952
|
+
/**
|
|
1953
|
+
* <p>When this parameter is specified, the container is run as the specified group ID (<code>gid</code>). If this
|
|
1954
|
+
* parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to
|
|
1955
|
+
* <code>RunAsGroup</code> and <code>MustRunAs</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups">Users and groups pod
|
|
1956
|
+
* security policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1957
|
+
*/
|
|
1958
|
+
runAsGroup?: number;
|
|
1959
|
+
/**
|
|
1960
|
+
* <p>When this parameter is <code>true</code>, the container is given elevated permissions on the host container
|
|
1961
|
+
* instance. The level of permissions are similar to the <code>root</code> user permissions. The default value is
|
|
1962
|
+
* <code>false</code>. This parameter maps to <code>privileged</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged">Privileged pod security
|
|
1963
|
+
* policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1964
|
+
*/
|
|
1965
|
+
privileged?: boolean;
|
|
1966
|
+
/**
|
|
1967
|
+
* <p>When this parameter is <code>true</code>, the container is given read-only access to its root file system. The
|
|
1968
|
+
* default value is <code>false</code>. This parameter maps to <code>ReadOnlyRootFilesystem</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems">Volumes and file
|
|
1969
|
+
* systems pod security policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1970
|
+
*/
|
|
1971
|
+
readOnlyRootFilesystem?: boolean;
|
|
1972
|
+
/**
|
|
1973
|
+
* <p>When this parameter is specified, the container is run as a user with a <code>uid</code> other than 0. If this
|
|
1974
|
+
* parameter isn't specified, so such rule is enforced. This parameter maps to <code>RunAsUser</code> and
|
|
1975
|
+
* <code>MustRunAsNonRoot</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups">Users and groups pod
|
|
1976
|
+
* security policies</a> in the <i>Kubernetes documentation</i>.</p>
|
|
1977
|
+
*/
|
|
1978
|
+
runAsNonRoot?: boolean;
|
|
1979
|
+
}
|
|
1980
|
+
/**
|
|
1981
|
+
* <p>The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in
|
|
1982
|
+
* Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes
|
|
1983
|
+
* documentation</i>.</p>
|
|
1984
|
+
*/
|
|
1985
|
+
export interface EksContainerVolumeMount {
|
|
1986
|
+
/**
|
|
1987
|
+
* <p>The name the volume mount. This must match the name of one of the volumes in the pod.</p>
|
|
1988
|
+
*/
|
|
1989
|
+
name?: string;
|
|
1990
|
+
/**
|
|
1991
|
+
* <p>The path on the container where the volume is mounted.</p>
|
|
1992
|
+
*/
|
|
1993
|
+
mountPath?: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* <p>If this value is <code>true</code>, the container has read-only access to the volume. Otherwise, the container
|
|
1996
|
+
* can write to the volume. The default value is <code>false</code>.</p>
|
|
1997
|
+
*/
|
|
1998
|
+
readOnly?: boolean;
|
|
1999
|
+
}
|
|
2000
|
+
/**
|
|
2001
|
+
* <p>EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties
|
|
2002
|
+
* for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job
|
|
2003
|
+
* definitions.</p>
|
|
2004
|
+
*/
|
|
2005
|
+
export interface EksContainer {
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>The name of the container. If the name isn't specified, the default name "<code>Default</code>" is used. Each
|
|
2008
|
+
* container in a pod must have a unique name.</p>
|
|
2009
|
+
*/
|
|
2010
|
+
name?: string;
|
|
2011
|
+
/**
|
|
2012
|
+
* <p>The Docker image used to start the container.</p>
|
|
2013
|
+
*/
|
|
2014
|
+
image: string | undefined;
|
|
2015
|
+
/**
|
|
2016
|
+
* <p>The image pull policy for the container. Supported values are <code>Always</code>, <code>IfNotPresent</code>,
|
|
2017
|
+
* and <code>Never</code>. This parameter defaults to <code>IfNotPresent</code>. However, if the <code>:latest</code>
|
|
2018
|
+
* tag is specified, it defaults to <code>Always</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/containers/images/#updating-images">Updating images</a> in the
|
|
2019
|
+
* <i>Kubernetes documentation</i>.</p>
|
|
2020
|
+
*/
|
|
2021
|
+
imagePullPolicy?: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* <p>The entrypoint for the container. This isn't run within a shell. If this isn't specified, the
|
|
2024
|
+
* <code>ENTRYPOINT</code> of the container image is used. Environment variable references are expanded using the
|
|
2025
|
+
* container's environment.</p>
|
|
2026
|
+
* <p>If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,
|
|
2027
|
+
* if the reference is to "<code>$(NAME1)</code>" and the <code>NAME1</code> environment variable doesn't exist, the
|
|
2028
|
+
* command string will remain "<code>$(NAME1)</code>." <code>$$</code> is replaced with <code>$</code> and the resulting
|
|
2029
|
+
* string isn't expanded. For example, <code>$$(VAR_NAME)</code> will be passed as <code>$(VAR_NAME)</code> whether or
|
|
2030
|
+
* not the <code>VAR_NAME</code> environment variable exists. The entrypoint can't be updated. For more information, see
|
|
2031
|
+
* <a href="https://docs.docker.com/engine/reference/builder/#entrypoint">ENTRYPOINT</a> in the
|
|
2032
|
+
* <i>Dockerfile reference</i> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command
|
|
2033
|
+
* and arguments for a container</a> and <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> in
|
|
2034
|
+
* the <i>Kubernetes documentation</i>.</p>
|
|
2035
|
+
*/
|
|
2036
|
+
command?: string[];
|
|
2037
|
+
/**
|
|
2038
|
+
* <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of the container image is
|
|
2039
|
+
* 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>
|
|
2040
|
+
* portion of the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/">Pod</a> in Kubernetes. Environment variable references are expanded using the container's environment.</p>
|
|
2041
|
+
* <p>If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,
|
|
2042
|
+
* if the reference is to "<code>$(NAME1)</code>" and the <code>NAME1</code> environment variable doesn't exist, the
|
|
2043
|
+
* command string will remain "<code>$(NAME1)</code>." <code>$$</code> is replaced with <code>$</code>, and the
|
|
2044
|
+
* resulting string isn't expanded. For example, <code>$$(VAR_NAME)</code> is passed as <code>$(VAR_NAME)</code> whether
|
|
2045
|
+
* or not the <code>VAR_NAME</code> environment variable exists. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a> in the <i>Dockerfile
|
|
2046
|
+
* reference</i> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command
|
|
2047
|
+
* and arguments for a pod</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2048
|
+
*/
|
|
2049
|
+
args?: string[];
|
|
2050
|
+
/**
|
|
2051
|
+
* <p>The environment variables to pass to a container.</p>
|
|
2052
|
+
* <note>
|
|
2053
|
+
* <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
|
|
2054
|
+
* convention is reserved for variables that Batch sets.</p>
|
|
2055
|
+
* </note>
|
|
2056
|
+
*/
|
|
2057
|
+
env?: EksContainerEnvironmentVariable[];
|
|
2058
|
+
/**
|
|
2059
|
+
* <p>The type and amount of resources to assign to a container. The supported resources include <code>memory</code>,
|
|
2060
|
+
* <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods
|
|
2061
|
+
* and containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2062
|
+
*/
|
|
2063
|
+
resources?: EksContainerResourceRequirements;
|
|
2064
|
+
/**
|
|
2065
|
+
* <p>The volume mounts for the container. Batch supports <code>emptyDir</code>, <code>hostPath</code>, and
|
|
2066
|
+
* <code>secret</code> volume types. For more information about volumes and volume mounts in Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes
|
|
2067
|
+
* documentation</i>.</p>
|
|
2068
|
+
*/
|
|
2069
|
+
volumeMounts?: EksContainerVolumeMount[];
|
|
2070
|
+
/**
|
|
2071
|
+
* <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 security context for a
|
|
2072
|
+
* pod or container</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2073
|
+
*/
|
|
2074
|
+
securityContext?: EksContainerSecurityContext;
|
|
2075
|
+
}
|
|
2076
|
+
/**
|
|
2077
|
+
* <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. An <code>emptyDir</code> volume is first
|
|
2078
|
+
* created when a pod is assigned to a node. It exists as long as that pod is running on that node. The
|
|
2079
|
+
* <code>emptyDir</code> volume is initially empty. All containers in the pod can read and write the files in the
|
|
2080
|
+
* <code>emptyDir</code> volume. However, the <code>emptyDir</code> volume can be mounted at the same or different paths
|
|
2081
|
+
* in each container. When a pod is removed from a node for any reason, the data in the <code>emptyDir</code> is
|
|
2082
|
+
* deleted permanently. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#emptydir">emptyDir</a> in the <i>Kubernetes
|
|
2083
|
+
* documentation</i>.</p>
|
|
2084
|
+
*/
|
|
2085
|
+
export interface EksEmptyDir {
|
|
2086
|
+
/**
|
|
2087
|
+
* <p>The medium to store the volume. The default value is an empty string, which uses the storage of the node.</p>
|
|
2088
|
+
* <dl>
|
|
2089
|
+
* <dt>""</dt>
|
|
2090
|
+
* <dd>
|
|
2091
|
+
* <p>
|
|
2092
|
+
* <b>(Default)</b> Use the disk storage of the node.</p>
|
|
2093
|
+
* </dd>
|
|
2094
|
+
* <dt>"Memory"</dt>
|
|
2095
|
+
* <dd>
|
|
2096
|
+
* <p>Use the <code>tmpfs</code> volume that's backed by the RAM of the node. Contents of the volume are lost when
|
|
2097
|
+
* the node reboots, and any storage on the volume counts against the container's memory limit.</p>
|
|
2098
|
+
* </dd>
|
|
2099
|
+
* </dl>
|
|
2100
|
+
*/
|
|
2101
|
+
medium?: string;
|
|
2102
|
+
/**
|
|
2103
|
+
* <p>The maximum size of the volume. By default, there's no maximum size defined.</p>
|
|
2104
|
+
*/
|
|
2105
|
+
sizeLimit?: string;
|
|
2106
|
+
}
|
|
2107
|
+
/**
|
|
2108
|
+
* <p>Specifies the configuration of a Kubernetes <code>hostPath</code> volume. A <code>hostPath</code> volume mounts an
|
|
2109
|
+
* existing file or directory from the host node's filesystem into your pod. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#hostpath">hostPath</a> in the <i>Kubernetes
|
|
2110
|
+
* documentation</i>.</p>
|
|
2111
|
+
*/
|
|
2112
|
+
export interface EksHostPath {
|
|
2113
|
+
/**
|
|
2114
|
+
* <p>The path of the file or directory on the host to mount into containers on the pod.</p>
|
|
2115
|
+
*/
|
|
2116
|
+
path?: string;
|
|
2117
|
+
}
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#secret">secret</a> in the <i>Kubernetes
|
|
2120
|
+
* documentation</i>.</p>
|
|
2121
|
+
*/
|
|
2122
|
+
export interface EksSecret {
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names">DNS subdomain
|
|
2125
|
+
* names</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2126
|
+
*/
|
|
2127
|
+
secretName: string | undefined;
|
|
2128
|
+
/**
|
|
2129
|
+
* <p>Specifies whether the secret or the secret's keys must be defined.</p>
|
|
2130
|
+
*/
|
|
2131
|
+
optional?: boolean;
|
|
2132
|
+
}
|
|
2133
|
+
/**
|
|
2134
|
+
* <p>Specifies an Amazon EKS volume for a job definition.</p>
|
|
2135
|
+
*/
|
|
2136
|
+
export interface EksVolume {
|
|
2137
|
+
/**
|
|
2138
|
+
* <p>The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names">DNS subdomain
|
|
2139
|
+
* names</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2140
|
+
*/
|
|
2141
|
+
name: string | undefined;
|
|
2142
|
+
/**
|
|
2143
|
+
* <p>Specifies the configuration of a Kubernetes <code>hostPath</code> volume. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#hostpath">hostPath</a> in the <i>Kubernetes
|
|
2144
|
+
* documentation</i>.</p>
|
|
2145
|
+
*/
|
|
2146
|
+
hostPath?: EksHostPath;
|
|
2147
|
+
/**
|
|
2148
|
+
* <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#emptydir">emptyDir</a> in the <i>Kubernetes
|
|
2149
|
+
* documentation</i>.</p>
|
|
2150
|
+
*/
|
|
2151
|
+
emptyDir?: EksEmptyDir;
|
|
2152
|
+
/**
|
|
2153
|
+
* <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#secret">secret</a> in the <i>Kubernetes
|
|
2154
|
+
* documentation</i>.</p>
|
|
2155
|
+
*/
|
|
2156
|
+
secret?: EksSecret;
|
|
2157
|
+
}
|
|
2158
|
+
/**
|
|
2159
|
+
* <p>The properties for the pod.</p>
|
|
2160
|
+
*/
|
|
2161
|
+
export interface EksPodProperties {
|
|
2162
|
+
/**
|
|
2163
|
+
* <p>The name of the service account that's used to run the pod. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html">Kubernetes service accounts</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html">Configure a Kubernetes service account
|
|
2164
|
+
* to assume an IAM role</a> in the <i>Amazon EKS User Guide</i> and <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/">Configure service accounts
|
|
2165
|
+
* for pods</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2166
|
+
*/
|
|
2167
|
+
serviceAccountName?: string;
|
|
2168
|
+
/**
|
|
2169
|
+
* <p>Indicates if the pod uses the hosts' network IP address. The default value is <code>true</code>. Setting this
|
|
2170
|
+
* to <code>false</code> enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't
|
|
2171
|
+
* require the overhead of IP allocation for each pod for incoming connections. For more information, see <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces">Host namespaces</a> and
|
|
2172
|
+
* <a href="https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking">Pod networking</a> in the
|
|
2173
|
+
* <i>Kubernetes documentation</i>.</p>
|
|
2174
|
+
*/
|
|
2175
|
+
hostNetwork?: boolean;
|
|
2176
|
+
/**
|
|
2177
|
+
* <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the <code>hostNetwork</code>
|
|
2178
|
+
* parameter is not specified, the default is <code>ClusterFirstWithHostNet</code>. <code>ClusterFirst</code> indicates
|
|
2179
|
+
* that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver
|
|
2180
|
+
* inherited from the node. For more information, see <a href="https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy">Pod's DNS
|
|
2181
|
+
* policy</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2182
|
+
* <p>Valid values: <code>Default</code> | <code>ClusterFirst</code> | <code>ClusterFirstWithHostNet</code> |
|
|
2183
|
+
* <code>None</code>
|
|
2184
|
+
* </p>
|
|
2185
|
+
*/
|
|
2186
|
+
dnsPolicy?: string;
|
|
2187
|
+
/**
|
|
2188
|
+
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
2189
|
+
*/
|
|
2190
|
+
containers?: EksContainer[];
|
|
2191
|
+
/**
|
|
2192
|
+
* <p>Specifies the volumes for a job definition that uses Amazon EKS resources.</p>
|
|
2193
|
+
*/
|
|
2194
|
+
volumes?: EksVolume[];
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* <p>An object that contains the properties for the Kubernetes resources of a job.</p>
|
|
2198
|
+
*/
|
|
2199
|
+
export interface EksProperties {
|
|
2200
|
+
/**
|
|
2201
|
+
* <p>The properties for the Kubernetes pod resources of a job.</p>
|
|
2202
|
+
*/
|
|
2203
|
+
podProperties?: EksPodProperties;
|
|
2204
|
+
}
|
|
2205
|
+
/**
|
|
2206
|
+
* <p>An object that represents the properties of the node range for a multi-node parallel job.</p>
|
|
1785
2207
|
*/
|
|
1786
2208
|
export interface NodeRangeProperty {
|
|
1787
2209
|
/**
|
|
1788
2210
|
* <p>The range of nodes, using node index values. A range of <code>0:3</code> indicates nodes with index values of
|
|
1789
|
-
*
|
|
2211
|
+
* <code>0</code> through <code>3</code>. If the starting range value is omitted (<code>:n</code>), then <code>0</code>
|
|
1790
2212
|
* is used to start the range. If the ending range value is omitted (<code>n:</code>), then the highest possible node
|
|
1791
2213
|
* index is used to end the range. Your accumulative node ranges must account for all nodes (<code>0:n</code>). You can
|
|
1792
|
-
* nest node ranges
|
|
2214
|
+
* nest node ranges (for example, <code>0:10</code> and <code>4:5</code>). In this case, the <code>4:5</code> range
|
|
1793
2215
|
* properties override the <code>0:10</code> properties.</p>
|
|
1794
2216
|
*/
|
|
1795
2217
|
targetNodes: string | undefined;
|
|
@@ -1799,11 +2221,14 @@ export interface NodeRangeProperty {
|
|
|
1799
2221
|
container?: ContainerProperties;
|
|
1800
2222
|
}
|
|
1801
2223
|
/**
|
|
1802
|
-
* <p>An object
|
|
2224
|
+
* <p>An object that represents the node properties of a multi-node parallel job.</p>
|
|
2225
|
+
* <note>
|
|
2226
|
+
* <p>Node properties can't be specified for Amazon EKS based job definitions.</p>
|
|
2227
|
+
* </note>
|
|
1803
2228
|
*/
|
|
1804
2229
|
export interface NodeProperties {
|
|
1805
2230
|
/**
|
|
1806
|
-
* <p>The number of nodes associated with a multi-node parallel job.</p>
|
|
2231
|
+
* <p>The number of nodes that are associated with a multi-node parallel job.</p>
|
|
1807
2232
|
*/
|
|
1808
2233
|
numNodes: number | undefined;
|
|
1809
2234
|
/**
|
|
@@ -1812,7 +2237,7 @@ export interface NodeProperties {
|
|
|
1812
2237
|
*/
|
|
1813
2238
|
mainNode: number | undefined;
|
|
1814
2239
|
/**
|
|
1815
|
-
* <p>A list of node ranges and their properties associated with a multi-node parallel job.</p>
|
|
2240
|
+
* <p>A list of node ranges and their properties that are associated with a multi-node parallel job.</p>
|
|
1816
2241
|
*/
|
|
1817
2242
|
nodeRangeProperties: NodeRangeProperty[] | undefined;
|
|
1818
2243
|
}
|
|
@@ -1825,42 +2250,40 @@ export declare enum RetryAction {
|
|
|
1825
2250
|
RETRY = "RETRY"
|
|
1826
2251
|
}
|
|
1827
2252
|
/**
|
|
1828
|
-
* <p>Specifies
|
|
1829
|
-
* conditions are met
|
|
2253
|
+
* <p>Specifies an array of up to 5 conditions to be met, and an action to take (<code>RETRY</code> or
|
|
2254
|
+
* <code>EXIT</code>) if all conditions are met. If none of the <code>EvaluateOnExit</code> conditions in a
|
|
2255
|
+
* <code>RetryStrategy</code> match, then the job is retried.</p>
|
|
1830
2256
|
*/
|
|
1831
2257
|
export interface EvaluateOnExit {
|
|
1832
2258
|
/**
|
|
1833
|
-
* <p>Contains a glob pattern to match against the <code>StatusReason</code> returned for a job. The pattern can
|
|
1834
|
-
* to 512 characters
|
|
1835
|
-
* spaces or tabs).
|
|
1836
|
-
*
|
|
1837
|
-
* asterisk (*) so that only the start of the string needs to be an exact match.</p>
|
|
1838
|
-
* <p>The string can be between 1 and 512 characters in length.</p>
|
|
2259
|
+
* <p>Contains a glob pattern to match against the <code>StatusReason</code> returned for a job. The pattern can
|
|
2260
|
+
* contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including
|
|
2261
|
+
* spaces or tabs). It can optionally end with
|
|
2262
|
+
* an asterisk (*) so that only the start of the string needs to be an exact match.</p>
|
|
1839
2263
|
*/
|
|
1840
2264
|
onStatusReason?: string;
|
|
1841
2265
|
/**
|
|
1842
|
-
* <p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The pattern can
|
|
1843
|
-
* 512 characters
|
|
1844
|
-
*
|
|
2266
|
+
* <p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The pattern can contain up
|
|
2267
|
+
* to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and
|
|
2268
|
+
* tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact
|
|
1845
2269
|
* match.</p>
|
|
1846
|
-
* <p>The string can be between 1 and 512 characters in length.</p>
|
|
1847
2270
|
*/
|
|
1848
2271
|
onReason?: string;
|
|
1849
2272
|
/**
|
|
1850
2273
|
* <p>Contains a glob pattern to match against the decimal representation of the <code>ExitCode</code> returned for a
|
|
1851
|
-
* job. The pattern can be up to 512 characters
|
|
1852
|
-
*
|
|
1853
|
-
* <p>The string can
|
|
2274
|
+
* job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so
|
|
2275
|
+
* that only the start of the string needs to be an exact match.</p>
|
|
2276
|
+
* <p>The string can contain up to 512 characters.</p>
|
|
1854
2277
|
*/
|
|
1855
2278
|
onExitCode?: string;
|
|
1856
2279
|
/**
|
|
1857
2280
|
* <p>Specifies the action to take if all of the specified conditions (<code>onStatusReason</code>,
|
|
1858
|
-
*
|
|
2281
|
+
* <code>onReason</code>, and <code>onExitCode</code>) are met. The values aren't case sensitive.</p>
|
|
1859
2282
|
*/
|
|
1860
2283
|
action: RetryAction | string | undefined;
|
|
1861
2284
|
}
|
|
1862
2285
|
/**
|
|
1863
|
-
* <p>The retry strategy associated with a job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html">Automated job retries</a> in the <i>Batch User Guide</i>.</p>
|
|
2286
|
+
* <p>The retry strategy that's associated with a job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html">Automated job retries</a> in the <i>Batch User Guide</i>.</p>
|
|
1864
2287
|
*/
|
|
1865
2288
|
export interface RetryStrategy {
|
|
1866
2289
|
/**
|
|
@@ -1870,23 +2293,25 @@ export interface RetryStrategy {
|
|
|
1870
2293
|
*/
|
|
1871
2294
|
attempts?: number;
|
|
1872
2295
|
/**
|
|
1873
|
-
* <p>Array of up to 5 objects that specify conditions
|
|
1874
|
-
*
|
|
2296
|
+
* <p>Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is
|
|
2297
|
+
* specified, then the <code>attempts</code> parameter must also be specified. If none of the listed conditions match,
|
|
2298
|
+
* then the job is retried.</p>
|
|
1875
2299
|
*/
|
|
1876
2300
|
evaluateOnExit?: EvaluateOnExit[];
|
|
1877
2301
|
}
|
|
1878
2302
|
/**
|
|
1879
|
-
* <p>An object
|
|
2303
|
+
* <p>An object that represents a job timeout configuration.</p>
|
|
1880
2304
|
*/
|
|
1881
2305
|
export interface JobTimeout {
|
|
1882
2306
|
/**
|
|
1883
|
-
* <p>The time
|
|
1884
|
-
* Batch terminates your jobs if they
|
|
2307
|
+
* <p>The job timeout time (in seconds) that's measured from the job attempt's <code>startedAt</code> timestamp. After
|
|
2308
|
+
* this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60
|
|
2309
|
+
* seconds.</p>
|
|
1885
2310
|
*/
|
|
1886
2311
|
attemptDurationSeconds?: number;
|
|
1887
2312
|
}
|
|
1888
2313
|
/**
|
|
1889
|
-
* <p>An object
|
|
2314
|
+
* <p>An object that represents an Batch job definition.</p>
|
|
1890
2315
|
*/
|
|
1891
2316
|
export interface JobDefinition {
|
|
1892
2317
|
/**
|
|
@@ -1906,10 +2331,10 @@ export interface JobDefinition {
|
|
|
1906
2331
|
*/
|
|
1907
2332
|
status?: string;
|
|
1908
2333
|
/**
|
|
1909
|
-
* <p>The type of job definition
|
|
2334
|
+
* <p>The type of job definition. It's either <code>container</code> or <code>multinode</code>. If the job is run on
|
|
1910
2335
|
* Fargate resources, then <code>multinode</code> isn't supported. For more information about multi-node parallel
|
|
1911
2336
|
* jobs, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node parallel job
|
|
1912
|
-
*
|
|
2337
|
+
* definition</a> in the <i>Batch User Guide</i>.</p>
|
|
1913
2338
|
*/
|
|
1914
2339
|
type: string | undefined;
|
|
1915
2340
|
/**
|
|
@@ -1921,7 +2346,7 @@ export interface JobDefinition {
|
|
|
1921
2346
|
* <p>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are
|
|
1922
2347
|
* specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding
|
|
1923
2348
|
* parameter defaults from the job definition. For more information about specifying parameters, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html">Job definition parameters</a> in the
|
|
1924
|
-
*
|
|
2349
|
+
* <i>Batch User Guide</i>.</p>
|
|
1925
2350
|
*/
|
|
1926
2351
|
parameters?: Record<string, string>;
|
|
1927
2352
|
/**
|
|
@@ -1929,38 +2354,53 @@ export interface JobDefinition {
|
|
|
1929
2354
|
*/
|
|
1930
2355
|
retryStrategy?: RetryStrategy;
|
|
1931
2356
|
/**
|
|
1932
|
-
* <p>An object with various properties specific to
|
|
2357
|
+
* <p>An object with various properties specific to Amazon ECS based jobs. Valid values are
|
|
2358
|
+
* <code>containerProperties</code>, <code>eksProperties</code>, and <code>nodeProperties</code>. Only one can be
|
|
2359
|
+
* specified.</p>
|
|
1933
2360
|
*/
|
|
1934
2361
|
containerProperties?: ContainerProperties;
|
|
1935
2362
|
/**
|
|
1936
|
-
* <p>The timeout
|
|
1937
|
-
*
|
|
2363
|
+
* <p>The timeout time for jobs that are submitted with this job definition. After the amount of time you specify
|
|
2364
|
+
* passes, Batch terminates your jobs if they aren't finished.</p>
|
|
1938
2365
|
*/
|
|
1939
2366
|
timeout?: JobTimeout;
|
|
1940
2367
|
/**
|
|
1941
|
-
* <p>An object with various properties specific to multi-node parallel jobs
|
|
2368
|
+
* <p>An object with various properties that are specific to multi-node parallel jobs. Valid values are
|
|
2369
|
+
* <code>containerProperties</code>, <code>eksProperties</code>, and <code>nodeProperties</code>. Only one can be
|
|
2370
|
+
* specified.</p>
|
|
1942
2371
|
* <note>
|
|
1943
|
-
* <p>If the job runs on Fargate resources,
|
|
1944
|
-
*
|
|
2372
|
+
* <p>If the job runs on Fargate resources, don't specify <code>nodeProperties</code>. Use
|
|
2373
|
+
* <code>containerProperties</code> instead.</p>
|
|
1945
2374
|
* </note>
|
|
1946
2375
|
*/
|
|
1947
2376
|
nodeProperties?: NodeProperties;
|
|
1948
2377
|
/**
|
|
1949
|
-
* <p>The tags applied to the job definition.</p>
|
|
2378
|
+
* <p>The tags that are applied to the job definition.</p>
|
|
1950
2379
|
*/
|
|
1951
2380
|
tags?: Record<string, string>;
|
|
1952
2381
|
/**
|
|
1953
2382
|
* <p>Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no
|
|
1954
|
-
* value is specified, the tags aren't propagated. Tags can only be propagated to the tasks
|
|
1955
|
-
* tags with the same name, job tags are given priority over job definitions tags. If the total number of combined
|
|
1956
|
-
* from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
2383
|
+
* value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created.
|
|
2384
|
+
* For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined
|
|
2385
|
+
* tags from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
1957
2386
|
*/
|
|
1958
2387
|
propagateTags?: boolean;
|
|
1959
2388
|
/**
|
|
1960
2389
|
* <p>The platform capabilities required by the job definition. If no value is specified, it defaults to
|
|
1961
|
-
*
|
|
2390
|
+
* <code>EC2</code>. Jobs run on Fargate resources specify <code>FARGATE</code>.</p>
|
|
1962
2391
|
*/
|
|
1963
2392
|
platformCapabilities?: (PlatformCapability | string)[];
|
|
2393
|
+
/**
|
|
2394
|
+
* <p>An object with various properties that are specific to Amazon EKS based jobs. Valid values are
|
|
2395
|
+
* <code>containerProperties</code>, <code>eksProperties</code>, and <code>nodeProperties</code>. Only one can be
|
|
2396
|
+
* specified.</p>
|
|
2397
|
+
*/
|
|
2398
|
+
eksProperties?: EksProperties;
|
|
2399
|
+
/**
|
|
2400
|
+
* <p>The orchestration type of the compute environment. The valid values are <code>ECS</code> (default) or
|
|
2401
|
+
* <code>EKS</code>.</p>
|
|
2402
|
+
*/
|
|
2403
|
+
containerOrchestrationType?: OrchestrationType | string;
|
|
1964
2404
|
}
|
|
1965
2405
|
export interface DescribeJobDefinitionsResponse {
|
|
1966
2406
|
/**
|
|
@@ -1997,7 +2437,7 @@ export interface DescribeJobQueuesRequest {
|
|
|
1997
2437
|
* end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when
|
|
1998
2438
|
* there are no more results to return.</p>
|
|
1999
2439
|
* <note>
|
|
2000
|
-
* <p>
|
|
2440
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
2001
2441
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
2002
2442
|
* </note>
|
|
2003
2443
|
*/
|
|
@@ -2012,11 +2452,11 @@ export declare enum JQStatus {
|
|
|
2012
2452
|
VALID = "VALID"
|
|
2013
2453
|
}
|
|
2014
2454
|
/**
|
|
2015
|
-
* <p>An object
|
|
2455
|
+
* <p>An object that represents the details for an Batch job queue.</p>
|
|
2016
2456
|
*/
|
|
2017
2457
|
export interface JobQueueDetail {
|
|
2018
2458
|
/**
|
|
2019
|
-
* <p>The
|
|
2459
|
+
* <p>The job queue name.</p>
|
|
2020
2460
|
*/
|
|
2021
2461
|
jobQueueName: string | undefined;
|
|
2022
2462
|
/**
|
|
@@ -2024,17 +2464,17 @@ export interface JobQueueDetail {
|
|
|
2024
2464
|
*/
|
|
2025
2465
|
jobQueueArn: string | undefined;
|
|
2026
2466
|
/**
|
|
2027
|
-
* <p>Describes the ability of the queue to accept new jobs. If the job queue state is <code>ENABLED</code>, it
|
|
2028
|
-
*
|
|
2029
|
-
*
|
|
2467
|
+
* <p>Describes the ability of the queue to accept new jobs. If the job queue state is <code>ENABLED</code>, it can
|
|
2468
|
+
* accept jobs. If the job queue state is <code>DISABLED</code>, new jobs can't be added to the queue, but jobs already
|
|
2469
|
+
* in the queue can finish.</p>
|
|
2030
2470
|
*/
|
|
2031
2471
|
state: JQState | string | undefined;
|
|
2032
2472
|
/**
|
|
2033
2473
|
* <p>The Amazon Resource Name (ARN) of the scheduling policy. The format is
|
|
2034
|
-
*
|
|
2474
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
2035
2475
|
* </code>.
|
|
2036
2476
|
* For example,
|
|
2037
|
-
* <code>aws:aws:batch:us-west-2:
|
|
2477
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
2038
2478
|
*/
|
|
2039
2479
|
schedulingPolicyArn?: string;
|
|
2040
2480
|
/**
|
|
@@ -2042,15 +2482,15 @@ export interface JobQueueDetail {
|
|
|
2042
2482
|
*/
|
|
2043
2483
|
status?: JQStatus | string;
|
|
2044
2484
|
/**
|
|
2045
|
-
* <p>A short, human-readable string to provide additional details
|
|
2485
|
+
* <p>A short, human-readable string to provide additional details for the current status of the job queue.</p>
|
|
2046
2486
|
*/
|
|
2047
2487
|
statusReason?: string;
|
|
2048
2488
|
/**
|
|
2049
2489
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
|
|
2050
|
-
*
|
|
2051
|
-
* determined in descending order
|
|
2490
|
+
* <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is
|
|
2491
|
+
* determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling
|
|
2052
2492
|
* preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either
|
|
2053
|
-
* EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>)
|
|
2493
|
+
* EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). EC2 and
|
|
2054
2494
|
* Fargate compute environments can't be mixed.</p>
|
|
2055
2495
|
*/
|
|
2056
2496
|
priority: number | undefined;
|
|
@@ -2060,7 +2500,7 @@ export interface JobQueueDetail {
|
|
|
2060
2500
|
*/
|
|
2061
2501
|
computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined;
|
|
2062
2502
|
/**
|
|
2063
|
-
* <p>The tags applied to the job queue. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a> in
|
|
2503
|
+
* <p>The tags that are applied to the job queue. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a> in
|
|
2064
2504
|
* <i>Batch User Guide</i>.</p>
|
|
2065
2505
|
*/
|
|
2066
2506
|
tags?: Record<string, string>;
|
|
@@ -2087,7 +2527,7 @@ export interface DescribeJobsRequest {
|
|
|
2087
2527
|
jobs: string[] | undefined;
|
|
2088
2528
|
}
|
|
2089
2529
|
/**
|
|
2090
|
-
* <p>An object
|
|
2530
|
+
* <p>An object that represents the details of a container that's part of a job.</p>
|
|
2091
2531
|
*/
|
|
2092
2532
|
export interface ContainerDetail {
|
|
2093
2533
|
/**
|
|
@@ -2099,9 +2539,9 @@ export interface ContainerDetail {
|
|
|
2099
2539
|
* requirement for the job using <code>resourceRequirements</code>, but you can't specify the vCPU requirements in both
|
|
2100
2540
|
* the <code>vcpus</code> and <code>resourceRequirements</code> object. This parameter maps to <code>CpuShares</code> in
|
|
2101
2541
|
* 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 <code>--cpu-shares</code> option to
|
|
2102
|
-
*
|
|
2103
|
-
*
|
|
2104
|
-
*
|
|
2542
|
+
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify
|
|
2543
|
+
* at least one vCPU. This is required but can be specified in several places. It must be specified for each node at
|
|
2544
|
+
* least once.</p>
|
|
2105
2545
|
* <note>
|
|
2106
2546
|
* <p>This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate
|
|
2107
2547
|
* resources, you must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p>
|
|
@@ -2110,7 +2550,7 @@ export interface ContainerDetail {
|
|
|
2110
2550
|
vcpus?: number;
|
|
2111
2551
|
/**
|
|
2112
2552
|
* <p>For jobs running on EC2 resources that didn't specify memory requirements using
|
|
2113
|
-
*
|
|
2553
|
+
* <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other jobs, including all
|
|
2114
2554
|
* run on Fargate resources, see <code>resourceRequirements</code>.</p>
|
|
2115
2555
|
*/
|
|
2116
2556
|
memory?: number;
|
|
@@ -2119,23 +2559,25 @@ export interface ContainerDetail {
|
|
|
2119
2559
|
*/
|
|
2120
2560
|
command?: string[];
|
|
2121
2561
|
/**
|
|
2122
|
-
* <p>The Amazon Resource Name (ARN) associated with the job
|
|
2562
|
+
* <p>The Amazon Resource Name (ARN) that's associated with the job when run.</p>
|
|
2123
2563
|
*/
|
|
2124
2564
|
jobRoleArn?: string;
|
|
2125
2565
|
/**
|
|
2126
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2127
|
-
*
|
|
2566
|
+
* <p>The Amazon Resource Name (ARN) of the
|
|
2567
|
+
* execution
|
|
2568
|
+
* role that Batch can assume. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a> in the
|
|
2569
|
+
* <i>Batch User Guide</i>.</p>
|
|
2128
2570
|
*/
|
|
2129
2571
|
executionRoleArn?: string;
|
|
2130
2572
|
/**
|
|
2131
|
-
* <p>A list of volumes associated with the job.</p>
|
|
2573
|
+
* <p>A list of volumes that are associated with the job.</p>
|
|
2132
2574
|
*/
|
|
2133
2575
|
volumes?: Volume[];
|
|
2134
2576
|
/**
|
|
2135
2577
|
* <p>The environment variables to pass to a container.</p>
|
|
2136
2578
|
* <note>
|
|
2137
|
-
* <p>Environment variables
|
|
2138
|
-
* convention is reserved for variables that
|
|
2579
|
+
* <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
|
|
2580
|
+
* convention is reserved for variables that Batch sets.</p>
|
|
2139
2581
|
* </note>
|
|
2140
2582
|
*/
|
|
2141
2583
|
environment?: KeyValuePair[];
|
|
@@ -2161,10 +2603,10 @@ export interface ContainerDetail {
|
|
|
2161
2603
|
ulimits?: Ulimit[];
|
|
2162
2604
|
/**
|
|
2163
2605
|
* <p>When this parameter is true, the container is given elevated permissions on the host container instance (similar
|
|
2164
|
-
* to the <code>root</code> user). The default value is false
|
|
2606
|
+
* to the <code>root</code> user). The default value is <code>false</code>.</p>
|
|
2165
2607
|
* <note>
|
|
2166
2608
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or
|
|
2167
|
-
* specified as false
|
|
2609
|
+
* specified as <code>false</code>.</p>
|
|
2168
2610
|
* </note>
|
|
2169
2611
|
*/
|
|
2170
2612
|
privileged?: boolean;
|
|
@@ -2178,7 +2620,7 @@ export interface ContainerDetail {
|
|
|
2178
2620
|
*/
|
|
2179
2621
|
exitCode?: number;
|
|
2180
2622
|
/**
|
|
2181
|
-
* <p>A short (255 max characters) human-readable string to provide additional details
|
|
2623
|
+
* <p>A short (255 max characters) human-readable string to provide additional details for a running or stopped
|
|
2182
2624
|
* container.</p>
|
|
2183
2625
|
*/
|
|
2184
2626
|
reason?: string;
|
|
@@ -2192,9 +2634,9 @@ export interface ContainerDetail {
|
|
|
2192
2634
|
*/
|
|
2193
2635
|
taskArn?: string;
|
|
2194
2636
|
/**
|
|
2195
|
-
* <p>The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs is
|
|
2196
|
-
*
|
|
2197
|
-
*
|
|
2637
|
+
* <p>The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
|
|
2638
|
+
* <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the
|
|
2639
|
+
* <code>RUNNING</code> status.</p>
|
|
2198
2640
|
*/
|
|
2199
2641
|
logStreamName?: string;
|
|
2200
2642
|
/**
|
|
@@ -2205,12 +2647,12 @@ export interface ContainerDetail {
|
|
|
2205
2647
|
*/
|
|
2206
2648
|
instanceType?: string;
|
|
2207
2649
|
/**
|
|
2208
|
-
* <p>The network interfaces associated with the job.</p>
|
|
2650
|
+
* <p>The network interfaces that are associated with the job.</p>
|
|
2209
2651
|
*/
|
|
2210
2652
|
networkInterfaces?: NetworkInterface[];
|
|
2211
2653
|
/**
|
|
2212
2654
|
* <p>The type and amount of resources to assign to a container. The supported resources include <code>GPU</code>,
|
|
2213
|
-
*
|
|
2655
|
+
* <code>MEMORY</code>, and <code>VCPU</code>.</p>
|
|
2214
2656
|
*/
|
|
2215
2657
|
resourceRequirements?: ResourceRequirement[];
|
|
2216
2658
|
/**
|
|
@@ -2232,20 +2674,20 @@ export interface ContainerDetail {
|
|
|
2232
2674
|
* container agent.</p>
|
|
2233
2675
|
* </note>
|
|
2234
2676
|
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your
|
|
2235
|
-
* container instance. To check the Docker Remote API version on your container instance, log
|
|
2677
|
+
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
2236
2678
|
* container instance and run the following command: <code>sudo docker version | grep "Server API version"</code>
|
|
2237
2679
|
* </p>
|
|
2238
2680
|
* <note>
|
|
2239
2681
|
* <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that
|
|
2240
2682
|
* instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that
|
|
2241
2683
|
* instance can use these log configuration options. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS container agent configuration</a> in the
|
|
2242
|
-
*
|
|
2684
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2243
2685
|
* </note>
|
|
2244
2686
|
*/
|
|
2245
2687
|
logConfiguration?: LogConfiguration;
|
|
2246
2688
|
/**
|
|
2247
2689
|
* <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
|
|
2248
|
-
*
|
|
2690
|
+
* <i>Batch User Guide</i>.</p>
|
|
2249
2691
|
*/
|
|
2250
2692
|
secrets?: Secret[];
|
|
2251
2693
|
/**
|
|
@@ -2260,11 +2702,11 @@ export interface ContainerDetail {
|
|
|
2260
2702
|
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
2261
2703
|
}
|
|
2262
2704
|
/**
|
|
2263
|
-
* <p>An object
|
|
2705
|
+
* <p>An object that represents an Batch job dependency.</p>
|
|
2264
2706
|
*/
|
|
2265
2707
|
export interface JobDependency {
|
|
2266
2708
|
/**
|
|
2267
|
-
* <p>The job ID of the Batch job associated with this dependency.</p>
|
|
2709
|
+
* <p>The job ID of the Batch job that's associated with this dependency.</p>
|
|
2268
2710
|
*/
|
|
2269
2711
|
jobId?: string;
|
|
2270
2712
|
/**
|
|
@@ -2273,11 +2715,186 @@ export interface JobDependency {
|
|
|
2273
2715
|
type?: ArrayJobDependency | string;
|
|
2274
2716
|
}
|
|
2275
2717
|
/**
|
|
2276
|
-
* <p>An object
|
|
2718
|
+
* <p>An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.</p>
|
|
2719
|
+
*/
|
|
2720
|
+
export interface EksAttemptContainerDetail {
|
|
2721
|
+
/**
|
|
2722
|
+
* <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
|
|
2723
|
+
*/
|
|
2724
|
+
exitCode?: number;
|
|
2725
|
+
/**
|
|
2726
|
+
* <p>A short (255 max characters) human-readable string to provide additional details for a running or stopped
|
|
2727
|
+
* container.</p>
|
|
2728
|
+
*/
|
|
2729
|
+
reason?: string;
|
|
2730
|
+
}
|
|
2731
|
+
/**
|
|
2732
|
+
* <p>An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.</p>
|
|
2733
|
+
*/
|
|
2734
|
+
export interface EksAttemptDetail {
|
|
2735
|
+
/**
|
|
2736
|
+
* <p>The details for the final status of the containers for this job attempt.</p>
|
|
2737
|
+
*/
|
|
2738
|
+
containers?: EksAttemptContainerDetail[];
|
|
2739
|
+
/**
|
|
2740
|
+
* <p>The name of the pod for this job attempt.</p>
|
|
2741
|
+
*/
|
|
2742
|
+
podName?: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* <p>The name of the node for this job attempt.</p>
|
|
2745
|
+
*/
|
|
2746
|
+
nodeName?: string;
|
|
2747
|
+
/**
|
|
2748
|
+
* <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the
|
|
2749
|
+
* <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
|
|
2750
|
+
*/
|
|
2751
|
+
startedAt?: number;
|
|
2752
|
+
/**
|
|
2753
|
+
* <p>The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt
|
|
2754
|
+
* transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or
|
|
2755
|
+
* <code>FAILED</code>.</p>
|
|
2756
|
+
*/
|
|
2757
|
+
stoppedAt?: number;
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>A short, human-readable string to provide additional details for the current status of the job attempt.</p>
|
|
2760
|
+
*/
|
|
2761
|
+
statusReason?: string;
|
|
2762
|
+
}
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>The details for container properties that are returned by <code>DescribeJobs</code> for jobs that use
|
|
2765
|
+
* Amazon EKS.</p>
|
|
2766
|
+
*/
|
|
2767
|
+
export interface EksContainerDetail {
|
|
2768
|
+
/**
|
|
2769
|
+
* <p>The name of the container. If the name isn't specified, the default name "<code>Default</code>" is used. Each
|
|
2770
|
+
* container in a pod must have a unique name.</p>
|
|
2771
|
+
*/
|
|
2772
|
+
name?: string;
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>The Docker image used to start the container.</p>
|
|
2775
|
+
*/
|
|
2776
|
+
image?: string;
|
|
2777
|
+
/**
|
|
2778
|
+
* <p>The image pull policy for the container. Supported values are <code>Always</code>, <code>IfNotPresent</code>,
|
|
2779
|
+
* and <code>Never</code>. This parameter defaults to <code>Always</code> if the <code>:latest</code> tag is specified,
|
|
2780
|
+
* <code>IfNotPresent</code> otherwise. For more information, see <a href="https://kubernetes.io/docs/concepts/containers/images/#updating-images">Updating images</a> in the
|
|
2781
|
+
* <i>Kubernetes documentation</i>.</p>
|
|
2782
|
+
*/
|
|
2783
|
+
imagePullPolicy?: string;
|
|
2784
|
+
/**
|
|
2785
|
+
* <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
|
|
2786
|
+
* the <i>Kubernetes documentation</i>.</p>
|
|
2787
|
+
*/
|
|
2788
|
+
command?: string[];
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of the container image is
|
|
2791
|
+
* 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>
|
|
2792
|
+
* portion of the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/">Pod</a> in Kubernetes. Environment variable references are expanded using the container's environment.</p>
|
|
2793
|
+
* <p>If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,
|
|
2794
|
+
* if the reference is to "<code>$(NAME1)</code>" and the <code>NAME1</code> environment variable doesn't exist, the
|
|
2795
|
+
* command string will remain "<code>$(NAME1)</code>". <code>$$</code> is replaced with <code>$</code> and the resulting
|
|
2796
|
+
* string isn't expanded. For example, <code>$$(VAR_NAME)</code> is passed as <code>$(VAR_NAME)</code> whether or not
|
|
2797
|
+
* the <code>VAR_NAME</code> environment variable exists. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a> in the <i>Dockerfile
|
|
2798
|
+
* reference</i> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command
|
|
2799
|
+
* and arguments for a pod</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2800
|
+
*/
|
|
2801
|
+
args?: string[];
|
|
2802
|
+
/**
|
|
2803
|
+
* <p>The environment variables to pass to a container.</p>
|
|
2804
|
+
* <note>
|
|
2805
|
+
* <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
|
|
2806
|
+
* convention is reserved for variables that Batch sets.</p>
|
|
2807
|
+
* </note>
|
|
2808
|
+
*/
|
|
2809
|
+
env?: EksContainerEnvironmentVariable[];
|
|
2810
|
+
/**
|
|
2811
|
+
* <p>The type and amount of resources to assign to a container. The supported resources include <code>memory</code>,
|
|
2812
|
+
* <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods
|
|
2813
|
+
* and containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2814
|
+
*/
|
|
2815
|
+
resources?: EksContainerResourceRequirements;
|
|
2816
|
+
/**
|
|
2817
|
+
* <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
|
|
2818
|
+
*/
|
|
2819
|
+
exitCode?: number;
|
|
2820
|
+
/**
|
|
2821
|
+
* <p>A short human-readable string to provide additional details for a running or stopped container. It can be up to
|
|
2822
|
+
* 255 characters long.</p>
|
|
2823
|
+
*/
|
|
2824
|
+
reason?: string;
|
|
2825
|
+
/**
|
|
2826
|
+
* <p>The volume mounts for the container. Batch supports <code>emptyDir</code>, <code>hostPath</code>, and
|
|
2827
|
+
* <code>secret</code> volume types. For more information about volumes and volume mounts in Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes
|
|
2828
|
+
* documentation</i>.</p>
|
|
2829
|
+
*/
|
|
2830
|
+
volumeMounts?: EksContainerVolumeMount[];
|
|
2831
|
+
/**
|
|
2832
|
+
* <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 security context for a
|
|
2833
|
+
* pod or container</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2834
|
+
*/
|
|
2835
|
+
securityContext?: EksContainerSecurityContext;
|
|
2836
|
+
}
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>The details for the pod.</p>
|
|
2839
|
+
*/
|
|
2840
|
+
export interface EksPodPropertiesDetail {
|
|
2841
|
+
/**
|
|
2842
|
+
* <p>The name of the service account that's used to run the pod. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html">Kubernetes service accounts</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html">Configure a Kubernetes service account
|
|
2843
|
+
* to assume an IAM role</a> in the <i>Amazon EKS User Guide</i> and <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/">Configure service accounts
|
|
2844
|
+
* for pods</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2845
|
+
*/
|
|
2846
|
+
serviceAccountName?: string;
|
|
2847
|
+
/**
|
|
2848
|
+
* <p>Indicates if the pod uses the hosts' network IP address. The default value is <code>true</code>. Setting this
|
|
2849
|
+
* to <code>false</code> enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't
|
|
2850
|
+
* require the overhead of IP allocation for each pod for incoming connections. For more information, see <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces">Host namespaces</a> and
|
|
2851
|
+
* <a href="https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking">Pod networking</a> in the
|
|
2852
|
+
* <i>Kubernetes documentation</i>.</p>
|
|
2853
|
+
*/
|
|
2854
|
+
hostNetwork?: boolean;
|
|
2855
|
+
/**
|
|
2856
|
+
* <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the <code>hostNetwork</code>
|
|
2857
|
+
* parameter is not specified, the default is <code>ClusterFirstWithHostNet</code>. <code>ClusterFirst</code> indicates
|
|
2858
|
+
* that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver
|
|
2859
|
+
* inherited from the node. For more information, see <a href="https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy">Pod's DNS
|
|
2860
|
+
* policy</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2861
|
+
* <p>Valid values: <code>Default</code> | <code>ClusterFirst</code> | <code>ClusterFirstWithHostNet</code> |
|
|
2862
|
+
* <code>None</code>
|
|
2863
|
+
* </p>
|
|
2864
|
+
*/
|
|
2865
|
+
dnsPolicy?: string;
|
|
2866
|
+
/**
|
|
2867
|
+
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
2868
|
+
*/
|
|
2869
|
+
containers?: EksContainerDetail[];
|
|
2870
|
+
/**
|
|
2871
|
+
* <p>Specifies the volumes for a job definition using Amazon EKS resources.</p>
|
|
2872
|
+
*/
|
|
2873
|
+
volumes?: EksVolume[];
|
|
2874
|
+
/**
|
|
2875
|
+
* <p>The name of the pod for this job.</p>
|
|
2876
|
+
*/
|
|
2877
|
+
podName?: string;
|
|
2878
|
+
/**
|
|
2879
|
+
* <p>The name of the node for this job.</p>
|
|
2880
|
+
*/
|
|
2881
|
+
nodeName?: string;
|
|
2882
|
+
}
|
|
2883
|
+
/**
|
|
2884
|
+
* <p>An object that contains the details for the Kubernetes resources of a job.</p>
|
|
2885
|
+
*/
|
|
2886
|
+
export interface EksPropertiesDetail {
|
|
2887
|
+
/**
|
|
2888
|
+
* <p>The properties for the Kubernetes pod resources of a job.</p>
|
|
2889
|
+
*/
|
|
2890
|
+
podProperties?: EksPodPropertiesDetail;
|
|
2891
|
+
}
|
|
2892
|
+
/**
|
|
2893
|
+
* <p>An object that represents the details of a multi-node parallel job node.</p>
|
|
2277
2894
|
*/
|
|
2278
2895
|
export interface NodeDetails {
|
|
2279
2896
|
/**
|
|
2280
|
-
* <p>The node index for the node. Node index numbering
|
|
2897
|
+
* <p>The node index for the node. Node index numbering starts at zero. This index is also available on the node with
|
|
2281
2898
|
* the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
|
|
2282
2899
|
*/
|
|
2283
2900
|
nodeIndex?: number;
|
|
@@ -2296,7 +2913,7 @@ export declare enum JobStatus {
|
|
|
2296
2913
|
SUCCEEDED = "SUCCEEDED"
|
|
2297
2914
|
}
|
|
2298
2915
|
/**
|
|
2299
|
-
* <p>An object
|
|
2916
|
+
* <p>An object that represents an Batch job.</p>
|
|
2300
2917
|
*/
|
|
2301
2918
|
export interface JobDetail {
|
|
2302
2919
|
/**
|
|
@@ -2304,11 +2921,11 @@ export interface JobDetail {
|
|
|
2304
2921
|
*/
|
|
2305
2922
|
jobArn?: string;
|
|
2306
2923
|
/**
|
|
2307
|
-
* <p>The name
|
|
2924
|
+
* <p>The job name.</p>
|
|
2308
2925
|
*/
|
|
2309
2926
|
jobName: string | undefined;
|
|
2310
2927
|
/**
|
|
2311
|
-
* <p>The ID
|
|
2928
|
+
* <p>The job ID.</p>
|
|
2312
2929
|
*/
|
|
2313
2930
|
jobId: string | undefined;
|
|
2314
2931
|
/**
|
|
@@ -2333,18 +2950,17 @@ export interface JobDetail {
|
|
|
2333
2950
|
*/
|
|
2334
2951
|
schedulingPriority?: number;
|
|
2335
2952
|
/**
|
|
2336
|
-
* <p>A list of job attempts associated with this job.</p>
|
|
2953
|
+
* <p>A list of job attempts that are associated with this job.</p>
|
|
2337
2954
|
*/
|
|
2338
2955
|
attempts?: AttemptDetail[];
|
|
2339
2956
|
/**
|
|
2340
|
-
* <p>A short, human-readable string to provide
|
|
2957
|
+
* <p>A short, human-readable string to provide more details for the current status of the job.</p>
|
|
2341
2958
|
*/
|
|
2342
2959
|
statusReason?: string;
|
|
2343
2960
|
/**
|
|
2344
2961
|
* <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,
|
|
2345
|
-
* this is when the job entered the <code>SUBMITTED</code> state
|
|
2346
|
-
*
|
|
2347
|
-
* state.</p>
|
|
2962
|
+
* this is when the job entered the <code>SUBMITTED</code> state. This is specifically at the time <a>SubmitJob</a> was called. For array child jobs, this is when the child job was spawned by its parent and
|
|
2963
|
+
* entered the <code>PENDING</code> state.</p>
|
|
2348
2964
|
*/
|
|
2349
2965
|
createdAt?: number;
|
|
2350
2966
|
/**
|
|
@@ -2352,14 +2968,15 @@ export interface JobDetail {
|
|
|
2352
2968
|
*/
|
|
2353
2969
|
retryStrategy?: RetryStrategy;
|
|
2354
2970
|
/**
|
|
2355
|
-
* <p>The Unix timestamp (in milliseconds) for when the job was started
|
|
2356
|
-
*
|
|
2357
|
-
* array jobs or multi-node parallel jobs.</p>
|
|
2971
|
+
* <p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
|
|
2972
|
+
* transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state. This parameter isn't provided
|
|
2973
|
+
* for child jobs of array jobs or multi-node parallel jobs.</p>
|
|
2358
2974
|
*/
|
|
2359
2975
|
startedAt: number | undefined;
|
|
2360
2976
|
/**
|
|
2361
|
-
* <p>The Unix timestamp (in milliseconds) for when the job was stopped
|
|
2362
|
-
*
|
|
2977
|
+
* <p>The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
|
|
2978
|
+
* transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or
|
|
2979
|
+
* <code>FAILED</code>.</p>
|
|
2363
2980
|
*/
|
|
2364
2981
|
stoppedAt?: number;
|
|
2365
2982
|
/**
|
|
@@ -2367,31 +2984,31 @@ export interface JobDetail {
|
|
|
2367
2984
|
*/
|
|
2368
2985
|
dependsOn?: JobDependency[];
|
|
2369
2986
|
/**
|
|
2370
|
-
* <p>The Amazon Resource Name (ARN) of the job definition that
|
|
2987
|
+
* <p>The Amazon Resource Name (ARN) of the job definition that this job uses.</p>
|
|
2371
2988
|
*/
|
|
2372
2989
|
jobDefinition: string | undefined;
|
|
2373
2990
|
/**
|
|
2374
|
-
* <p>Additional parameters passed to the job that replace parameter substitution placeholders or override
|
|
2375
|
-
* corresponding parameter defaults from the job definition.</p>
|
|
2991
|
+
* <p>Additional parameters that are passed to the job that replace parameter substitution placeholders or override
|
|
2992
|
+
* any corresponding parameter defaults from the job definition.</p>
|
|
2376
2993
|
*/
|
|
2377
2994
|
parameters?: Record<string, string>;
|
|
2378
2995
|
/**
|
|
2379
|
-
* <p>An object
|
|
2996
|
+
* <p>An object that represents the details for the container that's associated with the job.</p>
|
|
2380
2997
|
*/
|
|
2381
2998
|
container?: ContainerDetail;
|
|
2382
2999
|
/**
|
|
2383
|
-
* <p>An object
|
|
3000
|
+
* <p>An object that represents the details of a node that's associated with a multi-node parallel job.</p>
|
|
2384
3001
|
*/
|
|
2385
3002
|
nodeDetails?: NodeDetails;
|
|
2386
3003
|
/**
|
|
2387
|
-
* <p>An object
|
|
3004
|
+
* <p>An object that represents the node properties of a multi-node parallel job.</p>
|
|
2388
3005
|
* <note>
|
|
2389
3006
|
* <p>This isn't applicable to jobs that are running on Fargate resources.</p>
|
|
2390
3007
|
* </note>
|
|
2391
3008
|
*/
|
|
2392
3009
|
nodeProperties?: NodeProperties;
|
|
2393
3010
|
/**
|
|
2394
|
-
* <p>The array properties of the job, if it
|
|
3011
|
+
* <p>The array properties of the job, if it's an array job.</p>
|
|
2395
3012
|
*/
|
|
2396
3013
|
arrayProperties?: ArrayPropertiesDetail;
|
|
2397
3014
|
/**
|
|
@@ -2399,21 +3016,30 @@ export interface JobDetail {
|
|
|
2399
3016
|
*/
|
|
2400
3017
|
timeout?: JobTimeout;
|
|
2401
3018
|
/**
|
|
2402
|
-
* <p>The tags applied to the job.</p>
|
|
3019
|
+
* <p>The tags that are applied to the job.</p>
|
|
2403
3020
|
*/
|
|
2404
3021
|
tags?: Record<string, string>;
|
|
2405
3022
|
/**
|
|
2406
3023
|
* <p>Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no
|
|
2407
|
-
* value is specified, the tags aren't propagated. Tags can only be propagated to the tasks
|
|
2408
|
-
* tags with the same name, job tags are given priority over job definitions tags. If the total number of combined
|
|
2409
|
-
* from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
3024
|
+
* value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created.
|
|
3025
|
+
* For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined
|
|
3026
|
+
* tags from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
2410
3027
|
*/
|
|
2411
3028
|
propagateTags?: boolean;
|
|
2412
3029
|
/**
|
|
2413
3030
|
* <p>The platform capabilities required by the job definition. If no value is specified, it defaults to
|
|
2414
|
-
*
|
|
3031
|
+
* <code>EC2</code>. Jobs run on Fargate resources specify <code>FARGATE</code>.</p>
|
|
2415
3032
|
*/
|
|
2416
3033
|
platformCapabilities?: (PlatformCapability | string)[];
|
|
3034
|
+
/**
|
|
3035
|
+
* <p>An object with various properties that are specific to Amazon EKS based jobs. Only one of <code>container</code>,
|
|
3036
|
+
* <code>eksProperties</code>, or <code>nodeDetails</code> is specified.</p>
|
|
3037
|
+
*/
|
|
3038
|
+
eksProperties?: EksPropertiesDetail;
|
|
3039
|
+
/**
|
|
3040
|
+
* <p>A list of job attempts that are associated with this job.</p>
|
|
3041
|
+
*/
|
|
3042
|
+
eksAttempts?: EksAttemptDetail[];
|
|
2417
3043
|
}
|
|
2418
3044
|
export interface DescribeJobsResponse {
|
|
2419
3045
|
/**
|
|
@@ -2440,7 +3066,7 @@ export interface SchedulingPolicyDetail {
|
|
|
2440
3066
|
name: string | undefined;
|
|
2441
3067
|
/**
|
|
2442
3068
|
* <p>The Amazon Resource Name (ARN) of the scheduling policy. An example is
|
|
2443
|
-
*
|
|
3069
|
+
* <code>arn:<i>aws</i>:batch:<i>us-east-1</i>:<i>123456789012</i>:scheduling-policy/<i>HighPriority</i>
|
|
2444
3070
|
* </code>.</p>
|
|
2445
3071
|
*/
|
|
2446
3072
|
arn: string | undefined;
|
|
@@ -2451,7 +3077,7 @@ export interface SchedulingPolicyDetail {
|
|
|
2451
3077
|
/**
|
|
2452
3078
|
* <p>The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of
|
|
2453
3079
|
* 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 <i>Amazon Web Services General
|
|
2454
|
-
*
|
|
3080
|
+
* Reference</i>.</p>
|
|
2455
3081
|
*/
|
|
2456
3082
|
tags?: Record<string, string>;
|
|
2457
3083
|
}
|
|
@@ -2514,7 +3140,7 @@ export interface ListJobsRequest {
|
|
|
2514
3140
|
* end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when
|
|
2515
3141
|
* there are no more results to return.</p>
|
|
2516
3142
|
* <note>
|
|
2517
|
-
* <p>
|
|
3143
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
2518
3144
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
2519
3145
|
* </note>
|
|
2520
3146
|
*/
|
|
@@ -2527,23 +3153,23 @@ export interface ListJobsRequest {
|
|
|
2527
3153
|
* <dt>JOB_NAME</dt>
|
|
2528
3154
|
* <dd>
|
|
2529
3155
|
* <p>The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*),
|
|
2530
|
-
* the filter
|
|
2531
|
-
*
|
|
2532
|
-
*
|
|
2533
|
-
*
|
|
3156
|
+
* the filter matches any job name that begins with the string before the '*'. This corresponds to the
|
|
3157
|
+
* <code>jobName</code> value. For example, <code>test1</code> matches both <code>Test1</code> and
|
|
3158
|
+
* <code>test1</code>, and <code>test1*</code> matches both <code>test1</code> and <code>Test10</code>. When the
|
|
3159
|
+
* <code>JOB_NAME</code> filter is used, the results are grouped by the job name and version.</p>
|
|
2534
3160
|
* </dd>
|
|
2535
3161
|
* <dt>JOB_DEFINITION</dt>
|
|
2536
3162
|
* <dd>
|
|
2537
3163
|
* <p>The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the
|
|
2538
|
-
*
|
|
2539
|
-
*
|
|
2540
|
-
*
|
|
2541
|
-
*
|
|
2542
|
-
*
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2545
|
-
* results include jobs that used the specified revision of the job definition. Asterisk (*)
|
|
2546
|
-
*
|
|
3164
|
+
* <code>jobDefinition</code> value. The value is case sensitive. When the value for the filter is the job definition
|
|
3165
|
+
* name, the results include all the jobs that used any revision of that job definition name. If the value ends with
|
|
3166
|
+
* an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For
|
|
3167
|
+
* example, <code>jd1</code> matches only <code>jd1</code>, and <code>jd1*</code> matches both <code>jd1</code> and
|
|
3168
|
+
* <code>jd1A</code>. The version of the job definition that's used doesn't affect the sort order. When the
|
|
3169
|
+
* <code>JOB_DEFINITION</code> filter is used and the ARN is used (which is in the form
|
|
3170
|
+
* <code>arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code>), the
|
|
3171
|
+
* results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the
|
|
3172
|
+
* ARN is used.</p>
|
|
2547
3173
|
* </dd>
|
|
2548
3174
|
* <dt>BEFORE_CREATED_AT</dt>
|
|
2549
3175
|
* <dd>
|
|
@@ -2562,7 +3188,7 @@ export interface ListJobsRequest {
|
|
|
2562
3188
|
filters?: KeyValuesPair[];
|
|
2563
3189
|
}
|
|
2564
3190
|
/**
|
|
2565
|
-
* <p>An object
|
|
3191
|
+
* <p>An object that represents summary details of a container within a job.</p>
|
|
2566
3192
|
*/
|
|
2567
3193
|
export interface ContainerSummary {
|
|
2568
3194
|
/**
|
|
@@ -2570,13 +3196,13 @@ export interface ContainerSummary {
|
|
|
2570
3196
|
*/
|
|
2571
3197
|
exitCode?: number;
|
|
2572
3198
|
/**
|
|
2573
|
-
* <p>A short (255 max characters) human-readable string to provide additional details
|
|
3199
|
+
* <p>A short (255 max characters) human-readable string to provide additional details for a running or stopped
|
|
2574
3200
|
* container.</p>
|
|
2575
3201
|
*/
|
|
2576
3202
|
reason?: string;
|
|
2577
3203
|
}
|
|
2578
3204
|
/**
|
|
2579
|
-
* <p>An object
|
|
3205
|
+
* <p>An object that represents the properties of a node that's associated with a multi-node parallel job.</p>
|
|
2580
3206
|
*/
|
|
2581
3207
|
export interface NodePropertiesSummary {
|
|
2582
3208
|
/**
|
|
@@ -2584,7 +3210,7 @@ export interface NodePropertiesSummary {
|
|
|
2584
3210
|
*/
|
|
2585
3211
|
isMainNode?: boolean;
|
|
2586
3212
|
/**
|
|
2587
|
-
* <p>The number of nodes associated with a multi-node parallel job.</p>
|
|
3213
|
+
* <p>The number of nodes that are associated with a multi-node parallel job.</p>
|
|
2588
3214
|
*/
|
|
2589
3215
|
numNodes?: number;
|
|
2590
3216
|
/**
|
|
@@ -2594,7 +3220,7 @@ export interface NodePropertiesSummary {
|
|
|
2594
3220
|
nodeIndex?: number;
|
|
2595
3221
|
}
|
|
2596
3222
|
/**
|
|
2597
|
-
* <p>An object
|
|
3223
|
+
* <p>An object that represents summary details of a job.</p>
|
|
2598
3224
|
*/
|
|
2599
3225
|
export interface JobSummary {
|
|
2600
3226
|
/**
|
|
@@ -2602,11 +3228,11 @@ export interface JobSummary {
|
|
|
2602
3228
|
*/
|
|
2603
3229
|
jobArn?: string;
|
|
2604
3230
|
/**
|
|
2605
|
-
* <p>The ID
|
|
3231
|
+
* <p>The job ID.</p>
|
|
2606
3232
|
*/
|
|
2607
3233
|
jobId: string | undefined;
|
|
2608
3234
|
/**
|
|
2609
|
-
* <p>The name
|
|
3235
|
+
* <p>The job name.</p>
|
|
2610
3236
|
*/
|
|
2611
3237
|
jobName: string | undefined;
|
|
2612
3238
|
/**
|
|
@@ -2621,25 +3247,25 @@ export interface JobSummary {
|
|
|
2621
3247
|
*/
|
|
2622
3248
|
status?: JobStatus | string;
|
|
2623
3249
|
/**
|
|
2624
|
-
* <p>A short, human-readable string to provide
|
|
3250
|
+
* <p>A short, human-readable string to provide more details for the current status of the job.</p>
|
|
2625
3251
|
*/
|
|
2626
3252
|
statusReason?: string;
|
|
2627
3253
|
/**
|
|
2628
|
-
* <p>The Unix timestamp for when the job was started
|
|
2629
|
-
* to the <code>RUNNING</code> state
|
|
3254
|
+
* <p>The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
|
|
3255
|
+
* <code>STARTING</code> state to the <code>RUNNING</code> state.</p>
|
|
2630
3256
|
*/
|
|
2631
3257
|
startedAt?: number;
|
|
2632
3258
|
/**
|
|
2633
|
-
* <p>The Unix timestamp for when the job was stopped
|
|
2634
|
-
* to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code
|
|
3259
|
+
* <p>The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the
|
|
3260
|
+
* <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
|
|
2635
3261
|
*/
|
|
2636
3262
|
stoppedAt?: number;
|
|
2637
3263
|
/**
|
|
2638
|
-
* <p>An object
|
|
3264
|
+
* <p>An object that represents the details of the container that's associated with the job.</p>
|
|
2639
3265
|
*/
|
|
2640
3266
|
container?: ContainerSummary;
|
|
2641
3267
|
/**
|
|
2642
|
-
* <p>The array properties of the job, if it
|
|
3268
|
+
* <p>The array properties of the job, if it's an array job.</p>
|
|
2643
3269
|
*/
|
|
2644
3270
|
arrayProperties?: ArrayPropertiesSummary;
|
|
2645
3271
|
/**
|
|
@@ -2681,13 +3307,13 @@ export interface ListSchedulingPoliciesRequest {
|
|
|
2681
3307
|
*/
|
|
2682
3308
|
maxResults?: number;
|
|
2683
3309
|
/**
|
|
2684
|
-
* <p>The <code>nextToken</code> value that's returned from a previous paginated
|
|
2685
|
-
*
|
|
2686
|
-
*
|
|
2687
|
-
*
|
|
2688
|
-
*
|
|
3310
|
+
* <p>The <code>nextToken</code> value that's returned from a previous paginated
|
|
3311
|
+
* <code>ListSchedulingPolicies</code> request where <code>maxResults</code> was used and the
|
|
3312
|
+
* results exceeded the value of that parameter. Pagination continues from the end of the
|
|
3313
|
+
* previous results that returned the <code>nextToken</code> value. This value is
|
|
3314
|
+
* <code>null</code> when there are no more results to return.</p>
|
|
2689
3315
|
* <note>
|
|
2690
|
-
* <p>
|
|
3316
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
2691
3317
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
2692
3318
|
* </note>
|
|
2693
3319
|
*/
|
|
@@ -2695,7 +3321,7 @@ export interface ListSchedulingPoliciesRequest {
|
|
|
2695
3321
|
}
|
|
2696
3322
|
/**
|
|
2697
3323
|
* <p>An object that contains the details of a scheduling policy that's returned in a
|
|
2698
|
-
*
|
|
3324
|
+
* <code>ListSchedulingPolicy</code> action.</p>
|
|
2699
3325
|
*/
|
|
2700
3326
|
export interface SchedulingPolicyListingDetail {
|
|
2701
3327
|
/**
|
|
@@ -2721,7 +3347,7 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
2721
3347
|
export interface ListTagsForResourceRequest {
|
|
2722
3348
|
/**
|
|
2723
3349
|
* <p>The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
|
|
2724
|
-
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs
|
|
3350
|
+
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
|
|
2725
3351
|
*/
|
|
2726
3352
|
resourceArn: string | undefined;
|
|
2727
3353
|
}
|
|
@@ -2759,16 +3385,17 @@ export interface RegisterJobDefinitionRequest {
|
|
|
2759
3385
|
*/
|
|
2760
3386
|
parameters?: Record<string, string>;
|
|
2761
3387
|
/**
|
|
2762
|
-
* <p>The scheduling priority for jobs that are submitted with this job definition. This
|
|
2763
|
-
* queues with a fair share policy. Jobs with a higher scheduling priority
|
|
3388
|
+
* <p>The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job
|
|
3389
|
+
* queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
2764
3390
|
* scheduling priority.</p>
|
|
2765
3391
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
2766
3392
|
*/
|
|
2767
3393
|
schedulingPriority?: number;
|
|
2768
3394
|
/**
|
|
2769
|
-
* <p>An object with various properties specific to single-node container-based jobs. If the job
|
|
2770
|
-
*
|
|
2771
|
-
* or <code>nodeProperties</code
|
|
3395
|
+
* <p>An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job
|
|
3396
|
+
* definition's <code>type</code> parameter is <code>container</code>, then you must specify either
|
|
3397
|
+
* <code>containerProperties</code> or <code>nodeProperties</code>. This must not be specified for Amazon EKS based job
|
|
3398
|
+
* definitions.</p>
|
|
2772
3399
|
* <note>
|
|
2773
3400
|
* <p>If the job runs on Fargate resources, then you must not specify <code>nodeProperties</code>; use only
|
|
2774
3401
|
* <code>containerProperties</code>.</p>
|
|
@@ -2778,12 +3405,14 @@ export interface RegisterJobDefinitionRequest {
|
|
|
2778
3405
|
/**
|
|
2779
3406
|
* <p>An object with various properties specific to multi-node parallel jobs. If you specify node properties for a
|
|
2780
3407
|
* 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 Jobs</a> in the
|
|
2781
|
-
*
|
|
2782
|
-
*
|
|
2783
|
-
* <code>nodeProperties</code>.</p>
|
|
3408
|
+
* <i>Batch User Guide</i>. If the job definition's <code>type</code> parameter is <code>container</code>,
|
|
3409
|
+
* then you must specify either <code>containerProperties</code> or <code>nodeProperties</code>.</p>
|
|
2784
3410
|
* <note>
|
|
2785
3411
|
* <p>If the job runs on Fargate resources, then you must not specify <code>nodeProperties</code>; use
|
|
2786
|
-
*
|
|
3412
|
+
* <code>containerProperties</code> instead.</p>
|
|
3413
|
+
* </note>
|
|
3414
|
+
* <note>
|
|
3415
|
+
* <p>If the job runs on Amazon EKS resources, then you must not specify <code>nodeProperties</code>.</p>
|
|
2787
3416
|
* </note>
|
|
2788
3417
|
*/
|
|
2789
3418
|
nodeProperties?: NodeProperties;
|
|
@@ -2798,6 +3427,9 @@ export interface RegisterJobDefinitionRequest {
|
|
|
2798
3427
|
* value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For
|
|
2799
3428
|
* tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags
|
|
2800
3429
|
* from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
3430
|
+
* <note>
|
|
3431
|
+
* <p>If the job runs on Amazon EKS resources, then you must not specify <code>propagateTags</code>.</p>
|
|
3432
|
+
* </note>
|
|
2801
3433
|
*/
|
|
2802
3434
|
propagateTags?: boolean;
|
|
2803
3435
|
/**
|
|
@@ -2814,9 +3446,17 @@ export interface RegisterJobDefinitionRequest {
|
|
|
2814
3446
|
tags?: Record<string, string>;
|
|
2815
3447
|
/**
|
|
2816
3448
|
* <p>The platform capabilities required by the job definition. If no value is specified, it defaults to
|
|
2817
|
-
*
|
|
3449
|
+
* <code>EC2</code>. To run the job on Fargate resources, specify <code>FARGATE</code>.</p>
|
|
3450
|
+
* <note>
|
|
3451
|
+
* <p>If the job runs on Amazon EKS resources, then you must not specify <code>platformCapabilities</code>.</p>
|
|
3452
|
+
* </note>
|
|
2818
3453
|
*/
|
|
2819
3454
|
platformCapabilities?: (PlatformCapability | string)[];
|
|
3455
|
+
/**
|
|
3456
|
+
* <p>An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS
|
|
3457
|
+
* based job definitions.</p>
|
|
3458
|
+
*/
|
|
3459
|
+
eksProperties?: EksProperties;
|
|
2820
3460
|
}
|
|
2821
3461
|
export interface RegisterJobDefinitionResponse {
|
|
2822
3462
|
/**
|
|
@@ -2840,26 +3480,26 @@ export interface ContainerOverrides {
|
|
|
2840
3480
|
* @deprecated
|
|
2841
3481
|
*
|
|
2842
3482
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the <code>vcpus</code> parameter
|
|
2843
|
-
* that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs
|
|
3483
|
+
* that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2
|
|
2844
3484
|
* resources, it overrides the <code>vcpus</code> parameter set in the job definition, but doesn't override any vCPU
|
|
2845
3485
|
* requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override vCPU
|
|
2846
3486
|
* requirements that are specified in the <code>resourceRequirements</code> structure in the job definition,
|
|
2847
|
-
*
|
|
2848
|
-
*
|
|
2849
|
-
*
|
|
3487
|
+
* <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code> set
|
|
3488
|
+
* to <code>VCPU</code> and <code>value</code> set to the new value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements">Can't override job
|
|
3489
|
+
* definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
2850
3490
|
*/
|
|
2851
3491
|
vcpus?: number;
|
|
2852
3492
|
/**
|
|
2853
3493
|
* @deprecated
|
|
2854
3494
|
*
|
|
2855
3495
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the memory requirements
|
|
2856
|
-
* specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs
|
|
3496
|
+
* specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2
|
|
2857
3497
|
* resources, it overrides the <code>memory</code> parameter set in the job definition, but doesn't override any memory
|
|
2858
|
-
* requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override
|
|
2859
|
-
* requirements that are specified in the <code>resourceRequirements</code> structure in the job definition,
|
|
2860
|
-
*
|
|
2861
|
-
*
|
|
2862
|
-
*
|
|
3498
|
+
* requirement that's specified in the <code>resourceRequirements</code> structure in the job definition. To override
|
|
3499
|
+
* memory requirements that are specified in the <code>resourceRequirements</code> structure in the job definition,
|
|
3500
|
+
* <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code> set
|
|
3501
|
+
* to <code>MEMORY</code> and <code>value</code> set to the new value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements">Can't override job
|
|
3502
|
+
* definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
2863
3503
|
*/
|
|
2864
3504
|
memory?: number;
|
|
2865
3505
|
/**
|
|
@@ -2880,8 +3520,8 @@ export interface ContainerOverrides {
|
|
|
2880
3520
|
* the container at launch, or you can override the existing environment variables from the Docker image or the job
|
|
2881
3521
|
* definition.</p>
|
|
2882
3522
|
* <note>
|
|
2883
|
-
* <p>Environment variables
|
|
2884
|
-
* convention is reserved for variables that
|
|
3523
|
+
* <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
|
|
3524
|
+
* convention is reserved for variables that Batch sets.</p>
|
|
2885
3525
|
* </note>
|
|
2886
3526
|
*/
|
|
2887
3527
|
environment?: KeyValuePair[];
|
|
@@ -2892,46 +3532,103 @@ export interface ContainerOverrides {
|
|
|
2892
3532
|
resourceRequirements?: ResourceRequirement[];
|
|
2893
3533
|
}
|
|
2894
3534
|
/**
|
|
2895
|
-
* <p>Object representing any
|
|
3535
|
+
* <p>Object representing any Kubernetes overrides to a job definition that's used in a <a>SubmitJob</a> API
|
|
2896
3536
|
* operation.</p>
|
|
2897
3537
|
*/
|
|
3538
|
+
export interface EksContainerOverride {
|
|
3539
|
+
/**
|
|
3540
|
+
* <p>The override of the Docker image that's used to start the container.</p>
|
|
3541
|
+
*/
|
|
3542
|
+
image?: string;
|
|
3543
|
+
/**
|
|
3544
|
+
* <p>The command to send to the container that overrides the default command from the Docker image or the job
|
|
3545
|
+
* definition.</p>
|
|
3546
|
+
*/
|
|
3547
|
+
command?: string[];
|
|
3548
|
+
/**
|
|
3549
|
+
* <p>The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker
|
|
3550
|
+
* image or the job definition. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a> in the <i>Dockerfile
|
|
3551
|
+
* reference</i> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command an
|
|
3552
|
+
* arguments for a pod</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3553
|
+
*/
|
|
3554
|
+
args?: string[];
|
|
3555
|
+
/**
|
|
3556
|
+
* <p>The environment variables to send to the container. You can add new environment variables, which are added to
|
|
3557
|
+
* the container at launch. Or, you can override the existing environment variables from the Docker image or the job
|
|
3558
|
+
* definition.</p>
|
|
3559
|
+
* <note>
|
|
3560
|
+
* <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
|
|
3561
|
+
* convention is reserved for variables that Batch sets.</p>
|
|
3562
|
+
* </note>
|
|
3563
|
+
*/
|
|
3564
|
+
env?: EksContainerEnvironmentVariable[];
|
|
3565
|
+
/**
|
|
3566
|
+
* <p>The type and amount of resources to assign to a container. These override the settings in the job definition.
|
|
3567
|
+
* The supported resources include <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more
|
|
3568
|
+
* information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource
|
|
3569
|
+
* management for pods and containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3570
|
+
*/
|
|
3571
|
+
resources?: EksContainerResourceRequirements;
|
|
3572
|
+
}
|
|
3573
|
+
/**
|
|
3574
|
+
* <p>An object that contains overrides for the Kubernetes pod properties of a job.</p>
|
|
3575
|
+
*/
|
|
3576
|
+
export interface EksPodPropertiesOverride {
|
|
3577
|
+
/**
|
|
3578
|
+
* <p>The overrides for the container that's used on the Amazon EKS pod.</p>
|
|
3579
|
+
*/
|
|
3580
|
+
containers?: EksContainerOverride[];
|
|
3581
|
+
}
|
|
3582
|
+
/**
|
|
3583
|
+
* <p>An object that contains overrides for the Kubernetes resources of a job.</p>
|
|
3584
|
+
*/
|
|
3585
|
+
export interface EksPropertiesOverride {
|
|
3586
|
+
/**
|
|
3587
|
+
* <p>The overrides for the Kubernetes pod resources of a job.</p>
|
|
3588
|
+
*/
|
|
3589
|
+
podProperties?: EksPodPropertiesOverride;
|
|
3590
|
+
}
|
|
3591
|
+
/**
|
|
3592
|
+
* <p>The object that represents any node overrides to a job definition that's used in a <a>SubmitJob</a>
|
|
3593
|
+
* API operation.</p>
|
|
3594
|
+
*/
|
|
2898
3595
|
export interface NodePropertyOverride {
|
|
2899
3596
|
/**
|
|
2900
3597
|
* <p>The range of nodes, using node index values, that's used to override. A range of <code>0:3</code> indicates
|
|
2901
3598
|
* nodes with index values of <code>0</code> through <code>3</code>. If the starting range value is omitted
|
|
2902
|
-
*
|
|
2903
|
-
*
|
|
3599
|
+
* (<code>:n</code>), then <code>0</code> is used to start the range. If the ending range value is omitted
|
|
3600
|
+
* (<code>n:</code>), then the highest possible node index is used to end the range.</p>
|
|
2904
3601
|
*/
|
|
2905
3602
|
targetNodes: string | undefined;
|
|
2906
3603
|
/**
|
|
2907
|
-
* <p>The overrides that
|
|
3604
|
+
* <p>The overrides that are sent to a node range.</p>
|
|
2908
3605
|
*/
|
|
2909
3606
|
containerOverrides?: ContainerOverrides;
|
|
2910
3607
|
}
|
|
2911
3608
|
/**
|
|
2912
|
-
* <p>
|
|
2913
|
-
* operation.</p>
|
|
3609
|
+
* <p>An object that represents any node overrides to a job definition that's used in a <a>SubmitJob</a>
|
|
3610
|
+
* API operation.</p>
|
|
2914
3611
|
* <note>
|
|
2915
|
-
* <p>This isn't applicable to jobs that are running on Fargate resources
|
|
2916
|
-
*
|
|
3612
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
|
|
3613
|
+
* jobs. Rather, use <code>containerOverrides</code> instead.</p>
|
|
2917
3614
|
* </note>
|
|
2918
3615
|
*/
|
|
2919
3616
|
export interface NodeOverrides {
|
|
2920
3617
|
/**
|
|
2921
3618
|
* <p>The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are
|
|
2922
|
-
* specified in the job definition. To use this override:</p>
|
|
3619
|
+
* specified in the job definition. To use this override, you must meet the following conditions:</p>
|
|
2923
3620
|
* <ul>
|
|
2924
3621
|
* <li>
|
|
2925
|
-
* <p>There must be at least one node range in your job definition that has an open upper boundary
|
|
2926
|
-
*
|
|
3622
|
+
* <p>There must be at least one node range in your job definition that has an open upper boundary, such as
|
|
3623
|
+
* <code>:</code> or <code>n:</code>.</p>
|
|
2927
3624
|
* </li>
|
|
2928
3625
|
* <li>
|
|
2929
|
-
* <p>The lower boundary of the node range specified in the job definition must be fewer than the number of
|
|
2930
|
-
* specified in the override.</p>
|
|
3626
|
+
* <p>The lower boundary of the node range that's specified in the job definition must be fewer than the number of
|
|
3627
|
+
* nodes specified in the override.</p>
|
|
2931
3628
|
* </li>
|
|
2932
3629
|
* <li>
|
|
2933
|
-
* <p>The main node index specified in the job definition must be fewer than the number of nodes specified in
|
|
2934
|
-
* override.</p>
|
|
3630
|
+
* <p>The main node index that's specified in the job definition must be fewer than the number of nodes specified in
|
|
3631
|
+
* the override.</p>
|
|
2935
3632
|
* </li>
|
|
2936
3633
|
* </ul>
|
|
2937
3634
|
*/
|
|
@@ -2955,14 +3652,14 @@ export interface SubmitJobRequest {
|
|
|
2955
3652
|
*/
|
|
2956
3653
|
jobQueue: string | undefined;
|
|
2957
3654
|
/**
|
|
2958
|
-
* <p>The share identifier for the job. If the job queue
|
|
3655
|
+
* <p>The share identifier for the job. If the job queue doesn't have a scheduling policy, then this parameter must
|
|
2959
3656
|
* not be specified. If the job queue has a scheduling policy, then this parameter must be specified.</p>
|
|
2960
3657
|
*/
|
|
2961
3658
|
shareIdentifier?: string;
|
|
2962
3659
|
/**
|
|
2963
|
-
* <p>The scheduling priority for the job. This
|
|
2964
|
-
*
|
|
2965
|
-
*
|
|
3660
|
+
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a
|
|
3661
|
+
* higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling
|
|
3662
|
+
* priority in the job definition.</p>
|
|
2966
3663
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
2967
3664
|
*/
|
|
2968
3665
|
schedulingPriorityOverride?: number;
|
|
@@ -2993,11 +3690,11 @@ export interface SubmitJobRequest {
|
|
|
2993
3690
|
*/
|
|
2994
3691
|
parameters?: Record<string, string>;
|
|
2995
3692
|
/**
|
|
2996
|
-
* <p>
|
|
2997
|
-
* definition and the overrides it
|
|
2998
|
-
* the job definition or the Docker image, with a <code>command</code> override.
|
|
2999
|
-
* existing environment variables on a container or add new environment variables to it with an
|
|
3000
|
-
* override.</p>
|
|
3693
|
+
* <p>An object with various properties that override the defaults for the job definition that specify the name of a
|
|
3694
|
+
* container in the specified job definition and the overrides it should receive. You can override the default command
|
|
3695
|
+
* for a container, which is specified in the job definition or the Docker image, with a <code>command</code> override.
|
|
3696
|
+
* You can also override existing environment variables on a container or add new environment variables to it with an
|
|
3697
|
+
* <code>environment</code> override.</p>
|
|
3001
3698
|
*/
|
|
3002
3699
|
containerOverrides?: ContainerOverrides;
|
|
3003
3700
|
/**
|
|
@@ -3037,6 +3734,11 @@ export interface SubmitJobRequest {
|
|
|
3037
3734
|
* Reference</i>.</p>
|
|
3038
3735
|
*/
|
|
3039
3736
|
tags?: Record<string, string>;
|
|
3737
|
+
/**
|
|
3738
|
+
* <p>An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that
|
|
3739
|
+
* override defaults for the job definition.</p>
|
|
3740
|
+
*/
|
|
3741
|
+
eksPropertiesOverride?: EksPropertiesOverride;
|
|
3040
3742
|
}
|
|
3041
3743
|
export interface SubmitJobResponse {
|
|
3042
3744
|
/**
|
|
@@ -3058,7 +3760,7 @@ export interface SubmitJobResponse {
|
|
|
3058
3760
|
export interface TagResourceRequest {
|
|
3059
3761
|
/**
|
|
3060
3762
|
* <p>The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
|
|
3061
|
-
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs
|
|
3763
|
+
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
|
|
3062
3764
|
*/
|
|
3063
3765
|
resourceArn: string | undefined;
|
|
3064
3766
|
/**
|
|
@@ -3093,7 +3795,7 @@ export interface TerminateJobResponse {
|
|
|
3093
3795
|
export interface UntagResourceRequest {
|
|
3094
3796
|
/**
|
|
3095
3797
|
* <p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
|
|
3096
|
-
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs
|
|
3798
|
+
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
|
|
3097
3799
|
*/
|
|
3098
3800
|
resourceArn: string | undefined;
|
|
3099
3801
|
/**
|
|
@@ -3108,25 +3810,24 @@ export declare enum CRUpdateAllocationStrategy {
|
|
|
3108
3810
|
SPOT_CAPACITY_OPTIMIZED = "SPOT_CAPACITY_OPTIMIZED"
|
|
3109
3811
|
}
|
|
3110
3812
|
/**
|
|
3111
|
-
* <p>An object
|
|
3112
|
-
*
|
|
3813
|
+
* <p>An object that represents the attributes of a compute environment that can be updated. For more information, see
|
|
3814
|
+
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a>
|
|
3113
3815
|
* in the <i>Batch User Guide</i>.</p>
|
|
3114
3816
|
*/
|
|
3115
3817
|
export interface ComputeResourceUpdate {
|
|
3116
3818
|
/**
|
|
3117
3819
|
* <p>The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
|
|
3118
|
-
*
|
|
3820
|
+
* <code>DISABLED</code>).</p>
|
|
3119
3821
|
* <note>
|
|
3120
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3121
|
-
* specified.</p>
|
|
3822
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3122
3823
|
* </note>
|
|
3123
3824
|
*/
|
|
3124
3825
|
minvCpus?: number;
|
|
3125
3826
|
/**
|
|
3126
3827
|
* <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
|
|
3127
3828
|
* <note>
|
|
3128
|
-
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies
|
|
3129
|
-
* Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never
|
|
3829
|
+
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies
|
|
3830
|
+
* using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never
|
|
3130
3831
|
* exceeds <code>maxvCpus</code> by more than a single instance. That is, no more than a single instance from among
|
|
3131
3832
|
* those specified in your compute environment.</p>
|
|
3132
3833
|
* </note>
|
|
@@ -3136,8 +3837,7 @@ export interface ComputeResourceUpdate {
|
|
|
3136
3837
|
* <p>The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum
|
|
3137
3838
|
* and maximum values based on job queue demand.</p>
|
|
3138
3839
|
* <note>
|
|
3139
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3140
|
-
* specified.</p>
|
|
3840
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3141
3841
|
* </note>
|
|
3142
3842
|
*/
|
|
3143
3843
|
desiredvCpus?: number;
|
|
@@ -3151,45 +3851,46 @@ export interface ComputeResourceUpdate {
|
|
|
3151
3851
|
*/
|
|
3152
3852
|
subnets?: string[];
|
|
3153
3853
|
/**
|
|
3154
|
-
* <p>The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter
|
|
3155
|
-
* required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute
|
|
3854
|
+
* <p>The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter
|
|
3855
|
+
* is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute
|
|
3156
3856
|
* resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2
|
|
3157
3857
|
* compute resources, providing an empty list removes the security groups from the compute resource.</p>
|
|
3158
3858
|
* <p>When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the
|
|
3159
3859
|
* compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
3160
|
-
*
|
|
3860
|
+
* <i>Batch User Guide</i>.</p>
|
|
3161
3861
|
*/
|
|
3162
3862
|
securityGroupIds?: string[];
|
|
3163
3863
|
/**
|
|
3164
|
-
* <p>The allocation strategy to use for the compute resource if not enough instances of the best fitting
|
|
3165
|
-
* type can be allocated. This might be because of availability of the instance type in the Region or
|
|
3166
|
-
*
|
|
3167
|
-
*
|
|
3864
|
+
* <p>The allocation strategy to use for the compute resource if there's not enough instances of the best fitting
|
|
3865
|
+
* instance type that can be allocated. This might be because of availability of the instance type in the Region or
|
|
3866
|
+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html">Amazon EC2 service limits</a>. For
|
|
3867
|
+
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html">Allocation
|
|
3868
|
+
* strategies</a> in the <i>Batch User Guide</i>.</p>
|
|
3168
3869
|
* <p>When updating a compute environment, changing the allocation strategy requires an infrastructure update of the
|
|
3169
3870
|
* compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
3170
|
-
*
|
|
3871
|
+
* <i>Batch User Guide</i>. <code>BEST_FIT</code> isn't supported when updating a compute
|
|
3171
3872
|
* environment.</p>
|
|
3172
3873
|
* <note>
|
|
3173
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3174
|
-
* specified.</p>
|
|
3874
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3175
3875
|
* </note>
|
|
3176
3876
|
* <dl>
|
|
3177
3877
|
* <dt>BEST_FIT_PROGRESSIVE</dt>
|
|
3178
3878
|
* <dd>
|
|
3179
|
-
* <p>Batch
|
|
3180
|
-
*
|
|
3181
|
-
*
|
|
3879
|
+
* <p>Batch selects additional instance types that are large enough to meet the requirements of the jobs in the
|
|
3880
|
+
* queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously
|
|
3881
|
+
* selected instance types aren't available, Batch selects new instance types.</p>
|
|
3182
3882
|
* </dd>
|
|
3183
3883
|
* <dt>SPOT_CAPACITY_OPTIMIZED</dt>
|
|
3184
3884
|
* <dd>
|
|
3185
|
-
* <p>Batch
|
|
3186
|
-
*
|
|
3187
|
-
*
|
|
3885
|
+
* <p>Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the
|
|
3886
|
+
* queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is
|
|
3887
|
+
* only available for Spot Instance compute resources.</p>
|
|
3188
3888
|
* </dd>
|
|
3189
3889
|
* </dl>
|
|
3190
|
-
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> strategies
|
|
3191
|
-
*
|
|
3192
|
-
* <code>maxvCpus</code>
|
|
3890
|
+
* <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> strategies using On-Demand
|
|
3891
|
+
* or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
3892
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds <code>maxvCpus</code>
|
|
3893
|
+
* by more than a single instance.</p>
|
|
3193
3894
|
*/
|
|
3194
3895
|
allocationStrategy?: CRUpdateAllocationStrategy | string;
|
|
3195
3896
|
/**
|
|
@@ -3200,8 +3901,7 @@ export interface ComputeResourceUpdate {
|
|
|
3200
3901
|
* <p>When updating a compute environment, changing this setting requires an infrastructure update of the compute
|
|
3201
3902
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
3202
3903
|
* <note>
|
|
3203
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3204
|
-
* specified.</p>
|
|
3904
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3205
3905
|
* </note>
|
|
3206
3906
|
* <note>
|
|
3207
3907
|
* <p>When you create a compute environment, the instance types that you select for the compute environment must
|
|
@@ -3210,7 +3910,7 @@ export interface ComputeResourceUpdate {
|
|
|
3210
3910
|
* </note>
|
|
3211
3911
|
* <note>
|
|
3212
3912
|
* <p>Currently, <code>optimal</code> uses instance types from the C4, M4, and R4 instance families. In Regions that
|
|
3213
|
-
* don't have instance types from those instance families, instance types from the C5, M5
|
|
3913
|
+
* don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are
|
|
3214
3914
|
* used.</p>
|
|
3215
3915
|
* </note>
|
|
3216
3916
|
*/
|
|
@@ -3221,40 +3921,36 @@ export interface ComputeResourceUpdate {
|
|
|
3221
3921
|
* <p>When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute
|
|
3222
3922
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
3223
3923
|
* <note>
|
|
3224
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3225
|
-
* specified.</p>
|
|
3924
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3226
3925
|
* </note>
|
|
3227
3926
|
*/
|
|
3228
3927
|
ec2KeyPair?: string;
|
|
3229
3928
|
/**
|
|
3230
3929
|
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name
|
|
3231
|
-
* or full Amazon Resource Name (ARN) of an instance profile. For example,
|
|
3232
|
-
* <code>
|
|
3930
|
+
* or full Amazon Resource Name (ARN) of an instance profile. For example, <code>
|
|
3233
3931
|
* <i>ecsInstanceRole</i>
|
|
3234
3932
|
* </code> or
|
|
3235
|
-
*
|
|
3933
|
+
* <code>arn:aws:iam::<i><aws_account_id></i>:instance-profile/<i>ecsInstanceRole</i>
|
|
3236
3934
|
* </code>.
|
|
3237
3935
|
* For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html">Amazon ECS instance
|
|
3238
|
-
*
|
|
3936
|
+
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
3239
3937
|
* <p>When updating a compute environment, changing this setting requires an infrastructure update of the compute
|
|
3240
3938
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
3241
3939
|
* <note>
|
|
3242
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3243
|
-
* specified.</p>
|
|
3940
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3244
3941
|
* </note>
|
|
3245
3942
|
*/
|
|
3246
3943
|
instanceRole?: string;
|
|
3247
3944
|
/**
|
|
3248
3945
|
* <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
|
|
3249
|
-
* these take the form of "String1": "String2"
|
|
3250
|
-
* example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is
|
|
3251
|
-
* instances in the Amazon EC2 console. These tags aren't seen when using the Batch
|
|
3252
|
-
* operation.</p>
|
|
3946
|
+
* these take the form of <code>"String1": "String2"</code>, where <code>String1</code> is the tag key and
|
|
3947
|
+
* <code>String2</code> is the tag value-for example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is
|
|
3948
|
+
* helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch
|
|
3949
|
+
* <code>ListTagsForResource</code> API operation.</p>
|
|
3253
3950
|
* <p>When updating a compute environment, changing this setting requires an infrastructure update of the compute
|
|
3254
3951
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
3255
3952
|
* <note>
|
|
3256
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3257
|
-
* specified.</p>
|
|
3953
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3258
3954
|
* </note>
|
|
3259
3955
|
*/
|
|
3260
3956
|
tags?: Record<string, string>;
|
|
@@ -3263,27 +3959,25 @@ export interface ComputeResourceUpdate {
|
|
|
3263
3959
|
* jobs to your compute environment, you should consider creating a cluster placement group and associate it with your
|
|
3264
3960
|
* compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single
|
|
3265
3961
|
* Availability Zone with high network flow potential. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide for
|
|
3266
|
-
*
|
|
3962
|
+
* Linux Instances</i>.</p>
|
|
3267
3963
|
* <p>When updating a compute environment, changing the placement group requires an infrastructure update of the
|
|
3268
3964
|
* compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
3269
|
-
*
|
|
3965
|
+
* <i>Batch User Guide</i>.</p>
|
|
3270
3966
|
* <note>
|
|
3271
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3272
|
-
* specified.</p>
|
|
3967
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3273
3968
|
* </note>
|
|
3274
3969
|
*/
|
|
3275
3970
|
placementGroup?: string;
|
|
3276
3971
|
/**
|
|
3277
3972
|
* <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that
|
|
3278
|
-
* instance type before instances are launched. For example, if your maximum percentage is 20%,
|
|
3279
|
-
*
|
|
3973
|
+
* instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be
|
|
3974
|
+
* less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and
|
|
3280
3975
|
* never more than your maximum percentage.</p>
|
|
3281
3976
|
* <p>When updating a compute environment, changing the bid percentage requires an infrastructure update of the
|
|
3282
3977
|
* compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
3283
|
-
*
|
|
3978
|
+
* <i>Batch User Guide</i>.</p>
|
|
3284
3979
|
* <note>
|
|
3285
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3286
|
-
* specified.</p>
|
|
3980
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3287
3981
|
* </note>
|
|
3288
3982
|
*/
|
|
3289
3983
|
bidPercentage?: number;
|
|
@@ -3291,16 +3985,15 @@ export interface ComputeResourceUpdate {
|
|
|
3291
3985
|
* <p>The updated launch template to use for your compute resources. You must specify either the launch template ID or
|
|
3292
3986
|
* launch template name in the request, but not both. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Batch User Guide</i>.
|
|
3293
3987
|
* To remove the custom launch template and use the default launch template, set <code>launchTemplateId</code> or
|
|
3294
|
-
*
|
|
3988
|
+
* <code>launchTemplateName</code> member of the launch template specification to an empty string. Removing the launch
|
|
3295
3989
|
* template from a compute environment will not remove the AMI specified in the launch template. In order to update the
|
|
3296
3990
|
* AMI specified in a launch template, the <code>updateToLatestImageVersion</code> parameter must be set to
|
|
3297
|
-
*
|
|
3991
|
+
* <code>true</code>.</p>
|
|
3298
3992
|
* <p>When updating a compute environment, changing the launch template requires an infrastructure update of the
|
|
3299
3993
|
* compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
3300
|
-
*
|
|
3994
|
+
* <i>Batch User Guide</i>.</p>
|
|
3301
3995
|
* <note>
|
|
3302
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3303
|
-
* specified.</p>
|
|
3996
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3304
3997
|
* </note>
|
|
3305
3998
|
*/
|
|
3306
3999
|
launchTemplate?: LaunchTemplateSpecification;
|
|
@@ -3312,36 +4005,34 @@ export interface ComputeResourceUpdate {
|
|
|
3312
4005
|
* and any custom AMI ID specified in <code>imageIdOverride</code>, set this value to an empty string.</p>
|
|
3313
4006
|
* <p>One or two values can be provided.</p>
|
|
3314
4007
|
* <note>
|
|
3315
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3316
|
-
* specified.</p>
|
|
4008
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3317
4009
|
* </note>
|
|
3318
4010
|
*/
|
|
3319
4011
|
ec2Configuration?: Ec2Configuration[];
|
|
3320
4012
|
/**
|
|
3321
4013
|
* <p>Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute
|
|
3322
4014
|
* environment has an infrastructure update. The default value is <code>false</code>.</p>
|
|
3323
|
-
*
|
|
3324
4015
|
* <note>
|
|
3325
|
-
* <p>
|
|
3326
|
-
* launch template specified in the <code>launchTemplate</code> parameter
|
|
3327
|
-
*
|
|
4016
|
+
* <p>An AMI ID can either be specified in the <code>imageId</code> or <code>imageIdOverride</code> parameters or be
|
|
4017
|
+
* determined by the launch template that's specified in the <code>launchTemplate</code> parameter. If an AMI ID is
|
|
4018
|
+
* specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an
|
|
4019
|
+
* infrastructure update, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami">Updating the AMI ID</a> in
|
|
3328
4020
|
* the <i>Batch User Guide</i>.</p>
|
|
3329
4021
|
* </note>
|
|
3330
|
-
*
|
|
3331
4022
|
* <p>When updating a compute environment, changing this setting requires an infrastructure update of the compute
|
|
3332
4023
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
3333
4024
|
*/
|
|
3334
4025
|
updateToLatestImageVersion?: boolean;
|
|
3335
4026
|
/**
|
|
3336
4027
|
* <p>The type of compute environment: <code>EC2</code>, <code>SPOT</code>, <code>FARGATE</code>, or
|
|
3337
|
-
*
|
|
4028
|
+
* <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
|
|
3338
4029
|
* <i>Batch User Guide</i>.</p>
|
|
3339
4030
|
* <p> If you choose <code>SPOT</code>, you must also specify an Amazon EC2 Spot Fleet role with the
|
|
3340
|
-
*
|
|
4031
|
+
* <code>spotIamFleetRole</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html">Amazon EC2 spot fleet role</a> in the
|
|
3341
4032
|
* <i>Batch User Guide</i>.</p>
|
|
3342
4033
|
* <p>When updating a compute environment, changing the type of a compute environment requires an infrastructure
|
|
3343
4034
|
* update of the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
3344
|
-
*
|
|
4035
|
+
* <i>Batch User Guide</i>.</p>
|
|
3345
4036
|
*/
|
|
3346
4037
|
type?: CRType | string;
|
|
3347
4038
|
/**
|
|
@@ -3351,8 +4042,7 @@ export interface ComputeResourceUpdate {
|
|
|
3351
4042
|
* <p>When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute
|
|
3352
4043
|
* environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
3353
4044
|
* <note>
|
|
3354
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources
|
|
3355
|
-
* specified.</p>
|
|
4045
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
3356
4046
|
* </note>
|
|
3357
4047
|
* <note>
|
|
3358
4048
|
* <p>The AMI that you choose for a compute environment must match the architecture of the instance types that
|
|
@@ -3386,10 +4076,10 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
3386
4076
|
*/
|
|
3387
4077
|
state?: CEState | string;
|
|
3388
4078
|
/**
|
|
3389
|
-
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
|
4079
|
+
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this
|
|
3390
4080
|
* parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU
|
|
3391
|
-
* capacity for new share identifiers. If this parameter
|
|
3392
|
-
*
|
|
4081
|
+
* capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity
|
|
4082
|
+
* is reserved.</p>
|
|
3393
4083
|
*/
|
|
3394
4084
|
unmanagedvCpus?: number;
|
|
3395
4085
|
/**
|
|
@@ -3428,7 +4118,7 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
3428
4118
|
}
|
|
3429
4119
|
export interface UpdateComputeEnvironmentResponse {
|
|
3430
4120
|
/**
|
|
3431
|
-
* <p>The name of the compute environment. It can be up to 128
|
|
4121
|
+
* <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
|
|
3432
4122
|
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
3433
4123
|
*/
|
|
3434
4124
|
computeEnvironmentName?: string;
|
|
@@ -3457,7 +4147,7 @@ export interface UpdateJobQueueRequest {
|
|
|
3457
4147
|
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
3458
4148
|
* </code>.
|
|
3459
4149
|
* For example,
|
|
3460
|
-
* <code>aws:aws:batch:us-west-2:
|
|
4150
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
3461
4151
|
*/
|
|
3462
4152
|
schedulingPolicyArn?: string;
|
|
3463
4153
|
/**
|
|
@@ -3551,6 +4241,10 @@ export declare const LaunchTemplateSpecificationFilterSensitiveLog: (obj: Launch
|
|
|
3551
4241
|
* @internal
|
|
3552
4242
|
*/
|
|
3553
4243
|
export declare const ComputeResourceFilterSensitiveLog: (obj: ComputeResource) => any;
|
|
4244
|
+
/**
|
|
4245
|
+
* @internal
|
|
4246
|
+
*/
|
|
4247
|
+
export declare const EksConfigurationFilterSensitiveLog: (obj: EksConfiguration) => any;
|
|
3554
4248
|
/**
|
|
3555
4249
|
* @internal
|
|
3556
4250
|
*/
|
|
@@ -3703,6 +4397,50 @@ export declare const VolumeFilterSensitiveLog: (obj: Volume) => any;
|
|
|
3703
4397
|
* @internal
|
|
3704
4398
|
*/
|
|
3705
4399
|
export declare const ContainerPropertiesFilterSensitiveLog: (obj: ContainerProperties) => any;
|
|
4400
|
+
/**
|
|
4401
|
+
* @internal
|
|
4402
|
+
*/
|
|
4403
|
+
export declare const EksContainerEnvironmentVariableFilterSensitiveLog: (obj: EksContainerEnvironmentVariable) => any;
|
|
4404
|
+
/**
|
|
4405
|
+
* @internal
|
|
4406
|
+
*/
|
|
4407
|
+
export declare const EksContainerResourceRequirementsFilterSensitiveLog: (obj: EksContainerResourceRequirements) => any;
|
|
4408
|
+
/**
|
|
4409
|
+
* @internal
|
|
4410
|
+
*/
|
|
4411
|
+
export declare const EksContainerSecurityContextFilterSensitiveLog: (obj: EksContainerSecurityContext) => any;
|
|
4412
|
+
/**
|
|
4413
|
+
* @internal
|
|
4414
|
+
*/
|
|
4415
|
+
export declare const EksContainerVolumeMountFilterSensitiveLog: (obj: EksContainerVolumeMount) => any;
|
|
4416
|
+
/**
|
|
4417
|
+
* @internal
|
|
4418
|
+
*/
|
|
4419
|
+
export declare const EksContainerFilterSensitiveLog: (obj: EksContainer) => any;
|
|
4420
|
+
/**
|
|
4421
|
+
* @internal
|
|
4422
|
+
*/
|
|
4423
|
+
export declare const EksEmptyDirFilterSensitiveLog: (obj: EksEmptyDir) => any;
|
|
4424
|
+
/**
|
|
4425
|
+
* @internal
|
|
4426
|
+
*/
|
|
4427
|
+
export declare const EksHostPathFilterSensitiveLog: (obj: EksHostPath) => any;
|
|
4428
|
+
/**
|
|
4429
|
+
* @internal
|
|
4430
|
+
*/
|
|
4431
|
+
export declare const EksSecretFilterSensitiveLog: (obj: EksSecret) => any;
|
|
4432
|
+
/**
|
|
4433
|
+
* @internal
|
|
4434
|
+
*/
|
|
4435
|
+
export declare const EksVolumeFilterSensitiveLog: (obj: EksVolume) => any;
|
|
4436
|
+
/**
|
|
4437
|
+
* @internal
|
|
4438
|
+
*/
|
|
4439
|
+
export declare const EksPodPropertiesFilterSensitiveLog: (obj: EksPodProperties) => any;
|
|
4440
|
+
/**
|
|
4441
|
+
* @internal
|
|
4442
|
+
*/
|
|
4443
|
+
export declare const EksPropertiesFilterSensitiveLog: (obj: EksProperties) => any;
|
|
3706
4444
|
/**
|
|
3707
4445
|
* @internal
|
|
3708
4446
|
*/
|
|
@@ -3755,6 +4493,26 @@ export declare const ContainerDetailFilterSensitiveLog: (obj: ContainerDetail) =
|
|
|
3755
4493
|
* @internal
|
|
3756
4494
|
*/
|
|
3757
4495
|
export declare const JobDependencyFilterSensitiveLog: (obj: JobDependency) => any;
|
|
4496
|
+
/**
|
|
4497
|
+
* @internal
|
|
4498
|
+
*/
|
|
4499
|
+
export declare const EksAttemptContainerDetailFilterSensitiveLog: (obj: EksAttemptContainerDetail) => any;
|
|
4500
|
+
/**
|
|
4501
|
+
* @internal
|
|
4502
|
+
*/
|
|
4503
|
+
export declare const EksAttemptDetailFilterSensitiveLog: (obj: EksAttemptDetail) => any;
|
|
4504
|
+
/**
|
|
4505
|
+
* @internal
|
|
4506
|
+
*/
|
|
4507
|
+
export declare const EksContainerDetailFilterSensitiveLog: (obj: EksContainerDetail) => any;
|
|
4508
|
+
/**
|
|
4509
|
+
* @internal
|
|
4510
|
+
*/
|
|
4511
|
+
export declare const EksPodPropertiesDetailFilterSensitiveLog: (obj: EksPodPropertiesDetail) => any;
|
|
4512
|
+
/**
|
|
4513
|
+
* @internal
|
|
4514
|
+
*/
|
|
4515
|
+
export declare const EksPropertiesDetailFilterSensitiveLog: (obj: EksPropertiesDetail) => any;
|
|
3758
4516
|
/**
|
|
3759
4517
|
* @internal
|
|
3760
4518
|
*/
|
|
@@ -3835,6 +4593,18 @@ export declare const RegisterJobDefinitionResponseFilterSensitiveLog: (obj: Regi
|
|
|
3835
4593
|
* @internal
|
|
3836
4594
|
*/
|
|
3837
4595
|
export declare const ContainerOverridesFilterSensitiveLog: (obj: ContainerOverrides) => any;
|
|
4596
|
+
/**
|
|
4597
|
+
* @internal
|
|
4598
|
+
*/
|
|
4599
|
+
export declare const EksContainerOverrideFilterSensitiveLog: (obj: EksContainerOverride) => any;
|
|
4600
|
+
/**
|
|
4601
|
+
* @internal
|
|
4602
|
+
*/
|
|
4603
|
+
export declare const EksPodPropertiesOverrideFilterSensitiveLog: (obj: EksPodPropertiesOverride) => any;
|
|
4604
|
+
/**
|
|
4605
|
+
* @internal
|
|
4606
|
+
*/
|
|
4607
|
+
export declare const EksPropertiesOverrideFilterSensitiveLog: (obj: EksPropertiesOverride) => any;
|
|
3838
4608
|
/**
|
|
3839
4609
|
* @internal
|
|
3840
4610
|
*/
|