@aws-sdk/client-batch 3.774.0 → 3.777.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/dist-cjs/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-cjs/index.js +24 -18
- package/dist-es/BatchClient.js +2 -1
- package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-es/endpoint/EndpointParameters.js +2 -3
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/runtimeExtensions.js +2 -14
- package/dist-types/commands/CancelJobCommand.d.ts +8 -5
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +44 -45
- package/dist-types/commands/CreateConsumableResourceCommand.d.ts +11 -11
- package/dist-types/commands/CreateJobQueueCommand.d.ts +22 -23
- package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +1 -0
- package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +7 -4
- package/dist-types/commands/DeleteConsumableResourceCommand.d.ts +7 -4
- package/dist-types/commands/DeleteJobQueueCommand.d.ts +7 -4
- package/dist-types/commands/DeleteSchedulingPolicyCommand.d.ts +1 -0
- package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +7 -4
- package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +26 -26
- package/dist-types/commands/DescribeConsumableResourceCommand.d.ts +14 -14
- package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +40 -24
- package/dist-types/commands/DescribeJobQueuesCommand.d.ts +14 -14
- package/dist-types/commands/DescribeJobsCommand.d.ts +44 -28
- package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +1 -0
- package/dist-types/commands/GetJobQueueSnapshotCommand.d.ts +1 -0
- package/dist-types/commands/ListConsumableResourcesCommand.d.ts +13 -13
- package/dist-types/commands/ListJobsByConsumableResourceCommand.d.ts +20 -20
- package/dist-types/commands/ListJobsCommand.d.ts +13 -14
- package/dist-types/commands/ListSchedulingPoliciesCommand.d.ts +1 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -8
- package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +58 -43
- package/dist-types/commands/SubmitJobCommand.d.ts +9 -9
- package/dist-types/commands/TagResourceCommand.d.ts +9 -6
- package/dist-types/commands/TerminateJobCommand.d.ts +8 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +7 -7
- package/dist-types/commands/UpdateConsumableResourceCommand.d.ts +9 -9
- package/dist-types/commands/UpdateJobQueueCommand.d.ts +7 -7
- package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +127 -45
- package/dist-types/ts3.4/models/models_0.d.ts +17 -0
- package/package.json +33 -33
|
@@ -143,58 +143,58 @@ declare const DescribeComputeEnvironmentsCommand_base: {
|
|
|
143
143
|
* @throws {@link BatchServiceException}
|
|
144
144
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
145
145
|
*
|
|
146
|
-
*
|
|
146
|
+
*
|
|
147
147
|
* @example To describe a compute environment
|
|
148
148
|
* ```javascript
|
|
149
149
|
* // This example describes the P2OnDemand compute environment.
|
|
150
150
|
* const input = {
|
|
151
|
-
*
|
|
151
|
+
* computeEnvironments: [
|
|
152
152
|
* "P2OnDemand"
|
|
153
153
|
* ]
|
|
154
154
|
* };
|
|
155
155
|
* const command = new DescribeComputeEnvironmentsCommand(input);
|
|
156
156
|
* const response = await client.send(command);
|
|
157
|
-
* /* response
|
|
157
|
+
* /* response is
|
|
158
158
|
* {
|
|
159
|
-
*
|
|
159
|
+
* computeEnvironments: [
|
|
160
160
|
* {
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
* "
|
|
167
|
-
*
|
|
168
|
-
* "instanceRole": "ecsInstanceRole",
|
|
169
|
-
* "instanceTypes": [
|
|
161
|
+
* computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
|
|
162
|
+
* computeEnvironmentName: "P2OnDemand",
|
|
163
|
+
* computeResources: {
|
|
164
|
+
* desiredvCpus: 48,
|
|
165
|
+
* ec2KeyPair: "id_rsa",
|
|
166
|
+
* instanceRole: "ecsInstanceRole",
|
|
167
|
+
* instanceTypes: [
|
|
170
168
|
* "p2"
|
|
171
169
|
* ],
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
170
|
+
* maxvCpus: 128,
|
|
171
|
+
* minvCpus: 0,
|
|
172
|
+
* securityGroupIds: [
|
|
175
173
|
* "sg-cf5093b2"
|
|
176
174
|
* ],
|
|
177
|
-
*
|
|
175
|
+
* subnets: [
|
|
178
176
|
* "subnet-220c0e0a",
|
|
179
177
|
* "subnet-1a95556d",
|
|
180
178
|
* "subnet-978f6dce"
|
|
181
179
|
* ],
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
* }
|
|
180
|
+
* tags: {
|
|
181
|
+
* Name: "Batch Instance - P2OnDemand"
|
|
182
|
+
* },
|
|
183
|
+
* type: "EC2"
|
|
185
184
|
* },
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
185
|
+
* ecsClusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
|
|
186
|
+
* serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
|
187
|
+
* state: "ENABLED",
|
|
188
|
+
* status: "VALID",
|
|
189
|
+
* statusReason: "ComputeEnvironment Healthy",
|
|
190
|
+
* type: "MANAGED"
|
|
191
191
|
* }
|
|
192
192
|
* ]
|
|
193
193
|
* }
|
|
194
194
|
* *\/
|
|
195
|
-
* // example id: to-describe-a-compute-environment-1481153713334
|
|
196
195
|
* ```
|
|
197
196
|
*
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
export declare class DescribeComputeEnvironmentsCommand extends DescribeComputeEnvironmentsCommand_base {
|
|
200
200
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -71,33 +71,33 @@ declare const DescribeConsumableResourceCommand_base: {
|
|
|
71
71
|
* @throws {@link BatchServiceException}
|
|
72
72
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
73
73
|
*
|
|
74
|
-
*
|
|
74
|
+
*
|
|
75
75
|
* @example To get a description of a consumable resource
|
|
76
76
|
* ```javascript
|
|
77
77
|
* // Returns a description of the specified consumable resource.
|
|
78
78
|
* const input = {
|
|
79
|
-
*
|
|
79
|
+
* consumableResource: "myConsumableResource"
|
|
80
80
|
* };
|
|
81
81
|
* const command = new DescribeConsumableResourceCommand(input);
|
|
82
82
|
* const response = await client.send(command);
|
|
83
|
-
* /* response
|
|
83
|
+
* /* response is
|
|
84
84
|
* {
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
85
|
+
* availableQuantity: 123,
|
|
86
|
+
* consumableResourceArn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
|
87
|
+
* consumableResourceName: "myConsumableResource",
|
|
88
|
+
* createdAt: 123,
|
|
89
|
+
* inUseQuantity: 123,
|
|
90
|
+
* resourceType: "REPLENISHABLE",
|
|
91
|
+
* tags: {
|
|
92
|
+
* Department: "Engineering",
|
|
93
|
+
* User: "JaneDoe"
|
|
94
94
|
* },
|
|
95
|
-
*
|
|
95
|
+
* totalQuantity: 123
|
|
96
96
|
* }
|
|
97
97
|
* *\/
|
|
98
|
-
* // example id: to-get-a-description-of-a-consumable-resource-1739495864808
|
|
99
98
|
* ```
|
|
100
99
|
*
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export declare class DescribeConsumableResourceCommand extends DescribeConsumableResourceCommand_base {
|
|
103
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -151,7 +151,7 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
151
151
|
* // swappiness: Number("int"),
|
|
152
152
|
* // },
|
|
153
153
|
* // logConfiguration: { // LogConfiguration
|
|
154
|
-
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
|
|
154
|
+
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
|
|
155
155
|
* // options: { // LogConfigurationOptionsMap
|
|
156
156
|
* // "<keys>": "STRING_VALUE",
|
|
157
157
|
* // },
|
|
@@ -174,6 +174,7 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
174
174
|
* // fargatePlatformConfiguration: { // FargatePlatformConfiguration
|
|
175
175
|
* // platformVersion: "STRING_VALUE",
|
|
176
176
|
* // },
|
|
177
|
+
* // enableExecuteCommand: true || false,
|
|
177
178
|
* // ephemeralStorage: { // EphemeralStorage
|
|
178
179
|
* // sizeInGiB: Number("int"), // required
|
|
179
180
|
* // },
|
|
@@ -274,7 +275,7 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
274
275
|
* // swappiness: Number("int"),
|
|
275
276
|
* // },
|
|
276
277
|
* // logConfiguration: {
|
|
277
|
-
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
|
|
278
|
+
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
|
|
278
279
|
* // options: {
|
|
279
280
|
* // "<keys>": "STRING_VALUE",
|
|
280
281
|
* // },
|
|
@@ -287,6 +288,7 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
287
288
|
* // fargatePlatformConfiguration: {
|
|
288
289
|
* // platformVersion: "STRING_VALUE",
|
|
289
290
|
* // },
|
|
291
|
+
* // enableExecuteCommand: true || false,
|
|
290
292
|
* // ephemeralStorage: {
|
|
291
293
|
* // sizeInGiB: Number("int"), // required
|
|
292
294
|
* // },
|
|
@@ -313,6 +315,12 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
313
315
|
* // ],
|
|
314
316
|
* // environment: "<EnvironmentVariables>",
|
|
315
317
|
* // essential: true || false,
|
|
318
|
+
* // firelensConfiguration: { // FirelensConfiguration
|
|
319
|
+
* // type: "fluentd" || "fluentbit", // required
|
|
320
|
+
* // options: { // FirelensConfigurationOptionsMap
|
|
321
|
+
* // "<keys>": "STRING_VALUE",
|
|
322
|
+
* // },
|
|
323
|
+
* // },
|
|
316
324
|
* // image: "STRING_VALUE", // required
|
|
317
325
|
* // linuxParameters: "<LinuxParameters>",
|
|
318
326
|
* // logConfiguration: "<LogConfiguration>",
|
|
@@ -336,6 +344,7 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
336
344
|
* // networkConfiguration: "<NetworkConfiguration>",
|
|
337
345
|
* // runtimePlatform: "<RuntimePlatform>",
|
|
338
346
|
* // volumes: "<Volumes>",
|
|
347
|
+
* // enableExecuteCommand: true || false,
|
|
339
348
|
* // },
|
|
340
349
|
* // ],
|
|
341
350
|
* // },
|
|
@@ -491,6 +500,12 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
491
500
|
* // ],
|
|
492
501
|
* // environment: "<EnvironmentVariables>",
|
|
493
502
|
* // essential: true || false,
|
|
503
|
+
* // firelensConfiguration: {
|
|
504
|
+
* // type: "fluentd" || "fluentbit", // required
|
|
505
|
+
* // options: {
|
|
506
|
+
* // "<keys>": "STRING_VALUE",
|
|
507
|
+
* // },
|
|
508
|
+
* // },
|
|
494
509
|
* // image: "STRING_VALUE", // required
|
|
495
510
|
* // linuxParameters: "<LinuxParameters>",
|
|
496
511
|
* // logConfiguration: "<LogConfiguration>",
|
|
@@ -514,6 +529,7 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
514
529
|
* // networkConfiguration: "<NetworkConfiguration>",
|
|
515
530
|
* // runtimePlatform: "<RuntimePlatform>",
|
|
516
531
|
* // volumes: "<Volumes>",
|
|
532
|
+
* // enableExecuteCommand: true || false,
|
|
517
533
|
* // },
|
|
518
534
|
* // ],
|
|
519
535
|
* // },
|
|
@@ -670,52 +686,52 @@ declare const DescribeJobDefinitionsCommand_base: {
|
|
|
670
686
|
* @throws {@link BatchServiceException}
|
|
671
687
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
672
688
|
*
|
|
673
|
-
*
|
|
689
|
+
*
|
|
674
690
|
* @example To describe active job definitions
|
|
675
691
|
* ```javascript
|
|
676
692
|
* // This example describes all of your active job definitions.
|
|
677
693
|
* const input = {
|
|
678
|
-
*
|
|
694
|
+
* status: "ACTIVE"
|
|
679
695
|
* };
|
|
680
696
|
* const command = new DescribeJobDefinitionsCommand(input);
|
|
681
697
|
* const response = await client.send(command);
|
|
682
|
-
* /* response
|
|
698
|
+
* /* response is
|
|
683
699
|
* {
|
|
684
|
-
*
|
|
700
|
+
* jobDefinitions: [
|
|
685
701
|
* {
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
* "command": [
|
|
702
|
+
* containerProperties: {
|
|
703
|
+
* command: [
|
|
689
704
|
* "sleep",
|
|
690
705
|
* "60"
|
|
691
706
|
* ],
|
|
692
|
-
*
|
|
693
|
-
*
|
|
694
|
-
*
|
|
695
|
-
*
|
|
707
|
+
* environment: [],
|
|
708
|
+
* image: "busybox",
|
|
709
|
+
* mountPoints: [],
|
|
710
|
+
* resourceRequirements: [
|
|
696
711
|
* {
|
|
697
|
-
*
|
|
698
|
-
*
|
|
712
|
+
* type: "MEMORY",
|
|
713
|
+
* value: "128"
|
|
699
714
|
* },
|
|
700
715
|
* {
|
|
701
|
-
*
|
|
702
|
-
*
|
|
716
|
+
* type: "VCPU",
|
|
717
|
+
* value: "1"
|
|
703
718
|
* }
|
|
704
719
|
* ],
|
|
705
|
-
*
|
|
706
|
-
*
|
|
720
|
+
* ulimits: [],
|
|
721
|
+
* volumes: []
|
|
707
722
|
* },
|
|
708
|
-
*
|
|
709
|
-
*
|
|
710
|
-
*
|
|
711
|
-
*
|
|
723
|
+
* jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
|
|
724
|
+
* jobDefinitionName: "sleep60",
|
|
725
|
+
* revision: 1,
|
|
726
|
+
* status: "ACTIVE",
|
|
727
|
+
* type: "container"
|
|
712
728
|
* }
|
|
713
729
|
* ]
|
|
714
730
|
* }
|
|
715
731
|
* *\/
|
|
716
|
-
* // example id: to-describe-active-job-definitions-1481153895831
|
|
717
732
|
* ```
|
|
718
733
|
*
|
|
734
|
+
* @public
|
|
719
735
|
*/
|
|
720
736
|
export declare class DescribeJobDefinitionsCommand extends DescribeJobDefinitionsCommand_base {
|
|
721
737
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -94,40 +94,40 @@ declare const DescribeJobQueuesCommand_base: {
|
|
|
94
94
|
* @throws {@link BatchServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
96
96
|
*
|
|
97
|
-
*
|
|
97
|
+
*
|
|
98
98
|
* @example To describe a job queue
|
|
99
99
|
* ```javascript
|
|
100
100
|
* // This example describes the HighPriority job queue.
|
|
101
101
|
* const input = {
|
|
102
|
-
*
|
|
102
|
+
* jobQueues: [
|
|
103
103
|
* "HighPriority"
|
|
104
104
|
* ]
|
|
105
105
|
* };
|
|
106
106
|
* const command = new DescribeJobQueuesCommand(input);
|
|
107
107
|
* const response = await client.send(command);
|
|
108
|
-
* /* response
|
|
108
|
+
* /* response is
|
|
109
109
|
* {
|
|
110
|
-
*
|
|
110
|
+
* jobQueues: [
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
112
|
+
* computeEnvironmentOrder: [
|
|
113
113
|
* {
|
|
114
|
-
*
|
|
115
|
-
*
|
|
114
|
+
* computeEnvironment: "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
|
|
115
|
+
* order: 1
|
|
116
116
|
* }
|
|
117
117
|
* ],
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
118
|
+
* jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
|
119
|
+
* jobQueueName: "HighPriority",
|
|
120
|
+
* priority: 1,
|
|
121
|
+
* state: "ENABLED",
|
|
122
|
+
* status: "VALID",
|
|
123
|
+
* statusReason: "JobQueue Healthy"
|
|
124
124
|
* }
|
|
125
125
|
* ]
|
|
126
126
|
* }
|
|
127
127
|
* *\/
|
|
128
|
-
* // example id: to-describe-a-job-queue-1481153995804
|
|
129
128
|
* ```
|
|
130
129
|
*
|
|
130
|
+
* @public
|
|
131
131
|
*/
|
|
132
132
|
export declare class DescribeJobQueuesCommand extends DescribeJobQueuesCommand_base {
|
|
133
133
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -206,7 +206,7 @@ declare const DescribeJobsCommand_base: {
|
|
|
206
206
|
* // swappiness: Number("int"),
|
|
207
207
|
* // },
|
|
208
208
|
* // logConfiguration: { // LogConfiguration
|
|
209
|
-
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
|
|
209
|
+
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
|
|
210
210
|
* // options: { // LogConfigurationOptionsMap
|
|
211
211
|
* // "<keys>": "STRING_VALUE",
|
|
212
212
|
* // },
|
|
@@ -239,6 +239,7 @@ declare const DescribeJobsCommand_base: {
|
|
|
239
239
|
* // repositoryCredentials: { // RepositoryCredentials
|
|
240
240
|
* // credentialsParameter: "STRING_VALUE", // required
|
|
241
241
|
* // },
|
|
242
|
+
* // enableExecuteCommand: true || false,
|
|
242
243
|
* // },
|
|
243
244
|
* // nodeDetails: { // NodeDetails
|
|
244
245
|
* // nodeIndex: Number("int"),
|
|
@@ -330,7 +331,7 @@ declare const DescribeJobsCommand_base: {
|
|
|
330
331
|
* // swappiness: Number("int"),
|
|
331
332
|
* // },
|
|
332
333
|
* // logConfiguration: {
|
|
333
|
-
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
|
|
334
|
+
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
|
|
334
335
|
* // options: {
|
|
335
336
|
* // "<keys>": "STRING_VALUE",
|
|
336
337
|
* // },
|
|
@@ -343,6 +344,7 @@ declare const DescribeJobsCommand_base: {
|
|
|
343
344
|
* // fargatePlatformConfiguration: {
|
|
344
345
|
* // platformVersion: "STRING_VALUE",
|
|
345
346
|
* // },
|
|
347
|
+
* // enableExecuteCommand: true || false,
|
|
346
348
|
* // ephemeralStorage: {
|
|
347
349
|
* // sizeInGiB: Number("int"), // required
|
|
348
350
|
* // },
|
|
@@ -369,6 +371,12 @@ declare const DescribeJobsCommand_base: {
|
|
|
369
371
|
* // ],
|
|
370
372
|
* // environment: "<EnvironmentVariables>",
|
|
371
373
|
* // essential: true || false,
|
|
374
|
+
* // firelensConfiguration: { // FirelensConfiguration
|
|
375
|
+
* // type: "fluentd" || "fluentbit", // required
|
|
376
|
+
* // options: { // FirelensConfigurationOptionsMap
|
|
377
|
+
* // "<keys>": "STRING_VALUE",
|
|
378
|
+
* // },
|
|
379
|
+
* // },
|
|
372
380
|
* // image: "STRING_VALUE", // required
|
|
373
381
|
* // linuxParameters: "<LinuxParameters>",
|
|
374
382
|
* // logConfiguration: "<LogConfiguration>",
|
|
@@ -392,6 +400,7 @@ declare const DescribeJobsCommand_base: {
|
|
|
392
400
|
* // networkConfiguration: "<NetworkConfiguration>",
|
|
393
401
|
* // runtimePlatform: "<RuntimePlatform>",
|
|
394
402
|
* // volumes: "<Volumes>",
|
|
403
|
+
* // enableExecuteCommand: true || false,
|
|
395
404
|
* // },
|
|
396
405
|
* // ],
|
|
397
406
|
* // },
|
|
@@ -710,6 +719,12 @@ declare const DescribeJobsCommand_base: {
|
|
|
710
719
|
* // ],
|
|
711
720
|
* // environment: "<EnvironmentVariables>",
|
|
712
721
|
* // essential: true || false,
|
|
722
|
+
* // firelensConfiguration: {
|
|
723
|
+
* // type: "fluentd" || "fluentbit", // required
|
|
724
|
+
* // options: {
|
|
725
|
+
* // "<keys>": "STRING_VALUE",
|
|
726
|
+
* // },
|
|
727
|
+
* // },
|
|
713
728
|
* // image: "STRING_VALUE",
|
|
714
729
|
* // linuxParameters: "<LinuxParameters>",
|
|
715
730
|
* // logConfiguration: "<LogConfiguration>",
|
|
@@ -739,6 +754,7 @@ declare const DescribeJobsCommand_base: {
|
|
|
739
754
|
* // networkConfiguration: "<NetworkConfiguration>",
|
|
740
755
|
* // runtimePlatform: "<RuntimePlatform>",
|
|
741
756
|
* // volumes: "<Volumes>",
|
|
757
|
+
* // enableExecuteCommand: true || false,
|
|
742
758
|
* // },
|
|
743
759
|
* // ],
|
|
744
760
|
* // },
|
|
@@ -775,53 +791,53 @@ declare const DescribeJobsCommand_base: {
|
|
|
775
791
|
* @throws {@link BatchServiceException}
|
|
776
792
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
777
793
|
*
|
|
778
|
-
*
|
|
794
|
+
*
|
|
779
795
|
* @example To describe a specific job
|
|
780
796
|
* ```javascript
|
|
781
797
|
* // This example describes a job with the specified job ID.
|
|
782
798
|
* const input = {
|
|
783
|
-
*
|
|
799
|
+
* jobs: [
|
|
784
800
|
* "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
|
|
785
801
|
* ]
|
|
786
802
|
* };
|
|
787
803
|
* const command = new DescribeJobsCommand(input);
|
|
788
804
|
* const response = await client.send(command);
|
|
789
|
-
* /* response
|
|
805
|
+
* /* response is
|
|
790
806
|
* {
|
|
791
|
-
*
|
|
807
|
+
* jobs: [
|
|
792
808
|
* {
|
|
793
|
-
*
|
|
794
|
-
*
|
|
809
|
+
* container: {
|
|
810
|
+
* command: [
|
|
795
811
|
* "sleep",
|
|
796
812
|
* "60"
|
|
797
813
|
* ],
|
|
798
|
-
*
|
|
799
|
-
*
|
|
800
|
-
*
|
|
801
|
-
*
|
|
802
|
-
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
*
|
|
806
|
-
*
|
|
814
|
+
* containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c",
|
|
815
|
+
* environment: [],
|
|
816
|
+
* exitCode: 0,
|
|
817
|
+
* image: "busybox",
|
|
818
|
+
* memory: 128,
|
|
819
|
+
* mountPoints: [],
|
|
820
|
+
* ulimits: [],
|
|
821
|
+
* vcpus: 1,
|
|
822
|
+
* volumes: []
|
|
807
823
|
* },
|
|
808
|
-
*
|
|
809
|
-
*
|
|
810
|
-
*
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
*
|
|
815
|
-
*
|
|
816
|
-
*
|
|
817
|
-
*
|
|
824
|
+
* createdAt: 1480460782010,
|
|
825
|
+
* dependsOn: [],
|
|
826
|
+
* jobDefinition: "sleep60",
|
|
827
|
+
* jobId: "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9",
|
|
828
|
+
* jobName: "example",
|
|
829
|
+
* jobQueue: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
|
830
|
+
* parameters: { /* empty *\/ },
|
|
831
|
+
* startedAt: 1480460816500,
|
|
832
|
+
* status: "SUCCEEDED",
|
|
833
|
+
* stoppedAt: 1480460880699
|
|
818
834
|
* }
|
|
819
835
|
* ]
|
|
820
836
|
* }
|
|
821
837
|
* *\/
|
|
822
|
-
* // example id: to-describe-a-specific-job-1481154090490
|
|
823
838
|
* ```
|
|
824
839
|
*
|
|
840
|
+
* @public
|
|
825
841
|
*/
|
|
826
842
|
export declare class DescribeJobsCommand extends DescribeJobsCommand_base {
|
|
827
843
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,6 +82,7 @@ declare const DescribeSchedulingPoliciesCommand_base: {
|
|
|
82
82
|
* @throws {@link BatchServiceException}
|
|
83
83
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
84
84
|
*
|
|
85
|
+
*
|
|
85
86
|
* @public
|
|
86
87
|
*/
|
|
87
88
|
export declare class DescribeSchedulingPoliciesCommand extends DescribeSchedulingPoliciesCommand_base {
|
|
@@ -70,6 +70,7 @@ declare const GetJobQueueSnapshotCommand_base: {
|
|
|
70
70
|
* @throws {@link BatchServiceException}
|
|
71
71
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
72
72
|
*
|
|
73
|
+
*
|
|
73
74
|
* @public
|
|
74
75
|
*/
|
|
75
76
|
export declare class GetJobQueueSnapshotCommand extends GetJobQueueSnapshotCommand_base {
|
|
@@ -80,39 +80,39 @@ declare const ListConsumableResourcesCommand_base: {
|
|
|
80
80
|
* @throws {@link BatchServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
82
82
|
*
|
|
83
|
-
*
|
|
83
|
+
*
|
|
84
84
|
* @example To get a list of a consumable resources
|
|
85
85
|
* ```javascript
|
|
86
86
|
* // Returns a list of the consumable resources for your account.
|
|
87
87
|
* const input = {
|
|
88
|
-
*
|
|
88
|
+
* filters: [
|
|
89
89
|
* {
|
|
90
|
-
*
|
|
91
|
-
*
|
|
90
|
+
* name: "CONSUMABLE_RESOURCE_NAME",
|
|
91
|
+
* values: [
|
|
92
92
|
* "my*"
|
|
93
93
|
* ]
|
|
94
94
|
* }
|
|
95
95
|
* ],
|
|
96
|
-
*
|
|
96
|
+
* maxResults: 123
|
|
97
97
|
* };
|
|
98
98
|
* const command = new ListConsumableResourcesCommand(input);
|
|
99
99
|
* const response = await client.send(command);
|
|
100
|
-
* /* response
|
|
100
|
+
* /* response is
|
|
101
101
|
* {
|
|
102
|
-
*
|
|
102
|
+
* consumableResources: [
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
104
|
+
* consumableResourceArn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
|
105
|
+
* consumableResourceName: "myConsumableResource",
|
|
106
|
+
* inUseQuantity: 12,
|
|
107
|
+
* resourceType: "REPLENISHABLE",
|
|
108
|
+
* totalQuantity: 123
|
|
109
109
|
* }
|
|
110
110
|
* ]
|
|
111
111
|
* }
|
|
112
112
|
* *\/
|
|
113
|
-
* // example id: to-get-a-list-of-a-consumable-resources-1739496071960
|
|
114
113
|
* ```
|
|
115
114
|
*
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
export declare class ListConsumableResourcesCommand extends ListConsumableResourcesCommand_base {
|
|
118
118
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -94,50 +94,50 @@ declare const ListJobsByConsumableResourceCommand_base: {
|
|
|
94
94
|
* @throws {@link BatchServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
96
96
|
*
|
|
97
|
-
*
|
|
97
|
+
*
|
|
98
98
|
* @example To get a list of Batch jobs by consumable resource
|
|
99
99
|
* ```javascript
|
|
100
100
|
* // Returns a list of Batch jobs that require a specific consumable resource.
|
|
101
101
|
* const input = {
|
|
102
|
-
*
|
|
103
|
-
*
|
|
102
|
+
* consumableResource: "myConsumableResource",
|
|
103
|
+
* filters: [
|
|
104
104
|
* {
|
|
105
|
-
*
|
|
106
|
-
*
|
|
105
|
+
* name: "CONSUMABLE_RESOURCE_NAME",
|
|
106
|
+
* values: [
|
|
107
107
|
* "my*"
|
|
108
108
|
* ]
|
|
109
109
|
* }
|
|
110
110
|
* ],
|
|
111
|
-
*
|
|
111
|
+
* maxResults: 123
|
|
112
112
|
* };
|
|
113
113
|
* const command = new ListJobsByConsumableResourceCommand(input);
|
|
114
114
|
* const response = await client.send(command);
|
|
115
|
-
* /* response
|
|
115
|
+
* /* response is
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
117
|
+
* jobs: [
|
|
118
118
|
* {
|
|
119
|
-
*
|
|
120
|
-
*
|
|
119
|
+
* consumableResourceProperties: {
|
|
120
|
+
* consumableResourceList: [
|
|
121
121
|
* {
|
|
122
|
-
*
|
|
123
|
-
*
|
|
122
|
+
* consumableResource: "myConsumableResource",
|
|
123
|
+
* quantity: 123
|
|
124
124
|
* }
|
|
125
125
|
* ]
|
|
126
126
|
* },
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
127
|
+
* createdAt: 1480460782010,
|
|
128
|
+
* jobArn: "arn:aws:batch:us-east-1:012345678910:job/myJob",
|
|
129
|
+
* jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef",
|
|
130
|
+
* jobName: "myJob",
|
|
131
|
+
* jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue",
|
|
132
|
+
* jobStatus: "PENDING",
|
|
133
|
+
* quantity: 123
|
|
134
134
|
* }
|
|
135
135
|
* ]
|
|
136
136
|
* }
|
|
137
137
|
* *\/
|
|
138
|
-
* // example id: to-get-a-list-of-batch-jobs-by-consumable-resource-1739496640347
|
|
139
138
|
* ```
|
|
140
139
|
*
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
export declare class ListJobsByConsumableResourceCommand extends ListJobsByConsumableResourceCommand_base {
|
|
143
143
|
/** @internal type navigation helper, not in runtime. */
|