@aws-sdk/client-batch 3.1130.0 → 3.1131.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 +21 -0
- package/dist-cjs/index.js +123 -14
- package/dist-es/Batch.js +6 -0
- package/dist-es/commands/CancelJobsCommand.js +4 -0
- package/dist-es/commands/TerminateJobsCommand.js +4 -0
- package/dist-es/commands/TerminateServiceJobsCommand.js +4 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +95 -13
- package/dist-types/Batch.d.ts +21 -0
- package/dist-types/BatchClient.d.ts +5 -2
- package/dist-types/commands/CancelJobCommand.d.ts +6 -6
- package/dist-types/commands/CancelJobsCommand.d.ts +138 -0
- package/dist-types/commands/ListJobsCommand.d.ts +2 -0
- package/dist-types/commands/ListServiceJobsCommand.d.ts +1 -0
- package/dist-types/commands/TerminateJobsCommand.d.ts +128 -0
- package/dist-types/commands/TerminateServiceJobsCommand.d.ts +120 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +260 -6
- package/dist-types/schemas/schemas_0.d.ts +12 -0
- package/dist-types/ts3.4/Batch.d.ts +48 -0
- package/dist-types/ts3.4/BatchClient.d.ts +15 -0
- package/dist-types/ts3.4/commands/CancelJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/TerminateJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/TerminateServiceJobsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +42 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
- package/package.json +1 -1
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { TerminateJobsRequest, TerminateJobsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link TerminateJobsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface TerminateJobsCommandInput extends TerminateJobsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link TerminateJobsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface TerminateJobsCommandOutput extends TerminateJobsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const TerminateJobsCommand_base: {
|
|
22
|
+
new (input: TerminateJobsCommandInput): import("@smithy/core/client").CommandImpl<TerminateJobsCommandInput, TerminateJobsCommandOutput, import("..").BatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: TerminateJobsCommandInput): import("@smithy/core/client").CommandImpl<TerminateJobsCommandInput, TerminateJobsCommandOutput, import("..").BatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Terminates up to 50 jobs in a job queue. This is a bulk version of <a>TerminateJob</a>. Jobs that are in the <code>STARTING</code> or
|
|
28
|
+
* <code>RUNNING</code> state are terminated, which causes them to transition to
|
|
29
|
+
* <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are
|
|
30
|
+
* cancelled.</p>
|
|
31
|
+
* <p>Batch reports the result for each job individually in the response. Jobs that
|
|
32
|
+
* were processed successfully are reported in the <code>successful</code> list. Jobs that
|
|
33
|
+
* encountered errors are reported in the <code>errors</code> list. The response returns an
|
|
34
|
+
* HTTP status code of <code>200</code> even when some jobs encountered errors, so check the
|
|
35
|
+
* <code>errors</code> list. Jobs that can't be found are treated as successfully
|
|
36
|
+
* processed.</p>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { BatchClient, TerminateJobsCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
41
|
+
* // const { BatchClient, TerminateJobsCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
42
|
+
* // import type { BatchClientConfig } from "@aws-sdk/client-batch";
|
|
43
|
+
* const config = {}; // type is BatchClientConfig
|
|
44
|
+
* const client = new BatchClient(config);
|
|
45
|
+
* const input = { // TerminateJobsRequest
|
|
46
|
+
* jobs: [ // StringList // required
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* reason: "STRING_VALUE", // required
|
|
50
|
+
* };
|
|
51
|
+
* const command = new TerminateJobsCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // TerminateJobsResponse
|
|
54
|
+
* // successful: [ // StringList // required
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // errors: [ // TerminateJobsErrorDetailList // required
|
|
58
|
+
* // { // TerminateJobsErrorDetail
|
|
59
|
+
* // job: "STRING_VALUE", // required
|
|
60
|
+
* // code: "STRING_VALUE", // required
|
|
61
|
+
* // message: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param TerminateJobsCommandInput - {@link TerminateJobsCommandInput}
|
|
69
|
+
* @returns {@link TerminateJobsCommandOutput}
|
|
70
|
+
* @see {@link TerminateJobsCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link TerminateJobsCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ClientException} (client fault)
|
|
75
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
76
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
77
|
+
* that's not valid.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ServerException} (server fault)
|
|
80
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link BatchServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @example To terminate multiple jobs
|
|
87
|
+
* ```javascript
|
|
88
|
+
* // This example terminates the jobs with the specified job IDs.
|
|
89
|
+
* const input = {
|
|
90
|
+
* jobs: [
|
|
91
|
+
* "61e743ed-35e4-48da-b2de-5c8333821c84",
|
|
92
|
+
* "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e"
|
|
93
|
+
* ],
|
|
94
|
+
* reason: "Terminating jobs."
|
|
95
|
+
* };
|
|
96
|
+
* const command = new TerminateJobsCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response is
|
|
99
|
+
* {
|
|
100
|
+
* errors: [
|
|
101
|
+
* {
|
|
102
|
+
* code: "ServerException",
|
|
103
|
+
* job: "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
104
|
+
* message: "Failed to read job state. Please retry this job."
|
|
105
|
+
* }
|
|
106
|
+
* ],
|
|
107
|
+
* successful: [
|
|
108
|
+
* "61e743ed-35e4-48da-b2de-5c8333821c84"
|
|
109
|
+
* ]
|
|
110
|
+
* }
|
|
111
|
+
* *\/
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
export declare class TerminateJobsCommand extends TerminateJobsCommand_base {
|
|
117
|
+
/** @internal type navigation helper, not in runtime. */
|
|
118
|
+
protected static __types: {
|
|
119
|
+
api: {
|
|
120
|
+
input: TerminateJobsRequest;
|
|
121
|
+
output: TerminateJobsResponse;
|
|
122
|
+
};
|
|
123
|
+
sdk: {
|
|
124
|
+
input: TerminateJobsCommandInput;
|
|
125
|
+
output: TerminateJobsCommandOutput;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
}
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { TerminateServiceJobsRequest, TerminateServiceJobsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link TerminateServiceJobsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface TerminateServiceJobsCommandInput extends TerminateServiceJobsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link TerminateServiceJobsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface TerminateServiceJobsCommandOutput extends TerminateServiceJobsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const TerminateServiceJobsCommand_base: {
|
|
22
|
+
new (input: TerminateServiceJobsCommandInput): import("@smithy/core/client").CommandImpl<TerminateServiceJobsCommandInput, TerminateServiceJobsCommandOutput, import("..").BatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: TerminateServiceJobsCommandInput): import("@smithy/core/client").CommandImpl<TerminateServiceJobsCommandInput, TerminateServiceJobsCommandOutput, import("..").BatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Terminates up to 50 service jobs in a job queue. This is a bulk version of <a>TerminateServiceJob</a>.</p>
|
|
28
|
+
* <p>Batch reports the result for each service job individually in the response. Service jobs that were processed successfully are reported in the <code>successful</code> list. Service jobs that encountered errors are reported in the <code>errors</code> list. The response returns an HTTP status code of <code>200</code> even when some service jobs encountered errors, so check the <code>errors</code> list. Service jobs that can't be found are treated as successfully processed.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { BatchClient, TerminateServiceJobsCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
33
|
+
* // const { BatchClient, TerminateServiceJobsCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
34
|
+
* // import type { BatchClientConfig } from "@aws-sdk/client-batch";
|
|
35
|
+
* const config = {}; // type is BatchClientConfig
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // TerminateServiceJobsRequest
|
|
38
|
+
* jobs: [ // StringList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* reason: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new TerminateServiceJobsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // TerminateServiceJobsResponse
|
|
46
|
+
* // successful: [ // StringList // required
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // errors: [ // TerminateServiceJobsErrorDetailList // required
|
|
50
|
+
* // { // TerminateServiceJobsErrorDetail
|
|
51
|
+
* // job: "STRING_VALUE", // required
|
|
52
|
+
* // code: "STRING_VALUE", // required
|
|
53
|
+
* // message: "STRING_VALUE", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param TerminateServiceJobsCommandInput - {@link TerminateServiceJobsCommandInput}
|
|
61
|
+
* @returns {@link TerminateServiceJobsCommandOutput}
|
|
62
|
+
* @see {@link TerminateServiceJobsCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link TerminateServiceJobsCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ClientException} (client fault)
|
|
67
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
68
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
69
|
+
* that's not valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ServerException} (server fault)
|
|
72
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link BatchServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @example To terminate multiple service jobs
|
|
79
|
+
* ```javascript
|
|
80
|
+
* // This example terminates the specified service jobs with a reason.
|
|
81
|
+
* const input = {
|
|
82
|
+
* jobs: [
|
|
83
|
+
* "a4d6c728-8ee8-4c65-8e2a-9a5e8f4b7c3d",
|
|
84
|
+
* "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e"
|
|
85
|
+
* ],
|
|
86
|
+
* reason: "Job terminated by user request"
|
|
87
|
+
* };
|
|
88
|
+
* const command = new TerminateServiceJobsCommand(input);
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response is
|
|
91
|
+
* {
|
|
92
|
+
* errors: [
|
|
93
|
+
* {
|
|
94
|
+
* code: "ServerException",
|
|
95
|
+
* job: "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
96
|
+
* message: "Failed to read job state. Please retry this job."
|
|
97
|
+
* }
|
|
98
|
+
* ],
|
|
99
|
+
* successful: [
|
|
100
|
+
* "a4d6c728-8ee8-4c65-8e2a-9a5e8f4b7c3d"
|
|
101
|
+
* ]
|
|
102
|
+
* }
|
|
103
|
+
* *\/
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export declare class TerminateServiceJobsCommand extends TerminateServiceJobsCommand_base {
|
|
109
|
+
/** @internal type navigation helper, not in runtime. */
|
|
110
|
+
protected static __types: {
|
|
111
|
+
api: {
|
|
112
|
+
input: TerminateServiceJobsRequest;
|
|
113
|
+
output: TerminateServiceJobsResponse;
|
|
114
|
+
};
|
|
115
|
+
sdk: {
|
|
116
|
+
input: TerminateServiceJobsCommandInput;
|
|
117
|
+
output: TerminateServiceJobsCommandOutput;
|
|
118
|
+
};
|
|
119
|
+
};
|
|
120
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from "./CancelJobCommand";
|
|
2
|
+
export * from "./CancelJobsCommand";
|
|
2
3
|
export * from "./CreateComputeEnvironmentCommand";
|
|
3
4
|
export * from "./CreateConsumableResourceCommand";
|
|
4
5
|
export * from "./CreateJobQueueCommand";
|
|
@@ -34,7 +35,9 @@ export * from "./SubmitJobCommand";
|
|
|
34
35
|
export * from "./SubmitServiceJobCommand";
|
|
35
36
|
export * from "./TagResourceCommand";
|
|
36
37
|
export * from "./TerminateJobCommand";
|
|
38
|
+
export * from "./TerminateJobsCommand";
|
|
37
39
|
export * from "./TerminateServiceJobCommand";
|
|
40
|
+
export * from "./TerminateServiceJobsCommand";
|
|
38
41
|
export * from "./UntagResourceCommand";
|
|
39
42
|
export * from "./UpdateComputeEnvironmentCommand";
|
|
40
43
|
export * from "./UpdateConsumableResourceCommand";
|
|
@@ -230,10 +230,10 @@ export interface CancelJobRequest {
|
|
|
230
230
|
*/
|
|
231
231
|
jobId: string | undefined;
|
|
232
232
|
/**
|
|
233
|
-
* <p>A message to attach to the job that explains the reason for
|
|
233
|
+
* <p>A message to attach to the job that explains the reason for cancelling it. This message is
|
|
234
234
|
* returned by future <a>DescribeJobs</a> operations on the job. It is also
|
|
235
235
|
* recorded in the Batch activity logs.</p>
|
|
236
|
-
* <p>This parameter has
|
|
236
|
+
* <p>This parameter has a limit of 1024 characters.</p>
|
|
237
237
|
* @public
|
|
238
238
|
*/
|
|
239
239
|
reason: string | undefined;
|
|
@@ -243,6 +243,88 @@ export interface CancelJobRequest {
|
|
|
243
243
|
*/
|
|
244
244
|
export interface CancelJobResponse {
|
|
245
245
|
}
|
|
246
|
+
/**
|
|
247
|
+
* <p>Specifies the jobs to cancel and the reason for the cancellation.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
export interface CancelJobsRequest {
|
|
251
|
+
/**
|
|
252
|
+
* <p>An array of up to 50 Batch job IDs of the jobs to cancel.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
jobs: string[] | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>A message to attach to the job that explains the reason for cancelling it. This message is
|
|
258
|
+
* returned by future <a>DescribeJobs</a> operations on the job. It is also
|
|
259
|
+
* recorded in the Batch activity logs.</p>
|
|
260
|
+
* <p>This parameter has a limit of 1024 characters.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
reason: string | undefined;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* <p>An object that contains the details of a job that couldn't be cancelled by a
|
|
267
|
+
* <code>CancelJobs</code> operation.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export interface CancelJobsErrorDetail {
|
|
271
|
+
/**
|
|
272
|
+
* <p>The Batch job ID of the job that couldn't be cancelled.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
job: string | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* <p>An error code that identifies the reason the job couldn't be cancelled. Valid values are:</p>
|
|
278
|
+
* <ul>
|
|
279
|
+
* <li>
|
|
280
|
+
* <p>
|
|
281
|
+
* <code>ValidationException</code> – A job identifier in the request is malformed or isn't valid.</p>
|
|
282
|
+
* </li>
|
|
283
|
+
* <li>
|
|
284
|
+
* <p>
|
|
285
|
+
* <code>ClientException</code> – The request failed because of a client error.</p>
|
|
286
|
+
* </li>
|
|
287
|
+
* <li>
|
|
288
|
+
* <p>
|
|
289
|
+
* <code>ThrottlingException</code> – The request was throttled. Retry the request.</p>
|
|
290
|
+
* </li>
|
|
291
|
+
* <li>
|
|
292
|
+
* <p>
|
|
293
|
+
* <code>ServerException</code> – An internal error occurred. Retry the request.</p>
|
|
294
|
+
* </li>
|
|
295
|
+
* <li>
|
|
296
|
+
* <p>
|
|
297
|
+
* <code>AccessDenied</code> – The caller isn't authorized to perform the action on the specified job.</p>
|
|
298
|
+
* </li>
|
|
299
|
+
* </ul>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
code: string | undefined;
|
|
303
|
+
/**
|
|
304
|
+
* <p>A message that describes the reason the job couldn't be cancelled.</p>
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
message: string | undefined;
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* <p>The result of a <code>CancelJobs</code> request, including the jobs whose cancellation
|
|
311
|
+
* request was accepted and the errors for jobs that couldn't be cancelled.</p>
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
export interface CancelJobsResponse {
|
|
315
|
+
/**
|
|
316
|
+
* <p>A list of the job IDs whose cancellation request was accepted.</p>
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
successful: string[] | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* <p>A list of <code>CancelJobsErrorDetail</code> items, one for each job that couldn't be
|
|
322
|
+
* cancelled. Each item includes the job ID along with a code and message that describe why the
|
|
323
|
+
* job wasn't cancelled.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
errors: CancelJobsErrorDetail[] | undefined;
|
|
327
|
+
}
|
|
246
328
|
/**
|
|
247
329
|
* <p>Provides information used to select Amazon Machine Images (AMIs) for instances in the
|
|
248
330
|
* compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
@@ -6136,7 +6218,7 @@ export interface JobDetail {
|
|
|
6136
6218
|
*/
|
|
6137
6219
|
ecsProperties?: EcsPropertiesDetail | undefined;
|
|
6138
6220
|
/**
|
|
6139
|
-
* <p>Indicates whether the job is
|
|
6221
|
+
* <p>Indicates whether the job is cancelled.</p>
|
|
6140
6222
|
* @public
|
|
6141
6223
|
*/
|
|
6142
6224
|
isCancelled?: boolean | undefined;
|
|
@@ -7312,6 +7394,16 @@ export interface JobSummary {
|
|
|
7312
7394
|
* @public
|
|
7313
7395
|
*/
|
|
7314
7396
|
jobDefinition?: string | undefined;
|
|
7397
|
+
/**
|
|
7398
|
+
* <p>Indicates whether a cancellation request has been accepted for the job. This field is only present when the value is <code>true</code>.</p>
|
|
7399
|
+
* @public
|
|
7400
|
+
*/
|
|
7401
|
+
isCancelled?: boolean | undefined;
|
|
7402
|
+
/**
|
|
7403
|
+
* <p>Indicates whether a termination request has been accepted for the job. This field is only present when the value is <code>true</code>.</p>
|
|
7404
|
+
* @public
|
|
7405
|
+
*/
|
|
7406
|
+
isTerminated?: boolean | undefined;
|
|
7315
7407
|
}
|
|
7316
7408
|
/**
|
|
7317
7409
|
* @public
|
|
@@ -7841,6 +7933,11 @@ export interface ServiceJobSummary {
|
|
|
7841
7933
|
* @public
|
|
7842
7934
|
*/
|
|
7843
7935
|
stoppedAt?: number | undefined;
|
|
7936
|
+
/**
|
|
7937
|
+
* <p>Indicates whether a termination request has been accepted for the service job. This field is only present when the value is <code>true</code>.</p>
|
|
7938
|
+
* @public
|
|
7939
|
+
*/
|
|
7940
|
+
isTerminated?: boolean | undefined;
|
|
7844
7941
|
}
|
|
7845
7942
|
/**
|
|
7846
7943
|
* @public
|
|
@@ -8639,10 +8736,10 @@ export interface TerminateJobRequest {
|
|
|
8639
8736
|
*/
|
|
8640
8737
|
jobId: string | undefined;
|
|
8641
8738
|
/**
|
|
8642
|
-
* <p>A message to attach to the job that explains the reason for
|
|
8739
|
+
* <p>A message to attach to the job that explains the reason for terminating it. This message is
|
|
8643
8740
|
* returned by future <a>DescribeJobs</a> operations on the job. It is also
|
|
8644
8741
|
* recorded in the Batch activity logs.</p>
|
|
8645
|
-
* <p>This parameter has
|
|
8742
|
+
* <p>This parameter has a limit of 1024 characters.</p>
|
|
8646
8743
|
* @public
|
|
8647
8744
|
*/
|
|
8648
8745
|
reason: string | undefined;
|
|
@@ -8652,6 +8749,88 @@ export interface TerminateJobRequest {
|
|
|
8652
8749
|
*/
|
|
8653
8750
|
export interface TerminateJobResponse {
|
|
8654
8751
|
}
|
|
8752
|
+
/**
|
|
8753
|
+
* <p>Specifies the jobs to terminate and the reason for the termination.</p>
|
|
8754
|
+
* @public
|
|
8755
|
+
*/
|
|
8756
|
+
export interface TerminateJobsRequest {
|
|
8757
|
+
/**
|
|
8758
|
+
* <p>An array of up to 50 Batch job IDs of the jobs to terminate.</p>
|
|
8759
|
+
* @public
|
|
8760
|
+
*/
|
|
8761
|
+
jobs: string[] | undefined;
|
|
8762
|
+
/**
|
|
8763
|
+
* <p>A message to attach to the job that explains the reason for terminating it. This message is
|
|
8764
|
+
* returned by future <a>DescribeJobs</a> operations on the job. It is also
|
|
8765
|
+
* recorded in the Batch activity logs.</p>
|
|
8766
|
+
* <p>This parameter has a limit of 1024 characters.</p>
|
|
8767
|
+
* @public
|
|
8768
|
+
*/
|
|
8769
|
+
reason: string | undefined;
|
|
8770
|
+
}
|
|
8771
|
+
/**
|
|
8772
|
+
* <p>An object that contains the details of a job that couldn't be terminated by a
|
|
8773
|
+
* <code>TerminateJobs</code> operation.</p>
|
|
8774
|
+
* @public
|
|
8775
|
+
*/
|
|
8776
|
+
export interface TerminateJobsErrorDetail {
|
|
8777
|
+
/**
|
|
8778
|
+
* <p>The Batch job ID of the job that couldn't be terminated.</p>
|
|
8779
|
+
* @public
|
|
8780
|
+
*/
|
|
8781
|
+
job: string | undefined;
|
|
8782
|
+
/**
|
|
8783
|
+
* <p>An error code that identifies the reason the job couldn't be terminated. Valid values are:</p>
|
|
8784
|
+
* <ul>
|
|
8785
|
+
* <li>
|
|
8786
|
+
* <p>
|
|
8787
|
+
* <code>ValidationException</code> – A job identifier in the request is malformed or isn't valid.</p>
|
|
8788
|
+
* </li>
|
|
8789
|
+
* <li>
|
|
8790
|
+
* <p>
|
|
8791
|
+
* <code>ClientException</code> – The request failed because of a client error.</p>
|
|
8792
|
+
* </li>
|
|
8793
|
+
* <li>
|
|
8794
|
+
* <p>
|
|
8795
|
+
* <code>ThrottlingException</code> – The request was throttled. Retry the request.</p>
|
|
8796
|
+
* </li>
|
|
8797
|
+
* <li>
|
|
8798
|
+
* <p>
|
|
8799
|
+
* <code>ServerException</code> – An internal error occurred. Retry the request.</p>
|
|
8800
|
+
* </li>
|
|
8801
|
+
* <li>
|
|
8802
|
+
* <p>
|
|
8803
|
+
* <code>AccessDenied</code> – The caller isn't authorized to perform the action on the specified job.</p>
|
|
8804
|
+
* </li>
|
|
8805
|
+
* </ul>
|
|
8806
|
+
* @public
|
|
8807
|
+
*/
|
|
8808
|
+
code: string | undefined;
|
|
8809
|
+
/**
|
|
8810
|
+
* <p>A message that describes the reason the job couldn't be terminated.</p>
|
|
8811
|
+
* @public
|
|
8812
|
+
*/
|
|
8813
|
+
message: string | undefined;
|
|
8814
|
+
}
|
|
8815
|
+
/**
|
|
8816
|
+
* <p>The result of a <code>TerminateJobs</code> request, including the jobs whose termination
|
|
8817
|
+
* request was accepted and the errors for jobs that couldn't be terminated.</p>
|
|
8818
|
+
* @public
|
|
8819
|
+
*/
|
|
8820
|
+
export interface TerminateJobsResponse {
|
|
8821
|
+
/**
|
|
8822
|
+
* <p>A list of the job IDs whose termination request was accepted.</p>
|
|
8823
|
+
* @public
|
|
8824
|
+
*/
|
|
8825
|
+
successful: string[] | undefined;
|
|
8826
|
+
/**
|
|
8827
|
+
* <p>A list of <code>TerminateJobsErrorDetail</code> items, one for each job that couldn't be
|
|
8828
|
+
* terminated. Each item includes the job ID along with a code and message that describe why the
|
|
8829
|
+
* job wasn't terminated.</p>
|
|
8830
|
+
* @public
|
|
8831
|
+
*/
|
|
8832
|
+
errors: TerminateJobsErrorDetail[] | undefined;
|
|
8833
|
+
}
|
|
8655
8834
|
/**
|
|
8656
8835
|
* @public
|
|
8657
8836
|
*/
|
|
@@ -8662,7 +8841,7 @@ export interface TerminateServiceJobRequest {
|
|
|
8662
8841
|
*/
|
|
8663
8842
|
jobId: string | undefined;
|
|
8664
8843
|
/**
|
|
8665
|
-
* <p>A message to attach to the service job that explains the reason for
|
|
8844
|
+
* <p>A message to attach to the service job that explains the reason for terminating it. This message is returned by <code>DescribeServiceJob</code> operations on the service job.</p>
|
|
8666
8845
|
* @public
|
|
8667
8846
|
*/
|
|
8668
8847
|
reason: string | undefined;
|
|
@@ -8672,6 +8851,81 @@ export interface TerminateServiceJobRequest {
|
|
|
8672
8851
|
*/
|
|
8673
8852
|
export interface TerminateServiceJobResponse {
|
|
8674
8853
|
}
|
|
8854
|
+
/**
|
|
8855
|
+
* <p>Specifies the service jobs to terminate and the reason for the termination.</p>
|
|
8856
|
+
* @public
|
|
8857
|
+
*/
|
|
8858
|
+
export interface TerminateServiceJobsRequest {
|
|
8859
|
+
/**
|
|
8860
|
+
* <p>An array of up to 50 service job IDs of the service jobs to terminate.</p>
|
|
8861
|
+
* @public
|
|
8862
|
+
*/
|
|
8863
|
+
jobs: string[] | undefined;
|
|
8864
|
+
/**
|
|
8865
|
+
* <p>A message to attach to the service job that explains the reason for terminating it. This message is returned by <code>DescribeServiceJob</code> operations on the service job.</p>
|
|
8866
|
+
* @public
|
|
8867
|
+
*/
|
|
8868
|
+
reason: string | undefined;
|
|
8869
|
+
}
|
|
8870
|
+
/**
|
|
8871
|
+
* <p>An object that contains the details of a service job that couldn't be terminated by a <code>TerminateServiceJobs</code> operation.</p>
|
|
8872
|
+
* @public
|
|
8873
|
+
*/
|
|
8874
|
+
export interface TerminateServiceJobsErrorDetail {
|
|
8875
|
+
/**
|
|
8876
|
+
* <p>The service job ID of the service job that couldn't be terminated.</p>
|
|
8877
|
+
* @public
|
|
8878
|
+
*/
|
|
8879
|
+
job: string | undefined;
|
|
8880
|
+
/**
|
|
8881
|
+
* <p>An error code that identifies the reason the service job couldn't be terminated. Valid values are:</p>
|
|
8882
|
+
* <ul>
|
|
8883
|
+
* <li>
|
|
8884
|
+
* <p>
|
|
8885
|
+
* <code>ValidationException</code> – A service job identifier in the request is malformed or isn't valid.</p>
|
|
8886
|
+
* </li>
|
|
8887
|
+
* <li>
|
|
8888
|
+
* <p>
|
|
8889
|
+
* <code>ClientException</code> – The request failed because of a client error.</p>
|
|
8890
|
+
* </li>
|
|
8891
|
+
* <li>
|
|
8892
|
+
* <p>
|
|
8893
|
+
* <code>ThrottlingException</code> – The request was throttled. Retry the request.</p>
|
|
8894
|
+
* </li>
|
|
8895
|
+
* <li>
|
|
8896
|
+
* <p>
|
|
8897
|
+
* <code>ServerException</code> – An internal error occurred. Retry the request.</p>
|
|
8898
|
+
* </li>
|
|
8899
|
+
* <li>
|
|
8900
|
+
* <p>
|
|
8901
|
+
* <code>AccessDenied</code> – The caller isn't authorized to perform the action on the specified service job.</p>
|
|
8902
|
+
* </li>
|
|
8903
|
+
* </ul>
|
|
8904
|
+
* @public
|
|
8905
|
+
*/
|
|
8906
|
+
code: string | undefined;
|
|
8907
|
+
/**
|
|
8908
|
+
* <p>A message that describes the reason the service job couldn't be terminated.</p>
|
|
8909
|
+
* @public
|
|
8910
|
+
*/
|
|
8911
|
+
message: string | undefined;
|
|
8912
|
+
}
|
|
8913
|
+
/**
|
|
8914
|
+
* <p>The result of a <code>TerminateServiceJobs</code> request, including the service jobs whose termination request was accepted and the errors for service jobs that couldn't be terminated.</p>
|
|
8915
|
+
* @public
|
|
8916
|
+
*/
|
|
8917
|
+
export interface TerminateServiceJobsResponse {
|
|
8918
|
+
/**
|
|
8919
|
+
* <p>A list of the service job IDs whose termination request was accepted.</p>
|
|
8920
|
+
* @public
|
|
8921
|
+
*/
|
|
8922
|
+
successful: string[] | undefined;
|
|
8923
|
+
/**
|
|
8924
|
+
* <p>A list of <code>TerminateServiceJobsErrorDetail</code> items, one for each service job that couldn't be terminated. Each item includes the service job ID along with a code and message that describe why the service job wasn't terminated.</p>
|
|
8925
|
+
* @public
|
|
8926
|
+
*/
|
|
8927
|
+
errors: TerminateServiceJobsErrorDetail[] | undefined;
|
|
8928
|
+
}
|
|
8675
8929
|
/**
|
|
8676
8930
|
* <p>Contains the parameters for <code>UntagResource</code>.</p>
|
|
8677
8931
|
* @public
|
|
@@ -18,6 +18,9 @@ export declare var AttemptEcsTaskDetails$: StaticStructureSchema;
|
|
|
18
18
|
export declare var AttemptTaskContainerDetails$: StaticStructureSchema;
|
|
19
19
|
export declare var CancelJobRequest$: StaticStructureSchema;
|
|
20
20
|
export declare var CancelJobResponse$: StaticStructureSchema;
|
|
21
|
+
export declare var CancelJobsErrorDetail$: StaticStructureSchema;
|
|
22
|
+
export declare var CancelJobsRequest$: StaticStructureSchema;
|
|
23
|
+
export declare var CancelJobsResponse$: StaticStructureSchema;
|
|
21
24
|
export declare var CapacityLimit$: StaticStructureSchema;
|
|
22
25
|
export declare var CapacityReservationRequest$: StaticStructureSchema;
|
|
23
26
|
export declare var ComputeEnvironmentDetail$: StaticStructureSchema;
|
|
@@ -218,8 +221,14 @@ export declare var TaskContainerProperties$: StaticStructureSchema;
|
|
|
218
221
|
export declare var TaskPropertiesOverride$: StaticStructureSchema;
|
|
219
222
|
export declare var TerminateJobRequest$: StaticStructureSchema;
|
|
220
223
|
export declare var TerminateJobResponse$: StaticStructureSchema;
|
|
224
|
+
export declare var TerminateJobsErrorDetail$: StaticStructureSchema;
|
|
225
|
+
export declare var TerminateJobsRequest$: StaticStructureSchema;
|
|
226
|
+
export declare var TerminateJobsResponse$: StaticStructureSchema;
|
|
221
227
|
export declare var TerminateServiceJobRequest$: StaticStructureSchema;
|
|
222
228
|
export declare var TerminateServiceJobResponse$: StaticStructureSchema;
|
|
229
|
+
export declare var TerminateServiceJobsErrorDetail$: StaticStructureSchema;
|
|
230
|
+
export declare var TerminateServiceJobsRequest$: StaticStructureSchema;
|
|
231
|
+
export declare var TerminateServiceJobsResponse$: StaticStructureSchema;
|
|
223
232
|
export declare var Tmpfs$: StaticStructureSchema;
|
|
224
233
|
export declare var Ulimit$: StaticStructureSchema;
|
|
225
234
|
export declare var UntagResourceRequest$: StaticStructureSchema;
|
|
@@ -242,6 +251,7 @@ export declare var UpdateServiceJobRequest$: StaticStructureSchema;
|
|
|
242
251
|
export declare var UpdateServiceJobResponse$: StaticStructureSchema;
|
|
243
252
|
export declare var Volume$: StaticStructureSchema;
|
|
244
253
|
export declare var CancelJob$: StaticOperationSchema;
|
|
254
|
+
export declare var CancelJobs$: StaticOperationSchema;
|
|
245
255
|
export declare var CreateComputeEnvironment$: StaticOperationSchema;
|
|
246
256
|
export declare var CreateConsumableResource$: StaticOperationSchema;
|
|
247
257
|
export declare var CreateJobQueue$: StaticOperationSchema;
|
|
@@ -277,7 +287,9 @@ export declare var SubmitJob$: StaticOperationSchema;
|
|
|
277
287
|
export declare var SubmitServiceJob$: StaticOperationSchema;
|
|
278
288
|
export declare var TagResource$: StaticOperationSchema;
|
|
279
289
|
export declare var TerminateJob$: StaticOperationSchema;
|
|
290
|
+
export declare var TerminateJobs$: StaticOperationSchema;
|
|
280
291
|
export declare var TerminateServiceJob$: StaticOperationSchema;
|
|
292
|
+
export declare var TerminateServiceJobs$: StaticOperationSchema;
|
|
281
293
|
export declare var UntagResource$: StaticOperationSchema;
|
|
282
294
|
export declare var UpdateComputeEnvironment$: StaticOperationSchema;
|
|
283
295
|
export declare var UpdateConsumableResource$: StaticOperationSchema;
|