Skip to content

Commit 0260ae8

Browse files
author
awstools
committed
feat(client-batch): Add podNamespace to EksAttemptDetail and containerID to EksAttemptContainerDetail.
1 parent 41fe911 commit 0260ae8

File tree

4 files changed

+60
-42
lines changed

4 files changed

+60
-42
lines changed

clients/client-batch/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ on analyzing results and solving your specific problems instead.</p>
2121

2222
## Installing
2323

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
2525
using your favorite package manager:
2626

2727
- `npm install @aws-sdk/client-batch`

clients/client-batch/src/commands/DescribeJobsCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -647,19 +647,22 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
647647
* // containers: [ // EksAttemptContainerDetails
648648
* // { // EksAttemptContainerDetail
649649
* // name: "STRING_VALUE",
650+
* // containerID: "STRING_VALUE",
650651
* // exitCode: Number("int"),
651652
* // reason: "STRING_VALUE",
652653
* // },
653654
* // ],
654655
* // initContainers: [
655656
* // {
656657
* // name: "STRING_VALUE",
658+
* // containerID: "STRING_VALUE",
657659
* // exitCode: Number("int"),
658660
* // reason: "STRING_VALUE",
659661
* // },
660662
* // ],
661663
* // eksClusterArn: "STRING_VALUE",
662664
* // podName: "STRING_VALUE",
665+
* // podNamespace: "STRING_VALUE",
663666
* // nodeName: "STRING_VALUE",
664667
* // startedAt: Number("long"),
665668
* // stoppedAt: Number("long"),

clients/client-batch/src/models/models_0.ts

+32-29
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,9 @@ export interface CancelJobRequest {
276276

277277
/**
278278
* <p>A message to attach to the job that explains the reason for canceling it. This message is
279-
* returned by future <a>DescribeJobs</a> operations on the job. This message is also
279+
* returned by future <a>DescribeJobs</a> operations on the job. It is also
280280
* recorded in the Batch activity logs.</p>
281+
* <p>This parameter has as limit of 1024 characters.</p>
281282
* @public
282283
*/
283284
reason: string | undefined;
@@ -1062,8 +1063,7 @@ export type JobStateTimeLimitActionsState =
10621063
(typeof JobStateTimeLimitActionsState)[keyof typeof JobStateTimeLimitActionsState];
10631064

10641065
/**
1065-
* <p>Specifies an action that Batch will take after the job has remained at the head of the queue in the specified
1066-
* state for longer than the specified time.</p>
1066+
* <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>
10671067
* @public
10681068
*/
10691069
export interface JobStateTimeLimitAction {
@@ -1129,14 +1129,13 @@ export interface CreateJobQueueRequest {
11291129
state?: JQState;
11301130

11311131
/**
1132-
* <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job
1133-
* queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue
1134-
* uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can
1135-
* replace but can't remove the fair share scheduling policy. The format is
1132+
* <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>
1133+
* <p>The format is
11361134
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
1137-
* </code>.
1138-
* An example is
1135+
* </code>.</p>
1136+
* <p>An example is
11391137
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
1138+
* <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>
11401139
* @public
11411140
*/
11421141
schedulingPolicyArn?: string;
@@ -1179,8 +1178,7 @@ export interface CreateJobQueueRequest {
11791178
tags?: Record<string, string>;
11801179

11811180
/**
1182-
* <p>The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state
1183-
* longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
1181+
* <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>
11841182
* @public
11851183
*/
11861184
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
@@ -3285,7 +3283,7 @@ export interface EcsProperties {
32853283
/**
32863284
* <p>An object that contains the properties for the Amazon ECS task definition of a job.</p>
32873285
* <note>
3288-
* <p>This object is currently limited to one element.</p>
3286+
* <p>This object is currently limited to one task element. However, the task element can run up to 10 containers.</p>
32893287
* </note>
32903288
* @public
32913289
*/
@@ -3782,6 +3780,9 @@ export interface EksPodProperties {
37823780

37833781
/**
37843782
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
3783+
* <note>
3784+
* <p>This object is limited to 10 elements.</p>
3785+
* </note>
37853786
* @public
37863787
*/
37873788
containers?: EksContainer[];
@@ -3793,7 +3794,7 @@ export interface EksPodProperties {
37933794
* For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
37943795
* Containers</a> in the <i>Kubernetes documentation</i>.</p>
37953796
* <note>
3796-
* <p>This object is limited to 10 elements</p>
3797+
* <p>This object is limited to 10 elements.</p>
37973798
* </note>
37983799
* @public
37993800
*/
@@ -4298,13 +4299,7 @@ export interface JobQueueDetail {
42984299
statusReason?: string;
42994300

43004301
/**
4301-
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value
4302-
* for the <code>priority</code> parameter) are evaluated first when associated with the same
4303-
* compute environment. Priority is determined in descending order. For example, a job queue with a
4304-
* priority value of <code>10</code> is given scheduling preference over a job queue with a priority
4305-
* value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code>
4306-
* or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and
4307-
* Fargate compute environments can't be mixed.</p>
4302+
* <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>
43084303
* @public
43094304
*/
43104305
priority: number | undefined;
@@ -4324,8 +4319,7 @@ export interface JobQueueDetail {
43244319
tags?: Record<string, string>;
43254320

43264321
/**
4327-
* <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state
4328-
* longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
4322+
* <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>
43294323
* @public
43304324
*/
43314325
jobStateTimeLimitActions?: JobStateTimeLimitAction[];
@@ -5032,6 +5026,12 @@ export interface EksAttemptContainerDetail {
50325026
*/
50335027
name?: string;
50345028

5029+
/**
5030+
* <p>The ID for the container.</p>
5031+
* @public
5032+
*/
5033+
containerID?: string;
5034+
50355035
/**
50365036
* <p>The exit code returned for the job attempt. A non-zero exit code is considered
50375037
* failed.</p>
@@ -5077,6 +5077,12 @@ export interface EksAttemptDetail {
50775077
*/
50785078
podName?: string;
50795079

5080+
/**
5081+
* <p>The namespace of the Amazon EKS cluster that the pod exists in.</p>
5082+
* @public
5083+
*/
5084+
podNamespace?: string;
5085+
50805086
/**
50815087
* <p>The name of the node for this job attempt.</p>
50825088
* @public
@@ -6501,14 +6507,11 @@ export interface EksPodPropertiesOverride {
65016507
containers?: EksContainerOverride[];
65026508

65036509
/**
6504-
* <p>The overrides for the conatainers defined in the Amazon EKS pod. These containers run before
6510+
* <p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before
65056511
* application containers, always runs to completion, and must complete successfully before the next
65066512
* container starts. These containers are registered with the Amazon EKS Connector agent and persists the
65076513
* registration information in the Kubernetes backend data store. For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
65086514
* Containers</a> in the <i>Kubernetes documentation</i>.</p>
6509-
* <note>
6510-
* <p>This object is limited to 10 elements</p>
6511-
* </note>
65126515
* @public
65136516
*/
65146517
initContainers?: EksContainerOverride[];
@@ -6835,8 +6838,9 @@ export interface TerminateJobRequest {
68356838

68366839
/**
68376840
* <p>A message to attach to the job that explains the reason for canceling it. This message is
6838-
* returned by future <a>DescribeJobs</a> operations on the job. This message is also
6841+
* returned by future <a>DescribeJobs</a> operations on the job. It is also
68396842
* recorded in the Batch activity logs.</p>
6843+
* <p>This parameter has as limit of 1024 characters.</p>
68406844
* @public
68416845
*/
68426846
reason: string | undefined;
@@ -7396,8 +7400,7 @@ export interface UpdateJobQueueRequest {
73967400
computeEnvironmentOrder?: ComputeEnvironmentOrder[];
73977401

73987402
/**
7399-
* <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state
7400-
* longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed.</p>
7403+
* <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>
74017404
* @public
74027405
*/
74037406
jobStateTimeLimitActions?: JobStateTimeLimitAction[];

0 commit comments

Comments
 (0)