@aws-sdk/client-ecs 3.993.0 → 3.995.0

package/dist-types/commands/TagResourceCommand.d.ts

@@ -27,10 +27,7 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Associates the specified tags to a resource with the specified
- * 				<code>resourceArn</code>. If existing tags on a resource aren't specified in the
- * 			request parameters, they aren't changed. When a resource is deleted, the tags that are
- * 			associated with that resource are deleted as well.</p>
+ * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -61,18 +58,13 @@ declare const TagResourceCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource wasn't found.</p>

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -55,18 +55,13 @@ declare const UntagResourceCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource wasn't found.</p>

package/dist-types/commands/UpdateCapacityProviderCommand.d.ts

@@ -27,9 +27,7 @@ declare const UpdateCapacityProviderCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Modifies the parameters for a capacity provider.</p>
- *          <p>These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not
- * 			existing ones.</p>
+ * <p>Modifies the parameters for a capacity provider.</p> <p>These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not existing ones.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -278,18 +276,13 @@ declare const UpdateCapacityProviderCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>

package/dist-types/commands/UpdateClusterCommand.d.ts

@@ -150,18 +150,13 @@ declare const UpdateClusterCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link NamespaceNotFoundException} (client fault)
  *  <p>The specified namespace wasn't found.</p>

package/dist-types/commands/UpdateClusterSettingsCommand.d.ts

@@ -130,18 +130,13 @@ declare const UpdateClusterSettingsCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>

package/dist-types/commands/UpdateContainerAgentCommand.d.ts

@@ -27,28 +27,7 @@ declare const UpdateContainerAgentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the Amazon ECS container agent on a specified container instance. Updating the
- * 			Amazon ECS container agent doesn't interrupt running tasks or services on the container
- * 			instance. The process for updating the agent differs depending on whether your container
- * 			instance was launched with the Amazon ECS-optimized AMI or another operating
- * 			system.</p>
- *          <note>
- *             <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances
- * 				using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container
- * 				agent, you can update the <code>ecs-init</code> package. This updates the agent. For
- * 				more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
- * 					Amazon ECS container agent</a> in the <i>Amazon Elastic Container
- * 					Service Developer Guide</i>.</p>
- *          </note>
- *          <note>
- *             <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not
- * 				apply to Windows container instances. We recommend that you launch new container
- * 				instances to update the agent version in your Windows clusters.</p>
- *          </note>
- *          <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or
- * 			Amazon Linux AMI with the <code>ecs-init</code> service installed and running. For help
- * 			updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the <i>Amazon
- * 				Elastic Container Service Developer Guide</i>.</p>
+ * <p>Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.</p> <note> <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the <code>ecs-init</code> package. This updates the agent. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note> <note> <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.</p> </note> <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -155,39 +134,25 @@ declare const UpdateContainerAgentCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link MissingVersionException} (client fault)
- *  <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on
- * 			the container instance and doesn't have enough information to proceed with an update.
- * 			This could be because the agent running on the container instance is a previous or
- * 			custom version that doesn't use our version information.</p>
+ *  <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.</p>
  *
  * @throws {@link NoUpdateAvailableException} (client fault)
- *  <p>There's no update available for this Amazon ECS container agent. This might be because
- * 			the agent is already running the latest version or because it's so old that there's no
- * 			update path to the current version.</p>
+ *  <p>There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.</p>
  *
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>
  *
  * @throws {@link UpdateInProgressException} (client fault)
- *  <p>There's already a current Amazon ECS container agent update in progress on the
- * 			container instance that's specified. If the container agent becomes disconnected while
- * 			it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the
- * 			update process can get stuck in that state. However, when the agent reconnects, it
- * 			resumes where it stopped previously.</p>
+ *  <p>There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>
  *
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>

package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts

@@ -27,55 +27,7 @@ declare const UpdateContainerInstancesStateCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Modifies the status of an Amazon ECS container instance.</p>
- *          <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the
- * 			status of a container instance to <code>DRAINING</code> to manually remove an instance
- * 			from a cluster, for example to perform system updates, update the Docker daemon, or
- * 			scale down the cluster size.</p>
- *          <important>
- *             <p>A container instance can't be changed to <code>DRAINING</code> until it has
- * 				reached an <code>ACTIVE</code> status. If the instance is in any other status, an
- * 				error will be received.</p>
- *          </important>
- *          <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new
- * 			tasks from being scheduled for placement on the container instance and replacement
- * 			service tasks are started on other container instances in the cluster if the resources
- * 			are available. Service tasks on the container instance that are in the
- * 				<code>PENDING</code> state are stopped immediately.</p>
- *          <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are
- * 			stopped and replaced according to the service's deployment configuration parameters,
- * 				<code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change
- * 			the deployment configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
- *          <ul>
- *             <li>
- *                <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
- * 						<code>desiredCount</code> temporarily during task replacement. For example,
- * 						<code>desiredCount</code> is four tasks, a minimum of 50% allows the
- * 					scheduler to stop two existing tasks before starting two new tasks. If the
- * 					minimum is 100%, the service scheduler can't remove existing tasks until the
- * 					replacement tasks are considered healthy. Tasks for services that do not use a
- * 					load balancer are considered healthy if they're in the <code>RUNNING</code>
- * 					state. Tasks for services that use a load balancer are considered healthy if
- * 					they're in the <code>RUNNING</code> state and are reported as healthy by the
- * 					load balancer.</p>
- *             </li>
- *             <li>
- *                <p>The <code>maximumPercent</code> parameter represents an upper limit on the
- * 					number of running tasks during task replacement. You can use this to define the
- * 					replacement batch size. For example, if <code>desiredCount</code> is four tasks,
- * 					a maximum of 200% starts four new tasks before stopping the four tasks to be
- * 					drained, provided that the cluster resources required to do this are available.
- * 					If the maximum is 100%, then replacement tasks can't start until the draining
- * 					tasks have stopped.</p>
- *             </li>
- *          </ul>
- *          <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service
- * 			aren't affected. You must wait for them to finish or stop them manually.</p>
- *          <p>A container instance has completed draining when it has no more <code>RUNNING</code>
- * 			tasks. You can verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p>
- *          <p>When a container instance has been drained, you can set a container instance to
- * 				<code>ACTIVE</code> status and once it has reached that status the Amazon ECS
- * 			scheduler can begin scheduling tasks on the instance again.</p>
+ * <p>Modifies the status of an Amazon ECS container instance.</p> <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.</p> <important> <p>A container instance can't be changed to <code>DRAINING</code> until it has reached an <code>ACTIVE</code> status. If the instance is in any other status, an error will be received.</p> </important> <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the <code>PENDING</code> state are stopped immediately.</p> <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and replaced according to the service's deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during task replacement. For example, <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.</p> </li> </ul> <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually.</p> <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p> <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -194,18 +146,13 @@ declare const UpdateContainerInstancesStateCommand_base: {
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>

package/dist-types/commands/UpdateExpressGatewayServiceCommand.d.ts

@@ -27,14 +27,7 @@ declare const UpdateExpressGatewayServiceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates an existing Express service configuration. Modifies container settings, resource
- * 			allocation, auto-scaling configuration, and other service parameters without recreating the
- * 			service.</p>
- *          <p>Amazon ECS creates a new service revision with updated configuration and performs a rolling
- * 			deployment to replace existing tasks. The service remains available during updates,
- * 			ensuring zero-downtime deployments.</p>
- *          <p>Some parameters like the infrastructure role cannot be modified after service creation
- * 			and require creating a new service.</p>
+ * <p>Updates an existing Express service configuration. Modifies container settings, resource allocation, auto-scaling configuration, and other service parameters without recreating the service.</p> <p>Amazon ECS creates a new service revision with updated configuration and performs a rolling deployment to replace existing tasks. The service remains available during updates, ensuring zero-downtime deployments.</p> <p>Some parameters like the infrastructure role cannot be modified after service creation and require creating a new service.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -174,29 +167,22 @@ declare const UpdateExpressGatewayServiceCommand_base: {
  *  <p>You don't have authorization to perform the requested action.</p>
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>
  *
  * @throws {@link ServiceNotActiveException} (client fault)
- *  <p>The specified service isn't active. You can't update a service that's inactive. If you
- * 			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>
+ *  <p>The specified service isn't active. You can't update a service that's inactive. If you 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>
  *
  * @throws {@link ServiceNotFoundException} (client fault)
- *  <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>
+ *  <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>
  *
  * @throws {@link UnsupportedFeatureException} (client fault)
  *  <p>The specified task isn't supported in this Region.</p>

package/dist-types/commands/UpdateServiceCommand.d.ts

@@ -27,131 +27,7 @@ declare const UpdateServiceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Modifies the parameters of a service.</p>
- *          <note>
- *             <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>
- *          </note>
- *          <p>For services using the rolling update (<code>ECS</code>) you can update the desired
- * 			count, deployment configuration, network configuration, load balancers, service
- * 			registries, enable ECS managed tags option, propagate tags option, task placement
- * 			constraints and strategies, and task definition. When you update any of these
- * 			parameters, Amazon ECS starts new tasks with the new configuration. </p>
- *          <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when
- * 			starting or running a task, or when creating or updating a service. For more
- * 			information, 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 your volume
- * 			configurations and trigger a new deployment. <code>volumeConfigurations</code> is only
- * 			supported for REPLICA service and not DAEMON service. If you leave
- * 				<code>volumeConfigurations</code>
- *             <code>null</code>, it doesn't trigger a new deployment. For more information on volumes,
- * 			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>
- *          <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller,
- * 			only the desired count, deployment configuration, health check grace period, task
- * 			placement constraints and strategies, enable ECS managed tags option, and propagate tags
- * 			can be updated using this API. If the network configuration, platform version, task
- * 			definition, or load balancer need to be updated, create a new CodeDeploy deployment. For
- * 			more 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>
- *          <p>For services using an external deployment controller, you can update only the desired
- * 			count, task placement constraints and strategies, health check grace period, enable ECS
- * 			managed tags option, and propagate tags option, using this API. If the launch type, load
- * 			balancer, network configuration, platform version, or task definition need to be
- * 			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>
- *          <p>You can add to or subtract from the number of instantiations of a task definition in a
- * 			service by specifying the cluster that the service is running in and a new
- * 				<code>desiredCount</code> parameter.</p>
- *          <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when
- * 			starting or running a task, or when creating or updating a service. For more
- * 			information, 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>
- *          <p>If you have updated the container image of your application, you can create a new task
- * 			definition with that image and deploy it to your service. The service scheduler uses the
- * 			minimum healthy percent and maximum percent parameters (in the service's deployment
- * 			configuration) to determine the deployment strategy.</p>
- *          <note>
- *             <p>If your updated Docker image uses the same tag as what is in the existing task
- * 				definition for your service (for example, <code>my_image:latest</code>), you don't
- * 				need to create a new revision of your task definition. You can update the service
- * 				using the <code>forceNewDeployment</code> option. The new tasks launched by the
- * 				deployment pull the current image/tag combination from your repository when they
- * 				start.</p>
- *          </note>
- *          <p>You can also update the deployment configuration of a service. When a deployment is
- * 			triggered by updating the task definition of a service, the service scheduler uses the
- * 			deployment configuration parameters, <code>minimumHealthyPercent</code> and
- * 				<code>maximumPercent</code>, to determine the deployment strategy.</p>
- *          <ul>
- *             <li>
- *                <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
- * 						<code>desiredCount</code> temporarily during a deployment. For example, if
- * 						<code>desiredCount</code> is four tasks, a minimum of 50% allows the
- * 					scheduler to stop two existing tasks before starting two new tasks. Tasks for
- * 					services that don't use a load balancer are considered healthy if they're in the
- * 						<code>RUNNING</code> state. Tasks for services that use a load balancer are
- * 					considered healthy if they're in the <code>RUNNING</code> state and are reported
- * 					as healthy by the load balancer.</p>
- *             </li>
- *             <li>
- *                <p>The <code>maximumPercent</code> parameter represents an upper limit on the
- * 					number of running tasks during a deployment. You can use it to define the
- * 					deployment batch size. For example, if <code>desiredCount</code> is four tasks,
- * 					a maximum of 200% starts four new tasks before stopping the four older tasks
- * 					(provided that the cluster resources required to do this are available).</p>
- *             </li>
- *          </ul>
- *          <p>When <a 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> is issued
- * 			to the containers running in the task. This results in a <code>SIGTERM</code> and a
- * 			30-second timeout. After this, <code>SIGKILL</code> is sent and the containers are
- * 			forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits
- * 			within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p>
- *          <p>When the service scheduler launches new tasks, it determines task placement in your
- * 			cluster with the following logic.</p>
- *          <ul>
- *             <li>
- *                <p>Determine which of the container instances in your cluster can support your
- * 					service's task definition. For example, they have the required CPU, memory,
- * 					ports, and container instance attributes.</p>
- *             </li>
- *             <li>
- *                <p>By default, the service scheduler attempts to balance tasks across
- * 					Availability Zones in this manner even though you can choose a different
- * 					placement strategy.</p>
- *                <ul>
- *                   <li>
- *                      <p>Sort the valid container instances by the fewest number of running
- * 							tasks for this service in the same Availability Zone as the instance.
- * 							For example, if zone A has one running service task and zones B and C
- * 							each have zero, valid container instances in either zone B or C are
- * 							considered optimal for placement.</p>
- *                   </li>
- *                   <li>
- *                      <p>Place the new service task on a valid container instance in an optimal
- * 							Availability Zone (based on the previous steps), favoring container
- * 							instances with the fewest number of running tasks for this
- * 							service.</p>
- *                   </li>
- *                </ul>
- *             </li>
- *          </ul>
- *          <p>When the service scheduler stops running tasks, it attempts to maintain balance across
- * 			the Availability Zones in your cluster using the following logic: </p>
- *          <ul>
- *             <li>
- *                <p>Sort the container instances by the largest number of running tasks for this
- * 					service in the same Availability Zone as the instance. For example, if zone A
- * 					has one running service task and zones B and C each have two, container
- * 					instances in either zone B or C are considered optimal for termination.</p>
- *             </li>
- *             <li>
- *                <p>Stop the task on a container instance in an optimal Availability Zone (based
- * 					on the previous steps), favoring container instances with the largest number of
- * 					running tasks for this service.</p>
- *             </li>
- *          </ul>
+ * <p>Modifies the parameters of a service.</p> <note> <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> </note> <p>For services using the rolling update (<code>ECS</code>) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration. </p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more information, 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 your volume configurations and trigger a new deployment. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON service. If you leave <code>volumeConfigurations</code> <code>null</code>, it doesn't trigger a new deployment. For more information on volumes, 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> <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more 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> <p>For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be 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> <p>You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter.</p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more information, 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> <p>If you have updated the container image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.</p> <note> <p>If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, <code>my_image:latest</code>), you don't need to create a new revision of your task definition. You can update the service using the <code>forceNewDeployment</code> option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.</p> </note> <p>You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <p>When <a 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> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout. After this, <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.</p> <ul> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -702,25 +578,19 @@ declare const UpdateServiceCommand_base: {
  *  <p>You don't have authorization to perform the requested action.</p>
  *
  * @throws {@link ClientException} (client fault)
- *  <p>These errors are usually caused by a client action. This client action might be using
- * 			an action or resource on behalf of a user that doesn't have permissions to use the
- * 			action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
  *
  * @throws {@link ClusterNotFoundException} (client fault)
  *  <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>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  <p>The specified parameter isn't valid. Review the available parameters for the API
- * 			request.</p>
- *          <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
- * 				service event messages</a>. </p>
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
  *
  * @throws {@link NamespaceNotFoundException} (client fault)
  *  <p>The specified namespace wasn't found.</p>
  *
  * @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
- *  <p>The specified platform version doesn't satisfy the required capabilities of the task
- * 			definition.</p>
+ *  <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
  *
  * @throws {@link PlatformUnknownException} (client fault)
  *  <p>The specified platform version doesn't exist.</p>
@@ -729,12 +599,10 @@ declare const UpdateServiceCommand_base: {
  *  <p>These errors are usually caused by a server issue.</p>
  *
  * @throws {@link ServiceNotActiveException} (client fault)
- *  <p>The specified service isn't active. You can't update a service that's inactive. If you
- * 			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>
+ *  <p>The specified service isn't active. You can't update a service that's inactive. If you 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>
  *
  * @throws {@link ServiceNotFoundException} (client fault)
- *  <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>
+ *  <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>
  *
  * @throws {@link UnsupportedFeatureException} (client fault)
  *  <p>The specified task isn't supported in this Region.</p>
@@ -743,12 +611,12 @@ declare const UpdateServiceCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  *
- * @example To change the number of tasks in a service
+ * @example To change the task definition used in a service
  * ```javascript
- * // This example updates the desired count of the my-http-service service to 10.
+ * // This example updates the my-http-service service to use the amazon-ecs-sample task definition.
  * const input = {
- *   desiredCount: 10,
- *   service: "my-http-service"
+ *   service: "my-http-service",
+ *   taskDefinition: "amazon-ecs-sample"
  * };
  * const command = new UpdateServiceCommand(input);
  * const response = await client.send(command);
@@ -757,12 +625,12 @@ declare const UpdateServiceCommand_base: {
  * *\/
  * ```
  *
- * @example To change the task definition used in a service
+ * @example To change the number of tasks in a service
  * ```javascript
- * // This example updates the my-http-service service to use the amazon-ecs-sample task definition.
+ * // This example updates the desired count of the my-http-service service to 10.
  * const input = {
- *   service: "my-http-service",
- *   taskDefinition: "amazon-ecs-sample"
+ *   desiredCount: 10,
+ *   service: "my-http-service"
  * };
  * const command = new UpdateServiceCommand(input);
  * const response = await client.send(command);