@aws-sdk/client-ecs 3.693.0 → 3.696.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 (72) hide show
  1. package/README.md +11 -12
  2. package/dist-cjs/index.js +10 -2
  3. package/dist-es/models/models_0.js +4 -0
  4. package/dist-es/protocols/Aws_json1_1.js +2 -0
  5. package/dist-types/ECS.d.ts +11 -12
  6. package/dist-types/ECSClient.d.ts +11 -12
  7. package/dist-types/commands/CreateCapacityProviderCommand.d.ts +17 -22
  8. package/dist-types/commands/CreateClusterCommand.d.ts +17 -19
  9. package/dist-types/commands/CreateServiceCommand.d.ts +89 -80
  10. package/dist-types/commands/CreateTaskSetCommand.d.ts +15 -19
  11. package/dist-types/commands/DeleteAccountSettingCommand.d.ts +9 -12
  12. package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -4
  13. package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +17 -21
  14. package/dist-types/commands/DeleteClusterCommand.d.ts +23 -27
  15. package/dist-types/commands/DeleteServiceCommand.d.ts +30 -29
  16. package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +24 -28
  17. package/dist-types/commands/DeleteTaskSetCommand.d.ts +14 -17
  18. package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +19 -22
  19. package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +24 -26
  20. package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +8 -10
  21. package/dist-types/commands/DescribeClustersCommand.d.ts +8 -10
  22. package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +10 -12
  23. package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +9 -12
  24. package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +16 -12
  25. package/dist-types/commands/DescribeServicesCommand.d.ts +15 -10
  26. package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +14 -16
  27. package/dist-types/commands/DescribeTaskSetsCommand.d.ts +13 -17
  28. package/dist-types/commands/DescribeTasksCommand.d.ts +11 -13
  29. package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +7 -8
  30. package/dist-types/commands/ExecuteCommandCommand.d.ts +19 -23
  31. package/dist-types/commands/GetTaskProtectionCommand.d.ts +8 -10
  32. package/dist-types/commands/ListAccountSettingsCommand.d.ts +8 -10
  33. package/dist-types/commands/ListAttributesCommand.d.ts +6 -8
  34. package/dist-types/commands/ListClustersCommand.d.ts +8 -10
  35. package/dist-types/commands/ListContainerInstancesCommand.d.ts +12 -13
  36. package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +9 -12
  37. package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +12 -15
  38. package/dist-types/commands/ListServicesCommand.d.ts +10 -12
  39. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -10
  40. package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -17
  41. package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +11 -13
  42. package/dist-types/commands/ListTasksCommand.d.ts +12 -15
  43. package/dist-types/commands/PutAccountSettingCommand.d.ts +11 -14
  44. package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +10 -12
  45. package/dist-types/commands/PutAttributesCommand.d.ts +7 -11
  46. package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +24 -29
  47. package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +10 -12
  48. package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +23 -23
  49. package/dist-types/commands/RunTaskCommand.d.ts +33 -37
  50. package/dist-types/commands/StartTaskCommand.d.ts +16 -16
  51. package/dist-types/commands/StopTaskCommand.d.ts +18 -22
  52. package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +8 -10
  53. package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +7 -8
  54. package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +8 -10
  55. package/dist-types/commands/TagResourceCommand.d.ts +11 -14
  56. package/dist-types/commands/UntagResourceCommand.d.ts +8 -10
  57. package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +9 -11
  58. package/dist-types/commands/UpdateClusterCommand.d.ts +8 -10
  59. package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +8 -10
  60. package/dist-types/commands/UpdateContainerAgentCommand.d.ts +33 -37
  61. package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +42 -48
  62. package/dist-types/commands/UpdateServiceCommand.d.ts +105 -101
  63. package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +15 -20
  64. package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +20 -25
  65. package/dist-types/commands/UpdateTaskSetCommand.d.ts +15 -19
  66. package/dist-types/index.d.ts +11 -12
  67. package/dist-types/models/models_0.d.ts +2882 -3340
  68. package/dist-types/models/models_1.d.ts +166 -152
  69. package/dist-types/ts3.4/commands/UpdateCapacityProviderCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/models/models_0.d.ts +15 -7
  71. package/dist-types/ts3.4/models/models_1.d.ts +11 -0
  72. package/package.json +36 -36
@@ -28,54 +28,50 @@ declare const UpdateContainerInstancesStateCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Modifies the status of an Amazon ECS container instance.</p>
31
- * <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the
32
- * status of a container instance to <code>DRAINING</code> to manually remove an instance
33
- * from a cluster, for example to perform system updates, update the Docker daemon, or
34
- * scale down the cluster size.</p>
31
+ * <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a
32
+ * container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example
33
+ * to perform system updates, update the Docker daemon, or scale down the cluster size.</p>
35
34
  * <important>
36
- * <p>A container instance can't be changed to <code>DRAINING</code> until it has
37
- * reached an <code>ACTIVE</code> status. If the instance is in any other status, an
38
- * error will be received.</p>
35
+ * <p>A container instance can't be changed to <code>DRAINING</code> until it has reached an
36
+ * <code>ACTIVE</code> status. If the instance is in any other status, an error will be
37
+ * received.</p>
39
38
  * </important>
40
- * <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks
41
- * from being scheduled for placement on the container instance and replacement service
42
- * tasks are started on other container instances in the cluster if the resources are
43
- * available. Service tasks on the container instance that are in the <code>PENDING</code>
44
- * state are stopped immediately.</p>
45
- * <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are
46
- * stopped and replaced according to the service's deployment configuration parameters,
47
- * <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change
48
- * the deployment configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
39
+ * <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being
40
+ * scheduled for placement on the container instance and replacement service tasks are started on other
41
+ * container instances in the cluster if the resources are available. Service tasks on the container
42
+ * instance that are in the <code>PENDING</code> state are stopped immediately.</p>
43
+ * <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and
44
+ * replaced according to the service's deployment configuration parameters,
45
+ * <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment
46
+ * configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
49
47
  * <ul>
50
48
  * <li>
51
49
  * <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
52
50
  * <code>desiredCount</code> temporarily during task replacement. For example,
53
- * <code>desiredCount</code> is four tasks, a minimum of 50% allows the
54
- * scheduler to stop two existing tasks before starting two new tasks. If the
55
- * minimum is 100%, the service scheduler can't remove existing tasks until the
56
- * replacement tasks are considered healthy. Tasks for services that do not use a
57
- * load balancer are considered healthy if they're in the <code>RUNNING</code>
58
- * state. Tasks for services that use a load balancer are considered healthy if
59
- * they're in the <code>RUNNING</code> state and are reported as healthy by the
60
- * load balancer.</p>
51
+ * <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two
52
+ * existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler
53
+ * can't remove existing tasks until the replacement tasks are considered healthy. Tasks for
54
+ * services that do not use a load balancer are considered healthy if they're in the
55
+ * <code>RUNNING</code> state. Tasks for services that use a load balancer are considered
56
+ * healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load
57
+ * balancer.</p>
61
58
  * </li>
62
59
  * <li>
63
- * <p>The <code>maximumPercent</code> parameter represents an upper limit on the
64
- * number of running tasks during task replacement. You can use this to define the
65
- * replacement batch size. For example, if <code>desiredCount</code> is four tasks,
66
- * a maximum of 200% starts four new tasks before stopping the four tasks to be
67
- * drained, provided that the cluster resources required to do this are available.
68
- * If the maximum is 100%, then replacement tasks can't start until the draining
69
- * tasks have stopped.</p>
60
+ * <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running
61
+ * tasks during task replacement. You can use this to define the replacement batch size. For
62
+ * example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks
63
+ * before stopping the four tasks to be drained, provided that the cluster resources required to
64
+ * do this are available. If the maximum is 100%, then replacement tasks can't start until the
65
+ * draining tasks have stopped.</p>
70
66
  * </li>
71
67
  * </ul>
72
- * <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service
73
- * aren't affected. You must wait for them to finish or stop them manually.</p>
74
- * <p>A container instance has completed draining when it has no more <code>RUNNING</code>
75
- * tasks. You can verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p>
76
- * <p>When a container instance has been drained, you can set a container instance to
77
- * <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler
78
- * can begin scheduling tasks on the instance again.</p>
68
+ * <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service aren't
69
+ * affected. You must wait for them to finish or stop them manually.</p>
70
+ * <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can
71
+ * verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p>
72
+ * <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code>
73
+ * status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the
74
+ * instance again.</p>
79
75
  * @example
80
76
  * Use a bare-bones client and the command you need to make an API call.
81
77
  * ```javascript
@@ -192,17 +188,16 @@ declare const UpdateContainerInstancesStateCommand_base: {
192
188
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
193
189
  *
194
190
  * @throws {@link ClientException} (client fault)
195
- * <p>These errors are usually caused by a client action. This client action might be using
196
- * an action or resource on behalf of a user that doesn't have permissions to use the
197
- * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
191
+ * <p>These errors are usually caused by a client action. This client action might be using an action or
192
+ * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
193
+ * be specifying an identifier that isn't valid.</p>
198
194
  * <p>The following list includes additional causes for the error:</p>
199
195
  * <ul>
200
196
  * <li>
201
- * <p>The <code>RunTask</code> could not be processed because you use managed
202
- * scaling and there is a capacity error because the quota of tasks in the
203
- * <code>PROVISIONING</code> per cluster has been reached. For information
204
- * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
205
- * service quotas</a>.</p>
197
+ * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
198
+ * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
199
+ * 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
200
+ * quotas</a>.</p>
206
201
  * </li>
207
202
  * </ul>
208
203
  *
@@ -210,8 +205,7 @@ declare const UpdateContainerInstancesStateCommand_base: {
210
205
  * <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>
211
206
  *
212
207
  * @throws {@link InvalidParameterException} (client fault)
213
- * <p>The specified parameter isn't valid. Review the available parameters for the API
214
- * request.</p>
208
+ * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
215
209
  *
216
210
  * @throws {@link ServerException} (server fault)
217
211
  * <p>These errors are usually caused by a server issue.</p>
@@ -31,117 +31,111 @@ 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
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>
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>
66
66
  * <note>
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>
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>
73
72
  * </note>
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>
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>
78
77
  * <ul>
79
78
  * <li>
80
79
  * <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
81
80
  * <code>desiredCount</code> temporarily during a deployment. For example, if
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>
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>
88
86
  * </li>
89
87
  * <li>
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>
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>
95
93
  * </li>
96
94
  * </ul>
97
- * <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
98
- * of <code>docker stop</code> is issued to the containers running in the task. This
99
- * results in a <code>SIGTERM</code> and a 30-second timeout. After this,
100
- * <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the
101
- * container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from
102
- * 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>
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>
105
102
  * <ul>
106
103
  * <li>
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>
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>
110
107
  * </li>
111
108
  * <li>
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>
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>
115
111
  * <ul>
116
112
  * <li>
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>
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>
122
117
  * </li>
123
118
  * <li>
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>
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>
128
122
  * </li>
129
123
  * </ul>
130
124
  * </li>
131
125
  * </ul>
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>
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>
134
128
  * <ul>
135
129
  * <li>
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>
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>
140
134
  * </li>
141
135
  * <li>
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>
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>
145
139
  * </li>
146
140
  * </ul>
147
141
  * <note>
@@ -158,8 +152,7 @@ declare const UpdateServiceCommand_base: {
158
152
  * </p>
159
153
  * </li>
160
154
  * </ul>
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">
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">
163
156
  * <code>role</code>
164
157
  * </a>. </p>
165
158
  * </note>
@@ -309,6 +302,13 @@ declare const UpdateServiceCommand_base: {
309
302
  * },
310
303
  * },
311
304
  * ],
305
+ * vpcLatticeConfigurations: [ // VpcLatticeConfigurations
306
+ * { // VpcLatticeConfiguration
307
+ * roleArn: "STRING_VALUE", // required
308
+ * targetGroupArn: "STRING_VALUE", // required
309
+ * portName: "STRING_VALUE", // required
310
+ * },
311
+ * ],
312
312
  * };
313
313
  * const command = new UpdateServiceCommand(input);
314
314
  * const response = await client.send(command);
@@ -543,6 +543,13 @@ declare const UpdateServiceCommand_base: {
543
543
  * // fargateEphemeralStorage: {
544
544
  * // kmsKeyId: "STRING_VALUE",
545
545
  * // },
546
+ * // vpcLatticeConfigurations: [ // VpcLatticeConfigurations
547
+ * // { // VpcLatticeConfiguration
548
+ * // roleArn: "STRING_VALUE", // required
549
+ * // targetGroupArn: "STRING_VALUE", // required
550
+ * // portName: "STRING_VALUE", // required
551
+ * // },
552
+ * // ],
546
553
  * // },
547
554
  * // ],
548
555
  * // roleArn: "STRING_VALUE",
@@ -598,17 +605,16 @@ declare const UpdateServiceCommand_base: {
598
605
  * <p>You don't have authorization to perform the requested action.</p>
599
606
  *
600
607
  * @throws {@link ClientException} (client fault)
601
- * <p>These errors are usually caused by a client action. This client action might be using
602
- * an action or resource on behalf of a user that doesn't have permissions to use the
603
- * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
608
+ * <p>These errors are usually caused by a client action. This client action might be using an action or
609
+ * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
610
+ * be specifying an identifier that isn't valid.</p>
604
611
  * <p>The following list includes additional causes for the error:</p>
605
612
  * <ul>
606
613
  * <li>
607
- * <p>The <code>RunTask</code> could not be processed because you use managed
608
- * scaling and there is a capacity error because the quota of tasks in the
609
- * <code>PROVISIONING</code> per cluster has been reached. For information
610
- * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
611
- * service quotas</a>.</p>
614
+ * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
615
+ * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
616
+ * 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
617
+ * quotas</a>.</p>
612
618
  * </li>
613
619
  * </ul>
614
620
  *
@@ -616,8 +622,7 @@ declare const UpdateServiceCommand_base: {
616
622
  * <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>
617
623
  *
618
624
  * @throws {@link InvalidParameterException} (client fault)
619
- * <p>The specified parameter isn't valid. Review the available parameters for the API
620
- * request.</p>
625
+ * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
621
626
  *
622
627
  * @throws {@link NamespaceNotFoundException} (client fault)
623
628
  * <p>The specified namespace wasn't found.</p>
@@ -633,12 +638,11 @@ declare const UpdateServiceCommand_base: {
633
638
  * <p>These errors are usually caused by a server issue.</p>
634
639
  *
635
640
  * @throws {@link ServiceNotActiveException} (client fault)
636
- * <p>The specified service isn't active. You can't update a service that's inactive. If you
637
- * 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>
641
+ * <p>The specified service isn't active. You can't update a service that's inactive. If you have
642
+ * 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>
638
643
  *
639
644
  * @throws {@link ServiceNotFoundException} (client fault)
640
- * <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
641
- * specific.</p>
645
+ * <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>
642
646
  *
643
647
  * @throws {@link UnsupportedFeatureException} (client fault)
644
648
  * <p>The specified task isn't supported in this Region.</p>
@@ -27,10 +27,9 @@ 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
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
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
34
33
  * Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
35
34
  * @example
36
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -127,17 +126,16 @@ declare const UpdateServicePrimaryTaskSetCommand_base: {
127
126
  * <p>You don't have authorization to perform the requested action.</p>
128
127
  *
129
128
  * @throws {@link ClientException} (client fault)
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>
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>
133
132
  * <p>The following list includes additional causes for the error:</p>
134
133
  * <ul>
135
134
  * <li>
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>
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>
141
139
  * </li>
142
140
  * </ul>
143
141
  *
@@ -145,23 +143,20 @@ declare const UpdateServicePrimaryTaskSetCommand_base: {
145
143
  * <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>
146
144
  *
147
145
  * @throws {@link InvalidParameterException} (client fault)
148
- * <p>The specified parameter isn't valid. Review the available parameters for the API
149
- * request.</p>
146
+ * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
150
147
  *
151
148
  * @throws {@link ServerException} (server fault)
152
149
  * <p>These errors are usually caused by a server issue.</p>
153
150
  *
154
151
  * @throws {@link ServiceNotActiveException} (client fault)
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>
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>
157
154
  *
158
155
  * @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
160
- * specific.</p>
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>
161
157
  *
162
158
  * @throws {@link TaskSetNotFoundException} (client fault)
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>
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>
165
160
  *
166
161
  * @throws {@link UnsupportedFeatureException} (client fault)
167
162
  * <p>The specified task isn't supported in this Region.</p>
@@ -28,31 +28,28 @@ 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
32
- * <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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service
33
32
  * Autoscaling</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">deployments</a>.</p>
34
33
  * <p>Task-protection, by default, expires after 2 hours at which point Amazon ECS clears 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
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
42
40
  * protection expiration period of a task by invoking this operation repeatedly.</p>
43
41
  * <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
44
42
  * protection</a> in the <i>
45
43
  * <i>Amazon Elastic Container Service Developer Guide</i>
46
44
  * </i>.</p>
47
45
  * <note>
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>
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>
52
49
  * </note>
53
50
  * <important>
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>
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>
56
53
  * </important>
57
54
  * @example
58
55
  * Use a bare-bones client and the command you need to make an API call.
@@ -99,17 +96,16 @@ declare const UpdateTaskProtectionCommand_base: {
99
96
  * <p>You don't have authorization to perform the requested action.</p>
100
97
  *
101
98
  * @throws {@link ClientException} (client fault)
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>
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>
105
102
  * <p>The following list includes additional causes for the error:</p>
106
103
  * <ul>
107
104
  * <li>
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>
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>
113
109
  * </li>
114
110
  * </ul>
115
111
  *
@@ -117,8 +113,7 @@ declare const UpdateTaskProtectionCommand_base: {
117
113
  * <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>
118
114
  *
119
115
  * @throws {@link InvalidParameterException} (client fault)
120
- * <p>The specified parameter isn't valid. Review the available parameters for the API
121
- * request.</p>
116
+ * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
122
117
  *
123
118
  * @throws {@link ResourceNotFoundException} (client fault)
124
119
  * <p>The specified resource wasn't found.</p>