aws-sdk-ecs 1.200.0 → 1.202.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d097768e4a9e119d2a9443af7afb6a0d8215de115ebdab38e2d3ac0642ba2ab
-  data.tar.gz: 45866a349f84a021e42c08a55bbbc66c1c0ee3130f3d658ee35e8aeb2e7c5dfa
+  metadata.gz: 8c9a4053bc597705953a6a3021ca1fcd70ee36e1dd1d5219d09409c0b1d6a0ba
+  data.tar.gz: 0d56a3497cbcae57da05a88b63c152008fafc385f4691418c8858ed968f18287
 SHA512:
-  metadata.gz: d8e420aa529d0eb9a9d0f5f2ac000209d0eb2efec0fd9dd0ec3cd04482048193343e0dec7d24c78e358774d518082e82e3ecb8330a383c296dbf0c10bf919102
-  data.tar.gz: e868e009184f07571bd26b74592496fe699d9b31b4d2e7af4509d15b85b36ff5425010a30e734d52e2fa1c545eea05c017fb00f78046ebffc3d3f3535482d470
+  metadata.gz: bc66adc9a5ded47c12663861988e7cfde2d79f6a32796fae1d24075f3e74c681ef728eced8720413311cfd8a2e629aa0eb07284339866326048ba736edff9624
+  data.tar.gz: 25a912566fde3700834ffbd6362d1227bd13c2dea00dc3c2d67d7d4be81c4a8878ce2a8bda4d09113b47c593cda0c1a4757233f2a39f6268654095cdd92fd195

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.202.0 (2025-08-21)
+------------------
+
+* Feature - This is a documentation only release that adds additional information for the update-service request parameters.
+
+1.201.0 (2025-08-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.200.0 (2025-07-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.200.0
+1.202.0

data/lib/aws-sdk-ecs/client.rb

@@ -95,8 +95,8 @@ module Aws::ECS
     #     class name or an instance of a plugin class.
     #
     #   @option options [required, Aws::CredentialProvider] :credentials
-    #     Your AWS credentials used for authentication. This can be an instance of any one of the
-    #     following classes:
+    #     Your AWS credentials used for authentication. This can be any class that includes and implements
+    #     `Aws::CredentialProvider`, or instance of any one of the following classes:
     #
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
@@ -124,8 +124,7 @@ module Aws::ECS
     #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
     #       from the Cognito Identity service.
     #
-    #     When `:credentials` are not configured directly, the following
-    #     locations will be searched for credentials:
+    #     When `:credentials` are not configured directly, the following locations will be searched for credentials:
     #
     #     * `Aws.config[:credentials]`
     #
@@ -139,12 +138,10 @@ module Aws::ECS
     #
     #     * `~/.aws/config`
     #
-    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
-    #       are very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts. Instance profile credential
-    #       fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
-    #       to `true`.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
+    #       Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts. Instance profile credential fetching can be disabled by
+    #       setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -384,8 +381,8 @@ module Aws::ECS
     #     `Aws::Telemetry::OTelProvider` for telemetry provider.
     #
     #   @option options [Aws::TokenProvider] :token_provider
-    #     Your Bearer token used for authentication. This can be an instance of any one of the
-    #     following classes:
+    #     Your Bearer token used for authentication. This can be any class that includes and implements
+    #     `Aws::TokenProvider`, or instance of any one of the following classes:
     #
     #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
     #       tokens.
@@ -5283,8 +5280,7 @@ module Aws::ECS
     # @option params [String] :cluster
     #   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
-    #   `default` cluster is used.
+    #   the default cluster is assumed.
     #
     # @option params [required, Array<String>] :tasks
     #   A list of up to 100 task IDs or full ARN entries.
@@ -11641,6 +11637,8 @@ module Aws::ECS
     #   The number of instantiations of the task to place and keep running in
     #   your service.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [String] :task_definition
     #   The `family` and `revision` (`family:revision`) or full ARN of the
     #   task definition to run in your service. If a `revision` is not
@@ -11649,6 +11647,8 @@ module Aws::ECS
     #   the new version of the task definition and then stops an old task
     #   after the new version is running.
     #
+    #   This parameter triggers a new service deployment.
+    #
     # @option params [Array<Types::CapacityProviderStrategyItem>] :capacity_provider_strategy
     #   The details of a capacity provider strategy. You can set a capacity
     #   provider when you create a cluster, run a task, or update a service.
@@ -11683,6 +11683,8 @@ module Aws::ECS
     #   For information about Amazon Web Services CDK considerations, see
     #   [Amazon Web Services CDK considerations][1].
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html
@@ -11691,6 +11693,8 @@ module Aws::ECS
     #   Optional deployment parameters that control how many tasks run during
     #   the deployment and the ordering of stopping and starting tasks.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [String] :availability_zone_rebalancing
     #   Indicates whether to use Availability Zone rebalancing for the
     #   service.
@@ -11699,6 +11703,8 @@ module Aws::ECS
     #   Availability Zones][1] in the <i> <i>Amazon Elastic Container Service
     #   Developer Guide</i> </i>.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
@@ -11706,6 +11712,8 @@ module Aws::ECS
     # @option params [Types::NetworkConfiguration] :network_configuration
     #   An object representing the network configuration for the service.
     #
+    #   This parameter triggers a new service deployment.
+    #
     # @option params [Array<Types::PlacementConstraint>] :placement_constraints
     #   An array of task placement constraint objects to update the service to
     #   use. If no value is specified, the existing placement constraints for
@@ -11717,6 +11725,8 @@ module Aws::ECS
     #   includes constraints in the task definition and those specified at
     #   runtime.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [Array<Types::PlacementStrategy>] :placement_strategy
     #   The task placement strategy objects to update the service to use. If
     #   no value is specified, the existing placement strategy for the service
@@ -11726,6 +11736,8 @@ module Aws::ECS
     #
     #   You can specify a maximum of five strategy rules for each service.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [String] :platform_version
     #   The platform version that your tasks in the service run on. A platform
     #   version is only specified for tasks using the Fargate launch type. If
@@ -11733,6 +11745,8 @@ module Aws::ECS
     #   used. For more information, see [Fargate Platform Versions][1] in the
     #   *Amazon Elastic Container Service Developer Guide*.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
@@ -11760,6 +11774,8 @@ module Aws::ECS
     #   can prevent the service scheduler from marking tasks as unhealthy and
     #   stopping them before they have time to come up.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [Types::DeploymentController] :deployment_controller
     #   The deployment controller to use for the service.
     #
@@ -11770,6 +11786,8 @@ module Aws::ECS
     #   If you do not want to override the value that was set when the service
     #   was created, you can set this to `null` when performing this action.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [Boolean] :enable_ecs_managed_tags
     #   Determines whether to turn on Amazon ECS managed tags for the tasks in
     #   the service. For more information, see [Tagging Your Amazon ECS
@@ -11780,6 +11798,8 @@ module Aws::ECS
     #   update the tags on all tasks, set `forceNewDeployment` to `true`, so
     #   that Amazon ECS starts new tasks with the updated tags.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
@@ -11820,6 +11840,8 @@ module Aws::ECS
     #
     #   You can remove existing `loadBalancers` by passing an empty list.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html
@@ -11834,6 +11856,8 @@ module Aws::ECS
     #   update the tags on all tasks, set `forceNewDeployment` to `true`, so
     #   that Amazon ECS starts new tasks with the updated tags.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     # @option params [Array<Types::ServiceRegistry>] :service_registries
     #   <note markdown="1"> You must have a service-linked role when you update this property.
     #
@@ -11852,6 +11876,8 @@ module Aws::ECS
     #
     #   You can remove existing `serviceRegistries` by passing an empty list.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
@@ -11870,6 +11896,8 @@ module Aws::ECS
     #   Service Connect. For more information, see [Service Connect][1] in the
     #   *Amazon Elastic Container Service Developer Guide*.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
@@ -11882,6 +11910,8 @@ module Aws::ECS
     #   null, no new deployment is triggered. Otherwise, if this configuration
     #   differs from the existing one, it triggers a new deployment.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html
@@ -11890,6 +11920,8 @@ module Aws::ECS
     #   An object representing the VPC Lattice configuration for the service
     #   being updated.
     #
+    #   This parameter triggers a new service deployment.
+    #
     # @return [Types::UpdateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateServiceResponse#service #service} => Types::Service
@@ -12782,7 +12814,7 @@ module Aws::ECS
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-ecs'
-      context[:gem_version] = '1.200.0'
+      context[:gem_version] = '1.202.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-ecs/types.rb

@@ -492,20 +492,52 @@ module Aws::ECS
     #   `RunTask` or `CreateService` actions using the capacity provider
     #   strategy will fail.
     #
-    #   An example scenario for using weights is defining a strategy that
-    #   contains two capacity providers and both have a weight of `1`, then
-    #   when the `base` is satisfied, the tasks will be split evenly across
-    #   the two capacity providers. Using that same logic, if you specify a
-    #   weight of `1` for *capacityProviderA* and a weight of `4` for
-    #   *capacityProviderB*, then for every one task that's run using
-    #   *capacityProviderA*, four tasks would use *capacityProviderB*.
+    #   Weight value characteristics:
+    #
+    #   * Weight is considered after the base value is satisfied
+    #
+    #   * Default value is `0` if not specified
+    #
+    #   * Valid range: 0 to 1,000
+    #
+    #   * At least one capacity provider must have a weight greater than
+    #     zero
+    #
+    #   * Capacity providers with weight of `0` cannot place tasks
+    #
+    #   Task distribution logic:
+    #
+    #   1.  Base satisfaction: The minimum number of tasks specified by the
+    #       base value are placed on that capacity provider
+    #
+    #   2.  Weight distribution: After base requirements are met, additional
+    #       tasks are distributed according to weight ratios
+    #
+    #   Examples:
+    #
+    #   Equal Distribution: Two capacity providers both with weight `1` will
+    #   split tasks evenly after base requirements are met.
+    #
+    #   Weighted Distribution: If capacityProviderA has weight `1` and
+    #   capacityProviderB has weight `4`, then for every 1 task on A, 4
+    #   tasks will run on B.
     #   @return [Integer]
     #
     # @!attribute [rw] base
     #   The *base* value designates how many tasks, at a minimum, to run on
-    #   the specified capacity provider. Only one capacity provider in a
-    #   capacity provider strategy can have a *base* defined. If no value is
-    #   specified, the default value of `0` is used.
+    #   the specified capacity provider for each service. Only one capacity
+    #   provider in a capacity provider strategy can have a *base* defined.
+    #   If no value is specified, the default value of `0` is used.
+    #
+    #   Base value characteristics:
+    #
+    #   * Only one capacity provider in a strategy can have a base defined
+    #
+    #   * Default value is `0` if not specified
+    #
+    #   * Valid range: 0 to 100,000
+    #
+    #   * Base requirements are satisfied first before weight distribution
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CapacityProviderStrategyItem AWS API Documentation
@@ -608,7 +640,7 @@ module Aws::ECS
     #
     # @!attribute [rw] active_services_count
     #   The number of services that are running on the cluster in an
-    #   `ACTIVE` state. You can view these services with [PListServices][1].
+    #   `ACTIVE` state. You can view these services with [ListServices][1].
     #
     #
     #
@@ -4775,8 +4807,7 @@ module Aws::ECS
     # @!attribute [rw] cluster
     #   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 `default` cluster is used.
+    #   cluster, the default cluster is assumed.
     #   @return [String]
     #
     # @!attribute [rw] tasks
@@ -7327,7 +7358,7 @@ module Aws::ECS
     #
     #   : Required: No
     #
-    #     Default value: `1m`
+    #     Default value: `10m`
     #
     #     When `non-blocking` mode is used, the `max-buffer-size` log option
     #     controls the size of the buffer that's used for intermediate
@@ -7502,12 +7533,6 @@ module Aws::ECS
     #   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.
-    #
-    #   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.
     #   @return [Integer]
     #
     # @!attribute [rw] maximum_scaling_step_size
@@ -13847,6 +13872,8 @@ module Aws::ECS
     # @!attribute [rw] desired_count
     #   The number of instantiations of the task to place and keep running
     #   in your service.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [Integer]
     #
     # @!attribute [rw] task_definition
@@ -13856,6 +13883,8 @@ module Aws::ECS
     #   task definition with `UpdateService`, 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.
+    #
+    #   This parameter triggers a new service deployment.
     #   @return [String]
     #
     # @!attribute [rw] capacity_provider_strategy
@@ -13892,6 +13921,8 @@ module Aws::ECS
     #   For information about Amazon Web Services CDK considerations, see
     #   [Amazon Web Services CDK considerations][1].
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html
@@ -13901,6 +13932,8 @@ module Aws::ECS
     #   Optional deployment parameters that control how many tasks run
     #   during the deployment and the ordering of stopping and starting
     #   tasks.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [Types::DeploymentConfiguration]
     #
     # @!attribute [rw] availability_zone_rebalancing
@@ -13911,6 +13944,8 @@ module Aws::ECS
     #   Availability Zones][1] in the <i> <i>Amazon Elastic Container
     #   Service Developer Guide</i> </i>.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
@@ -13918,6 +13953,8 @@ module Aws::ECS
     #
     # @!attribute [rw] network_configuration
     #   An object representing the network configuration for the service.
+    #
+    #   This parameter triggers a new service deployment.
     #   @return [Types::NetworkConfiguration]
     #
     # @!attribute [rw] placement_constraints
@@ -13931,6 +13968,8 @@ module Aws::ECS
     #   You can specify a maximum of 10 constraints for each task. This
     #   limit includes constraints in the task definition and those
     #   specified at runtime.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [Array<Types::PlacementConstraint>]
     #
     # @!attribute [rw] placement_strategy
@@ -13941,6 +13980,8 @@ module Aws::ECS
     #   remove an existing placement strategy, specify an empty object.
     #
     #   You can specify a maximum of five strategy rules for each service.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [Array<Types::PlacementStrategy>]
     #
     # @!attribute [rw] platform_version
@@ -13951,6 +13992,8 @@ module Aws::ECS
     #   Platform Versions][1] in the *Amazon Elastic Container Service
     #   Developer Guide*.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
@@ -13979,6 +14022,8 @@ module Aws::ECS
     #   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.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [Integer]
     #
     # @!attribute [rw] deployment_controller
@@ -13992,6 +14037,8 @@ module Aws::ECS
     #   If you do not want to override the value that was set when the
     #   service was created, you can set this to `null` when performing this
     #   action.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [Boolean]
     #
     # @!attribute [rw] enable_ecs_managed_tags
@@ -14004,6 +14051,8 @@ module Aws::ECS
     #   update the tags on all tasks, set `forceNewDeployment` to `true`, so
     #   that Amazon ECS starts new tasks with the updated tags.
     #
+    #   This parameter doesn't trigger a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
@@ -14045,6 +14094,8 @@ module Aws::ECS
     #
     #   You can remove existing `loadBalancers` by passing an empty list.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html
@@ -14059,6 +14110,8 @@ module Aws::ECS
     #   Only tasks launched after the update will reflect the update. To
     #   update the tags on all tasks, set `forceNewDeployment` to `true`, so
     #   that Amazon ECS starts new tasks with the updated tags.
+    #
+    #   This parameter doesn't trigger a new service deployment.
     #   @return [String]
     #
     # @!attribute [rw] service_registries
@@ -14080,6 +14133,8 @@ module Aws::ECS
     #   You can remove existing `serviceRegistries` by passing an empty
     #   list.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
@@ -14100,6 +14155,8 @@ module Aws::ECS
     #   Connect][1] in the *Amazon Elastic Container Service Developer
     #   Guide*.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
@@ -14114,6 +14171,8 @@ module Aws::ECS
     #   configuration differs from the existing one, it triggers a new
     #   deployment.
     #
+    #   This parameter triggers a new service deployment.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html
@@ -14122,6 +14181,8 @@ module Aws::ECS
     # @!attribute [rw] vpc_lattice_configurations
     #   An object representing the VPC Lattice configuration for the service
     #   being updated.
+    #
+    #   This parameter triggers a new service deployment.
     #   @return [Array<Types::VpcLatticeConfiguration>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServiceRequest AWS API Documentation

data/lib/aws-sdk-ecs.rb

@@ -55,7 +55,7 @@ module Aws::ECS
   autoload :EndpointProvider, 'aws-sdk-ecs/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-ecs/endpoints'
 
-  GEM_VERSION = '1.200.0'
+  GEM_VERSION = '1.202.0'
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ecs
 version: !ruby/object:Gem::Version
-  version: 1.200.0
+  version: 1.202.0
 platform: ruby
 authors:
 - Amazon Web Services