Skip to content

Commit 6612591

Browse files
author
awstools
committed
feat(client-batch): Improvements of integration between AWS Batch and EC2.
1 parent b4200b0 commit 6612591

File tree

7 files changed

+43
-10
lines changed

7 files changed

+43
-10
lines changed

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

+1-9
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,7 @@ export interface CancelJobCommandInput extends CancelJobRequest {}
2828
export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels a job in an Batch job queue. Jobs that are in the
32-
* <code>SUBMITTED</code>
33-
* or
34-
* <code>PENDING</code>
35-
* are
36-
* canceled. A job
37-
* in<code>RUNNABLE</code> remains in <code>RUNNABLE</code> until it reaches the head of the
38-
* job queue. Then the job status is updated to
39-
* <code>FAILED</code>.</p>
31+
* <p>Cancels a job in an Batch job queue. Jobs that are in a <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled and the job status is updated to <code>FAILED</code>.</p>
4032
* <note>
4133
* <p>A <code>PENDING</code> job is canceled after all dependency jobs are completed.
4234
* Therefore, it may take longer than expected to cancel a job in <code>PENDING</code>

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

+1
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
181181
* eksClusterArn: "STRING_VALUE", // required
182182
* kubernetesNamespace: "STRING_VALUE", // required
183183
* },
184+
* context: "STRING_VALUE",
184185
* };
185186
* const command = new CreateComputeEnvironmentCommand(input);
186187
* const response = await client.send(command);

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

+1
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ export interface DescribeComputeEnvironmentsCommandOutput
114114
* // },
115115
* // containerOrchestrationType: "ECS" || "EKS",
116116
* // uuid: "STRING_VALUE",
117+
* // context: "STRING_VALUE",
117118
* // },
118119
* // ],
119120
* // nextToken: "STRING_VALUE",

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

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ export interface UpdateComputeEnvironmentCommandOutput extends UpdateComputeEnvi
8181
* terminateJobsOnUpdate: true || false,
8282
* jobExecutionTimeoutMinutes: Number("long"),
8383
* },
84+
* context: "STRING_VALUE",
8485
* };
8586
* const command = new UpdateComputeEnvironmentCommand(input);
8687
* const response = await client.send(command);

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

+18
Original file line numberDiff line numberDiff line change
@@ -976,6 +976,12 @@ export interface CreateComputeEnvironmentRequest {
976976
* @public
977977
*/
978978
eksConfiguration?: EksConfiguration;
979+
980+
/**
981+
* <p>Reserved.</p>
982+
* @public
983+
*/
984+
context?: string;
979985
}
980986

981987
/**
@@ -1606,6 +1612,12 @@ export interface ComputeEnvironmentDetail {
16061612
* @public
16071613
*/
16081614
uuid?: string;
1615+
1616+
/**
1617+
* <p>Reserved.</p>
1618+
* @public
1619+
*/
1620+
context?: string;
16091621
}
16101622

16111623
/**
@@ -7299,6 +7311,12 @@ export interface UpdateComputeEnvironmentRequest {
72997311
* @public
73007312
*/
73017313
updatePolicy?: UpdatePolicy;
7314+
7315+
/**
7316+
* <p>Reserved.</p>
7317+
* @public
7318+
*/
7319+
context?: string;
73027320
}
73037321

73047322
/**

clients/client-batch/src/protocols/Aws_restJson1.ts

+2
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ export const se_CreateComputeEnvironmentCommand = async (
207207
take(input, {
208208
computeEnvironmentName: [],
209209
computeResources: (_) => _json(_),
210+
context: [],
210211
eksConfiguration: (_) => _json(_),
211212
serviceRole: [],
212213
state: [],
@@ -722,6 +723,7 @@ export const se_UpdateComputeEnvironmentCommand = async (
722723
take(input, {
723724
computeEnvironment: [],
724725
computeResources: (_) => _json(_),
726+
context: [],
725727
serviceRole: [],
726728
state: [],
727729
unmanagedvCpus: [],

codegen/sdk-codegen/aws-models/batch.json

+19-1
Original file line numberDiff line numberDiff line change
@@ -1588,7 +1588,7 @@
15881588
}
15891589
],
15901590
"traits": {
1591-
"smithy.api#documentation": "<p>Cancels a job in an Batch job queue. Jobs that are in the\n <code>SUBMITTED</code>\n or\n <code>PENDING</code>\n are\n canceled. A job\n in<code>RUNNABLE</code> remains in <code>RUNNABLE</code> until it reaches the head of the\n job queue. Then the job status is updated to\n <code>FAILED</code>.</p>\n <note>\n <p>A <code>PENDING</code> job is canceled after all dependency jobs are completed.\n Therefore, it may take longer than expected to cancel a job in <code>PENDING</code>\n status.</p>\n <p>When you try to cancel an array parent job in <code>PENDING</code>, Batch attempts to\n cancel all child jobs. The array parent job is canceled when all child jobs are\n completed.</p>\n </note>\n <p>Jobs that progressed to the <code>STARTING</code> or\n <code>RUNNING</code> state aren't canceled. However, the API operation still succeeds, even\n if no job is canceled. These jobs must be terminated with the <a>TerminateJob</a>\n operation.</p>",
1591+
"smithy.api#documentation": "<p>Cancels a job in an Batch job queue. Jobs that are in a <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled and the job status is updated to <code>FAILED</code>.</p>\n <note>\n <p>A <code>PENDING</code> job is canceled after all dependency jobs are completed.\n Therefore, it may take longer than expected to cancel a job in <code>PENDING</code>\n status.</p>\n <p>When you try to cancel an array parent job in <code>PENDING</code>, Batch attempts to\n cancel all child jobs. The array parent job is canceled when all child jobs are\n completed.</p>\n </note>\n <p>Jobs that progressed to the <code>STARTING</code> or\n <code>RUNNING</code> state aren't canceled. However, the API operation still succeeds, even\n if no job is canceled. These jobs must be terminated with the <a>TerminateJob</a>\n operation.</p>",
15921592
"smithy.api#examples": [
15931593
{
15941594
"title": "To cancel a job",
@@ -1748,6 +1748,12 @@
17481748
"traits": {
17491749
"smithy.api#documentation": "<p>Unique identifier for the compute environment.</p>"
17501750
}
1751+
},
1752+
"context": {
1753+
"target": "com.amazonaws.batch#String",
1754+
"traits": {
1755+
"smithy.api#documentation": "<p>Reserved.</p>"
1756+
}
17511757
}
17521758
},
17531759
"traits": {
@@ -2562,6 +2568,12 @@
25622568
"traits": {
25632569
"smithy.api#documentation": "<p>The details for the Amazon EKS cluster that supports the compute environment.</p>"
25642570
}
2571+
},
2572+
"context": {
2573+
"target": "com.amazonaws.batch#String",
2574+
"traits": {
2575+
"smithy.api#documentation": "<p>Reserved.</p>"
2576+
}
25652577
}
25662578
},
25672579
"traits": {
@@ -7966,6 +7978,12 @@
79667978
"traits": {
79677979
"smithy.api#documentation": "<p>Specifies the updated infrastructure update policy for the compute environment. For more\n information about infrastructure updates, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html\">Updating compute environments</a> in\n the <i>Batch User Guide</i>.</p>"
79687980
}
7981+
},
7982+
"context": {
7983+
"target": "com.amazonaws.batch#String",
7984+
"traits": {
7985+
"smithy.api#documentation": "<p>Reserved.</p>"
7986+
}
79697987
}
79707988
},
79717989
"traits": {

0 commit comments

Comments
 (0)