@aws-sdk/client-ecs 3.722.0 → 3.723.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/index.js +415 -317
- package/dist-es/ECSClient.js +1 -0
- package/dist-es/models/models_0.js +49 -48
- package/dist-es/models/models_1.js +4 -4
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +40 -0
- package/dist-types/commands/CreateTaskSetCommand.d.ts +58 -0
- package/dist-types/commands/DeleteAttributesCommand.d.ts +27 -0
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +32 -0
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +47 -0
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +49 -0
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +39 -0
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +86 -0
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +41 -0
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +41 -0
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +53 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +29 -0
- package/dist-types/commands/ListAttributesCommand.d.ts +25 -0
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +28 -0
- package/dist-types/commands/PutAttributesCommand.d.ts +29 -0
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +249 -0
- package/dist-types/commands/StartTaskCommand.d.ts +56 -0
- package/dist-types/commands/StopTaskCommand.d.ts +63 -0
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +40 -0
- package/dist-types/commands/UpdateClusterCommand.d.ts +189 -0
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +38 -0
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +25 -0
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +172 -0
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +48 -0
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +52 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +9 -7
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +20 -8
- package/package.json +44 -44
|
@@ -183,6 +183,255 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
183
183
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
184
184
|
*
|
|
185
185
|
* @public
|
|
186
|
+
* @example To add an existing capacity provider to a cluuster
|
|
187
|
+
* ```javascript
|
|
188
|
+
* // This example adds an existing capacity provider "MyCapacityProvider2" to a cluster that already has the capacity provider "MyCapacityProvider1" associated with it. Both "MyCapacityProvider2" and "MyCapacityProvider1" need to be specified.
|
|
189
|
+
* const input = {
|
|
190
|
+
* "capacityProviders": [
|
|
191
|
+
* "MyCapacityProvider1",
|
|
192
|
+
* "MyCapacityProvider2"
|
|
193
|
+
* ],
|
|
194
|
+
* "cluster": "MyCluster",
|
|
195
|
+
* "defaultCapacityProviderStrategy": [
|
|
196
|
+
* {
|
|
197
|
+
* "capacityProvider": "MyCapacityProvider1",
|
|
198
|
+
* "weight": 1
|
|
199
|
+
* },
|
|
200
|
+
* {
|
|
201
|
+
* "capacityProvider": "MyCapacityProvider2",
|
|
202
|
+
* "weight": 1
|
|
203
|
+
* }
|
|
204
|
+
* ]
|
|
205
|
+
* };
|
|
206
|
+
* const command = new PutClusterCapacityProvidersCommand(input);
|
|
207
|
+
* const response = await client.send(command);
|
|
208
|
+
* /* response ==
|
|
209
|
+
* {
|
|
210
|
+
* "cluster": {
|
|
211
|
+
* "activeServicesCount": 0,
|
|
212
|
+
* "attachments": [
|
|
213
|
+
* {
|
|
214
|
+
* "type": "as_policy",
|
|
215
|
+
* "details": [
|
|
216
|
+
* {
|
|
217
|
+
* "name": "capacityProviderName",
|
|
218
|
+
* "value": "MyCapacityProvider1"
|
|
219
|
+
* },
|
|
220
|
+
* {
|
|
221
|
+
* "name": "scalingPolicyName",
|
|
222
|
+
* "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
223
|
+
* }
|
|
224
|
+
* ],
|
|
225
|
+
* "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
|
|
226
|
+
* "status": "ACTIVE"
|
|
227
|
+
* },
|
|
228
|
+
* {
|
|
229
|
+
* "type": "as_policy",
|
|
230
|
+
* "details": [
|
|
231
|
+
* {
|
|
232
|
+
* "name": "capacityProviderName",
|
|
233
|
+
* "value": "MyCapacityProvider2"
|
|
234
|
+
* },
|
|
235
|
+
* {
|
|
236
|
+
* "name": "scalingPolicyName",
|
|
237
|
+
* "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
|
|
238
|
+
* }
|
|
239
|
+
* ],
|
|
240
|
+
* "id": "ae592060-2382-4663-9476-b015c685593c",
|
|
241
|
+
* "status": "ACTIVE"
|
|
242
|
+
* }
|
|
243
|
+
* ],
|
|
244
|
+
* "attachmentsStatus": "UPDATE_IN_PROGRESS",
|
|
245
|
+
* "capacityProviders": [
|
|
246
|
+
* "MyCapacityProvider1",
|
|
247
|
+
* "MyCapacityProvider2"
|
|
248
|
+
* ],
|
|
249
|
+
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
|
|
250
|
+
* "clusterName": "MyCluster",
|
|
251
|
+
* "defaultCapacityProviderStrategy": [
|
|
252
|
+
* {
|
|
253
|
+
* "base": 0,
|
|
254
|
+
* "capacityProvider": "MyCapacityProvider1",
|
|
255
|
+
* "weight": 1
|
|
256
|
+
* },
|
|
257
|
+
* {
|
|
258
|
+
* "base": 0,
|
|
259
|
+
* "capacityProvider": "MyCapacityProvider2",
|
|
260
|
+
* "weight": 1
|
|
261
|
+
* }
|
|
262
|
+
* ],
|
|
263
|
+
* "pendingTasksCount": 0,
|
|
264
|
+
* "registeredContainerInstancesCount": 0,
|
|
265
|
+
* "runningTasksCount": 0,
|
|
266
|
+
* "settings": [
|
|
267
|
+
* {
|
|
268
|
+
* "name": "containerInsights",
|
|
269
|
+
* "value": "enabled"
|
|
270
|
+
* }
|
|
271
|
+
* ],
|
|
272
|
+
* "statistics": [],
|
|
273
|
+
* "status": "ACTIVE",
|
|
274
|
+
* "tags": []
|
|
275
|
+
* }
|
|
276
|
+
* }
|
|
277
|
+
* *\/
|
|
278
|
+
* // example id: to-add-an-existing-capacity-provider-to-a-cluster-1734385195698
|
|
279
|
+
* ```
|
|
280
|
+
*
|
|
281
|
+
* @example To remove a capacity provider from a cluster
|
|
282
|
+
* ```javascript
|
|
283
|
+
* // This example removes a capacity provider "MyCapacityProvider2" from a cluster that has both "MyCapacityProvider2" and "MyCapacityProvider1" associated with it. Only "MyCapacityProvider1" needs to be specified in this scenario.
|
|
284
|
+
* const input = {
|
|
285
|
+
* "capacityProviders": [
|
|
286
|
+
* "MyCapacityProvider1"
|
|
287
|
+
* ],
|
|
288
|
+
* "cluster": "MyCluster",
|
|
289
|
+
* "defaultCapacityProviderStrategy": [
|
|
290
|
+
* {
|
|
291
|
+
* "base": 0,
|
|
292
|
+
* "capacityProvider": "MyCapacityProvider1",
|
|
293
|
+
* "weight": 1
|
|
294
|
+
* }
|
|
295
|
+
* ]
|
|
296
|
+
* };
|
|
297
|
+
* const command = new PutClusterCapacityProvidersCommand(input);
|
|
298
|
+
* const response = await client.send(command);
|
|
299
|
+
* /* response ==
|
|
300
|
+
* {
|
|
301
|
+
* "cluster": {
|
|
302
|
+
* "activeServicesCount": 0,
|
|
303
|
+
* "attachments": [
|
|
304
|
+
* {
|
|
305
|
+
* "type": "as_policy",
|
|
306
|
+
* "details": [
|
|
307
|
+
* {
|
|
308
|
+
* "name": "capacityProviderName",
|
|
309
|
+
* "value": "MyCapacityProvider1"
|
|
310
|
+
* },
|
|
311
|
+
* {
|
|
312
|
+
* "name": "scalingPolicyName",
|
|
313
|
+
* "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
314
|
+
* }
|
|
315
|
+
* ],
|
|
316
|
+
* "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
|
|
317
|
+
* "status": "ACTIVE"
|
|
318
|
+
* },
|
|
319
|
+
* {
|
|
320
|
+
* "type": "as_policy",
|
|
321
|
+
* "details": [
|
|
322
|
+
* {
|
|
323
|
+
* "name": "capacityProviderName",
|
|
324
|
+
* "value": "MyCapacityProvider2"
|
|
325
|
+
* },
|
|
326
|
+
* {
|
|
327
|
+
* "name": "scalingPolicyName",
|
|
328
|
+
* "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
|
|
329
|
+
* }
|
|
330
|
+
* ],
|
|
331
|
+
* "id": "ae592060-2382-4663-9476-b015c685593c",
|
|
332
|
+
* "status": "DELETING"
|
|
333
|
+
* }
|
|
334
|
+
* ],
|
|
335
|
+
* "attachmentsStatus": "UPDATE_IN_PROGRESS",
|
|
336
|
+
* "capacityProviders": [
|
|
337
|
+
* "MyCapacityProvider1"
|
|
338
|
+
* ],
|
|
339
|
+
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
|
|
340
|
+
* "clusterName": "MyCluster",
|
|
341
|
+
* "defaultCapacityProviderStrategy": [
|
|
342
|
+
* {
|
|
343
|
+
* "base": 0,
|
|
344
|
+
* "capacityProvider": "MyCapacityProvider1",
|
|
345
|
+
* "weight": 1
|
|
346
|
+
* }
|
|
347
|
+
* ],
|
|
348
|
+
* "pendingTasksCount": 0,
|
|
349
|
+
* "registeredContainerInstancesCount": 0,
|
|
350
|
+
* "runningTasksCount": 0,
|
|
351
|
+
* "settings": [
|
|
352
|
+
* {
|
|
353
|
+
* "name": "containerInsights",
|
|
354
|
+
* "value": "enabled"
|
|
355
|
+
* }
|
|
356
|
+
* ],
|
|
357
|
+
* "statistics": [],
|
|
358
|
+
* "status": "ACTIVE",
|
|
359
|
+
* "tags": []
|
|
360
|
+
* }
|
|
361
|
+
* }
|
|
362
|
+
* *\/
|
|
363
|
+
* // example id: to-remove-a-capacity-provider-from-a-cluster-1734386641517
|
|
364
|
+
* ```
|
|
365
|
+
*
|
|
366
|
+
* @example To remove all capacity providers from a cluster
|
|
367
|
+
* ```javascript
|
|
368
|
+
* // This example removes all capacity providers associated with a cluster.
|
|
369
|
+
* const input = {
|
|
370
|
+
* "capacityProviders": [],
|
|
371
|
+
* "cluster": "MyCluster",
|
|
372
|
+
* "defaultCapacityProviderStrategy": []
|
|
373
|
+
* };
|
|
374
|
+
* const command = new PutClusterCapacityProvidersCommand(input);
|
|
375
|
+
* const response = await client.send(command);
|
|
376
|
+
* /* response ==
|
|
377
|
+
* {
|
|
378
|
+
* "cluster": {
|
|
379
|
+
* "activeServicesCount": 0,
|
|
380
|
+
* "attachments": [
|
|
381
|
+
* {
|
|
382
|
+
* "type": "as_policy",
|
|
383
|
+
* "details": [
|
|
384
|
+
* {
|
|
385
|
+
* "name": "capacityProviderName",
|
|
386
|
+
* "value": "MyCapacityProvider1"
|
|
387
|
+
* },
|
|
388
|
+
* {
|
|
389
|
+
* "name": "scalingPolicyName",
|
|
390
|
+
* "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
391
|
+
* }
|
|
392
|
+
* ],
|
|
393
|
+
* "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
|
|
394
|
+
* "status": "DELETING"
|
|
395
|
+
* },
|
|
396
|
+
* {
|
|
397
|
+
* "type": "as_policy",
|
|
398
|
+
* "details": [
|
|
399
|
+
* {
|
|
400
|
+
* "name": "capacityProviderName",
|
|
401
|
+
* "value": "MyCapacityProvider2"
|
|
402
|
+
* },
|
|
403
|
+
* {
|
|
404
|
+
* "name": "scalingPolicyName",
|
|
405
|
+
* "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
|
|
406
|
+
* }
|
|
407
|
+
* ],
|
|
408
|
+
* "id": "ae592060-2382-4663-9476-b015c685593c",
|
|
409
|
+
* "status": "DELETING"
|
|
410
|
+
* }
|
|
411
|
+
* ],
|
|
412
|
+
* "attachmentsStatus": "UPDATE_IN_PROGRESS",
|
|
413
|
+
* "capacityProviders": [],
|
|
414
|
+
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
|
|
415
|
+
* "clusterName": "MyCluster",
|
|
416
|
+
* "defaultCapacityProviderStrategy": [],
|
|
417
|
+
* "pendingTasksCount": 0,
|
|
418
|
+
* "registeredContainerInstancesCount": 0,
|
|
419
|
+
* "runningTasksCount": 0,
|
|
420
|
+
* "settings": [
|
|
421
|
+
* {
|
|
422
|
+
* "name": "containerInsights",
|
|
423
|
+
* "value": "enabled"
|
|
424
|
+
* }
|
|
425
|
+
* ],
|
|
426
|
+
* "statistics": [],
|
|
427
|
+
* "status": "ACTIVE",
|
|
428
|
+
* "tags": []
|
|
429
|
+
* }
|
|
430
|
+
* }
|
|
431
|
+
* *\/
|
|
432
|
+
* // example id: to-remove-all-capacity-providers-from-a-cluster-1734387170874
|
|
433
|
+
* ```
|
|
434
|
+
*
|
|
186
435
|
*/
|
|
187
436
|
export declare class PutClusterCapacityProvidersCommand extends PutClusterCapacityProvidersCommand_base {
|
|
188
437
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -362,6 +362,62 @@ declare const StartTaskCommand_base: {
|
|
|
362
362
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
363
363
|
*
|
|
364
364
|
* @public
|
|
365
|
+
* @example To start a new task
|
|
366
|
+
* ```javascript
|
|
367
|
+
* // This example starts a new task in the cluster "MyCluster" on the specified container instance using the latest revision of the "hello-world" task definition.
|
|
368
|
+
* const input = {
|
|
369
|
+
* "cluster": "MyCluster",
|
|
370
|
+
* "containerInstances": [
|
|
371
|
+
* "4c543eed-f83f-47da-b1d8-3d23f1da4c64"
|
|
372
|
+
* ],
|
|
373
|
+
* "taskDefinition": "hello-world"
|
|
374
|
+
* };
|
|
375
|
+
* const command = new StartTaskCommand(input);
|
|
376
|
+
* const response = await client.send(command);
|
|
377
|
+
* /* response ==
|
|
378
|
+
* {
|
|
379
|
+
* "failures": [],
|
|
380
|
+
* "tasks": [
|
|
381
|
+
* {
|
|
382
|
+
* "version": 1,
|
|
383
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
384
|
+
* "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/default/4c543eed-f83f-47da-b1d8-3d23f1da4c64",
|
|
385
|
+
* "containers": [
|
|
386
|
+
* {
|
|
387
|
+
* "name": "wordpress",
|
|
388
|
+
* "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e76594d4-27e1-4c74-98b5-46a6435eb769",
|
|
389
|
+
* "lastStatus": "PENDING",
|
|
390
|
+
* "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb"
|
|
391
|
+
* },
|
|
392
|
+
* {
|
|
393
|
+
* "name": "mysql",
|
|
394
|
+
* "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/default/b19106ea-4fa8-4f1d-9767-96922c82b070",
|
|
395
|
+
* "lastStatus": "PENDING",
|
|
396
|
+
* "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb"
|
|
397
|
+
* }
|
|
398
|
+
* ],
|
|
399
|
+
* "createdAt": 1479765460.842,
|
|
400
|
+
* "desiredStatus": "RUNNING",
|
|
401
|
+
* "lastStatus": "PENDING",
|
|
402
|
+
* "overrides": {
|
|
403
|
+
* "containerOverrides": [
|
|
404
|
+
* {
|
|
405
|
+
* "name": "wordpress"
|
|
406
|
+
* },
|
|
407
|
+
* {
|
|
408
|
+
* "name": "mysql"
|
|
409
|
+
* }
|
|
410
|
+
* ]
|
|
411
|
+
* },
|
|
412
|
+
* "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb",
|
|
413
|
+
* "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
|
|
414
|
+
* }
|
|
415
|
+
* ]
|
|
416
|
+
* }
|
|
417
|
+
* *\/
|
|
418
|
+
* // example id: to-start-a-new-task-1734455482966
|
|
419
|
+
* ```
|
|
420
|
+
*
|
|
365
421
|
*/
|
|
366
422
|
export declare class StartTaskCommand extends StartTaskCommand_base {
|
|
367
423
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -256,6 +256,69 @@ declare const StopTaskCommand_base: {
|
|
|
256
256
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
257
257
|
*
|
|
258
258
|
* @public
|
|
259
|
+
* @example To stop a task
|
|
260
|
+
* ```javascript
|
|
261
|
+
* // This example stops a task with ID "1dc5c17a-422b-4dc4-b493-371970c6c4d6" in cluster "MyCluster".
|
|
262
|
+
* const input = {
|
|
263
|
+
* "cluster": "MyCluster",
|
|
264
|
+
* "reason": "testing stop task.",
|
|
265
|
+
* "task": "1dc5c17a-422b-4dc4-b493-371970c6c4d6"
|
|
266
|
+
* };
|
|
267
|
+
* const command = new StopTaskCommand(input);
|
|
268
|
+
* const response = await client.send(command);
|
|
269
|
+
* /* response ==
|
|
270
|
+
* {
|
|
271
|
+
* "task": {
|
|
272
|
+
* "version": 0,
|
|
273
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/MyCluster",
|
|
274
|
+
* "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/MyCluster/5991d8da-1d59-49d2-a31f-4230f9e73140",
|
|
275
|
+
* "containers": [
|
|
276
|
+
* {
|
|
277
|
+
* "name": "simple-app",
|
|
278
|
+
* "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/4df26bb4-f057-467b-a079-961675296e64",
|
|
279
|
+
* "lastStatus": "RUNNING",
|
|
280
|
+
* "networkBindings": [
|
|
281
|
+
* {
|
|
282
|
+
* "bindIP": "0.0.0.0",
|
|
283
|
+
* "containerPort": 80,
|
|
284
|
+
* "hostPort": 32774,
|
|
285
|
+
* "protocol": "tcp"
|
|
286
|
+
* }
|
|
287
|
+
* ],
|
|
288
|
+
* "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6"
|
|
289
|
+
* },
|
|
290
|
+
* {
|
|
291
|
+
* "name": "busybox",
|
|
292
|
+
* "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e09064f7-7361-4c87-8ab9-8d073bbdbcb9",
|
|
293
|
+
* "lastStatus": "RUNNING",
|
|
294
|
+
* "networkBindings": [],
|
|
295
|
+
* "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6"
|
|
296
|
+
* }
|
|
297
|
+
* ],
|
|
298
|
+
* "createdAt": 1476822811.295,
|
|
299
|
+
* "desiredStatus": "STOPPED",
|
|
300
|
+
* "lastStatus": "RUNNING",
|
|
301
|
+
* "overrides": {
|
|
302
|
+
* "containerOverrides": [
|
|
303
|
+
* {
|
|
304
|
+
* "name": "simple-app"
|
|
305
|
+
* },
|
|
306
|
+
* {
|
|
307
|
+
* "name": "busybox"
|
|
308
|
+
* }
|
|
309
|
+
* ]
|
|
310
|
+
* },
|
|
311
|
+
* "startedAt": 1476822833.998,
|
|
312
|
+
* "startedBy": "ecs-svc/9223370560032507596",
|
|
313
|
+
* "stoppedReason": "testing stop task.",
|
|
314
|
+
* "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/1dc5c17a-422b-4dc4-b493-371970c6c4d6",
|
|
315
|
+
* "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-dynamic-ports:1"
|
|
316
|
+
* }
|
|
317
|
+
* }
|
|
318
|
+
* *\/
|
|
319
|
+
* // example id: to-stop-a-task-1734457210346
|
|
320
|
+
* ```
|
|
321
|
+
*
|
|
259
322
|
*/
|
|
260
323
|
export declare class StopTaskCommand extends StopTaskCommand_base {
|
|
261
324
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -112,6 +112,46 @@ declare const UpdateCapacityProviderCommand_base: {
|
|
|
112
112
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
113
113
|
*
|
|
114
114
|
* @public
|
|
115
|
+
* @example To update a capacity provider's parameters
|
|
116
|
+
* ```javascript
|
|
117
|
+
* // This example updates the targetCapacity and instanceWarmupPeriod parameters for the capacity provider MyCapacityProvider to 90 and 150 respectively.
|
|
118
|
+
* const input = {
|
|
119
|
+
* "name": "MyCapacityProvider",
|
|
120
|
+
* "autoScalingGroupProvider": {
|
|
121
|
+
* "managedScaling": {
|
|
122
|
+
* "instanceWarmupPeriod": 150,
|
|
123
|
+
* "status": "ENABLED",
|
|
124
|
+
* "targetCapacity": 90
|
|
125
|
+
* }
|
|
126
|
+
* }
|
|
127
|
+
* };
|
|
128
|
+
* const command = new UpdateCapacityProviderCommand(input);
|
|
129
|
+
* const response = await client.send(command);
|
|
130
|
+
* /* response ==
|
|
131
|
+
* {
|
|
132
|
+
* "capacityProvider": {
|
|
133
|
+
* "name": "MyCapacityProvider",
|
|
134
|
+
* "autoScalingGroupProvider": {
|
|
135
|
+
* "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG",
|
|
136
|
+
* "managedScaling": {
|
|
137
|
+
* "instanceWarmupPeriod": 150,
|
|
138
|
+
* "maximumScalingStepSize": 10000,
|
|
139
|
+
* "minimumScalingStepSize": 1,
|
|
140
|
+
* "status": "ENABLED",
|
|
141
|
+
* "targetCapacity": 90
|
|
142
|
+
* },
|
|
143
|
+
* "managedTerminationProtection": "ENABLED"
|
|
144
|
+
* },
|
|
145
|
+
* "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider",
|
|
146
|
+
* "status": "ACTIVE",
|
|
147
|
+
* "tags": [],
|
|
148
|
+
* "updateStatus": "UPDATE_COMPLETE"
|
|
149
|
+
* }
|
|
150
|
+
* }
|
|
151
|
+
* *\/
|
|
152
|
+
* // example id: to-update-a-capacity-providers-parameters-1734557290198
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
115
155
|
*/
|
|
116
156
|
export declare class UpdateCapacityProviderCommand extends UpdateCapacityProviderCommand_base {
|
|
117
157
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -179,6 +179,195 @@ declare const UpdateClusterCommand_base: {
|
|
|
179
179
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
180
180
|
*
|
|
181
181
|
* @public
|
|
182
|
+
* @example To update a cluster's observability settings.
|
|
183
|
+
* ```javascript
|
|
184
|
+
* // This example turns on enhanced containerInsights in an existing cluster.
|
|
185
|
+
* const input = {
|
|
186
|
+
* "cluster": "ECS-project-update-cluster",
|
|
187
|
+
* "settings": [
|
|
188
|
+
* {
|
|
189
|
+
* "name": "containerInsights",
|
|
190
|
+
* "value": "enhanced"
|
|
191
|
+
* }
|
|
192
|
+
* ]
|
|
193
|
+
* };
|
|
194
|
+
* const command = new UpdateClusterCommand(input);
|
|
195
|
+
* const response = await client.send(command);
|
|
196
|
+
* /* response ==
|
|
197
|
+
* {
|
|
198
|
+
* "cluster": {
|
|
199
|
+
* "activeServicesCount": 0,
|
|
200
|
+
* "attachments": [
|
|
201
|
+
* {
|
|
202
|
+
* "type": "as_policy",
|
|
203
|
+
* "details": [
|
|
204
|
+
* {
|
|
205
|
+
* "name": "capacityProviderName",
|
|
206
|
+
* "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
|
|
207
|
+
* },
|
|
208
|
+
* {
|
|
209
|
+
* "name": "scalingPolicyName",
|
|
210
|
+
* "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93"
|
|
211
|
+
* }
|
|
212
|
+
* ],
|
|
213
|
+
* "id": "069d002b-7634-42e4-b1d4-544f4c8f6380",
|
|
214
|
+
* "status": "CREATED"
|
|
215
|
+
* },
|
|
216
|
+
* {
|
|
217
|
+
* "type": "managed_draining",
|
|
218
|
+
* "details": [
|
|
219
|
+
* {
|
|
220
|
+
* "name": "capacityProviderName",
|
|
221
|
+
* "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
|
|
222
|
+
* },
|
|
223
|
+
* {
|
|
224
|
+
* "name": "autoScalingLifecycleHookName",
|
|
225
|
+
* "value": "ecs-managed-draining-termination-hook"
|
|
226
|
+
* }
|
|
227
|
+
* ],
|
|
228
|
+
* "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a",
|
|
229
|
+
* "status": "CREATED"
|
|
230
|
+
* },
|
|
231
|
+
* {
|
|
232
|
+
* "type": "sc",
|
|
233
|
+
* "details": [],
|
|
234
|
+
* "id": "45d0b36f-8cff-46b6-9380-1288744802ab",
|
|
235
|
+
* "status": "ATTACHED"
|
|
236
|
+
* }
|
|
237
|
+
* ],
|
|
238
|
+
* "attachmentsStatus": "UPDATE_COMPLETE",
|
|
239
|
+
* "capacityProviders": [
|
|
240
|
+
* "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
|
|
241
|
+
* ],
|
|
242
|
+
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster",
|
|
243
|
+
* "clusterName": "ECS-project-update-cluster",
|
|
244
|
+
* "defaultCapacityProviderStrategy": [
|
|
245
|
+
* {
|
|
246
|
+
* "base": 0,
|
|
247
|
+
* "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
|
|
248
|
+
* "weight": 1
|
|
249
|
+
* }
|
|
250
|
+
* ],
|
|
251
|
+
* "pendingTasksCount": 0,
|
|
252
|
+
* "registeredContainerInstancesCount": 0,
|
|
253
|
+
* "runningTasksCount": 0,
|
|
254
|
+
* "serviceConnectDefaults": {
|
|
255
|
+
* "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx"
|
|
256
|
+
* },
|
|
257
|
+
* "settings": [
|
|
258
|
+
* {
|
|
259
|
+
* "name": "containerInsights",
|
|
260
|
+
* "value": "enhanced"
|
|
261
|
+
* }
|
|
262
|
+
* ],
|
|
263
|
+
* "statistics": [],
|
|
264
|
+
* "status": "ACTIVE",
|
|
265
|
+
* "tags": []
|
|
266
|
+
* }
|
|
267
|
+
* }
|
|
268
|
+
* *\/
|
|
269
|
+
* // example id: to-update-a-clusters-observability-settings-1734626018966
|
|
270
|
+
* ```
|
|
271
|
+
*
|
|
272
|
+
* @example To update a cluster's Service Connect defaults.
|
|
273
|
+
* ```javascript
|
|
274
|
+
* // This example sets a default Service Connect namespace.
|
|
275
|
+
* const input = {
|
|
276
|
+
* "cluster": "ECS-project-update-cluster",
|
|
277
|
+
* "serviceConnectDefaults": {
|
|
278
|
+
* "namespace": "test"
|
|
279
|
+
* }
|
|
280
|
+
* };
|
|
281
|
+
* const command = new UpdateClusterCommand(input);
|
|
282
|
+
* const response = await client.send(command);
|
|
283
|
+
* /* response ==
|
|
284
|
+
* {
|
|
285
|
+
* "cluster": {
|
|
286
|
+
* "activeServicesCount": 0,
|
|
287
|
+
* "attachments": [
|
|
288
|
+
* {
|
|
289
|
+
* "type": "as_policy",
|
|
290
|
+
* "details": [
|
|
291
|
+
* {
|
|
292
|
+
* "name": "capacityProviderName",
|
|
293
|
+
* "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
|
|
294
|
+
* },
|
|
295
|
+
* {
|
|
296
|
+
* "name": "scalingPolicyName",
|
|
297
|
+
* "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93"
|
|
298
|
+
* }
|
|
299
|
+
* ],
|
|
300
|
+
* "id": "069d002b-7634-42e4-b1d4-544f4c8f6380",
|
|
301
|
+
* "status": "CREATED"
|
|
302
|
+
* },
|
|
303
|
+
* {
|
|
304
|
+
* "type": "managed_draining",
|
|
305
|
+
* "details": [
|
|
306
|
+
* {
|
|
307
|
+
* "name": "capacityProviderName",
|
|
308
|
+
* "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
|
|
309
|
+
* },
|
|
310
|
+
* {
|
|
311
|
+
* "name": "autoScalingLifecycleHookName",
|
|
312
|
+
* "value": "ecs-managed-draining-termination-hook"
|
|
313
|
+
* }
|
|
314
|
+
* ],
|
|
315
|
+
* "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a",
|
|
316
|
+
* "status": "CREATED"
|
|
317
|
+
* },
|
|
318
|
+
* {
|
|
319
|
+
* "type": "sc",
|
|
320
|
+
* "details": [],
|
|
321
|
+
* "id": "45d0b36f-8cff-46b6-9380-1288744802ab",
|
|
322
|
+
* "status": "DELETED"
|
|
323
|
+
* },
|
|
324
|
+
* {
|
|
325
|
+
* "type": "sc",
|
|
326
|
+
* "details": [],
|
|
327
|
+
* "id": "3e6890c3-609c-4832-91de-d6ca891b3ef1",
|
|
328
|
+
* "status": "ATTACHED"
|
|
329
|
+
* },
|
|
330
|
+
* {
|
|
331
|
+
* "type": "sc",
|
|
332
|
+
* "details": [],
|
|
333
|
+
* "id": "961b8ec1-c2f1-4070-8495-e669b7668e90",
|
|
334
|
+
* "status": "DELETED"
|
|
335
|
+
* }
|
|
336
|
+
* ],
|
|
337
|
+
* "attachmentsStatus": "UPDATE_COMPLETE",
|
|
338
|
+
* "capacityProviders": [
|
|
339
|
+
* "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
|
|
340
|
+
* ],
|
|
341
|
+
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster",
|
|
342
|
+
* "clusterName": "ECS-project-update-cluster",
|
|
343
|
+
* "defaultCapacityProviderStrategy": [
|
|
344
|
+
* {
|
|
345
|
+
* "base": 0,
|
|
346
|
+
* "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
|
|
347
|
+
* "weight": 1
|
|
348
|
+
* }
|
|
349
|
+
* ],
|
|
350
|
+
* "pendingTasksCount": 0,
|
|
351
|
+
* "registeredContainerInstancesCount": 0,
|
|
352
|
+
* "runningTasksCount": 0,
|
|
353
|
+
* "serviceConnectDefaults": {
|
|
354
|
+
* "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr"
|
|
355
|
+
* },
|
|
356
|
+
* "settings": [
|
|
357
|
+
* {
|
|
358
|
+
* "name": "containerInsights",
|
|
359
|
+
* "value": "enhanced"
|
|
360
|
+
* }
|
|
361
|
+
* ],
|
|
362
|
+
* "statistics": [],
|
|
363
|
+
* "status": "ACTIVE",
|
|
364
|
+
* "tags": []
|
|
365
|
+
* }
|
|
366
|
+
* }
|
|
367
|
+
* *\/
|
|
368
|
+
* // example id: to-update-a-clusters-service-connect-defaults-1734626891648
|
|
369
|
+
* ```
|
|
370
|
+
*
|
|
182
371
|
*/
|
|
183
372
|
export declare class UpdateClusterCommand extends UpdateClusterCommand_base {
|
|
184
373
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -156,6 +156,44 @@ declare const UpdateClusterSettingsCommand_base: {
|
|
|
156
156
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
157
157
|
*
|
|
158
158
|
* @public
|
|
159
|
+
* @example To update a cluster's settings
|
|
160
|
+
* ```javascript
|
|
161
|
+
* // This example enables CloudWatch Container Insights for the default cluster.
|
|
162
|
+
* const input = {
|
|
163
|
+
* "cluster": "default",
|
|
164
|
+
* "settings": [
|
|
165
|
+
* {
|
|
166
|
+
* "name": "containerInsights",
|
|
167
|
+
* "value": "enabled"
|
|
168
|
+
* }
|
|
169
|
+
* ]
|
|
170
|
+
* };
|
|
171
|
+
* const command = new UpdateClusterSettingsCommand(input);
|
|
172
|
+
* const response = await client.send(command);
|
|
173
|
+
* /* response ==
|
|
174
|
+
* {
|
|
175
|
+
* "cluster": {
|
|
176
|
+
* "activeServicesCount": 0,
|
|
177
|
+
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
|
|
178
|
+
* "clusterName": "default",
|
|
179
|
+
* "pendingTasksCount": 0,
|
|
180
|
+
* "registeredContainerInstancesCount": 0,
|
|
181
|
+
* "runningTasksCount": 0,
|
|
182
|
+
* "settings": [
|
|
183
|
+
* {
|
|
184
|
+
* "name": "containerInsights",
|
|
185
|
+
* "value": "enabled"
|
|
186
|
+
* }
|
|
187
|
+
* ],
|
|
188
|
+
* "statistics": [],
|
|
189
|
+
* "status": "ACTIVE",
|
|
190
|
+
* "tags": []
|
|
191
|
+
* }
|
|
192
|
+
* }
|
|
193
|
+
* *\/
|
|
194
|
+
* // example id: to-update-a-clusters-settings-1734628004887
|
|
195
|
+
* ```
|
|
196
|
+
*
|
|
159
197
|
*/
|
|
160
198
|
export declare class UpdateClusterSettingsCommand extends UpdateClusterSettingsCommand_base {
|
|
161
199
|
/** @internal type navigation helper, not in runtime. */
|