docs(client-ecs): Amazon ECS UpdateService now supports the following parameters: PlacementStrategies, PlacementConstraints and CapacityProviderStrategy.

awstools · awstools · commit 89979861a0e3 · 2022-06-21T18:18:47.000Z
diff --git a/clients/client-ecs/README.md b/clients/client-ecs/README.md
@@ -12,10 +12,10 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
 <fullname>Amazon Elastic Container Service</fullname>
 
 <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
-it easy to run, stop, and manage Docker containers on a cluster. You can host your
-cluster on a serverless infrastructure that's managed by Amazon ECS by launching your
-services or tasks on Fargate. For more control, you can host your tasks on a cluster
-of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.</p>
+it easy to run, stop, and manage Docker containers. You can host your cluster on a
+serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
+Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
+or External (on-premises) instances that you manage.</p>
 <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
 calls. This makes it easy to get the state of your cluster from a centralized service,
 and gives you access to many familiar Amazon EC2 features.</p>
diff --git a/clients/client-ecs/src/ECS.ts b/clients/client-ecs/src/ECS.ts
diff --git a/clients/client-ecs/src/ECSClient.ts b/clients/client-ecs/src/ECSClient.ts
@@ -449,10 +449,10 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {}
 /**
  * <fullname>Amazon Elastic Container Service</fullname>
  * 		       <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
- * 			it easy to run, stop, and manage Docker containers on a cluster. You can host your
- * 			cluster on a serverless infrastructure that's managed by Amazon ECS by launching your
- * 			services or tasks on Fargate. For more control, you can host your tasks on a cluster
- * 			of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.</p>
+ * 			it easy to run, stop, and manage Docker containers. You can host your cluster on a
+ * 			serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
+ * 			Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
+ * 			or External (on-premises) instances that you manage.</p>
  * 		       <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
  * 			calls. This makes it easy to get the state of your cluster from a centralized service,
  * 			and gives you access to many familiar Amazon EC2 features.</p>
diff --git a/clients/client-ecs/src/commands/CreateClusterCommand.ts b/clients/client-ecs/src/commands/CreateClusterCommand.ts
@@ -32,7 +32,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  * 				required resources in other Amazon Web Services services on your behalf. However, if the IAM user
  * 				that makes the call doesn't have permissions to 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
- * 					Service-Linked Roles for Amazon ECS</a> in the
+ * 					service-linked roles for Amazon ECS</a> in the
  * 					<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 		       </note>
  * @example
diff --git a/clients/client-ecs/src/commands/CreateServiceCommand.ts b/clients/client-ecs/src/commands/CreateServiceCommand.ts
@@ -26,15 +26,16 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  * <p>Runs and maintains your desired number of tasks from a specified task definition. If
  * 			the number of tasks running in a service drops below the <code>desiredCount</code>,
  * 			Amazon ECS runs another copy of the task in the specified cluster. To update an existing
- * 			service, see the UpdateService action.</p>
+ * 			service, see the <a>UpdateService</a> action.</p>
  * 		       <p>In addition to maintaining the desired count of tasks in your service, you can
  * 			optionally run your service behind one or more load balancers. The load balancers
  * 			distribute traffic across the tasks that are associated with the service. For more
- * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service Load Balancing</a> in the
+ * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
  * 				<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 		       <p>Tasks for services that 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>
+ * 			considered healthy if they're in the <code>RUNNING</code> state and are reported as
+ * 			healthy by the load balancer.</p>
  * 		       <p>There are two service scheduler strategies available:</p>
  * 		       <ul>
  *             <li>
@@ -43,7 +44,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  * 					maintains your desired number of tasks across your cluster. By default, the
  * 					service scheduler spreads tasks across Availability Zones. You can use task
  * 					placement strategies and constraints to customize task placement decisions. For
- * 					more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service Scheduler Concepts</a> in the
+ * 					more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
  * 						<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 			         </li>
  *             <li>
@@ -54,7 +55,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  * 					evaluates the task placement constraints for running tasks. It also stops tasks
  * 					that don't meet the placement constraints. When using this strategy, you don't
  * 					need to specify a desired number of tasks, a task placement strategy, or use
- * 					Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service Scheduler Concepts</a> in the
+ * 					Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
  * 						<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 			         </li>
  *          </ul>
@@ -98,7 +99,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  * 			currently visible when describing your service.</p>
  * 		       <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
  * 			can specify only parameters that aren't controlled at the task set level. The only
- * 			required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
+ * 			required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 		       <p>When the service scheduler launches new tasks, it determines task placement in your
  * 			cluster using the following logic:</p>
  * 		       <ul>
diff --git a/clients/client-ecs/src/commands/CreateTaskSetCommand.ts b/clients/client-ecs/src/commands/CreateTaskSetCommand.ts
@@ -25,8 +25,8 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
 /**
  * <p>Create a task set in the specified cluster and service. This is used when a service
  * 			uses the <code>EXTERNAL</code> deployment controller type. For more information, see
- * 				<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment
- * 				Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
+ * 				<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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts b/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts
@@ -24,7 +24,7 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
 
 /**
  * <p>Deletes a specified task set within a service. This is used when a service uses the
- * 				<code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
+ * 				<code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ecs/src/commands/DescribeTasksCommand.ts b/clients/client-ecs/src/commands/DescribeTasksCommand.ts
@@ -24,6 +24,7 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
 
 /**
  * <p>Describes a specified task or tasks.</p>
+ * 		       <p>Currently, stopped tasks appear in the returned results for at least one hour.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ecs/src/commands/ExecuteCommandCommand.ts b/clients/client-ecs/src/commands/ExecuteCommandCommand.ts
@@ -24,6 +24,10 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
 
 /**
  * <p>Runs a command remotely on a container within a task.</p>
+ * 		       <p>If you use a condition key in your IAM policy to refine the conditions for the policy
+ * 			statement, for example limit the actions to a specific cluster, you recevie an
+ * 				<code>AccessDeniedException</code> when there is a mismatch between the condition
+ * 			key value and the corresponding parameter value.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ecs/src/commands/PutAccountSettingCommand.ts b/clients/client-ecs/src/commands/PutAccountSettingCommand.ts
@@ -32,9 +32,9 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
  * 				<code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name
  * 			(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or
  * 			the root user for an account is affected. The opt-in and opt-out account setting must be
- * 			set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
- * 			defined by the opt-in status of the IAM user or role that created the resource. You must
- * 			turn on this setting to use Amazon ECS features such as resource tagging.</p>
+ * 			set for each Amazon ECS resource separately. The ARN and resource ID format of a resource
+ * 			is defined by the opt-in status of the IAM user or role that created the resource. You
+ * 			must turn on this setting to use Amazon ECS features such as resource tagging.</p>
  * 		       <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
  * 			limit for any new container instances that support the feature is changed. If
  * 				<code>awsvpcTrunking</code> is enabled, any new container instances that support the
diff --git a/clients/client-ecs/src/commands/RunTaskCommand.ts b/clients/client-ecs/src/commands/RunTaskCommand.ts
@@ -27,11 +27,11 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
  * 				<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 		       <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
  * 			place tasks manually on specific container instances.</p>
- * 		       <p>The Amazon ECS API follows an eventual consistency model. This is because of the distributed
- * 			nature of the system supporting the API. This means that the result of an API command
- * 			you run that affects your Amazon ECS resources might not be immediately visible to all
- * 			subsequent commands you run. Keep this in mind when you carry out an API command that
- * 			immediately follows a previous API command.</p>
+ * 		       <p>The Amazon ECS API follows an eventual consistency model. This is because of the
+ * 			distributed nature of the system supporting the API. This means that the result of an
+ * 			API command you run that affects your Amazon ECS resources might not be immediately visible
+ * 			to all subsequent commands you run. Keep this in mind when you carry out an API command
+ * 			that immediately follows a previous API command.</p>
  * 		       <p>To manage eventual consistency, you can do the following:</p>
  * 		       <ul>
  *             <li>
diff --git a/clients/client-ecs/src/commands/UpdateServiceCommand.ts b/clients/client-ecs/src/commands/UpdateServiceCommand.ts
@@ -23,27 +23,21 @@ export interface UpdateServiceCommandInput extends UpdateServiceRequest {}
 export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __MetadataBearer {}
 
 /**
- * <important>
- * 			         <p>Updating the task placement strategies and constraints on an Amazon ECS service remains
- * 				in preview and is a Beta Service as defined by and subject to the Beta Service
- * 				Participation Service Terms located at <a href="https://aws.amazon.com/service-terms">https://aws.amazon.com/service-terms</a> ("Beta Terms"). These Beta Terms
- * 				apply to your participation in this preview.</p>
- * 		       </important>
- * 		       <p>Modifies the parameters of a service.</p>
- * 		       <p>For services using the rolling update (<code>ECS</code>) 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>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
+ * <p>Modifies the parameters of a service.</p>
+ * 		       <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>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
+ * 		       <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>CreateTaskSet</a>.</p>
  * 		       <p>You can add to or subtract from the number of instantiations of a task definition in a
@@ -136,22 +130,22 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
  * 			         </li>
  *          </ul>
  * 		       <note>
- * 		          <p>You must have a service-linked role when you update any of the following service properties.
- * 			If you specified a custom IAM role when you created the service, Amazon ECS automatically
- * 			replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your service-linked
- * 			role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked
- * 				roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
- * 		          <ul>
+ * 			         <p>You must have a service-linked role when you update any of the following service
+ * 				properties. If you specified a custom IAM role when you created the service, Amazon ECS
+ * 				automatically replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your
+ * 				service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the
+ * 				<i>Amazon Elastic Container Service Developer Guide</i>.</p>
+ * 			         <ul>
  *                <li>
- * 				              <p>
+ * 					             <p>
  *                      <code>loadBalancers,</code>
  *                   </p>
- * 			            </li>
+ * 				           </li>
  *                <li>
- * 				              <p>
+ * 					             <p>
  *                      <code>serviceRegistries</code>
  *                   </p>
- * 			            </li>
+ * 				           </li>
  *             </ul>
  * 		       </note>
  * @example
diff --git a/clients/client-ecs/src/models/models_0.ts b/clients/client-ecs/src/models/models_0.ts
diff --git a/clients/client-ecs/src/waiters/index.ts b/clients/client-ecs/src/waiters/index.ts
diff --git a/clients/client-ecs/src/waiters/waitForServicesStable.ts b/clients/client-ecs/src/waiters/waitForServicesStable.ts
diff --git a/codegen/sdk-codegen/aws-models/ecs.json b/codegen/sdk-codegen/aws-models/ecs.json
