@aws-sdk/client-ecs 3.703.0 → 3.708.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +12 -11
  2. package/dist-types/ECS.d.ts +12 -11
  3. package/dist-types/ECSClient.d.ts +12 -11
  4. package/dist-types/commands/CreateCapacityProviderCommand.d.ts +22 -17
  5. package/dist-types/commands/CreateClusterCommand.d.ts +19 -17
  6. package/dist-types/commands/CreateServiceCommand.d.ts +80 -75
  7. package/dist-types/commands/CreateTaskSetCommand.d.ts +19 -15
  8. package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -9
  9. package/dist-types/commands/DeleteAttributesCommand.d.ts +4 -2
  10. package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +21 -17
  11. package/dist-types/commands/DeleteClusterCommand.d.ts +28 -23
  12. package/dist-types/commands/DeleteServiceCommand.d.ts +29 -23
  13. package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +28 -23
  14. package/dist-types/commands/DeleteTaskSetCommand.d.ts +17 -14
  15. package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +22 -19
  16. package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +26 -23
  17. package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +10 -8
  18. package/dist-types/commands/DescribeClustersCommand.d.ts +10 -8
  19. package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +12 -10
  20. package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +15 -10
  21. package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +14 -11
  22. package/dist-types/commands/DescribeServicesCommand.d.ts +10 -8
  23. package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +16 -13
  24. package/dist-types/commands/DescribeTaskSetsCommand.d.ts +17 -13
  25. package/dist-types/commands/DescribeTasksCommand.d.ts +13 -11
  26. package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +8 -7
  27. package/dist-types/commands/ExecuteCommandCommand.d.ts +23 -19
  28. package/dist-types/commands/GetTaskProtectionCommand.d.ts +10 -8
  29. package/dist-types/commands/ListAccountSettingsCommand.d.ts +10 -8
  30. package/dist-types/commands/ListAttributesCommand.d.ts +8 -6
  31. package/dist-types/commands/ListClustersCommand.d.ts +10 -8
  32. package/dist-types/commands/ListContainerInstancesCommand.d.ts +13 -12
  33. package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +14 -10
  34. package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +15 -12
  35. package/dist-types/commands/ListServicesCommand.d.ts +12 -10
  36. package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -8
  37. package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +17 -13
  38. package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -11
  39. package/dist-types/commands/ListTasksCommand.d.ts +15 -12
  40. package/dist-types/commands/PutAccountSettingCommand.d.ts +14 -11
  41. package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +12 -10
  42. package/dist-types/commands/PutAttributesCommand.d.ts +10 -7
  43. package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +29 -24
  44. package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +12 -10
  45. package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +24 -21
  46. package/dist-types/commands/RunTaskCommand.d.ts +37 -33
  47. package/dist-types/commands/StartTaskCommand.d.ts +16 -16
  48. package/dist-types/commands/StopTaskCommand.d.ts +22 -18
  49. package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +10 -8
  50. package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +8 -7
  51. package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +10 -8
  52. package/dist-types/commands/TagResourceCommand.d.ts +14 -11
  53. package/dist-types/commands/UntagResourceCommand.d.ts +10 -8
  54. package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +10 -8
  55. package/dist-types/commands/UpdateClusterCommand.d.ts +10 -8
  56. package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +10 -8
  57. package/dist-types/commands/UpdateContainerAgentCommand.d.ts +37 -33
  58. package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +48 -42
  59. package/dist-types/commands/UpdateServiceCommand.d.ts +101 -91
  60. package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +20 -15
  61. package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +25 -20
  62. package/dist-types/commands/UpdateTaskSetCommand.d.ts +19 -15
  63. package/dist-types/index.d.ts +12 -11
  64. package/dist-types/models/models_0.d.ts +3378 -2890
  65. package/dist-types/models/models_1.d.ts +165 -146
  66. package/package.json +1 -1
@@ -31,111 +31,117 @@ declare const UpdateServiceCommand_base: {
31
31
  * <note>
32
32
  * <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p>
33
33
  * </note>
34
- * <p>For services using the rolling update (<code>ECS</code>) you can update the desired count, deployment
35
- * configuration, network configuration, load balancers, service registries, enable ECS managed tags
36
- * option, propagate tags option, task placement constraints and strategies, and task definition. When you
37
- * update any of these parameters, Amazon ECS starts new tasks with the new configuration. </p>
38
- * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a
39
- * task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
40
- * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. You can update your volume configurations and trigger a new
41
- * deployment. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON
42
- * service. If you leave <code>volumeConfigurations</code>
43
- * <code>null</code>, it doesn't trigger a new deployment. For more infomation on volumes, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
44
- * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
45
- * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the desired
46
- * count, deployment configuration, health check grace period, task placement constraints and strategies,
47
- * enable ECS managed tags option, and propagate tags can be updated using this API. If the network
48
- * configuration, platform version, task definition, or load balancer need to be updated, create a new
49
- * CodeDeploy deployment. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the
50
- * <i>CodeDeploy API Reference</i>.</p>
51
- * <p>For services using an external deployment controller, you can update only the desired count, task
52
- * placement constraints and strategies, health check grace period, enable ECS managed tags option, and
53
- * propagate tags option, using this API. If the launch type, load balancer, network configuration,
54
- * platform version, or task definition need to be updated, create a new task set For more information,
55
- * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.</p>
56
- * <p>You can add to or subtract from the number of instantiations of a task definition in a service by
57
- * specifying the cluster that the service is running in and a new <code>desiredCount</code>
58
- * parameter.</p>
59
- * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a
60
- * task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
61
- * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
62
- * <p>If you have updated the container image of your application, you can create a new task definition
63
- * with that image and deploy it to your service. The service scheduler uses the minimum healthy percent
64
- * and maximum percent parameters (in the service's deployment configuration) to determine the deployment
65
- * strategy.</p>
34
+ * <p>For services using the rolling update (<code>ECS</code>) you can update the desired
35
+ * count, deployment configuration, network configuration, load balancers, service
36
+ * registries, enable ECS managed tags option, propagate tags option, task placement
37
+ * constraints and strategies, and task definition. When you update any of these
38
+ * parameters, Amazon ECS starts new tasks with the new configuration. </p>
39
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
40
+ * running a task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. You can update
41
+ * your volume configurations and trigger a new deployment.
42
+ * <code>volumeConfigurations</code> is only supported for REPLICA service and not
43
+ * DAEMON service. If you leave <code>volumeConfigurations</code>
44
+ * <code>null</code>, it doesn't trigger a new deployment. For more infomation on volumes,
45
+ * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
46
+ * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller,
47
+ * only the desired count, deployment configuration, health check grace period, task
48
+ * placement constraints and strategies, enable ECS managed tags option, and propagate tags
49
+ * can be updated using this API. If the network configuration, platform version, task
50
+ * definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more
51
+ * information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p>
52
+ * <p>For services using an external deployment controller, you can update only the desired
53
+ * count, task placement constraints and strategies, health check grace period, enable ECS
54
+ * managed tags option, and propagate tags option, using this API. If the launch type, load
55
+ * balancer, network configuration, platform version, or task definition need to be
56
+ * updated, create a new task set For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.</p>
57
+ * <p>You can add to or subtract from the number of instantiations of a task definition in a
58
+ * service by specifying the cluster that the service is running in and a new
59
+ * <code>desiredCount</code> parameter.</p>
60
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
61
+ * running a task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
62
+ * <p>If you have updated the container image of your application, you can create a new task
63
+ * definition with that image and deploy it to your service. The service scheduler uses the
64
+ * minimum healthy percent and maximum percent parameters (in the service's deployment
65
+ * configuration) to determine the deployment strategy.</p>
66
66
  * <note>
67
- * <p>If your updated Docker image uses the same tag as what is in the existing task definition for
68
- * your service (for example, <code>my_image:latest</code>), you don't need to create a new revision
69
- * of your task definition. You can update the service using the <code>forceNewDeployment</code>
70
- * option. The new tasks launched by the deployment pull the current image/tag combination from your
71
- * repository when they start.</p>
67
+ * <p>If your updated Docker image uses the same tag as what is in the existing task
68
+ * definition for your service (for example, <code>my_image:latest</code>), you don't
69
+ * need to create a new revision of your task definition. You can update the service
70
+ * using the <code>forceNewDeployment</code> option. The new tasks launched by the
71
+ * deployment pull the current image/tag combination from your repository when they
72
+ * start.</p>
72
73
  * </note>
73
- * <p>You can also update the deployment configuration of a service. When a deployment is triggered by
74
- * updating the task definition of a service, the service scheduler uses the deployment configuration
75
- * parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the
76
- * deployment strategy.</p>
74
+ * <p>You can also update the deployment configuration of a service. When a deployment is
75
+ * triggered by updating the task definition of a service, the service scheduler uses the
76
+ * deployment configuration parameters, <code>minimumHealthyPercent</code> and
77
+ * <code>maximumPercent</code>, to determine the deployment strategy.</p>
77
78
  * <ul>
78
79
  * <li>
79
80
  * <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
80
81
  * <code>desiredCount</code> temporarily during a deployment. For example, if
81
- * <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two
82
- * existing tasks before starting two new tasks. Tasks for services that don't use a load balancer
83
- * are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that
84
- * use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are
85
- * reported as healthy by the load balancer.</p>
82
+ * <code>desiredCount</code> is four tasks, a minimum of 50% allows the
83
+ * scheduler to stop two existing tasks before starting two new tasks. Tasks for
84
+ * services that don't use a load balancer are considered healthy if they're in the
85
+ * <code>RUNNING</code> state. Tasks for services that use a load balancer are
86
+ * considered healthy if they're in the <code>RUNNING</code> state and are reported
87
+ * as healthy by the load balancer.</p>
86
88
  * </li>
87
89
  * <li>
88
- * <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running
89
- * tasks during a deployment. You can use it to define the deployment batch size. For example, if
90
- * <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before
91
- * stopping the four older tasks (provided that the cluster resources required to do this are
92
- * available).</p>
90
+ * <p>The <code>maximumPercent</code> parameter represents an upper limit on the
91
+ * number of running tasks during a deployment. You can use it to define the
92
+ * deployment batch size. For example, if <code>desiredCount</code> is four tasks,
93
+ * a maximum of 200% starts four new tasks before stopping the four older tasks
94
+ * (provided that the cluster resources required to do this are available).</p>
93
95
  * </li>
94
96
  * </ul>
95
- * <p>When <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code>
96
- * is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second
97
- * timeout. After this, <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the
98
- * container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no
99
- * <code>SIGKILL</code> is sent.</p>
100
- * <p>When the service scheduler launches new tasks, it determines task placement in your cluster with the
101
- * following logic.</p>
97
+ * <p>When <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>
98
+ * stops a task during a deployment, the equivalent of <code>docker stop</code> is issued
99
+ * to the containers running in the task. This results in a <code>SIGTERM</code> and a
100
+ * 30-second timeout. After this, <code>SIGKILL</code> is sent and the containers are
101
+ * forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits
102
+ * within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p>
103
+ * <p>When the service scheduler launches new tasks, it determines task placement in your
104
+ * cluster with the following logic.</p>
102
105
  * <ul>
103
106
  * <li>
104
- * <p>Determine which of the container instances in your cluster can support your service's task
105
- * definition. For example, they have the required CPU, memory, ports, and container instance
106
- * attributes.</p>
107
+ * <p>Determine which of the container instances in your cluster can support your
108
+ * service's task definition. For example, they have the required CPU, memory,
109
+ * ports, and container instance attributes.</p>
107
110
  * </li>
108
111
  * <li>
109
- * <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this
110
- * manner even though you can choose a different placement strategy.</p>
112
+ * <p>By default, the service scheduler attempts to balance tasks across
113
+ * Availability Zones in this manner even though you can choose a different
114
+ * placement strategy.</p>
111
115
  * <ul>
112
116
  * <li>
113
- * <p>Sort the valid container instances by the fewest number of running tasks for this
114
- * service in the same Availability Zone as the instance. For example, if zone A has one
115
- * running service task and zones B and C each have zero, valid container instances in
116
- * either zone B or C are considered optimal for placement.</p>
117
+ * <p>Sort the valid container instances by the fewest number of running
118
+ * tasks for this service in the same Availability Zone as the instance.
119
+ * For example, if zone A has one running service task and zones B and C
120
+ * each have zero, valid container instances in either zone B or C are
121
+ * considered optimal for placement.</p>
117
122
  * </li>
118
123
  * <li>
119
- * <p>Place the new service task on a valid container instance in an optimal Availability
120
- * Zone (based on the previous steps), favoring container instances with the fewest number
121
- * of running tasks for this service.</p>
124
+ * <p>Place the new service task on a valid container instance in an optimal
125
+ * Availability Zone (based on the previous steps), favoring container
126
+ * instances with the fewest number of running tasks for this
127
+ * service.</p>
122
128
  * </li>
123
129
  * </ul>
124
130
  * </li>
125
131
  * </ul>
126
- * <p>When the service scheduler stops running tasks, it attempts to maintain balance across the
127
- * Availability Zones in your cluster using the following logic: </p>
132
+ * <p>When the service scheduler stops running tasks, it attempts to maintain balance across
133
+ * the Availability Zones in your cluster using the following logic: </p>
128
134
  * <ul>
129
135
  * <li>
130
- * <p>Sort the container instances by the largest number of running tasks for this service in the
131
- * same Availability Zone as the instance. For example, if zone A has one running service task and
132
- * zones B and C each have two, container instances in either zone B or C are considered optimal
133
- * for termination.</p>
136
+ * <p>Sort the container instances by the largest number of running tasks for this
137
+ * service in the same Availability Zone as the instance. For example, if zone A
138
+ * has one running service task and zones B and C each have two, container
139
+ * instances in either zone B or C are considered optimal for termination.</p>
134
140
  * </li>
135
141
  * <li>
136
- * <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous
137
- * steps), favoring container instances with the largest number of running tasks for this
138
- * service.</p>
142
+ * <p>Stop the task on a container instance in an optimal Availability Zone (based
143
+ * on the previous steps), favoring container instances with the largest number of
144
+ * running tasks for this service.</p>
139
145
  * </li>
140
146
  * </ul>
141
147
  * <note>
@@ -152,7 +158,8 @@ declare const UpdateServiceCommand_base: {
152
158
  * </p>
153
159
  * </li>
154
160
  * </ul>
155
- * <p>For more information about the role see the <code>CreateService</code> request parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
161
+ * <p>For more information about the role see the <code>CreateService</code> request
162
+ * parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
156
163
  * <code>role</code>
157
164
  * </a>. </p>
158
165
  * </note>
@@ -607,16 +614,17 @@ declare const UpdateServiceCommand_base: {
607
614
  * <p>You don't have authorization to perform the requested action.</p>
608
615
  *
609
616
  * @throws {@link ClientException} (client fault)
610
- * <p>These errors are usually caused by a client action. This client action might be using an action or
611
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
612
- * be specifying an identifier that isn't valid.</p>
617
+ * <p>These errors are usually caused by a client action. This client action might be using
618
+ * an action or resource on behalf of a user that doesn't have permissions to use the
619
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
613
620
  * <p>The following list includes additional causes for the error:</p>
614
621
  * <ul>
615
622
  * <li>
616
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
617
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
618
- * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
619
- * quotas</a>.</p>
623
+ * <p>The <code>RunTask</code> could not be processed because you use managed
624
+ * scaling and there is a capacity error because the quota of tasks in the
625
+ * <code>PROVISIONING</code> per cluster has been reached. For information
626
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
627
+ * service quotas</a>.</p>
620
628
  * </li>
621
629
  * </ul>
622
630
  *
@@ -624,7 +632,8 @@ declare const UpdateServiceCommand_base: {
624
632
  * <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
625
633
  *
626
634
  * @throws {@link InvalidParameterException} (client fault)
627
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
635
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
636
+ * request.</p>
628
637
  *
629
638
  * @throws {@link NamespaceNotFoundException} (client fault)
630
639
  * <p>The specified namespace wasn't found.</p>
@@ -640,11 +649,12 @@ declare const UpdateServiceCommand_base: {
640
649
  * <p>These errors are usually caused by a server issue.</p>
641
650
  *
642
651
  * @throws {@link ServiceNotActiveException} (client fault)
643
- * <p>The specified service isn't active. You can't update a service that's inactive. If you have
644
- * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
652
+ * <p>The specified service isn't active. You can't update a service that's inactive. If you
653
+ * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
645
654
  *
646
655
  * @throws {@link ServiceNotFoundException} (client fault)
647
- * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p>
656
+ * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
657
+ * specific.</p>
648
658
  *
649
659
  * @throws {@link UnsupportedFeatureException} (client fault)
650
660
  * <p>The specified task isn't supported in this Region.</p>
@@ -27,9 +27,10 @@ declare const UpdateServicePrimaryTaskSetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Modifies which task set in a service is the primary task set. Any parameters that are updated on the
31
- * primary task set in a service will transition to the service. This is used when a service uses the
32
- * <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
30
+ * <p>Modifies which task set in a service is the primary task set. Any parameters that are
31
+ * updated on the primary task set in a service will transition to the service. This is
32
+ * used when a service uses the <code>EXTERNAL</code> deployment controller type. For more
33
+ * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment
33
34
  * Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
34
35
  * @example
35
36
  * Use a bare-bones client and the command you need to make an API call.
@@ -126,16 +127,17 @@ declare const UpdateServicePrimaryTaskSetCommand_base: {
126
127
  * <p>You don't have authorization to perform the requested action.</p>
127
128
  *
128
129
  * @throws {@link ClientException} (client fault)
129
- * <p>These errors are usually caused by a client action. This client action might be using an action or
130
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
131
- * be specifying an identifier that isn't valid.</p>
130
+ * <p>These errors are usually caused by a client action. This client action might be using
131
+ * an action or resource on behalf of a user that doesn't have permissions to use the
132
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
132
133
  * <p>The following list includes additional causes for the error:</p>
133
134
  * <ul>
134
135
  * <li>
135
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
136
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
137
- * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
138
- * quotas</a>.</p>
136
+ * <p>The <code>RunTask</code> could not be processed because you use managed
137
+ * scaling and there is a capacity error because the quota of tasks in the
138
+ * <code>PROVISIONING</code> per cluster has been reached. For information
139
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
140
+ * service quotas</a>.</p>
139
141
  * </li>
140
142
  * </ul>
141
143
  *
@@ -143,20 +145,23 @@ declare const UpdateServicePrimaryTaskSetCommand_base: {
143
145
  * <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
144
146
  *
145
147
  * @throws {@link InvalidParameterException} (client fault)
146
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
148
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
149
+ * request.</p>
147
150
  *
148
151
  * @throws {@link ServerException} (server fault)
149
152
  * <p>These errors are usually caused by a server issue.</p>
150
153
  *
151
154
  * @throws {@link ServiceNotActiveException} (client fault)
152
- * <p>The specified service isn't active. You can't update a service that's inactive. If you have
153
- * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
155
+ * <p>The specified service isn't active. You can't update a service that's inactive. If you
156
+ * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
154
157
  *
155
158
  * @throws {@link ServiceNotFoundException} (client fault)
156
- * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p>
159
+ * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
160
+ * specific.</p>
157
161
  *
158
162
  * @throws {@link TaskSetNotFoundException} (client fault)
159
- * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p>
163
+ * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and
164
+ * Region.</p>
160
165
  *
161
166
  * @throws {@link UnsupportedFeatureException} (client fault)
162
167
  * <p>The specified task isn't supported in this Region.</p>
@@ -28,28 +28,31 @@ declare const UpdateTaskProtectionCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Updates the protection status of a task. You can set <code>protectionEnabled</code> to
31
- * <code>true</code> to protect your task from termination during scale-in events from <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service
31
+ * <code>true</code> to protect your task from termination during scale-in events from
32
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service
32
33
  * Autoscaling</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">deployments</a>.</p>
33
34
  * <p>Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the
34
- * <code>protectionEnabled</code> property making the task eligible for termination by a subsequent
35
- * scale-in event.</p>
36
- * <p>You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes
37
- * (48 hours). To specify the custom expiration period, set the <code>expiresInMinutes</code> property.
38
- * The <code>expiresInMinutes</code> property is always reset when you invoke this operation for a task
39
- * that already has <code>protectionEnabled</code> set to <code>true</code>. You can keep extending the
35
+ * <code>protectionEnabled</code> property making the task eligible for termination by
36
+ * a subsequent scale-in event.</p>
37
+ * <p>You can specify a custom expiration period for task protection from 1 minute to up to
38
+ * 2,880 minutes (48 hours). To specify the custom expiration period, set the
39
+ * <code>expiresInMinutes</code> property. The <code>expiresInMinutes</code> property
40
+ * is always reset when you invoke this operation for a task that already has
41
+ * <code>protectionEnabled</code> set to <code>true</code>. You can keep extending the
40
42
  * protection expiration period of a task by invoking this operation repeatedly.</p>
41
43
  * <p>To learn more about Amazon ECS task protection, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html">Task scale-in
42
44
  * protection</a> in the <i>
43
45
  * <i>Amazon Elastic Container Service Developer Guide</i>
44
46
  * </i>.</p>
45
47
  * <note>
46
- * <p>This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation
47
- * for a standalone task will result in an <code>TASK_NOT_VALID</code> failure. For more information,
48
- * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html">API failure reasons</a>.</p>
48
+ * <p>This operation is only supported for tasks belonging to an Amazon ECS service. Invoking
49
+ * this operation for a standalone task will result in an <code>TASK_NOT_VALID</code>
50
+ * failure. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html">API failure
51
+ * reasons</a>.</p>
49
52
  * </note>
50
53
  * <important>
51
- * <p>If you prefer to set task protection from within the container, we recommend using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html">Task scale-in
52
- * protection endpoint</a>.</p>
54
+ * <p>If you prefer to set task protection from within the container, we recommend using
55
+ * the <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html">Task scale-in protection endpoint</a>.</p>
53
56
  * </important>
54
57
  * @example
55
58
  * Use a bare-bones client and the command you need to make an API call.
@@ -96,16 +99,17 @@ declare const UpdateTaskProtectionCommand_base: {
96
99
  * <p>You don't have authorization to perform the requested action.</p>
97
100
  *
98
101
  * @throws {@link ClientException} (client fault)
99
- * <p>These errors are usually caused by a client action. This client action might be using an action or
100
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
101
- * be specifying an identifier that isn't valid.</p>
102
+ * <p>These errors are usually caused by a client action. This client action might be using
103
+ * an action or resource on behalf of a user that doesn't have permissions to use the
104
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
102
105
  * <p>The following list includes additional causes for the error:</p>
103
106
  * <ul>
104
107
  * <li>
105
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
106
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
107
- * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
108
- * quotas</a>.</p>
108
+ * <p>The <code>RunTask</code> could not be processed because you use managed
109
+ * scaling and there is a capacity error because the quota of tasks in the
110
+ * <code>PROVISIONING</code> per cluster has been reached. For information
111
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
112
+ * service quotas</a>.</p>
109
113
  * </li>
110
114
  * </ul>
111
115
  *
@@ -113,7 +117,8 @@ declare const UpdateTaskProtectionCommand_base: {
113
117
  * <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
114
118
  *
115
119
  * @throws {@link InvalidParameterException} (client fault)
116
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
120
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
121
+ * request.</p>
117
122
  *
118
123
  * @throws {@link ResourceNotFoundException} (client fault)
119
124
  * <p>The specified resource wasn't found.</p>
@@ -27,9 +27,9 @@ declare const UpdateTaskSetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code> deployment controller
31
- * 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
32
- * <i>Amazon Elastic Container Service Developer Guide</i>.</p>
30
+ * <p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code>
31
+ * deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment
32
+ * Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
@@ -129,16 +129,17 @@ declare const UpdateTaskSetCommand_base: {
129
129
  * <p>You don't have authorization to perform the requested action.</p>
130
130
  *
131
131
  * @throws {@link ClientException} (client fault)
132
- * <p>These errors are usually caused by a client action. This client action might be using an action or
133
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
134
- * be specifying an identifier that isn't valid.</p>
132
+ * <p>These errors are usually caused by a client action. This client action might be using
133
+ * an action or resource on behalf of a user that doesn't have permissions to use the
134
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
135
135
  * <p>The following list includes additional causes for the error:</p>
136
136
  * <ul>
137
137
  * <li>
138
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
139
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
140
- * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
141
- * quotas</a>.</p>
138
+ * <p>The <code>RunTask</code> could not be processed because you use managed
139
+ * scaling and there is a capacity error because the quota of tasks in the
140
+ * <code>PROVISIONING</code> per cluster has been reached. For information
141
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
142
+ * service quotas</a>.</p>
142
143
  * </li>
143
144
  * </ul>
144
145
  *
@@ -146,20 +147,23 @@ declare const UpdateTaskSetCommand_base: {
146
147
  * <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
147
148
  *
148
149
  * @throws {@link InvalidParameterException} (client fault)
149
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
150
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
151
+ * request.</p>
150
152
  *
151
153
  * @throws {@link ServerException} (server fault)
152
154
  * <p>These errors are usually caused by a server issue.</p>
153
155
  *
154
156
  * @throws {@link ServiceNotActiveException} (client fault)
155
- * <p>The specified service isn't active. You can't update a service that's inactive. If you have
156
- * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
157
+ * <p>The specified service isn't active. You can't update a service that's inactive. If you
158
+ * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
157
159
  *
158
160
  * @throws {@link ServiceNotFoundException} (client fault)
159
- * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p>
161
+ * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
162
+ * specific.</p>
160
163
  *
161
164
  * @throws {@link TaskSetNotFoundException} (client fault)
162
- * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p>
165
+ * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and
166
+ * Region.</p>
163
167
  *
164
168
  * @throws {@link UnsupportedFeatureException} (client fault)
165
169
  * <p>The specified task isn't supported in this Region.</p>
@@ -1,16 +1,17 @@
1
1
  /**
2
2
  * <fullname>Amazon Elastic Container Service</fullname>
3
- * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
4
- * stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
5
- * managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
6
- * tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
7
- * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
8
- * it easy to get the state of your cluster from a centralized service, and gives you access to many
9
- * familiar Amazon EC2 features.</p>
10
- * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
11
- * needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
12
- * own cluster management and configuration management systems. You also don't need to worry about scaling
13
- * your management infrastructure. </p>
3
+ * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
4
+ * it easy to run, stop, and manage Docker containers. You can host your cluster on a
5
+ * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
6
+ * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
7
+ * or External (on-premises) instances that you manage.</p>
8
+ * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
9
+ * calls. This makes it easy to get the state of your cluster from a centralized service,
10
+ * and gives you access to many familiar Amazon EC2 features.</p>
11
+ * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
12
+ * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
13
+ * don't need to operate your own cluster management and configuration management systems.
14
+ * You also don't need to worry about scaling your management infrastructure. </p>
14
15
  *
15
16
  * @packageDocumentation
16
17
  */