@aws-sdk/client-batch 3.682.0 → 3.684.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/README.md CHANGED
@@ -21,7 +21,7 @@ on analyzing results and solving your specific problems instead.</p>
21
21
 
22
22
  ## Installing
23
23
 
24
- To install the this package, simply type add or install @aws-sdk/client-batch
24
+ To install this package, simply type add or install @aws-sdk/client-batch
25
25
  using your favorite package manager:
26
26
 
27
27
  - `npm install @aws-sdk/client-batch`
@@ -646,6 +646,7 @@ declare const DescribeJobsCommand_base: {
646
646
  * // containers: [ // EksAttemptContainerDetails
647
647
  * // { // EksAttemptContainerDetail
648
648
  * // name: "STRING_VALUE",
649
+ * // containerID: "STRING_VALUE",
649
650
  * // exitCode: Number("int"),
650
651
  * // reason: "STRING_VALUE",
651
652
  * // },
@@ -653,12 +654,14 @@ declare const DescribeJobsCommand_base: {
653
654
  * // initContainers: [
654
655
  * // {
655
656
  * // name: "STRING_VALUE",
657
+ * // containerID: "STRING_VALUE",
656
658
  * // exitCode: Number("int"),
657
659
  * // reason: "STRING_VALUE",
658
660
  * // },
659
661
  * // ],
660
662
  * // eksClusterArn: "STRING_VALUE",
661
663
  * // podName: "STRING_VALUE",
664
+ * // podNamespace: "STRING_VALUE",
662
665
  * // nodeName: "STRING_VALUE",
663
666
  * // startedAt: Number("long"),
664
667
  * // stoppedAt: Number("long"),
@@ -240,8 +240,9 @@ export interface CancelJobRequest {
240
240
  jobId: string | undefined;
241
241
  /**
242
242
  * <p>A message to attach to the job that explains the reason for canceling it. This message is
243
- * returned by future <a>DescribeJobs</a> operations on the job. This message is also
243
+ * returned by future <a>DescribeJobs</a> operations on the job. It is also
244
244
  * recorded in the Batch activity logs.</p>
245
+ * <p>This parameter has as limit of 1024 characters.</p>
245
246
  * @public
246
247
  */
247
248
  reason: string | undefined;
@@ -957,8 +958,7 @@ export declare const JobStateTimeLimitActionsState: {
957
958
  */
958
959
  export type JobStateTimeLimitActionsState = (typeof JobStateTimeLimitActionsState)[keyof typeof JobStateTimeLimitActionsState];
959
960
  /**
960
- * <p>Specifies an action that Batch will take after the job has remained at the head of the queue in the specified
961
- * state for longer than the specified time.</p>
961
+ * <p>Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.</p>
962
962
  * @public
963
963
  */
964
964
  export interface JobStateTimeLimitAction {
@@ -1016,14 +1016,13 @@ export interface CreateJobQueueRequest {
1016
1016
  */
1017
1017
  state?: JQState;
1018
1018
  /**
1019
- * <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job
1020
- * queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue
1021
- * uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can
1022
- * replace but can't remove the fair share scheduling policy. The format is
1019
+ * <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>
1020
+ * <p>The format is
1023
1021
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
1024
- * </code>.
1025
- * An example is
1022
+ * </code>.</p>
1023
+ * <p>An example is
1026
1024
  * <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
1025
+ * <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>
1027
1026
  * @public
1028
1027
  */
1029
1028
  schedulingPolicyArn?: string;
@@ -1062,8 +1061,7 @@ export interface CreateJobQueueRequest {
1062
1061
  */
1063
1062
  tags?: Record<string, string>;
1064
1063
  /**
1065
- * <p>The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
1066
- * longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
1064
+ * <p>The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed. (<b>Note</b>: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)</p>
1067
1065
  * @public
1068
1066
  */
1069
1067
  jobStateTimeLimitActions?: JobStateTimeLimitAction[];
@@ -3014,7 +3012,7 @@ export interface EcsProperties {
3014
3012
  /**
3015
3013
  * <p>An object that contains the properties for the Amazon ECS task definition of a job.</p>
3016
3014
  * <note>
3017
- * <p>This object is currently limited to one element.</p>
3015
+ * <p>This object is currently limited to one task element. However, the task element can run up to 10 containers.</p>
3018
3016
  * </note>
3019
3017
  * @public
3020
3018
  */
@@ -3473,6 +3471,9 @@ export interface EksPodProperties {
3473
3471
  imagePullSecrets?: ImagePullSecret[];
3474
3472
  /**
3475
3473
  * <p>The properties of the container that's used on the Amazon EKS pod.</p>
3474
+ * <note>
3475
+ * <p>This object is limited to 10 elements.</p>
3476
+ * </note>
3476
3477
  * @public
3477
3478
  */
3478
3479
  containers?: EksContainer[];
@@ -3483,7 +3484,7 @@ export interface EksPodProperties {
3483
3484
  * For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
3484
3485
  * Containers</a> in the <i>Kubernetes documentation</i>.</p>
3485
3486
  * <note>
3486
- * <p>This object is limited to 10 elements</p>
3487
+ * <p>This object is limited to 10 elements.</p>
3487
3488
  * </note>
3488
3489
  * @public
3489
3490
  */
@@ -3934,13 +3935,7 @@ export interface JobQueueDetail {
3934
3935
  */
3935
3936
  statusReason?: string;
3936
3937
  /**
3937
- * <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value
3938
- * for the <code>priority</code> parameter) are evaluated first when associated with the same
3939
- * compute environment. Priority is determined in descending order. For example, a job queue with a
3940
- * priority value of <code>10</code> is given scheduling preference over a job queue with a priority
3941
- * value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code>
3942
- * or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and
3943
- * Fargate compute environments can't be mixed.</p>
3938
+ * <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and Fargate compute environments can't be mixed.</p>
3944
3939
  * @public
3945
3940
  */
3946
3941
  priority: number | undefined;
@@ -3957,8 +3952,7 @@ export interface JobQueueDetail {
3957
3952
  */
3958
3953
  tags?: Record<string, string>;
3959
3954
  /**
3960
- * <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state
3961
- * longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
3955
+ * <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
3962
3956
  * @public
3963
3957
  */
3964
3958
  jobStateTimeLimitActions?: JobStateTimeLimitAction[];
@@ -4596,6 +4590,11 @@ export interface EksAttemptContainerDetail {
4596
4590
  * @public
4597
4591
  */
4598
4592
  name?: string;
4593
+ /**
4594
+ * <p>The ID for the container.</p>
4595
+ * @public
4596
+ */
4597
+ containerID?: string;
4599
4598
  /**
4600
4599
  * <p>The exit code returned for the job attempt. A non-zero exit code is considered
4601
4600
  * failed.</p>
@@ -4635,6 +4634,11 @@ export interface EksAttemptDetail {
4635
4634
  * @public
4636
4635
  */
4637
4636
  podName?: string;
4637
+ /**
4638
+ * <p>The namespace of the Amazon EKS cluster that the pod exists in.</p>
4639
+ * @public
4640
+ */
4641
+ podNamespace?: string;
4638
4642
  /**
4639
4643
  * <p>The name of the node for this job attempt.</p>
4640
4644
  * @public
@@ -5914,14 +5918,11 @@ export interface EksPodPropertiesOverride {
5914
5918
  */
5915
5919
  containers?: EksContainerOverride[];
5916
5920
  /**
5917
- * <p>The overrides for the conatainers defined in the Amazon EKS pod. These containers run before
5921
+ * <p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before
5918
5922
  * application containers, always runs to completion, and must complete successfully before the next
5919
5923
  * container starts. These containers are registered with the Amazon EKS Connector agent and persists the
5920
5924
  * registration information in the Kubernetes backend data store. For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
5921
5925
  * Containers</a> in the <i>Kubernetes documentation</i>.</p>
5922
- * <note>
5923
- * <p>This object is limited to 10 elements</p>
5924
- * </note>
5925
5926
  * @public
5926
5927
  */
5927
5928
  initContainers?: EksContainerOverride[];
@@ -6216,8 +6217,9 @@ export interface TerminateJobRequest {
6216
6217
  jobId: string | undefined;
6217
6218
  /**
6218
6219
  * <p>A message to attach to the job that explains the reason for canceling it. This message is
6219
- * returned by future <a>DescribeJobs</a> operations on the job. This message is also
6220
+ * returned by future <a>DescribeJobs</a> operations on the job. It is also
6220
6221
  * recorded in the Batch activity logs.</p>
6222
+ * <p>This parameter has as limit of 1024 characters.</p>
6221
6223
  * @public
6222
6224
  */
6223
6225
  reason: string | undefined;
@@ -6741,8 +6743,7 @@ export interface UpdateJobQueueRequest {
6741
6743
  */
6742
6744
  computeEnvironmentOrder?: ComputeEnvironmentOrder[];
6743
6745
  /**
6744
- * <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state
6745
- * longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
6746
+ * <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed. (<b>Note</b>: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)</p>
6746
6747
  * @public
6747
6748
  */
6748
6749
  jobStateTimeLimitActions?: JobStateTimeLimitAction[];
@@ -683,6 +683,7 @@ export interface EcsPropertiesDetail {
683
683
  }
684
684
  export interface EksAttemptContainerDetail {
685
685
  name?: string;
686
+ containerID?: string;
686
687
  exitCode?: number;
687
688
  reason?: string;
688
689
  }
@@ -691,6 +692,7 @@ export interface EksAttemptDetail {
691
692
  initContainers?: EksAttemptContainerDetail[];
692
693
  eksClusterArn?: string;
693
694
  podName?: string;
695
+ podNamespace?: string;
694
696
  nodeName?: string;
695
697
  startedAt?: number;
696
698
  stoppedAt?: number;
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.682.0",
4
+ "version": "3.684.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",