@aws-sdk/client-ecs 3.775.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-types/commands/CreateCapacityProviderCommand.d.ts +25 -25
- package/dist-types/commands/CreateClusterCommand.d.ts +12 -12
- package/dist-types/commands/CreateServiceCommand.d.ts +75 -76
- package/dist-types/commands/CreateTaskSetCommand.d.ts +33 -33
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +19 -20
- package/dist-types/commands/DeleteAttributesCommand.d.ts +10 -10
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +18 -18
- package/dist-types/commands/DeleteClusterCommand.d.ts +12 -12
- package/dist-types/commands/DeleteServiceCommand.d.ts +7 -4
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +23 -23
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +30 -30
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +9 -6
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +22 -22
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +60 -61
- package/dist-types/commands/DescribeClustersCommand.d.ts +9 -9
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +49 -49
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +1 -41
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +1 -41
- package/dist-types/commands/DescribeServicesCommand.d.ts +32 -32
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +33 -33
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +30 -30
- package/dist-types/commands/DescribeTasksCommand.d.ts +25 -25
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +1 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +17 -17
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +10 -10
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +31 -32
- package/dist-types/commands/ListAttributesCommand.d.ts +11 -11
- package/dist-types/commands/ListClustersCommand.d.ts +5 -5
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +5 -5
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +12 -12
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +1 -0
- package/dist-types/commands/ListServicesCommand.d.ts +5 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -7
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +16 -17
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +16 -17
- package/dist-types/commands/ListTasksCommand.d.ts +16 -17
- package/dist-types/commands/PutAccountSettingCommand.d.ts +21 -22
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +9 -9
- package/dist-types/commands/PutAttributesCommand.d.ts +12 -12
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +129 -131
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +1 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +29 -29
- package/dist-types/commands/RunTaskCommand.d.ts +19 -19
- package/dist-types/commands/StartTaskCommand.d.ts +29 -29
- package/dist-types/commands/StopTaskCommand.d.ts +37 -37
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +1 -0
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +1 -0
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +10 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +25 -25
- package/dist-types/commands/UpdateClusterCommand.d.ts +103 -104
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +20 -20
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +12 -12
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +90 -90
- package/dist-types/commands/UpdateServiceCommand.d.ts +18 -13
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +29 -29
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +35 -37
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +32 -32
- package/package.json +2 -2
|
@@ -163,48 +163,8 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
163
163
|
* @throws {@link ECSServiceException}
|
|
164
164
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
165
165
|
*
|
|
166
|
-
* @public
|
|
167
|
-
* @example To describe a service deployment
|
|
168
|
-
* ```javascript
|
|
169
|
-
* // This example describes a service deployment for the service sd-example in the example cluster.
|
|
170
|
-
* const input = {
|
|
171
|
-
* "serviceDeploymentArns": [
|
|
172
|
-
* "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5"
|
|
173
|
-
* ]
|
|
174
|
-
* };
|
|
175
|
-
* const command = new DescribeServiceDeploymentsCommand(input);
|
|
176
|
-
* const response = await client.send(command);
|
|
177
|
-
* /* response ==
|
|
178
|
-
* {
|
|
179
|
-
* "failures": [],
|
|
180
|
-
* "serviceDeployments": [
|
|
181
|
-
* {
|
|
182
|
-
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example",
|
|
183
|
-
* "deploymentConfiguration": {
|
|
184
|
-
* "deploymentCircuitBreaker": {
|
|
185
|
-
* "enable": false,
|
|
186
|
-
* "rollback": false
|
|
187
|
-
* },
|
|
188
|
-
* "maximumPercent": 200,
|
|
189
|
-
* "minimumHealthyPercent": 100
|
|
190
|
-
* },
|
|
191
|
-
* "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
|
|
192
|
-
* "serviceDeploymentArn": "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5",
|
|
193
|
-
* "status": "PENDING",
|
|
194
|
-
* "targetServiceRevision": {
|
|
195
|
-
* "arn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095",
|
|
196
|
-
* "pendingTaskCount": 0,
|
|
197
|
-
* "requestedTaskCount": 0,
|
|
198
|
-
* "runningTaskCount": 0
|
|
199
|
-
* },
|
|
200
|
-
* "updatedAt": "2024-09-10T16:49:35.572000+00:00"
|
|
201
|
-
* }
|
|
202
|
-
* ]
|
|
203
|
-
* }
|
|
204
|
-
* *\/
|
|
205
|
-
* // example id: to-describe-a-service-deployment--1733954961143
|
|
206
|
-
* ```
|
|
207
166
|
*
|
|
167
|
+
* @public
|
|
208
168
|
*/
|
|
209
169
|
export declare class DescribeServiceDeploymentsCommand extends DescribeServiceDeploymentsCommand_base {
|
|
210
170
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -234,48 +234,8 @@ declare const DescribeServiceRevisionsCommand_base: {
|
|
|
234
234
|
* @throws {@link ECSServiceException}
|
|
235
235
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
236
236
|
*
|
|
237
|
-
* @public
|
|
238
|
-
* @example To describe a service revision
|
|
239
|
-
* ```javascript
|
|
240
|
-
* // This example describes a service revision with the specified ARN
|
|
241
|
-
* const input = {
|
|
242
|
-
* "serviceRevisionArns": [
|
|
243
|
-
* "arn:aws:ecs:us-west-2:123456789012:service-revision/testc/sd1/4980306466373577095"
|
|
244
|
-
* ]
|
|
245
|
-
* };
|
|
246
|
-
* const command = new DescribeServiceRevisionsCommand(input);
|
|
247
|
-
* const response = await client.send(command);
|
|
248
|
-
* /* response ==
|
|
249
|
-
* {
|
|
250
|
-
* "failures": [],
|
|
251
|
-
* "serviceRevisions": [
|
|
252
|
-
* {
|
|
253
|
-
* "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example",
|
|
254
|
-
* "createdAt": "2024-09-10T16:49:26.388000+00:00",
|
|
255
|
-
* "launchType": "FARGATE",
|
|
256
|
-
* "networkConfiguration": {
|
|
257
|
-
* "awsvpcConfiguration": {
|
|
258
|
-
* "assignPublicIp": "ENABLED",
|
|
259
|
-
* "securityGroups": [
|
|
260
|
-
* "sg-09605d60a6bc1b296"
|
|
261
|
-
* ],
|
|
262
|
-
* "subnets": [
|
|
263
|
-
* "subnet-0a4040e73895f04e1"
|
|
264
|
-
* ]
|
|
265
|
-
* }
|
|
266
|
-
* },
|
|
267
|
-
* "platformFamily": "DockerLinux",
|
|
268
|
-
* "platformVersion": "1.4.0",
|
|
269
|
-
* "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
|
|
270
|
-
* "serviceRevisionArn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095",
|
|
271
|
-
* "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/large-ngingx:1"
|
|
272
|
-
* }
|
|
273
|
-
* ]
|
|
274
|
-
* }
|
|
275
|
-
* *\/
|
|
276
|
-
* // example id: to-describe-a-service-revision--1734033215738
|
|
277
|
-
* ```
|
|
278
237
|
*
|
|
238
|
+
* @public
|
|
279
239
|
*/
|
|
280
240
|
export declare class DescribeServiceRevisionsCommand extends DescribeServiceRevisionsCommand_base {
|
|
281
241
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -373,62 +373,62 @@ declare const DescribeServicesCommand_base: {
|
|
|
373
373
|
* @throws {@link ECSServiceException}
|
|
374
374
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
375
375
|
*
|
|
376
|
-
*
|
|
376
|
+
*
|
|
377
377
|
* @example To describe a service
|
|
378
378
|
* ```javascript
|
|
379
379
|
* // This example provides descriptive information about the service named ``ecs-simple-service``.
|
|
380
380
|
* const input = {
|
|
381
|
-
*
|
|
381
|
+
* services: [
|
|
382
382
|
* "ecs-simple-service"
|
|
383
383
|
* ]
|
|
384
384
|
* };
|
|
385
385
|
* const command = new DescribeServicesCommand(input);
|
|
386
386
|
* const response = await client.send(command);
|
|
387
|
-
* /* response
|
|
387
|
+
* /* response is
|
|
388
388
|
* {
|
|
389
|
-
*
|
|
390
|
-
*
|
|
389
|
+
* failures: [],
|
|
390
|
+
* services: [
|
|
391
391
|
* {
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
*
|
|
392
|
+
* clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
393
|
+
* createdAt: "2016-08-29T16:25:52.130Z",
|
|
394
|
+
* deploymentConfiguration: {
|
|
395
|
+
* maximumPercent: 200,
|
|
396
|
+
* minimumHealthyPercent: 100
|
|
397
397
|
* },
|
|
398
|
-
*
|
|
398
|
+
* deployments: [
|
|
399
399
|
* {
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
400
|
+
* createdAt: "2016-08-29T16:25:52.130Z",
|
|
401
|
+
* desiredCount: 1,
|
|
402
|
+
* id: "ecs-svc/9223370564341623665",
|
|
403
|
+
* pendingCount: 0,
|
|
404
|
+
* runningCount: 0,
|
|
405
|
+
* status: "PRIMARY",
|
|
406
|
+
* taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
|
|
407
|
+
* updatedAt: "2016-08-29T16:25:52.130Z"
|
|
408
408
|
* }
|
|
409
409
|
* ],
|
|
410
|
-
*
|
|
411
|
-
*
|
|
410
|
+
* desiredCount: 1,
|
|
411
|
+
* events: [
|
|
412
412
|
* {
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
413
|
+
* createdAt: "2016-08-29T16:25:58.520Z",
|
|
414
|
+
* id: "38c285e5-d335-4b68-8b15-e46dedc8e88d",
|
|
415
|
+
* message: "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide."
|
|
416
416
|
* }
|
|
417
417
|
* ],
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
418
|
+
* loadBalancers: [],
|
|
419
|
+
* pendingCount: 0,
|
|
420
|
+
* runningCount: 0,
|
|
421
|
+
* serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service",
|
|
422
|
+
* serviceName: "ecs-simple-service",
|
|
423
|
+
* status: "ACTIVE",
|
|
424
|
+
* taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6"
|
|
425
425
|
* }
|
|
426
426
|
* ]
|
|
427
427
|
* }
|
|
428
428
|
* *\/
|
|
429
|
-
* // example id: to-describe-a-service-1472513256350
|
|
430
429
|
* ```
|
|
431
430
|
*
|
|
431
|
+
* @public
|
|
432
432
|
*/
|
|
433
433
|
export declare class DescribeServicesCommand extends DescribeServicesCommand_base {
|
|
434
434
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -364,65 +364,65 @@ declare const DescribeTaskDefinitionCommand_base: {
|
|
|
364
364
|
* @throws {@link ECSServiceException}
|
|
365
365
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
366
366
|
*
|
|
367
|
-
*
|
|
367
|
+
*
|
|
368
368
|
* @example To describe a task definition
|
|
369
369
|
* ```javascript
|
|
370
370
|
* // This example provides a description of the specified task definition.
|
|
371
371
|
* const input = {
|
|
372
|
-
*
|
|
372
|
+
* taskDefinition: "hello_world:8"
|
|
373
373
|
* };
|
|
374
374
|
* const command = new DescribeTaskDefinitionCommand(input);
|
|
375
375
|
* const response = await client.send(command);
|
|
376
|
-
* /* response
|
|
376
|
+
* /* response is
|
|
377
377
|
* {
|
|
378
|
-
*
|
|
379
|
-
*
|
|
378
|
+
* taskDefinition: {
|
|
379
|
+
* containerDefinitions: [
|
|
380
380
|
* {
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
* "
|
|
385
|
-
*
|
|
386
|
-
* "links": [
|
|
381
|
+
* cpu: 10,
|
|
382
|
+
* environment: [],
|
|
383
|
+
* essential: true,
|
|
384
|
+
* image: "wordpress",
|
|
385
|
+
* links: [
|
|
387
386
|
* "mysql"
|
|
388
387
|
* ],
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
* "
|
|
388
|
+
* memory: 500,
|
|
389
|
+
* mountPoints: [],
|
|
390
|
+
* name: "wordpress",
|
|
391
|
+
* portMappings: [
|
|
392
392
|
* {
|
|
393
|
-
*
|
|
394
|
-
*
|
|
393
|
+
* containerPort: 80,
|
|
394
|
+
* hostPort: 80
|
|
395
395
|
* }
|
|
396
396
|
* ],
|
|
397
|
-
*
|
|
397
|
+
* volumesFrom: []
|
|
398
398
|
* },
|
|
399
399
|
* {
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
* "environment": [
|
|
400
|
+
* cpu: 10,
|
|
401
|
+
* environment: [
|
|
403
402
|
* {
|
|
404
|
-
*
|
|
405
|
-
*
|
|
403
|
+
* name: "MYSQL_ROOT_PASSWORD",
|
|
404
|
+
* value: "password"
|
|
406
405
|
* }
|
|
407
406
|
* ],
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
* "
|
|
413
|
-
*
|
|
407
|
+
* essential: true,
|
|
408
|
+
* image: "mysql",
|
|
409
|
+
* memory: 500,
|
|
410
|
+
* mountPoints: [],
|
|
411
|
+
* name: "mysql",
|
|
412
|
+
* portMappings: [],
|
|
413
|
+
* volumesFrom: []
|
|
414
414
|
* }
|
|
415
415
|
* ],
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
416
|
+
* family: "hello_world",
|
|
417
|
+
* revision: 8,
|
|
418
|
+
* taskDefinitionArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8",
|
|
419
|
+
* volumes: []
|
|
420
420
|
* }
|
|
421
421
|
* }
|
|
422
422
|
* *\/
|
|
423
|
-
* // example id: 4c21eeb1-f1da-4a08-8c44-297fc8d0ea88
|
|
424
423
|
* ```
|
|
425
424
|
*
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
export declare class DescribeTaskDefinitionCommand extends DescribeTaskDefinitionCommand_base {
|
|
428
428
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -179,60 +179,60 @@ declare const DescribeTaskSetsCommand_base: {
|
|
|
179
179
|
* @throws {@link ECSServiceException}
|
|
180
180
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
181
181
|
*
|
|
182
|
-
*
|
|
182
|
+
*
|
|
183
183
|
* @example To describe a task set
|
|
184
184
|
* ```javascript
|
|
185
185
|
* // This example describes a task set in service MyService that uses an EXTERNAL deployment controller.
|
|
186
186
|
* const input = {
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
187
|
+
* cluster: "MyCluster",
|
|
188
|
+
* service: "MyService",
|
|
189
|
+
* taskSets: [
|
|
190
190
|
* "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789"
|
|
191
191
|
* ]
|
|
192
192
|
* };
|
|
193
193
|
* const command = new DescribeTaskSetsCommand(input);
|
|
194
194
|
* const response = await client.send(command);
|
|
195
|
-
* /* response
|
|
195
|
+
* /* response is
|
|
196
196
|
* {
|
|
197
|
-
*
|
|
198
|
-
*
|
|
197
|
+
* failures: [],
|
|
198
|
+
* taskSets: [
|
|
199
199
|
* {
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
200
|
+
* computedDesiredCount: 0,
|
|
201
|
+
* createdAt: 1.557207715195E9,
|
|
202
|
+
* id: "ecs-svc/1234567890123456789",
|
|
203
|
+
* launchType: "EC2",
|
|
204
|
+
* loadBalancers: [],
|
|
205
|
+
* networkConfiguration: {
|
|
206
|
+
* awsvpcConfiguration: {
|
|
207
|
+
* assignPublicIp: "DISABLED",
|
|
208
|
+
* securityGroups: [
|
|
209
209
|
* "sg-1234431"
|
|
210
210
|
* ],
|
|
211
|
-
*
|
|
211
|
+
* subnets: [
|
|
212
212
|
* "subnet-12344321"
|
|
213
213
|
* ]
|
|
214
214
|
* }
|
|
215
215
|
* },
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
* "
|
|
220
|
-
*
|
|
216
|
+
* pendingCount: 0,
|
|
217
|
+
* runningCount: 0,
|
|
218
|
+
* scale: {
|
|
219
|
+
* unit: "PERCENT",
|
|
220
|
+
* value: 0
|
|
221
221
|
* },
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
222
|
+
* serviceRegistries: [],
|
|
223
|
+
* stabilityStatus: "STEADY_STATE",
|
|
224
|
+
* stabilityStatusAt: 1.557207740014E9,
|
|
225
|
+
* status: "ACTIVE",
|
|
226
|
+
* taskDefinition: "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
|
|
227
|
+
* taskSetArn: "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
|
|
228
|
+
* updatedAt: 1.557207740014E9
|
|
229
229
|
* }
|
|
230
230
|
* ]
|
|
231
231
|
* }
|
|
232
232
|
* *\/
|
|
233
|
-
* // example id: to-describe-a-task-set--1734035629507
|
|
234
233
|
* ```
|
|
235
234
|
*
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
export declare class DescribeTaskSetsCommand extends DescribeTaskSetsCommand_base {
|
|
238
238
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -258,58 +258,58 @@ declare const DescribeTasksCommand_base: {
|
|
|
258
258
|
* @throws {@link ECSServiceException}
|
|
259
259
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
260
260
|
*
|
|
261
|
-
*
|
|
261
|
+
*
|
|
262
262
|
* @example To describe a task
|
|
263
263
|
* ```javascript
|
|
264
264
|
* // This example provides a description of the specified task, using the task UUID as an identifier.
|
|
265
265
|
* const input = {
|
|
266
|
-
*
|
|
266
|
+
* tasks: [
|
|
267
267
|
* "c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
|
|
268
268
|
* ]
|
|
269
269
|
* };
|
|
270
270
|
* const command = new DescribeTasksCommand(input);
|
|
271
271
|
* const response = await client.send(command);
|
|
272
|
-
* /* response
|
|
272
|
+
* /* response is
|
|
273
273
|
* {
|
|
274
|
-
*
|
|
275
|
-
*
|
|
274
|
+
* failures: [],
|
|
275
|
+
* tasks: [
|
|
276
276
|
* {
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
277
|
+
* clusterArn: "arn:aws:ecs:<region>:<aws_account_id>:cluster/default",
|
|
278
|
+
* containerInstanceArn: "arn:aws:ecs:<region>:<aws_account_id>:container-instance/default/18f9eda5-27d7-4c19-b133-45adc516e8fb",
|
|
279
|
+
* containers: [
|
|
280
280
|
* {
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
281
|
+
* containerArn: "arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6",
|
|
282
|
+
* lastStatus: "RUNNING",
|
|
283
|
+
* name: "ecs-demo",
|
|
284
|
+
* networkBindings: [
|
|
285
285
|
* {
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
286
|
+
* bindIP: "0.0.0.0",
|
|
287
|
+
* containerPort: 80,
|
|
288
|
+
* hostPort: 80
|
|
289
289
|
* }
|
|
290
290
|
* ],
|
|
291
|
-
*
|
|
291
|
+
* taskArn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
|
|
292
292
|
* }
|
|
293
293
|
* ],
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
294
|
+
* desiredStatus: "RUNNING",
|
|
295
|
+
* lastStatus: "RUNNING",
|
|
296
|
+
* overrides: {
|
|
297
|
+
* containerOverrides: [
|
|
298
298
|
* {
|
|
299
|
-
*
|
|
299
|
+
* name: "ecs-demo"
|
|
300
300
|
* }
|
|
301
301
|
* ]
|
|
302
302
|
* },
|
|
303
|
-
*
|
|
304
|
-
*
|
|
305
|
-
*
|
|
303
|
+
* startedBy: "ecs-svc/9223370608528463088",
|
|
304
|
+
* taskArn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8",
|
|
305
|
+
* taskDefinitionArn: "arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1"
|
|
306
306
|
* }
|
|
307
307
|
* ]
|
|
308
308
|
* }
|
|
309
309
|
* *\/
|
|
310
|
-
* // example id: a90b0cde-f965-4946-b55e-cfd8cc54e827
|
|
311
310
|
* ```
|
|
312
311
|
*
|
|
312
|
+
* @public
|
|
313
313
|
*/
|
|
314
314
|
export declare class DescribeTasksCommand extends DescribeTasksCommand_base {
|
|
315
315
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -78,6 +78,7 @@ declare const DiscoverPollEndpointCommand_base: {
|
|
|
78
78
|
* @throws {@link ECSServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
80
80
|
*
|
|
81
|
+
*
|
|
81
82
|
* @public
|
|
82
83
|
*/
|
|
83
84
|
export declare class DiscoverPollEndpointCommand extends DiscoverPollEndpointCommand_base {
|
|
@@ -121,36 +121,36 @@ declare const ExecuteCommandCommand_base: {
|
|
|
121
121
|
* @throws {@link ECSServiceException}
|
|
122
122
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
123
123
|
*
|
|
124
|
-
*
|
|
124
|
+
*
|
|
125
125
|
* @example To run a command remotely on a container in a task
|
|
126
126
|
* ```javascript
|
|
127
127
|
* // This example runs an interactive /bin/sh command on a container MyContainer.
|
|
128
128
|
* const input = {
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
129
|
+
* cluster: "MyCluster",
|
|
130
|
+
* command: "/bin/sh",
|
|
131
|
+
* container: "MyContainer",
|
|
132
|
+
* interactive: true,
|
|
133
|
+
* task: "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE"
|
|
134
134
|
* };
|
|
135
135
|
* const command = new ExecuteCommandCommand(input);
|
|
136
136
|
* const response = await client.send(command);
|
|
137
|
-
* /* response
|
|
137
|
+
* /* response is
|
|
138
138
|
* {
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
139
|
+
* clusterArn: "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
|
|
140
|
+
* containerArn: "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/43ba4b77-37f7-4a41-b923-69d4abEXAMPLE",
|
|
141
|
+
* containerName: "MyContainer",
|
|
142
|
+
* interactive: true,
|
|
143
|
+
* session: {
|
|
144
|
+
* sessionId: "ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e",
|
|
145
|
+
* streamUrl: "wss://ssmmessages.us-east-1.amazonaws.com/v1/data-channel/ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e?role=publish_subscribe&cell-number=AAEAAfiZG4oybxqsYj3Zhm15s4J0W1k7d9nxVRenNO8Kl5nzAAAAAGdbWGl479/y/4IrTWPadUic3eBrMu3vmB7aPvI+s12lbpDc142y1KZy",
|
|
146
|
+
* tokenValue: "AAEAAcVb7ww10N9aNUI5Cl7K7DbHjbD2Ed4Mw6uaGYIc+UFNAAAAAGdbWGmMDaPbGfDkzrVIhyKEsc4CPT2hcToPU6yzlddPm7rRZvYQtpaAgsvQdjbCAd9OB6ohtDYfqZI9gzMqLKegXq0E+KbDcGPnQVODFNHmQxnR1BvC6vNcHqh6HAJuKnQD7RSYx/J5bfYNHj4hCYHuN0HNcueSDOOTRB/MBt5DBDY7Djv2uzs9FD0N1kcsGljZkZWLuPTVKHHyrU3zh0awfrFFC3RXvgaUCBnloIIvZeq2CjTesxn9JJS+3N4I0DVxfkHdWWBbBY/5+wH82JVTJpqN3yOAt74u/W7TvYBd7Xu2lQbvtpuAnEszl++bFG2ZoV3dfnmBkSnfD/qV1FJcEskbxUHKgmqe0Paouv4zwrQKNfWYfcv9xkWskqcExh07IeaxZz1tp/WegZ5D76sD6xYeuH+35TMNXMoY7oudLgxIXsA7b39ElM7orGi4Jy3W2tLyuNIvDoI2JI6ww4tYdEjYZnld9rhKwV9rDHk1Z8wjHMs++3BIkHrFQRsv7BFUWlZ9lyqO9GWlXeBe7dQtOeFNahBuJUE9z/xLHJn1x13VkdROKqUVHTJrT4sXAnI5roWiGPoQPVY7aHVYJnwjSxrPRWJBsgyHiVN3dAWTmeVMjp0VbOiJaLlpBI+AUWs8OeVRzuJSZ+1alETpK7Ukag7ma9K4lxq/N7IxYo2ub0cG/bvX42zQqdJAW+9St9sQ1QMaMvkSq1tdbLoOuY0QjN7JrkuKLFQA5bhs+o1YwItzIp7bNrzQ9Z9IN51qoGL5HDXQzi1kNFfYtAryhwt6BgtQU9Z0k+RpE+V5G+V68E0MMUvb313f0nRBYj1u5VKonWb708wADPbUU+s7nvbWuD5oLp1Z6A4iqI9Om0R4RrFASj/7fVY7r3raNXcIYA="
|
|
147
147
|
* },
|
|
148
|
-
*
|
|
148
|
+
* taskArn: "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE"
|
|
149
149
|
* }
|
|
150
150
|
* *\/
|
|
151
|
-
* // example id: to-run-a-command-remotely-on-a-container-in-a-task-1734037663312
|
|
152
151
|
* ```
|
|
153
152
|
*
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
export declare class ExecuteCommandCommand extends ExecuteCommandCommand_base {
|
|
156
156
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -105,33 +105,33 @@ declare const GetTaskProtectionCommand_base: {
|
|
|
105
105
|
* @throws {@link ECSServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
107
107
|
*
|
|
108
|
-
*
|
|
108
|
+
*
|
|
109
109
|
* @example To get the protection status of a task
|
|
110
110
|
* ```javascript
|
|
111
111
|
* // In this example, we get the protection status for a single task.
|
|
112
112
|
* const input = {
|
|
113
|
-
*
|
|
114
|
-
*
|
|
113
|
+
* cluster: "test-task-protection",
|
|
114
|
+
* tasks: [
|
|
115
115
|
* "b8b1cf532d0e46ba8d44a40d1de16772"
|
|
116
116
|
* ]
|
|
117
117
|
* };
|
|
118
118
|
* const command = new GetTaskProtectionCommand(input);
|
|
119
119
|
* const response = await client.send(command);
|
|
120
|
-
* /* response
|
|
120
|
+
* /* response is
|
|
121
121
|
* {
|
|
122
|
-
*
|
|
123
|
-
*
|
|
122
|
+
* failures: [],
|
|
123
|
+
* protectedTasks: [
|
|
124
124
|
* {
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
125
|
+
* expirationDate: "2022-11-02T06:56:32.553Z",
|
|
126
|
+
* protectionEnabled: true,
|
|
127
|
+
* taskArn: "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772"
|
|
128
128
|
* }
|
|
129
129
|
* ]
|
|
130
130
|
* }
|
|
131
131
|
* *\/
|
|
132
|
-
* // example id: get-the-protection-status-for-a-single-task-2022-11-02T06:56:32.553Z
|
|
133
132
|
* ```
|
|
134
133
|
*
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
export declare class GetTaskProtectionCommand extends GetTaskProtectionCommand_base {
|
|
137
137
|
/** @internal type navigation helper, not in runtime. */
|