@aws-sdk/client-batch 3.507.0 → 3.511.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CancelJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +2 -2
- package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +6 -0
- package/dist-types/commands/DescribeJobsCommand.d.ts +6 -0
- package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +130 -69
- package/dist-types/ts3.4/models/models_0.d.ts +5 -0
- package/package.json +14 -14
|
@@ -39,7 +39,7 @@ declare const CancelJobCommand_base: {
|
|
|
39
39
|
* <p>A <code>PENDING</code> job is canceled after all dependency jobs are completed.
|
|
40
40
|
* Therefore, it may take longer than expected to cancel a job in <code>PENDING</code>
|
|
41
41
|
* status.</p>
|
|
42
|
-
* <p>When you try to cancel an array parent job in <code>PENDING</code>, Batch
|
|
42
|
+
* <p>When you try to cancel an array parent job in <code>PENDING</code>, Batch attempts to
|
|
43
43
|
* cancel all child jobs. The array parent job is canceled when all child jobs are
|
|
44
44
|
* completed.</p>
|
|
45
45
|
* </note>
|
|
@@ -93,8 +93,8 @@ declare const CreateComputeEnvironmentCommand_base: {
|
|
|
93
93
|
* <p>Don't specify an AMI ID in <code>imageId</code>, <code>imageIdOverride</code> (in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html">
|
|
94
94
|
* <code>ec2Configuration</code>
|
|
95
95
|
* </a>), or in the launch
|
|
96
|
-
*
|
|
97
|
-
*
|
|
96
|
+
* template (<code>launchTemplate</code>). In that case, Batch selects the latest Amazon ECS optimized AMI that's
|
|
97
|
+
* supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID
|
|
98
98
|
* in the <code>imageId</code> or <code>imageIdOverride</code> parameters, or the launch template identified by the
|
|
99
99
|
* <code>LaunchTemplate</code> properties. Changing any of these properties starts an infrastructure update. If the
|
|
100
100
|
* AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the
|
|
@@ -180,6 +180,9 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
180
180
|
* // operatingSystemFamily: "STRING_VALUE",
|
|
181
181
|
* // cpuArchitecture: "STRING_VALUE",
|
|
182
182
|
* // },
|
|
183
|
+
* // repositoryCredentials: { // RepositoryCredentials
|
|
184
|
+
* // credentialsParameter: "STRING_VALUE", // required
|
|
185
|
+
* // },
|
|
183
186
|
* // },
|
|
184
187
|
* // timeout: { // JobTimeout
|
|
185
188
|
* // attemptDurationSeconds: Number("int"),
|
|
@@ -290,6 +293,9 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
290
293
|
* // operatingSystemFamily: "STRING_VALUE",
|
|
291
294
|
* // cpuArchitecture: "STRING_VALUE",
|
|
292
295
|
* // },
|
|
296
|
+
* // repositoryCredentials: {
|
|
297
|
+
* // credentialsParameter: "STRING_VALUE", // required
|
|
298
|
+
* // },
|
|
293
299
|
* // },
|
|
294
300
|
* // },
|
|
295
301
|
* // ],
|
|
@@ -220,6 +220,9 @@ declare const DescribeJobsCommand_base: {
|
|
|
220
220
|
* // operatingSystemFamily: "STRING_VALUE",
|
|
221
221
|
* // cpuArchitecture: "STRING_VALUE",
|
|
222
222
|
* // },
|
|
223
|
+
* // repositoryCredentials: { // RepositoryCredentials
|
|
224
|
+
* // credentialsParameter: "STRING_VALUE", // required
|
|
225
|
+
* // },
|
|
223
226
|
* // },
|
|
224
227
|
* // nodeDetails: { // NodeDetails
|
|
225
228
|
* // nodeIndex: Number("int"),
|
|
@@ -331,6 +334,9 @@ declare const DescribeJobsCommand_base: {
|
|
|
331
334
|
* // operatingSystemFamily: "STRING_VALUE",
|
|
332
335
|
* // cpuArchitecture: "STRING_VALUE",
|
|
333
336
|
* // },
|
|
337
|
+
* // repositoryCredentials: {
|
|
338
|
+
* // credentialsParameter: "STRING_VALUE", // required
|
|
339
|
+
* // },
|
|
334
340
|
* // },
|
|
335
341
|
* // },
|
|
336
342
|
* // ],
|
|
@@ -152,6 +152,9 @@ declare const RegisterJobDefinitionCommand_base: {
|
|
|
152
152
|
* operatingSystemFamily: "STRING_VALUE",
|
|
153
153
|
* cpuArchitecture: "STRING_VALUE",
|
|
154
154
|
* },
|
|
155
|
+
* repositoryCredentials: { // RepositoryCredentials
|
|
156
|
+
* credentialsParameter: "STRING_VALUE", // required
|
|
157
|
+
* },
|
|
155
158
|
* },
|
|
156
159
|
* nodeProperties: { // NodeProperties
|
|
157
160
|
* numNodes: Number("int"), // required
|
|
@@ -259,6 +262,9 @@ declare const RegisterJobDefinitionCommand_base: {
|
|
|
259
262
|
* operatingSystemFamily: "STRING_VALUE",
|
|
260
263
|
* cpuArchitecture: "STRING_VALUE",
|
|
261
264
|
* },
|
|
265
|
+
* repositoryCredentials: {
|
|
266
|
+
* credentialsParameter: "STRING_VALUE", // required
|
|
267
|
+
* },
|
|
262
268
|
* },
|
|
263
269
|
* },
|
|
264
270
|
* ],
|
|
@@ -265,6 +265,15 @@ export interface Ec2Configuration {
|
|
|
265
265
|
* (GPU)</a>: Default for all GPU instance families (for example <code>P4</code> and
|
|
266
266
|
* <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based instance types.</p>
|
|
267
267
|
* </dd>
|
|
268
|
+
* <dt>ECS_AL2023</dt>
|
|
269
|
+
* <dd>
|
|
270
|
+
* <p>
|
|
271
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon Linux 2023</a>: Batch
|
|
272
|
+
* supports Amazon Linux 2023.</p>
|
|
273
|
+
* <note>
|
|
274
|
+
* <p>Amazon Linux 2023 does not support <code>A1</code> instances.</p>
|
|
275
|
+
* </note>
|
|
276
|
+
* </dd>
|
|
268
277
|
* <dt>ECS_AL1</dt>
|
|
269
278
|
* <dd>
|
|
270
279
|
* <p>
|
|
@@ -356,7 +365,7 @@ export interface LaunchTemplateSpecification {
|
|
|
356
365
|
* isn't changed when the compute environment is updated. It's only changed if the
|
|
357
366
|
* <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
|
|
358
367
|
* <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or
|
|
359
|
-
*
|
|
368
|
+
* <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it
|
|
360
369
|
* might use a different version of the launch template. This is the case even if the launch
|
|
361
370
|
* template isn't specified in the update. When updating a compute environment, changing the launch
|
|
362
371
|
* template requires an infrastructure update of the compute environment. For more information, see
|
|
@@ -442,10 +451,12 @@ export interface ComputeResource {
|
|
|
442
451
|
* resources.</p>
|
|
443
452
|
* </dd>
|
|
444
453
|
* </dl>
|
|
445
|
-
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
454
|
+
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
455
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
456
|
+
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
457
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
458
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
459
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
449
460
|
*/
|
|
450
461
|
allocationStrategy?: CRAllocationStrategy;
|
|
451
462
|
/**
|
|
@@ -467,12 +478,12 @@ export interface ComputeResource {
|
|
|
467
478
|
* compute environment can
|
|
468
479
|
* support.</p>
|
|
469
480
|
* <note>
|
|
470
|
-
* <p>With <code>BEST_FIT_PROGRESSIVE</code
|
|
471
|
-
*
|
|
472
|
-
* using Spot Instances,
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
481
|
+
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
482
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
483
|
+
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
484
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
485
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
486
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
476
487
|
* </note>
|
|
477
488
|
*/
|
|
478
489
|
maxvCpus: number | undefined;
|
|
@@ -567,8 +578,8 @@ export interface ComputeResource {
|
|
|
567
578
|
ec2KeyPair?: string;
|
|
568
579
|
/**
|
|
569
580
|
* @public
|
|
570
|
-
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
|
571
|
-
* specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
|
|
581
|
+
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required
|
|
582
|
+
* for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
|
|
572
583
|
* <code>
|
|
573
584
|
* <i>ecsInstanceRole</i>
|
|
574
585
|
* </code> or
|
|
@@ -588,7 +599,7 @@ export interface ComputeResource {
|
|
|
588
599
|
* <code>\{ "Name": "Batch Instance - C4OnDemand" \}</code>. This is helpful for recognizing your
|
|
589
600
|
* Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to
|
|
590
601
|
* 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
|
|
591
|
-
*
|
|
602
|
+
* <i>Batch User Guide</i>. These tags aren't seen when using the Batch
|
|
592
603
|
* <code>ListTagsForResource</code> API operation.</p>
|
|
593
604
|
* <note>
|
|
594
605
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
@@ -773,12 +784,12 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
773
784
|
/**
|
|
774
785
|
* @public
|
|
775
786
|
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For
|
|
776
|
-
*
|
|
787
|
+
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
|
|
777
788
|
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
778
789
|
* <important>
|
|
779
790
|
* <p>If your account already created the Batch service-linked role, that role is used by default for your compute
|
|
780
|
-
*
|
|
781
|
-
*
|
|
791
|
+
* environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your
|
|
792
|
+
* account, and no role is specified here, the service attempts to create the Batch service-linked role in your
|
|
782
793
|
* account.</p>
|
|
783
794
|
* </important>
|
|
784
795
|
* <p>If your specified role has a path other than <code>/</code>, then you must specify either the full role ARN
|
|
@@ -787,7 +798,7 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
787
798
|
* and paths</a> in the <i>IAM User Guide</i>.</p>
|
|
788
799
|
* <note>
|
|
789
800
|
* <p>Depending on how you created your Batch service role, its ARN might contain the <code>service-role</code>
|
|
790
|
-
*
|
|
801
|
+
* path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
|
|
791
802
|
* <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service
|
|
792
803
|
* role when you create compute environments.</p>
|
|
793
804
|
* </note>
|
|
@@ -993,7 +1004,7 @@ export interface FairsharePolicy {
|
|
|
993
1004
|
* <i>ActiveFairShares</i>
|
|
994
1005
|
* </code> is the number of active fair share
|
|
995
1006
|
* identifiers.</p>
|
|
996
|
-
* <p>For example, a <code>computeReservation</code> value of 50 indicates that
|
|
1007
|
+
* <p>For example, a <code>computeReservation</code> value of 50 indicates that Batch reserves
|
|
997
1008
|
* 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if
|
|
998
1009
|
* there are two fair share identifiers. It reserves 12.5% if there are three fair share
|
|
999
1010
|
* identifiers. A <code>computeReservation</code> value of 25 indicates that Batch should reserve
|
|
@@ -1335,9 +1346,10 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
1335
1346
|
export interface DescribeJobDefinitionsRequest {
|
|
1336
1347
|
/**
|
|
1337
1348
|
* @public
|
|
1338
|
-
* <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the
|
|
1339
|
-
*
|
|
1340
|
-
*
|
|
1349
|
+
* <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the
|
|
1350
|
+
* format
|
|
1351
|
+
* <code>arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code>
|
|
1352
|
+
* or a short version using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>. This parameter can't be used with other parameters.</p>
|
|
1341
1353
|
*/
|
|
1342
1354
|
jobDefinitions?: string[];
|
|
1343
1355
|
/**
|
|
@@ -1750,7 +1762,7 @@ export interface LogConfiguration {
|
|
|
1750
1762
|
/**
|
|
1751
1763
|
* @public
|
|
1752
1764
|
* <p>Details for a Docker volume mount point that's used in a job's container properties. This
|
|
1753
|
-
* parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/
|
|
1765
|
+
* parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate">Create a container</a> section of the <i>Docker Remote API</i> and the
|
|
1754
1766
|
* <code>--volume</code> option to docker run.</p>
|
|
1755
1767
|
*/
|
|
1756
1768
|
export interface MountPoint {
|
|
@@ -1787,6 +1799,17 @@ export interface NetworkConfiguration {
|
|
|
1787
1799
|
*/
|
|
1788
1800
|
assignPublicIp?: AssignPublicIp;
|
|
1789
1801
|
}
|
|
1802
|
+
/**
|
|
1803
|
+
* @public
|
|
1804
|
+
* <p>The repository credentials for private registry authentication.</p>
|
|
1805
|
+
*/
|
|
1806
|
+
export interface RepositoryCredentials {
|
|
1807
|
+
/**
|
|
1808
|
+
* @public
|
|
1809
|
+
* <p>The Amazon Resource Name (ARN) of the secret containing the private repository credentials.</p>
|
|
1810
|
+
*/
|
|
1811
|
+
credentialsParameter: string | undefined;
|
|
1812
|
+
}
|
|
1790
1813
|
/**
|
|
1791
1814
|
* @public
|
|
1792
1815
|
* @enum
|
|
@@ -1979,53 +2002,70 @@ export interface ResourceRequirement {
|
|
|
1979
2002
|
}
|
|
1980
2003
|
/**
|
|
1981
2004
|
* @public
|
|
1982
|
-
* <p>
|
|
2005
|
+
* <p>
|
|
2006
|
+
* An object that represents the compute environment architecture for Batch jobs on Fargate.
|
|
2007
|
+
* </p>
|
|
1983
2008
|
*/
|
|
1984
2009
|
export interface RuntimePlatform {
|
|
1985
2010
|
/**
|
|
1986
2011
|
* @public
|
|
1987
2012
|
* <p>The operating system for the compute environment.
|
|
1988
2013
|
* Valid values are:
|
|
1989
|
-
*
|
|
1990
|
-
*
|
|
1991
|
-
*
|
|
2014
|
+
* <code>LINUX</code> (default), <code>WINDOWS_SERVER_2019_CORE</code>,
|
|
2015
|
+
* <code>WINDOWS_SERVER_2019_FULL</code>, <code>WINDOWS_SERVER_2022_CORE</code>, and
|
|
2016
|
+
* <code>WINDOWS_SERVER_2022_FULL</code>.</p>
|
|
1992
2017
|
* <note>
|
|
1993
2018
|
* <p>The following parameters can’t be set for Windows containers: <code>linuxParameters</code>,
|
|
1994
|
-
*
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
2019
|
+
* <code>privileged</code>, <code>user</code>, <code>ulimits</code>,
|
|
2020
|
+
* <code>readonlyRootFilesystem</code>,
|
|
2021
|
+
* and <code>efsVolumeConfiguration</code>.</p>
|
|
1997
2022
|
* </note>
|
|
1998
2023
|
* <note>
|
|
1999
|
-
* <p>The Batch Scheduler checks
|
|
2000
|
-
*
|
|
2001
|
-
*
|
|
2002
|
-
*
|
|
2024
|
+
* <p>The Batch Scheduler checks
|
|
2025
|
+
* the compute environments
|
|
2026
|
+
* that are attached to the job queue before registering a task definition with
|
|
2027
|
+
* Fargate. In this
|
|
2028
|
+
* scenario, the job queue is where the job is submitted. If the job requires a
|
|
2029
|
+
* Windows container and the first compute environment is <code>LINUX</code>, the compute
|
|
2030
|
+
* environment is skipped and the next compute environment is checked until a Windows-based compute
|
|
2031
|
+
* environment is found.</p>
|
|
2003
2032
|
* </note>
|
|
2004
2033
|
* <note>
|
|
2005
|
-
* <p>Fargate Spot is not supported for
|
|
2006
|
-
*
|
|
2007
|
-
*
|
|
2008
|
-
*
|
|
2009
|
-
*
|
|
2010
|
-
*
|
|
2034
|
+
* <p>Fargate Spot is not supported for
|
|
2035
|
+
* <code>ARM64</code> and
|
|
2036
|
+
* Windows-based containers on Fargate. A job queue will be blocked if a
|
|
2037
|
+
* Fargate
|
|
2038
|
+
* <code>ARM64</code> or
|
|
2039
|
+
* Windows job is submitted to a job queue with only Fargate Spot compute environments.
|
|
2040
|
+
* However, you can attach both <code>FARGATE</code> and
|
|
2041
|
+
* <code>FARGATE_SPOT</code> compute environments to the same job queue.</p>
|
|
2011
2042
|
* </note>
|
|
2012
2043
|
*/
|
|
2013
2044
|
operatingSystemFamily?: string;
|
|
2014
2045
|
/**
|
|
2015
2046
|
* @public
|
|
2016
|
-
* <p>
|
|
2017
|
-
*
|
|
2047
|
+
* <p>
|
|
2048
|
+
* The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
|
|
2049
|
+
* <code>X86_64</code> and <code>ARM64</code>.</p>
|
|
2018
2050
|
* <note>
|
|
2019
2051
|
* <p>This parameter must be set to
|
|
2020
2052
|
* <code>X86_64</code>
|
|
2021
2053
|
* for Windows containers.</p>
|
|
2022
2054
|
* </note>
|
|
2055
|
+
* <note>
|
|
2056
|
+
* <p>Fargate Spot is not supported for <code>ARM64</code> and Windows-based containers on
|
|
2057
|
+
* Fargate. A job queue will be blocked if a Fargate <code>ARM64</code> or Windows job is
|
|
2058
|
+
* submitted to a job queue with only Fargate Spot compute environments. However, you can attach
|
|
2059
|
+
* both <code>FARGATE</code> and <code>FARGATE_SPOT</code> compute environments to the same job
|
|
2060
|
+
* queue.</p>
|
|
2061
|
+
* </note>
|
|
2023
2062
|
*/
|
|
2024
2063
|
cpuArchitecture?: string;
|
|
2025
2064
|
}
|
|
2026
2065
|
/**
|
|
2027
2066
|
* @public
|
|
2028
|
-
* <p>The <code>ulimit</code> settings to pass to the container
|
|
2067
|
+
* <p>The <code>ulimit</code> settings to pass to the container. For more information, see
|
|
2068
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html">Ulimit</a>.</p>
|
|
2029
2069
|
* <note>
|
|
2030
2070
|
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
2031
2071
|
* </note>
|
|
@@ -2033,12 +2073,15 @@ export interface RuntimePlatform {
|
|
|
2033
2073
|
export interface Ulimit {
|
|
2034
2074
|
/**
|
|
2035
2075
|
* @public
|
|
2036
|
-
* <p>The hard limit for the <code>ulimit</code> type
|
|
2076
|
+
* <p>The hard limit for the <code>ulimit</code> type. </p>
|
|
2037
2077
|
*/
|
|
2038
2078
|
hardLimit: number | undefined;
|
|
2039
2079
|
/**
|
|
2040
2080
|
* @public
|
|
2041
|
-
* <p>The <code>type</code> of the <code>ulimit</code
|
|
2081
|
+
* <p>The <code>type</code> of the <code>ulimit</code>. Valid values are: <code>core</code> | <code>cpu</code> |
|
|
2082
|
+
* <code>data</code> | <code>fsize</code> | <code>locks</code> | <code>memlock</code> | <code>msgqueue</code> |
|
|
2083
|
+
* <code>nice</code> | <code>nofile</code> | <code>nproc</code> | <code>rss</code> | <code>rtprio</code> |
|
|
2084
|
+
* <code>rttime</code> | <code>sigpending</code> | <code>stack</code>.</p>
|
|
2042
2085
|
*/
|
|
2043
2086
|
name: string | undefined;
|
|
2044
2087
|
/**
|
|
@@ -2210,8 +2253,10 @@ export interface Volume {
|
|
|
2210
2253
|
export interface ContainerProperties {
|
|
2211
2254
|
/**
|
|
2212
2255
|
* @public
|
|
2213
|
-
* <p>
|
|
2214
|
-
*
|
|
2256
|
+
* <p>Required.
|
|
2257
|
+
* The image used to start a container. This string is passed directly to the
|
|
2258
|
+
* Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are
|
|
2259
|
+
* specified with
|
|
2215
2260
|
* <code>
|
|
2216
2261
|
* <i>repository-url</i>/<i>image</i>:<i>tag</i>
|
|
2217
2262
|
* </code>.
|
|
@@ -2445,6 +2490,11 @@ export interface ContainerProperties {
|
|
|
2445
2490
|
* <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
|
|
2446
2491
|
*/
|
|
2447
2492
|
runtimePlatform?: RuntimePlatform;
|
|
2493
|
+
/**
|
|
2494
|
+
* @public
|
|
2495
|
+
* <p>The private repository authentication credentials to use.</p>
|
|
2496
|
+
*/
|
|
2497
|
+
repositoryCredentials?: RepositoryCredentials;
|
|
2448
2498
|
}
|
|
2449
2499
|
/**
|
|
2450
2500
|
* @public
|
|
@@ -3046,7 +3096,7 @@ export interface JobTimeout {
|
|
|
3046
3096
|
/**
|
|
3047
3097
|
* @public
|
|
3048
3098
|
* <p>The job timeout time (in seconds) that's measured from the job attempt's
|
|
3049
|
-
*
|
|
3099
|
+
* <code>startedAt</code> timestamp. After this time passes, Batch terminates your jobs if they
|
|
3050
3100
|
* aren't finished. The minimum value for the timeout is 60 seconds.</p>
|
|
3051
3101
|
* <p>For array jobs, the timeout applies to the child jobs, not to the parent array job.</p>
|
|
3052
3102
|
* <p>For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the
|
|
@@ -3555,6 +3605,11 @@ export interface ContainerDetail {
|
|
|
3555
3605
|
* <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
|
|
3556
3606
|
*/
|
|
3557
3607
|
runtimePlatform?: RuntimePlatform;
|
|
3608
|
+
/**
|
|
3609
|
+
* @public
|
|
3610
|
+
* <p>The private repository authentication credentials to use.</p>
|
|
3611
|
+
*/
|
|
3612
|
+
repositoryCredentials?: RepositoryCredentials;
|
|
3558
3613
|
}
|
|
3559
3614
|
/**
|
|
3560
3615
|
* @public
|
|
@@ -3785,7 +3840,7 @@ export interface EksPodPropertiesDetail {
|
|
|
3785
3840
|
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
|
|
3786
3841
|
* that a pod runs in or the <code>jobID</code> for a job running in the pod. For more information,
|
|
3787
3842
|
* see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes
|
|
3788
|
-
*
|
|
3843
|
+
* documentation</i>.</p>
|
|
3789
3844
|
*/
|
|
3790
3845
|
metadata?: EksMetadata;
|
|
3791
3846
|
}
|
|
@@ -3909,7 +3964,7 @@ export interface JobDetail {
|
|
|
3909
3964
|
* @public
|
|
3910
3965
|
* <p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's
|
|
3911
3966
|
* when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.
|
|
3912
|
-
*
|
|
3967
|
+
* </p>
|
|
3913
3968
|
*/
|
|
3914
3969
|
startedAt: number | undefined;
|
|
3915
3970
|
/**
|
|
@@ -4770,9 +4825,12 @@ export interface SubmitJobRequest {
|
|
|
4770
4825
|
shareIdentifier?: string;
|
|
4771
4826
|
/**
|
|
4772
4827
|
* @public
|
|
4773
|
-
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair share
|
|
4774
|
-
*
|
|
4775
|
-
*
|
|
4828
|
+
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair share
|
|
4829
|
+
* policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
4830
|
+
* scheduling priority.
|
|
4831
|
+
* This
|
|
4832
|
+
* overrides any scheduling priority in the job definition and works only within a single share
|
|
4833
|
+
* identifier.</p>
|
|
4776
4834
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
4777
4835
|
*/
|
|
4778
4836
|
schedulingPriorityOverride?: number;
|
|
@@ -4848,7 +4906,7 @@ export interface SubmitJobRequest {
|
|
|
4848
4906
|
/**
|
|
4849
4907
|
* @public
|
|
4850
4908
|
* <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration
|
|
4851
|
-
*
|
|
4909
|
+
* after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't
|
|
4852
4910
|
* retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration
|
|
4853
4911
|
* specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job.
|
|
4854
4912
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html">Job
|
|
@@ -4992,12 +5050,12 @@ export interface ComputeResourceUpdate {
|
|
|
4992
5050
|
* @public
|
|
4993
5051
|
* <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
|
|
4994
5052
|
* <note>
|
|
4995
|
-
* <p>With <code>BEST_FIT_PROGRESSIVE</code
|
|
4996
|
-
*
|
|
4997
|
-
* using Spot Instances,
|
|
4998
|
-
*
|
|
4999
|
-
*
|
|
5000
|
-
*
|
|
5053
|
+
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
5054
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
5055
|
+
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
5056
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
5057
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
5058
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
5001
5059
|
* </note>
|
|
5002
5060
|
*/
|
|
5003
5061
|
maxvCpus?: number;
|
|
@@ -5092,10 +5150,12 @@ export interface ComputeResourceUpdate {
|
|
|
5092
5150
|
* resources.</p>
|
|
5093
5151
|
* </dd>
|
|
5094
5152
|
* </dl>
|
|
5095
|
-
* <p>With
|
|
5096
|
-
*
|
|
5097
|
-
*
|
|
5098
|
-
*
|
|
5153
|
+
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
5154
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
5155
|
+
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
5156
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
5157
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
5158
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
5099
5159
|
*/
|
|
5100
5160
|
allocationStrategy?: CRUpdateAllocationStrategy;
|
|
5101
5161
|
/**
|
|
@@ -5138,9 +5198,10 @@ export interface ComputeResourceUpdate {
|
|
|
5138
5198
|
ec2KeyPair?: string;
|
|
5139
5199
|
/**
|
|
5140
5200
|
* @public
|
|
5141
|
-
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
|
5142
|
-
*
|
|
5143
|
-
*
|
|
5201
|
+
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
|
5202
|
+
* Required for Amazon EC2
|
|
5203
|
+
* instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance
|
|
5204
|
+
* profile. For example, <code>
|
|
5144
5205
|
* <i>ecsInstanceRole</i>
|
|
5145
5206
|
* </code> or
|
|
5146
5207
|
* <code>arn:aws:iam::<i><aws_account_id></i>:instance-profile/<i>ecsInstanceRole</i>
|
|
@@ -5343,7 +5404,7 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
5343
5404
|
/**
|
|
5344
5405
|
* @public
|
|
5345
5406
|
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.
|
|
5346
|
-
*
|
|
5407
|
+
* For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
|
|
5347
5408
|
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
5348
5409
|
* <important>
|
|
5349
5410
|
* <p>If the compute environment has a service-linked role, it can't be changed to use a regular IAM role.
|
|
@@ -5356,7 +5417,7 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
5356
5417
|
* (recommended) or prefix the role name with the path.</p>
|
|
5357
5418
|
* <note>
|
|
5358
5419
|
* <p>Depending on how you created your Batch service role, its ARN might contain the <code>service-role</code>
|
|
5359
|
-
*
|
|
5420
|
+
* path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
|
|
5360
5421
|
* <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service
|
|
5361
5422
|
* role when you create compute environments.</p>
|
|
5362
5423
|
* </note>
|
|
@@ -299,6 +299,9 @@ export interface MountPoint {
|
|
|
299
299
|
export interface NetworkConfiguration {
|
|
300
300
|
assignPublicIp?: AssignPublicIp;
|
|
301
301
|
}
|
|
302
|
+
export interface RepositoryCredentials {
|
|
303
|
+
credentialsParameter: string | undefined;
|
|
304
|
+
}
|
|
302
305
|
export declare const ResourceType: {
|
|
303
306
|
readonly GPU: "GPU";
|
|
304
307
|
readonly MEMORY: "MEMORY";
|
|
@@ -372,6 +375,7 @@ export interface ContainerProperties {
|
|
|
372
375
|
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
373
376
|
ephemeralStorage?: EphemeralStorage;
|
|
374
377
|
runtimePlatform?: RuntimePlatform;
|
|
378
|
+
repositoryCredentials?: RepositoryCredentials;
|
|
375
379
|
}
|
|
376
380
|
export interface EksContainerEnvironmentVariable {
|
|
377
381
|
name: string | undefined;
|
|
@@ -551,6 +555,7 @@ export interface ContainerDetail {
|
|
|
551
555
|
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
552
556
|
ephemeralStorage?: EphemeralStorage;
|
|
553
557
|
runtimePlatform?: RuntimePlatform;
|
|
558
|
+
repositoryCredentials?: RepositoryCredentials;
|
|
554
559
|
}
|
|
555
560
|
export interface JobDependency {
|
|
556
561
|
jobId?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-batch",
|
|
3
3
|
"description": "AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.511.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-batch",
|
|
@@ -20,19 +20,19 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/core": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
32
|
-
"@aws-sdk/types": "3.
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.511.0",
|
|
24
|
+
"@aws-sdk/core": "3.511.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.511.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.511.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.511.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.511.0",
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.511.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.511.0",
|
|
31
|
+
"@aws-sdk/region-config-resolver": "3.511.0",
|
|
32
|
+
"@aws-sdk/types": "3.511.0",
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.511.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-browser": "3.511.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.511.0",
|
|
36
36
|
"@smithy/config-resolver": "^2.1.1",
|
|
37
37
|
"@smithy/core": "^1.3.1",
|
|
38
38
|
"@smithy/fetch-http-handler": "^2.4.1",
|