@aws-sdk/client-ecs 3.486.0 → 3.490.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.
@@ -35,6 +35,8 @@ declare const RunTaskCommand_base: {
35
35
  * <note>
36
36
  * <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
37
37
  * </note>
38
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
39
+ * updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
38
40
  * <p>The Amazon ECS API follows an eventual consistency model. This is because of the
39
41
  * distributed nature of the system supporting the API. This means that the result of an
40
42
  * API command you run that affects your Amazon ECS resources might not be immediately visible
@@ -156,6 +158,37 @@ declare const RunTaskCommand_base: {
156
158
  * ],
157
159
  * taskDefinition: "STRING_VALUE", // required
158
160
  * clientToken: "STRING_VALUE",
161
+ * volumeConfigurations: [ // TaskVolumeConfigurations
162
+ * { // TaskVolumeConfiguration
163
+ * name: "STRING_VALUE", // required
164
+ * managedEBSVolume: { // TaskManagedEBSVolumeConfiguration
165
+ * encrypted: true || false,
166
+ * kmsKeyId: "STRING_VALUE",
167
+ * volumeType: "STRING_VALUE",
168
+ * sizeInGiB: Number("int"),
169
+ * snapshotId: "STRING_VALUE",
170
+ * iops: Number("int"),
171
+ * throughput: Number("int"),
172
+ * tagSpecifications: [ // EBSTagSpecifications
173
+ * { // EBSTagSpecification
174
+ * resourceType: "volume", // required
175
+ * tags: [
176
+ * {
177
+ * key: "STRING_VALUE",
178
+ * value: "STRING_VALUE",
179
+ * },
180
+ * ],
181
+ * propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
182
+ * },
183
+ * ],
184
+ * roleArn: "STRING_VALUE", // required
185
+ * terminationPolicy: { // TaskManagedEBSVolumeTerminationPolicy
186
+ * deleteOnTermination: true || false, // required
187
+ * },
188
+ * filesystemType: "ext3" || "ext4" || "xfs",
189
+ * },
190
+ * },
191
+ * ],
159
192
  * };
160
193
  * const command = new RunTaskCommand(input);
161
194
  * const response = await client.send(command);
@@ -358,12 +391,11 @@ declare const RunTaskCommand_base: {
358
391
  * <p>To fix this issue:</p>
359
392
  * <ul>
360
393
  * <li>
361
- * <p>Run <code>RunTask</code> with a unique
362
- * <code>clientToken</code>.</p>
394
+ * <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p>
363
395
  * </li>
364
396
  * <li>
365
- * <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original set of
366
- * parameters</p>
397
+ * <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original
398
+ * set of parameters</p>
367
399
  * </li>
368
400
  * </ul>
369
401
  *
@@ -33,6 +33,8 @@ declare const StartTaskCommand_base: {
33
33
  * </note>
34
34
  * <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
35
35
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
36
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
37
+ * updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
36
38
  * @example
37
39
  * Use a bare-bones client and the command you need to make an API call.
38
40
  * ```javascript
@@ -110,6 +112,37 @@ declare const StartTaskCommand_base: {
110
112
  * },
111
113
  * ],
112
114
  * taskDefinition: "STRING_VALUE", // required
115
+ * volumeConfigurations: [ // TaskVolumeConfigurations
116
+ * { // TaskVolumeConfiguration
117
+ * name: "STRING_VALUE", // required
118
+ * managedEBSVolume: { // TaskManagedEBSVolumeConfiguration
119
+ * encrypted: true || false,
120
+ * kmsKeyId: "STRING_VALUE",
121
+ * volumeType: "STRING_VALUE",
122
+ * sizeInGiB: Number("int"),
123
+ * snapshotId: "STRING_VALUE",
124
+ * iops: Number("int"),
125
+ * throughput: Number("int"),
126
+ * tagSpecifications: [ // EBSTagSpecifications
127
+ * { // EBSTagSpecification
128
+ * resourceType: "volume", // required
129
+ * tags: [
130
+ * {
131
+ * key: "STRING_VALUE",
132
+ * value: "STRING_VALUE",
133
+ * },
134
+ * ],
135
+ * propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
136
+ * },
137
+ * ],
138
+ * roleArn: "STRING_VALUE", // required
139
+ * terminationPolicy: { // TaskManagedEBSVolumeTerminationPolicy
140
+ * deleteOnTermination: true || false, // required
141
+ * },
142
+ * filesystemType: "ext3" || "ext4" || "xfs",
143
+ * },
144
+ * },
145
+ * ],
113
146
  * };
114
147
  * const command = new StartTaskCommand(input);
115
148
  * const response = await client.send(command);
@@ -304,6 +337,9 @@ declare const StartTaskCommand_base: {
304
337
  * @throws {@link ServerException} (server fault)
305
338
  * <p>These errors are usually caused by a server issue.</p>
306
339
  *
340
+ * @throws {@link UnsupportedFeatureException} (client fault)
341
+ * <p>The specified task isn't supported in this Region.</p>
342
+ *
307
343
  * @throws {@link ECSServiceException}
308
344
  * <p>Base exception class for all service exceptions from ECS service.</p>
309
345
  *
@@ -32,6 +32,13 @@ declare const UpdateServiceCommand_base: {
32
32
  * registries, enable ECS managed tags option, propagate tags option, task placement
33
33
  * constraints and strategies, and task definition. When you update any of these
34
34
  * parameters, Amazon ECS starts new tasks with the new configuration. </p>
35
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
36
+ * running a task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. You can update
37
+ * your volume configurations and trigger a new deployment.
38
+ * <code>volumeConfigurations</code> is only supported for REPLICA service and not
39
+ * DAEMON service. If you leave <code>volumeConfigurations</code>
40
+ * <code>null</code>, it doesn't trigger a new deployment. For more infomation on volumes,
41
+ * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
35
42
  * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller,
36
43
  * only the desired count, deployment configuration, health check grace period, task
37
44
  * placement constraints and strategies, enable ECS managed tags option, and propagate tags
@@ -46,7 +53,9 @@ declare const UpdateServiceCommand_base: {
46
53
  * <p>You can add to or subtract from the number of instantiations of a task definition in a
47
54
  * service by specifying the cluster that the service is running in and a new
48
55
  * <code>desiredCount</code> parameter.</p>
49
- * <p>If you have updated the Docker image of your application, you can create a new task
56
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
57
+ * running a task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
58
+ * <p>If you have updated the container image of your application, you can create a new task
50
59
  * definition with that image and deploy it to your service. The service scheduler uses the
51
60
  * minimum healthy percent and maximum percent parameters (in the service's deployment
52
61
  * configuration) to determine the deployment strategy.</p>
@@ -145,8 +154,8 @@ declare const UpdateServiceCommand_base: {
145
154
  * </p>
146
155
  * </li>
147
156
  * </ul>
148
- * <p>For more information about the role see the <code>CreateService</code> request parameter
149
- * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
157
+ * <p>For more information about the role see the <code>CreateService</code> request
158
+ * parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
150
159
  * <code>role</code>
151
160
  * </a>. </p>
152
161
  * </note>
@@ -257,6 +266,34 @@ declare const UpdateServiceCommand_base: {
257
266
  * ],
258
267
  * },
259
268
  * },
269
+ * volumeConfigurations: [ // ServiceVolumeConfigurations
270
+ * { // ServiceVolumeConfiguration
271
+ * name: "STRING_VALUE", // required
272
+ * managedEBSVolume: { // ServiceManagedEBSVolumeConfiguration
273
+ * encrypted: true || false,
274
+ * kmsKeyId: "STRING_VALUE",
275
+ * volumeType: "STRING_VALUE",
276
+ * sizeInGiB: Number("int"),
277
+ * snapshotId: "STRING_VALUE",
278
+ * iops: Number("int"),
279
+ * throughput: Number("int"),
280
+ * tagSpecifications: [ // EBSTagSpecifications
281
+ * { // EBSTagSpecification
282
+ * resourceType: "volume", // required
283
+ * tags: [ // Tags
284
+ * { // Tag
285
+ * key: "STRING_VALUE",
286
+ * value: "STRING_VALUE",
287
+ * },
288
+ * ],
289
+ * propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
290
+ * },
291
+ * ],
292
+ * roleArn: "STRING_VALUE", // required
293
+ * filesystemType: "ext3" || "ext4" || "xfs",
294
+ * },
295
+ * },
296
+ * ],
260
297
  * };
261
298
  * const command = new UpdateServiceCommand(input);
262
299
  * const response = await client.send(command);
@@ -446,6 +483,34 @@ declare const UpdateServiceCommand_base: {
446
483
  * // discoveryArn: "STRING_VALUE",
447
484
  * // },
448
485
  * // ],
486
+ * // volumeConfigurations: [ // ServiceVolumeConfigurations
487
+ * // { // ServiceVolumeConfiguration
488
+ * // name: "STRING_VALUE", // required
489
+ * // managedEBSVolume: { // ServiceManagedEBSVolumeConfiguration
490
+ * // encrypted: true || false,
491
+ * // kmsKeyId: "STRING_VALUE",
492
+ * // volumeType: "STRING_VALUE",
493
+ * // sizeInGiB: Number("int"),
494
+ * // snapshotId: "STRING_VALUE",
495
+ * // iops: Number("int"),
496
+ * // throughput: Number("int"),
497
+ * // tagSpecifications: [ // EBSTagSpecifications
498
+ * // { // EBSTagSpecification
499
+ * // resourceType: "volume", // required
500
+ * // tags: [
501
+ * // {
502
+ * // key: "STRING_VALUE",
503
+ * // value: "STRING_VALUE",
504
+ * // },
505
+ * // ],
506
+ * // propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
507
+ * // },
508
+ * // ],
509
+ * // roleArn: "STRING_VALUE", // required
510
+ * // filesystemType: "ext3" || "ext4" || "xfs",
511
+ * // },
512
+ * // },
513
+ * // ],
449
514
  * // },
450
515
  * // ],
451
516
  * // roleArn: "STRING_VALUE",
@@ -481,12 +546,7 @@ declare const UpdateServiceCommand_base: {
481
546
  * // deploymentController: { // DeploymentController
482
547
  * // type: "ECS" || "CODE_DEPLOY" || "EXTERNAL", // required
483
548
  * // },
484
- * // tags: [
485
- * // {
486
- * // key: "STRING_VALUE",
487
- * // value: "STRING_VALUE",
488
- * // },
489
- * // ],
549
+ * // tags: "<Tags>",
490
550
  * // createdBy: "STRING_VALUE",
491
551
  * // enableECSManagedTags: true || false,
492
552
  * // propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
@@ -538,6 +598,9 @@ declare const UpdateServiceCommand_base: {
538
598
  * <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
539
599
  * specific.</p>
540
600
  *
601
+ * @throws {@link UnsupportedFeatureException} (client fault)
602
+ * <p>The specified task isn't supported in this Region.</p>
603
+ *
541
604
  * @throws {@link ECSServiceException}
542
605
  * <p>Base exception class for all service exceptions from ECS service.</p>
543
606
  *