@aws-sdk/client-ecs 3.872.0 → 3.873.0

package/dist-types/models/models_0.d.ts

@@ -130,10 +130,6 @@ export interface ManagedScaling {
      * 			value of <code>1</code> is used.</p>
      *          <p>When additional capacity is required, Amazon ECS will scale up the minimum scaling step
      * 			size even if the actual demand is less than the minimum scaling step size.</p>
-     *          <p>If you use a capacity provider with an Auto Scaling group configured with more than
-     * 			one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum
-     * 			scaling step size value and will ignore both the maximum scaling step size as well as
-     * 			the capacity demand.</p>
      * @public
      */
     minimumScalingStepSize?: number | undefined;
@@ -668,7 +664,7 @@ export interface CapacityProviderStrategyItem {
     /**
      * <p>The <i>weight</i> value designates the relative percentage of the total
      * 			number of tasks launched that should use the specified capacity provider. The
-     * 				<code>weight</code> value is taken into consideration after the <code>base</code>
+     * 			<code>weight</code> value is taken into consideration after the <code>base</code>
      * 			value, if defined, is satisfied.</p>
      *          <p>If no <code>weight</code> value is specified, the default value of <code>0</code> is
      * 			used. When multiple capacity providers are specified within a capacity provider
@@ -677,22 +673,59 @@ export interface CapacityProviderStrategyItem {
      * 			tasks. If you specify multiple capacity providers in a strategy that all have a weight
      * 			of <code>0</code>, any <code>RunTask</code> or <code>CreateService</code> actions using
      * 			the capacity provider strategy will fail.</p>
-     *          <p>An example scenario for using weights is defining a strategy that contains two
-     * 			capacity providers and both have a weight of <code>1</code>, then when the
-     * 				<code>base</code> is satisfied, the tasks will be split evenly across the two
-     * 			capacity providers. Using that same logic, if you specify a weight of <code>1</code> for
-     * 				<i>capacityProviderA</i> and a weight of <code>4</code> for
-     * 				<i>capacityProviderB</i>, then for every one task that's run using
-     * 				<i>capacityProviderA</i>, four tasks would use
-     * 				<i>capacityProviderB</i>.</p>
+     *          <p>Weight value characteristics:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Weight is considered after the base value is satisfied</p>
+     *             </li>
+     *             <li>
+     *                <p>Default value is <code>0</code> if not specified</p>
+     *             </li>
+     *             <li>
+     *                <p>Valid range: 0 to 1,000</p>
+     *             </li>
+     *             <li>
+     *                <p>At least one capacity provider must have a weight greater than zero</p>
+     *             </li>
+     *             <li>
+     *                <p>Capacity providers with weight of <code>0</code> cannot place tasks</p>
+     *             </li>
+     *          </ul>
+     *          <p>Task distribution logic:</p>
+     *          <ol>
+     *             <li>
+     *                <p>Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider</p>
+     *             </li>
+     *             <li>
+     *                <p>Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios</p>
+     *             </li>
+     *          </ol>
+     *          <p>Examples:</p>
+     *          <p>Equal Distribution: Two capacity providers both with weight <code>1</code> will split tasks evenly after base requirements are met.</p>
+     *          <p>Weighted Distribution: If capacityProviderA has weight <code>1</code> and capacityProviderB has weight <code>4</code>, then for every 1 task on A, 4 tasks will run on B.</p>
      * @public
      */
     weight?: number | undefined;
     /**
      * <p>The <i>base</i> value designates how many tasks, at a minimum, to run on
-     * 			the specified capacity provider. Only one capacity provider in a capacity provider
+     * 			the specified capacity provider for each service. Only one capacity provider in a capacity provider
      * 			strategy can have a <i>base</i> defined. If no value is specified, the
      * 			default value of <code>0</code> is used.</p>
+     *          <p>Base value characteristics:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Only one capacity provider in a strategy can have a base defined</p>
+     *             </li>
+     *             <li>
+     *                <p>Default value is <code>0</code> if not specified</p>
+     *             </li>
+     *             <li>
+     *                <p>Valid range: 0 to 100,000</p>
+     *             </li>
+     *             <li>
+     *                <p>Base requirements are satisfied first before weight distribution</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     base?: number | undefined;
@@ -1041,7 +1074,7 @@ export interface Cluster {
     pendingTasksCount?: number | undefined;
     /**
      * <p>The number of services that are running on the cluster in an <code>ACTIVE</code>
-     * 			state. You can view these services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">PListServices</a>.</p>
+     * 			state. You can view these services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>.</p>
      * @public
      */
     activeServicesCount?: number | undefined;
@@ -2196,7 +2229,7 @@ export interface LogConfiguration {
      *             <dt>max-buffer-size</dt>
      *             <dd>
      *                <p>Required: No</p>
-     *                <p>Default value: <code>1m</code>
+     *                <p>Default value: <code>10m</code>
      *                </p>
      *                <p>When <code>non-blocking</code> mode is used, the
      * 							<code>max-buffer-size</code> log option controls the size of the buffer
@@ -8626,8 +8659,7 @@ export type TaskField = (typeof TaskField)[keyof typeof TaskField];
 export interface DescribeTasksRequest {
     /**
      * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to
-     * 			describe. If you do not specify a cluster, the default cluster is assumed. If you do not specify a
-     * 			value, the <code>default</code> cluster is used.</p>
+     * 			describe. If you do not specify a cluster, the default cluster is assumed.</p>
      * @public
      */
     cluster?: string | undefined;

package/dist-types/models/models_1.d.ts

@@ -583,6 +583,7 @@ export interface UpdateServiceRequest {
     /**
      * <p>The number of instantiations of the task to place and keep running in your
      * 			service.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     desiredCount?: number | undefined;
@@ -592,6 +593,7 @@ export interface UpdateServiceRequest {
      * 			not specified, the latest <code>ACTIVE</code> revision is used. If you modify the task
      * 			definition with <code>UpdateService</code>, Amazon ECS spawns a task with the new version of
      * 			the task definition and then stops an old task after the new version is running.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     taskDefinition?: string | undefined;
@@ -623,12 +625,14 @@ export interface UpdateServiceRequest {
      *             </li>
      *          </ul>
      *          <p>For information about Amazon Web Services CDK considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html">Amazon Web Services CDK considerations</a>.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
     /**
      * <p>Optional deployment parameters that control how many tasks run during the deployment
      * 			and the ordering of stopping and starting tasks.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     deploymentConfiguration?: DeploymentConfiguration | undefined;
@@ -638,11 +642,13 @@ export interface UpdateServiceRequest {
      * 			the <i>
      *                <i>Amazon Elastic Container Service Developer Guide</i>
      *             </i>.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
     /**
      * <p>An object representing the network configuration for the service.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     networkConfiguration?: NetworkConfiguration | undefined;
@@ -654,6 +660,7 @@ export interface UpdateServiceRequest {
      * 			specify an empty array.</p>
      *          <p>You can specify a maximum of 10 constraints for each task. This limit includes
      * 			constraints in the task definition and those specified at runtime.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     placementConstraints?: PlacementConstraint[] | undefined;
@@ -663,6 +670,7 @@ export interface UpdateServiceRequest {
      * 			this value is specified, it will override the existing placement strategy defined for
      * 			the service. To remove an existing placement strategy, specify an empty object.</p>
      *          <p>You can specify a maximum of five strategy rules for each service.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     placementStrategy?: PlacementStrategy[] | undefined;
@@ -672,6 +680,7 @@ export interface UpdateServiceRequest {
      * 			is not specified, the <code>LATEST</code> platform version is used. For more
      * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
      * 				Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     platformVersion?: string | undefined;
@@ -695,6 +704,7 @@ export interface UpdateServiceRequest {
      * 			During that time, the Amazon ECS service scheduler ignores health check status. This grace
      * 			period can prevent the service scheduler from marking tasks as unhealthy and stopping
      * 			them before they have time to come up.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     healthCheckGracePeriodSeconds?: number | undefined;
@@ -708,6 +718,7 @@ export interface UpdateServiceRequest {
      * 			containers.</p>
      *          <p>If you do not want to override the value that was set when the service was created,
      * 			you can set this to <code>null</code> when performing this action.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     enableExecuteCommand?: boolean | undefined;
@@ -718,6 +729,7 @@ export interface UpdateServiceRequest {
      *          <p>Only tasks launched after the update will reflect the update. To update the tags on
      * 			all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
      * 			starts new tasks with the updated tags.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     enableECSManagedTags?: boolean | undefined;
@@ -746,6 +758,7 @@ export interface UpdateServiceRequest {
      * 			information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
      * 				multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
      *          <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     loadBalancers?: LoadBalancer[] | undefined;
@@ -755,6 +768,7 @@ export interface UpdateServiceRequest {
      *          <p>Only tasks launched after the update will reflect the update. To update the tags on
      * 			all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
      * 			starts new tasks with the updated tags.</p>
+     *          <p>This parameter doesn't trigger a new service deployment.</p>
      * @public
      */
     propagateTags?: PropagateTags | undefined;
@@ -774,6 +788,7 @@ export interface UpdateServiceRequest {
      * 			when the new tasks are running.</p>
      *          <p>You can remove existing <code>serviceRegistries</code> by passing an empty
      * 			list.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     serviceRegistries?: ServiceRegistry[] | undefined;
@@ -786,6 +801,7 @@ export interface UpdateServiceRequest {
      * 	that collects logs and metrics for increased visibility.
      * 	Only the tasks that Amazon ECS services create are supported with Service Connect.
      * 	For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
@@ -795,12 +811,14 @@ export interface UpdateServiceRequest {
      * 			must match the <code>name</code> from the task definition. If set to null, no new
      * 			deployment is triggered. Otherwise, if this configuration differs from the existing one,
      * 			it triggers a new deployment.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
     /**
      * <p>An object representing the VPC Lattice configuration for the service being
      * 			updated.</p>
+     *          <p>This parameter triggers a new service deployment.</p>
      * @public
      */
     vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ecs",
   "description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native",
-  "version": "3.872.0",
+  "version": "3.873.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-ecs",
@@ -20,17 +20,17 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "3.864.0",
-    "@aws-sdk/credential-provider-node": "3.872.0",
-    "@aws-sdk/middleware-host-header": "3.862.0",
-    "@aws-sdk/middleware-logger": "3.862.0",
-    "@aws-sdk/middleware-recursion-detection": "3.862.0",
-    "@aws-sdk/middleware-user-agent": "3.864.0",
-    "@aws-sdk/region-config-resolver": "3.862.0",
+    "@aws-sdk/core": "3.873.0",
+    "@aws-sdk/credential-provider-node": "3.873.0",
+    "@aws-sdk/middleware-host-header": "3.873.0",
+    "@aws-sdk/middleware-logger": "3.873.0",
+    "@aws-sdk/middleware-recursion-detection": "3.873.0",
+    "@aws-sdk/middleware-user-agent": "3.873.0",
+    "@aws-sdk/region-config-resolver": "3.873.0",
     "@aws-sdk/types": "3.862.0",
-    "@aws-sdk/util-endpoints": "3.862.0",
-    "@aws-sdk/util-user-agent-browser": "3.862.0",
-    "@aws-sdk/util-user-agent-node": "3.864.0",
+    "@aws-sdk/util-endpoints": "3.873.0",
+    "@aws-sdk/util-user-agent-browser": "3.873.0",
+    "@aws-sdk/util-user-agent-node": "3.873.0",
     "@smithy/config-resolver": "^4.1.5",
     "@smithy/core": "^3.8.0",
     "@smithy/fetch-http-handler": "^5.1.1",