Add ECS API.
[software/guile-aws.git] / aws / api / ecs-2014-11-13.normal.json
1 {
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2014-11-13",
5 "endpointPrefix": "ecs",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "serviceAbbreviation": "Amazon ECS",
9 "serviceFullName": "Amazon EC2 Container Service",
10 "serviceId": "ECS",
11 "signatureVersion": "v4",
12 "targetPrefix": "AmazonEC2ContainerServiceV20141113",
13 "uid": "ecs-2014-11-13"
14 },
15 "operations": {
16 "CreateCapacityProvider": {
17 "name": "CreateCapacityProvider",
18 "http": {
19 "method": "POST",
20 "requestUri": "/"
21 },
22 "input": {
23 "shape": "CreateCapacityProviderRequest"
24 },
25 "output": {
26 "shape": "CreateCapacityProviderResponse"
27 },
28 "errors": [
29 {
30 "shape": "ServerException"
31 },
32 {
33 "shape": "ClientException"
34 },
35 {
36 "shape": "InvalidParameterException"
37 },
38 {
39 "shape": "LimitExceededException"
40 }
41 ],
42 "documentation": "<p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.</p> <p>Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.</p>"
43 },
44 "CreateCluster": {
45 "name": "CreateCluster",
46 "http": {
47 "method": "POST",
48 "requestUri": "/"
49 },
50 "input": {
51 "shape": "CreateClusterRequest"
52 },
53 "output": {
54 "shape": "CreateClusterResponse"
55 },
56 "errors": [
57 {
58 "shape": "ServerException"
59 },
60 {
61 "shape": "ClientException"
62 },
63 {
64 "shape": "InvalidParameterException"
65 }
66 ],
67 "documentation": "<p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action.</p> <note> <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
68 },
69 "CreateService": {
70 "name": "CreateService",
71 "http": {
72 "method": "POST",
73 "requestUri": "/"
74 },
75 "input": {
76 "shape": "CreateServiceRequest"
77 },
78 "output": {
79 "shape": "CreateServiceResponse"
80 },
81 "errors": [
82 {
83 "shape": "ServerException"
84 },
85 {
86 "shape": "ClientException"
87 },
88 {
89 "shape": "InvalidParameterException"
90 },
91 {
92 "shape": "ClusterNotFoundException"
93 },
94 {
95 "shape": "UnsupportedFeatureException"
96 },
97 {
98 "shape": "PlatformUnknownException"
99 },
100 {
101 "shape": "PlatformTaskDefinitionIncompatibilityException"
102 },
103 {
104 "shape": "AccessDeniedException"
105 }
106 ],
107 "documentation": "<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Tasks for services that <i>do not</i> use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that <i>do</i> use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and the container instance that they're hosted on is reported as healthy by the load balancer.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code> - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p> <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> </ul> <p>You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an <a>UpdateService</a> operation. The default value for a replica service for <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service for <code>minimumHealthyPercent</code> is 0%.</p> <p>If a service is using the <code>ECS</code> deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that <i>do</i> use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.</p> <p>If a service is using the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the number of tasks in a service that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.</p> <p>If a service is using either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller types and tasks that use the EC2 launch type, the <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the <code>RUNNING</code> state while the container instances are in the <code>DRAINING</code> state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.</p> <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the <code>placementStrategy</code> parameter):</p> <ul> <li> <p>Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul>"
108 },
109 "CreateTaskSet": {
110 "name": "CreateTaskSet",
111 "http": {
112 "method": "POST",
113 "requestUri": "/"
114 },
115 "input": {
116 "shape": "CreateTaskSetRequest"
117 },
118 "output": {
119 "shape": "CreateTaskSetResponse"
120 },
121 "errors": [
122 {
123 "shape": "ServerException"
124 },
125 {
126 "shape": "ClientException"
127 },
128 {
129 "shape": "InvalidParameterException"
130 },
131 {
132 "shape": "ClusterNotFoundException"
133 },
134 {
135 "shape": "UnsupportedFeatureException"
136 },
137 {
138 "shape": "PlatformUnknownException"
139 },
140 {
141 "shape": "PlatformTaskDefinitionIncompatibilityException"
142 },
143 {
144 "shape": "AccessDeniedException"
145 },
146 {
147 "shape": "ServiceNotFoundException"
148 },
149 {
150 "shape": "ServiceNotActiveException"
151 }
152 ],
153 "documentation": "<p>Create a task set in the specified cluster and service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
154 },
155 "DeleteAccountSetting": {
156 "name": "DeleteAccountSetting",
157 "http": {
158 "method": "POST",
159 "requestUri": "/"
160 },
161 "input": {
162 "shape": "DeleteAccountSettingRequest"
163 },
164 "output": {
165 "shape": "DeleteAccountSettingResponse"
166 },
167 "errors": [
168 {
169 "shape": "ServerException"
170 },
171 {
172 "shape": "ClientException"
173 },
174 {
175 "shape": "InvalidParameterException"
176 }
177 ],
178 "documentation": "<p>Disables an account setting for a specified IAM user, IAM role, or the root user for an account.</p>"
179 },
180 "DeleteAttributes": {
181 "name": "DeleteAttributes",
182 "http": {
183 "method": "POST",
184 "requestUri": "/"
185 },
186 "input": {
187 "shape": "DeleteAttributesRequest"
188 },
189 "output": {
190 "shape": "DeleteAttributesResponse"
191 },
192 "errors": [
193 {
194 "shape": "ClusterNotFoundException"
195 },
196 {
197 "shape": "TargetNotFoundException"
198 },
199 {
200 "shape": "InvalidParameterException"
201 }
202 ],
203 "documentation": "<p>Deletes one or more custom attributes from an Amazon ECS resource.</p>"
204 },
205 "DeleteCluster": {
206 "name": "DeleteCluster",
207 "http": {
208 "method": "POST",
209 "requestUri": "/"
210 },
211 "input": {
212 "shape": "DeleteClusterRequest"
213 },
214 "output": {
215 "shape": "DeleteClusterResponse"
216 },
217 "errors": [
218 {
219 "shape": "ServerException"
220 },
221 {
222 "shape": "ClientException"
223 },
224 {
225 "shape": "InvalidParameterException"
226 },
227 {
228 "shape": "ClusterNotFoundException"
229 },
230 {
231 "shape": "ClusterContainsContainerInstancesException"
232 },
233 {
234 "shape": "ClusterContainsServicesException"
235 },
236 {
237 "shape": "ClusterContainsTasksException"
238 },
239 {
240 "shape": "UpdateInProgressException"
241 }
242 ],
243 "documentation": "<p>Deletes the specified cluster. The cluster will transition to the <code>INACTIVE</code> state. Clusters with an <code>INACTIVE</code> status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> clusters persisting.</p> <p>You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>"
244 },
245 "DeleteService": {
246 "name": "DeleteService",
247 "http": {
248 "method": "POST",
249 "requestUri": "/"
250 },
251 "input": {
252 "shape": "DeleteServiceRequest"
253 },
254 "output": {
255 "shape": "DeleteServiceResponse"
256 },
257 "errors": [
258 {
259 "shape": "ServerException"
260 },
261 {
262 "shape": "ClientException"
263 },
264 {
265 "shape": "InvalidParameterException"
266 },
267 {
268 "shape": "ClusterNotFoundException"
269 },
270 {
271 "shape": "ServiceNotFoundException"
272 }
273 ],
274 "documentation": "<p>Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>.</p> <note> <p>When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in the <a>ListServices</a> API operation. After all tasks have transitioned to either <code>STOPPING</code> or <code>STOPPED</code> status, the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with the <a>DescribeServices</a> API operation. However, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> calls on those services return a <code>ServiceNotFoundException</code> error.</p> </note> <important> <p>If you attempt to create a new service with the same name as an existing service in either <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an error.</p> </important>"
275 },
276 "DeleteTaskSet": {
277 "name": "DeleteTaskSet",
278 "http": {
279 "method": "POST",
280 "requestUri": "/"
281 },
282 "input": {
283 "shape": "DeleteTaskSetRequest"
284 },
285 "output": {
286 "shape": "DeleteTaskSetResponse"
287 },
288 "errors": [
289 {
290 "shape": "ServerException"
291 },
292 {
293 "shape": "ClientException"
294 },
295 {
296 "shape": "InvalidParameterException"
297 },
298 {
299 "shape": "ClusterNotFoundException"
300 },
301 {
302 "shape": "UnsupportedFeatureException"
303 },
304 {
305 "shape": "AccessDeniedException"
306 },
307 {
308 "shape": "ServiceNotFoundException"
309 },
310 {
311 "shape": "ServiceNotActiveException"
312 },
313 {
314 "shape": "TaskSetNotFoundException"
315 }
316 ],
317 "documentation": "<p>Deletes a specified task set within a service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
318 },
319 "DeregisterContainerInstance": {
320 "name": "DeregisterContainerInstance",
321 "http": {
322 "method": "POST",
323 "requestUri": "/"
324 },
325 "input": {
326 "shape": "DeregisterContainerInstanceRequest"
327 },
328 "output": {
329 "shape": "DeregisterContainerInstanceResponse"
330 },
331 "errors": [
332 {
333 "shape": "ServerException"
334 },
335 {
336 "shape": "ClientException"
337 },
338 {
339 "shape": "InvalidParameterException"
340 },
341 {
342 "shape": "ClusterNotFoundException"
343 }
344 ],
345 "documentation": "<p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.</p> <p>If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.</p> <p>Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.</p> <note> <p>If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).</p> </note>"
346 },
347 "DeregisterTaskDefinition": {
348 "name": "DeregisterTaskDefinition",
349 "http": {
350 "method": "POST",
351 "requestUri": "/"
352 },
353 "input": {
354 "shape": "DeregisterTaskDefinitionRequest"
355 },
356 "output": {
357 "shape": "DeregisterTaskDefinitionResponse"
358 },
359 "errors": [
360 {
361 "shape": "ServerException"
362 },
363 {
364 "shape": "ClientException"
365 },
366 {
367 "shape": "InvalidParameterException"
368 }
369 ],
370 "documentation": "<p>Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count.</p> <p>You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.</p> <note> <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> task definitions persisting beyond the lifecycle of any associated tasks and services.</p> </note>"
371 },
372 "DescribeCapacityProviders": {
373 "name": "DescribeCapacityProviders",
374 "http": {
375 "method": "POST",
376 "requestUri": "/"
377 },
378 "input": {
379 "shape": "DescribeCapacityProvidersRequest"
380 },
381 "output": {
382 "shape": "DescribeCapacityProvidersResponse"
383 },
384 "errors": [
385 {
386 "shape": "ServerException"
387 },
388 {
389 "shape": "ClientException"
390 },
391 {
392 "shape": "InvalidParameterException"
393 }
394 ],
395 "documentation": "<p>Describes one or more of your capacity providers.</p>"
396 },
397 "DescribeClusters": {
398 "name": "DescribeClusters",
399 "http": {
400 "method": "POST",
401 "requestUri": "/"
402 },
403 "input": {
404 "shape": "DescribeClustersRequest"
405 },
406 "output": {
407 "shape": "DescribeClustersResponse"
408 },
409 "errors": [
410 {
411 "shape": "ServerException"
412 },
413 {
414 "shape": "ClientException"
415 },
416 {
417 "shape": "InvalidParameterException"
418 }
419 ],
420 "documentation": "<p>Describes one or more of your clusters.</p>"
421 },
422 "DescribeContainerInstances": {
423 "name": "DescribeContainerInstances",
424 "http": {
425 "method": "POST",
426 "requestUri": "/"
427 },
428 "input": {
429 "shape": "DescribeContainerInstancesRequest"
430 },
431 "output": {
432 "shape": "DescribeContainerInstancesResponse"
433 },
434 "errors": [
435 {
436 "shape": "ServerException"
437 },
438 {
439 "shape": "ClientException"
440 },
441 {
442 "shape": "InvalidParameterException"
443 },
444 {
445 "shape": "ClusterNotFoundException"
446 }
447 ],
448 "documentation": "<p>Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.</p>"
449 },
450 "DescribeServices": {
451 "name": "DescribeServices",
452 "http": {
453 "method": "POST",
454 "requestUri": "/"
455 },
456 "input": {
457 "shape": "DescribeServicesRequest"
458 },
459 "output": {
460 "shape": "DescribeServicesResponse"
461 },
462 "errors": [
463 {
464 "shape": "ServerException"
465 },
466 {
467 "shape": "ClientException"
468 },
469 {
470 "shape": "InvalidParameterException"
471 },
472 {
473 "shape": "ClusterNotFoundException"
474 }
475 ],
476 "documentation": "<p>Describes the specified services running in your cluster.</p>"
477 },
478 "DescribeTaskDefinition": {
479 "name": "DescribeTaskDefinition",
480 "http": {
481 "method": "POST",
482 "requestUri": "/"
483 },
484 "input": {
485 "shape": "DescribeTaskDefinitionRequest"
486 },
487 "output": {
488 "shape": "DescribeTaskDefinitionResponse"
489 },
490 "errors": [
491 {
492 "shape": "ServerException"
493 },
494 {
495 "shape": "ClientException"
496 },
497 {
498 "shape": "InvalidParameterException"
499 }
500 ],
501 "documentation": "<p>Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family.</p> <note> <p>You can only describe <code>INACTIVE</code> task definitions while an active task or service references them.</p> </note>"
502 },
503 "DescribeTaskSets": {
504 "name": "DescribeTaskSets",
505 "http": {
506 "method": "POST",
507 "requestUri": "/"
508 },
509 "input": {
510 "shape": "DescribeTaskSetsRequest"
511 },
512 "output": {
513 "shape": "DescribeTaskSetsResponse"
514 },
515 "errors": [
516 {
517 "shape": "ServerException"
518 },
519 {
520 "shape": "ClientException"
521 },
522 {
523 "shape": "InvalidParameterException"
524 },
525 {
526 "shape": "ClusterNotFoundException"
527 },
528 {
529 "shape": "UnsupportedFeatureException"
530 },
531 {
532 "shape": "AccessDeniedException"
533 },
534 {
535 "shape": "ServiceNotFoundException"
536 },
537 {
538 "shape": "ServiceNotActiveException"
539 }
540 ],
541 "documentation": "<p>Describes the task sets in the specified cluster and service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
542 },
543 "DescribeTasks": {
544 "name": "DescribeTasks",
545 "http": {
546 "method": "POST",
547 "requestUri": "/"
548 },
549 "input": {
550 "shape": "DescribeTasksRequest"
551 },
552 "output": {
553 "shape": "DescribeTasksResponse"
554 },
555 "errors": [
556 {
557 "shape": "ServerException"
558 },
559 {
560 "shape": "ClientException"
561 },
562 {
563 "shape": "InvalidParameterException"
564 },
565 {
566 "shape": "ClusterNotFoundException"
567 }
568 ],
569 "documentation": "<p>Describes a specified task or tasks.</p>"
570 },
571 "DiscoverPollEndpoint": {
572 "name": "DiscoverPollEndpoint",
573 "http": {
574 "method": "POST",
575 "requestUri": "/"
576 },
577 "input": {
578 "shape": "DiscoverPollEndpointRequest"
579 },
580 "output": {
581 "shape": "DiscoverPollEndpointResponse"
582 },
583 "errors": [
584 {
585 "shape": "ServerException"
586 },
587 {
588 "shape": "ClientException"
589 }
590 ],
591 "documentation": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>"
592 },
593 "ListAccountSettings": {
594 "name": "ListAccountSettings",
595 "http": {
596 "method": "POST",
597 "requestUri": "/"
598 },
599 "input": {
600 "shape": "ListAccountSettingsRequest"
601 },
602 "output": {
603 "shape": "ListAccountSettingsResponse"
604 },
605 "errors": [
606 {
607 "shape": "ServerException"
608 },
609 {
610 "shape": "ClientException"
611 },
612 {
613 "shape": "InvalidParameterException"
614 }
615 ],
616 "documentation": "<p>Lists the account settings for a specified principal.</p>"
617 },
618 "ListAttributes": {
619 "name": "ListAttributes",
620 "http": {
621 "method": "POST",
622 "requestUri": "/"
623 },
624 "input": {
625 "shape": "ListAttributesRequest"
626 },
627 "output": {
628 "shape": "ListAttributesResponse"
629 },
630 "errors": [
631 {
632 "shape": "ClusterNotFoundException"
633 },
634 {
635 "shape": "InvalidParameterException"
636 }
637 ],
638 "documentation": "<p>Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, <code>ListAttributes</code> returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (<code>ecs.os-type=linux</code>). </p>"
639 },
640 "ListClusters": {
641 "name": "ListClusters",
642 "http": {
643 "method": "POST",
644 "requestUri": "/"
645 },
646 "input": {
647 "shape": "ListClustersRequest"
648 },
649 "output": {
650 "shape": "ListClustersResponse"
651 },
652 "errors": [
653 {
654 "shape": "ServerException"
655 },
656 {
657 "shape": "ClientException"
658 },
659 {
660 "shape": "InvalidParameterException"
661 }
662 ],
663 "documentation": "<p>Returns a list of existing clusters.</p>"
664 },
665 "ListContainerInstances": {
666 "name": "ListContainerInstances",
667 "http": {
668 "method": "POST",
669 "requestUri": "/"
670 },
671 "input": {
672 "shape": "ListContainerInstancesRequest"
673 },
674 "output": {
675 "shape": "ListContainerInstancesResponse"
676 },
677 "errors": [
678 {
679 "shape": "ServerException"
680 },
681 {
682 "shape": "ClientException"
683 },
684 {
685 "shape": "InvalidParameterException"
686 },
687 {
688 "shape": "ClusterNotFoundException"
689 }
690 ],
691 "documentation": "<p>Returns a list of container instances in a specified cluster. You can filter the results of a <code>ListContainerInstances</code> operation with cluster query language statements inside the <code>filter</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
692 },
693 "ListServices": {
694 "name": "ListServices",
695 "http": {
696 "method": "POST",
697 "requestUri": "/"
698 },
699 "input": {
700 "shape": "ListServicesRequest"
701 },
702 "output": {
703 "shape": "ListServicesResponse"
704 },
705 "errors": [
706 {
707 "shape": "ServerException"
708 },
709 {
710 "shape": "ClientException"
711 },
712 {
713 "shape": "InvalidParameterException"
714 },
715 {
716 "shape": "ClusterNotFoundException"
717 }
718 ],
719 "documentation": "<p>Lists the services that are running in a specified cluster.</p>"
720 },
721 "ListTagsForResource": {
722 "name": "ListTagsForResource",
723 "http": {
724 "method": "POST",
725 "requestUri": "/"
726 },
727 "input": {
728 "shape": "ListTagsForResourceRequest"
729 },
730 "output": {
731 "shape": "ListTagsForResourceResponse"
732 },
733 "errors": [
734 {
735 "shape": "ServerException"
736 },
737 {
738 "shape": "ClientException"
739 },
740 {
741 "shape": "ClusterNotFoundException"
742 },
743 {
744 "shape": "InvalidParameterException"
745 }
746 ],
747 "documentation": "<p>List the tags for an Amazon ECS resource.</p>"
748 },
749 "ListTaskDefinitionFamilies": {
750 "name": "ListTaskDefinitionFamilies",
751 "http": {
752 "method": "POST",
753 "requestUri": "/"
754 },
755 "input": {
756 "shape": "ListTaskDefinitionFamiliesRequest"
757 },
758 "output": {
759 "shape": "ListTaskDefinitionFamiliesResponse"
760 },
761 "errors": [
762 {
763 "shape": "ServerException"
764 },
765 {
766 "shape": "ClientException"
767 },
768 {
769 "shape": "InvalidParameterException"
770 }
771 ],
772 "documentation": "<p>Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definition revisions).</p> <p>You can filter out task definition families that do not contain any <code>ACTIVE</code> task definition revisions by setting the <code>status</code> parameter to <code>ACTIVE</code>. You can also filter the results with the <code>familyPrefix</code> parameter.</p>"
773 },
774 "ListTaskDefinitions": {
775 "name": "ListTaskDefinitions",
776 "http": {
777 "method": "POST",
778 "requestUri": "/"
779 },
780 "input": {
781 "shape": "ListTaskDefinitionsRequest"
782 },
783 "output": {
784 "shape": "ListTaskDefinitionsResponse"
785 },
786 "errors": [
787 {
788 "shape": "ServerException"
789 },
790 {
791 "shape": "ClientException"
792 },
793 {
794 "shape": "InvalidParameterException"
795 }
796 ],
797 "documentation": "<p>Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter.</p>"
798 },
799 "ListTasks": {
800 "name": "ListTasks",
801 "http": {
802 "method": "POST",
803 "requestUri": "/"
804 },
805 "input": {
806 "shape": "ListTasksRequest"
807 },
808 "output": {
809 "shape": "ListTasksResponse"
810 },
811 "errors": [
812 {
813 "shape": "ServerException"
814 },
815 {
816 "shape": "ClientException"
817 },
818 {
819 "shape": "InvalidParameterException"
820 },
821 {
822 "shape": "ClusterNotFoundException"
823 },
824 {
825 "shape": "ServiceNotFoundException"
826 }
827 ],
828 "documentation": "<p>Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters.</p> <p>Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour. </p>"
829 },
830 "PutAccountSetting": {
831 "name": "PutAccountSetting",
832 "http": {
833 "method": "POST",
834 "requestUri": "/"
835 },
836 "input": {
837 "shape": "PutAccountSettingRequest"
838 },
839 "output": {
840 "shape": "PutAccountSettingResponse"
841 },
842 "errors": [
843 {
844 "shape": "ServerException"
845 },
846 {
847 "shape": "ClientException"
848 },
849 {
850 "shape": "InvalidParameterException"
851 }
852 ],
853 "documentation": "<p>Modifies an account setting. Account settings are set on a per-Region basis.</p> <p>If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html\">Account Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.</p> <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If <code>awsvpcTrunking</code> is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html\">Elastic Network Interface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When <code>containerInsights</code> is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If <code>containerInsights</code> is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html\">CloudWatch Container Insights</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
854 },
855 "PutAccountSettingDefault": {
856 "name": "PutAccountSettingDefault",
857 "http": {
858 "method": "POST",
859 "requestUri": "/"
860 },
861 "input": {
862 "shape": "PutAccountSettingDefaultRequest"
863 },
864 "output": {
865 "shape": "PutAccountSettingDefaultResponse"
866 },
867 "errors": [
868 {
869 "shape": "ServerException"
870 },
871 {
872 "shape": "ClientException"
873 },
874 {
875 "shape": "InvalidParameterException"
876 }
877 ],
878 "documentation": "<p>Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.</p>"
879 },
880 "PutAttributes": {
881 "name": "PutAttributes",
882 "http": {
883 "method": "POST",
884 "requestUri": "/"
885 },
886 "input": {
887 "shape": "PutAttributesRequest"
888 },
889 "output": {
890 "shape": "PutAttributesResponse"
891 },
892 "errors": [
893 {
894 "shape": "ClusterNotFoundException"
895 },
896 {
897 "shape": "TargetNotFoundException"
898 },
899 {
900 "shape": "AttributeLimitExceededException"
901 },
902 {
903 "shape": "InvalidParameterException"
904 }
905 ],
906 "documentation": "<p>Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use <a>DeleteAttributes</a>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
907 },
908 "PutClusterCapacityProviders": {
909 "name": "PutClusterCapacityProviders",
910 "http": {
911 "method": "POST",
912 "requestUri": "/"
913 },
914 "input": {
915 "shape": "PutClusterCapacityProvidersRequest"
916 },
917 "output": {
918 "shape": "PutClusterCapacityProvidersResponse"
919 },
920 "errors": [
921 {
922 "shape": "ServerException"
923 },
924 {
925 "shape": "ClientException"
926 },
927 {
928 "shape": "InvalidParameterException"
929 },
930 {
931 "shape": "ClusterNotFoundException"
932 },
933 {
934 "shape": "ResourceInUseException"
935 },
936 {
937 "shape": "UpdateInProgressException"
938 }
939 ],
940 "documentation": "<p>Modifies the available capacity providers and the default capacity provider strategy for a cluster.</p> <p>You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a <a>PutClusterCapacityProviders</a> API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.</p> <p>When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array (<code>[]</code>) to bypass defining a default strategy.</p>"
941 },
942 "RegisterContainerInstance": {
943 "name": "RegisterContainerInstance",
944 "http": {
945 "method": "POST",
946 "requestUri": "/"
947 },
948 "input": {
949 "shape": "RegisterContainerInstanceRequest"
950 },
951 "output": {
952 "shape": "RegisterContainerInstanceResponse"
953 },
954 "errors": [
955 {
956 "shape": "ServerException"
957 },
958 {
959 "shape": "ClientException"
960 },
961 {
962 "shape": "InvalidParameterException"
963 }
964 ],
965 "documentation": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.</p>"
966 },
967 "RegisterTaskDefinition": {
968 "name": "RegisterTaskDefinition",
969 "http": {
970 "method": "POST",
971 "requestUri": "/"
972 },
973 "input": {
974 "shape": "RegisterTaskDefinitionRequest"
975 },
976 "output": {
977 "shape": "RegisterTaskDefinitionResponse"
978 },
979 "errors": [
980 {
981 "shape": "ServerException"
982 },
983 {
984 "shape": "ClientException"
985 },
986 {
987 "shape": "InvalidParameterException"
988 }
989 ],
990 "documentation": "<p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify a Docker networking mode for the containers in your task definition with the <code>networkMode</code> parameter. The available network modes correspond to those described in <a href=\"https://docs.docker.com/engine/reference/run/#/network-settings\">Network settings</a> in the Docker run reference. If you specify the <code>awsvpc</code> network mode, the task is allocated an elastic network interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
991 },
992 "RunTask": {
993 "name": "RunTask",
994 "http": {
995 "method": "POST",
996 "requestUri": "/"
997 },
998 "input": {
999 "shape": "RunTaskRequest"
1000 },
1001 "output": {
1002 "shape": "RunTaskResponse"
1003 },
1004 "errors": [
1005 {
1006 "shape": "ServerException"
1007 },
1008 {
1009 "shape": "ClientException"
1010 },
1011 {
1012 "shape": "InvalidParameterException"
1013 },
1014 {
1015 "shape": "ClusterNotFoundException"
1016 },
1017 {
1018 "shape": "UnsupportedFeatureException"
1019 },
1020 {
1021 "shape": "PlatformUnknownException"
1022 },
1023 {
1024 "shape": "PlatformTaskDefinitionIncompatibilityException"
1025 },
1026 {
1027 "shape": "AccessDeniedException"
1028 },
1029 {
1030 "shape": "BlockedException"
1031 }
1032 ],
1033 "documentation": "<p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more 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> <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or place tasks manually on specific container instances.</p> <p>The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul>"
1034 },
1035 "StartTask": {
1036 "name": "StartTask",
1037 "http": {
1038 "method": "POST",
1039 "requestUri": "/"
1040 },
1041 "input": {
1042 "shape": "StartTaskRequest"
1043 },
1044 "output": {
1045 "shape": "StartTaskResponse"
1046 },
1047 "errors": [
1048 {
1049 "shape": "ServerException"
1050 },
1051 {
1052 "shape": "ClientException"
1053 },
1054 {
1055 "shape": "InvalidParameterException"
1056 },
1057 {
1058 "shape": "ClusterNotFoundException"
1059 }
1060 ],
1061 "documentation": "<p>Starts a new task from the specified task definition on the specified container instance or instances.</p> <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more 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>"
1062 },
1063 "StopTask": {
1064 "name": "StopTask",
1065 "http": {
1066 "method": "POST",
1067 "requestUri": "/"
1068 },
1069 "input": {
1070 "shape": "StopTaskRequest"
1071 },
1072 "output": {
1073 "shape": "StopTaskResponse"
1074 },
1075 "errors": [
1076 {
1077 "shape": "ServerException"
1078 },
1079 {
1080 "shape": "ClientException"
1081 },
1082 {
1083 "shape": "InvalidParameterException"
1084 },
1085 {
1086 "shape": "ClusterNotFoundException"
1087 }
1088 ],
1089 "documentation": "<p>Stops a running task. Any tags associated with the task will be deleted.</p> <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> value and a default 30-second timeout, after which the <code>SIGKILL</code> value is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> value is sent.</p> <note> <p>The default 30-second timeout can be configured on the Amazon ECS container agent with the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
1090 },
1091 "SubmitAttachmentStateChanges": {
1092 "name": "SubmitAttachmentStateChanges",
1093 "http": {
1094 "method": "POST",
1095 "requestUri": "/"
1096 },
1097 "input": {
1098 "shape": "SubmitAttachmentStateChangesRequest"
1099 },
1100 "output": {
1101 "shape": "SubmitAttachmentStateChangesResponse"
1102 },
1103 "errors": [
1104 {
1105 "shape": "ServerException"
1106 },
1107 {
1108 "shape": "ClientException"
1109 },
1110 {
1111 "shape": "AccessDeniedException"
1112 },
1113 {
1114 "shape": "InvalidParameterException"
1115 }
1116 ],
1117 "documentation": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that an attachment changed states.</p>"
1118 },
1119 "SubmitContainerStateChange": {
1120 "name": "SubmitContainerStateChange",
1121 "http": {
1122 "method": "POST",
1123 "requestUri": "/"
1124 },
1125 "input": {
1126 "shape": "SubmitContainerStateChangeRequest"
1127 },
1128 "output": {
1129 "shape": "SubmitContainerStateChangeResponse"
1130 },
1131 "errors": [
1132 {
1133 "shape": "ServerException"
1134 },
1135 {
1136 "shape": "ClientException"
1137 },
1138 {
1139 "shape": "AccessDeniedException"
1140 }
1141 ],
1142 "documentation": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a container changed states.</p>"
1143 },
1144 "SubmitTaskStateChange": {
1145 "name": "SubmitTaskStateChange",
1146 "http": {
1147 "method": "POST",
1148 "requestUri": "/"
1149 },
1150 "input": {
1151 "shape": "SubmitTaskStateChangeRequest"
1152 },
1153 "output": {
1154 "shape": "SubmitTaskStateChangeResponse"
1155 },
1156 "errors": [
1157 {
1158 "shape": "ServerException"
1159 },
1160 {
1161 "shape": "ClientException"
1162 },
1163 {
1164 "shape": "AccessDeniedException"
1165 },
1166 {
1167 "shape": "InvalidParameterException"
1168 }
1169 ],
1170 "documentation": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a task changed states.</p>"
1171 },
1172 "TagResource": {
1173 "name": "TagResource",
1174 "http": {
1175 "method": "POST",
1176 "requestUri": "/"
1177 },
1178 "input": {
1179 "shape": "TagResourceRequest"
1180 },
1181 "output": {
1182 "shape": "TagResourceResponse"
1183 },
1184 "errors": [
1185 {
1186 "shape": "ServerException"
1187 },
1188 {
1189 "shape": "ClientException"
1190 },
1191 {
1192 "shape": "ClusterNotFoundException"
1193 },
1194 {
1195 "shape": "ResourceNotFoundException"
1196 },
1197 {
1198 "shape": "InvalidParameterException"
1199 }
1200 ],
1201 "documentation": "<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.</p>"
1202 },
1203 "UntagResource": {
1204 "name": "UntagResource",
1205 "http": {
1206 "method": "POST",
1207 "requestUri": "/"
1208 },
1209 "input": {
1210 "shape": "UntagResourceRequest"
1211 },
1212 "output": {
1213 "shape": "UntagResourceResponse"
1214 },
1215 "errors": [
1216 {
1217 "shape": "ServerException"
1218 },
1219 {
1220 "shape": "ClientException"
1221 },
1222 {
1223 "shape": "ClusterNotFoundException"
1224 },
1225 {
1226 "shape": "ResourceNotFoundException"
1227 },
1228 {
1229 "shape": "InvalidParameterException"
1230 }
1231 ],
1232 "documentation": "<p>Deletes specified tags from a resource.</p>"
1233 },
1234 "UpdateClusterSettings": {
1235 "name": "UpdateClusterSettings",
1236 "http": {
1237 "method": "POST",
1238 "requestUri": "/"
1239 },
1240 "input": {
1241 "shape": "UpdateClusterSettingsRequest"
1242 },
1243 "output": {
1244 "shape": "UpdateClusterSettingsResponse"
1245 },
1246 "errors": [
1247 {
1248 "shape": "ServerException"
1249 },
1250 {
1251 "shape": "ClientException"
1252 },
1253 {
1254 "shape": "ClusterNotFoundException"
1255 },
1256 {
1257 "shape": "InvalidParameterException"
1258 }
1259 ],
1260 "documentation": "<p>Modifies the settings to use for a cluster.</p>"
1261 },
1262 "UpdateContainerAgent": {
1263 "name": "UpdateContainerAgent",
1264 "http": {
1265 "method": "POST",
1266 "requestUri": "/"
1267 },
1268 "input": {
1269 "shape": "UpdateContainerAgentRequest"
1270 },
1271 "output": {
1272 "shape": "UpdateContainerAgentResponse"
1273 },
1274 "errors": [
1275 {
1276 "shape": "ServerException"
1277 },
1278 {
1279 "shape": "ClientException"
1280 },
1281 {
1282 "shape": "InvalidParameterException"
1283 },
1284 {
1285 "shape": "ClusterNotFoundException"
1286 },
1287 {
1288 "shape": "UpdateInProgressException"
1289 },
1290 {
1291 "shape": "NoUpdateAvailableException"
1292 },
1293 {
1294 "shape": "MissingVersionException"
1295 }
1296 ],
1297 "documentation": "<p>Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.</p> <p> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent\">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1298 },
1299 "UpdateContainerInstancesState": {
1300 "name": "UpdateContainerInstancesState",
1301 "http": {
1302 "method": "POST",
1303 "requestUri": "/"
1304 },
1305 "input": {
1306 "shape": "UpdateContainerInstancesStateRequest"
1307 },
1308 "output": {
1309 "shape": "UpdateContainerInstancesStateResponse"
1310 },
1311 "errors": [
1312 {
1313 "shape": "ServerException"
1314 },
1315 {
1316 "shape": "ClientException"
1317 },
1318 {
1319 "shape": "InvalidParameterException"
1320 },
1321 {
1322 "shape": "ClusterNotFoundException"
1323 }
1324 ],
1325 "documentation": "<p>Modifies the status of an Amazon ECS container instance.</p> <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.</p> <important> <p>A container instance cannot be changed to <code>DRAINING</code> until it has reached an <code>ACTIVE</code> status. If the instance is in any other status, an error will be received.</p> </important> <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the <code>PENDING</code> state are stopped immediately.</p> <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and replaced according to the service's deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment configuration of your service using <a>UpdateService</a>.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during task replacement. For example, <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.</p> </li> </ul> <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.</p> <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can verify this using <a>ListTasks</a>.</p> <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.</p>"
1326 },
1327 "UpdateService": {
1328 "name": "UpdateService",
1329 "http": {
1330 "method": "POST",
1331 "requestUri": "/"
1332 },
1333 "input": {
1334 "shape": "UpdateServiceRequest"
1335 },
1336 "output": {
1337 "shape": "UpdateServiceResponse"
1338 },
1339 "errors": [
1340 {
1341 "shape": "ServerException"
1342 },
1343 {
1344 "shape": "ClientException"
1345 },
1346 {
1347 "shape": "InvalidParameterException"
1348 },
1349 {
1350 "shape": "ClusterNotFoundException"
1351 },
1352 {
1353 "shape": "ServiceNotFoundException"
1354 },
1355 {
1356 "shape": "ServiceNotActiveException"
1357 },
1358 {
1359 "shape": "PlatformUnknownException"
1360 },
1361 {
1362 "shape": "PlatformTaskDefinitionIncompatibilityException"
1363 },
1364 {
1365 "shape": "AccessDeniedException"
1366 }
1367 ],
1368 "documentation": "<important> <p>Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at <a href=\"https://aws.amazon.com/service-terms\">https://aws.amazon.com/service-terms</a> (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.</p> </important> <p>Modifies the parameters of a service.</p> <p>For services using the rolling update (<code>ECS</code>) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.</p> <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html\">CreateDeployment</a> in the <i>AWS CodeDeploy API Reference</i>.</p> <p>For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see <a>CreateTaskSet</a>.</p> <p>You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter.</p> <p>If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.</p> <note> <p>If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, <code>my_image:latest</code>), you do not need to create a new revision of your task definition. You can update the service using the <code>forceNewDeployment</code> option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.</p> </note> <p>You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):</p> <ul> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul>"
1369 },
1370 "UpdateServicePrimaryTaskSet": {
1371 "name": "UpdateServicePrimaryTaskSet",
1372 "http": {
1373 "method": "POST",
1374 "requestUri": "/"
1375 },
1376 "input": {
1377 "shape": "UpdateServicePrimaryTaskSetRequest"
1378 },
1379 "output": {
1380 "shape": "UpdateServicePrimaryTaskSetResponse"
1381 },
1382 "errors": [
1383 {
1384 "shape": "ServerException"
1385 },
1386 {
1387 "shape": "ClientException"
1388 },
1389 {
1390 "shape": "InvalidParameterException"
1391 },
1392 {
1393 "shape": "ClusterNotFoundException"
1394 },
1395 {
1396 "shape": "UnsupportedFeatureException"
1397 },
1398 {
1399 "shape": "ServiceNotFoundException"
1400 },
1401 {
1402 "shape": "ServiceNotActiveException"
1403 },
1404 {
1405 "shape": "TaskSetNotFoundException"
1406 },
1407 {
1408 "shape": "AccessDeniedException"
1409 }
1410 ],
1411 "documentation": "<p>Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1412 },
1413 "UpdateTaskSet": {
1414 "name": "UpdateTaskSet",
1415 "http": {
1416 "method": "POST",
1417 "requestUri": "/"
1418 },
1419 "input": {
1420 "shape": "UpdateTaskSetRequest"
1421 },
1422 "output": {
1423 "shape": "UpdateTaskSetResponse"
1424 },
1425 "errors": [
1426 {
1427 "shape": "ServerException"
1428 },
1429 {
1430 "shape": "ClientException"
1431 },
1432 {
1433 "shape": "InvalidParameterException"
1434 },
1435 {
1436 "shape": "ClusterNotFoundException"
1437 },
1438 {
1439 "shape": "UnsupportedFeatureException"
1440 },
1441 {
1442 "shape": "AccessDeniedException"
1443 },
1444 {
1445 "shape": "ServiceNotFoundException"
1446 },
1447 {
1448 "shape": "ServiceNotActiveException"
1449 },
1450 {
1451 "shape": "TaskSetNotFoundException"
1452 }
1453 ],
1454 "documentation": "<p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1455 }
1456 },
1457 "shapes": {
1458 "AgentUpdateStatus": {
1459 "type": "string",
1460 "enum": [
1461 "PENDING",
1462 "STAGING",
1463 "STAGED",
1464 "UPDATING",
1465 "UPDATED",
1466 "FAILED"
1467 ]
1468 },
1469 "AssignPublicIp": {
1470 "type": "string",
1471 "enum": [
1472 "ENABLED",
1473 "DISABLED"
1474 ]
1475 },
1476 "Attachment": {
1477 "type": "structure",
1478 "members": {
1479 "id": {
1480 "shape": "String",
1481 "documentation": "<p>The unique identifier for the attachment.</p>"
1482 },
1483 "type": {
1484 "shape": "String",
1485 "documentation": "<p>The type of the attachment, such as <code>ElasticNetworkInterface</code>.</p>"
1486 },
1487 "status": {
1488 "shape": "String",
1489 "documentation": "<p> The status of the attachment. Valid values are <code>PRECREATED</code>, <code>CREATED</code>, <code>ATTACHING</code>, <code>ATTACHED</code>, <code>DETACHING</code>, <code>DETACHED</code>, and <code>DELETED</code>.</p>"
1490 },
1491 "details": {
1492 "shape": "AttachmentDetails",
1493 "documentation": "<p>Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.</p>"
1494 }
1495 },
1496 "documentation": "<p>An object representing a container instance or task attachment.</p>"
1497 },
1498 "AttachmentDetails": {
1499 "type": "list",
1500 "member": {
1501 "shape": "KeyValuePair"
1502 }
1503 },
1504 "AttachmentStateChange": {
1505 "type": "structure",
1506 "required": [
1507 "attachmentArn",
1508 "status"
1509 ],
1510 "members": {
1511 "attachmentArn": {
1512 "shape": "String",
1513 "documentation": "<p>The Amazon Resource Name (ARN) of the attachment.</p>"
1514 },
1515 "status": {
1516 "shape": "String",
1517 "documentation": "<p>The status of the attachment.</p>"
1518 }
1519 },
1520 "documentation": "<p>An object representing a change in state for a task attachment.</p>"
1521 },
1522 "AttachmentStateChanges": {
1523 "type": "list",
1524 "member": {
1525 "shape": "AttachmentStateChange"
1526 }
1527 },
1528 "Attachments": {
1529 "type": "list",
1530 "member": {
1531 "shape": "Attachment"
1532 }
1533 },
1534 "Attribute": {
1535 "type": "structure",
1536 "required": [
1537 "name"
1538 ],
1539 "members": {
1540 "name": {
1541 "shape": "String",
1542 "documentation": "<p>The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.</p>"
1543 },
1544 "value": {
1545 "shape": "String",
1546 "documentation": "<p>The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.</p>"
1547 },
1548 "targetType": {
1549 "shape": "TargetType",
1550 "documentation": "<p>The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.</p>"
1551 },
1552 "targetId": {
1553 "shape": "String",
1554 "documentation": "<p>The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).</p>"
1555 }
1556 },
1557 "documentation": "<p>An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1558 },
1559 "Attributes": {
1560 "type": "list",
1561 "member": {
1562 "shape": "Attribute"
1563 }
1564 },
1565 "AutoScalingGroupProvider": {
1566 "type": "structure",
1567 "required": [
1568 "autoScalingGroupArn"
1569 ],
1570 "members": {
1571 "autoScalingGroupArn": {
1572 "shape": "String",
1573 "documentation": "<p>The Amazon Resource Name (ARN) that identifies the Auto Scaling group.</p>"
1574 },
1575 "managedScaling": {
1576 "shape": "ManagedScaling",
1577 "documentation": "<p>The managed scaling settings for the Auto Scaling group capacity provider.</p>"
1578 },
1579 "managedTerminationProtection": {
1580 "shape": "ManagedTerminationProtection",
1581 "documentation": "<p>The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.</p> <important> <p>When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.</p> </important> <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>AWS Auto Scaling User Guide</i>.</p> <p>When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.</p>"
1582 }
1583 },
1584 "documentation": "<p>The details of the Auto Scaling group for the capacity provider.</p>"
1585 },
1586 "AwsVpcConfiguration": {
1587 "type": "structure",
1588 "required": [
1589 "subnets"
1590 ],
1591 "members": {
1592 "subnets": {
1593 "shape": "StringList",
1594 "documentation": "<p>The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per <code>AwsVpcConfiguration</code>.</p> <note> <p>All specified subnets must be from the same VPC.</p> </note>"
1595 },
1596 "securityGroups": {
1597 "shape": "StringList",
1598 "documentation": "<p>The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per <code>AwsVpcConfiguration</code>.</p> <note> <p>All specified security groups must be from the same VPC.</p> </note>"
1599 },
1600 "assignPublicIp": {
1601 "shape": "AssignPublicIp",
1602 "documentation": "<p>Whether the task's elastic network interface receives a public IP address. The default value is <code>DISABLED</code>.</p>"
1603 }
1604 },
1605 "documentation": "<p>An object representing the networking details for a task or service.</p>"
1606 },
1607 "Boolean": {
1608 "type": "boolean"
1609 },
1610 "BoxedBoolean": {
1611 "type": "boolean",
1612 "box": true
1613 },
1614 "BoxedInteger": {
1615 "type": "integer",
1616 "box": true
1617 },
1618 "CapacityProvider": {
1619 "type": "structure",
1620 "members": {
1621 "capacityProviderArn": {
1622 "shape": "String",
1623 "documentation": "<p>The Amazon Resource Name (ARN) that identifies the capacity provider.</p>"
1624 },
1625 "name": {
1626 "shape": "String",
1627 "documentation": "<p>The name of the capacity provider.</p>"
1628 },
1629 "status": {
1630 "shape": "CapacityProviderStatus",
1631 "documentation": "<p>The current status of the capacity provider. Only capacity providers in an <code>ACTIVE</code> state can be used in a cluster.</p>"
1632 },
1633 "autoScalingGroupProvider": {
1634 "shape": "AutoScalingGroupProvider",
1635 "documentation": "<p>The Auto Scaling group settings for the capacity provider.</p>"
1636 },
1637 "tags": {
1638 "shape": "Tags",
1639 "documentation": "<p>The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
1640 }
1641 },
1642 "documentation": "<p>The details of a capacity provider.</p>"
1643 },
1644 "CapacityProviderField": {
1645 "type": "string",
1646 "enum": [
1647 "TAGS"
1648 ]
1649 },
1650 "CapacityProviderFieldList": {
1651 "type": "list",
1652 "member": {
1653 "shape": "CapacityProviderField"
1654 }
1655 },
1656 "CapacityProviderStatus": {
1657 "type": "string",
1658 "enum": [
1659 "ACTIVE"
1660 ]
1661 },
1662 "CapacityProviderStrategy": {
1663 "type": "list",
1664 "member": {
1665 "shape": "CapacityProviderStrategyItem"
1666 }
1667 },
1668 "CapacityProviderStrategyItem": {
1669 "type": "structure",
1670 "required": [
1671 "capacityProvider"
1672 ],
1673 "members": {
1674 "capacityProvider": {
1675 "shape": "String",
1676 "documentation": "<p>The short name of the capacity provider.</p>"
1677 },
1678 "weight": {
1679 "shape": "CapacityProviderStrategyItemWeight",
1680 "documentation": "<p>The <i>weight</i> value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.</p> <p>For example, if you have a strategy that contains two capacity providers and both have a weight of <code>1</code>, then when the <code>base</code> is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of <code>1</code> for <i>capacityProviderA</i> and a weight of <code>4</code> for <i>capacityProviderB</i>, then for every one task that is run using <i>capacityProviderA</i>, four tasks would use <i>capacityProviderB</i>.</p>"
1681 },
1682 "base": {
1683 "shape": "CapacityProviderStrategyItemBase",
1684 "documentation": "<p>The <i>base</i> value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a <i>base</i> defined.</p>"
1685 }
1686 },
1687 "documentation": "<p>The details of a capacity provider strategy.</p>"
1688 },
1689 "CapacityProviderStrategyItemBase": {
1690 "type": "integer",
1691 "max": 100000,
1692 "min": 0
1693 },
1694 "CapacityProviderStrategyItemWeight": {
1695 "type": "integer",
1696 "max": 1000,
1697 "min": 0
1698 },
1699 "CapacityProviders": {
1700 "type": "list",
1701 "member": {
1702 "shape": "CapacityProvider"
1703 }
1704 },
1705 "Cluster": {
1706 "type": "structure",
1707 "members": {
1708 "clusterArn": {
1709 "shape": "String",
1710 "documentation": "<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:region:012345678910:cluster/test</code>.</p>"
1711 },
1712 "clusterName": {
1713 "shape": "String",
1714 "documentation": "<p>A user-generated string that you use to identify your cluster.</p>"
1715 },
1716 "status": {
1717 "shape": "String",
1718 "documentation": "<p>The status of the cluster. The following are the possible states that will be returned.</p> <dl> <dt>ACTIVE</dt> <dd> <p>The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.</p> </dd> <dt>PROVISIONING</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.</p> </dd> <dt>DEPROVISIONING</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.</p> </dd> <dt>FAILED</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.</p> </dd> <dt>INACTIVE</dt> <dd> <p>The cluster has been deleted. Clusters with an <code>INACTIVE</code> status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> clusters persisting.</p> </dd> </dl>"
1719 },
1720 "registeredContainerInstancesCount": {
1721 "shape": "Integer",
1722 "documentation": "<p>The number of container instances registered into the cluster. This includes container instances in both <code>ACTIVE</code> and <code>DRAINING</code> status.</p>"
1723 },
1724 "runningTasksCount": {
1725 "shape": "Integer",
1726 "documentation": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>"
1727 },
1728 "pendingTasksCount": {
1729 "shape": "Integer",
1730 "documentation": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>"
1731 },
1732 "activeServicesCount": {
1733 "shape": "Integer",
1734 "documentation": "<p>The number of services that are running on the cluster in an <code>ACTIVE</code> state. You can view these services with <a>ListServices</a>.</p>"
1735 },
1736 "statistics": {
1737 "shape": "Statistics",
1738 "documentation": "<p>Additional information about your clusters that are separated by launch type, including:</p> <ul> <li> <p>runningEC2TasksCount</p> </li> <li> <p>RunningFargateTasksCount</p> </li> <li> <p>pendingEC2TasksCount</p> </li> <li> <p>pendingFargateTasksCount</p> </li> <li> <p>activeEC2ServiceCount</p> </li> <li> <p>activeFargateServiceCount</p> </li> <li> <p>drainingEC2ServiceCount</p> </li> <li> <p>drainingFargateServiceCount</p> </li> </ul>"
1739 },
1740 "tags": {
1741 "shape": "Tags",
1742 "documentation": "<p>The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
1743 },
1744 "settings": {
1745 "shape": "ClusterSettings",
1746 "documentation": "<p>The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.</p>"
1747 },
1748 "capacityProviders": {
1749 "shape": "StringList",
1750 "documentation": "<p>The capacity providers associated with the cluster.</p>"
1751 },
1752 "defaultCapacityProviderStrategy": {
1753 "shape": "CapacityProviderStrategy",
1754 "documentation": "<p>The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.</p>"
1755 },
1756 "attachments": {
1757 "shape": "Attachments",
1758 "documentation": "<p>The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.</p>"
1759 },
1760 "attachmentsStatus": {
1761 "shape": "String",
1762 "documentation": "<p>The status of the capacity providers associated with the cluster. The following are the states that will be returned:</p> <dl> <dt>UPDATE_IN_PROGRESS</dt> <dd> <p>The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.</p> </dd> <dt>UPDATE_COMPLETE</dt> <dd> <p>The capacity providers have successfully updated.</p> </dd> <dt>UPDATE_FAILED</dt> <dd> <p>The capacity provider updates failed.</p> </dd> </dl>"
1763 }
1764 },
1765 "documentation": "<p>A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.</p>"
1766 },
1767 "ClusterField": {
1768 "type": "string",
1769 "enum": [
1770 "ATTACHMENTS",
1771 "SETTINGS",
1772 "STATISTICS",
1773 "TAGS"
1774 ]
1775 },
1776 "ClusterFieldList": {
1777 "type": "list",
1778 "member": {
1779 "shape": "ClusterField"
1780 }
1781 },
1782 "ClusterSetting": {
1783 "type": "structure",
1784 "members": {
1785 "name": {
1786 "shape": "ClusterSettingName",
1787 "documentation": "<p>The name of the cluster setting. The only supported value is <code>containerInsights</code>.</p>"
1788 },
1789 "value": {
1790 "shape": "String",
1791 "documentation": "<p>The value to set for the cluster setting. The supported values are <code>enabled</code> and <code>disabled</code>. If <code>enabled</code> is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the <code>containerInsights</code> account setting is enabled. If a cluster value is specified, it will override the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
1792 }
1793 },
1794 "documentation": "<p>The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.</p>"
1795 },
1796 "ClusterSettingName": {
1797 "type": "string",
1798 "enum": [
1799 "containerInsights"
1800 ]
1801 },
1802 "ClusterSettings": {
1803 "type": "list",
1804 "member": {
1805 "shape": "ClusterSetting"
1806 }
1807 },
1808 "Clusters": {
1809 "type": "list",
1810 "member": {
1811 "shape": "Cluster"
1812 }
1813 },
1814 "Compatibility": {
1815 "type": "string",
1816 "enum": [
1817 "EC2",
1818 "FARGATE"
1819 ]
1820 },
1821 "CompatibilityList": {
1822 "type": "list",
1823 "member": {
1824 "shape": "Compatibility"
1825 }
1826 },
1827 "Connectivity": {
1828 "type": "string",
1829 "enum": [
1830 "CONNECTED",
1831 "DISCONNECTED"
1832 ]
1833 },
1834 "Container": {
1835 "type": "structure",
1836 "members": {
1837 "containerArn": {
1838 "shape": "String",
1839 "documentation": "<p>The Amazon Resource Name (ARN) of the container.</p>"
1840 },
1841 "taskArn": {
1842 "shape": "String",
1843 "documentation": "<p>The ARN of the task.</p>"
1844 },
1845 "name": {
1846 "shape": "String",
1847 "documentation": "<p>The name of the container.</p>"
1848 },
1849 "image": {
1850 "shape": "String",
1851 "documentation": "<p>The image used for the container.</p>"
1852 },
1853 "imageDigest": {
1854 "shape": "String",
1855 "documentation": "<p>The container image manifest digest.</p> <note> <p>The <code>imageDigest</code> is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.</p> </note>"
1856 },
1857 "runtimeId": {
1858 "shape": "String",
1859 "documentation": "<p>The ID of the Docker container.</p>"
1860 },
1861 "lastStatus": {
1862 "shape": "String",
1863 "documentation": "<p>The last known status of the container.</p>"
1864 },
1865 "exitCode": {
1866 "shape": "BoxedInteger",
1867 "documentation": "<p>The exit code returned from the container.</p>"
1868 },
1869 "reason": {
1870 "shape": "String",
1871 "documentation": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>"
1872 },
1873 "networkBindings": {
1874 "shape": "NetworkBindings",
1875 "documentation": "<p>The network bindings associated with the container.</p>"
1876 },
1877 "networkInterfaces": {
1878 "shape": "NetworkInterfaces",
1879 "documentation": "<p>The network interfaces associated with the container.</p>"
1880 },
1881 "healthStatus": {
1882 "shape": "HealthStatus",
1883 "documentation": "<p>The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as <code>UNKNOWN</code>.</p>"
1884 },
1885 "cpu": {
1886 "shape": "String",
1887 "documentation": "<p>The number of CPU units set for the container. The value will be <code>0</code> if no value was specified in the container definition when the task definition was registered.</p>"
1888 },
1889 "memory": {
1890 "shape": "String",
1891 "documentation": "<p>The hard limit (in MiB) of memory set for the container.</p>"
1892 },
1893 "memoryReservation": {
1894 "shape": "String",
1895 "documentation": "<p>The soft limit (in MiB) of memory set for the container.</p>"
1896 },
1897 "gpuIds": {
1898 "shape": "GpuIds",
1899 "documentation": "<p>The IDs of each GPU assigned to the container.</p>"
1900 }
1901 },
1902 "documentation": "<p>A Docker container that is part of a task.</p>"
1903 },
1904 "ContainerCondition": {
1905 "type": "string",
1906 "enum": [
1907 "START",
1908 "COMPLETE",
1909 "SUCCESS",
1910 "HEALTHY"
1911 ]
1912 },
1913 "ContainerDefinition": {
1914 "type": "structure",
1915 "members": {
1916 "name": {
1917 "shape": "String",
1918 "documentation": "<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>"
1919 },
1920 "image": {
1921 "shape": "String",
1922 "documentation": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.</p> </li> <li> <p>Images in Amazon ECR repositories can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;:latest</code> or <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>. </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
1923 },
1924 "repositoryCredentials": {
1925 "shape": "RepositoryCredentials",
1926 "documentation": "<p>The private repository authentication credentials to use.</p>"
1927 },
1928 "cpu": {
1929 "shape": "Integer",
1930 "documentation": "<p>The number of <code>cpu</code> units reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>"
1931 },
1932 "memory": {
1933 "shape": "BoxedInteger",
1934 "documentation": "<p>The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task <code>memory</code> value, if one is specified. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>If using the Fargate launch type, this parameter is optional.</p> <p>If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level <code>memory</code> and <code>memoryReservation</code> value, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of <code>memory</code> is used.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.</p>"
1935 },
1936 "memoryReservation": {
1937 "shape": "BoxedInteger",
1938 "documentation": "<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>If a task-level memory value is not specified, you must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in a container definition. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
1939 },
1940 "links": {
1941 "shape": "StringList",
1942 "documentation": "<p>The <code>links</code> parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is <code>bridge</code>. The <code>name:internalName</code> construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to <a href=\"https://docs.docker.com/network/links/\">Legacy container links</a> in the Docker documentation. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>"
1943 },
1944 "portMappings": {
1945 "shape": "PortMappingList",
1946 "documentation": "<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.</p> <p>For task definitions that use the <code>awsvpc</code> network mode, you should only specify the <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than <code>localhost</code>. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. </p> <p>This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you can't specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
1947 },
1948 "essential": {
1949 "shape": "BoxedBoolean",
1950 "documentation": "<p>If the <code>essential</code> parameter of a container is marked as <code>true</code>, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the <code>essential</code> parameter of a container is marked as <code>false</code>, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.</p> <p>All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html\">Application Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1951 },
1952 "entryPoint": {
1953 "shape": "StringList",
1954 "documentation": "<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>"
1955 },
1956 "command": {
1957 "shape": "StringList",
1958 "documentation": "<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>. If there are multiple arguments, each argument should be a separated string in the array.</p>"
1959 },
1960 "environment": {
1961 "shape": "EnvironmentVariables",
1962 "documentation": "<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important>"
1963 },
1964 "environmentFiles": {
1965 "shape": "EnvironmentFiles",
1966 "documentation": "<p>A list of files containing the environment variables to pass to a container. This parameter maps to the <code>--env-file</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You can specify up to ten environment files. The file must have a <code>.env</code> file extension. Each line in an environment file should contain an environment variable in <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated as comments and are ignored. For more information on the environment variable file syntax, see <a href=\"https://docs.docker.com/compose/env-file/\">Declare default environment variables in file</a>.</p> <p>If there are environment variables specified using the <code>environment</code> parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html\">Specifying Environment Variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This field is not valid for containers in tasks using the Fargate launch type.</p>"
1967 },
1968 "mountPoints": {
1969 "shape": "MountPointList",
1970 "documentation": "<p>The mount points for data volumes in your container.</p> <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.</p>"
1971 },
1972 "volumesFrom": {
1973 "shape": "VolumeFromList",
1974 "documentation": "<p>Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
1975 },
1976 "linuxParameters": {
1977 "shape": "LinuxParameters",
1978 "documentation": "<p>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see <a>KernelCapabilities</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
1979 },
1980 "secrets": {
1981 "shape": "SecretList",
1982 "documentation": "<p>The secrets to pass to the container. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html\">Specifying Sensitive Data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1983 },
1984 "dependsOn": {
1985 "shape": "ContainerDependencies",
1986 "documentation": "<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>For tasks using the Fargate launch type, the task or service requires platform version <code>1.3.0</code> or later.</p>"
1987 },
1988 "startTimeout": {
1989 "shape": "BoxedInteger",
1990 "documentation": "<p>Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a <code>COMPLETE</code>, <code>SUCCESS</code>, or <code>HEALTHY</code> status. If a <code>startTimeout</code> value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a <code>STOPPED</code> state.</p> <p>For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. If this parameter is not specified, the default value of 3 minutes is used.</p> <p>For tasks using the EC2 launch type, if the <code>startTimeout</code> parameter is not specified, the value set for the Amazon ECS container agent configuration variable <code>ECS_CONTAINER_START_TIMEOUT</code> is used by default. If neither the <code>startTimeout</code> parameter or the <code>ECS_CONTAINER_START_TIMEOUT</code> agent configuration variable are set, then the default values of 3 minutes for Linux containers and 8 minutes on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1991 },
1992 "stopTimeout": {
1993 "shape": "BoxedInteger",
1994 "documentation": "<p>Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.</p> <p>For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.</p> <p>For tasks using the EC2 launch type, if the <code>stopTimeout</code> parameter is not specified, the value set for the Amazon ECS container agent configuration variable <code>ECS_CONTAINER_STOP_TIMEOUT</code> is used by default. If neither the <code>stopTimeout</code> parameter or the <code>ECS_CONTAINER_STOP_TIMEOUT</code> agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1995 },
1996 "hostname": {
1997 "shape": "String",
1998 "documentation": "<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The <code>hostname</code> parameter is not supported if you are using the <code>awsvpc</code> network mode.</p> </note>"
1999 },
2000 "user": {
2001 "shape": "String",
2002 "documentation": "<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer.</p> <ul> <li> <p> <code>user</code> </p> </li> <li> <p> <code>user:group</code> </p> </li> <li> <p> <code>uid</code> </p> </li> <li> <p> <code>uid:gid</code> </p> </li> <li> <p> <code>user:gid</code> </p> </li> <li> <p> <code>uid:group</code> </p> </li> </ul> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
2003 },
2004 "workingDirectory": {
2005 "shape": "String",
2006 "documentation": "<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
2007 },
2008 "disableNetworking": {
2009 "shape": "BoxedBoolean",
2010 "documentation": "<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
2011 },
2012 "privileged": {
2013 "shape": "BoxedBoolean",
2014 "documentation": "<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
2015 },
2016 "readonlyRootFilesystem": {
2017 "shape": "BoxedBoolean",
2018 "documentation": "<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--read-only</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
2019 },
2020 "dnsServers": {
2021 "shape": "StringList",
2022 "documentation": "<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
2023 },
2024 "dnsSearchDomains": {
2025 "shape": "StringList",
2026 "documentation": "<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
2027 },
2028 "extraHosts": {
2029 "shape": "HostEntryList",
2030 "documentation": "<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks that use the <code>awsvpc</code> network mode.</p> </note>"
2031 },
2032 "dockerSecurityOptions": {
2033 "shape": "StringList",
2034 "documentation": "<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html\">Using gMSAs for Windows Containers</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
2035 },
2036 "interactive": {
2037 "shape": "BoxedBoolean",
2038 "documentation": "<p>When this parameter is <code>true</code>, this allows you to deploy containerized applications that require <code>stdin</code> or a <code>tty</code> to be allocated. This parameter maps to <code>OpenStdin</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--interactive</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
2039 },
2040 "pseudoTerminal": {
2041 "shape": "BoxedBoolean",
2042 "documentation": "<p>When this parameter is <code>true</code>, a TTY is allocated. This parameter maps to <code>Tty</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--tty</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
2043 },
2044 "dockerLabels": {
2045 "shape": "DockerLabelsMap",
2046 "documentation": "<p>A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> </p>"
2047 },
2048 "ulimits": {
2049 "shape": "UlimitList",
2050 "documentation": "<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> </p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
2051 },
2052 "logConfiguration": {
2053 "shape": "LogConfiguration",
2054 "documentation": "<p>The log configuration specification for the container.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
2055 },
2056 "healthCheck": {
2057 "shape": "HealthCheck",
2058 "documentation": "<p>The container health check command and associated configuration parameters for the container. This parameter maps to <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>HEALTHCHECK</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
2059 },
2060 "systemControls": {
2061 "shape": "SystemControls",
2062 "documentation": "<p>A list of namespaced kernel parameters to set in the container. This parameter maps to <code>Sysctls</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--sysctl</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>It is not recommended that you specify network-related <code>systemControls</code> parameters for multiple containers in a single task that also uses either the <code>awsvpc</code> or <code>host</code> network modes. For tasks that use the <code>awsvpc</code> network mode, the container that is started last determines which <code>systemControls</code> parameters take effect. For tasks that use the <code>host</code> network mode, it changes the container instance's namespaced kernel parameters as well as the containers.</p> </note>"
2063 },
2064 "resourceRequirements": {
2065 "shape": "ResourceRequirements",
2066 "documentation": "<p>The type and amount of a resource to assign to a container. The only supported resource is a GPU.</p>"
2067 },
2068 "firelensConfiguration": {
2069 "shape": "FirelensConfiguration",
2070 "documentation": "<p>The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom Log Routing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2071 }
2072 },
2073 "documentation": "<p>Container definitions are used in task definitions to describe the different containers that are launched as part of a task.</p>"
2074 },
2075 "ContainerDefinitions": {
2076 "type": "list",
2077 "member": {
2078 "shape": "ContainerDefinition"
2079 }
2080 },
2081 "ContainerDependencies": {
2082 "type": "list",
2083 "member": {
2084 "shape": "ContainerDependency"
2085 }
2086 },
2087 "ContainerDependency": {
2088 "type": "structure",
2089 "required": [
2090 "containerName",
2091 "condition"
2092 ],
2093 "members": {
2094 "containerName": {
2095 "shape": "String",
2096 "documentation": "<p>The name of a container.</p>"
2097 },
2098 "condition": {
2099 "shape": "ContainerCondition",
2100 "documentation": "<p>The dependency condition of the container. The following are the available conditions and their behavior:</p> <ul> <li> <p> <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.</p> </li> <li> <p> <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit.</p> </li> <li> <p> <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the container exits with a <code>zero</code> status.</p> </li> <li> <p> <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.</p> </li> </ul>"
2101 }
2102 },
2103 "documentation": "<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.</p> </note>"
2104 },
2105 "ContainerInstance": {
2106 "type": "structure",
2107 "members": {
2108 "containerInstanceArn": {
2109 "shape": "String",
2110 "documentation": "<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
2111 },
2112 "ec2InstanceId": {
2113 "shape": "String",
2114 "documentation": "<p>The EC2 instance ID of the container instance.</p>"
2115 },
2116 "capacityProviderName": {
2117 "shape": "String",
2118 "documentation": "<p>The capacity provider associated with the container instance.</p>"
2119 },
2120 "version": {
2121 "shape": "Long",
2122 "documentation": "<p>The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the <code>detail</code> object) to verify that the version in your event stream is current.</p>"
2123 },
2124 "versionInfo": {
2125 "shape": "VersionInfo",
2126 "documentation": "<p>The version information for the Amazon ECS container agent and Docker daemon running on the container instance.</p>"
2127 },
2128 "remainingResources": {
2129 "shape": "Resources",
2130 "documentation": "<p>For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the <code>host</code> or <code>bridge</code> network mode). Any port that is not specified here is available for new tasks.</p>"
2131 },
2132 "registeredResources": {
2133 "shape": "Resources",
2134 "documentation": "<p>For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.</p>"
2135 },
2136 "status": {
2137 "shape": "String",
2138 "documentation": "<p>The status of the container instance. The valid values are <code>REGISTERING</code>, <code>REGISTRATION_FAILED</code>, <code>ACTIVE</code>, <code>INACTIVE</code>, <code>DEREGISTERING</code>, or <code>DRAINING</code>.</p> <p>If your account has opted in to the <code>awsvpcTrunking</code> account setting, then any newly registered container instance will transition to a <code>REGISTERING</code> status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a <code>REGISTRATION_FAILED</code> status. You can describe the container instance and see the reason for failure in the <code>statusReason</code> parameter. Once the container instance is terminated, the instance transitions to a <code>DEREGISTERING</code> status while the trunk elastic network interface is deprovisioned. The instance then transitions to an <code>INACTIVE</code> status.</p> <p>The <code>ACTIVE</code> status indicates that the container instance can accept tasks. The <code>DRAINING</code> indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html\">Container Instance Draining</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2139 },
2140 "statusReason": {
2141 "shape": "String",
2142 "documentation": "<p>The reason that the container instance reached its current status.</p>"
2143 },
2144 "agentConnected": {
2145 "shape": "Boolean",
2146 "documentation": "<p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>. Only instances connected to an agent can accept placement requests.</p>"
2147 },
2148 "runningTasksCount": {
2149 "shape": "Integer",
2150 "documentation": "<p>The number of tasks on the container instance that are in the <code>RUNNING</code> status.</p>"
2151 },
2152 "pendingTasksCount": {
2153 "shape": "Integer",
2154 "documentation": "<p>The number of tasks on the container instance that are in the <code>PENDING</code> status.</p>"
2155 },
2156 "agentUpdateStatus": {
2157 "shape": "AgentUpdateStatus",
2158 "documentation": "<p>The status of the most recent agent update. If an update has never been requested, this value is <code>NULL</code>.</p>"
2159 },
2160 "attributes": {
2161 "shape": "Attributes",
2162 "documentation": "<p>The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the <a>PutAttributes</a> operation.</p>"
2163 },
2164 "registeredAt": {
2165 "shape": "Timestamp",
2166 "documentation": "<p>The Unix timestamp for when the container instance was registered.</p>"
2167 },
2168 "attachments": {
2169 "shape": "Attachments",
2170 "documentation": "<p>The resources attached to a container instance, such as elastic network interfaces.</p>"
2171 },
2172 "tags": {
2173 "shape": "Tags",
2174 "documentation": "<p>The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
2175 }
2176 },
2177 "documentation": "<p>An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.</p>"
2178 },
2179 "ContainerInstanceField": {
2180 "type": "string",
2181 "enum": [
2182 "TAGS"
2183 ]
2184 },
2185 "ContainerInstanceFieldList": {
2186 "type": "list",
2187 "member": {
2188 "shape": "ContainerInstanceField"
2189 }
2190 },
2191 "ContainerInstanceStatus": {
2192 "type": "string",
2193 "enum": [
2194 "ACTIVE",
2195 "DRAINING",
2196 "REGISTERING",
2197 "DEREGISTERING",
2198 "REGISTRATION_FAILED"
2199 ]
2200 },
2201 "ContainerInstances": {
2202 "type": "list",
2203 "member": {
2204 "shape": "ContainerInstance"
2205 }
2206 },
2207 "ContainerOverride": {
2208 "type": "structure",
2209 "members": {
2210 "name": {
2211 "shape": "String",
2212 "documentation": "<p>The name of the container that receives the override. This parameter is required if any override is specified.</p>"
2213 },
2214 "command": {
2215 "shape": "StringList",
2216 "documentation": "<p>The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.</p>"
2217 },
2218 "environment": {
2219 "shape": "EnvironmentVariables",
2220 "documentation": "<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>"
2221 },
2222 "environmentFiles": {
2223 "shape": "EnvironmentFiles",
2224 "documentation": "<p>A list of files containing the environment variables to pass to a container, instead of the value from the container definition.</p>"
2225 },
2226 "cpu": {
2227 "shape": "BoxedInteger",
2228 "documentation": "<p>The number of <code>cpu</code> units reserved for the container, instead of the default value from the task definition. You must also specify a container name.</p>"
2229 },
2230 "memory": {
2231 "shape": "BoxedInteger",
2232 "documentation": "<p>The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.</p>"
2233 },
2234 "memoryReservation": {
2235 "shape": "BoxedInteger",
2236 "documentation": "<p>The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.</p>"
2237 },
2238 "resourceRequirements": {
2239 "shape": "ResourceRequirements",
2240 "documentation": "<p>The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.</p>"
2241 }
2242 },
2243 "documentation": "<p>The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be <code>{\"containerOverrides\": [ ] }</code>. If a non-empty container override is specified, the <code>name</code> parameter must be included.</p>"
2244 },
2245 "ContainerOverrides": {
2246 "type": "list",
2247 "member": {
2248 "shape": "ContainerOverride"
2249 }
2250 },
2251 "ContainerStateChange": {
2252 "type": "structure",
2253 "members": {
2254 "containerName": {
2255 "shape": "String",
2256 "documentation": "<p>The name of the container.</p>"
2257 },
2258 "imageDigest": {
2259 "shape": "String",
2260 "documentation": "<p>The container image SHA 256 digest.</p>"
2261 },
2262 "runtimeId": {
2263 "shape": "String",
2264 "documentation": "<p>The ID of the Docker container.</p>"
2265 },
2266 "exitCode": {
2267 "shape": "BoxedInteger",
2268 "documentation": "<p>The exit code for the container, if the state change is a result of the container exiting.</p>"
2269 },
2270 "networkBindings": {
2271 "shape": "NetworkBindings",
2272 "documentation": "<p>Any network bindings associated with the container.</p>"
2273 },
2274 "reason": {
2275 "shape": "String",
2276 "documentation": "<p>The reason for the state change.</p>"
2277 },
2278 "status": {
2279 "shape": "String",
2280 "documentation": "<p>The status of the container.</p>"
2281 }
2282 },
2283 "documentation": "<p>An object representing a change in state for a container.</p>"
2284 },
2285 "ContainerStateChanges": {
2286 "type": "list",
2287 "member": {
2288 "shape": "ContainerStateChange"
2289 }
2290 },
2291 "Containers": {
2292 "type": "list",
2293 "member": {
2294 "shape": "Container"
2295 }
2296 },
2297 "CreateCapacityProviderRequest": {
2298 "type": "structure",
2299 "required": [
2300 "name",
2301 "autoScalingGroupProvider"
2302 ],
2303 "members": {
2304 "name": {
2305 "shape": "String",
2306 "documentation": "<p>The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with \"<code>aws</code>\", \"<code>ecs</code>\", or \"<code>fargate</code>\".</p>"
2307 },
2308 "autoScalingGroupProvider": {
2309 "shape": "AutoScalingGroupProvider",
2310 "documentation": "<p>The details of the Auto Scaling group for the capacity provider.</p>"
2311 },
2312 "tags": {
2313 "shape": "Tags",
2314 "documentation": "<p>The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
2315 }
2316 }
2317 },
2318 "CreateCapacityProviderResponse": {
2319 "type": "structure",
2320 "members": {
2321 "capacityProvider": {
2322 "shape": "CapacityProvider",
2323 "documentation": "<p>The full description of the new capacity provider.</p>"
2324 }
2325 }
2326 },
2327 "CreateClusterRequest": {
2328 "type": "structure",
2329 "members": {
2330 "clusterName": {
2331 "shape": "String",
2332 "documentation": "<p>The name of your cluster. If you do not specify a name for your cluster, you create a cluster named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. </p>"
2333 },
2334 "tags": {
2335 "shape": "Tags",
2336 "documentation": "<p>The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
2337 },
2338 "settings": {
2339 "shape": "ClusterSettings",
2340 "documentation": "<p>The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
2341 },
2342 "capacityProviders": {
2343 "shape": "StringList",
2344 "documentation": "<p>The short name of one or more capacity providers to associate with the cluster.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
2345 },
2346 "defaultCapacityProviderStrategy": {
2347 "shape": "CapacityProviderStrategy",
2348 "documentation": "<p>The capacity provider strategy to use by default for the cluster.</p> <p>When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the <a>PutClusterCapacityProviders</a> API operation.</p>"
2349 }
2350 }
2351 },
2352 "CreateClusterResponse": {
2353 "type": "structure",
2354 "members": {
2355 "cluster": {
2356 "shape": "Cluster",
2357 "documentation": "<p>The full description of your new cluster.</p>"
2358 }
2359 }
2360 },
2361 "CreateServiceRequest": {
2362 "type": "structure",
2363 "required": [
2364 "serviceName"
2365 ],
2366 "members": {
2367 "cluster": {
2368 "shape": "String",
2369 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.</p>"
2370 },
2371 "serviceName": {
2372 "shape": "String",
2373 "documentation": "<p>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.</p>"
2374 },
2375 "taskDefinition": {
2376 "shape": "String",
2377 "documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to run in your service. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p> <p>A task definition must be specified if the service is using the <code>ECS</code> deployment controller.</p>"
2378 },
2379 "loadBalancers": {
2380 "shape": "LoadBalancers",
2381 "documentation": "<p>A load balancer object representing the load balancers to use with your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service is using the rolling update (<code>ECS</code>) deployment controller and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service is using the <code>CODE_DEPLOY</code> deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a <code>targetGroupPair</code>). During a deployment, AWS CodeDeploy determines which task set in your service has the status <code>PRIMARY</code> and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.</p> <p>After you create a service using the <code>ECS</code> deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the <code>CODE_DEPLOY</code> deployment controller, these values can be changed when updating the service.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
2382 },
2383 "serviceRegistries": {
2384 "shape": "ServiceRegistries",
2385 "documentation": "<p>The details of the service discovery registries to assign to this service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p> <note> <p>Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a>.</p> </note>"
2386 },
2387 "desiredCount": {
2388 "shape": "BoxedInteger",
2389 "documentation": "<p>The number of instantiations of the specified task definition to place and keep running on your cluster.</p> <p>This is required if <code>schedulingStrategy</code> is <code>REPLICA</code> or is not specified. If <code>schedulingStrategy</code> is <code>DAEMON</code> then this is not required.</p>"
2390 },
2391 "clientToken": {
2392 "shape": "String",
2393 "documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>"
2394 },
2395 "launchType": {
2396 "shape": "LaunchType",
2397 "documentation": "<p>The launch type on which to run your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>"
2398 },
2399 "capacityProviderStrategy": {
2400 "shape": "CapacityProviderStrategy",
2401 "documentation": "<p>The capacity provider strategy to use for the service.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
2402 },
2403 "platformVersion": {
2404 "shape": "String",
2405 "documentation": "<p>The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the <code>LATEST</code> platform version is used by default. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2406 },
2407 "role": {
2408 "shape": "String",
2409 "documentation": "<p>The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the <code>awsvpc</code> network mode. If you specify the <code>role</code> parameter, you must also specify a load balancer object with the <code>loadBalancers</code> parameter.</p> <important> <p>If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the <code>awsvpc</code> network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </important> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name <code>bar</code> has a path of <code>/foo/</code> then you would specify <code>/foo/bar</code> as the role name. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names\">Friendly Names and Paths</a> in the <i>IAM User Guide</i>.</p>"
2410 },
2411 "deploymentConfiguration": {
2412 "shape": "DeploymentConfiguration",
2413 "documentation": "<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>"
2414 },
2415 "placementConstraints": {
2416 "shape": "PlacementConstraints",
2417 "documentation": "<p>An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime). </p>"
2418 },
2419 "placementStrategy": {
2420 "shape": "PlacementStrategies",
2421 "documentation": "<p>The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.</p>"
2422 },
2423 "networkConfiguration": {
2424 "shape": "NetworkConfiguration",
2425 "documentation": "<p>The network configuration for the service. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2426 },
2427 "healthCheckGracePeriodSeconds": {
2428 "shape": "BoxedInteger",
2429 "documentation": "<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of <code>0</code> is used.</p> <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
2430 },
2431 "schedulingStrategy": {
2432 "shape": "SchedulingStrategy",
2433 "documentation": "<p>The scheduling strategy to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Services</a>.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code>-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller types.</p> </li> <li> <p> <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.</p> <note> <p>Tasks using the Fargate launch type or the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller types don't support the <code>DAEMON</code> scheduling strategy.</p> </note> </li> </ul>"
2434 },
2435 "deploymentController": {
2436 "shape": "DeploymentController",
2437 "documentation": "<p>The deployment controller to use for the service.</p>"
2438 },
2439 "tags": {
2440 "shape": "Tags",
2441 "documentation": "<p>The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
2442 },
2443 "enableECSManagedTags": {
2444 "shape": "Boolean",
2445 "documentation": "<p>Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2446 },
2447 "propagateTags": {
2448 "shape": "PropagateTags",
2449 "documentation": "<p>Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the <a>TagResource</a> API action.</p>"
2450 }
2451 }
2452 },
2453 "CreateServiceResponse": {
2454 "type": "structure",
2455 "members": {
2456 "service": {
2457 "shape": "Service",
2458 "documentation": "<p>The full description of your service following the create call.</p> <p>If a service is using the <code>ECS</code> deployment controller, the <code>deploymentController</code> and <code>taskSets</code> parameters will not be returned.</p> <p>If the service is using the <code>CODE_DEPLOY</code> deployment controller, the <code>deploymentController</code>, <code>taskSets</code> and <code>deployments</code> parameters will be returned, however the <code>deployments</code> parameter will be an empty list.</p>"
2459 }
2460 }
2461 },
2462 "CreateTaskSetRequest": {
2463 "type": "structure",
2464 "required": [
2465 "service",
2466 "cluster",
2467 "taskDefinition"
2468 ],
2469 "members": {
2470 "service": {
2471 "shape": "String",
2472 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service to create the task set in.</p>"
2473 },
2474 "cluster": {
2475 "shape": "String",
2476 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.</p>"
2477 },
2478 "externalId": {
2479 "shape": "String",
2480 "documentation": "<p>An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the <code>ECS_TASK_SET_EXTERNAL_ID</code> AWS Cloud Map attribute set to the provided value.</p>"
2481 },
2482 "taskDefinition": {
2483 "shape": "String",
2484 "documentation": "<p>The task definition for the tasks in the task set to use.</p>"
2485 },
2486 "networkConfiguration": {
2487 "shape": "NetworkConfiguration"
2488 },
2489 "loadBalancers": {
2490 "shape": "LoadBalancers",
2491 "documentation": "<p>A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.</p>"
2492 },
2493 "serviceRegistries": {
2494 "shape": "ServiceRegistries",
2495 "documentation": "<p>The details of the service discovery registries to assign to this task set. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p>"
2496 },
2497 "launchType": {
2498 "shape": "LaunchType",
2499 "documentation": "<p>The launch type that new tasks in the task set will use. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>"
2500 },
2501 "capacityProviderStrategy": {
2502 "shape": "CapacityProviderStrategy",
2503 "documentation": "<p>The capacity provider strategy to use for the task set.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
2504 },
2505 "platformVersion": {
2506 "shape": "String",
2507 "documentation": "<p>The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the <code>LATEST</code> platform version is used by default.</p>"
2508 },
2509 "scale": {
2510 "shape": "Scale"
2511 },
2512 "clientToken": {
2513 "shape": "String",
2514 "documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>"
2515 },
2516 "tags": {
2517 "shape": "Tags",
2518 "documentation": "<p>The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
2519 }
2520 }
2521 },
2522 "CreateTaskSetResponse": {
2523 "type": "structure",
2524 "members": {
2525 "taskSet": {
2526 "shape": "TaskSet"
2527 }
2528 }
2529 },
2530 "DeleteAccountSettingRequest": {
2531 "type": "structure",
2532 "required": [
2533 "name"
2534 ],
2535 "members": {
2536 "name": {
2537 "shape": "SettingName",
2538 "documentation": "<p>The resource name for which to disable the account setting. If <code>serviceLongArnFormat</code> is specified, the ARN for your Amazon ECS services is affected. If <code>taskLongArnFormat</code> is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If <code>containerInstanceLongArnFormat</code> is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If <code>awsvpcTrunking</code> is specified, the ENI limit for your Amazon ECS container instances is affected.</p>"
2539 },
2540 "principalArn": {
2541 "shape": "String",
2542 "documentation": "<p>The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.</p>"
2543 }
2544 }
2545 },
2546 "DeleteAccountSettingResponse": {
2547 "type": "structure",
2548 "members": {
2549 "setting": {
2550 "shape": "Setting",
2551 "documentation": "<p>The account setting for the specified principal ARN.</p>"
2552 }
2553 }
2554 },
2555 "DeleteAttributesRequest": {
2556 "type": "structure",
2557 "required": [
2558 "attributes"
2559 ],
2560 "members": {
2561 "cluster": {
2562 "shape": "String",
2563 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.</p>"
2564 },
2565 "attributes": {
2566 "shape": "Attributes",
2567 "documentation": "<p>The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.</p>"
2568 }
2569 }
2570 },
2571 "DeleteAttributesResponse": {
2572 "type": "structure",
2573 "members": {
2574 "attributes": {
2575 "shape": "Attributes",
2576 "documentation": "<p>A list of attribute objects that were successfully deleted from your resource.</p>"
2577 }
2578 }
2579 },
2580 "DeleteClusterRequest": {
2581 "type": "structure",
2582 "required": [
2583 "cluster"
2584 ],
2585 "members": {
2586 "cluster": {
2587 "shape": "String",
2588 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to delete.</p>"
2589 }
2590 }
2591 },
2592 "DeleteClusterResponse": {
2593 "type": "structure",
2594 "members": {
2595 "cluster": {
2596 "shape": "Cluster",
2597 "documentation": "<p>The full description of the deleted cluster.</p>"
2598 }
2599 }
2600 },
2601 "DeleteServiceRequest": {
2602 "type": "structure",
2603 "required": [
2604 "service"
2605 ],
2606 "members": {
2607 "cluster": {
2608 "shape": "String",
2609 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.</p>"
2610 },
2611 "service": {
2612 "shape": "String",
2613 "documentation": "<p>The name of the service to delete.</p>"
2614 },
2615 "force": {
2616 "shape": "BoxedBoolean",
2617 "documentation": "<p>If <code>true</code>, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the <code>REPLICA</code> scheduling strategy.</p>"
2618 }
2619 }
2620 },
2621 "DeleteServiceResponse": {
2622 "type": "structure",
2623 "members": {
2624 "service": {
2625 "shape": "Service",
2626 "documentation": "<p>The full description of the deleted service.</p>"
2627 }
2628 }
2629 },
2630 "DeleteTaskSetRequest": {
2631 "type": "structure",
2632 "required": [
2633 "cluster",
2634 "service",
2635 "taskSet"
2636 ],
2637 "members": {
2638 "cluster": {
2639 "shape": "String",
2640 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.</p>"
2641 },
2642 "service": {
2643 "shape": "String",
2644 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.</p>"
2645 },
2646 "taskSet": {
2647 "shape": "String",
2648 "documentation": "<p>The task set ID or full Amazon Resource Name (ARN) of the task set to delete.</p>"
2649 },
2650 "force": {
2651 "shape": "BoxedBoolean",
2652 "documentation": "<p>If <code>true</code>, this allows you to delete a task set even if it hasn't been scaled down to zero.</p>"
2653 }
2654 }
2655 },
2656 "DeleteTaskSetResponse": {
2657 "type": "structure",
2658 "members": {
2659 "taskSet": {
2660 "shape": "TaskSet"
2661 }
2662 }
2663 },
2664 "Deployment": {
2665 "type": "structure",
2666 "members": {
2667 "id": {
2668 "shape": "String",
2669 "documentation": "<p>The ID of the deployment.</p>"
2670 },
2671 "status": {
2672 "shape": "String",
2673 "documentation": "<p>The status of the deployment. The following describes each state:</p> <dl> <dt>PRIMARY</dt> <dd> <p>The most recent deployment of a service.</p> </dd> <dt>ACTIVE</dt> <dd> <p>A service deployment that still has running tasks, but are in the process of being replaced with a new <code>PRIMARY</code> deployment.</p> </dd> <dt>INACTIVE</dt> <dd> <p>A deployment that has been completely replaced.</p> </dd> </dl>"
2674 },
2675 "taskDefinition": {
2676 "shape": "String",
2677 "documentation": "<p>The most recent task definition that was specified for the tasks in the service to use.</p>"
2678 },
2679 "desiredCount": {
2680 "shape": "Integer",
2681 "documentation": "<p>The most recent desired count of tasks that was specified for the service to deploy or maintain.</p>"
2682 },
2683 "pendingCount": {
2684 "shape": "Integer",
2685 "documentation": "<p>The number of tasks in the deployment that are in the <code>PENDING</code> status.</p>"
2686 },
2687 "runningCount": {
2688 "shape": "Integer",
2689 "documentation": "<p>The number of tasks in the deployment that are in the <code>RUNNING</code> status.</p>"
2690 },
2691 "createdAt": {
2692 "shape": "Timestamp",
2693 "documentation": "<p>The Unix timestamp for when the service deployment was created.</p>"
2694 },
2695 "updatedAt": {
2696 "shape": "Timestamp",
2697 "documentation": "<p>The Unix timestamp for when the service deployment was last updated.</p>"
2698 },
2699 "capacityProviderStrategy": {
2700 "shape": "CapacityProviderStrategy",
2701 "documentation": "<p>The capacity provider strategy that the deployment is using.</p>"
2702 },
2703 "launchType": {
2704 "shape": "LaunchType",
2705 "documentation": "<p>The launch type the tasks in the service are using. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2706 },
2707 "platformVersion": {
2708 "shape": "String",
2709 "documentation": "<p>The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the <code>LATEST</code> platform version is used by default. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2710 },
2711 "networkConfiguration": {
2712 "shape": "NetworkConfiguration",
2713 "documentation": "<p>The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
2714 }
2715 },
2716 "documentation": "<p>The details of an Amazon ECS service deployment. This is used only when a service uses the <code>ECS</code> deployment controller type.</p>"
2717 },
2718 "DeploymentConfiguration": {
2719 "type": "structure",
2720 "members": {
2721 "maximumPercent": {
2722 "shape": "BoxedInteger",
2723 "documentation": "<p>If a service is using the rolling update (<code>ECS</code>) deployment type, the <b>maximum percent</b> parameter represents an upper limit on the number of tasks in a service that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.</p> <p>If a service is using the blue/green (<code>CODE_DEPLOY</code>) or <code>EXTERNAL</code> deployment types and tasks that use the EC2 launch type, the <b>maximum percent</b> value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the <code>RUNNING</code> state while the container instances are in the <code>DRAINING</code> state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.</p>"
2724 },
2725 "minimumHealthyPercent": {
2726 "shape": "BoxedInteger",
2727 "documentation": "<p>If a service is using the rolling update (<code>ECS</code>) deployment type, the <b>minimum healthy percent</b> represents a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.</p> <p>If a service is using the blue/green (<code>CODE_DEPLOY</code>) or <code>EXTERNAL</code> deployment types and tasks that use the EC2 launch type, the <b>minimum healthy percent</b> value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the <code>RUNNING</code> state while the container instances are in the <code>DRAINING</code> state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.</p>"
2728 }
2729 },
2730 "documentation": "<p>Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.</p>"
2731 },
2732 "DeploymentController": {
2733 "type": "structure",
2734 "required": [
2735 "type"
2736 ],
2737 "members": {
2738 "type": {
2739 "shape": "DeploymentControllerType",
2740 "documentation": "<p>The deployment controller type to use.</p> <p>There are three deployment controller types available:</p> <dl> <dt>ECS</dt> <dd> <p>The rolling update (<code>ECS</code>) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the <a>DeploymentConfiguration</a>.</p> </dd> <dt>CODE_DEPLOY</dt> <dd> <p>The blue/green (<code>CODE_DEPLOY</code>) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.</p> </dd> <dt>EXTERNAL</dt> <dd> <p>The external (<code>EXTERNAL</code>) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.</p> </dd> </dl>"
2741 }
2742 },
2743 "documentation": "<p>The deployment controller to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
2744 },
2745 "DeploymentControllerType": {
2746 "type": "string",
2747 "enum": [
2748 "ECS",
2749 "CODE_DEPLOY",
2750 "EXTERNAL"
2751 ]
2752 },
2753 "Deployments": {
2754 "type": "list",
2755 "member": {
2756 "shape": "Deployment"
2757 }
2758 },
2759 "DeregisterContainerInstanceRequest": {
2760 "type": "structure",
2761 "required": [
2762 "containerInstance"
2763 ],
2764 "members": {
2765 "cluster": {
2766 "shape": "String",
2767 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.</p>"
2768 },
2769 "containerInstance": {
2770 "shape": "String",
2771 "documentation": "<p>The container instance ID or full ARN of the container instance to deregister. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
2772 },
2773 "force": {
2774 "shape": "BoxedBoolean",
2775 "documentation": "<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. </p> <p>Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.</p>"
2776 }
2777 }
2778 },
2779 "DeregisterContainerInstanceResponse": {
2780 "type": "structure",
2781 "members": {
2782 "containerInstance": {
2783 "shape": "ContainerInstance",
2784 "documentation": "<p>The container instance that was deregistered.</p>"
2785 }
2786 }
2787 },
2788 "DeregisterTaskDefinitionRequest": {
2789 "type": "structure",
2790 "required": [
2791 "taskDefinition"
2792 ],
2793 "members": {
2794 "taskDefinition": {
2795 "shape": "String",
2796 "documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a <code>revision</code>.</p>"
2797 }
2798 }
2799 },
2800 "DeregisterTaskDefinitionResponse": {
2801 "type": "structure",
2802 "members": {
2803 "taskDefinition": {
2804 "shape": "TaskDefinition",
2805 "documentation": "<p>The full description of the deregistered task.</p>"
2806 }
2807 }
2808 },
2809 "DescribeCapacityProvidersRequest": {
2810 "type": "structure",
2811 "members": {
2812 "capacityProviders": {
2813 "shape": "StringList",
2814 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to <code>100</code> capacity providers can be described in an action.</p>"
2815 },
2816 "include": {
2817 "shape": "CapacityProviderFieldList",
2818 "documentation": "<p>Specifies whether or not you want to see the resource tags for the capacity provider. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
2819 },
2820 "maxResults": {
2821 "shape": "BoxedInteger",
2822 "documentation": "<p>The maximum number of account setting results returned by <code>DescribeCapacityProviders</code> in paginated output. When this parameter is used, <code>DescribeCapacityProviders</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeCapacityProviders</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter is not used, then <code>DescribeCapacityProviders</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p>"
2823 },
2824 "nextToken": {
2825 "shape": "String",
2826 "documentation": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeCapacityProviders</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>"
2827 }
2828 }
2829 },
2830 "DescribeCapacityProvidersResponse": {
2831 "type": "structure",
2832 "members": {
2833 "capacityProviders": {
2834 "shape": "CapacityProviders",
2835 "documentation": "<p>The list of capacity providers.</p>"
2836 },
2837 "failures": {
2838 "shape": "Failures",
2839 "documentation": "<p>Any failures associated with the call.</p>"
2840 },
2841 "nextToken": {
2842 "shape": "String",
2843 "documentation": "<p>The <code>nextToken</code> value to include in a future <code>DescribeCapacityProviders</code> request. When the results of a <code>DescribeCapacityProviders</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
2844 }
2845 }
2846 },
2847 "DescribeClustersRequest": {
2848 "type": "structure",
2849 "members": {
2850 "clusters": {
2851 "shape": "StringList",
2852 "documentation": "<p>A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.</p>"
2853 },
2854 "include": {
2855 "shape": "ClusterFieldList",
2856 "documentation": "<p>Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.</p> <p>If <code>ATTACHMENTS</code> is specified, the attachments for the container instances or tasks within the cluster are included.</p> <p>If <code>SETTINGS</code> is specified, the settings for the cluster are included.</p> <p>If <code>STATISTICS</code> is specified, the following additional information, separated by launch type, is included:</p> <ul> <li> <p>runningEC2TasksCount</p> </li> <li> <p>runningFargateTasksCount</p> </li> <li> <p>pendingEC2TasksCount</p> </li> <li> <p>pendingFargateTasksCount</p> </li> <li> <p>activeEC2ServiceCount</p> </li> <li> <p>activeFargateServiceCount</p> </li> <li> <p>drainingEC2ServiceCount</p> </li> <li> <p>drainingFargateServiceCount</p> </li> </ul> <p>If <code>TAGS</code> is specified, the metadata tags associated with the cluster are included.</p>"
2857 }
2858 }
2859 },
2860 "DescribeClustersResponse": {
2861 "type": "structure",
2862 "members": {
2863 "clusters": {
2864 "shape": "Clusters",
2865 "documentation": "<p>The list of clusters.</p>"
2866 },
2867 "failures": {
2868 "shape": "Failures",
2869 "documentation": "<p>Any failures associated with the call.</p>"
2870 }
2871 }
2872 },
2873 "DescribeContainerInstancesRequest": {
2874 "type": "structure",
2875 "required": [
2876 "containerInstances"
2877 ],
2878 "members": {
2879 "cluster": {
2880 "shape": "String",
2881 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.</p>"
2882 },
2883 "containerInstances": {
2884 "shape": "StringList",
2885 "documentation": "<p>A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.</p>"
2886 },
2887 "include": {
2888 "shape": "ContainerInstanceFieldList",
2889 "documentation": "<p>Specifies whether you want to see the resource tags for the container instance. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
2890 }
2891 }
2892 },
2893 "DescribeContainerInstancesResponse": {
2894 "type": "structure",
2895 "members": {
2896 "containerInstances": {
2897 "shape": "ContainerInstances",
2898 "documentation": "<p>The list of container instances.</p>"
2899 },
2900 "failures": {
2901 "shape": "Failures",
2902 "documentation": "<p>Any failures associated with the call.</p>"
2903 }
2904 }
2905 },
2906 "DescribeServicesRequest": {
2907 "type": "structure",
2908 "required": [
2909 "services"
2910 ],
2911 "members": {
2912 "cluster": {
2913 "shape": "String",
2914 "documentation": "<p>The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.</p>"
2915 },
2916 "services": {
2917 "shape": "StringList",
2918 "documentation": "<p>A list of services to describe. You may specify up to 10 services to describe in a single operation.</p>"
2919 },
2920 "include": {
2921 "shape": "ServiceFieldList",
2922 "documentation": "<p>Specifies whether you want to see the resource tags for the service. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
2923 }
2924 }
2925 },
2926 "DescribeServicesResponse": {
2927 "type": "structure",
2928 "members": {
2929 "services": {
2930 "shape": "Services",
2931 "documentation": "<p>The list of services described.</p>"
2932 },
2933 "failures": {
2934 "shape": "Failures",
2935 "documentation": "<p>Any failures associated with the call.</p>"
2936 }
2937 }
2938 },
2939 "DescribeTaskDefinitionRequest": {
2940 "type": "structure",
2941 "required": [
2942 "taskDefinition"
2943 ],
2944 "members": {
2945 "taskDefinition": {
2946 "shape": "String",
2947 "documentation": "<p>The <code>family</code> for the latest <code>ACTIVE</code> revision, <code>family</code> and <code>revision</code> (<code>family:revision</code>) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.</p>"
2948 },
2949 "include": {
2950 "shape": "TaskDefinitionFieldList",
2951 "documentation": "<p>Specifies whether to see the resource tags for the task definition. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
2952 }
2953 }
2954 },
2955 "DescribeTaskDefinitionResponse": {
2956 "type": "structure",
2957 "members": {
2958 "taskDefinition": {
2959 "shape": "TaskDefinition",
2960 "documentation": "<p>The full task definition description.</p>"
2961 },
2962 "tags": {
2963 "shape": "Tags",
2964 "documentation": "<p>The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
2965 }
2966 }
2967 },
2968 "DescribeTaskSetsRequest": {
2969 "type": "structure",
2970 "required": [
2971 "cluster",
2972 "service"
2973 ],
2974 "members": {
2975 "cluster": {
2976 "shape": "String",
2977 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.</p>"
2978 },
2979 "service": {
2980 "shape": "String",
2981 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.</p>"
2982 },
2983 "taskSets": {
2984 "shape": "StringList",
2985 "documentation": "<p>The ID or full Amazon Resource Name (ARN) of task sets to describe.</p>"
2986 },
2987 "include": {
2988 "shape": "TaskSetFieldList",
2989 "documentation": "<p>Specifies whether to see the resource tags for the task set. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
2990 }
2991 }
2992 },
2993 "DescribeTaskSetsResponse": {
2994 "type": "structure",
2995 "members": {
2996 "taskSets": {
2997 "shape": "TaskSets",
2998 "documentation": "<p>The list of task sets described.</p>"
2999 },
3000 "failures": {
3001 "shape": "Failures",
3002 "documentation": "<p>Any failures associated with the call.</p>"
3003 }
3004 }
3005 },
3006 "DescribeTasksRequest": {
3007 "type": "structure",
3008 "required": [
3009 "tasks"
3010 ],
3011 "members": {
3012 "cluster": {
3013 "shape": "String",
3014 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.</p>"
3015 },
3016 "tasks": {
3017 "shape": "StringList",
3018 "documentation": "<p>A list of up to 100 task IDs or full ARN entries.</p>"
3019 },
3020 "include": {
3021 "shape": "TaskFieldList",
3022 "documentation": "<p>Specifies whether you want to see the resource tags for the task. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
3023 }
3024 }
3025 },
3026 "DescribeTasksResponse": {
3027 "type": "structure",
3028 "members": {
3029 "tasks": {
3030 "shape": "Tasks",
3031 "documentation": "<p>The list of tasks.</p>"
3032 },
3033 "failures": {
3034 "shape": "Failures",
3035 "documentation": "<p>Any failures associated with the call.</p>"
3036 }
3037 }
3038 },
3039 "DesiredStatus": {
3040 "type": "string",
3041 "enum": [
3042 "RUNNING",
3043 "PENDING",
3044 "STOPPED"
3045 ]
3046 },
3047 "Device": {
3048 "type": "structure",
3049 "required": [
3050 "hostPath"
3051 ],
3052 "members": {
3053 "hostPath": {
3054 "shape": "String",
3055 "documentation": "<p>The path for the device on the host container instance.</p>"
3056 },
3057 "containerPath": {
3058 "shape": "String",
3059 "documentation": "<p>The path inside the container at which to expose the host device.</p>"
3060 },
3061 "permissions": {
3062 "shape": "DeviceCgroupPermissions",
3063 "documentation": "<p>The explicit permissions to provide to the container for the device. By default, the container has permissions for <code>read</code>, <code>write</code>, and <code>mknod</code> for the device.</p>"
3064 }
3065 },
3066 "documentation": "<p>An object representing a container instance host device.</p>"
3067 },
3068 "DeviceCgroupPermission": {
3069 "type": "string",
3070 "enum": [
3071 "read",
3072 "write",
3073 "mknod"
3074 ]
3075 },
3076 "DeviceCgroupPermissions": {
3077 "type": "list",
3078 "member": {
3079 "shape": "DeviceCgroupPermission"
3080 }
3081 },
3082 "DevicesList": {
3083 "type": "list",
3084 "member": {
3085 "shape": "Device"
3086 }
3087 },
3088 "DiscoverPollEndpointRequest": {
3089 "type": "structure",
3090 "members": {
3091 "containerInstance": {
3092 "shape": "String",
3093 "documentation": "<p>The container instance ID or full ARN of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
3094 },
3095 "cluster": {
3096 "shape": "String",
3097 "documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.</p>"
3098 }
3099 }
3100 },
3101 "DiscoverPollEndpointResponse": {
3102 "type": "structure",
3103 "members": {
3104 "endpoint": {
3105 "shape": "String",
3106 "documentation": "<p>The endpoint for the Amazon ECS agent to poll.</p>"
3107 },
3108 "telemetryEndpoint": {
3109 "shape": "String",
3110 "documentation": "<p>The telemetry endpoint for the Amazon ECS agent.</p>"
3111 }
3112 }
3113 },
3114 "DockerLabelsMap": {
3115 "type": "map",
3116 "key": {
3117 "shape": "String"
3118 },
3119 "value": {
3120 "shape": "String"
3121 }
3122 },
3123 "DockerVolumeConfiguration": {
3124 "type": "structure",
3125 "members": {
3126 "scope": {
3127 "shape": "Scope",
3128 "documentation": "<p>The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a <code>task</code> are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as <code>shared</code> persist after the task stops.</p>"
3129 },
3130 "autoprovision": {
3131 "shape": "BoxedBoolean",
3132 "documentation": "<p>If this value is <code>true</code>, the Docker volume is created if it does not already exist.</p> <note> <p>This field is only used if the <code>scope</code> is <code>shared</code>.</p> </note>"
3133 },
3134 "driver": {
3135 "shape": "String",
3136 "documentation": "<p>The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use <code>docker plugin ls</code> to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see <a href=\"https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery\">Docker plugin discovery</a>. This parameter maps to <code>Driver</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxdriver</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\">docker volume create</a>.</p>"
3137 },
3138 "driverOpts": {
3139 "shape": "StringMap",
3140 "documentation": "<p>A map of Docker driver-specific options passed through. This parameter maps to <code>DriverOpts</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxopt</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\">docker volume create</a>.</p>"
3141 },
3142 "labels": {
3143 "shape": "StringMap",
3144 "documentation": "<p>Custom metadata to add to your Docker volume. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxlabel</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\">docker volume create</a>.</p>"
3145 }
3146 },
3147 "documentation": "<p>This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the <code>local</code> driver. To use bind mounts, specify a <code>host</code> instead.</p>"
3148 },
3149 "Double": {
3150 "type": "double"
3151 },
3152 "EFSAuthorizationConfig": {
3153 "type": "structure",
3154 "members": {
3155 "accessPointId": {
3156 "shape": "String",
3157 "documentation": "<p>The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the <code>EFSVolumeConfiguration</code> will be relative to the directory set for the access point. If an access point is used, transit encryption must be enabled in the <code>EFSVolumeConfiguration</code>. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Working with Amazon EFS Access Points</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
3158 },
3159 "iam": {
3160 "shape": "EFSAuthorizationConfigIAM",
3161 "documentation": "<p>Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the <code>EFSVolumeConfiguration</code>. If this parameter is omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints\">Using Amazon EFS Access Points</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
3162 }
3163 },
3164 "documentation": "<p>The authorization configuration details for the Amazon EFS file system.</p>"
3165 },
3166 "EFSAuthorizationConfigIAM": {
3167 "type": "string",
3168 "enum": [
3169 "ENABLED",
3170 "DISABLED"
3171 ]
3172 },
3173 "EFSTransitEncryption": {
3174 "type": "string",
3175 "enum": [
3176 "ENABLED",
3177 "DISABLED"
3178 ]
3179 },
3180 "EFSVolumeConfiguration": {
3181 "type": "structure",
3182 "required": [
3183 "fileSystemId"
3184 ],
3185 "members": {
3186 "fileSystemId": {
3187 "shape": "String",
3188 "documentation": "<p>The Amazon EFS file system ID to use.</p>"
3189 },
3190 "rootDirectory": {
3191 "shape": "String",
3192 "documentation": "<p>The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying <code>/</code> will have the same effect as omitting this parameter.</p>"
3193 },
3194 "transitEncryption": {
3195 "shape": "EFSTransitEncryption",
3196 "documentation": "<p>Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html\">Encrypting Data in Transit</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
3197 },
3198 "transitEncryptionPort": {
3199 "shape": "BoxedInteger",
3200 "documentation": "<p>The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html\">EFS Mount Helper</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
3201 },
3202 "authorizationConfig": {
3203 "shape": "EFSAuthorizationConfig",
3204 "documentation": "<p>The authorization configuration details for the Amazon EFS file system.</p>"
3205 }
3206 },
3207 "documentation": "<p>This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html\">Amazon EFS Volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
3208 },
3209 "EnvironmentFile": {
3210 "type": "structure",
3211 "required": [
3212 "value",
3213 "type"
3214 ],
3215 "members": {
3216 "value": {
3217 "shape": "String",
3218 "documentation": "<p>The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.</p>"
3219 },
3220 "type": {
3221 "shape": "EnvironmentFileType",
3222 "documentation": "<p>The file type to use. The only supported value is <code>s3</code>.</p>"
3223 }
3224 },
3225 "documentation": "<p>A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a <code>.env</code> file extension. Each line in an environment file should contain an environment variable in <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated as comments and are ignored. For more information on the environment variable file syntax, see <a href=\"https://docs.docker.com/compose/env-file/\">Declare default environment variables in file</a>.</p> <p>If there are environment variables specified using the <code>environment</code> parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html\">Specifying Environment Variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This field is not valid for containers in tasks using the Fargate launch type.</p>"
3226 },
3227 "EnvironmentFileType": {
3228 "type": "string",
3229 "enum": [
3230 "s3"
3231 ]
3232 },
3233 "EnvironmentFiles": {
3234 "type": "list",
3235 "member": {
3236 "shape": "EnvironmentFile"
3237 }
3238 },
3239 "EnvironmentVariables": {
3240 "type": "list",
3241 "member": {
3242 "shape": "KeyValuePair"
3243 }
3244 },
3245 "Failure": {
3246 "type": "structure",
3247 "members": {
3248 "arn": {
3249 "shape": "String",
3250 "documentation": "<p>The Amazon Resource Name (ARN) of the failed resource.</p>"
3251 },
3252 "reason": {
3253 "shape": "String",
3254 "documentation": "<p>The reason for the failure.</p>"
3255 },
3256 "detail": {
3257 "shape": "String",
3258 "documentation": "<p>The details of the failure.</p>"
3259 }
3260 },
3261 "documentation": "<p>A failed resource.</p>"
3262 },
3263 "Failures": {
3264 "type": "list",
3265 "member": {
3266 "shape": "Failure"
3267 }
3268 },
3269 "FirelensConfiguration": {
3270 "type": "structure",
3271 "required": [
3272 "type"
3273 ],
3274 "members": {
3275 "type": {
3276 "shape": "FirelensConfigurationType",
3277 "documentation": "<p>The log router to use. The valid values are <code>fluentd</code> or <code>fluentbit</code>.</p>"
3278 },
3279 "options": {
3280 "shape": "FirelensConfigurationOptionsMap",
3281 "documentation": "<p>The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is <code>\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef\">Creating a Task Definition that Uses a FireLens Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
3282 }
3283 },
3284 "documentation": "<p>The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom Log Routing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
3285 },
3286 "FirelensConfigurationOptionsMap": {
3287 "type": "map",
3288 "key": {
3289 "shape": "String"
3290 },
3291 "value": {
3292 "shape": "String"
3293 }
3294 },
3295 "FirelensConfigurationType": {
3296 "type": "string",
3297 "enum": [
3298 "fluentd",
3299 "fluentbit"
3300 ]
3301 },
3302 "GpuIds": {
3303 "type": "list",
3304 "member": {
3305 "shape": "String"
3306 }
3307 },
3308 "HealthCheck": {