aws-sdk-ecs 1.153.0 → 1.154.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 93ed3e7df1cbd25815a7d9537e41771a006a65f3556917d4edfca405ed509563
4
- data.tar.gz: 69fbffb5733e5e7e76da34d91936759af4df0ea368cda19e35e968c5fea8b0c7
3
+ metadata.gz: e734c03592e49fb9c2a46bec1d63252dfb820a6d791cec1aa09f753049c97d48
4
+ data.tar.gz: 238d3dca56e5376bfc7e206a9be293366f10958f37e185e9f203d031eba03a33
5
5
  SHA512:
6
- metadata.gz: 7ebd984cf41fa8096ae0a6c0408b44a29f41ef462652b3ea5c4897926a5479f918ad910d358f02655f00733f652be67254c7869346695da6233be650c92657fd
7
- data.tar.gz: 6212f970998f5d9046a2adac806f8d7d039d59670764f14c01b6f3e173087e02d9a9c13fc4e5d1dead17123f8f35a51a3cedf9325b4058e1ec5e40bb9f291ab0
6
+ metadata.gz: 5b0ef27eaf6d00ea5fa5172d73f656222494a7959f91abe5614867a17f934582da4ec3499de18a60d02cad0162f2275bed59ef7bd19262a7c2511a59f7d3b320
7
+ data.tar.gz: 1ae30c7e38521b13ca68d2c427e5bfba840f6f4cf9a2126f15628a3b82d542452e4634e876826c1b120930d4256559d728e961bd04977ab81ffe94871b59ae48
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.154.0 (2024-08-20)
5
+ ------------------
6
+
7
+ * Feature - Documentation only release to address various tickets
8
+
4
9
  1.153.0 (2024-08-15)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.153.0
1
+ 1.154.0
@@ -538,23 +538,23 @@ module Aws::ECS
538
538
 
539
539
  # Creates a new Amazon ECS cluster. By default, your account receives a
540
540
  # `default` cluster when you launch your first container instance.
541
- # However, you can create your own cluster with a unique name with the
542
- # `CreateCluster` action.
543
- #
544
- # <note markdown="1"> When you call the CreateCluster API operation, Amazon ECS attempts to
545
- # create the Amazon ECS service-linked role for your account. This is so
546
- # that it can manage required resources in other Amazon Web Services
547
- # services on your behalf. However, if the user that makes the call
548
- # doesn't have permissions to create the service-linked role, it isn't
549
- # created. For more information, see [Using service-linked roles for
550
- # Amazon ECS][1] in the *Amazon Elastic Container Service Developer
551
- # Guide*.
541
+ # However, you can create your own cluster with a unique name.
542
+ #
543
+ # <note markdown="1"> When you call the [CreateCluster][1] API operation, Amazon ECS
544
+ # attempts to create the Amazon ECS service-linked role for your
545
+ # account. This is so that it can manage required resources in other
546
+ # Amazon Web Services services on your behalf. However, if the user that
547
+ # makes the call doesn't have permissions to create the service-linked
548
+ # role, it isn't created. For more information, see [Using
549
+ # service-linked roles for Amazon ECS][2] in the *Amazon Elastic
550
+ # Container Service Developer Guide*.
552
551
  #
553
552
  # </note>
554
553
  #
555
554
  #
556
555
  #
557
- # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
556
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
557
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
558
558
  #
559
559
  # @option params [String] :cluster_name
560
560
  # The name of your cluster. If you don't specify a name for your
@@ -596,7 +596,12 @@ module Aws::ECS
596
596
  # The setting to use when creating a cluster. This parameter is used to
597
597
  # turn on CloudWatch Container Insights for a cluster. If this value is
598
598
  # specified, it overrides the `containerInsights` value set with
599
- # PutAccountSetting or PutAccountSettingDefault.
599
+ # [PutAccountSetting][1] or [PutAccountSettingDefault][2].
600
+ #
601
+ #
602
+ #
603
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
604
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
600
605
  #
601
606
  # @option params [Types::ClusterConfiguration] :configuration
602
607
  # The `execute` command configuration for the cluster.
@@ -638,12 +643,13 @@ module Aws::ECS
638
643
  #
639
644
  # If a default capacity provider strategy isn't defined for a cluster
640
645
  # when it was created, it can be defined later with the
641
- # PutClusterCapacityProviders API operation.
646
+ # [PutClusterCapacityProviders][3] API operation.
642
647
  #
643
648
  #
644
649
  #
645
650
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
646
651
  # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
652
+ # [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
647
653
  #
648
654
  # @option params [Types::ClusterServiceConnectDefaultsRequest] :service_connect_defaults
649
655
  # Use this parameter to set a default Service Connect namespace. After
@@ -794,8 +800,8 @@ module Aws::ECS
794
800
  # Runs and maintains your desired number of tasks from a specified task
795
801
  # definition. If the number of tasks running in a service drops below
796
802
  # the `desiredCount`, Amazon ECS runs another copy of the task in the
797
- # specified cluster. To update an existing service, see the
798
- # UpdateService action.
803
+ # specified cluster. To update an existing service, use
804
+ # [UpdateService][1].
799
805
  #
800
806
  # <note markdown="1"> On March 21, 2024, a change was made to resolve the task definition
801
807
  # revision before authorization. When a task definition revision is not
@@ -808,13 +814,13 @@ module Aws::ECS
808
814
  # you can optionally run your service behind one or more load balancers.
809
815
  # The load balancers distribute traffic across the tasks that are
810
816
  # associated with the service. For more information, see [Service load
811
- # balancing][1] in the *Amazon Elastic Container Service Developer
817
+ # balancing][2] in the *Amazon Elastic Container Service Developer
812
818
  # Guide*.
813
819
  #
814
820
  # You can attach Amazon EBS volumes to Amazon ECS tasks by configuring
815
821
  # the volume when creating or updating a service. `volumeConfigurations`
816
822
  # is only supported for REPLICA service and not DAEMON service. For more
817
- # infomation, see [Amazon EBS volumes][2] in the *Amazon Elastic
823
+ # infomation, see [Amazon EBS volumes][3] in the *Amazon Elastic
818
824
  # Container Service Developer Guide*.
819
825
  #
820
826
  # Tasks for services that don't use a load balancer are considered
@@ -829,7 +835,7 @@ module Aws::ECS
829
835
  # service scheduler spreads tasks across Availability Zones. You can
830
836
  # use task placement strategies and constraints to customize task
831
837
  # placement decisions. For more information, see [Service scheduler
832
- # concepts][3] in the *Amazon Elastic Container Service Developer
838
+ # concepts][4] in the *Amazon Elastic Container Service Developer
833
839
  # Guide*.
834
840
  #
835
841
  # * `DAEMON` - The daemon scheduling strategy deploys exactly one task
@@ -840,16 +846,16 @@ module Aws::ECS
840
846
  # constraints. When using this strategy, you don't need to specify a
841
847
  # desired number of tasks, a task placement strategy, or use Service
842
848
  # Auto Scaling policies. For more information, see [Service scheduler
843
- # concepts][3] in the *Amazon Elastic Container Service Developer
849
+ # concepts][4] in the *Amazon Elastic Container Service Developer
844
850
  # Guide*.
845
851
  #
846
852
  # You can optionally specify a deployment configuration for your
847
853
  # service. The deployment is initiated by changing properties. For
848
854
  # example, the deployment might be initiated by the task definition or
849
- # by your desired count of a service. This is done with an UpdateService
850
- # operation. The default value for a replica service for
851
- # `minimumHealthyPercent` is 100%. The default value for a daemon
852
- # service for `minimumHealthyPercent` is 0%.
855
+ # by your desired count of a service. You can use [UpdateService][1].
856
+ # The default value for a replica service for `minimumHealthyPercent` is
857
+ # 100%. The default value for a daemon service for
858
+ # `minimumHealthyPercent` is 0%.
853
859
  #
854
860
  # If a service uses the `ECS` deployment controller, the minimum healthy
855
861
  # percent represents a lower limit on the number of tasks in a service
@@ -895,13 +901,13 @@ module Aws::ECS
895
901
  # When creating a service that uses the `EXTERNAL` deployment
896
902
  # controller, you can specify only parameters that aren't controlled at
897
903
  # the task set level. The only required parameter is the service name.
898
- # You control your services using the CreateTaskSet operation. For more
899
- # information, see [Amazon ECS deployment types][4] in the *Amazon
904
+ # You control your services using the [CreateTaskSet][5]. For more
905
+ # information, see [Amazon ECS deployment types][6] in the *Amazon
900
906
  # Elastic Container Service Developer Guide*.
901
907
  #
902
908
  # When the service scheduler launches new tasks, it determines task
903
909
  # placement. For information about task placement and task placement
904
- # strategies, see [Amazon ECS task placement][5] in the *Amazon Elastic
910
+ # strategies, see [Amazon ECS task placement][7] in the *Amazon Elastic
905
911
  # Container Service Developer Guide*
906
912
  #
907
913
  # Starting April 15, 2023, Amazon Web Services will not onboard new
@@ -915,11 +921,13 @@ module Aws::ECS
915
921
  #
916
922
  #
917
923
  #
918
- # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
919
- # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
920
- # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
921
- # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
922
- # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html
924
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
925
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
926
+ # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
927
+ # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
928
+ # [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
929
+ # [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
930
+ # [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html
923
931
  #
924
932
  # @option params [String] :cluster
925
933
  # The short name or full Amazon Resource Name (ARN) of the cluster that
@@ -1811,8 +1819,8 @@ module Aws::ECS
1811
1819
  # A capacity provider strategy consists of one or more capacity
1812
1820
  # providers along with the `base` and `weight` to assign to them. A
1813
1821
  # capacity provider must be associated with the cluster to be used in a
1814
- # capacity provider strategy. The PutClusterCapacityProviders API is
1815
- # used to associate a capacity provider with a cluster. Only capacity
1822
+ # capacity provider strategy. The [PutClusterCapacityProviders][1] API
1823
+ # is used to associate a capacity provider with a cluster. Only capacity
1816
1824
  # providers with an `ACTIVE` or `UPDATING` status can be used.
1817
1825
  #
1818
1826
  # If a `capacityProviderStrategy` is specified, the `launchType`
@@ -1822,16 +1830,21 @@ module Aws::ECS
1822
1830
  #
1823
1831
  # If specifying a capacity provider that uses an Auto Scaling group, the
1824
1832
  # capacity provider must already be created. New capacity providers can
1825
- # be created with the CreateCapacityProvider API operation.
1833
+ # be created with the [CreateCapacityProviderProvider][2]API operation.
1826
1834
  #
1827
1835
  # To use a Fargate capacity provider, specify either the `FARGATE` or
1828
1836
  # `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
1829
1837
  # available to all accounts and only need to be associated with a
1830
1838
  # cluster to be used.
1831
1839
  #
1832
- # The PutClusterCapacityProviders API operation is used to update the
1833
- # list of available capacity providers for a cluster after the cluster
1834
- # is created.
1840
+ # The [PutClusterCapacityProviders][1] API operation is used to update
1841
+ # the list of available capacity providers for a cluster after the
1842
+ # cluster is created.
1843
+ #
1844
+ #
1845
+ #
1846
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
1847
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
1835
1848
  #
1836
1849
  # @option params [String] :platform_version
1837
1850
  # The platform version that the tasks in the task set uses. A platform
@@ -2126,20 +2139,26 @@ module Aws::ECS
2126
2139
  #
2127
2140
  # <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
2128
2141
  # can't be deleted. You can disassociate them from a cluster using
2129
- # either the PutClusterCapacityProviders API or by deleting the cluster.
2142
+ # either [PutCapacityProviderProviders][1] or by deleting the cluster.
2130
2143
  #
2131
2144
  # </note>
2132
2145
  #
2133
2146
  # Prior to a capacity provider being deleted, the capacity provider must
2134
2147
  # be removed from the capacity provider strategy from all services. The
2135
- # UpdateService API can be used to remove a capacity provider from a
2136
- # service's capacity provider strategy. When updating a service, the
2148
+ # [UpdateService][2] API can be used to remove a capacity provider from
2149
+ # a service's capacity provider strategy. When updating a service, the
2137
2150
  # `forceNewDeployment` option can be used to ensure that any tasks using
2138
2151
  # the Amazon EC2 instance capacity provided by the capacity provider are
2139
2152
  # transitioned to use the capacity from the remaining capacity
2140
2153
  # providers. Only capacity providers that aren't associated with a
2141
2154
  # cluster can be deleted. To remove a capacity provider from a cluster,
2142
- # you can either use PutClusterCapacityProviders or delete the cluster.
2155
+ # you can either use [PutCapacityProviderProviders][1] or delete the
2156
+ # cluster.
2157
+ #
2158
+ #
2159
+ #
2160
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html
2161
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
2143
2162
  #
2144
2163
  # @option params [required, String] :capacity_provider
2145
2164
  # The short name or full Amazon Resource Name (ARN) of the capacity
@@ -2191,8 +2210,13 @@ module Aws::ECS
2191
2210
  #
2192
2211
  # You must deregister all container instances from this cluster before
2193
2212
  # you may delete it. You can list the container instances in a cluster
2194
- # with ListContainerInstances and deregister them with
2195
- # DeregisterContainerInstance.
2213
+ # with [ListContainerInstances][1] and deregister them with
2214
+ # [DeregisterContainerInstance][2].
2215
+ #
2216
+ #
2217
+ #
2218
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html
2219
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html
2196
2220
  #
2197
2221
  # @option params [required, String] :cluster
2198
2222
  # The short name or full Amazon Resource Name (ARN) of the cluster to
@@ -2286,18 +2310,19 @@ module Aws::ECS
2286
2310
  # if you have no running tasks in it and the desired task count is zero.
2287
2311
  # If the service is actively maintaining tasks, you can't delete it,
2288
2312
  # and you must update the service to a desired task count of zero. For
2289
- # more information, see UpdateService.
2313
+ # more information, see [UpdateService][1].
2290
2314
  #
2291
2315
  # <note markdown="1"> When you delete a service, if there are still running tasks that
2292
2316
  # require cleanup, the service status moves from `ACTIVE` to `DRAINING`,
2293
2317
  # and the service is no longer visible in the console or in the
2294
- # ListServices API operation. After all tasks have transitioned to
2318
+ # [ListServices][2] API operation. After all tasks have transitioned to
2295
2319
  # either `STOPPING` or `STOPPED` status, the service status moves from
2296
2320
  # `DRAINING` to `INACTIVE`. Services in the `DRAINING` or `INACTIVE`
2297
- # status can still be viewed with the DescribeServices API operation.
2298
- # However, in the future, `INACTIVE` services may be cleaned up and
2299
- # purged from Amazon ECS record keeping, and DescribeServices calls on
2300
- # those services return a `ServiceNotFoundException` error.
2321
+ # status can still be viewed with the [DescribeServices][3] API
2322
+ # operation. However, in the future, `INACTIVE` services may be cleaned
2323
+ # up and purged from Amazon ECS record keeping, and
2324
+ # [DescribeServices][3] calls on those services return a
2325
+ # `ServiceNotFoundException` error.
2301
2326
  #
2302
2327
  # </note>
2303
2328
  #
@@ -2305,6 +2330,12 @@ module Aws::ECS
2305
2330
  # existing service in either `ACTIVE` or `DRAINING` status, you receive
2306
2331
  # an error.
2307
2332
  #
2333
+ #
2334
+ #
2335
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
2336
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
2337
+ # [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html
2338
+ #
2308
2339
  # @option params [String] :cluster
2309
2340
  # The short name or full Amazon Resource Name (ARN) of the cluster that
2310
2341
  # hosts the service to delete. If you do not specify a cluster, the
@@ -5021,9 +5052,14 @@ module Aws::ECS
5021
5052
  # @option params [String] :status
5022
5053
  # Filters the container instances by status. For example, if you specify
5023
5054
  # the `DRAINING` status, the results include only container instances
5024
- # that have been set to `DRAINING` using UpdateContainerInstancesState.
5025
- # If you don't specify this parameter, the default is to include
5026
- # container instances set to all states other than `INACTIVE`.
5055
+ # that have been set to `DRAINING` using
5056
+ # [UpdateContainerInstancesState][1]. If you don't specify this
5057
+ # parameter, the default is to include container instances set to all
5058
+ # states other than `INACTIVE`.
5059
+ #
5060
+ #
5061
+ #
5062
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
5027
5063
  #
5028
5064
  # @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5029
5065
  #
@@ -6036,12 +6072,13 @@ module Aws::ECS
6036
6072
  # Create or update an attribute on an Amazon ECS resource. If the
6037
6073
  # attribute doesn't exist, it's created. If the attribute exists, its
6038
6074
  # value is replaced with the specified value. To delete an attribute,
6039
- # use DeleteAttributes. For more information, see [Attributes][1] in the
6040
- # *Amazon Elastic Container Service Developer Guide*.
6075
+ # use [DeleteAttributes][1]. For more information, see [Attributes][2]
6076
+ # in the *Amazon Elastic Container Service Developer Guide*.
6041
6077
  #
6042
6078
  #
6043
6079
  #
6044
- # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
6080
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html
6081
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
6045
6082
  #
6046
6083
  # @option params [String] :cluster
6047
6084
  # The short name or full Amazon Resource Name (ARN) of the cluster that
@@ -6096,10 +6133,10 @@ module Aws::ECS
6096
6133
  # has existing capacity providers associated with it, you must specify
6097
6134
  # all existing capacity providers in addition to any new ones you want
6098
6135
  # to add. Any existing capacity providers that are associated with a
6099
- # cluster that are omitted from a PutClusterCapacityProviders API call
6100
- # will be disassociated with the cluster. You can only disassociate an
6101
- # existing capacity provider from a cluster if it's not being used by
6102
- # any existing tasks.
6136
+ # cluster that are omitted from a [PutClusterCapacityProviders][1] API
6137
+ # call will be disassociated with the cluster. You can only disassociate
6138
+ # an existing capacity provider from a cluster if it's not being used
6139
+ # by any existing tasks.
6103
6140
  #
6104
6141
  # When creating a service or running a task on a cluster, if no capacity
6105
6142
  # provider or launch type is specified, then the cluster's default
@@ -6107,6 +6144,10 @@ module Aws::ECS
6107
6144
  # default capacity provider strategy for your cluster. However, you must
6108
6145
  # specify an empty array (`[]`) to bypass defining a default strategy.
6109
6146
  #
6147
+ #
6148
+ #
6149
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
6150
+ #
6110
6151
  # @option params [required, String] :cluster
6111
6152
  # The short name or full Amazon Resource Name (ARN) of the cluster to
6112
6153
  # modify the capacity provider settings for. If you don't specify a
@@ -6118,13 +6159,17 @@ module Aws::ECS
6118
6159
  #
6119
6160
  # If specifying a capacity provider that uses an Auto Scaling group, the
6120
6161
  # capacity provider must already be created. New capacity providers can
6121
- # be created with the CreateCapacityProvider API operation.
6162
+ # be created with the [CreateCapacityProvider][1] API operation.
6122
6163
  #
6123
6164
  # To use a Fargate capacity provider, specify either the `FARGATE` or
6124
6165
  # `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
6125
6166
  # available to all accounts and only need to be associated with a
6126
6167
  # cluster to be used.
6127
6168
  #
6169
+ #
6170
+ #
6171
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
6172
+ #
6128
6173
  # @option params [required, Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
6129
6174
  # The capacity provider strategy to use by default for the cluster.
6130
6175
  #
@@ -6135,19 +6180,24 @@ module Aws::ECS
6135
6180
  # A capacity provider strategy consists of one or more capacity
6136
6181
  # providers along with the `base` and `weight` to assign to them. A
6137
6182
  # capacity provider must be associated with the cluster to be used in a
6138
- # capacity provider strategy. The PutClusterCapacityProviders API is
6139
- # used to associate a capacity provider with a cluster. Only capacity
6183
+ # capacity provider strategy. The [PutClusterCapacityProviders][1] API
6184
+ # is used to associate a capacity provider with a cluster. Only capacity
6140
6185
  # providers with an `ACTIVE` or `UPDATING` status can be used.
6141
6186
  #
6142
6187
  # If specifying a capacity provider that uses an Auto Scaling group, the
6143
6188
  # capacity provider must already be created. New capacity providers can
6144
- # be created with the CreateCapacityProvider API operation.
6189
+ # be created with the [CreateCapacityProvider][2] API operation.
6145
6190
  #
6146
6191
  # To use a Fargate capacity provider, specify either the `FARGATE` or
6147
6192
  # `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
6148
6193
  # available to all accounts and only need to be associated with a
6149
6194
  # cluster to be used.
6150
6195
  #
6196
+ #
6197
+ #
6198
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
6199
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
6200
+ #
6151
6201
  # @return [Types::PutClusterCapacityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6152
6202
  #
6153
6203
  # * {Types::PutClusterCapacityProvidersResponse#cluster #cluster} => Types::Cluster
@@ -6419,16 +6469,17 @@ module Aws::ECS
6419
6469
  # You can specify a Docker networking mode for the containers in your
6420
6470
  # task definition with the `networkMode` parameter. If you specify the
6421
6471
  # `awsvpc` network mode, the task is allocated an elastic network
6422
- # interface, and you must specify a NetworkConfiguration when you create
6423
- # a service or run a task with the task definition. For more
6424
- # information, see [Task Networking][3] in the *Amazon Elastic Container
6472
+ # interface, and you must specify a [NetworkConfiguration][3] when you
6473
+ # create a service or run a task with the task definition. For more
6474
+ # information, see [Task Networking][4] in the *Amazon Elastic Container
6425
6475
  # Service Developer Guide*.
6426
6476
  #
6427
6477
  #
6428
6478
  #
6429
6479
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html
6430
6480
  # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
6431
- # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
6481
+ # [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
6482
+ # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
6432
6483
  #
6433
6484
  # @option params [required, String] :family
6434
6485
  # You must specify a `family` for a task definition. You can use it
@@ -7260,7 +7311,7 @@ module Aws::ECS
7260
7311
  # strategies. For more information, see [Scheduling Tasks][1] in the
7261
7312
  # *Amazon Elastic Container Service Developer Guide*.
7262
7313
  #
7263
- # Alternatively, you can use StartTask to use your own scheduler or
7314
+ # Alternatively, you can use `StartTask` to use your own scheduler or
7264
7315
  # place tasks manually on specific container instances.
7265
7316
  #
7266
7317
  # Starting April 15, 2023, Amazon Web Services will not onboard new
@@ -7429,13 +7480,17 @@ module Aws::ECS
7429
7480
  # Specifies whether to propagate the tags from the task definition to
7430
7481
  # the task. If no value is specified, the tags aren't propagated. Tags
7431
7482
  # can only be propagated to the task during task creation. To add tags
7432
- # to a task after task creation, use the TagResource API action.
7483
+ # to a task after task creation, use the[TagResource][1] API action.
7433
7484
  #
7434
7485
  # <note markdown="1"> An error will be received if you specify the `SERVICE` option when
7435
7486
  # running a task.
7436
7487
  #
7437
7488
  # </note>
7438
7489
  #
7490
+ #
7491
+ #
7492
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
7493
+ #
7439
7494
  # @option params [String] :reference_id
7440
7495
  # The reference ID to use for the task. The reference ID can have a
7441
7496
  # maximum length of 1024 characters.
@@ -7844,7 +7899,7 @@ module Aws::ECS
7844
7899
  # at least once during the past 30-day period are considered current
7845
7900
  # customers and will be able to continue using the service.
7846
7901
  #
7847
- # Alternatively, you can use RunTask to place tasks for you. For more
7902
+ # Alternatively, you can use`RunTask` to place tasks for you. For more
7848
7903
  # information, see [Scheduling Tasks][1] in the *Amazon Elastic
7849
7904
  # Container Service Developer Guide*.
7850
7905
  #
@@ -8208,7 +8263,7 @@ module Aws::ECS
8208
8263
  # Stops a running task. Any tags associated with the task will be
8209
8264
  # deleted.
8210
8265
  #
8211
- # When StopTask is called on a task, the equivalent of `docker stop` is
8266
+ # When you call `StopTask` on a task, the equivalent of `docker stop` is
8212
8267
  # issued to the containers running in the task. This results in a
8213
8268
  # `SIGTERM` value and a default 30-second timeout, after which the
8214
8269
  # `SIGKILL` value is sent and the containers are forcibly stopped. If
@@ -8244,7 +8299,11 @@ module Aws::ECS
8244
8299
  # An optional message specified when a task is stopped. For example, if
8245
8300
  # you're using a custom scheduler, you can use this parameter to
8246
8301
  # specify the reason for stopping the task here, and the message appears
8247
- # in subsequent DescribeTasks API operations on this task.
8302
+ # in subsequent [DescribeTasks][1]&gt; API operations on this task.
8303
+ #
8304
+ #
8305
+ #
8306
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
8248
8307
  #
8249
8308
  # @return [Types::StopTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8250
8309
  #
@@ -8904,7 +8963,7 @@ module Aws::ECS
8904
8963
  # The setting to use by default for a cluster. This parameter is used to
8905
8964
  # turn on CloudWatch Container Insights for a cluster. If this value is
8906
8965
  # specified, it overrides the `containerInsights` value set with
8907
- # PutAccountSetting or PutAccountSettingDefault.
8966
+ # [PutAccountSetting][1] or [PutAccountSettingDefault][2].
8908
8967
  #
8909
8968
  # Currently, if you delete an existing cluster that does not have
8910
8969
  # Container Insights turned on, and then create a new cluster with the
@@ -8913,6 +8972,11 @@ module Aws::ECS
8913
8972
  # your existing cluster and turn on Container Insights, you must wait 7
8914
8973
  # days before you can re-create it.
8915
8974
  #
8975
+ #
8976
+ #
8977
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
8978
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
8979
+ #
8916
8980
  # @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8917
8981
  #
8918
8982
  # * {Types::UpdateClusterSettingsResponse#cluster #cluster} => Types::Cluster
@@ -9121,7 +9185,7 @@ module Aws::ECS
9121
9185
  # state are stopped and replaced according to the service's deployment
9122
9186
  # configuration parameters, `minimumHealthyPercent` and
9123
9187
  # `maximumPercent`. You can change the deployment configuration of your
9124
- # service using UpdateService.
9188
+ # service using [UpdateService][1].
9125
9189
  #
9126
9190
  # * If `minimumHealthyPercent` is below 100%, the scheduler can ignore
9127
9191
  # `desiredCount` temporarily during task replacement. For example,
@@ -9148,7 +9212,7 @@ module Aws::ECS
9148
9212
  # manually.
9149
9213
  #
9150
9214
  # A container instance has completed draining when it has no more
9151
- # `RUNNING` tasks. You can verify this using [ListTasks][1].
9215
+ # `RUNNING` tasks. You can verify this using [ListTasks][2].
9152
9216
  #
9153
9217
  # When a container instance has been drained, you can set a container
9154
9218
  # instance to `ACTIVE` status and once it has reached that status the
@@ -9156,7 +9220,8 @@ module Aws::ECS
9156
9220
  #
9157
9221
  #
9158
9222
  #
9159
- # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
9223
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
9224
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
9160
9225
  #
9161
9226
  # @option params [String] :cluster
9162
9227
  # The short name or full Amazon Resource Name (ARN) of the cluster that
@@ -9298,7 +9363,7 @@ module Aws::ECS
9298
9363
  # propagate tags option, using this API. If the launch type, load
9299
9364
  # balancer, network configuration, platform version, or task definition
9300
9365
  # need to be updated, create a new task set For more information, see
9301
- # CreateTaskSet.
9366
+ # [CreateTaskSet][3].
9302
9367
  #
9303
9368
  # You can add to or subtract from the number of instantiations of a task
9304
9369
  # definition in a service by specifying the cluster that the service is
@@ -9347,12 +9412,12 @@ module Aws::ECS
9347
9412
  # the four older tasks (provided that the cluster resources required
9348
9413
  # to do this are available).
9349
9414
  #
9350
- # When UpdateService stops a task during a deployment, the equivalent of
9351
- # `docker stop` is issued to the containers running in the task. This
9352
- # results in a `SIGTERM` and a 30-second timeout. After this, `SIGKILL`
9353
- # is sent and the containers are forcibly stopped. If the container
9354
- # handles the `SIGTERM` gracefully and exits within 30 seconds from
9355
- # receiving it, no `SIGKILL` is sent.
9415
+ # When [UpdateService][4] stops a task during a deployment, the
9416
+ # equivalent of `docker stop` is issued to the containers running in the
9417
+ # task. This results in a `SIGTERM` and a 30-second timeout. After this,
9418
+ # `SIGKILL` is sent and the containers are forcibly stopped. If the
9419
+ # container handles the `SIGTERM` gracefully and exits within 30 seconds
9420
+ # from receiving it, no `SIGKILL` is sent.
9356
9421
  #
9357
9422
  # When the service scheduler launches new tasks, it determines task
9358
9423
  # placement in your cluster with the following logic.
@@ -9398,7 +9463,7 @@ module Aws::ECS
9398
9463
  # * `serviceRegistries`
9399
9464
  #
9400
9465
  # For more information about the role see the `CreateService` request
9401
- # parameter [ `role` ][3].
9466
+ # parameter [ `role` ][5].
9402
9467
  #
9403
9468
  # </note>
9404
9469
  #
@@ -9406,7 +9471,9 @@ module Aws::ECS
9406
9471
  #
9407
9472
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
9408
9473
  # [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
9409
- # [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
9474
+ # [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
9475
+ # [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
9476
+ # [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
9410
9477
  #
9411
9478
  # @option params [String] :cluster
9412
9479
  # The short name or full Amazon Resource Name (ARN) of the cluster that
@@ -9441,22 +9508,29 @@ module Aws::ECS
9441
9508
  # A capacity provider strategy consists of one or more capacity
9442
9509
  # providers along with the `base` and `weight` to assign to them. A
9443
9510
  # capacity provider must be associated with the cluster to be used in a
9444
- # capacity provider strategy. The PutClusterCapacityProviders API is
9445
- # used to associate a capacity provider with a cluster. Only capacity
9511
+ # capacity provider strategy. The [PutClusterCapacityProviders][1] API
9512
+ # is used to associate a capacity provider with a cluster. Only capacity
9446
9513
  # providers with an `ACTIVE` or `UPDATING` status can be used.
9447
9514
  #
9448
9515
  # If specifying a capacity provider that uses an Auto Scaling group, the
9449
9516
  # capacity provider must already be created. New capacity providers can
9450
- # be created with the CreateCapacityProvider API operation.
9517
+ # be created with the [CreateClusterCapacityProvider][2] API operation.
9451
9518
  #
9452
9519
  # To use a Fargate capacity provider, specify either the `FARGATE` or
9453
9520
  # `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
9454
9521
  # available to all accounts and only need to be associated with a
9455
9522
  # cluster to be used.
9456
9523
  #
9457
- # The PutClusterCapacityProviders API operation is used to update the
9458
- # list of available capacity providers for a cluster after the cluster
9459
- # is created.
9524
+ # The [PutClusterCapacityProviders][1]API operation is used to update
9525
+ # the list of available capacity providers for a cluster after the
9526
+ # cluster is created.
9527
+ #
9528
+ #
9529
+ #
9530
+ #
9531
+ #
9532
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
9533
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
9460
9534
  #
9461
9535
  # @option params [Types::DeploymentConfiguration] :deployment_configuration
9462
9536
  # Optional deployment parameters that control how many tasks run during
@@ -10348,7 +10422,7 @@ module Aws::ECS
10348
10422
  params: params,
10349
10423
  config: config)
10350
10424
  context[:gem_name] = 'aws-sdk-ecs'
10351
- context[:gem_version] = '1.153.0'
10425
+ context[:gem_version] = '1.154.0'
10352
10426
  Seahorse::Client::Request.new(handlers, context)
10353
10427
  end
10354
10428