@aws-sdk/client-ecs 3.703.0 → 3.709.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 +36 -36
package/README.md CHANGED
@@ -8,17 +8,18 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
8
8
 
9
9
  <fullname>Amazon Elastic Container Service</fullname>
10
10
 
11
- <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
12
- stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
13
- managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
14
- tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
15
- <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
16
- it easy to get the state of your cluster from a centralized service, and gives you access to many
17
- familiar Amazon EC2 features.</p>
18
- <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
19
- needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
20
- own cluster management and configuration management systems. You also don't need to worry about scaling
21
- your management infrastructure. </p>
11
+ <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
12
+ it easy to run, stop, and manage Docker containers. You can host your cluster on a
13
+ serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
14
+ Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
15
+ or External (on-premises) instances that you manage.</p>
16
+ <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
17
+ calls. This makes it easy to get the state of your cluster from a centralized service,
18
+ and gives you access to many familiar Amazon EC2 features.</p>
19
+ <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
20
+ your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
21
+ don't need to operate your own cluster management and configuration management systems.
22
+ You also don't need to worry about scaling your management infrastructure. </p>
22
23
 
23
24
  ## Installing
24
25
 
@@ -431,17 +431,18 @@ export interface ECS {
431
431
  }
432
432
  /**
433
433
  * <fullname>Amazon Elastic Container Service</fullname>
434
- * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
435
- * stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
436
- * managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
437
- * tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
438
- * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
439
- * it easy to get the state of your cluster from a centralized service, and gives you access to many
440
- * familiar Amazon EC2 features.</p>
441
- * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
442
- * needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
443
- * own cluster management and configuration management systems. You also don't need to worry about scaling
444
- * your management infrastructure. </p>
434
+ * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
435
+ * it easy to run, stop, and manage Docker containers. You can host your cluster on a
436
+ * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
437
+ * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
438
+ * or External (on-premises) instances that you manage.</p>
439
+ * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
440
+ * calls. This makes it easy to get the state of your cluster from a centralized service,
441
+ * and gives you access to many familiar Amazon EC2 features.</p>
442
+ * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
443
+ * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
444
+ * don't need to operate your own cluster management and configuration management systems.
445
+ * You also don't need to worry about scaling your management infrastructure. </p>
445
446
  * @public
446
447
  */
447
448
  export declare class ECS extends ECSClient implements ECS {
@@ -211,17 +211,18 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {
211
211
  }
212
212
  /**
213
213
  * <fullname>Amazon Elastic Container Service</fullname>
214
- * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
215
- * stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
216
- * managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
217
- * tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
218
- * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
219
- * it easy to get the state of your cluster from a centralized service, and gives you access to many
220
- * familiar Amazon EC2 features.</p>
221
- * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
222
- * needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
223
- * own cluster management and configuration management systems. You also don't need to worry about scaling
224
- * your management infrastructure. </p>
214
+ * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
215
+ * it easy to run, stop, and manage Docker containers. You can host your cluster on a
216
+ * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
217
+ * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
218
+ * or External (on-premises) instances that you manage.</p>
219
+ * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
220
+ * calls. This makes it easy to get the state of your cluster from a centralized service,
221
+ * and gives you access to many familiar Amazon EC2 features.</p>
222
+ * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
223
+ * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
224
+ * don't need to operate your own cluster management and configuration management systems.
225
+ * You also don't need to worry about scaling your management infrastructure. </p>
225
226
  * @public
226
227
  */
227
228
  export declare class ECSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ECSClientResolvedConfig> {
@@ -27,11 +27,13 @@ declare const CreateCapacityProviderCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used
31
- * in capacity provider strategies to facilitate cluster auto scaling.</p>
32
- * <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use
33
- * the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers. These providers are
34
- * available to all accounts in the Amazon Web Services Regions that Fargate supports.</p>
30
+ * <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
31
+ * cluster and are used in capacity provider strategies to facilitate cluster auto
32
+ * scaling.</p>
33
+ * <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
34
+ * Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.
35
+ * These providers are available to all accounts in the Amazon Web Services Regions that Fargate
36
+ * supports.</p>
35
37
  * @example
36
38
  * Use a bare-bones client and the command you need to make an API call.
37
39
  * ```javascript
@@ -98,21 +100,23 @@ declare const CreateCapacityProviderCommand_base: {
98
100
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
99
101
  *
100
102
  * @throws {@link ClientException} (client fault)
101
- * <p>These errors are usually caused by a client action. This client action might be using an action or
102
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
103
- * be specifying an identifier that isn't valid.</p>
103
+ * <p>These errors are usually caused by a client action. This client action might be using
104
+ * an action or resource on behalf of a user that doesn't have permissions to use the
105
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
104
106
  * <p>The following list includes additional causes for the error:</p>
105
107
  * <ul>
106
108
  * <li>
107
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
108
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
109
- * 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
110
- * quotas</a>.</p>
109
+ * <p>The <code>RunTask</code> could not be processed because you use managed
110
+ * scaling and there is a capacity error because the quota of tasks in the
111
+ * <code>PROVISIONING</code> per cluster has been reached. For information
112
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
113
+ * service quotas</a>.</p>
111
114
  * </li>
112
115
  * </ul>
113
116
  *
114
117
  * @throws {@link InvalidParameterException} (client fault)
115
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
118
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
119
+ * request.</p>
116
120
  *
117
121
  * @throws {@link LimitExceededException} (client fault)
118
122
  * <p>The limit for the resource was exceeded.</p>
@@ -121,10 +125,11 @@ declare const CreateCapacityProviderCommand_base: {
121
125
  * <p>These errors are usually caused by a server issue.</p>
122
126
  *
123
127
  * @throws {@link UpdateInProgressException} (client fault)
124
- * <p>There's already a current Amazon ECS container agent update in progress on the container instance that's
125
- * specified. If the container agent becomes disconnected while it's in a transitional stage, such as
126
- * <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state.
127
- * However, when the agent reconnects, it resumes where it stopped previously.</p>
128
+ * <p>There's already a current Amazon ECS container agent update in progress on the container
129
+ * instance that's specified. If the container agent becomes disconnected while it's in a
130
+ * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
131
+ * process can get stuck in that state. However, when the agent reconnects, it resumes
132
+ * where it stopped previously.</p>
128
133
  *
129
134
  * @throws {@link ECSServiceException}
130
135
  * <p>Base exception class for all service exceptions from ECS service.</p>
@@ -27,16 +27,16 @@ declare const CreateClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when
31
- * you launch your first container instance. However, you can create your own cluster with a unique
32
- * name.</p>
30
+ * <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
31
+ * cluster when you launch your first container instance. However, you can create your own
32
+ * cluster with a unique name.</p>
33
33
  * <note>
34
- * <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation,
35
- * Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can
36
- * manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes
37
- * the call doesn't have permissions to create the service-linked role, it isn't created. For more
38
- * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked
39
- * roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
34
+ * <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a>
35
+ * API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your
36
+ * account. This is so that it can manage required resources in other Amazon Web Services services on
37
+ * your behalf. However, if the user that makes the call doesn't have permissions to
38
+ * create the service-linked role, it isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
39
+ * service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
40
40
  * </note>
41
41
  * @example
42
42
  * Use a bare-bones client and the command you need to make an API call.
@@ -174,21 +174,23 @@ declare const CreateClusterCommand_base: {
174
174
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
175
175
  *
176
176
  * @throws {@link ClientException} (client fault)
177
- * <p>These errors are usually caused by a client action. This client action might be using an action or
178
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
179
- * be specifying an identifier that isn't valid.</p>
177
+ * <p>These errors are usually caused by a client action. This client action might be using
178
+ * an action or resource on behalf of a user that doesn't have permissions to use the
179
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
180
180
  * <p>The following list includes additional causes for the error:</p>
181
181
  * <ul>
182
182
  * <li>
183
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
184
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
185
- * 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
186
- * quotas</a>.</p>
183
+ * <p>The <code>RunTask</code> could not be processed because you use managed
184
+ * scaling and there is a capacity error because the quota of tasks in the
185
+ * <code>PROVISIONING</code> per cluster has been reached. For information
186
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
187
+ * service quotas</a>.</p>
187
188
  * </li>
188
189
  * </ul>
189
190
  *
190
191
  * @throws {@link InvalidParameterException} (client fault)
191
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
192
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
193
+ * request.</p>
192
194
  *
193
195
  * @throws {@link NamespaceNotFoundException} (client fault)
194
196
  * <p>The specified namespace wasn't found.</p>
@@ -27,89 +27,92 @@ declare const CreateServiceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Runs and maintains your desired number of tasks from a specified task definition. If the number of
31
- * tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the
32
- * task in the specified cluster. To update an existing service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
30
+ * <p>Runs and maintains your desired number of tasks from a specified task definition. If
31
+ * the number of tasks running in a service drops below the <code>desiredCount</code>,
32
+ * Amazon ECS runs another copy of the task in the specified cluster. To update an existing
33
+ * service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
33
34
  * <note>
34
35
  * <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>
35
36
  * </note>
36
37
  * <note>
37
38
  * <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
38
39
  * </note>
39
- * <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your
40
- * service behind one or more load balancers. The load balancers distribute traffic across the tasks that
41
- * are associated with the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load
42
- * balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
43
- * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a
44
- * service. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON
45
- * service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
46
- * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
47
- * <p>Tasks for services that don't use a load balancer are considered healthy if they're in the
48
- * <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if
49
- * they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p>
40
+ * <p>In addition to maintaining the desired count of tasks in your service, you can
41
+ * optionally run your service behind one or more load balancers. The load balancers
42
+ * distribute traffic across the tasks that are associated with the service. For more
43
+ * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
44
+ * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
45
+ * updating a service. <code>volumeConfigurations</code> is only supported for REPLICA
46
+ * service and not DAEMON 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>
47
+ * <p>Tasks for services that don't use a load balancer are considered healthy if they're in
48
+ * the <code>RUNNING</code> state. Tasks for services that use a load balancer are
49
+ * considered healthy if they're in the <code>RUNNING</code> state and are reported as
50
+ * healthy by the load balancer.</p>
50
51
  * <p>There are two service scheduler strategies available:</p>
51
52
  * <ul>
52
53
  * <li>
53
54
  * <p>
54
- * <code>REPLICA</code> - The replica scheduling strategy places and maintains your
55
- * desired number of tasks across your cluster. By default, the service scheduler spreads tasks
56
- * across Availability Zones. You can use task placement strategies and constraints to customize
57
- * task placement decisions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service
58
- * scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
55
+ * <code>REPLICA</code> - The replica scheduling strategy places and
56
+ * maintains your desired number of tasks across your cluster. By default, the
57
+ * service scheduler spreads tasks across Availability Zones. You can use task
58
+ * placement strategies and constraints to customize task placement decisions. For
59
+ * more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
59
60
  * </li>
60
61
  * <li>
61
62
  * <p>
62
- * <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each
63
- * active container instance that meets all of the task placement constraints that you specify in
64
- * your cluster. The service scheduler also evaluates the task placement constraints for running
65
- * tasks. It also stops tasks that don't meet the placement constraints. When using this strategy,
66
- * you don't need to specify a desired number of tasks, a task placement strategy, or use Service
67
- * Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service
68
- * scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
63
+ * <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one
64
+ * task on each active container instance that meets all of the task placement
65
+ * constraints that you specify in your cluster. The service scheduler also
66
+ * evaluates the task placement constraints for running tasks. It also stops tasks
67
+ * that don't meet the placement constraints. When using this strategy, you don't
68
+ * need to specify a desired number of tasks, a task placement strategy, or use
69
+ * Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
69
70
  * </li>
70
71
  * </ul>
71
- * <p>You can optionally specify a deployment configuration for your service. The deployment is initiated
72
- * by changing properties. For example, the deployment might be initiated by the task definition or by
73
- * your desired count of a service. You can use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>. The default value for a replica service for
74
- * <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service for
75
- * <code>minimumHealthyPercent</code> is 0%.</p>
76
- * <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy percent represents
77
- * a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state
78
- * during a deployment. Specifically, it represents it as a percentage of your desired number of tasks
79
- * (rounded up to the nearest integer). This happens when any of your container instances are in the
80
- * <code>DRAINING</code> state if the service contains tasks using the EC2 launch type.
81
- * Using this parameter, you can deploy without using additional cluster capacity. For example, if you set
82
- * your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler
83
- * might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in
84
- * the <code>RUNNING</code> state, tasks for services that don't use a load balancer are considered
85
- * healthy . If they're in the <code>RUNNING</code> state and reported as healthy by the load balancer,
86
- * tasks for services that <i>do</i> use a load balancer are considered healthy . The
72
+ * <p>You can optionally specify a deployment configuration for your service. The deployment
73
+ * is initiated by changing properties. For example, the deployment might be initiated by
74
+ * the task definition or by your desired count of a service. You can use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>. The default value for a replica service for
75
+ * <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service
76
+ * for <code>minimumHealthyPercent</code> is 0%.</p>
77
+ * <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy
78
+ * percent represents a lower limit on the number of tasks in a service that must remain in
79
+ * the <code>RUNNING</code> state during a deployment. Specifically, it represents it as a
80
+ * percentage of your desired number of tasks (rounded up to the nearest integer). This
81
+ * happens when any of your container instances are in the <code>DRAINING</code> state if
82
+ * the service contains tasks using the EC2 launch type. Using this
83
+ * parameter, you can deploy without using additional cluster capacity. For example, if you
84
+ * set your service to have desired number of four tasks and a minimum healthy percent of
85
+ * 50%, the scheduler might stop two existing tasks to free up cluster capacity before
86
+ * starting two new tasks. If they're in the <code>RUNNING</code> state, tasks for services
87
+ * that don't use a load balancer are considered healthy . If they're in the
88
+ * <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for
89
+ * services that <i>do</i> use a load balancer are considered healthy . The
87
90
  * default value for minimum healthy percent is 100%.</p>
88
- * <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum
89
- * percent</b> parameter represents an upper limit on the number of tasks in a service that are
90
- * allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment. Specifically, it
91
- * represents it as a percentage of the desired number of tasks (rounded down to the nearest integer).
92
- * This happens when any of your container instances are in the <code>DRAINING</code> state if the service
93
- * contains tasks using the EC2 launch type. Using this parameter, you can define the
94
- * deployment batch size. For example, if your service has a desired number of four tasks and a maximum
95
- * percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks
96
- * (provided that the cluster resources required to do this are available). The default value for maximum
97
- * percent is 200%.</p>
98
- * <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller
99
- * types and tasks that use the EC2 launch type, the <b>minimum healthy
100
- * percent</b> and <b>maximum percent</b> values are used only to
101
- * define the lower and upper limit on the number of the tasks in the service that remain in the
102
- * <code>RUNNING</code> state. This is while the container instances are in the <code>DRAINING</code>
103
- * state. If the tasks in the service use the Fargate launch type, the minimum healthy
104
- * percent and maximum percent values aren't used. This is the case even if they're currently visible when
105
- * describing your service.</p>
106
- * <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify
107
- * only parameters that aren't controlled at the task set level. The only required parameter is the
108
- * service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
109
- * types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
110
- * <p>When the service scheduler launches new tasks, it determines task placement. For information about
111
- * task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task
112
- * placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
91
+ * <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the
92
+ * number of tasks in a service that are allowed in the <code>RUNNING</code> or
93
+ * <code>PENDING</code> state during a deployment. Specifically, it represents it as a
94
+ * percentage of the desired number of tasks (rounded down to the nearest integer). This
95
+ * happens when any of your container instances are in the <code>DRAINING</code> state if
96
+ * the service contains tasks using the EC2 launch type. Using this
97
+ * parameter, you can define the deployment batch size. For example, if your service has a
98
+ * desired number of four tasks and a maximum percent value of 200%, the scheduler may
99
+ * start four new tasks before stopping the four older tasks (provided that the cluster
100
+ * resources required to do this are available). The default value for maximum percent is
101
+ * 200%.</p>
102
+ * <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code>
103
+ * deployment controller types and tasks that use the EC2 launch type, the
104
+ * <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit
105
+ * on the number of the tasks in the service that remain in the <code>RUNNING</code> state.
106
+ * This is while the container instances are in the <code>DRAINING</code> state. If the
107
+ * tasks in the service use the Fargate launch type, the minimum healthy
108
+ * percent and maximum percent values aren't used. This is the case even if they're
109
+ * currently visible when describing your service.</p>
110
+ * <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
111
+ * can specify only parameters that aren't controlled at the task set level. The only
112
+ * required parameter is the service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
113
+ * <p>When the service scheduler launches new tasks, it determines task placement. For
114
+ * information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
115
+ * task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
113
116
  * </p>
114
117
  * @example
115
118
  * Use a bare-bones client and the command you need to make an API call.
@@ -574,16 +577,17 @@ declare const CreateServiceCommand_base: {
574
577
  * <p>You don't have authorization to perform the requested action.</p>
575
578
  *
576
579
  * @throws {@link ClientException} (client fault)
577
- * <p>These errors are usually caused by a client action. This client action might be using an action or
578
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
579
- * be specifying an identifier that isn't valid.</p>
580
+ * <p>These errors are usually caused by a client action. This client action might be using
581
+ * an action or resource on behalf of a user that doesn't have permissions to use the
582
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
580
583
  * <p>The following list includes additional causes for the error:</p>
581
584
  * <ul>
582
585
  * <li>
583
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
584
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
585
- * 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
586
- * quotas</a>.</p>
586
+ * <p>The <code>RunTask</code> could not be processed because you use managed
587
+ * scaling and there is a capacity error because the quota of tasks in the
588
+ * <code>PROVISIONING</code> per cluster has been reached. For information
589
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
590
+ * service quotas</a>.</p>
587
591
  * </li>
588
592
  * </ul>
589
593
  *
@@ -591,7 +595,8 @@ declare const CreateServiceCommand_base: {
591
595
  * <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>
592
596
  *
593
597
  * @throws {@link InvalidParameterException} (client fault)
594
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
598
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
599
+ * request.</p>
595
600
  *
596
601
  * @throws {@link NamespaceNotFoundException} (client fault)
597
602
  * <p>The specified namespace wasn't found.</p>
@@ -27,14 +27,15 @@ declare const CreateTaskSetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a task set in the specified cluster and service. This is used when a service uses the
31
- * <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>Create a task set in the specified cluster and service. This is used when a service
31
+ * uses the <code>EXTERNAL</code> deployment controller type. For more information, see
32
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
32
33
  * types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
33
34
  * <note>
34
35
  * <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>
35
36
  * </note>
36
- * <p>For information about the maximum number of task sets and other quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
37
- * quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
37
+ * <p>For information about the maximum number of task sets and other quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
38
+ * service quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
38
39
  * @example
39
40
  * Use a bare-bones client and the command you need to make an API call.
40
41
  * ```javascript
@@ -178,16 +179,17 @@ declare const CreateTaskSetCommand_base: {
178
179
  * <p>You don't have authorization to perform the requested action.</p>
179
180
  *
180
181
  * @throws {@link ClientException} (client fault)
181
- * <p>These errors are usually caused by a client action. This client action might be using an action or
182
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
183
- * be specifying an identifier that isn't valid.</p>
182
+ * <p>These errors are usually caused by a client action. This client action might be using
183
+ * an action or resource on behalf of a user that doesn't have permissions to use the
184
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
184
185
  * <p>The following list includes additional causes for the error:</p>
185
186
  * <ul>
186
187
  * <li>
187
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
188
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
189
- * 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
190
- * quotas</a>.</p>
188
+ * <p>The <code>RunTask</code> could not be processed because you use managed
189
+ * scaling and there is a capacity error because the quota of tasks in the
190
+ * <code>PROVISIONING</code> per cluster has been reached. For information
191
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
192
+ * service quotas</a>.</p>
191
193
  * </li>
192
194
  * </ul>
193
195
  *
@@ -195,7 +197,8 @@ declare const CreateTaskSetCommand_base: {
195
197
  * <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>
196
198
  *
197
199
  * @throws {@link InvalidParameterException} (client fault)
198
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
200
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
201
+ * request.</p>
199
202
  *
200
203
  * @throws {@link NamespaceNotFoundException} (client fault)
201
204
  * <p>The specified namespace wasn't found.</p>
@@ -211,11 +214,12 @@ declare const CreateTaskSetCommand_base: {
211
214
  * <p>These errors are usually caused by a server issue.</p>
212
215
  *
213
216
  * @throws {@link ServiceNotActiveException} (client fault)
214
- * <p>The specified service isn't active. You can't update a service that's inactive. If you have
215
- * 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>
217
+ * <p>The specified service isn't active. You can't update a service that's inactive. If you
218
+ * 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>
216
219
  *
217
220
  * @throws {@link ServiceNotFoundException} (client fault)
218
- * <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>
221
+ * <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
222
+ * specific.</p>
219
223
  *
220
224
  * @throws {@link UnsupportedFeatureException} (client fault)
221
225
  * <p>The specified task isn't supported in this Region.</p>
@@ -27,7 +27,8 @@ declare const DeleteAccountSettingCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Disables an account setting for a specified user, role, or the root user for an account.</p>
30
+ * <p>Disables an account setting for a specified user, role, or the root user for an
31
+ * account.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -58,21 +59,23 @@ declare const DeleteAccountSettingCommand_base: {
58
59
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
59
60
  *
60
61
  * @throws {@link ClientException} (client fault)
61
- * <p>These errors are usually caused by a client action. This client action might be using an action or
62
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
63
- * be specifying an identifier that isn't valid.</p>
62
+ * <p>These errors are usually caused by a client action. This client action might be using
63
+ * an action or resource on behalf of a user that doesn't have permissions to use the
64
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
64
65
  * <p>The following list includes additional causes for the error:</p>
65
66
  * <ul>
66
67
  * <li>
67
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
68
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
69
- * 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
70
- * quotas</a>.</p>
68
+ * <p>The <code>RunTask</code> could not be processed because you use managed
69
+ * scaling and there is a capacity error because the quota of tasks in the
70
+ * <code>PROVISIONING</code> per cluster has been reached. For information
71
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
72
+ * service quotas</a>.</p>
71
73
  * </li>
72
74
  * </ul>
73
75
  *
74
76
  * @throws {@link InvalidParameterException} (client fault)
75
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
77
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
78
+ * request.</p>
76
79
  *
77
80
  * @throws {@link ServerException} (server fault)
78
81
  * <p>These errors are usually caused by a server issue.</p>
@@ -70,10 +70,12 @@ declare const DeleteAttributesCommand_base: {
70
70
  * <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>
71
71
  *
72
72
  * @throws {@link InvalidParameterException} (client fault)
73
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
73
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
74
+ * request.</p>
74
75
  *
75
76
  * @throws {@link TargetNotFoundException} (client fault)
76
- * <p>The specified target wasn't found. You can view your available container instances with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and
77
+ * <p>The specified target wasn't found. You can view your available container instances
78
+ * with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and
77
79
  * Region-specific.</p>
78
80
  *
79
81
  * @throws {@link ECSServiceException}