@aws-sdk/client-batch 3.751.0 → 3.758.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/README.md +48 -0
  2. package/dist-cjs/index.js +318 -0
  3. package/dist-es/Batch.js +12 -0
  4. package/dist-es/commands/CreateConsumableResourceCommand.js +22 -0
  5. package/dist-es/commands/DeleteConsumableResourceCommand.js +22 -0
  6. package/dist-es/commands/DescribeConsumableResourceCommand.js +22 -0
  7. package/dist-es/commands/ListConsumableResourcesCommand.js +22 -0
  8. package/dist-es/commands/ListJobsByConsumableResourceCommand.js +22 -0
  9. package/dist-es/commands/UpdateConsumableResourceCommand.js +22 -0
  10. package/dist-es/commands/index.js +6 -0
  11. package/dist-es/pagination/ListConsumableResourcesPaginator.js +4 -0
  12. package/dist-es/pagination/ListJobsByConsumableResourcePaginator.js +4 -0
  13. package/dist-es/pagination/index.js +2 -0
  14. package/dist-es/protocols/Aws_restJson1.js +186 -0
  15. package/dist-types/Batch.d.ts +43 -0
  16. package/dist-types/BatchClient.d.ts +8 -2
  17. package/dist-types/commands/CreateConsumableResourceCommand.d.ts +108 -0
  18. package/dist-types/commands/DeleteConsumableResourceCommand.d.ts +88 -0
  19. package/dist-types/commands/DescribeConsumableResourceCommand.d.ts +114 -0
  20. package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeJobsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListConsumableResourcesCommand.d.ts +129 -0
  23. package/dist-types/commands/ListJobsByConsumableResourceCommand.d.ts +154 -0
  24. package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +16 -0
  25. package/dist-types/commands/SubmitJobCommand.d.ts +17 -1
  26. package/dist-types/commands/UpdateConsumableResourceCommand.d.ts +104 -0
  27. package/dist-types/commands/index.d.ts +6 -0
  28. package/dist-types/models/models_0.d.ts +589 -40
  29. package/dist-types/pagination/ListConsumableResourcesPaginator.d.ts +7 -0
  30. package/dist-types/pagination/ListJobsByConsumableResourcePaginator.d.ts +7 -0
  31. package/dist-types/pagination/index.d.ts +2 -0
  32. package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
  33. package/dist-types/ts3.4/Batch.d.ts +103 -0
  34. package/dist-types/ts3.4/BatchClient.d.ts +36 -0
  35. package/dist-types/ts3.4/commands/CreateConsumableResourceCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/DeleteConsumableResourceCommand.d.ts +51 -0
  37. package/dist-types/ts3.4/commands/DescribeConsumableResourceCommand.d.ts +51 -0
  38. package/dist-types/ts3.4/commands/ListConsumableResourcesCommand.d.ts +51 -0
  39. package/dist-types/ts3.4/commands/ListJobsByConsumableResourceCommand.d.ts +51 -0
  40. package/dist-types/ts3.4/commands/UpdateConsumableResourceCommand.d.ts +51 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  42. package/dist-types/ts3.4/models/models_0.d.ts +94 -0
  43. package/dist-types/ts3.4/pagination/ListConsumableResourcesPaginator.d.ts +11 -0
  44. package/dist-types/ts3.4/pagination/ListJobsByConsumableResourcePaginator.d.ts +11 -0
  45. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  46. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
  47. package/package.json +15 -13
@@ -908,8 +908,8 @@ export interface CreateComputeEnvironmentRequest {
908
908
  state?: CEState | undefined;
909
909
  /**
910
910
  * <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only
911
- * used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this
912
- * parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.</p>
911
+ * used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this
912
+ * parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>
913
913
  * <note>
914
914
  * <p>This parameter is only supported when the <code>type</code> parameter is set to
915
915
  * <code>UNMANAGED</code>.</p>
@@ -986,6 +986,59 @@ export interface CreateComputeEnvironmentResponse {
986
986
  */
987
987
  computeEnvironmentArn?: string | undefined;
988
988
  }
989
+ /**
990
+ * @public
991
+ */
992
+ export interface CreateConsumableResourceRequest {
993
+ /**
994
+ * <p>The name of the consumable resource. Must be unique.</p>
995
+ * @public
996
+ */
997
+ consumableResourceName: string | undefined;
998
+ /**
999
+ * <p>The total amount of the consumable resource that is available. Must be non-negative.</p>
1000
+ * @public
1001
+ */
1002
+ totalQuantity?: number | undefined;
1003
+ /**
1004
+ * <p>Indicates whether the resource is available to be re-used after a job completes. Can be
1005
+ * one of: </p>
1006
+ * <ul>
1007
+ * <li>
1008
+ * <p>
1009
+ * <code>REPLENISHABLE</code> (default)</p>
1010
+ * </li>
1011
+ * <li>
1012
+ * <p>
1013
+ * <code>NON_REPLENISHABLE</code>
1014
+ * </p>
1015
+ * </li>
1016
+ * </ul>
1017
+ * @public
1018
+ */
1019
+ resourceType?: string | undefined;
1020
+ /**
1021
+ * <p>The tags that you apply to the consumable resource to help you categorize and organize your
1022
+ * resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
1023
+ * @public
1024
+ */
1025
+ tags?: Record<string, string> | undefined;
1026
+ }
1027
+ /**
1028
+ * @public
1029
+ */
1030
+ export interface CreateConsumableResourceResponse {
1031
+ /**
1032
+ * <p>The name of the consumable resource.</p>
1033
+ * @public
1034
+ */
1035
+ consumableResourceName: string | undefined;
1036
+ /**
1037
+ * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
1038
+ * @public
1039
+ */
1040
+ consumableResourceArn: string | undefined;
1041
+ }
989
1042
  /**
990
1043
  * <p>The order that compute environments are tried in for job placement within a queue. Compute
991
1044
  * environments are tried in ascending order. For example, if two compute environments are
@@ -1096,13 +1149,13 @@ export interface CreateJobQueueRequest {
1096
1149
  */
1097
1150
  state?: JQState | undefined;
1098
1151
  /**
1099
- * <p>The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed.</p>
1152
+ * <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. Job queues that don't have a scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a scheduling policy, it can be replaced but can't be removed.</p>
1100
1153
  * <p>The format is
1101
1154
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
1102
1155
  * </code>.</p>
1103
1156
  * <p>An example is
1104
1157
  * <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
1105
- * <p>A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail.</p>
1158
+ * <p>A job queue without a scheduling policy is scheduled as a FIFO job queue and can't have a scheduling policy added. Jobs queues with a scheduling policy can have a maximum of 500 active fair share identifiers. When the limit has been reached, submissions of any jobs that add a new fair share identifier fail.</p>
1106
1159
  * @public
1107
1160
  */
1108
1161
  schedulingPolicyArn?: string | undefined;
@@ -1162,25 +1215,25 @@ export interface CreateJobQueueResponse {
1162
1215
  jobQueueArn: string | undefined;
1163
1216
  }
1164
1217
  /**
1165
- * <p>Specifies the weights for the share identifiers for the fair-share policy. Share
1218
+ * <p>Specifies the weights for the fair share identifiers for the fair share policy. Fair share
1166
1219
  * identifiers that aren't included have a default weight of <code>1.0</code>.</p>
1167
1220
  * @public
1168
1221
  */
1169
1222
  export interface ShareAttributes {
1170
1223
  /**
1171
- * <p>A share identifier or share identifier prefix. If the string ends with an asterisk
1172
- * (*), this entry specifies the weight factor to use for share identifiers that start with
1173
- * that prefix. The list of share identifiers in a fair-share policy can't overlap. For
1224
+ * <p>A fair share identifier or fair share identifier prefix. If the string ends with an asterisk
1225
+ * (*), this entry specifies the weight factor to use for fair share identifiers that start with
1226
+ * that prefix. The list of fair share identifiers in a fair share policy can't overlap. For
1174
1227
  * example, you can't have one that specifies a <code>shareIdentifier</code> of <code>UserA*</code>
1175
1228
  * and another that specifies a <code>shareIdentifier</code> of <code>UserA-1</code>.</p>
1176
- * <p>There can be no more than 500 share identifiers active in a job queue.</p>
1229
+ * <p>There can be no more than 500 fair share identifiers active in a job queue.</p>
1177
1230
  * <p>The string is limited to 255 alphanumeric characters, and can be followed by an asterisk
1178
1231
  * (*).</p>
1179
1232
  * @public
1180
1233
  */
1181
1234
  shareIdentifier: string | undefined;
1182
1235
  /**
1183
- * <p>The weight factor for the share identifier. The default value is 1.0. A lower value has
1236
+ * <p>The weight factor for the fair share identifier. The default value is 1.0. A lower value has
1184
1237
  * a higher priority for compute resources. For example, jobs that use a share identifier with a
1185
1238
  * weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share
1186
1239
  * identifier with a weight factor of 1.</p>
@@ -1190,12 +1243,12 @@ export interface ShareAttributes {
1190
1243
  weightFactor?: number | undefined;
1191
1244
  }
1192
1245
  /**
1193
- * <p>The fair-share scheduling policy details.</p>
1246
+ * <p>The fair share policy for a scheduling policy.</p>
1194
1247
  * @public
1195
1248
  */
1196
1249
  export interface FairsharePolicy {
1197
1250
  /**
1198
- * <p>The amount of time (in seconds) to use to calculate a fair-share percentage for each
1251
+ * <p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair
1199
1252
  * share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds).
1200
1253
  * The maximum supported value is 604800 (1 week).</p>
1201
1254
  * <p>The decay allows for more recently run jobs to have more weight than jobs that ran earlier.
@@ -1206,28 +1259,28 @@ export interface FairsharePolicy {
1206
1259
  */
1207
1260
  shareDecaySeconds?: number | undefined;
1208
1261
  /**
1209
- * <p>A value used to reserve some of the available maximum vCPU for share identifiers that
1262
+ * <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that
1210
1263
  * aren't already used.</p>
1211
1264
  * <p>The reserved ratio is
1212
1265
  * <code>(<i>computeReservation</i>/100)^<i>ActiveFairShares</i>
1213
1266
  * </code>
1214
1267
  * where <code>
1215
1268
  * <i>ActiveFairShares</i>
1216
- * </code> is the number of active share
1269
+ * </code> is the number of active fair share
1217
1270
  * identifiers.</p>
1218
1271
  * <p>For example, a <code>computeReservation</code> value of 50 indicates that Batch reserves
1219
- * 50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if
1220
- * there are two share identifiers. It reserves 12.5% if there are three share
1272
+ * 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if
1273
+ * there are two fair share identifiers. It reserves 12.5% if there are three fair share
1221
1274
  * identifiers. A <code>computeReservation</code> value of 25 indicates that Batch should reserve
1222
- * 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are
1223
- * two fair share identifiers, and 1.56% if there are three share identifiers.</p>
1275
+ * 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are
1276
+ * two fair share identifiers, and 1.56% if there are three fair share identifiers.</p>
1224
1277
  * <p>The minimum value is 0 and the maximum value is 99.</p>
1225
1278
  * @public
1226
1279
  */
1227
1280
  computeReservation?: number | undefined;
1228
1281
  /**
1229
- * <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the
1230
- * share identifiers for the fair-share policy. Share identifiers that aren't included have a
1282
+ * <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair
1283
+ * share identifiers for the fair share policy. Fair share identifiers that aren't included have a
1231
1284
  * default weight of <code>1.0</code>.</p>
1232
1285
  * @public
1233
1286
  */
@@ -1239,13 +1292,13 @@ export interface FairsharePolicy {
1239
1292
  */
1240
1293
  export interface CreateSchedulingPolicyRequest {
1241
1294
  /**
1242
- * <p>The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain
1295
+ * <p>The name of the scheduling policy. It can be up to 128 letters long. It can contain
1243
1296
  * uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
1244
1297
  * @public
1245
1298
  */
1246
1299
  name: string | undefined;
1247
1300
  /**
1248
- * <p>The fair-share scheduling policy details.</p>
1301
+ * <p>The fair share policy of the scheduling policy.</p>
1249
1302
  * @public
1250
1303
  */
1251
1304
  fairsharePolicy?: FairsharePolicy | undefined;
@@ -1293,6 +1346,21 @@ export interface DeleteComputeEnvironmentRequest {
1293
1346
  */
1294
1347
  export interface DeleteComputeEnvironmentResponse {
1295
1348
  }
1349
+ /**
1350
+ * @public
1351
+ */
1352
+ export interface DeleteConsumableResourceRequest {
1353
+ /**
1354
+ * <p>The name or ARN of the consumable resource that will be deleted.</p>
1355
+ * @public
1356
+ */
1357
+ consumableResource: string | undefined;
1358
+ }
1359
+ /**
1360
+ * @public
1361
+ */
1362
+ export interface DeleteConsumableResourceResponse {
1363
+ }
1296
1364
  /**
1297
1365
  * <p>Contains the parameters for <code>DeleteJobQueue</code>.</p>
1298
1366
  * @public
@@ -1561,6 +1629,75 @@ export interface DescribeComputeEnvironmentsResponse {
1561
1629
  */
1562
1630
  nextToken?: string | undefined;
1563
1631
  }
1632
+ /**
1633
+ * @public
1634
+ */
1635
+ export interface DescribeConsumableResourceRequest {
1636
+ /**
1637
+ * <p>The name or ARN of the consumable resource whose description will be returned.</p>
1638
+ * @public
1639
+ */
1640
+ consumableResource: string | undefined;
1641
+ }
1642
+ /**
1643
+ * @public
1644
+ */
1645
+ export interface DescribeConsumableResourceResponse {
1646
+ /**
1647
+ * <p>The name of the consumable resource.</p>
1648
+ * @public
1649
+ */
1650
+ consumableResourceName: string | undefined;
1651
+ /**
1652
+ * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
1653
+ * @public
1654
+ */
1655
+ consumableResourceArn: string | undefined;
1656
+ /**
1657
+ * <p>The total amount of the consumable resource that is available.</p>
1658
+ * @public
1659
+ */
1660
+ totalQuantity?: number | undefined;
1661
+ /**
1662
+ * <p>The amount of the consumable resource that is currently in use.</p>
1663
+ * @public
1664
+ */
1665
+ inUseQuantity?: number | undefined;
1666
+ /**
1667
+ * <p>The amount of the consumable resource that is currently available to use.</p>
1668
+ * @public
1669
+ */
1670
+ availableQuantity?: number | undefined;
1671
+ /**
1672
+ * <p>Indicates whether the resource is available to be re-used after a job completes. Can be
1673
+ * one of: </p>
1674
+ * <ul>
1675
+ * <li>
1676
+ * <p>
1677
+ * <code>REPLENISHABLE</code>
1678
+ * </p>
1679
+ * </li>
1680
+ * <li>
1681
+ * <p>
1682
+ * <code>NON_REPLENISHABLE</code>
1683
+ * </p>
1684
+ * </li>
1685
+ * </ul>
1686
+ * @public
1687
+ */
1688
+ resourceType?: string | undefined;
1689
+ /**
1690
+ * <p>The Unix timestamp (in milliseconds) for when the consumable resource was created.</p>
1691
+ * @public
1692
+ */
1693
+ createdAt?: number | undefined;
1694
+ /**
1695
+ * <p>The tags that you apply to the consumable resource to help you categorize and organize your
1696
+ * resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
1697
+ * @public
1698
+ */
1699
+ tags?: Record<string, string> | undefined;
1700
+ }
1564
1701
  /**
1565
1702
  * <p>Contains the parameters for <code>DescribeJobDefinitions</code>.</p>
1566
1703
  * @public
@@ -1611,6 +1748,33 @@ export interface DescribeJobDefinitionsRequest {
1611
1748
  */
1612
1749
  nextToken?: string | undefined;
1613
1750
  }
1751
+ /**
1752
+ * <p>Information about a consumable resource required to run a job.</p>
1753
+ * @public
1754
+ */
1755
+ export interface ConsumableResourceRequirement {
1756
+ /**
1757
+ * <p>The name or ARN of the consumable resource.</p>
1758
+ * @public
1759
+ */
1760
+ consumableResource?: string | undefined;
1761
+ /**
1762
+ * <p>The quantity of the consumable resource that is needed.</p>
1763
+ * @public
1764
+ */
1765
+ quantity?: number | undefined;
1766
+ }
1767
+ /**
1768
+ * <p>Contains a list of consumable resources required by a job.</p>
1769
+ * @public
1770
+ */
1771
+ export interface ConsumableResourceProperties {
1772
+ /**
1773
+ * <p>The list of consumable resources required by a job.</p>
1774
+ * @public
1775
+ */
1776
+ consumableResourceList?: ConsumableResourceRequirement[] | undefined;
1777
+ }
1614
1778
  /**
1615
1779
  * <p>A key-value pair object.</p>
1616
1780
  * @public
@@ -1793,7 +1957,7 @@ export interface LinuxParameters {
1793
1957
  * <p>If a <code>maxSwap</code> value of <code>0</code> is specified, the container doesn't use
1794
1958
  * swap. Accepted values are <code>0</code> or any positive integer. If the <code>maxSwap</code>
1795
1959
  * parameter is omitted, the container doesn't use the swap configuration for the container instance
1796
- * on which it runs. A <code>maxSwap</code> value must be set for the <code>swappiness</code>
1960
+ * that it's running on. A <code>maxSwap</code> value must be set for the <code>swappiness</code>
1797
1961
  * parameter to be used.</p>
1798
1962
  * <note>
1799
1963
  * <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't
@@ -3722,6 +3886,11 @@ export interface NodeRangeProperty {
3722
3886
  * @public
3723
3887
  */
3724
3888
  eksProperties?: EksProperties | undefined;
3889
+ /**
3890
+ * <p>Contains a list of consumable resources required by a job.</p>
3891
+ * @public
3892
+ */
3893
+ consumableResourceProperties?: ConsumableResourceProperties | undefined;
3725
3894
  }
3726
3895
  /**
3727
3896
  * <p>An object that represents the node properties of a multi-node parallel job.</p>
@@ -3886,7 +4055,7 @@ export interface JobDefinition {
3886
4055
  type: string | undefined;
3887
4056
  /**
3888
4057
  * <p>The scheduling priority of the job definition. This only affects jobs in job queues with a
3889
- * fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
4058
+ * fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
3890
4059
  * scheduling priority.</p>
3891
4060
  * @public
3892
4061
  */
@@ -3974,6 +4143,11 @@ export interface JobDefinition {
3974
4143
  * @public
3975
4144
  */
3976
4145
  containerOrchestrationType?: OrchestrationType | undefined;
4146
+ /**
4147
+ * <p>Contains a list of consumable resources required by the job.</p>
4148
+ * @public
4149
+ */
4150
+ consumableResourceProperties?: ConsumableResourceProperties | undefined;
3977
4151
  }
3978
4152
  /**
3979
4153
  * @public
@@ -5101,7 +5275,7 @@ export interface JobDetail {
5101
5275
  shareIdentifier?: string | undefined;
5102
5276
  /**
5103
5277
  * <p>The scheduling policy of the job definition. This only affects jobs in job queues with a
5104
- * fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
5278
+ * fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
5105
5279
  * scheduling priority.</p>
5106
5280
  * @public
5107
5281
  */
@@ -5259,6 +5433,11 @@ export interface JobDetail {
5259
5433
  * @public
5260
5434
  */
5261
5435
  isTerminated?: boolean | undefined;
5436
+ /**
5437
+ * <p>Contains a list of consumable resources required by the job.</p>
5438
+ * @public
5439
+ */
5440
+ consumableResourceProperties?: ConsumableResourceProperties | undefined;
5262
5441
  }
5263
5442
  /**
5264
5443
  * @public
@@ -5287,7 +5466,7 @@ export interface DescribeSchedulingPoliciesRequest {
5287
5466
  */
5288
5467
  export interface SchedulingPolicyDetail {
5289
5468
  /**
5290
- * <p>The name of the fair-share scheduling policy.</p>
5469
+ * <p>The name of the scheduling policy.</p>
5291
5470
  * @public
5292
5471
  */
5293
5472
  name: string | undefined;
@@ -5299,12 +5478,12 @@ export interface SchedulingPolicyDetail {
5299
5478
  */
5300
5479
  arn: string | undefined;
5301
5480
  /**
5302
- * <p>The fair-share scheduling policy details.</p>
5481
+ * <p>The fair share policy for the scheduling policy.</p>
5303
5482
  * @public
5304
5483
  */
5305
5484
  fairsharePolicy?: FairsharePolicy | undefined;
5306
5485
  /**
5307
- * <p>The tags that you apply to the fair-share scheduling policy to categorize and organize your resources.
5486
+ * <p>The tags that you apply to the scheduling policy to categorize and organize your resources.
5308
5487
  * Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
5309
5488
  * <i>Amazon Web Services General Reference</i>.</p>
5310
5489
  * @public
@@ -5353,7 +5532,7 @@ export interface FrontOfQueueJobSummary {
5353
5532
  */
5354
5533
  export interface FrontOfQueueDetail {
5355
5534
  /**
5356
- * <p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
5535
+ * <p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
5357
5536
  * @public
5358
5537
  */
5359
5538
  jobs?: FrontOfQueueJobSummary[] | undefined;
@@ -5368,14 +5547,14 @@ export interface FrontOfQueueDetail {
5368
5547
  */
5369
5548
  export interface GetJobQueueSnapshotResponse {
5370
5549
  /**
5371
- * <p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
5550
+ * <p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
5372
5551
  * @public
5373
5552
  */
5374
5553
  frontOfQueue?: FrontOfQueueDetail | undefined;
5375
5554
  }
5376
5555
  /**
5377
5556
  * <p>A filter name and value pair that's used to return a more specific list of results from a
5378
- * <code>ListJobs</code> API operation.</p>
5557
+ * <code>ListJobs</code> or <code>ListJobsByConsumableResource</code> API operation.</p>
5379
5558
  * @public
5380
5559
  */
5381
5560
  export interface KeyValuesPair {
@@ -5390,6 +5569,113 @@ export interface KeyValuesPair {
5390
5569
  */
5391
5570
  values?: string[] | undefined;
5392
5571
  }
5572
+ /**
5573
+ * @public
5574
+ */
5575
+ export interface ListConsumableResourcesRequest {
5576
+ /**
5577
+ * <p>The filters to apply to the consumable resource list query. If used, only those consumable
5578
+ * resources that match the filter are listed. Filter names and values can be:</p>
5579
+ * <ul>
5580
+ * <li>
5581
+ * <p>name: <code>CONSUMABLE_RESOURCE_NAME </code>
5582
+ * </p>
5583
+ * <p>values: case-insensitive matches for the consumable resource name. If a filter
5584
+ * value ends with an asterisk (*), it matches any consumable resource name that begins
5585
+ * with the string before the '*'.</p>
5586
+ * </li>
5587
+ * </ul>
5588
+ * @public
5589
+ */
5590
+ filters?: KeyValuesPair[] | undefined;
5591
+ /**
5592
+ * <p>The maximum number of results returned by <code>ListConsumableResources</code> in paginated
5593
+ * output. When this parameter is used, <code>ListConsumableResources</code> only returns
5594
+ * <code>maxResults</code> results in a single page and a <code>nextToken</code> response
5595
+ * element. The remaining results of the initial request can be seen by sending another
5596
+ * <code>ListConsumableResources</code> request with the returned <code>nextToken</code> value.
5597
+ * This value can be between 1 and 100. If this parameter isn't
5598
+ * used, then <code>ListConsumableResources</code> returns up to 100 results and
5599
+ * a <code>nextToken</code> value if applicable.</p>
5600
+ * @public
5601
+ */
5602
+ maxResults?: number | undefined;
5603
+ /**
5604
+ * <p>The <code>nextToken</code> value returned from a previous paginated
5605
+ * <code>ListConsumableResources</code> request where <code>maxResults</code> was used and the
5606
+ * results exceeded the value of that parameter. Pagination continues from the end of the previous
5607
+ * results that returned the <code>nextToken</code> value. This value is <code>null</code> when
5608
+ * there are no more results to return.</p>
5609
+ * <note>
5610
+ * <p>Treat this token as an opaque identifier that's only used to
5611
+ * retrieve the next items in a list and not for other programmatic purposes.</p>
5612
+ * </note>
5613
+ * @public
5614
+ */
5615
+ nextToken?: string | undefined;
5616
+ }
5617
+ /**
5618
+ * <p>Current information about a consumable resource.</p>
5619
+ * @public
5620
+ */
5621
+ export interface ConsumableResourceSummary {
5622
+ /**
5623
+ * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
5624
+ * @public
5625
+ */
5626
+ consumableResourceArn: string | undefined;
5627
+ /**
5628
+ * <p>The name of the consumable resource.</p>
5629
+ * @public
5630
+ */
5631
+ consumableResourceName: string | undefined;
5632
+ /**
5633
+ * <p>The total amount of the consumable resource that is available.</p>
5634
+ * @public
5635
+ */
5636
+ totalQuantity?: number | undefined;
5637
+ /**
5638
+ * <p>The amount of the consumable resource that is currently in use.</p>
5639
+ * @public
5640
+ */
5641
+ inUseQuantity?: number | undefined;
5642
+ /**
5643
+ * <p>Indicates whether the resource is available to be re-used after a job completes. Can be
5644
+ * one of: </p>
5645
+ * <ul>
5646
+ * <li>
5647
+ * <p>
5648
+ * <code>REPLENISHABLE</code>
5649
+ * </p>
5650
+ * </li>
5651
+ * <li>
5652
+ * <p>
5653
+ * <code>NON_REPLENISHABLE</code>
5654
+ * </p>
5655
+ * </li>
5656
+ * </ul>
5657
+ * @public
5658
+ */
5659
+ resourceType?: string | undefined;
5660
+ }
5661
+ /**
5662
+ * @public
5663
+ */
5664
+ export interface ListConsumableResourcesResponse {
5665
+ /**
5666
+ * <p>A list of consumable resources that match the request.</p>
5667
+ * @public
5668
+ */
5669
+ consumableResources: ConsumableResourceSummary[] | undefined;
5670
+ /**
5671
+ * <p>The <code>nextToken</code> value to include in a future <code>ListConsumableResources</code>
5672
+ * request. When the results of a <code>ListConsumableResources</code> request exceed <code>maxResults</code>,
5673
+ * this value can be used to retrieve the next page of results. This value is <code>null</code>
5674
+ * when there are no more results to return.</p>
5675
+ * @public
5676
+ */
5677
+ nextToken?: string | undefined;
5678
+ }
5393
5679
  /**
5394
5680
  * <p>Contains the parameters for <code>ListJobs</code>.</p>
5395
5681
  * @public
@@ -5638,6 +5924,180 @@ export interface ListJobsResponse {
5638
5924
  */
5639
5925
  nextToken?: string | undefined;
5640
5926
  }
5927
+ /**
5928
+ * @public
5929
+ */
5930
+ export interface ListJobsByConsumableResourceRequest {
5931
+ /**
5932
+ * <p>The name or ARN of the consumable resource.</p>
5933
+ * @public
5934
+ */
5935
+ consumableResource: string | undefined;
5936
+ /**
5937
+ * <p>The filters to apply to the job list query. If used, only those jobs requiring the specified
5938
+ * consumable resource (<code>consumableResource</code>) and that match the value of the filters
5939
+ * are listed. The filter names and values can be:</p>
5940
+ * <ul>
5941
+ * <li>
5942
+ * <p>name: <code>JOB_STATUS</code>
5943
+ * </p>
5944
+ * <p>values: <code>SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED</code>
5945
+ * </p>
5946
+ * </li>
5947
+ * <li>
5948
+ * <p>name: <code>JOB_NAME </code>
5949
+ * </p>
5950
+ * <p>The values are case-insensitive matches for the job name. If a filter value ends
5951
+ * with an asterisk (*), it matches any job name that begins with the string before
5952
+ * the '*'.</p>
5953
+ * </li>
5954
+ * </ul>
5955
+ * @public
5956
+ */
5957
+ filters?: KeyValuesPair[] | undefined;
5958
+ /**
5959
+ * <p>The maximum number of results returned by <code>ListJobsByConsumableResource</code> in paginated
5960
+ * output. When this parameter is used, <code>ListJobsByConsumableResource</code> only returns
5961
+ * <code>maxResults</code> results in a single page and a <code>nextToken</code> response
5962
+ * element. The remaining results of the initial request can be seen by sending another
5963
+ * <code>ListJobsByConsumableResource</code> request with the returned <code>nextToken</code> value.
5964
+ * This value can be between 1 and 100. If this parameter isn't
5965
+ * used, then <code>ListJobsByConsumableResource</code> returns up to 100 results
5966
+ * and a <code>nextToken</code> value if applicable.</p>
5967
+ * @public
5968
+ */
5969
+ maxResults?: number | undefined;
5970
+ /**
5971
+ * <p>The <code>nextToken</code> value returned from a previous paginated
5972
+ * <code>ListJobsByConsumableResource</code> request where <code>maxResults</code> was used and the
5973
+ * results exceeded the value of that parameter. Pagination continues from the end of the previous
5974
+ * results that returned the <code>nextToken</code> value. This value is <code>null</code> when
5975
+ * there are no more results to return.</p>
5976
+ * <note>
5977
+ * <p>Treat this token as an opaque identifier that's only used to
5978
+ * retrieve the next items in a list and not for other programmatic purposes.</p>
5979
+ * </note>
5980
+ * @public
5981
+ */
5982
+ nextToken?: string | undefined;
5983
+ }
5984
+ /**
5985
+ * <p>Current information about a consumable resource required by a job.</p>
5986
+ * @public
5987
+ */
5988
+ export interface ListJobsByConsumableResourceSummary {
5989
+ /**
5990
+ * <p>The Amazon Resource Name (ARN) of the job.</p>
5991
+ * @public
5992
+ */
5993
+ jobArn: string | undefined;
5994
+ /**
5995
+ * <p>The Amazon Resource Name (ARN) of the job queue.</p>
5996
+ * @public
5997
+ */
5998
+ jobQueueArn: string | undefined;
5999
+ /**
6000
+ * <p>The name of the job.</p>
6001
+ * @public
6002
+ */
6003
+ jobName: string | undefined;
6004
+ /**
6005
+ * <p>The Amazon Resource Name (ARN) of the job definition.</p>
6006
+ * @public
6007
+ */
6008
+ jobDefinitionArn?: string | undefined;
6009
+ /**
6010
+ * <p>The fair-share scheduling policy identifier for the job.</p>
6011
+ * @public
6012
+ */
6013
+ shareIdentifier?: string | undefined;
6014
+ /**
6015
+ * <p>The status of the job. Can be one of:</p>
6016
+ * <ul>
6017
+ * <li>
6018
+ * <p>
6019
+ * <code>SUBMITTED</code>
6020
+ * </p>
6021
+ * </li>
6022
+ * <li>
6023
+ * <p>
6024
+ * <code>PENDING</code>
6025
+ * </p>
6026
+ * </li>
6027
+ * <li>
6028
+ * <p>
6029
+ * <code>RUNNABLE</code>
6030
+ * </p>
6031
+ * </li>
6032
+ * <li>
6033
+ * <p>
6034
+ * <code>STARTING</code>
6035
+ * </p>
6036
+ * </li>
6037
+ * <li>
6038
+ * <p>
6039
+ * <code>RUNNING</code>
6040
+ * </p>
6041
+ * </li>
6042
+ * <li>
6043
+ * <p>
6044
+ * <code>SUCCEEDED</code>
6045
+ * </p>
6046
+ * </li>
6047
+ * <li>
6048
+ * <p>
6049
+ * <code>FAILED</code>
6050
+ * </p>
6051
+ * </li>
6052
+ * </ul>
6053
+ * @public
6054
+ */
6055
+ jobStatus: string | undefined;
6056
+ /**
6057
+ * <p>The total amount of the consumable resource that is available.</p>
6058
+ * @public
6059
+ */
6060
+ quantity: number | undefined;
6061
+ /**
6062
+ * <p>A short, human-readable string to provide more details for the current status of the job.</p>
6063
+ * @public
6064
+ */
6065
+ statusReason?: string | undefined;
6066
+ /**
6067
+ * <p>The Unix timestamp for when the job was started. More specifically, it's when the job transitioned
6068
+ * from the <code>STARTING</code> state to the <code>RUNNING</code> state.</p>
6069
+ * @public
6070
+ */
6071
+ startedAt?: number | undefined;
6072
+ /**
6073
+ * <p>The Unix timestamp (in milliseconds) for when the consumable resource was created.</p>
6074
+ * @public
6075
+ */
6076
+ createdAt: number | undefined;
6077
+ /**
6078
+ * <p>Contains a list of consumable resources required by the job.</p>
6079
+ * @public
6080
+ */
6081
+ consumableResourceProperties: ConsumableResourceProperties | undefined;
6082
+ }
6083
+ /**
6084
+ * @public
6085
+ */
6086
+ export interface ListJobsByConsumableResourceResponse {
6087
+ /**
6088
+ * <p>The list of jobs that require the specified consumable resources.</p>
6089
+ * @public
6090
+ */
6091
+ jobs: ListJobsByConsumableResourceSummary[] | undefined;
6092
+ /**
6093
+ * <p>The <code>nextToken</code> value to include in a future <code>ListJobsByConsumableResource</code>
6094
+ * request. When the results of a <code>ListJobsByConsumableResource</code> request exceed
6095
+ * <code>maxResults</code>, this value can be used to retrieve the next page of results. This
6096
+ * value is <code>null</code> when there are no more results to return.</p>
6097
+ * @public
6098
+ */
6099
+ nextToken?: string | undefined;
6100
+ }
5641
6101
  /**
5642
6102
  * <p>Contains the parameters for <code>ListSchedulingPolicies</code>.</p>
5643
6103
  * @public
@@ -5772,7 +6232,7 @@ export interface RegisterJobDefinitionRequest {
5772
6232
  parameters?: Record<string, string> | undefined;
5773
6233
  /**
5774
6234
  * <p>The scheduling priority for jobs that are submitted with this job definition. This only
5775
- * affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority
6235
+ * affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority
5776
6236
  * are scheduled before jobs with a lower scheduling priority.</p>
5777
6237
  * <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
5778
6238
  * @public
@@ -5865,6 +6325,11 @@ export interface RegisterJobDefinitionRequest {
5865
6325
  * @public
5866
6326
  */
5867
6327
  ecsProperties?: EcsProperties | undefined;
6328
+ /**
6329
+ * <p>Contains a list of consumable resources required by the job.</p>
6330
+ * @public
6331
+ */
6332
+ consumableResourceProperties?: ConsumableResourceProperties | undefined;
5868
6333
  }
5869
6334
  /**
5870
6335
  * @public
@@ -6092,7 +6557,7 @@ export interface EksPodPropertiesOverride {
6092
6557
  containers?: EksContainerOverride[] | undefined;
6093
6558
  /**
6094
6559
  * <p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before
6095
- * application containers, always run to completion, and must complete successfully before the next
6560
+ * application containers, always runs to completion, and must complete successfully before the next
6096
6561
  * container starts. These containers are registered with the Amazon EKS Connector agent and persists the
6097
6562
  * registration information in the Kubernetes backend data store. For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
6098
6563
  * Containers</a> in the <i>Kubernetes documentation</i>.</p>
@@ -6153,6 +6618,11 @@ export interface NodePropertyOverride {
6153
6618
  * @public
6154
6619
  */
6155
6620
  eksPropertiesOverride?: EksPropertiesOverride | undefined;
6621
+ /**
6622
+ * <p>An object that contains overrides for the consumable resources of a job.</p>
6623
+ * @public
6624
+ */
6625
+ consumableResourcePropertiesOverride?: ConsumableResourceProperties | undefined;
6156
6626
  }
6157
6627
  /**
6158
6628
  * <p>An object that represents any node overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
@@ -6211,7 +6681,7 @@ export interface SubmitJobRequest {
6211
6681
  jobQueue: string | undefined;
6212
6682
  /**
6213
6683
  * <p>The share identifier for the job. Don't specify this parameter if the job queue doesn't
6214
- * have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must
6684
+ * have a scheduling policy. If the job queue has a scheduling policy, then this parameter must
6215
6685
  * be specified.</p>
6216
6686
  * <p>This string is limited to 255 alphanumeric characters, and can be followed by an asterisk
6217
6687
  * (*).</p>
@@ -6219,8 +6689,8 @@ export interface SubmitJobRequest {
6219
6689
  */
6220
6690
  shareIdentifier?: string | undefined;
6221
6691
  /**
6222
- * <p>The scheduling priority for the job. This only affects jobs in job queues with a
6223
- * fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
6692
+ * <p>The scheduling priority for the job. This only affects jobs in job queues with a fair
6693
+ * share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
6224
6694
  * scheduling priority. This overrides any scheduling priority in the job definition and works only
6225
6695
  * within a single share identifier.</p>
6226
6696
  * <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
@@ -6330,6 +6800,11 @@ export interface SubmitJobRequest {
6330
6800
  * @public
6331
6801
  */
6332
6802
  ecsPropertiesOverride?: EcsPropertiesOverride | undefined;
6803
+ /**
6804
+ * <p>An object that contains overrides for the consumable resources of a job.</p>
6805
+ * @public
6806
+ */
6807
+ consumableResourcePropertiesOverride?: ConsumableResourceProperties | undefined;
6333
6808
  }
6334
6809
  /**
6335
6810
  * @public
@@ -6787,8 +7262,8 @@ export interface UpdateComputeEnvironmentRequest {
6787
7262
  /**
6788
7263
  * <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
6789
7264
  * Don't specify this parameter for a managed compute environment. This parameter is only used
6790
- * for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this
6791
- * parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.</p>
7265
+ * for fair share scheduling to reserve vCPU capacity for new share identifiers. If this
7266
+ * parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>
6792
7267
  * @public
6793
7268
  */
6794
7269
  unmanagedvCpus?: number | undefined;
@@ -6852,6 +7327,80 @@ export interface UpdateComputeEnvironmentResponse {
6852
7327
  */
6853
7328
  computeEnvironmentArn?: string | undefined;
6854
7329
  }
7330
+ /**
7331
+ * @public
7332
+ */
7333
+ export interface UpdateConsumableResourceRequest {
7334
+ /**
7335
+ * <p>The name or ARN of the consumable resource to be updated.</p>
7336
+ * @public
7337
+ */
7338
+ consumableResource: string | undefined;
7339
+ /**
7340
+ * <p>Indicates how the quantity of the consumable resource will be updated. Must be one of:</p>
7341
+ * <ul>
7342
+ * <li>
7343
+ * <p>
7344
+ * <code>SET</code>
7345
+ * </p>
7346
+ * <p>Sets the quantity of the resource to the value specified by the <code>quantity</code>
7347
+ * parameter.</p>
7348
+ * </li>
7349
+ * <li>
7350
+ * <p>
7351
+ * <code>ADD</code>
7352
+ * </p>
7353
+ * <p>Increases the quantity of the resource by the value specified by the <code>quantity</code>
7354
+ * parameter.</p>
7355
+ * </li>
7356
+ * <li>
7357
+ * <p>
7358
+ * <code>REMOVE</code>
7359
+ * </p>
7360
+ * <p>Reduces the quantity of the resource by the value specified by the <code>quantity</code>
7361
+ * parameter.</p>
7362
+ * </li>
7363
+ * </ul>
7364
+ * @public
7365
+ */
7366
+ operation?: string | undefined;
7367
+ /**
7368
+ * <p>The change in the total quantity of the consumable resource. The <code>operation</code>
7369
+ * parameter determines whether the value specified here will be the new total quantity, or
7370
+ * the amount by which the total quantity will be increased or reduced. Must be a non-negative
7371
+ * value.</p>
7372
+ * @public
7373
+ */
7374
+ quantity?: number | undefined;
7375
+ /**
7376
+ * <p>If this parameter is specified and two update requests with identical payloads and
7377
+ * <code>clientToken</code>s are received, these requests are considered the same request and
7378
+ * the second request is rejected. A <code>clientToken</code> is valid for 8 hours or until
7379
+ * one hour after the consumable resource is deleted, whichever is less.</p>
7380
+ * @public
7381
+ */
7382
+ clientToken?: string | undefined;
7383
+ }
7384
+ /**
7385
+ * @public
7386
+ */
7387
+ export interface UpdateConsumableResourceResponse {
7388
+ /**
7389
+ * <p>The name of the consumable resource to be updated.</p>
7390
+ * @public
7391
+ */
7392
+ consumableResourceName: string | undefined;
7393
+ /**
7394
+ * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
7395
+ * @public
7396
+ */
7397
+ consumableResourceArn: string | undefined;
7398
+ /**
7399
+ * <p>The total amount of the consumable resource that is available.</p>
7400
+ * @public
7401
+ */
7402
+ totalQuantity?: number | undefined;
7403
+ }
6855
7404
  /**
6856
7405
  * <p>Contains the parameters for <code>UpdateJobQueue</code>.</p>
6857
7406
  * @public
@@ -6870,7 +7419,7 @@ export interface UpdateJobQueueRequest {
6870
7419
  */
6871
7420
  state?: JQState | undefined;
6872
7421
  /**
6873
- * <p>Amazon Resource Name (ARN) of the fair-share scheduling policy. Once a job queue is created, the fair-share
7422
+ * <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
6874
7423
  * scheduling policy can be replaced but not removed. The format is
6875
7424
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
6876
7425
  * </code>.
@@ -6937,7 +7486,7 @@ export interface UpdateSchedulingPolicyRequest {
6937
7486
  */
6938
7487
  arn: string | undefined;
6939
7488
  /**
6940
- * <p>The fair-share policy scheduling details.</p>
7489
+ * <p>The fair share policy.</p>
6941
7490
  * @public
6942
7491
  */
6943
7492
  fairsharePolicy?: FairsharePolicy | undefined;