@aws-sdk/client-batch 3.749.0 → 3.751.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.
@@ -34,7 +34,7 @@ declare const SubmitJobCommand_base: {
34
34
  * parameters in a <code>resourceRequirements</code> object that's included in the
35
35
  * <code>containerOverrides</code> parameter.</p>
36
36
  * <note>
37
- * <p>Job queues with a scheduling policy are limited to 500 active fair share identifiers at
37
+ * <p>Job queues with a scheduling policy are limited to 500 active share identifiers at
38
38
  * a time. </p>
39
39
  * </note>
40
40
  * <important>
@@ -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>
@@ -1096,13 +1096,13 @@ export interface CreateJobQueueRequest {
1096
1096
  */
1097
1097
  state?: JQState | undefined;
1098
1098
  /**
1099
- * <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>
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>
1100
1100
  * <p>The format is
1101
1101
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
1102
1102
  * </code>.</p>
1103
1103
  * <p>An example is
1104
1104
  * <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
1105
- * <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>
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>
1106
1106
  * @public
1107
1107
  */
1108
1108
  schedulingPolicyArn?: string | undefined;
@@ -1162,25 +1162,25 @@ export interface CreateJobQueueResponse {
1162
1162
  jobQueueArn: string | undefined;
1163
1163
  }
1164
1164
  /**
1165
- * <p>Specifies the weights for the fair share identifiers for the fair share policy. Fair share
1165
+ * <p>Specifies the weights for the share identifiers for the fair-share policy. Share
1166
1166
  * identifiers that aren't included have a default weight of <code>1.0</code>.</p>
1167
1167
  * @public
1168
1168
  */
1169
1169
  export interface ShareAttributes {
1170
1170
  /**
1171
- * <p>A fair share identifier or fair share identifier prefix. If the string ends with an asterisk
1172
- * (*), this entry specifies the weight factor to use for fair share identifiers that start with
1173
- * that prefix. The list of fair share identifiers in a fair share policy can't overlap. For
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
1174
1174
  * example, you can't have one that specifies a <code>shareIdentifier</code> of <code>UserA*</code>
1175
1175
  * and another that specifies a <code>shareIdentifier</code> of <code>UserA-1</code>.</p>
1176
- * <p>There can be no more than 500 fair share identifiers active in a job queue.</p>
1176
+ * <p>There can be no more than 500 share identifiers active in a job queue.</p>
1177
1177
  * <p>The string is limited to 255 alphanumeric characters, and can be followed by an asterisk
1178
1178
  * (*).</p>
1179
1179
  * @public
1180
1180
  */
1181
1181
  shareIdentifier: string | undefined;
1182
1182
  /**
1183
- * <p>The weight factor for the fair share identifier. The default value is 1.0. A lower value has
1183
+ * <p>The weight factor for the share identifier. The default value is 1.0. A lower value has
1184
1184
  * a higher priority for compute resources. For example, jobs that use a share identifier with a
1185
1185
  * weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share
1186
1186
  * identifier with a weight factor of 1.</p>
@@ -1190,12 +1190,12 @@ export interface ShareAttributes {
1190
1190
  weightFactor?: number | undefined;
1191
1191
  }
1192
1192
  /**
1193
- * <p>The fair share policy for a scheduling policy.</p>
1193
+ * <p>The fair-share scheduling policy details.</p>
1194
1194
  * @public
1195
1195
  */
1196
1196
  export interface FairsharePolicy {
1197
1197
  /**
1198
- * <p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair
1198
+ * <p>The amount of time (in seconds) to use to calculate a fair-share percentage for each
1199
1199
  * share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds).
1200
1200
  * The maximum supported value is 604800 (1 week).</p>
1201
1201
  * <p>The decay allows for more recently run jobs to have more weight than jobs that ran earlier.
@@ -1206,28 +1206,28 @@ export interface FairsharePolicy {
1206
1206
  */
1207
1207
  shareDecaySeconds?: number | undefined;
1208
1208
  /**
1209
- * <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that
1209
+ * <p>A value used to reserve some of the available maximum vCPU for share identifiers that
1210
1210
  * aren't already used.</p>
1211
1211
  * <p>The reserved ratio is
1212
1212
  * <code>(<i>computeReservation</i>/100)^<i>ActiveFairShares</i>
1213
1213
  * </code>
1214
1214
  * where <code>
1215
1215
  * <i>ActiveFairShares</i>
1216
- * </code> is the number of active fair share
1216
+ * </code> is the number of active share
1217
1217
  * identifiers.</p>
1218
1218
  * <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 fair share identifier. It reserves 25% if
1220
- * there are two fair share identifiers. It reserves 12.5% if there are three fair share
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
1221
1221
  * 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 fair share identifier, 6.25% if there are
1223
- * two fair share identifiers, and 1.56% if there are three fair share identifiers.</p>
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>
1224
1224
  * <p>The minimum value is 0 and the maximum value is 99.</p>
1225
1225
  * @public
1226
1226
  */
1227
1227
  computeReservation?: number | undefined;
1228
1228
  /**
1229
- * <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair
1230
- * share identifiers for the fair share policy. Fair share identifiers that aren't included have a
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
1231
1231
  * default weight of <code>1.0</code>.</p>
1232
1232
  * @public
1233
1233
  */
@@ -1239,13 +1239,13 @@ export interface FairsharePolicy {
1239
1239
  */
1240
1240
  export interface CreateSchedulingPolicyRequest {
1241
1241
  /**
1242
- * <p>The name of the scheduling policy. It can be up to 128 letters long. It can contain
1242
+ * <p>The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain
1243
1243
  * uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
1244
1244
  * @public
1245
1245
  */
1246
1246
  name: string | undefined;
1247
1247
  /**
1248
- * <p>The fair share policy of the scheduling policy.</p>
1248
+ * <p>The fair-share scheduling policy details.</p>
1249
1249
  * @public
1250
1250
  */
1251
1251
  fairsharePolicy?: FairsharePolicy | undefined;
@@ -1793,7 +1793,7 @@ export interface LinuxParameters {
1793
1793
  * <p>If a <code>maxSwap</code> value of <code>0</code> is specified, the container doesn't use
1794
1794
  * swap. Accepted values are <code>0</code> or any positive integer. If the <code>maxSwap</code>
1795
1795
  * parameter is omitted, the container doesn't use the swap configuration for the container instance
1796
- * that it's running on. A <code>maxSwap</code> value must be set for the <code>swappiness</code>
1796
+ * on which it runs. A <code>maxSwap</code> value must be set for the <code>swappiness</code>
1797
1797
  * parameter to be used.</p>
1798
1798
  * <note>
1799
1799
  * <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't
@@ -3886,7 +3886,7 @@ export interface JobDefinition {
3886
3886
  type: string | undefined;
3887
3887
  /**
3888
3888
  * <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
3889
+ * fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
3890
3890
  * scheduling priority.</p>
3891
3891
  * @public
3892
3892
  */
@@ -5101,7 +5101,7 @@ export interface JobDetail {
5101
5101
  shareIdentifier?: string | undefined;
5102
5102
  /**
5103
5103
  * <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
5104
+ * fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
5105
5105
  * scheduling priority.</p>
5106
5106
  * @public
5107
5107
  */
@@ -5287,7 +5287,7 @@ export interface DescribeSchedulingPoliciesRequest {
5287
5287
  */
5288
5288
  export interface SchedulingPolicyDetail {
5289
5289
  /**
5290
- * <p>The name of the scheduling policy.</p>
5290
+ * <p>The name of the fair-share scheduling policy.</p>
5291
5291
  * @public
5292
5292
  */
5293
5293
  name: string | undefined;
@@ -5299,12 +5299,12 @@ export interface SchedulingPolicyDetail {
5299
5299
  */
5300
5300
  arn: string | undefined;
5301
5301
  /**
5302
- * <p>The fair share policy for the scheduling policy.</p>
5302
+ * <p>The fair-share scheduling policy details.</p>
5303
5303
  * @public
5304
5304
  */
5305
5305
  fairsharePolicy?: FairsharePolicy | undefined;
5306
5306
  /**
5307
- * <p>The tags that you apply to the scheduling policy to categorize and organize your resources.
5307
+ * <p>The tags that you apply to the fair-share scheduling policy to categorize and organize your resources.
5308
5308
  * 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
5309
  * <i>Amazon Web Services General Reference</i>.</p>
5310
5310
  * @public
@@ -5353,7 +5353,7 @@ export interface FrontOfQueueJobSummary {
5353
5353
  */
5354
5354
  export interface FrontOfQueueDetail {
5355
5355
  /**
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>
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>
5357
5357
  * @public
5358
5358
  */
5359
5359
  jobs?: FrontOfQueueJobSummary[] | undefined;
@@ -5368,7 +5368,7 @@ export interface FrontOfQueueDetail {
5368
5368
  */
5369
5369
  export interface GetJobQueueSnapshotResponse {
5370
5370
  /**
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>
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>
5372
5372
  * @public
5373
5373
  */
5374
5374
  frontOfQueue?: FrontOfQueueDetail | undefined;
@@ -5772,7 +5772,7 @@ export interface RegisterJobDefinitionRequest {
5772
5772
  parameters?: Record<string, string> | undefined;
5773
5773
  /**
5774
5774
  * <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
5775
+ * affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority
5776
5776
  * are scheduled before jobs with a lower scheduling priority.</p>
5777
5777
  * <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
5778
5778
  * @public
@@ -6092,7 +6092,7 @@ export interface EksPodPropertiesOverride {
6092
6092
  containers?: EksContainerOverride[] | undefined;
6093
6093
  /**
6094
6094
  * <p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before
6095
- * application containers, always runs to completion, and must complete successfully before the next
6095
+ * application containers, always run to completion, and must complete successfully before the next
6096
6096
  * container starts. These containers are registered with the Amazon EKS Connector agent and persists the
6097
6097
  * 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
6098
  * Containers</a> in the <i>Kubernetes documentation</i>.</p>
@@ -6211,7 +6211,7 @@ export interface SubmitJobRequest {
6211
6211
  jobQueue: string | undefined;
6212
6212
  /**
6213
6213
  * <p>The share identifier for the job. Don't specify this parameter if the job queue doesn't
6214
- * have a scheduling policy. If the job queue has a scheduling policy, then this parameter must
6214
+ * have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must
6215
6215
  * be specified.</p>
6216
6216
  * <p>This string is limited to 255 alphanumeric characters, and can be followed by an asterisk
6217
6217
  * (*).</p>
@@ -6219,8 +6219,8 @@ export interface SubmitJobRequest {
6219
6219
  */
6220
6220
  shareIdentifier?: string | undefined;
6221
6221
  /**
6222
- * <p>The scheduling priority for the job. This only affects jobs in job queues with a fair
6223
- * share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
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
6224
6224
  * scheduling priority. This overrides any scheduling priority in the job definition and works only
6225
6225
  * within a single share identifier.</p>
6226
6226
  * <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
@@ -6787,8 +6787,8 @@ export interface UpdateComputeEnvironmentRequest {
6787
6787
  /**
6788
6788
  * <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
6789
6789
  * 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>
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>
6792
6792
  * @public
6793
6793
  */
6794
6794
  unmanagedvCpus?: number | undefined;
@@ -6870,7 +6870,7 @@ export interface UpdateJobQueueRequest {
6870
6870
  */
6871
6871
  state?: JQState | undefined;
6872
6872
  /**
6873
- * <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
6873
+ * <p>Amazon Resource Name (ARN) of the fair-share scheduling policy. Once a job queue is created, the fair-share
6874
6874
  * scheduling policy can be replaced but not removed. The format is
6875
6875
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
6876
6876
  * </code>.
@@ -6937,7 +6937,7 @@ export interface UpdateSchedulingPolicyRequest {
6937
6937
  */
6938
6938
  arn: string | undefined;
6939
6939
  /**
6940
- * <p>The fair share policy.</p>
6940
+ * <p>The fair-share policy scheduling details.</p>
6941
6941
  * @public
6942
6942
  */
6943
6943
  fairsharePolicy?: FairsharePolicy | undefined;
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.749.0",
4
+ "version": "3.751.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,38 +20,38 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.749.0",
24
- "@aws-sdk/credential-provider-node": "3.749.0",
23
+ "@aws-sdk/core": "3.750.0",
24
+ "@aws-sdk/credential-provider-node": "3.750.0",
25
25
  "@aws-sdk/middleware-host-header": "3.734.0",
26
26
  "@aws-sdk/middleware-logger": "3.734.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.734.0",
28
- "@aws-sdk/middleware-user-agent": "3.749.0",
28
+ "@aws-sdk/middleware-user-agent": "3.750.0",
29
29
  "@aws-sdk/region-config-resolver": "3.734.0",
30
30
  "@aws-sdk/types": "3.734.0",
31
31
  "@aws-sdk/util-endpoints": "3.743.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.734.0",
33
- "@aws-sdk/util-user-agent-node": "3.749.0",
33
+ "@aws-sdk/util-user-agent-node": "3.750.0",
34
34
  "@smithy/config-resolver": "^4.0.1",
35
- "@smithy/core": "^3.1.3",
35
+ "@smithy/core": "^3.1.4",
36
36
  "@smithy/fetch-http-handler": "^5.0.1",
37
37
  "@smithy/hash-node": "^4.0.1",
38
38
  "@smithy/invalid-dependency": "^4.0.1",
39
39
  "@smithy/middleware-content-length": "^4.0.1",
40
- "@smithy/middleware-endpoint": "^4.0.4",
41
- "@smithy/middleware-retry": "^4.0.5",
40
+ "@smithy/middleware-endpoint": "^4.0.5",
41
+ "@smithy/middleware-retry": "^4.0.6",
42
42
  "@smithy/middleware-serde": "^4.0.2",
43
43
  "@smithy/middleware-stack": "^4.0.1",
44
44
  "@smithy/node-config-provider": "^4.0.1",
45
45
  "@smithy/node-http-handler": "^4.0.2",
46
46
  "@smithy/protocol-http": "^5.0.1",
47
- "@smithy/smithy-client": "^4.1.4",
47
+ "@smithy/smithy-client": "^4.1.5",
48
48
  "@smithy/types": "^4.1.0",
49
49
  "@smithy/url-parser": "^4.0.1",
50
50
  "@smithy/util-base64": "^4.0.0",
51
51
  "@smithy/util-body-length-browser": "^4.0.0",
52
52
  "@smithy/util-body-length-node": "^4.0.0",
53
- "@smithy/util-defaults-mode-browser": "^4.0.5",
54
- "@smithy/util-defaults-mode-node": "^4.0.5",
53
+ "@smithy/util-defaults-mode-browser": "^4.0.6",
54
+ "@smithy/util-defaults-mode-node": "^4.0.6",
55
55
  "@smithy/util-endpoints": "^3.0.1",
56
56
  "@smithy/util-middleware": "^4.0.1",
57
57
  "@smithy/util-retry": "^4.0.1",