aws-sdk-ecs 1.89.0 → 1.93.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.
@@ -10,7 +10,7 @@
10
10
  module Aws::ECS
11
11
  module Types
12
12
 
13
- # You do not have authorization to perform the requested action.
13
+ # You don't have authorization to perform the requested action.
14
14
  #
15
15
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AccessDeniedException AWS API Documentation
16
16
  #
@@ -76,9 +76,9 @@ module Aws::ECS
76
76
  include Aws::Structure
77
77
  end
78
78
 
79
- # An attribute is a name-value pair associated with an Amazon ECS
80
- # object. Attributes enable you to extend the Amazon ECS data model by
81
- # adding custom metadata to your resources. For more information, see
79
+ # An attribute is a name-value pair that's associated with an Amazon
80
+ # ECS object. Attributes enable you to extend the Amazon ECS data model
81
+ # by adding custom metadata to your resources. For more information, see
82
82
  # [Attributes][1] in the *Amazon Elastic Container Service Developer
83
83
  # Guide*.
84
84
  #
@@ -98,23 +98,23 @@ module Aws::ECS
98
98
  #
99
99
  # @!attribute [rw] name
100
100
  # The name of the attribute. The `name` must contain between 1 and 128
101
- # characters and name may contain letters (uppercase and lowercase),
102
- # numbers, hyphens, underscores, forward slashes, back slashes, or
103
- # periods.
101
+ # characters. The name may contain letters (uppercase and lowercase),
102
+ # numbers, hyphens (-), underscores (\_), forward slashes (/), back
103
+ # slashes (\\), or periods (.).
104
104
  # @return [String]
105
105
  #
106
106
  # @!attribute [rw] value
107
107
  # The value of the attribute. The `value` must contain between 1 and
108
- # 128 characters and may contain letters (uppercase and lowercase),
109
- # numbers, hyphens, underscores, periods, at signs (@), forward
110
- # slashes, back slashes, colons, or spaces. The value cannot contain
111
- # any leading or trailing whitespace.
108
+ # 128 characters. It can contain letters (uppercase and lowercase),
109
+ # numbers, hyphens (-), underscores (\_), periods (.), at signs (@),
110
+ # forward slashes (/), back slashes (\\), colons (:), or spaces. The
111
+ # value can't can't start or end with a space.
112
112
  # @return [String]
113
113
  #
114
114
  # @!attribute [rw] target_type
115
- # The type of the target with which to attach the attribute. This
116
- # parameter is required if you use the short form ID for a resource
117
- # instead of the full ARN.
115
+ # The type of the target to attach the attribute with. This parameter
116
+ # is required if you use the short form ID for a resource instead of
117
+ # the full ARN.
118
118
  # @return [String]
119
119
  #
120
120
  # @!attribute [rw] target_id
@@ -133,8 +133,8 @@ module Aws::ECS
133
133
  include Aws::Structure
134
134
  end
135
135
 
136
- # You can apply up to 10 custom attributes per resource. You can view
137
- # the attributes of a resource with ListAttributes. You can remove
136
+ # You can apply up to 10 custom attributes for each resource. You can
137
+ # view the attributes of a resource with ListAttributes. You can remove
138
138
  # existing attributes on a resource with DeleteAttributes.
139
139
  #
140
140
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AttributeLimitExceededException AWS API Documentation
@@ -174,7 +174,7 @@ module Aws::ECS
174
174
  # Scaling group has managed termination protection.
175
175
  #
176
176
  # When using managed termination protection, managed scaling must also
177
- # be used otherwise managed termination protection will not work.
177
+ # be used otherwise managed termination protection doesn't work.
178
178
  #
179
179
  # When managed termination protection is enabled, Amazon ECS prevents
180
180
  # the Amazon EC2 instances in an Auto Scaling group that contain tasks
@@ -185,7 +185,7 @@ module Aws::ECS
185
185
  # Guide*.
186
186
  #
187
187
  # When managed termination protection is disabled, your Amazon EC2
188
- # instances are not protected from termination when the Auto Scaling
188
+ # instances aren't protected from termination when the Auto Scaling
189
189
  # group scales in.
190
190
  #
191
191
  #
@@ -230,18 +230,17 @@ module Aws::ECS
230
230
  # Scaling group has managed termination protection.
231
231
  #
232
232
  # When using managed termination protection, managed scaling must also
233
- # be used otherwise managed termination protection will not work.
233
+ # be used otherwise managed termination protection doesn't work.
234
234
  #
235
235
  # When managed termination protection is enabled, Amazon ECS prevents
236
236
  # the Amazon EC2 instances in an Auto Scaling group that contain tasks
237
237
  # from being terminated during a scale-in action. The Auto Scaling
238
238
  # group and each instance in the Auto Scaling group must have instance
239
- # protection from scale-in actions enabled as well. For more
240
- # information, see [Instance Protection][1] in the *Auto Scaling User
241
- # Guide*.
239
+ # protection from scale-in actions enabled. For more information, see
240
+ # [Instance Protection][1] in the *Auto Scaling User Guide*.
242
241
  #
243
242
  # When managed termination protection is disabled, your Amazon EC2
244
- # instances are not protected from termination when the Auto Scaling
243
+ # instances aren't protected from termination when the Auto Scaling
245
244
  # group scales in.
246
245
  #
247
246
  #
@@ -270,7 +269,7 @@ module Aws::ECS
270
269
  # }
271
270
  #
272
271
  # @!attribute [rw] subnets
273
- # The IDs of the subnets associated with the task or service. There is
272
+ # The IDs of the subnets associated with the task or service. There's
274
273
  # a limit of 16 subnets that can be specified per
275
274
  # `AwsVpcConfiguration`.
276
275
  #
@@ -281,8 +280,8 @@ module Aws::ECS
281
280
  #
282
281
  # @!attribute [rw] security_groups
283
282
  # The IDs of the security groups associated with the task or service.
284
- # If you do not specify a security group, the default security group
285
- # for the VPC is used. There is a limit of 5 security groups that can
283
+ # If you don't specify a security group, the default security group
284
+ # for the VPC is used. There's a limit of 5 security groups that can
286
285
  # be specified per `AwsVpcConfiguration`.
287
286
  #
288
287
  # <note markdown="1"> All specified security groups must be from the same VPC.
@@ -305,8 +304,8 @@ module Aws::ECS
305
304
  include Aws::Structure
306
305
  end
307
306
 
308
- # Your Amazon Web Services account has been blocked. For more
309
- # information, contact [ Amazon Web Services Support][1].
307
+ # Your Amazon Web Services account was blocked. For more information,
308
+ # contact [ Amazon Web Services Support][1].
310
309
  #
311
310
  #
312
311
  #
@@ -316,7 +315,7 @@ module Aws::ECS
316
315
  #
317
316
  class BlockedException < Aws::EmptyStructure; end
318
317
 
319
- # The details of a capacity provider.
318
+ # The details for a capacity provider.
320
319
  #
321
320
  # @!attribute [rw] capacity_provider_arn
322
321
  # The Amazon Resource Name (ARN) that identifies the capacity
@@ -330,7 +329,7 @@ module Aws::ECS
330
329
  # @!attribute [rw] status
331
330
  # The current status of the capacity provider. Only capacity providers
332
331
  # in an `ACTIVE` state can be used in a cluster. When a capacity
333
- # provider is successfully deleted, it will have an `INACTIVE` status.
332
+ # provider is successfully deleted, it has an `INACTIVE` status.
334
333
  # @return [String]
335
334
  #
336
335
  # @!attribute [rw] auto_scaling_group_provider
@@ -339,7 +338,7 @@ module Aws::ECS
339
338
  #
340
339
  # @!attribute [rw] update_status
341
340
  # The update status of the capacity provider. The following are the
342
- # possible states that will be returned.
341
+ # possible states that is returned.
343
342
  #
344
343
  # DELETE\_IN\_PROGRESS
345
344
  #
@@ -347,13 +346,13 @@ module Aws::ECS
347
346
  #
348
347
  # DELETE\_COMPLETE
349
348
  #
350
- # : The capacity provider has been successfully deleted and will have
351
- # an `INACTIVE` status.
349
+ # : The capacity provider was successfully deleted and has an
350
+ # `INACTIVE` status.
352
351
  #
353
352
  # DELETE\_FAILED
354
353
  #
355
- # : The capacity provider was unable to be deleted. The update status
356
- # reason will provide further details about why the delete failed.
354
+ # : The capacity provider can't be deleted. The update status reason
355
+ # provides further details about why the delete failed.
357
356
  # @return [String]
358
357
  #
359
358
  # @!attribute [rw] update_status_reason
@@ -364,7 +363,7 @@ module Aws::ECS
364
363
  # @!attribute [rw] tags
365
364
  # The metadata that you apply to the capacity provider to help you
366
365
  # categorize and organize it. Each tag consists of a key and an
367
- # optional value, both of which you define.
366
+ # optional value. You define both.
368
367
  #
369
368
  # The following basic restrictions apply to tags:
370
369
  #
@@ -452,17 +451,17 @@ module Aws::ECS
452
451
  # When multiple capacity providers are specified within a capacity
453
452
  # provider strategy, at least one of the capacity providers must have
454
453
  # a weight value greater than zero and any capacity providers with a
455
- # weight of `0` will not be used to place tasks. If you specify
456
- # multiple capacity providers in a strategy that all have a weight of
457
- # `0`, any `RunTask` or `CreateService` actions using the capacity
458
- # provider strategy will fail.
454
+ # weight of `0` can't be used to place tasks. If you specify multiple
455
+ # capacity providers in a strategy that all have a weight of `0`, any
456
+ # `RunTask` or `CreateService` actions using the capacity provider
457
+ # strategy will fail.
459
458
  #
460
459
  # An example scenario for using weights is defining a strategy that
461
460
  # contains two capacity providers and both have a weight of `1`, then
462
461
  # when the `base` is satisfied, the tasks will be split evenly across
463
462
  # the two capacity providers. Using that same logic, if you specify a
464
463
  # weight of `1` for *capacityProviderA* and a weight of `4` for
465
- # *capacityProviderB*, then for every one task that is run using
464
+ # *capacityProviderB*, then for every one task that's run using
466
465
  # *capacityProviderA*, four tasks would use *capacityProviderB*.
467
466
  # @return [Integer]
468
467
  #
@@ -483,10 +482,10 @@ module Aws::ECS
483
482
  include Aws::Structure
484
483
  end
485
484
 
486
- # These errors are usually caused by a client action, such as using an
487
- # action or resource on behalf of a user that doesn't have permissions
488
- # to use the action or resource, or specifying an identifier that is not
489
- # valid.
485
+ # These errors are usually caused by a client action. This client action
486
+ # might be using an action or resource on behalf of a user that doesn't
487
+ # have permissions to use the action or resource,. Or, it might be
488
+ # specifying an identifier that isn't valid.
490
489
  #
491
490
  # @!attribute [rw] message
492
491
  # @return [String]
@@ -499,10 +498,10 @@ module Aws::ECS
499
498
  include Aws::Structure
500
499
  end
501
500
 
502
- # A regional grouping of one or more container instances on which you
503
- # can run task requests. Each account receives a default cluster the
504
- # first time you use the Amazon ECS service, but you may also create
505
- # other clusters. Clusters may contain more than one instance type
501
+ # A regional grouping of one or more container instances where you can
502
+ # run task requests. Each account receives a default cluster the first
503
+ # time you use the Amazon ECS service, but you may also create other
504
+ # clusters. Clusters may contain more than one instance type
506
505
  # simultaneously.
507
506
  #
508
507
  # @!attribute [rw] cluster_arn
@@ -523,7 +522,7 @@ module Aws::ECS
523
522
  #
524
523
  # @!attribute [rw] status
525
524
  # The status of the cluster. The following are the possible states
526
- # that will be returned.
525
+ # that are returned.
527
526
  #
528
527
  # ACTIVE
529
528
  #
@@ -532,25 +531,26 @@ module Aws::ECS
532
531
  #
533
532
  # PROVISIONING
534
533
  #
535
- # : The cluster has capacity providers associated with it and the
536
- # resources needed for the capacity provider are being created.
534
+ # : The cluster has capacity providers that are associated with it and
535
+ # the resources needed for the capacity provider are being created.
537
536
  #
538
537
  # DEPROVISIONING
539
538
  #
540
- # : The cluster has capacity providers associated with it and the
541
- # resources needed for the capacity provider are being deleted.
539
+ # : The cluster has capacity providers that are associated with it and
540
+ # the resources needed for the capacity provider are being deleted.
542
541
  #
543
542
  # FAILED
544
543
  #
545
- # : The cluster has capacity providers associated with it and the
546
- # resources needed for the capacity provider have failed to create.
544
+ # : The cluster has capacity providers that are associated with it and
545
+ # the resources needed for the capacity provider have failed to
546
+ # create.
547
547
  #
548
548
  # INACTIVE
549
549
  #
550
550
  # : The cluster has been deleted. Clusters with an `INACTIVE` status
551
551
  # may remain discoverable in your account for a period of time.
552
- # However, this behavior is subject to change in the future, so you
553
- # should not rely on `INACTIVE` clusters persisting.
552
+ # However, this behavior is subject to change in the future. We
553
+ # don't recommend that you rely on `INACTIVE` clusters persisting.
554
554
  # @return [String]
555
555
  #
556
556
  # @!attribute [rw] registered_container_instances_count
@@ -573,7 +573,7 @@ module Aws::ECS
573
573
  #
574
574
  # @!attribute [rw] statistics
575
575
  # Additional information about your clusters that are separated by
576
- # launch type, including:
576
+ # launch type. They include the following:
577
577
  #
578
578
  # * runningEC2TasksCount
579
579
  #
@@ -594,8 +594,8 @@ module Aws::ECS
594
594
  #
595
595
  # @!attribute [rw] tags
596
596
  # The metadata that you apply to the cluster to help you categorize
597
- # and organize them. Each tag consists of a key and an optional value,
598
- # both of which you define.
597
+ # and organize them. Each tag consists of a key and an optional value.
598
+ # You define both.
599
599
  #
600
600
  # The following basic restrictions apply to tags:
601
601
  #
@@ -641,13 +641,13 @@ module Aws::ECS
641
641
  #
642
642
  # @!attribute [rw] attachments
643
643
  # The resources attached to a cluster. When using a capacity provider
644
- # with a cluster, the Auto Scaling plan that is created will be
645
- # returned as a cluster attachment.
644
+ # with a cluster, the Auto Scaling plan that's created is returned as
645
+ # a cluster attachment.
646
646
  # @return [Array<Types::Attachment>]
647
647
  #
648
648
  # @!attribute [rw] attachments_status
649
649
  # The status of the capacity providers associated with the cluster.
650
- # The following are the states that will be returned:
650
+ # The following are the states that are returned.
651
651
  #
652
652
  # UPDATE\_IN\_PROGRESS
653
653
  #
@@ -717,7 +717,7 @@ module Aws::ECS
717
717
  include Aws::Structure
718
718
  end
719
719
 
720
- # You cannot delete a cluster that has registered container instances.
720
+ # You can't delete a cluster that has registered container instances.
721
721
  # First, deregister the container instances before you can delete the
722
722
  # cluster. For more information, see DeregisterContainerInstance.
723
723
  #
@@ -725,22 +725,22 @@ module Aws::ECS
725
725
  #
726
726
  class ClusterContainsContainerInstancesException < Aws::EmptyStructure; end
727
727
 
728
- # You cannot delete a cluster that contains services. First, update the
729
- # service to reduce its desired task count to 0 and then delete the
728
+ # You can't delete a cluster that contains services. First, update the
729
+ # service to reduce its desired task count to 0, and then delete the
730
730
  # service. For more information, see UpdateService and DeleteService.
731
731
  #
732
732
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsServicesException AWS API Documentation
733
733
  #
734
734
  class ClusterContainsServicesException < Aws::EmptyStructure; end
735
735
 
736
- # You cannot delete a cluster that has active tasks.
736
+ # You can't delete a cluster that has active tasks.
737
737
  #
738
738
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsTasksException AWS API Documentation
739
739
  #
740
740
  class ClusterContainsTasksException < Aws::EmptyStructure; end
741
741
 
742
- # The specified cluster could not be found. You can view your available
743
- # clusters with ListClusters. Amazon ECS clusters are Region-specific.
742
+ # The specified cluster wasn't found. You can view your available
743
+ # clusters with ListClusters. Amazon ECS clusters are Region specific.
744
744
  #
745
745
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterNotFoundException AWS API Documentation
746
746
  #
@@ -781,7 +781,7 @@ module Aws::ECS
781
781
  include Aws::Structure
782
782
  end
783
783
 
784
- # A Docker container that is part of a task.
784
+ # A Docker container that's part of a task.
785
785
  #
786
786
  # @!attribute [rw] container_arn
787
787
  # The Amazon Resource Name (ARN) of the container.
@@ -834,7 +834,7 @@ module Aws::ECS
834
834
  # @return [Array<Types::NetworkInterface>]
835
835
  #
836
836
  # @!attribute [rw] health_status
837
- # The health status of the container. If health checks are not
837
+ # The health status of the container. If health checks aren't
838
838
  # configured for this container in its task definition, then it
839
839
  # reports the health status as `UNKNOWN`.
840
840
  # @return [String]
@@ -845,8 +845,8 @@ module Aws::ECS
845
845
  # @return [Array<Types::ManagedAgent>]
846
846
  #
847
847
  # @!attribute [rw] cpu
848
- # The number of CPU units set for the container. The value will be `0`
849
- # if no value was specified in the container definition when the task
848
+ # The number of CPU units set for the container. The value is `0` if
849
+ # no value was specified in the container definition when the task
850
850
  # definition was registered.
851
851
  # @return [String]
852
852
  #
@@ -1042,7 +1042,7 @@ module Aws::ECS
1042
1042
  # }
1043
1043
  #
1044
1044
  # @!attribute [rw] name
1045
- # The name of a container. If you are linking multiple containers
1045
+ # The name of a container. If you're linking multiple containers
1046
1046
  # together in a task definition, the `name` of one container can be
1047
1047
  # entered in the `links` of another container to connect the
1048
1048
  # containers. Up to 255 letters (uppercase and lowercase), numbers,
@@ -1059,8 +1059,8 @@ module Aws::ECS
1059
1059
  #
1060
1060
  # @!attribute [rw] image
1061
1061
  # The image used to start a container. This string is passed directly
1062
- # to the Docker daemon. Images in the Docker Hub registry are
1063
- # available by default. Other repositories are specified with either `
1062
+ # to the Docker daemon. By default, images in the Docker Hub registry
1063
+ # are available. Other repositories are specified with either `
1064
1064
  # repository-url/image:tag ` or ` repository-url/image@digest `. Up to
1065
1065
  # 255 letters (uppercase and lowercase), numbers, hyphens,
1066
1066
  # underscores, colons, periods, forward slashes, and number signs are
@@ -1070,7 +1070,7 @@ module Aws::ECS
1070
1070
  #
1071
1071
  # * When a new task starts, the Amazon ECS container agent pulls the
1072
1072
  # latest version of the specified image and tag for the container to
1073
- # use. However, subsequent updates to a repository image are not
1073
+ # use. However, subsequent updates to a repository image aren't
1074
1074
  # propagated to already running tasks.
1075
1075
  #
1076
1076
  # * Images in Amazon ECR repositories can be specified by either using
@@ -1121,21 +1121,21 @@ module Aws::ECS
1121
1121
  # on the container instance with the same ratio as their allocated
1122
1122
  # amount. For example, if you run a single-container task on a
1123
1123
  # single-core instance type with 512 CPU units specified for that
1124
- # container, and that is the only task running on the container
1124
+ # container, and that's the only task running on the container
1125
1125
  # instance, that container could use the full 1,024 CPU unit share at
1126
1126
  # any given time. However, if you launched another copy of the same
1127
- # task on that container instance, each task would be guaranteed a
1128
- # minimum of 512 CPU units when needed, and each container could float
1129
- # to higher CPU usage if the other container was not using it, but if
1130
- # both tasks were 100% active all of the time, they would be limited
1131
- # to 512 CPU units.
1127
+ # task on that container instance, each task is guaranteed a minimum
1128
+ # of 512 CPU units when needed. Moreover, each container could float
1129
+ # to higher CPU usage if the other container was not using it. If both
1130
+ # tasks were 100% active all of the time, they would be limited to 512
1131
+ # CPU units.
1132
1132
  #
1133
1133
  # On Linux container instances, the Docker daemon on the container
1134
1134
  # instance uses the CPU value to calculate the relative CPU share
1135
1135
  # ratios for running containers. For more information, see [CPU share
1136
1136
  # constraint][5] in the Docker documentation. The minimum valid CPU
1137
1137
  # share value that the Linux kernel allows is 2. However, the CPU
1138
- # parameter is not required, and you can use CPU values below 2 in
1138
+ # parameter isn't required, and you can use CPU values below 2 in
1139
1139
  # your container definitions. For CPU values below 2 (including null),
1140
1140
  # the behavior varies based on your Amazon ECS container agent
1141
1141
  # version:
@@ -1150,7 +1150,7 @@ module Aws::ECS
1150
1150
  #
1151
1151
  # On Windows container instances, the CPU limit is enforced as an
1152
1152
  # absolute limit, or a quota. Windows containers only have access to
1153
- # the specified amount of CPU that is described in the task
1153
+ # the specified amount of CPU that's described in the task
1154
1154
  # definition. A null or zero CPU value is passed to Docker as `0`,
1155
1155
  # which Windows interprets as 1% of one CPU.
1156
1156
  #
@@ -1179,12 +1179,16 @@ module Aws::ECS
1179
1179
  # a container-level `memory` and `memoryReservation` value, `memory`
1180
1180
  # must be greater than `memoryReservation`. If you specify
1181
1181
  # `memoryReservation`, then that value is subtracted from the
1182
- # available memory resources for the container instance on which the
1182
+ # available memory resources for the container instance where the
1183
1183
  # container is placed. Otherwise, the value of `memory` is used.
1184
1184
  #
1185
- # The Docker daemon reserves a minimum of 4 MiB of memory for a
1186
- # container, so you should not specify fewer than 4 MiB of memory for
1187
- # your containers.
1185
+ # The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of
1186
+ # memory for a container, so you should not specify fewer than 6 MiB
1187
+ # of memory for your containers.
1188
+ #
1189
+ # The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB
1190
+ # of memory for a container, so you should not specify fewer than 4
1191
+ # MiB of memory for your containers.
1188
1192
  #
1189
1193
  #
1190
1194
  #
@@ -1209,7 +1213,7 @@ module Aws::ECS
1209
1213
  # in a container definition. If you specify both, `memory` must be
1210
1214
  # greater than `memoryReservation`. If you specify
1211
1215
  # `memoryReservation`, then that value is subtracted from the
1212
- # available memory resources for the container instance on which the
1216
+ # available memory resources for the container instance where the
1213
1217
  # container is placed. Otherwise, the value of `memory` is used.
1214
1218
  #
1215
1219
  # For example, if your container normally uses 128 MiB of memory, but
@@ -1221,8 +1225,8 @@ module Aws::ECS
1221
1225
  # memory resources when needed.
1222
1226
  #
1223
1227
  # The Docker daemon reserves a minimum of 4 MiB of memory for a
1224
- # container, so you should not specify fewer than 4 MiB of memory for
1225
- # your containers.
1228
+ # container. Therefore, we recommend that you specify fewer than 4 MiB
1229
+ # of memory for your containers.
1226
1230
  #
1227
1231
  #
1228
1232
  #
@@ -1265,13 +1269,13 @@ module Aws::ECS
1265
1269
  # containers to access ports on the host container instance to send or
1266
1270
  # receive traffic.
1267
1271
  #
1268
- # For task definitions that use the `awsvpc` network mode, you should
1269
- # only specify the `containerPort`. The `hostPort` can be left blank
1270
- # or it must be the same value as the `containerPort`.
1272
+ # For task definitions that use the `awsvpc` network mode, only
1273
+ # specify the `containerPort`. The `hostPort` can be left blank or it
1274
+ # must be the same value as the `containerPort`.
1271
1275
  #
1272
1276
  # Port mappings on Windows use the `NetNAT` gateway address rather
1273
- # than `localhost`. There is no loopback for port mappings on Windows,
1274
- # so you cannot access a container's mapped port from the host
1277
+ # than `localhost`. There's no loopback for port mappings on Windows,
1278
+ # so you can't access a container's mapped port from the host
1275
1279
  # itself.
1276
1280
  #
1277
1281
  # This parameter maps to `PortBindings` in the [Create a container][1]
@@ -1301,16 +1305,16 @@ module Aws::ECS
1301
1305
  # If the `essential` parameter of a container is marked as `true`, and
1302
1306
  # that container fails or stops for any reason, all other containers
1303
1307
  # that are part of the task are stopped. If the `essential` parameter
1304
- # of a container is marked as `false`, then its failure does not
1305
- # affect the rest of the containers in a task. If this parameter is
1306
- # omitted, a container is assumed to be essential.
1308
+ # of a container is marked as `false`, its failure doesn't affect the
1309
+ # rest of the containers in a task. If this parameter is omitted, a
1310
+ # container is assumed to be essential.
1307
1311
  #
1308
1312
  # All tasks must have at least one essential container. If you have an
1309
- # application that is composed of multiple containers, you should
1310
- # group containers that are used for a common purpose into components,
1311
- # and separate the different components into multiple task
1312
- # definitions. For more information, see [Application Architecture][1]
1313
- # in the *Amazon Elastic Container Service Developer Guide*.
1313
+ # application that's composed of multiple containers, group
1314
+ # containers that are used for a common purpose into components, and
1315
+ # separate the different components into multiple task definitions.
1316
+ # For more information, see [Application Architecture][1] in the
1317
+ # *Amazon Elastic Container Service Developer Guide*.
1314
1318
  #
1315
1319
  #
1316
1320
  #
@@ -1318,12 +1322,12 @@ module Aws::ECS
1318
1322
  # @return [Boolean]
1319
1323
  #
1320
1324
  # @!attribute [rw] entry_point
1321
- # Early versions of the Amazon ECS container agent do not properly
1325
+ # Early versions of the Amazon ECS container agent don't properly
1322
1326
  # handle `entryPoint` parameters. If you have problems using
1323
1327
  # `entryPoint`, update your container agent or enter your commands and
1324
1328
  # arguments as `command` array items instead.
1325
1329
  #
1326
- # The entry point that is passed to the container. This parameter maps
1330
+ # The entry point that's passed to the container. This parameter maps
1327
1331
  # to `Entrypoint` in the [Create a container][1] section of the
1328
1332
  # [Docker Remote API][2] and the `--entrypoint` option to [docker
1329
1333
  # run][3]. For more information, see
@@ -1338,13 +1342,13 @@ module Aws::ECS
1338
1342
  # @return [Array<String>]
1339
1343
  #
1340
1344
  # @!attribute [rw] command
1341
- # The command that is passed to the container. This parameter maps to
1345
+ # The command that's passed to the container. This parameter maps to
1342
1346
  # `Cmd` in the [Create a container][1] section of the [Docker Remote
1343
1347
  # API][2] and the `COMMAND` parameter to [docker run][3]. For more
1344
1348
  # information, see
1345
1349
  # [https://docs.docker.com/engine/reference/builder/#cmd][4]. If there
1346
- # are multiple arguments, each argument should be a separated string
1347
- # in the array.
1350
+ # are multiple arguments, each argument is a separated string in the
1351
+ # array.
1348
1352
  #
1349
1353
  #
1350
1354
  #
@@ -1359,7 +1363,7 @@ module Aws::ECS
1359
1363
  # maps to `Env` in the [Create a container][1] section of the [Docker
1360
1364
  # Remote API][2] and the `--env` option to [docker run][3].
1361
1365
  #
1362
- # We do not recommend using plaintext environment variables for
1366
+ # We don't recommend that you use plaintext environment variables for
1363
1367
  # sensitive information, such as credential data.
1364
1368
  #
1365
1369
  #
@@ -1375,20 +1379,20 @@ module Aws::ECS
1375
1379
  # run][1].
1376
1380
  #
1377
1381
  # You can specify up to ten environment files. The file must have a
1378
- # `.env` file extension. Each line in an environment file should
1379
- # contain an environment variable in `VARIABLE=VALUE` format. Lines
1380
- # beginning with `#` are treated as comments and are ignored. For more
1381
- # information on the environment variable file syntax, see [Declare
1382
+ # `.env` file extension. Each line in an environment file contains an
1383
+ # environment variable in `VARIABLE=VALUE` format. Lines beginning
1384
+ # with `#` are treated as comments and are ignored. For more
1385
+ # information about the environment variable file syntax, see [Declare
1382
1386
  # default environment variables in file][2].
1383
1387
  #
1384
1388
  # If there are environment variables specified using the `environment`
1385
1389
  # parameter in a container definition, they take precedence over the
1386
1390
  # variables contained within an environment file. If multiple
1387
- # environment files are specified that contain the same variable, they
1388
- # are processed from the top down. It is recommended to use unique
1389
- # variable names. For more information, see [Specifying Environment
1390
- # Variables][3] in the *Amazon Elastic Container Service Developer
1391
- # Guide*.
1391
+ # environment files are specified that contain the same variable,
1392
+ # they're processed from the top down. We recommend that you use
1393
+ # unique variable names. For more information, see [Specifying
1394
+ # Environment Variables][3] in the *Amazon Elastic Container Service
1395
+ # Developer Guide*.
1392
1396
  #
1393
1397
  #
1394
1398
  #
@@ -1405,8 +1409,8 @@ module Aws::ECS
1405
1409
  # [docker run][3].
1406
1410
  #
1407
1411
  # Windows containers can mount whole directories on the same drive as
1408
- # `$env:ProgramData`. Windows containers cannot mount directories on a
1409
- # different drive, and mount point cannot be across drives.
1412
+ # `$env:ProgramData`. Windows containers can't mount directories on a
1413
+ # different drive, and mount point can't be across drives.
1410
1414
  #
1411
1415
  #
1412
1416
  #
@@ -1459,7 +1463,7 @@ module Aws::ECS
1459
1463
  # version. For information about checking your agent version and
1460
1464
  # updating to the latest version, see [Updating the Amazon ECS
1461
1465
  # Container Agent][1] in the *Amazon Elastic Container Service
1462
- # Developer Guide*. If you are using an Amazon ECS-optimized Linux
1466
+ # Developer Guide*. If you're using an Amazon ECS-optimized Linux
1463
1467
  # AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
1464
1468
  # package. If your container instances are launched from version
1465
1469
  # `20190301` or later, then they contain the required versions of the
@@ -1468,7 +1472,7 @@ module Aws::ECS
1468
1472
  # Developer Guide*.
1469
1473
  #
1470
1474
  # For tasks using the Fargate launch type, the task or service
1471
- # requires the followiwng platforms:
1475
+ # requires the following platforms:
1472
1476
  #
1473
1477
  # * Linux platform version `1.3.0` or later.
1474
1478
  #
@@ -1485,19 +1489,19 @@ module Aws::ECS
1485
1489
  # dependencies for a container. For example, you specify two
1486
1490
  # containers in a task definition with containerA having a dependency
1487
1491
  # on containerB reaching a `COMPLETE`, `SUCCESS`, or `HEALTHY` status.
1488
- # If a `startTimeout` value is specified for containerB and it does
1489
- # not reach the desired status within that time then containerA will
1490
- # give up and not start. This results in the task transitioning to a
1492
+ # If a `startTimeout` value is specified for containerB and it
1493
+ # doesn't reach the desired status within that time then containerA
1494
+ # gives up and not start. This results in the task transitioning to a
1491
1495
  # `STOPPED` state.
1492
1496
  #
1493
1497
  # <note markdown="1"> When the `ECS_CONTAINER_START_TIMEOUT` container agent configuration
1494
- # variable is used, it is enforced indendently from this start timeout
1495
- # value.
1498
+ # variable is used, it's enforced independently from this start
1499
+ # timeout value.
1496
1500
  #
1497
1501
  # </note>
1498
1502
  #
1499
1503
  # For tasks using the Fargate launch type, the task or service
1500
- # requires the followiwng platforms:
1504
+ # requires the following platforms:
1501
1505
  #
1502
1506
  # * Linux platform version `1.3.0` or later.
1503
1507
  #
@@ -1509,7 +1513,7 @@ module Aws::ECS
1509
1513
  # latest container agent version. For information about checking your
1510
1514
  # agent version and updating to the latest version, see [Updating the
1511
1515
  # Amazon ECS Container Agent][1] in the *Amazon Elastic Container
1512
- # Service Developer Guide*. If you are using an Amazon ECS-optimized
1516
+ # Service Developer Guide*. If you're using an Amazon ECS-optimized
1513
1517
  # Linux AMI, your instance needs at least version `1.26.0-1` of the
1514
1518
  # `ecs-init` package. If your container instances are launched from
1515
1519
  # version `20190301` or later, then they contain the required versions
@@ -1528,7 +1532,7 @@ module Aws::ECS
1528
1532
  # forcefully killed if it doesn't exit normally on its own.
1529
1533
  #
1530
1534
  # For tasks using the Fargate launch type, the task or service
1531
- # requires the followiwng platforms:
1535
+ # requires the following platforms:
1532
1536
  #
1533
1537
  # * Linux platform version `1.3.0` or later.
1534
1538
  #
@@ -1537,10 +1541,10 @@ module Aws::ECS
1537
1541
  # The max stop timeout value is 120 seconds and if the parameter is
1538
1542
  # not specified, the default value of 30 seconds is used.
1539
1543
  #
1540
- # For tasks using the EC2 launch type, if the `stopTimeout` parameter
1541
- # is not specified, the value set for the Amazon ECS container agent
1542
- # configuration variable `ECS_CONTAINER_STOP_TIMEOUT` is used by
1543
- # default. If neither the `stopTimeout` parameter or the
1544
+ # For tasks that use the EC2 launch type, if the `stopTimeout`
1545
+ # parameter isn't specified, the value set for the Amazon ECS
1546
+ # container agent configuration variable `ECS_CONTAINER_STOP_TIMEOUT`
1547
+ # is used. If neither the `stopTimeout` parameter or the
1544
1548
  # `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set,
1545
1549
  # then the default values of 30 seconds for Linux containers and 30
1546
1550
  # seconds on Windows containers are used. Your container instances
@@ -1549,7 +1553,7 @@ module Aws::ECS
1549
1553
  # container agent version. For information about checking your agent
1550
1554
  # version and updating to the latest version, see [Updating the Amazon
1551
1555
  # ECS Container Agent][1] in the *Amazon Elastic Container Service
1552
- # Developer Guide*. If you are using an Amazon ECS-optimized Linux
1556
+ # Developer Guide*. If you're using an Amazon ECS-optimized Linux
1553
1557
  # AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
1554
1558
  # package. If your container instances are launched from version
1555
1559
  # `20190301` or later, then they contain the required versions of the
@@ -1568,7 +1572,7 @@ module Aws::ECS
1568
1572
  # `Hostname` in the [Create a container][1] section of the [Docker
1569
1573
  # Remote API][2] and the `--hostname` option to [docker run][3].
1570
1574
  #
1571
- # <note markdown="1"> The `hostname` parameter is not supported if you are using the
1575
+ # <note markdown="1"> The `hostname` parameter is not supported if you're using the
1572
1576
  # `awsvpc` network mode.
1573
1577
  #
1574
1578
  # </note>
@@ -1585,9 +1589,9 @@ module Aws::ECS
1585
1589
  # in the [Create a container][1] section of the [Docker Remote API][2]
1586
1590
  # and the `--user` option to [docker run][3].
1587
1591
  #
1588
- # When running tasks using the `host` network mode, you should not run
1589
- # containers using the root user (UID 0). It is considered best
1590
- # practice to use a non-root user.
1592
+ # When running tasks using the `host` network mode, don't run
1593
+ # containers using the root user (UID 0). We recommend using a
1594
+ # non-root user for better security.
1591
1595
  #
1592
1596
  # You can specify the `user` using the following formats. If
1593
1597
  # specifying a UID or GID, you must specify it as a positive integer.
@@ -1616,8 +1620,8 @@ module Aws::ECS
1616
1620
  # @return [String]
1617
1621
  #
1618
1622
  # @!attribute [rw] working_directory
1619
- # The working directory in which to run commands inside the container.
1620
- # This parameter maps to `WorkingDir` in the [Create a container][1]
1623
+ # The working directory to run commands inside the container in. This
1624
+ # parameter maps to `WorkingDir` in the [Create a container][1]
1621
1625
  # section of the [Docker Remote API][2] and the `--workdir` option to
1622
1626
  # [docker run][3].
1623
1627
  #
@@ -1719,7 +1723,7 @@ module Aws::ECS
1719
1723
  # `ExtraHosts` in the [Create a container][1] section of the [Docker
1720
1724
  # Remote API][2] and the `--add-host` option to [docker run][3].
1721
1725
  #
1722
- # <note markdown="1"> This parameter is not supported for Windows containers or tasks that
1726
+ # <note markdown="1"> This parameter isn't supported for Windows containers or tasks that
1723
1727
  # use the `awsvpc` network mode.
1724
1728
  #
1725
1729
  # </note>
@@ -1733,7 +1737,7 @@ module Aws::ECS
1733
1737
  #
1734
1738
  # @!attribute [rw] docker_security_options
1735
1739
  # A list of strings to provide custom labels for SELinux and AppArmor
1736
- # multi-level security systems. This field is not valid for containers
1740
+ # multi-level security systems. This field isn't valid for containers
1737
1741
  # in tasks using the Fargate launch type.
1738
1742
  #
1739
1743
  # With Windows containers, this parameter can be used to reference a
@@ -1771,11 +1775,11 @@ module Aws::ECS
1771
1775
  # @return [Array<String>]
1772
1776
  #
1773
1777
  # @!attribute [rw] interactive
1774
- # When this parameter is `true`, this allows you to deploy
1775
- # containerized applications that require `stdin` or a `tty` to be
1776
- # allocated. This parameter maps to `OpenStdin` in the [Create a
1777
- # container][1] section of the [Docker Remote API][2] and the
1778
- # `--interactive` option to [docker run][3].
1778
+ # When this parameter is `true`, you can deploy containerized
1779
+ # applications that require `stdin` or a `tty` to be allocated. This
1780
+ # parameter maps to `OpenStdin` in the [Create a container][1] section
1781
+ # of the [Docker Remote API][2] and the `--interactive` option to
1782
+ # [docker run][3].
1779
1783
  #
1780
1784
  #
1781
1785
  #
@@ -1815,8 +1819,8 @@ module Aws::ECS
1815
1819
  #
1816
1820
  # @!attribute [rw] ulimits
1817
1821
  # A list of `ulimits` to set in the container. If a ulimit value is
1818
- # specified in a task definition, it will override the default values
1819
- # set by Docker. This parameter maps to `Ulimits` in the [Create a
1822
+ # specified in a task definition, it overrides the default values set
1823
+ # by Docker. This parameter maps to `Ulimits` in the [Create a
1820
1824
  # container][1] section of the [Docker Remote API][2] and the
1821
1825
  # `--ulimit` option to [docker run][3]. Valid naming values are
1822
1826
  # displayed in the Ulimit data type.
@@ -1851,12 +1855,12 @@ module Aws::ECS
1851
1855
  # This parameter maps to `LogConfig` in the [Create a container][1]
1852
1856
  # section of the [Docker Remote API][2] and the `--log-driver` option
1853
1857
  # to [docker run][3]. By default, containers use the same logging
1854
- # driver that the Docker daemon uses. However the container may use a
1858
+ # driver that the Docker daemon uses. However the container can use a
1855
1859
  # different logging driver than the Docker daemon by specifying a log
1856
1860
  # driver with this parameter in the container definition. To use a
1857
1861
  # different logging driver for a container, the log system must be
1858
1862
  # configured properly on the container instance (or on a different log
1859
- # server for remote logging options). For more information on the
1863
+ # server for remote logging options). For more information about the
1860
1864
  # options for different supported log drivers, see [Configure logging
1861
1865
  # drivers][4] in the Docker documentation.
1862
1866
  #
@@ -1911,10 +1915,10 @@ module Aws::ECS
1911
1915
  # of the [Docker Remote API][2] and the `--sysctl` option to [docker
1912
1916
  # run][3].
1913
1917
  #
1914
- # <note markdown="1"> It is not recommended that you specify network-related
1918
+ # <note markdown="1"> We don't recommended that you specify network-related
1915
1919
  # `systemControls` parameters for multiple containers in a single task
1916
1920
  # that also uses either the `awsvpc` or `host` network modes. For
1917
- # tasks that use the `awsvpc` network mode, the container that is
1921
+ # tasks that use the `awsvpc` network mode, the container that's
1918
1922
  # started last determines which `systemControls` parameters take
1919
1923
  # effect. For tasks that use the `host` network mode, it changes the
1920
1924
  # container instance's namespaced kernel parameters as well as the
@@ -2000,7 +2004,7 @@ module Aws::ECS
2000
2004
  # recommend using the latest container agent version. For information
2001
2005
  # about checking your agent version and updating to the latest version,
2002
2006
  # see [Updating the Amazon ECS Container Agent][1] in the *Amazon
2003
- # Elastic Container Service Developer Guide*. If you are using an Amazon
2007
+ # Elastic Container Service Developer Guide*. If you're using an Amazon
2004
2008
  # ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
2005
2009
  # of the `ecs-init` package. If your container instances are launched
2006
2010
  # from version `20190301` or later, then they contain the required
@@ -2008,8 +2012,8 @@ module Aws::ECS
2008
2012
  # see [Amazon ECS-optimized Linux AMI][2] in the *Amazon Elastic
2009
2013
  # Container Service Developer Guide*.
2010
2014
  #
2011
- # <note markdown="1"> For tasks using the Fargate launch type, the task or service requires
2012
- # the followiwng platforms:
2015
+ # <note markdown="1"> For tasks that use the Fargate launch type, the task or service
2016
+ # requires the following platforms:
2013
2017
  #
2014
2018
  # * Linux platform version `1.3.0` or later.
2015
2019
  #
@@ -2045,12 +2049,12 @@ module Aws::ECS
2045
2049
  # * `COMPLETE` - This condition validates that a dependent container
2046
2050
  # runs to completion (exits) before permitting other containers to
2047
2051
  # start. This can be useful for nonessential containers that run a
2048
- # script and then exit. This condition cannot be set on an essential
2052
+ # script and then exit. This condition can't be set on an essential
2049
2053
  # container.
2050
2054
  #
2051
2055
  # * `SUCCESS` - This condition is the same as `COMPLETE`, but it also
2052
2056
  # requires that the container exits with a `zero` status. This
2053
- # condition cannot be set on an essential container.
2057
+ # condition can't be set on an essential container.
2054
2058
  #
2055
2059
  # * `HEALTHY` - This condition validates that the dependent container
2056
2060
  # passes its Docker health check before permitting other containers
@@ -2068,7 +2072,7 @@ module Aws::ECS
2068
2072
  include Aws::Structure
2069
2073
  end
2070
2074
 
2071
- # An EC2 instance that is running the Amazon ECS agent and has been
2075
+ # An EC2 instance that's running the Amazon ECS agent and has been
2072
2076
  # registered with a cluster.
2073
2077
  #
2074
2078
  # @!attribute [rw] container_instance_arn
@@ -2088,13 +2092,14 @@ module Aws::ECS
2088
2092
  # @return [String]
2089
2093
  #
2090
2094
  # @!attribute [rw] capacity_provider_name
2091
- # The capacity provider associated with the container instance.
2095
+ # The capacity provider that's associated with the container
2096
+ # instance.
2092
2097
  # @return [String]
2093
2098
  #
2094
2099
  # @!attribute [rw] version
2095
2100
  # The version counter for the container instance. Every time a
2096
2101
  # container instance experiences a change that triggers a CloudWatch
2097
- # event, the version counter is incremented. If you are replicating
2102
+ # event, the version counter is incremented. If you're replicating
2098
2103
  # your Amazon ECS container instance state with CloudWatch Events, you
2099
2104
  # can compare the version of a container instance reported by the
2100
2105
  # Amazon ECS APIs with the version reported in CloudWatch Events for
@@ -2109,12 +2114,12 @@ module Aws::ECS
2109
2114
  #
2110
2115
  # @!attribute [rw] remaining_resources
2111
2116
  # For CPU and memory resource types, this parameter describes the
2112
- # remaining CPU and memory that has not already been allocated to
2113
- # tasks and is therefore available for new tasks. For port resource
2114
- # types, this parameter describes the ports that were reserved by the
2115
- # Amazon ECS container agent (at instance registration time) and any
2116
- # task containers that have reserved port mappings on the host (with
2117
- # the `host` or `bridge` network mode). Any port that is not specified
2117
+ # remaining CPU and memory that wasn't already allocated to tasks and
2118
+ # is therefore available for new tasks. For port resource types, this
2119
+ # parameter describes the ports that were reserved by the Amazon ECS
2120
+ # container agent (at instance registration time) and any task
2121
+ # containers that have reserved port mappings on the host (with the
2122
+ # `host` or `bridge` network mode). Any port that's not specified
2118
2123
  # here is available for new tasks.
2119
2124
  # @return [Array<Types::Resource>]
2120
2125
  #
@@ -2147,7 +2152,7 @@ module Aws::ECS
2147
2152
  # status.
2148
2153
  #
2149
2154
  # The `ACTIVE` status indicates that the container instance can accept
2150
- # tasks. The `DRAINING` indicates that new tasks are not placed on the
2155
+ # tasks. The `DRAINING` indicates that new tasks aren't placed on the
2151
2156
  # container instance and any service tasks running on the container
2152
2157
  # instance are removed if possible. For more information, see
2153
2158
  # [Container Instance Draining][1] in the *Amazon Elastic Container
@@ -2180,8 +2185,8 @@ module Aws::ECS
2180
2185
  # @return [Integer]
2181
2186
  #
2182
2187
  # @!attribute [rw] agent_update_status
2183
- # The status of the most recent agent update. If an update has never
2184
- # been requested, this value is `NULL`.
2188
+ # The status of the most recent agent update. If an update wasn't
2189
+ # ever requested, this value is `NULL`.
2185
2190
  # @return [String]
2186
2191
  #
2187
2192
  # @!attribute [rw] attributes
@@ -2191,7 +2196,8 @@ module Aws::ECS
2191
2196
  # @return [Array<Types::Attribute>]
2192
2197
  #
2193
2198
  # @!attribute [rw] registered_at
2194
- # The Unix timestamp for when the container instance was registered.
2199
+ # The Unix timestamp for the time when the container instance was
2200
+ # registered.
2195
2201
  # @return [Time]
2196
2202
  #
2197
2203
  # @!attribute [rw] attachments
@@ -2202,7 +2208,7 @@ module Aws::ECS
2202
2208
  # @!attribute [rw] tags
2203
2209
  # The metadata that you apply to the container instance to help you
2204
2210
  # categorize and organize them. Each tag consists of a key and an
2205
- # optional value, both of which you define.
2211
+ # optional value. You define both.
2206
2212
  #
2207
2213
  # The following basic restrictions apply to tags:
2208
2214
  #
@@ -2230,6 +2236,10 @@ module Aws::ECS
2230
2236
  # against your tags per resource limit.
2231
2237
  # @return [Array<Types::Tag>]
2232
2238
  #
2239
+ # @!attribute [rw] health_status
2240
+ # An object representing the health status of the container instance.
2241
+ # @return [Types::ContainerInstanceHealthStatus]
2242
+ #
2233
2243
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
2234
2244
  #
2235
2245
  class ContainerInstance < Struct.new(
@@ -2249,15 +2259,37 @@ module Aws::ECS
2249
2259
  :attributes,
2250
2260
  :registered_at,
2251
2261
  :attachments,
2252
- :tags)
2262
+ :tags,
2263
+ :health_status)
2253
2264
  SENSITIVE = []
2254
2265
  include Aws::Structure
2255
2266
  end
2256
2267
 
2257
- # The overrides that should be sent to a container. An empty container
2268
+ # An object representing the health status of the container instance.
2269
+ #
2270
+ # @!attribute [rw] overall_status
2271
+ # The overall health status of the container instance. This is an
2272
+ # aggregate status of all container instance health checks.
2273
+ # @return [String]
2274
+ #
2275
+ # @!attribute [rw] details
2276
+ # An array of objects representing the details of the container
2277
+ # instance health status.
2278
+ # @return [Array<Types::InstanceHealthCheckResult>]
2279
+ #
2280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstanceHealthStatus AWS API Documentation
2281
+ #
2282
+ class ContainerInstanceHealthStatus < Struct.new(
2283
+ :overall_status,
2284
+ :details)
2285
+ SENSITIVE = []
2286
+ include Aws::Structure
2287
+ end
2288
+
2289
+ # The overrides that are sent to a container. An empty container
2258
2290
  # override can be passed in. An example of an empty container override
2259
- # would be `\{"containerOverrides": [ ] \}`. If a non-empty container
2260
- # override is specified, the `name` parameter must be included.
2291
+ # is `\{"containerOverrides": [ ] \}`. If a non-empty container override
2292
+ # is specified, the `name` parameter must be included.
2261
2293
  #
2262
2294
  # @note When making an API call, you may pass ContainerOverride
2263
2295
  # data as a hash:
@@ -2352,7 +2384,7 @@ module Aws::ECS
2352
2384
  include Aws::Structure
2353
2385
  end
2354
2386
 
2355
- # An object representing a change in state for a container.
2387
+ # An object that represents a change in state for a container.
2356
2388
  #
2357
2389
  # @note When making an API call, you may pass ContainerStateChange
2358
2390
  # data as a hash:
@@ -2392,7 +2424,7 @@ module Aws::ECS
2392
2424
  # @return [Integer]
2393
2425
  #
2394
2426
  # @!attribute [rw] network_bindings
2395
- # Any network bindings associated with the container.
2427
+ # Any network bindings that are associated with the container.
2396
2428
  # @return [Array<Types::NetworkBinding>]
2397
2429
  #
2398
2430
  # @!attribute [rw] reason
@@ -2442,10 +2474,10 @@ module Aws::ECS
2442
2474
  # }
2443
2475
  #
2444
2476
  # @!attribute [rw] name
2445
- # The name of the capacity provider. Up to 255 characters are allowed,
2446
- # including letters (upper and lowercase), numbers, underscores, and
2447
- # hyphens. The name cannot be prefixed with "`aws`", "`ecs`", or
2448
- # "`fargate`".
2477
+ # The name of the capacity provider. Up to 255 characters are allowed.
2478
+ # They include letters (both upper and lowercase letters), numbers,
2479
+ # underscores (\_), and hyphens (-). The name can't be prefixed with
2480
+ # "`aws`", "`ecs`", or "`fargate`".
2449
2481
  # @return [String]
2450
2482
  #
2451
2483
  # @!attribute [rw] auto_scaling_group_provider
@@ -2453,9 +2485,9 @@ module Aws::ECS
2453
2485
  # @return [Types::AutoScalingGroupProvider]
2454
2486
  #
2455
2487
  # @!attribute [rw] tags
2456
- # The metadata that you apply to the capacity provider to help you
2457
- # categorize and organize them. Each tag consists of a key and an
2458
- # optional value, both of which you define.
2488
+ # The metadata that you apply to the capacity provider to categorize
2489
+ # and organize them more conveniently. Each tag consists of a key and
2490
+ # an optional value. You define both of them.
2459
2491
  #
2460
2492
  # The following basic restrictions apply to tags:
2461
2493
  #
@@ -2546,16 +2578,16 @@ module Aws::ECS
2546
2578
  # }
2547
2579
  #
2548
2580
  # @!attribute [rw] cluster_name
2549
- # The name of your cluster. If you do not specify a name for your
2550
- # cluster, you create a cluster named `default`. Up to 255 letters
2551
- # (uppercase and lowercase), numbers, underscores, and hyphens are
2552
- # allowed.
2581
+ # The name of your cluster. If you don't specify a name for your
2582
+ # cluster, you create a cluster that's named `default`. Up to 255
2583
+ # letters (uppercase and lowercase), numbers, underscores, and hyphens
2584
+ # are allowed.
2553
2585
  # @return [String]
2554
2586
  #
2555
2587
  # @!attribute [rw] tags
2556
2588
  # The metadata that you apply to the cluster to help you categorize
2557
- # and organize them. Each tag consists of a key and an optional value,
2558
- # both of which you define.
2589
+ # and organize them. Each tag consists of a key and an optional value.
2590
+ # You define both.
2559
2591
  #
2560
2592
  # The following basic restrictions apply to tags:
2561
2593
  #
@@ -2586,8 +2618,8 @@ module Aws::ECS
2586
2618
  # @!attribute [rw] settings
2587
2619
  # The setting to use when creating a cluster. This parameter is used
2588
2620
  # to enable CloudWatch Container Insights for a cluster. If this value
2589
- # is specified, it will override the `containerInsights` value set
2590
- # with PutAccountSetting or PutAccountSettingDefault.
2621
+ # is specified, it overrides the `containerInsights` value set with
2622
+ # PutAccountSetting or PutAccountSettingDefault.
2591
2623
  # @return [Array<Types::ClusterSetting>]
2592
2624
  #
2593
2625
  # @!attribute [rw] configuration
@@ -2602,10 +2634,9 @@ module Aws::ECS
2602
2634
  # calling the CreateService or RunTask actions.
2603
2635
  #
2604
2636
  # If specifying a capacity provider that uses an Auto Scaling group,
2605
- # the capacity provider must already be created and not already
2606
- # associated with another cluster. New Auto Scaling group capacity
2607
- # providers can be created with the CreateCapacityProvider API
2608
- # operation.
2637
+ # the capacity provider must be created but not associated with
2638
+ # another cluster. New Auto Scaling group capacity providers can be
2639
+ # created with the CreateCapacityProvider API operation.
2609
2640
  #
2610
2641
  # To use a Fargate capacity provider, specify either the `FARGATE` or
2611
2642
  # `FARGATE_SPOT` capacity providers. The Fargate capacity providers
@@ -2619,13 +2650,13 @@ module Aws::ECS
2619
2650
  #
2620
2651
  # @!attribute [rw] default_capacity_provider_strategy
2621
2652
  # The capacity provider strategy to set as the default for the
2622
- # cluster. When a default capacity provider strategy is set for a
2623
- # cluster, when calling the RunTask or CreateService APIs with no
2653
+ # cluster. After a default capacity provider strategy is set for a
2654
+ # cluster, when you call the RunTask or CreateService APIs with no
2624
2655
  # capacity provider strategy or launch type specified, the default
2625
2656
  # capacity provider strategy for the cluster is used.
2626
2657
  #
2627
- # If a default capacity provider strategy is not defined for a cluster
2628
- # during creation, it can be defined later with the
2658
+ # If a default capacity provider strategy isn't defined for a cluster
2659
+ # when it was created, it can be defined later with the
2629
2660
  # PutClusterCapacityProviders API operation.
2630
2661
  # @return [Array<Types::CapacityProviderStrategyItem>]
2631
2662
  #
@@ -2733,8 +2764,8 @@ module Aws::ECS
2733
2764
  # }
2734
2765
  #
2735
2766
  # @!attribute [rw] cluster
2736
- # The short name or full Amazon Resource Name (ARN) of the cluster on
2737
- # which to run your service. If you do not specify a cluster, the
2767
+ # The short name or full Amazon Resource Name (ARN) of the cluster
2768
+ # that you run your service on. If you do not specify a cluster, the
2738
2769
  # default cluster is assumed.
2739
2770
  # @return [String]
2740
2771
  #
@@ -2748,11 +2779,11 @@ module Aws::ECS
2748
2779
  #
2749
2780
  # @!attribute [rw] task_definition
2750
2781
  # The `family` and `revision` (`family:revision`) or full ARN of the
2751
- # task definition to run in your service. If a `revision` is not
2782
+ # task definition to run in your service. If a `revision` isn't
2752
2783
  # specified, the latest `ACTIVE` revision is used.
2753
2784
  #
2754
- # A task definition must be specified if the service is using either
2755
- # the `ECS` or `CODE_DEPLOY` deployment controllers.
2785
+ # A task definition must be specified if the service uses either the
2786
+ # `ECS` or `CODE_DEPLOY` deployment controllers.
2756
2787
  # @return [String]
2757
2788
  #
2758
2789
  # @!attribute [rw] load_balancers
@@ -2760,56 +2791,57 @@ module Aws::ECS
2760
2791
  # your service. For more information, see [Service Load Balancing][1]
2761
2792
  # in the *Amazon Elastic Container Service Developer Guide*.
2762
2793
  #
2763
- # If the service is using the rolling update (`ECS`) deployment
2764
- # controller and using either an Application Load Balancer or Network
2765
- # Load Balancer, you must specify one or more target group ARNs to
2766
- # attach to the service. The service-linked role is required for
2767
- # services that make use of multiple target groups. For more
2768
- # information, see [Using service-linked roles for Amazon ECS][2] in
2769
- # the *Amazon Elastic Container Service Developer Guide*.
2794
+ # If the service uses the rolling update (`ECS`) deployment controller
2795
+ # and using either an Application Load Balancer or Network Load
2796
+ # Balancer, you must specify one or more target group ARNs to attach
2797
+ # to the service. The service-linked role is required for services
2798
+ # that use multiple target groups. For more information, see [Using
2799
+ # service-linked roles for Amazon ECS][2] in the *Amazon Elastic
2800
+ # Container Service Developer Guide*.
2770
2801
  #
2771
- # If the service is using the `CODE_DEPLOY` deployment controller, the
2802
+ # If the service uses the `CODE_DEPLOY` deployment controller, the
2772
2803
  # service is required to use either an Application Load Balancer or
2773
2804
  # Network Load Balancer. When creating an CodeDeploy deployment group,
2774
2805
  # you specify two target groups (referred to as a `targetGroupPair`).
2775
2806
  # During a deployment, CodeDeploy determines which task set in your
2776
- # service has the status `PRIMARY` and associates one target group
2777
- # with it, and then associates the other target group with the
2807
+ # service has the status `PRIMARY`, and it associates one target group
2808
+ # with it. Then, it also associates the other target group with the
2778
2809
  # replacement task set. The load balancer can also have up to two
2779
2810
  # listeners: a required listener for production traffic and an
2780
- # optional listener that allows you perform validation tests with
2811
+ # optional listener that you can use to perform validation tests with
2781
2812
  # Lambda functions before routing production traffic to it.
2782
2813
  #
2783
2814
  # After you create a service using the `ECS` deployment controller,
2784
2815
  # the load balancer name or target group ARN, container name, and
2785
- # container port specified in the service definition are immutable. If
2786
- # you are using the `CODE_DEPLOY` deployment controller, these values
2787
- # can be changed when updating the service.
2816
+ # container port that's specified in the service definition are
2817
+ # immutable. If you use the `CODE_DEPLOY` deployment controller, these
2818
+ # values can be changed when updating the service.
2788
2819
  #
2789
2820
  # For Application Load Balancers and Network Load Balancers, this
2790
2821
  # object must contain the load balancer target group ARN, the
2791
- # container name (as it appears in a container definition), and the
2792
- # container port to access from the load balancer. The load balancer
2793
- # name parameter must be omitted. When a task from this service is
2794
- # placed on a container instance, the container instance and port
2795
- # combination is registered as a target in the target group specified
2796
- # here.
2822
+ # container name, and the container port to access from the load
2823
+ # balancer. The container name must be as it appears in a container
2824
+ # definition. The load balancer name parameter must be omitted. When a
2825
+ # task from this service is placed on a container instance, the
2826
+ # container instance and port combination is registered as a target in
2827
+ # the target group that's specified here.
2797
2828
  #
2798
2829
  # For Classic Load Balancers, this object must contain the load
2799
- # balancer name, the container name (as it appears in a container
2800
- # definition), and the container port to access from the load
2801
- # balancer. The target group ARN parameter must be omitted. When a
2802
- # task from this service is placed on a container instance, the
2803
- # container instance is registered with the load balancer specified
2804
- # here.
2830
+ # balancer name, the container name , and the container port to access
2831
+ # from the load balancer. The container name must be as it appears in
2832
+ # a container definition. The target group ARN parameter must be
2833
+ # omitted. When a task from this service is placed on a container
2834
+ # instance, the container instance is registered with the load
2835
+ # balancer that's specified here.
2805
2836
  #
2806
2837
  # Services with tasks that use the `awsvpc` network mode (for example,
2807
2838
  # those with the Fargate launch type) only support Application Load
2808
- # Balancers and Network Load Balancers. Classic Load Balancers are not
2839
+ # Balancers and Network Load Balancers. Classic Load Balancers aren't
2809
2840
  # supported. Also, when you create any target groups for these
2810
- # services, you must choose `ip` as the target type, not `instance`,
2811
- # because tasks that use the `awsvpc` network mode are associated with
2812
- # an elastic network interface, not an Amazon EC2 instance.
2841
+ # services, you must choose `ip` as the target type, not `instance`.
2842
+ # This is because tasks that use the `awsvpc` network mode are
2843
+ # associated with an elastic network interface, not an Amazon EC2
2844
+ # instance.
2813
2845
  #
2814
2846
  #
2815
2847
  #
@@ -2822,7 +2854,7 @@ module Aws::ECS
2822
2854
  # service. For more information, see [Service discovery][1].
2823
2855
  #
2824
2856
  # <note markdown="1"> Each service may be associated with one service registry. Multiple
2825
- # service registries per service isn't supported.
2857
+ # service registries for each service isn't supported.
2826
2858
  #
2827
2859
  # </note>
2828
2860
  #
@@ -2835,18 +2867,19 @@ module Aws::ECS
2835
2867
  # The number of instantiations of the specified task definition to
2836
2868
  # place and keep running on your cluster.
2837
2869
  #
2838
- # This is required if `schedulingStrategy` is `REPLICA` or is not
2839
- # specified. If `schedulingStrategy` is `DAEMON` then this is not
2870
+ # This is required if `schedulingStrategy` is `REPLICA` or isn't
2871
+ # specified. If `schedulingStrategy` is `DAEMON` then this isn't
2840
2872
  # required.
2841
2873
  # @return [Integer]
2842
2874
  #
2843
2875
  # @!attribute [rw] client_token
2844
- # Unique, case-sensitive identifier that you provide to ensure the
2845
- # idempotency of the request. Up to 32 ASCII characters are allowed.
2876
+ # An identifier that you provide to ensure the idempotency of the
2877
+ # request. It must be unique and is case sensitive. Up to 32 ASCII
2878
+ # characters are allowed.
2846
2879
  # @return [String]
2847
2880
  #
2848
2881
  # @!attribute [rw] launch_type
2849
- # The infrastructure on which to run your service. For more
2882
+ # The infrastructure that you run your service on. For more
2850
2883
  # information, see [Amazon ECS launch types][1] in the *Amazon Elastic
2851
2884
  # Container Service Developer Guide*.
2852
2885
  #
@@ -2862,8 +2895,8 @@ module Aws::ECS
2862
2895
  # The `EC2` launch type runs your tasks on Amazon EC2 instances
2863
2896
  # registered to your cluster.
2864
2897
  #
2865
- # The `EXTERNAL` launch type runs your tasks on your on-premise server
2866
- # or virtual machine (VM) capacity registered to your cluster.
2898
+ # The `EXTERNAL` launch type runs your tasks on your on-premises
2899
+ # server or virtual machine (VM) capacity registered to your cluster.
2867
2900
  #
2868
2901
  # A service can use either a launch type or a capacity provider
2869
2902
  # strategy. If a `launchType` is specified, the
@@ -2891,9 +2924,8 @@ module Aws::ECS
2891
2924
  # The platform version that your tasks in the service are running on.
2892
2925
  # A platform version is specified only for tasks using the Fargate
2893
2926
  # launch type. If one isn't specified, the `LATEST` platform version
2894
- # is used by default. For more information, see [Fargate platform
2895
- # versions][1] in the *Amazon Elastic Container Service Developer
2896
- # Guide*.
2927
+ # is used. For more information, see [Fargate platform versions][1] in
2928
+ # the *Amazon Elastic Container Service Developer Guide*.
2897
2929
  #
2898
2930
  #
2899
2931
  #
@@ -2904,20 +2936,20 @@ module Aws::ECS
2904
2936
  # The name or full Amazon Resource Name (ARN) of the IAM role that
2905
2937
  # allows Amazon ECS to make calls to your load balancer on your
2906
2938
  # behalf. This parameter is only permitted if you are using a load
2907
- # balancer with your service and your task definition does not use the
2939
+ # balancer with your service and your task definition doesn't use the
2908
2940
  # `awsvpc` network mode. If you specify the `role` parameter, you must
2909
2941
  # also specify a load balancer object with the `loadBalancers`
2910
2942
  # parameter.
2911
2943
  #
2912
2944
  # If your account has already created the Amazon ECS service-linked
2913
- # role, that role is used by default for your service unless you
2914
- # specify a role here. The service-linked role is required if your
2915
- # task definition uses the `awsvpc` network mode or if the service is
2916
- # configured to use service discovery, an external deployment
2917
- # controller, multiple target groups, or Elastic Inference
2918
- # accelerators in which case you should not specify a role here. For
2919
- # more information, see [Using service-linked roles for Amazon ECS][1]
2920
- # in the *Amazon Elastic Container Service Developer Guide*.
2945
+ # role, that role is used for your service unless you specify a role
2946
+ # here. The service-linked role is required if your task definition
2947
+ # uses the `awsvpc` network mode or if the service is configured to
2948
+ # use service discovery, an external deployment controller, multiple
2949
+ # target groups, or Elastic Inference accelerators in which case you
2950
+ # don't specify a role here. For more information, see [Using
2951
+ # service-linked roles for Amazon ECS][1] in the *Amazon Elastic
2952
+ # Container Service Developer Guide*.
2921
2953
  #
2922
2954
  # If your specified role has a path other than `/`, then you must
2923
2955
  # either specify the full role ARN (this is recommended) or prefix the
@@ -2940,20 +2972,20 @@ module Aws::ECS
2940
2972
  #
2941
2973
  # @!attribute [rw] placement_constraints
2942
2974
  # An array of placement constraint objects to use for tasks in your
2943
- # service. You can specify a maximum of 10 constraints per task (this
2944
- # limit includes constraints in the task definition and those
2945
- # specified at runtime).
2975
+ # service. You can specify a maximum of 10 constraints for each task.
2976
+ # This limit includes constraints in the task definition and those
2977
+ # specified at runtime.
2946
2978
  # @return [Array<Types::PlacementConstraint>]
2947
2979
  #
2948
2980
  # @!attribute [rw] placement_strategy
2949
2981
  # The placement strategy objects to use for tasks in your service. You
2950
- # can specify a maximum of 5 strategy rules per service.
2982
+ # can specify a maximum of 5 strategy rules for each service.
2951
2983
  # @return [Array<Types::PlacementStrategy>]
2952
2984
  #
2953
2985
  # @!attribute [rw] network_configuration
2954
2986
  # The network configuration for the service. This parameter is
2955
2987
  # required for task definitions that use the `awsvpc` network mode to
2956
- # receive their own elastic network interface, and it is not supported
2988
+ # receive their own elastic network interface, and it isn't supported
2957
2989
  # for other network modes. For more information, see [Task
2958
2990
  # networking][1] in the *Amazon Elastic Container Service Developer
2959
2991
  # Guide*.
@@ -2965,18 +2997,19 @@ module Aws::ECS
2965
2997
  #
2966
2998
  # @!attribute [rw] health_check_grace_period_seconds
2967
2999
  # The period of time, in seconds, that the Amazon ECS service
2968
- # scheduler should ignore unhealthy Elastic Load Balancing target
2969
- # health checks after a task has first started. This is only used when
2970
- # your service is configured to use a load balancer. If your service
2971
- # has a load balancer defined and you don't specify a health check
2972
- # grace period value, the default value of `0` is used.
3000
+ # scheduler ignores unhealthy Elastic Load Balancing target health
3001
+ # checks after a task has first started. This is only used when your
3002
+ # service is configured to use a load balancer. If your service has a
3003
+ # load balancer defined and you don't specify a health check grace
3004
+ # period value, the default value of `0` is used.
2973
3005
  #
2974
3006
  # If your service's tasks take a while to start and respond to
2975
3007
  # Elastic Load Balancing health checks, you can specify a health check
2976
- # grace period of up to 2,147,483,647 seconds. During that time, the
2977
- # Amazon ECS service scheduler ignores health check status. This grace
2978
- # period can prevent the service scheduler from marking tasks as
2979
- # unhealthy and stopping them before they have time to come up.
3008
+ # grace period of up to 2,147,483,647 seconds (about 69 years). During
3009
+ # that time, the Amazon ECS service scheduler ignores health check
3010
+ # status. This grace period can prevent the service scheduler from
3011
+ # marking tasks as unhealthy and stopping them before they have time
3012
+ # to come up.
2980
3013
  # @return [Integer]
2981
3014
  #
2982
3015
  # @!attribute [rw] scheduling_strategy
@@ -2990,14 +3023,14 @@ module Aws::ECS
2990
3023
  # service scheduler spreads tasks across Availability Zones. You can
2991
3024
  # use task placement strategies and constraints to customize task
2992
3025
  # placement decisions. This scheduler strategy is required if the
2993
- # service is using the `CODE_DEPLOY` or `EXTERNAL` deployment
2994
- # controller types.
3026
+ # service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller
3027
+ # types.
2995
3028
  #
2996
3029
  # * `DAEMON`-The daemon scheduling strategy deploys exactly one task
2997
3030
  # on each active container instance that meets all of the task
2998
3031
  # placement constraints that you specify in your cluster. The
2999
3032
  # service scheduler also evaluates the task placement constraints
3000
- # for running tasks and will stop tasks that do not meet the
3033
+ # for running tasks and will stop tasks that don't meet the
3001
3034
  # placement constraints. When you're using this strategy, you
3002
3035
  # don't need to specify a desired number of tasks, a task placement
3003
3036
  # strategy, or use Service Auto Scaling policies.
@@ -3064,16 +3097,16 @@ module Aws::ECS
3064
3097
  # @!attribute [rw] propagate_tags
3065
3098
  # Specifies whether to propagate the tags from the task definition or
3066
3099
  # the service to the tasks in the service. If no value is specified,
3067
- # the tags are not propagated. Tags can only be propagated to the
3100
+ # the tags aren't propagated. Tags can only be propagated to the
3068
3101
  # tasks within the service during service creation. To add tags to a
3069
3102
  # task after service creation or task creation, use the TagResource
3070
3103
  # API action.
3071
3104
  # @return [String]
3072
3105
  #
3073
3106
  # @!attribute [rw] enable_execute_command
3074
- # Whether or not the execute command functionality is enabled for the
3075
- # service. If `true`, this enables execute command functionality on
3076
- # all containers in the service tasks.
3107
+ # Determines whether the execute command functionality is enabled for
3108
+ # the service. If `true`, this enables execute command functionality
3109
+ # on all containers in the service tasks.
3077
3110
  # @return [Boolean]
3078
3111
  #
3079
3112
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceRequest AWS API Documentation
@@ -3109,14 +3142,14 @@ module Aws::ECS
3109
3142
  # The full description of your service following the create call.
3110
3143
  #
3111
3144
  # A service will return either a `capacityProviderStrategy` or
3112
- # `launchType` parameter, but not both, depending on which one was
3113
- # specified during creation.
3145
+ # `launchType` parameter, but not both, depending where one was
3146
+ # specified when it was created.
3114
3147
  #
3115
3148
  # If a service is using the `ECS` deployment controller, the
3116
3149
  # `deploymentController` and `taskSets` parameters will not be
3117
3150
  # returned.
3118
3151
  #
3119
- # If the service is using the `CODE_DEPLOY` deployment controller, the
3152
+ # if the service uses the `CODE_DEPLOY` deployment controller, the
3120
3153
  # `deploymentController`, `taskSets` and `deployments` parameters will
3121
3154
  # be returned, however the `deployments` parameter will be an empty
3122
3155
  # list.
@@ -3225,7 +3258,7 @@ module Aws::ECS
3225
3258
  # @return [Array<Types::ServiceRegistry>]
3226
3259
  #
3227
3260
  # @!attribute [rw] launch_type
3228
- # The launch type that new tasks in the task set will use. For more
3261
+ # The launch type that new tasks in the task set uses. For more
3229
3262
  # information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
3230
3263
  # Container Service Developer Guide*.
3231
3264
  #
@@ -3268,10 +3301,9 @@ module Aws::ECS
3268
3301
  # @return [Array<Types::CapacityProviderStrategyItem>]
3269
3302
  #
3270
3303
  # @!attribute [rw] platform_version
3271
- # The platform version that the tasks in the task set should use. A
3272
- # platform version is specified only for tasks using the Fargate
3273
- # launch type. If one isn't specified, the `LATEST` platform version
3274
- # is used by default.
3304
+ # The platform version that the tasks in the task set uses. A platform
3305
+ # version is specified only for tasks using the Fargate launch type.
3306
+ # If one isn't specified, the `LATEST` platform version is used.
3275
3307
  # @return [String]
3276
3308
  #
3277
3309
  # @!attribute [rw] scale
@@ -3280,15 +3312,15 @@ module Aws::ECS
3280
3312
  # @return [Types::Scale]
3281
3313
  #
3282
3314
  # @!attribute [rw] client_token
3283
- # Unique, case-sensitive identifier that you provide to ensure the
3284
- # idempotency of the request. Up to 32 ASCII characters are allowed.
3315
+ # The identifier that you provide to ensure the idempotency of the
3316
+ # request. It's case sensitive and must be unique. It can be up to 32
3317
+ # ASCII characters are allowed.
3285
3318
  # @return [String]
3286
3319
  #
3287
3320
  # @!attribute [rw] tags
3288
3321
  # The metadata that you apply to the task set to help you categorize
3289
- # and organize them. Each tag consists of a key and an optional value,
3290
- # both of which you define. When a service is deleted, the tags are
3291
- # deleted as well.
3322
+ # and organize them. Each tag consists of a key and an optional value.
3323
+ # You define both. When a service is deleted, the tags are deleted.
3292
3324
  #
3293
3325
  # The following basic restrictions apply to tags:
3294
3326
  #
@@ -3360,7 +3392,7 @@ module Aws::ECS
3360
3392
  # }
3361
3393
  #
3362
3394
  # @!attribute [rw] name
3363
- # The resource name for which to disable the account setting. If
3395
+ # The resource name to disable the account setting for. If
3364
3396
  # `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
3365
3397
  # services is affected. If `taskLongArnFormat` is specified, the ARN
3366
3398
  # and resource ID for your Amazon ECS tasks is affected. If
@@ -3371,12 +3403,12 @@ module Aws::ECS
3371
3403
  # @return [String]
3372
3404
  #
3373
3405
  # @!attribute [rw] principal_arn
3374
- # The ARN of the principal, which can be an IAM user, IAM role, or the
3375
- # root user. If you specify the root user, it disables the account
3376
- # setting for all IAM users, IAM roles, and the root user of the
3377
- # account unless an IAM user or role explicitly overrides these
3378
- # settings. If this field is omitted, the setting is changed only for
3379
- # the authenticated user.
3406
+ # The Amazon Resource Name (ARN) of the principal. It can be an IAM
3407
+ # user, IAM role, or the root user. If you specify the root user, it
3408
+ # disables the account setting for all IAM users, IAM roles, and the
3409
+ # root user of the account unless an IAM user or role explicitly
3410
+ # overrides these settings. If this field is omitted, the setting is
3411
+ # changed only for the authenticated user.
3380
3412
  # @return [String]
3381
3413
  #
3382
3414
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSettingRequest AWS API Documentation
@@ -3423,8 +3455,8 @@ module Aws::ECS
3423
3455
  #
3424
3456
  # @!attribute [rw] attributes
3425
3457
  # The attributes to delete from your resource. You can specify up to
3426
- # 10 attributes per request. For custom attributes, specify the
3427
- # attribute name and target ID, but do not specify the value. If you
3458
+ # 10 attributes for each request. For custom attributes, specify the
3459
+ # attribute name and target ID, but don't specify the value. If you
3428
3460
  # specify the target ID using the short form, you must also specify
3429
3461
  # the target type.
3430
3462
  # @return [Array<Types::Attribute>]
@@ -3535,9 +3567,9 @@ module Aws::ECS
3535
3567
  # @return [String]
3536
3568
  #
3537
3569
  # @!attribute [rw] force
3538
- # If `true`, allows you to delete a service even if it has not been
3539
- # scaled down to zero tasks. It is only necessary to use this if the
3540
- # service is using the `REPLICA` scheduling strategy.
3570
+ # If `true`, allows you to delete a service even if it wasn't scaled
3571
+ # down to zero tasks. It's only necessary to use this if the service
3572
+ # uses the `REPLICA` scheduling strategy.
3541
3573
  # @return [Boolean]
3542
3574
  #
3543
3575
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteServiceRequest AWS API Documentation
@@ -3574,7 +3606,7 @@ module Aws::ECS
3574
3606
  #
3575
3607
  # @!attribute [rw] cluster
3576
3608
  # The short name or full Amazon Resource Name (ARN) of the cluster
3577
- # that hosts the service that the task set exists in to delete.
3609
+ # that hosts the service that the task set found in to delete.
3578
3610
  # @return [String]
3579
3611
  #
3580
3612
  # @!attribute [rw] service
@@ -3588,8 +3620,8 @@ module Aws::ECS
3588
3620
  # @return [String]
3589
3621
  #
3590
3622
  # @!attribute [rw] force
3591
- # If `true`, this allows you to delete a task set even if it hasn't
3592
- # been scaled down to zero.
3623
+ # If `true`, you can delete a task set even if it hasn't been scaled
3624
+ # down to zero.
3593
3625
  # @return [Boolean]
3594
3626
  #
3595
3627
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskSetRequest AWS API Documentation
@@ -3623,7 +3655,7 @@ module Aws::ECS
3623
3655
  # @return [String]
3624
3656
  #
3625
3657
  # @!attribute [rw] status
3626
- # The status of the deployment. The following describes each state:
3658
+ # The status of the deployment. The following describes each state.
3627
3659
  #
3628
3660
  # PRIMARY
3629
3661
  #
@@ -3673,11 +3705,13 @@ module Aws::ECS
3673
3705
  # @return [Integer]
3674
3706
  #
3675
3707
  # @!attribute [rw] created_at
3676
- # The Unix timestamp for when the service deployment was created.
3708
+ # The Unix timestamp for the time when the service deployment was
3709
+ # created.
3677
3710
  # @return [Time]
3678
3711
  #
3679
3712
  # @!attribute [rw] updated_at
3680
- # The Unix timestamp for when the service deployment was last updated.
3713
+ # The Unix timestamp for the time when the service deployment was last
3714
+ # updated.
3681
3715
  # @return [Time]
3682
3716
  #
3683
3717
  # @!attribute [rw] capacity_provider_strategy
@@ -3695,12 +3729,11 @@ module Aws::ECS
3695
3729
  # @return [String]
3696
3730
  #
3697
3731
  # @!attribute [rw] platform_version
3698
- # The platform version on which your tasks in the service are running.
3699
- # A platform version is only specified for tasks using the Fargate
3700
- # launch type. If one is not specified, the `LATEST` platform version
3701
- # is used by default. For more information, see [Fargate Platform
3702
- # Versions][1] in the *Amazon Elastic Container Service Developer
3703
- # Guide*.
3732
+ # The platform version that your tasks in the service run on. A
3733
+ # platform version is only specified for tasks using the Fargate
3734
+ # launch type. If one isn't specified, the `LATEST` platform version
3735
+ # is used. For more information, see [Fargate Platform Versions][1] in
3736
+ # the *Amazon Elastic Container Service Developer Guide*.
3704
3737
  #
3705
3738
  #
3706
3739
  #
@@ -3724,18 +3757,18 @@ module Aws::ECS
3724
3757
  #
3725
3758
  # @!attribute [rw] rollout_state
3726
3759
  # <note markdown="1"> The `rolloutState` of a service is only returned for services that
3727
- # use the rolling update (`ECS`) deployment type that are not behind a
3760
+ # use the rolling update (`ECS`) deployment type that aren't behind a
3728
3761
  # Classic Load Balancer.
3729
3762
  #
3730
3763
  # </note>
3731
3764
  #
3732
3765
  # The rollout state of the deployment. When a service deployment is
3733
3766
  # started, it begins in an `IN_PROGRESS` state. When the service
3734
- # reaches a steady state, the deployment will transition to a
3735
- # `COMPLETED` state. If the service fails to reach a steady state and
3736
- # circuit breaker is enabled, the deployment will transition to a
3737
- # `FAILED` state. A deployment in `FAILED` state will launch no new
3738
- # tasks. For more information, see DeploymentCircuitBreaker.
3767
+ # reaches a steady state, the deployment transitions to a `COMPLETED`
3768
+ # state. If the service fails to reach a steady state and circuit
3769
+ # breaker is enabled, the deployment transitions to a `FAILED` state.
3770
+ # A deployment in `FAILED` state doesn't launch any new tasks. For
3771
+ # more information, see DeploymentCircuitBreaker.
3739
3772
  # @return [String]
3740
3773
  #
3741
3774
  # @!attribute [rw] rollout_state_reason
@@ -3766,7 +3799,7 @@ module Aws::ECS
3766
3799
  end
3767
3800
 
3768
3801
  # <note markdown="1"> The deployment circuit breaker can only be used for services using the
3769
- # rolling update (`ECS`) deployment type that are not behind a Classic
3802
+ # rolling update (`ECS`) deployment type that aren't behind a Classic
3770
3803
  # Load Balancer.
3771
3804
  #
3772
3805
  # </note>
@@ -3792,15 +3825,15 @@ module Aws::ECS
3792
3825
  # }
3793
3826
  #
3794
3827
  # @!attribute [rw] enable
3795
- # Whether to enable the deployment circuit breaker logic for the
3796
- # service.
3828
+ # Determines whether to enable the deployment circuit breaker logic
3829
+ # for the service.
3797
3830
  # @return [Boolean]
3798
3831
  #
3799
3832
  # @!attribute [rw] rollback
3800
- # Whether to enable Amazon ECS to roll back the service if a service
3801
- # deployment fails. If rollback is enabled, when a service deployment
3802
- # fails, the service is rolled back to the last deployment that
3803
- # completed successfully.
3833
+ # Determines whether to enable Amazon ECS to roll back the service if
3834
+ # a service deployment fails. If rollback is enabled, when a service
3835
+ # deployment fails, the service is rolled back to the last deployment
3836
+ # that completed successfully.
3804
3837
  # @return [Boolean]
3805
3838
  #
3806
3839
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentCircuitBreaker AWS API Documentation
@@ -3877,10 +3910,10 @@ module Aws::ECS
3877
3910
  # service has a desired number of four tasks and a minimum healthy
3878
3911
  # percent of 50%, the scheduler may stop two existing tasks to free up
3879
3912
  # cluster capacity before starting two new tasks. Tasks for services
3880
- # that *do not* use a load balancer are considered healthy if they are
3913
+ # that *do not* use a load balancer are considered healthy if they're
3881
3914
  # in the `RUNNING` state; tasks for services that *do* use a load
3882
- # balancer are considered healthy if they are in the `RUNNING` state
3883
- # and they are reported as healthy by the load balancer. The default
3915
+ # balancer are considered healthy if they're in the `RUNNING` state
3916
+ # and they're reported as healthy by the load balancer. The default
3884
3917
  # value for minimum healthy percent is 100%.
3885
3918
  #
3886
3919
  # If a service is using the blue/green (`CODE_DEPLOY`) or `EXTERNAL`
@@ -3979,13 +4012,13 @@ module Aws::ECS
3979
4012
  # @return [String]
3980
4013
  #
3981
4014
  # @!attribute [rw] force
3982
- # Forces the deregistration of the container instance. If you have
3983
- # tasks running on the container instance when you deregister it with
3984
- # the `force` option, these tasks remain running until you terminate
3985
- # the instance or the tasks stop through some other means, but they
3986
- # are orphaned (no longer monitored or accounted for by Amazon ECS).
3987
- # If an orphaned task on your container instance is part of an Amazon
3988
- # ECS service, then the service scheduler starts another copy of that
4015
+ # Forces the container instance to be deregistered. If you have tasks
4016
+ # running on the container instance when you deregister it with the
4017
+ # `force` option, these tasks remain running until you terminate the
4018
+ # instance or the tasks stop through some other means, but they're
4019
+ # orphaned (no longer monitored or accounted for by Amazon ECS). If an
4020
+ # orphaned task on your container instance is part of an Amazon ECS
4021
+ # service, then the service scheduler starts another copy of that
3989
4022
  # task, on a different container instance if possible.
3990
4023
  #
3991
4024
  # Any containers in orphaned service tasks that are registered with a
@@ -4068,7 +4101,7 @@ module Aws::ECS
4068
4101
  # @!attribute [rw] include
4069
4102
  # Specifies whether or not you want to see the resource tags for the
4070
4103
  # capacity provider. If `TAGS` is specified, the tags are included in
4071
- # the response. If this field is omitted, tags are not included in the
4104
+ # the response. If this field is omitted, tags aren't included in the
4072
4105
  # response.
4073
4106
  # @return [Array<String>]
4074
4107
  #
@@ -4150,9 +4183,9 @@ module Aws::ECS
4150
4183
  # @return [Array<String>]
4151
4184
  #
4152
4185
  # @!attribute [rw] include
4153
- # Whether to include additional information about the clusters in the
4154
- # response. If this field is omitted, this information isn't
4155
- # included.
4186
+ # Determines whether to include additional information about the
4187
+ # clusters in the response. If this field is omitted, this information
4188
+ # isn't included.
4156
4189
  #
4157
4190
  # If `ATTACHMENTS` is specified, the attachments for the container
4158
4191
  # instances or tasks within the cluster are included.
@@ -4202,7 +4235,7 @@ module Aws::ECS
4202
4235
  # {
4203
4236
  # cluster: "String",
4204
4237
  # container_instances: ["String"], # required
4205
- # include: ["TAGS"], # accepts TAGS
4238
+ # include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
4206
4239
  # }
4207
4240
  #
4208
4241
  # @!attribute [rw] cluster
@@ -4222,8 +4255,10 @@ module Aws::ECS
4222
4255
  # @!attribute [rw] include
4223
4256
  # Specifies whether you want to see the resource tags for the
4224
4257
  # container instance. If `TAGS` is specified, the tags are included in
4225
- # the response. If this field is omitted, tags are not included in the
4226
- # response.
4258
+ # the response. If `CONTAINER_INSTANCE_HEALTH` is specified, the
4259
+ # container instance health is included in the response. If this field
4260
+ # is omitted, tags and container instance health status aren't
4261
+ # included in the response.
4227
4262
  # @return [Array<String>]
4228
4263
  #
4229
4264
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstancesRequest AWS API Documentation
@@ -4276,9 +4311,10 @@ module Aws::ECS
4276
4311
  # @return [Array<String>]
4277
4312
  #
4278
4313
  # @!attribute [rw] include
4279
- # Specifies whether you want to see the resource tags for the service.
4280
- # If `TAGS` is specified, the tags are included in the response. If
4281
- # this field is omitted, tags are not included in the response.
4314
+ # Determines whether you want to see the resource tags for the
4315
+ # service. If `TAGS` is specified, the tags are included in the
4316
+ # response. If this field is omitted, tags aren't included in the
4317
+ # response.
4282
4318
  # @return [Array<String>]
4283
4319
  #
4284
4320
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServicesRequest AWS API Documentation
@@ -4324,9 +4360,9 @@ module Aws::ECS
4324
4360
  # @return [String]
4325
4361
  #
4326
4362
  # @!attribute [rw] include
4327
- # Specifies whether to see the resource tags for the task definition.
4363
+ # Determines whether to see the resource tags for the task definition.
4328
4364
  # If `TAGS` is specified, the tags are included in the response. If
4329
- # this field is omitted, tags are not included in the response.
4365
+ # this field is omitted, tags aren't included in the response.
4330
4366
  # @return [Array<String>]
4331
4367
  #
4332
4368
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionRequest AWS API Documentation
@@ -4343,9 +4379,9 @@ module Aws::ECS
4343
4379
  # @return [Types::TaskDefinition]
4344
4380
  #
4345
4381
  # @!attribute [rw] tags
4346
- # The metadata that is applied to the task definition to help you
4382
+ # The metadata that's applied to the task definition to help you
4347
4383
  # categorize and organize them. Each tag consists of a key and an
4348
- # optional value, both of which you define.
4384
+ # optional value. You define both.
4349
4385
  #
4350
4386
  # The following basic restrictions apply to tags:
4351
4387
  #
@@ -4409,7 +4445,7 @@ module Aws::ECS
4409
4445
  # @!attribute [rw] include
4410
4446
  # Specifies whether to see the resource tags for the task set. If
4411
4447
  # `TAGS` is specified, the tags are included in the response. If this
4412
- # field is omitted, tags are not included in the response.
4448
+ # field is omitted, tags aren't included in the response.
4413
4449
  # @return [Array<String>]
4414
4450
  #
4415
4451
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSetsRequest AWS API Documentation
@@ -4464,7 +4500,7 @@ module Aws::ECS
4464
4500
  # @!attribute [rw] include
4465
4501
  # Specifies whether you want to see the resource tags for the task. If
4466
4502
  # `TAGS` is specified, the tags are included in the response. If this
4467
- # field is omitted, tags are not included in the response.
4503
+ # field is omitted, tags aren't included in the response.
4468
4504
  # @return [Array<String>]
4469
4505
  #
4470
4506
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasksRequest AWS API Documentation
@@ -4547,8 +4583,8 @@ module Aws::ECS
4547
4583
  # @return [String]
4548
4584
  #
4549
4585
  # @!attribute [rw] cluster
4550
- # The short name or full Amazon Resource Name (ARN) of the cluster to
4551
- # which the container instance belongs.
4586
+ # The short name or full Amazon Resource Name (ARN) of the cluster
4587
+ # that the container instance belongs to.
4552
4588
  # @return [String]
4553
4589
  #
4554
4590
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpointRequest AWS API Documentation
@@ -4577,8 +4613,8 @@ module Aws::ECS
4577
4613
  include Aws::Structure
4578
4614
  end
4579
4615
 
4580
- # This parameter is specified when you are using Docker volumes. Docker
4581
- # volumes are only supported when you are using the EC2 launch type.
4616
+ # This parameter is specified when you're using Docker volumes. Docker
4617
+ # volumes are only supported when you're using the EC2 launch type.
4582
4618
  # Windows containers only support the use of the `local` driver. To use
4583
4619
  # bind mounts, specify a `host` instead.
4584
4620
  #
@@ -4606,7 +4642,7 @@ module Aws::ECS
4606
4642
  # @return [String]
4607
4643
  #
4608
4644
  # @!attribute [rw] autoprovision
4609
- # If this value is `true`, the Docker volume is created if it does not
4645
+ # If this value is `true`, the Docker volume is created if it doesn't
4610
4646
  # already exist.
4611
4647
  #
4612
4648
  # <note markdown="1"> This field is only used if the `scope` is `shared`.
@@ -4698,12 +4734,13 @@ module Aws::ECS
4698
4734
  # @return [String]
4699
4735
  #
4700
4736
  # @!attribute [rw] iam
4701
- # Whether or not to use the Amazon ECS task IAM role defined in a task
4702
- # definition when mounting the Amazon EFS file system. If enabled,
4703
- # transit encryption must be enabled in the `EFSVolumeConfiguration`.
4704
- # If this parameter is omitted, the default value of `DISABLED` is
4705
- # used. For more information, see [Using Amazon EFS Access Points][1]
4706
- # in the *Amazon Elastic Container Service Developer Guide*.
4737
+ # Determines whether to use the Amazon ECS task IAM role defined in a
4738
+ # task definition when mounting the Amazon EFS file system. If
4739
+ # enabled, transit encryption must be enabled in the
4740
+ # `EFSVolumeConfiguration`. If this parameter is omitted, the default
4741
+ # value of `DISABLED` is used. For more information, see [Using Amazon
4742
+ # EFS Access Points][1] in the *Amazon Elastic Container Service
4743
+ # Developer Guide*.
4707
4744
  #
4708
4745
  #
4709
4746
  #
@@ -4719,7 +4756,7 @@ module Aws::ECS
4719
4756
  include Aws::Structure
4720
4757
  end
4721
4758
 
4722
- # This parameter is specified when you are using an Amazon Elastic File
4759
+ # This parameter is specified when you're using an Amazon Elastic File
4723
4760
  # System file system for task storage. For more information, see [Amazon
4724
4761
  # EFS Volumes][1] in the *Amazon Elastic Container Service Developer
4725
4762
  # Guide*.
@@ -4758,12 +4795,12 @@ module Aws::ECS
4758
4795
  # @return [String]
4759
4796
  #
4760
4797
  # @!attribute [rw] transit_encryption
4761
- # Whether or not to enable encryption for Amazon EFS data in transit
4762
- # between the Amazon ECS host and the Amazon EFS server. Transit
4763
- # encryption must be enabled if Amazon EFS IAM authorization is used.
4764
- # If this parameter is omitted, the default value of `DISABLED` is
4765
- # used. For more information, see [Encrypting Data in Transit][1] in
4766
- # the *Amazon Elastic File System User Guide*.
4798
+ # Determines whether to enable encryption for Amazon EFS data in
4799
+ # transit between the Amazon ECS host and the Amazon EFS server.
4800
+ # Transit encryption must be enabled if Amazon EFS IAM authorization
4801
+ # is used. If this parameter is omitted, the default value of
4802
+ # `DISABLED` is used. For more information, see [Encrypting Data in
4803
+ # Transit][1] in the *Amazon Elastic File System User Guide*.
4767
4804
  #
4768
4805
  #
4769
4806
  #
@@ -4804,14 +4841,14 @@ module Aws::ECS
4804
4841
  # have a `.env` file extension. Each line in an environment file should
4805
4842
  # contain an environment variable in `VARIABLE=VALUE` format. Lines
4806
4843
  # beginning with `#` are treated as comments and are ignored. For more
4807
- # information on the environment variable file syntax, see [Declare
4844
+ # information about the environment variable file syntax, see [Declare
4808
4845
  # default environment variables in file][1].
4809
4846
  #
4810
4847
  # If there are environment variables specified using the `environment`
4811
4848
  # parameter in a container definition, they take precedence over the
4812
4849
  # variables contained within an environment file. If multiple
4813
- # environment files are specified that contain the same variable, they
4814
- # are processed from the top down. It is recommended to use unique
4850
+ # environment files are specified that contain the same variable,
4851
+ # they're processed from the top down. We recommend that you use unique
4815
4852
  # variable names. For more information, see [Specifying environment
4816
4853
  # variables][2] in the *Amazon Elastic Container Service Developer
4817
4854
  # Guide*.
@@ -4972,8 +5009,8 @@ module Aws::ECS
4972
5009
  # @return [String]
4973
5010
  #
4974
5011
  # @!attribute [rw] cloud_watch_encryption_enabled
4975
- # Whether or not to enable encryption on the CloudWatch logs. If not
4976
- # specified, encryption will be disabled.
5012
+ # Determines whether to enable encryption on the CloudWatch logs. If
5013
+ # not specified, encryption will be disabled.
4977
5014
  # @return [Boolean]
4978
5015
  #
4979
5016
  # @!attribute [rw] s3_bucket_name
@@ -4985,8 +5022,8 @@ module Aws::ECS
4985
5022
  # @return [String]
4986
5023
  #
4987
5024
  # @!attribute [rw] s3_encryption_enabled
4988
- # Whether or not to use encryption on the S3 logs. If not specified,
4989
- # encryption is not used.
5025
+ # Determines whether to use encryption on the S3 logs. If not
5026
+ # specified, encryption is not used.
4990
5027
  # @return [Boolean]
4991
5028
  #
4992
5029
  # @!attribute [rw] s3_key_prefix
@@ -5066,9 +5103,9 @@ module Aws::ECS
5066
5103
  # @return [String]
5067
5104
  #
5068
5105
  # @!attribute [rw] interactive
5069
- # Whether or not the execute command session is running in interactive
5070
- # mode. Amazon ECS only supports initiating interactive sessions, so
5071
- # you must specify `true` for this value.
5106
+ # Determines whether the execute command session is running in
5107
+ # interactive mode. Amazon ECS only supports initiating interactive
5108
+ # sessions, so you must specify `true` for this value.
5072
5109
  # @return [Boolean]
5073
5110
  #
5074
5111
  # @!attribute [rw] session
@@ -5141,7 +5178,7 @@ module Aws::ECS
5141
5178
  include Aws::Structure
5142
5179
  end
5143
5180
 
5144
- # This parameter is specified when you are using [Amazon FSx for Windows
5181
+ # This parameter is specified when you're using [Amazon FSx for Windows
5145
5182
  # File Server][1] file system for task storage.
5146
5183
  #
5147
5184
  # For more information and the input format, see [Amazon FSx for Windows
@@ -5288,7 +5325,7 @@ module Aws::ECS
5288
5325
  #
5289
5326
  # * `UNHEALTHY`-The container health check has failed.
5290
5327
  #
5291
- # * `UNKNOWN`-The container health check is being evaluated or there is
5328
+ # * `UNKNOWN`-The container health check is being evaluated or there's
5292
5329
  # no container health check defined.
5293
5330
  #
5294
5331
  # The following describes the possible `healthStatus` values for a task.
@@ -5316,12 +5353,12 @@ module Aws::ECS
5316
5353
  # Amazon ECS container agent. For more information, see [Updating the
5317
5354
  # Amazon ECS Container Agent][1].
5318
5355
  #
5319
- # * Container health checks are supported for Fargate tasks if you are
5356
+ # * Container health checks are supported for Fargate tasks if you're
5320
5357
  # using platform version 1.1.0 or greater. For more information, see
5321
5358
  # [Fargate Platform Versions][2].
5322
5359
  #
5323
- # * Container health checks are not supported for tasks that are part of
5324
- # a service that is configured to use a Classic Load Balancer.
5360
+ # * Container health checks aren't supported for tasks that are part of
5361
+ # a service that's configured to use a Classic Load Balancer.
5325
5362
  #
5326
5363
  #
5327
5364
  #
@@ -5346,13 +5383,13 @@ module Aws::ECS
5346
5383
  # command with the container's default shell.
5347
5384
  #
5348
5385
  # When you use the Amazon Web Services Management Console JSON panel,
5349
- # the Command Line Interface, or the APIs, you should enclose the list
5350
- # of commands in brackets, as shown below.
5386
+ # the Command Line Interface, or the APIs, enclose the list of
5387
+ # commands in brackets.
5351
5388
  #
5352
5389
  # `[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`
5353
5390
  #
5354
- # You do not need to include the brackets when you use the Amazon Web
5355
- # Services Management Consoleas shown below.
5391
+ # You don't need to include the brackets when you use the Amazon Web
5392
+ # Services Management Console.
5356
5393
  #
5357
5394
  # ` "CMD-SHELL", "curl -f http://localhost/ || exit 1" `
5358
5395
  #
@@ -5385,10 +5422,10 @@ module Aws::ECS
5385
5422
  # @return [Integer]
5386
5423
  #
5387
5424
  # @!attribute [rw] start_period
5388
- # The optional grace period within which to provide containers time to
5389
- # bootstrap before failed health checks count towards the maximum
5390
- # number of retries. You may specify between 0 and 300 seconds. The
5391
- # `startPeriod` is disabled by default.
5425
+ # The optional grace period to provide containers time to bootstrap
5426
+ # before failed health checks count towards the maximum number of
5427
+ # retries. You can specify between 0 and 300 seconds. By default, the
5428
+ # `startPeriod` is disabled.
5392
5429
  #
5393
5430
  # <note markdown="1"> If a health check succeeds within the `startPeriod`, then the
5394
5431
  # container is considered healthy and any subsequent failures count
@@ -5449,16 +5486,16 @@ module Aws::ECS
5449
5486
  #
5450
5487
  # @!attribute [rw] source_path
5451
5488
  # When the `host` parameter is used, specify a `sourcePath` to declare
5452
- # the path on the host container instance that is presented to the
5489
+ # the path on the host container instance that's presented to the
5453
5490
  # container. If this parameter is empty, then the Docker daemon has
5454
5491
  # assigned a host path for you. If the `host` parameter contains a
5455
5492
  # `sourcePath` file location, then the data volume persists at the
5456
5493
  # specified location on the host container instance until you delete
5457
- # it manually. If the `sourcePath` value does not exist on the host
5494
+ # it manually. If the `sourcePath` value doesn't exist on the host
5458
5495
  # container instance, the Docker daemon creates it. If the location
5459
5496
  # does exist, the contents of the source path folder are exported.
5460
5497
  #
5461
- # If you are using the Fargate launch type, the `sourcePath` parameter
5498
+ # If you're using the Fargate launch type, the `sourcePath` parameter
5462
5499
  # is not supported.
5463
5500
  # @return [String]
5464
5501
  #
@@ -5470,7 +5507,7 @@ module Aws::ECS
5470
5507
  include Aws::Structure
5471
5508
  end
5472
5509
 
5473
- # Details on a Elastic Inference accelerator. For more information, see
5510
+ # Details on an Elastic Inference accelerator. For more information, see
5474
5511
  # [Working with Amazon Elastic Inference on Amazon ECS][1] in the
5475
5512
  # *Amazon Elastic Container Service Developer Guide*.
5476
5513
  #
@@ -5542,7 +5579,39 @@ module Aws::ECS
5542
5579
  include Aws::Structure
5543
5580
  end
5544
5581
 
5545
- # The specified parameter is invalid. Review the available parameters
5582
+ # An object representing the result of a container instance health
5583
+ # status check.
5584
+ #
5585
+ # @!attribute [rw] type
5586
+ # The type of container instance health status that was verified.
5587
+ # @return [String]
5588
+ #
5589
+ # @!attribute [rw] status
5590
+ # The container instance health status.
5591
+ # @return [String]
5592
+ #
5593
+ # @!attribute [rw] last_updated
5594
+ # The Unix timestamp for when the container instance health status was
5595
+ # last updated.
5596
+ # @return [Time]
5597
+ #
5598
+ # @!attribute [rw] last_status_change
5599
+ # The Unix timestamp for when the container instance health status
5600
+ # last changed.
5601
+ # @return [Time]
5602
+ #
5603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InstanceHealthCheckResult AWS API Documentation
5604
+ #
5605
+ class InstanceHealthCheckResult < Struct.new(
5606
+ :type,
5607
+ :status,
5608
+ :last_updated,
5609
+ :last_status_change)
5610
+ SENSITIVE = []
5611
+ include Aws::Structure
5612
+ end
5613
+
5614
+ # The specified parameter isn't valid. Review the available parameters
5546
5615
  # for the API request.
5547
5616
  #
5548
5617
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InvalidParameterException AWS API Documentation
@@ -5551,10 +5620,11 @@ module Aws::ECS
5551
5620
 
5552
5621
  # The Linux capabilities for the container that are added to or dropped
5553
5622
  # from the default configuration provided by Docker. For more
5554
- # information on the default capabilities and the non-default available
5555
- # capabilities, see [Runtime privilege and Linux capabilities][1] in the
5556
- # *Docker run reference*. For more detailed information on these Linux
5557
- # capabilities, see the [capabilities(7)][2] Linux manual page.
5623
+ # information about the default capabilities and the non-default
5624
+ # available capabilities, see [Runtime privilege and Linux
5625
+ # capabilities][1] in the *Docker run reference*. For more detailed
5626
+ # information about these Linux capabilities, see the
5627
+ # [capabilities(7)][2] Linux manual page.
5558
5628
  #
5559
5629
  #
5560
5630
  #
@@ -5658,7 +5728,7 @@ module Aws::ECS
5658
5728
  include Aws::Structure
5659
5729
  end
5660
5730
 
5661
- # The limit for the resource has been exceeded.
5731
+ # The limit for the resource was exceeded.
5662
5732
  #
5663
5733
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LimitExceededException AWS API Documentation
5664
5734
  #
@@ -5711,8 +5781,8 @@ module Aws::ECS
5711
5781
  # `Devices` in the [Create a container][1] section of the [Docker
5712
5782
  # Remote API][2] and the `--device` option to [docker run][3].
5713
5783
  #
5714
- # <note markdown="1"> If you are using tasks that use the Fargate launch type, the
5715
- # `devices` parameter is not supported.
5784
+ # <note markdown="1"> If you're using tasks that use the Fargate launch type, the
5785
+ # `devices` parameter isn't supported.
5716
5786
  #
5717
5787
  # </note>
5718
5788
  #
@@ -5756,8 +5826,8 @@ module Aws::ECS
5756
5826
  # mount. This parameter maps to the `--tmpfs` option to [docker
5757
5827
  # run][1].
5758
5828
  #
5759
- # <note markdown="1"> If you are using tasks that use the Fargate launch type, the `tmpfs`
5760
- # parameter is not supported.
5829
+ # <note markdown="1"> If you're using tasks that use the Fargate launch type, the `tmpfs`
5830
+ # parameter isn't supported.
5761
5831
  #
5762
5832
  # </note>
5763
5833
  #
@@ -5779,8 +5849,8 @@ module Aws::ECS
5779
5849
  # `maxSwap` value must be set for the `swappiness` parameter to be
5780
5850
  # used.
5781
5851
  #
5782
- # <note markdown="1"> If you are using tasks that use the Fargate launch type, the
5783
- # `maxSwap` parameter is not supported.
5852
+ # <note markdown="1"> If you're using tasks that use the Fargate launch type, the
5853
+ # `maxSwap` parameter isn't supported.
5784
5854
  #
5785
5855
  # </note>
5786
5856
  #
@@ -5800,8 +5870,8 @@ module Aws::ECS
5800
5870
  # parameter maps to the `--memory-swappiness` option to [docker
5801
5871
  # run][1].
5802
5872
  #
5803
- # <note markdown="1"> If you are using tasks that use the Fargate launch type, the
5804
- # `swappiness` parameter is not supported.
5873
+ # <note markdown="1"> If you're using tasks that use the Fargate launch type, the
5874
+ # `swappiness` parameter isn't supported.
5805
5875
  #
5806
5876
  # </note>
5807
5877
  #
@@ -5841,8 +5911,8 @@ module Aws::ECS
5841
5911
  # @return [String]
5842
5912
  #
5843
5913
  # @!attribute [rw] value
5844
- # The value of the account settings with which to filter results. You
5845
- # must also specify an account setting name to use this parameter.
5914
+ # The value of the account settings to filter results with. You must
5915
+ # also specify an account setting name to use this parameter.
5846
5916
  # @return [String]
5847
5917
  #
5848
5918
  # @!attribute [rw] principal_arn
@@ -5857,18 +5927,18 @@ module Aws::ECS
5857
5927
  # @return [String]
5858
5928
  #
5859
5929
  # @!attribute [rw] effective_settings
5860
- # Specifies whether to return the effective settings. If `true`, the
5930
+ # Determines whether to return the effective settings. If `true`, the
5861
5931
  # account settings for the root user or the default setting for the
5862
5932
  # `principalArn` are returned. If `false`, the account settings for
5863
- # the `principalArn` are returned if they are set. Otherwise, no
5933
+ # the `principalArn` are returned if they're set. Otherwise, no
5864
5934
  # account settings are returned.
5865
5935
  # @return [Boolean]
5866
5936
  #
5867
5937
  # @!attribute [rw] next_token
5868
5938
  # The `nextToken` value returned from a `ListAccountSettings` request
5869
5939
  # indicating that more results are available to fulfill the request
5870
- # and further calls will be needed. If `maxResults` was provided, it
5871
- # is possible the number of results to be fewer than `maxResults`.
5940
+ # and further calls will be needed. If `maxResults` was provided,
5941
+ # it's possible the number of results to be fewer than `maxResults`.
5872
5942
  #
5873
5943
  # <note markdown="1"> This token should be treated as an opaque identifier that is only
5874
5944
  # used to retrieve the next items in a list and not for other
@@ -5884,7 +5954,7 @@ module Aws::ECS
5884
5954
  # single page along with a `nextToken` response element. The remaining
5885
5955
  # results of the initial request can be seen by sending another
5886
5956
  # `ListAccountSettings` request with the returned `nextToken` value.
5887
- # This value can be between 1 and 10. If this parameter is not used,
5957
+ # This value can be between 1 and 10. If this parameter isn't used,
5888
5958
  # then `ListAccountSettings` returns up to 10 results and a
5889
5959
  # `nextToken` value if applicable.
5890
5960
  # @return [Integer]
@@ -5942,23 +6012,23 @@ module Aws::ECS
5942
6012
  # @return [String]
5943
6013
  #
5944
6014
  # @!attribute [rw] target_type
5945
- # The type of the target with which to list attributes.
6015
+ # The type of the target to list attributes with.
5946
6016
  # @return [String]
5947
6017
  #
5948
6018
  # @!attribute [rw] attribute_name
5949
- # The name of the attribute with which to filter the results.
6019
+ # The name of the attribute to filter the results with.
5950
6020
  # @return [String]
5951
6021
  #
5952
6022
  # @!attribute [rw] attribute_value
5953
- # The value of the attribute with which to filter results. You must
5954
- # also specify an attribute name to use this parameter.
6023
+ # The value of the attribute to filter results with. You must also
6024
+ # specify an attribute name to use this parameter.
5955
6025
  # @return [String]
5956
6026
  #
5957
6027
  # @!attribute [rw] next_token
5958
6028
  # The `nextToken` value returned from a `ListAttributes` request
5959
6029
  # indicating that more results are available to fulfill the request
5960
- # and further calls will be needed. If `maxResults` was provided, it
5961
- # is possible the number of results to be fewer than `maxResults`.
6030
+ # and further calls are needed. If `maxResults` was provided, it's
6031
+ # possible the number of results to be fewer than `maxResults`.
5962
6032
  #
5963
6033
  # <note markdown="1"> This token should be treated as an opaque identifier that is only
5964
6034
  # used to retrieve the next items in a list and not for other
@@ -5968,13 +6038,13 @@ module Aws::ECS
5968
6038
  # @return [String]
5969
6039
  #
5970
6040
  # @!attribute [rw] max_results
5971
- # The maximum number of cluster results returned by `ListAttributes`
6041
+ # The maximum number of cluster results that `ListAttributes` returned
5972
6042
  # in paginated output. When this parameter is used, `ListAttributes`
5973
6043
  # only returns `maxResults` results in a single page along with a
5974
6044
  # `nextToken` response element. The remaining results of the initial
5975
6045
  # request can be seen by sending another `ListAttributes` request with
5976
6046
  # the returned `nextToken` value. This value can be between 1 and 100.
5977
- # If this parameter is not used, then `ListAttributes` returns up to
6047
+ # If this parameter isn't used, then `ListAttributes` returns up to
5978
6048
  # 100 results and a `nextToken` value if applicable.
5979
6049
  # @return [Integer]
5980
6050
  #
@@ -6023,8 +6093,8 @@ module Aws::ECS
6023
6093
  # @!attribute [rw] next_token
6024
6094
  # The `nextToken` value returned from a `ListClusters` request
6025
6095
  # indicating that more results are available to fulfill the request
6026
- # and further calls will be needed. If `maxResults` was provided, it
6027
- # is possible the number of results to be fewer than `maxResults`.
6096
+ # and further calls are needed. If `maxResults` was provided, it's
6097
+ # possible the number of results to be fewer than `maxResults`.
6028
6098
  #
6029
6099
  # <note markdown="1"> This token should be treated as an opaque identifier that is only
6030
6100
  # used to retrieve the next items in a list and not for other
@@ -6034,13 +6104,13 @@ module Aws::ECS
6034
6104
  # @return [String]
6035
6105
  #
6036
6106
  # @!attribute [rw] max_results
6037
- # The maximum number of cluster results returned by `ListClusters` in
6038
- # paginated output. When this parameter is used, `ListClusters` only
6039
- # returns `maxResults` results in a single page along with a
6107
+ # The maximum number of cluster results that `ListClusters` returned
6108
+ # in paginated output. When this parameter is used, `ListClusters`
6109
+ # only returns `maxResults` results in a single page along with a
6040
6110
  # `nextToken` response element. The remaining results of the initial
6041
6111
  # request can be seen by sending another `ListClusters` request with
6042
6112
  # the returned `nextToken` value. This value can be between 1 and 100.
6043
- # If this parameter is not used, then `ListClusters` returns up to 100
6113
+ # If this parameter isn't used, then `ListClusters` returns up to 100
6044
6114
  # results and a `nextToken` value if applicable.
6045
6115
  # @return [Integer]
6046
6116
  #
@@ -6055,7 +6125,7 @@ module Aws::ECS
6055
6125
 
6056
6126
  # @!attribute [rw] cluster_arns
6057
6127
  # The list of full Amazon Resource Name (ARN) entries for each cluster
6058
- # associated with your account.
6128
+ # that's associated with your account.
6059
6129
  # @return [Array<String>]
6060
6130
  #
6061
6131
  # @!attribute [rw] next_token
@@ -6105,9 +6175,8 @@ module Aws::ECS
6105
6175
  # @!attribute [rw] next_token
6106
6176
  # The `nextToken` value returned from a `ListContainerInstances`
6107
6177
  # request indicating that more results are available to fulfill the
6108
- # request and further calls will be needed. If `maxResults` was
6109
- # provided, it is possible the number of results to be fewer than
6110
- # `maxResults`.
6178
+ # request and further calls are needed. If `maxResults` was provided,
6179
+ # it's possible the number of results to be fewer than `maxResults`.
6111
6180
  #
6112
6181
  # <note markdown="1"> This token should be treated as an opaque identifier that is only
6113
6182
  # used to retrieve the next items in a list and not for other
@@ -6117,22 +6186,22 @@ module Aws::ECS
6117
6186
  # @return [String]
6118
6187
  #
6119
6188
  # @!attribute [rw] max_results
6120
- # The maximum number of container instance results returned by
6121
- # `ListContainerInstances` in paginated output. When this parameter is
6122
- # used, `ListContainerInstances` only returns `maxResults` results in
6123
- # a single page along with a `nextToken` response element. The
6124
- # remaining results of the initial request can be seen by sending
6125
- # another `ListContainerInstances` request with the returned
6126
- # `nextToken` value. This value can be between 1 and 100. If this
6127
- # parameter is not used, then `ListContainerInstances` returns up to
6128
- # 100 results and a `nextToken` value if applicable.
6189
+ # The maximum number of container instance results that
6190
+ # `ListContainerInstances` returned in paginated output. When this
6191
+ # parameter is used, `ListContainerInstances` only returns
6192
+ # `maxResults` results in a single page along with a `nextToken`
6193
+ # response element. The remaining results of the initial request can
6194
+ # be seen by sending another `ListContainerInstances` request with the
6195
+ # returned `nextToken` value. This value can be between 1 and 100. If
6196
+ # this parameter isn't used, then `ListContainerInstances` returns up
6197
+ # to 100 results and a `nextToken` value if applicable.
6129
6198
  # @return [Integer]
6130
6199
  #
6131
6200
  # @!attribute [rw] status
6132
6201
  # Filters the container instances by status. For example, if you
6133
6202
  # specify the `DRAINING` status, the results include only container
6134
6203
  # instances that have been set to `DRAINING` using
6135
- # UpdateContainerInstancesState. If you do not specify this parameter,
6204
+ # UpdateContainerInstancesState. If you don't specify this parameter,
6136
6205
  # the default is to include container instances set to all states
6137
6206
  # other than `INACTIVE`.
6138
6207
  # @return [String]
@@ -6202,13 +6271,13 @@ module Aws::ECS
6202
6271
  # @return [String]
6203
6272
  #
6204
6273
  # @!attribute [rw] max_results
6205
- # The maximum number of service results returned by `ListServices` in
6206
- # paginated output. When this parameter is used, `ListServices` only
6207
- # returns `maxResults` results in a single page along with a
6274
+ # The maximum number of service results that `ListServices` returned
6275
+ # in paginated output. When this parameter is used, `ListServices`
6276
+ # only returns `maxResults` results in a single page along with a
6208
6277
  # `nextToken` response element. The remaining results of the initial
6209
6278
  # request can be seen by sending another `ListServices` request with
6210
6279
  # the returned `nextToken` value. This value can be between 1 and 100.
6211
- # If this parameter is not used, then `ListServices` returns up to 10
6280
+ # If this parameter isn't used, then `ListServices` returns up to 10
6212
6281
  # results and a `nextToken` value if applicable.
6213
6282
  # @return [Integer]
6214
6283
  #
@@ -6234,8 +6303,8 @@ module Aws::ECS
6234
6303
  end
6235
6304
 
6236
6305
  # @!attribute [rw] service_arns
6237
- # The list of full ARN entries for each service associated with the
6238
- # specified cluster.
6306
+ # The list of full ARN entries for each service that's associated
6307
+ # with the specified cluster.
6239
6308
  # @return [Array<String>]
6240
6309
  #
6241
6310
  # @!attribute [rw] next_token
@@ -6262,10 +6331,10 @@ module Aws::ECS
6262
6331
  # }
6263
6332
  #
6264
6333
  # @!attribute [rw] resource_arn
6265
- # The Amazon Resource Name (ARN) that identifies the resource for
6266
- # which to list the tags. Currently, the supported resources are
6267
- # Amazon ECS tasks, services, task definitions, clusters, and
6268
- # container instances.
6334
+ # The Amazon Resource Name (ARN) that identifies the resource to list
6335
+ # the tags for. Currently, the supported resources are Amazon ECS
6336
+ # tasks, services, task definitions, clusters, and container
6337
+ # instances.
6269
6338
  # @return [String]
6270
6339
  #
6271
6340
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTagsForResourceRequest AWS API Documentation
@@ -6299,22 +6368,22 @@ module Aws::ECS
6299
6368
  # }
6300
6369
  #
6301
6370
  # @!attribute [rw] family_prefix
6302
- # The `familyPrefix` is a string that is used to filter the results of
6371
+ # The `familyPrefix` is a string that's used to filter the results of
6303
6372
  # `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
6304
6373
  # task definition family names that begin with the `familyPrefix`
6305
6374
  # string are returned.
6306
6375
  # @return [String]
6307
6376
  #
6308
6377
  # @!attribute [rw] status
6309
- # The task definition family status with which to filter the
6310
- # `ListTaskDefinitionFamilies` results. By default, both `ACTIVE` and
6311
- # `INACTIVE` task definition families are listed. If this parameter is
6312
- # set to `ACTIVE`, only task definition families that have an `ACTIVE`
6313
- # task definition revision are returned. If this parameter is set to
6314
- # `INACTIVE`, only task definition families that do not have any
6315
- # `ACTIVE` task definition revisions are returned. If you paginate the
6316
- # resulting output, be sure to keep the `status` value constant in
6317
- # each subsequent request.
6378
+ # The task definition family status to filter the
6379
+ # `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
6380
+ # and `INACTIVE` task definition families are listed. If this
6381
+ # parameter is set to `ACTIVE`, only task definition families that
6382
+ # have an `ACTIVE` task definition revision are returned. If this
6383
+ # parameter is set to `INACTIVE`, only task definition families that
6384
+ # do not have any `ACTIVE` task definition revisions are returned. If
6385
+ # you paginate the resulting output, be sure to keep the `status`
6386
+ # value constant in each subsequent request.
6318
6387
  # @return [String]
6319
6388
  #
6320
6389
  # @!attribute [rw] next_token
@@ -6332,14 +6401,14 @@ module Aws::ECS
6332
6401
  # @return [String]
6333
6402
  #
6334
6403
  # @!attribute [rw] max_results
6335
- # The maximum number of task definition family results returned by
6336
- # `ListTaskDefinitionFamilies` in paginated output. When this
6404
+ # The maximum number of task definition family results that
6405
+ # `ListTaskDefinitionFamilies` returned in paginated output. When this
6337
6406
  # parameter is used, `ListTaskDefinitions` only returns `maxResults`
6338
6407
  # results in a single page along with a `nextToken` response element.
6339
6408
  # The remaining results of the initial request can be seen by sending
6340
6409
  # another `ListTaskDefinitionFamilies` request with the returned
6341
6410
  # `nextToken` value. This value can be between 1 and 100. If this
6342
- # parameter is not used, then `ListTaskDefinitionFamilies` returns up
6411
+ # parameter isn't used, then `ListTaskDefinitionFamilies` returns up
6343
6412
  # to 100 results and a `nextToken` value if applicable.
6344
6413
  # @return [Integer]
6345
6414
  #
@@ -6388,29 +6457,28 @@ module Aws::ECS
6388
6457
  # }
6389
6458
  #
6390
6459
  # @!attribute [rw] family_prefix
6391
- # The full family name with which to filter the `ListTaskDefinitions`
6392
- # results. Specifying a `familyPrefix` limits the listed task
6393
- # definitions to task definition revisions that belong to that family.
6460
+ # The full family name to filter the `ListTaskDefinitions` results
6461
+ # with. Specifying a `familyPrefix` limits the listed task definitions
6462
+ # to task definition revisions that belong to that family.
6394
6463
  # @return [String]
6395
6464
  #
6396
6465
  # @!attribute [rw] status
6397
- # The task definition status with which to filter the
6398
- # `ListTaskDefinitions` results. By default, only `ACTIVE` task
6399
- # definitions are listed. By setting this parameter to `INACTIVE`, you
6400
- # can view task definitions that are `INACTIVE` as long as an active
6401
- # task or service still references them. If you paginate the resulting
6402
- # output, be sure to keep the `status` value constant in each
6403
- # subsequent request.
6466
+ # The task definition status to filter the `ListTaskDefinitions`
6467
+ # results with. By default, only `ACTIVE` task definitions are listed.
6468
+ # By setting this parameter to `INACTIVE`, you can view task
6469
+ # definitions that are `INACTIVE` as long as an active task or service
6470
+ # still references them. If you paginate the resulting output, be sure
6471
+ # to keep the `status` value constant in each subsequent request.
6404
6472
  # @return [String]
6405
6473
  #
6406
6474
  # @!attribute [rw] sort
6407
- # The order in which to sort the results. Valid values are `ASC` and
6408
- # `DESC`. By default (`ASC`), task definitions are listed
6409
- # lexicographically by family name and in ascending numerical order by
6410
- # revision so that the newest task definitions in a family are listed
6411
- # last. Setting this parameter to `DESC` reverses the sort order on
6412
- # family name and revision so that the newest task definitions in a
6413
- # family are listed first.
6475
+ # The order to sort the results in. Valid values are `ASC` and `DESC`.
6476
+ # By default, (`ASC`) task definitions are listed lexicographically by
6477
+ # family name and in ascending numerical order by revision so that the
6478
+ # newest task definitions in a family are listed last. Setting this
6479
+ # parameter to `DESC` reverses the sort order on family name and
6480
+ # revision. This is so that the newest task definitions in a family
6481
+ # are listed first.
6414
6482
  # @return [String]
6415
6483
  #
6416
6484
  # @!attribute [rw] next_token
@@ -6427,14 +6495,14 @@ module Aws::ECS
6427
6495
  # @return [String]
6428
6496
  #
6429
6497
  # @!attribute [rw] max_results
6430
- # The maximum number of task definition results returned by
6431
- # `ListTaskDefinitions` in paginated output. When this parameter is
6432
- # used, `ListTaskDefinitions` only returns `maxResults` results in a
6433
- # single page along with a `nextToken` response element. The remaining
6434
- # results of the initial request can be seen by sending another
6435
- # `ListTaskDefinitions` request with the returned `nextToken` value.
6436
- # This value can be between 1 and 100. If this parameter is not used,
6437
- # then `ListTaskDefinitions` returns up to 100 results and a
6498
+ # The maximum number of task definition results that
6499
+ # `ListTaskDefinitions` returned in paginated output. When this
6500
+ # parameter is used, `ListTaskDefinitions` only returns `maxResults`
6501
+ # results in a single page along with a `nextToken` response element.
6502
+ # The remaining results of the initial request can be seen by sending
6503
+ # another `ListTaskDefinitions` request with the returned `nextToken`
6504
+ # value. This value can be between 1 and 100. If this parameter isn't
6505
+ # used, then `ListTaskDefinitions` returns up to 100 results and a
6438
6506
  # `nextToken` value if applicable.
6439
6507
  # @return [Integer]
6440
6508
  #
@@ -6509,7 +6577,7 @@ module Aws::ECS
6509
6577
  # @!attribute [rw] next_token
6510
6578
  # The `nextToken` value returned from a `ListTasks` request indicating
6511
6579
  # that more results are available to fulfill the request and further
6512
- # calls will be needed. If `maxResults` was provided, it is possible
6580
+ # calls will be needed. If `maxResults` was provided, it's possible
6513
6581
  # the number of results to be fewer than `maxResults`.
6514
6582
  #
6515
6583
  # <note markdown="1"> This token should be treated as an opaque identifier that is only
@@ -6520,20 +6588,20 @@ module Aws::ECS
6520
6588
  # @return [String]
6521
6589
  #
6522
6590
  # @!attribute [rw] max_results
6523
- # The maximum number of task results returned by `ListTasks` in
6591
+ # The maximum number of task results that `ListTasks` returned in
6524
6592
  # paginated output. When this parameter is used, `ListTasks` only
6525
6593
  # returns `maxResults` results in a single page along with a
6526
6594
  # `nextToken` response element. The remaining results of the initial
6527
6595
  # request can be seen by sending another `ListTasks` request with the
6528
6596
  # returned `nextToken` value. This value can be between 1 and 100. If
6529
- # this parameter is not used, then `ListTasks` returns up to 100
6597
+ # this parameter isn't used, then `ListTasks` returns up to 100
6530
6598
  # results and a `nextToken` value if applicable.
6531
6599
  # @return [Integer]
6532
6600
  #
6533
6601
  # @!attribute [rw] started_by
6534
- # The `startedBy` value with which to filter the task results.
6535
- # Specifying a `startedBy` value limits the results to tasks that were
6536
- # started with that value.
6602
+ # The `startedBy` value to filter the task results with. Specifying a
6603
+ # `startedBy` value limits the results to tasks that were started with
6604
+ # that value.
6537
6605
  # @return [String]
6538
6606
  #
6539
6607
  # @!attribute [rw] service_name
@@ -6546,13 +6614,13 @@ module Aws::ECS
6546
6614
  # The task desired status to use when filtering the `ListTasks`
6547
6615
  # results. Specifying a `desiredStatus` of `STOPPED` limits the
6548
6616
  # results to tasks that Amazon ECS has set the desired status to
6549
- # `STOPPED`. This can be useful for debugging tasks that are not
6617
+ # `STOPPED`. This can be useful for debugging tasks that aren't
6550
6618
  # starting properly or have died or finished. The default status
6551
6619
  # filter is `RUNNING`, which shows tasks that Amazon ECS has set the
6552
6620
  # desired status to `RUNNING`.
6553
6621
  #
6554
6622
  # <note markdown="1"> Although you can filter results based on a desired status of
6555
- # `PENDING`, this does not return any results. Amazon ECS never sets
6623
+ # `PENDING`, this doesn't return any results. Amazon ECS never sets
6556
6624
  # the desired status of a task to that value (only a task's
6557
6625
  # `lastStatus` may have a value of `PENDING`).
6558
6626
  #
@@ -6620,25 +6688,25 @@ module Aws::ECS
6620
6688
  # target group or groups associated with a service or task set.
6621
6689
  #
6622
6690
  # A target group ARN is only specified when using an Application Load
6623
- # Balancer or Network Load Balancer. If you are using a Classic Load
6624
- # Balancer the target group ARN should be omitted.
6691
+ # Balancer or Network Load Balancer. If you're using a Classic Load
6692
+ # Balancer, omit the target group ARN.
6625
6693
  #
6626
6694
  # For services using the `ECS` deployment controller, you can specify
6627
6695
  # one or multiple target groups. For more information, see
6628
6696
  # [Registering Multiple Target Groups with a Service][1] in the
6629
6697
  # *Amazon Elastic Container Service Developer Guide*.
6630
6698
  #
6631
- # For services using the `CODE_DEPLOY` deployment controller, you are
6699
+ # For services using the `CODE_DEPLOY` deployment controller, you're
6632
6700
  # required to define two target groups for the load balancer. For more
6633
6701
  # information, see [Blue/Green Deployment with CodeDeploy][2] in the
6634
6702
  # *Amazon Elastic Container Service Developer Guide*.
6635
6703
  #
6636
- # If your service's task definition uses the `awsvpc` network mode
6637
- # (which is required for the Fargate launch type), you must choose
6638
- # `ip` as the target type, not `instance`, when creating your target
6639
- # groups because tasks that use the `awsvpc` network mode are
6640
- # associated with an elastic network interface, not an Amazon EC2
6641
- # instance.
6704
+ # If your service's task definition uses the `awsvpc` network mode,
6705
+ # you must choose `ip` as the target type, not `instance`. Do this
6706
+ # when creating your target groups because tasks that use the `awsvpc`
6707
+ # network mode are associated with an elastic network interface, not
6708
+ # an Amazon EC2 instance. This network mode is required for the
6709
+ # Fargate launch type.
6642
6710
  #
6643
6711
  #
6644
6712
  #
@@ -6664,7 +6732,7 @@ module Aws::ECS
6664
6732
  # The port on the container to associate with the load balancer. This
6665
6733
  # port must correspond to a `containerPort` in the task definition the
6666
6734
  # tasks in the service are using. For tasks that use the EC2 launch
6667
- # type, the container instance they are launched on must allow ingress
6735
+ # type, the container instance they're launched on must allow ingress
6668
6736
  # traffic on the `hostPort` of the port mapping.
6669
6737
  # @return [Integer]
6670
6738
  #
@@ -6684,14 +6752,14 @@ module Aws::ECS
6684
6752
  # Remote API][2] and the `--log-driver` option to [ `docker run` ][3].
6685
6753
  #
6686
6754
  # By default, containers use the same logging driver that the Docker
6687
- # daemon uses; however the container may use a different logging driver
6688
- # than the Docker daemon by specifying a log driver configuration in the
6689
- # container definition. For more information on the options for
6690
- # different supported log drivers, see [Configure logging drivers][4] in
6691
- # the Docker documentation.
6755
+ # daemon uses. However, the container might use a different logging
6756
+ # driver than the Docker daemon by specifying a log driver configuration
6757
+ # in the container definition. For more information about the options
6758
+ # for different supported log drivers, see [Configure logging
6759
+ # drivers][4] in the Docker documentation.
6692
6760
  #
6693
- # The following should be noted when specifying a log configuration for
6694
- # your containers:
6761
+ # Understand the following when specifying a log configuration for your
6762
+ # containers.
6695
6763
  #
6696
6764
  # * Amazon ECS currently supports a subset of the logging drivers
6697
6765
  # available to the Docker daemon (shown in the valid values below).
@@ -6701,19 +6769,19 @@ module Aws::ECS
6701
6769
  # * This parameter requires version 1.18 of the Docker Remote API or
6702
6770
  # greater on your container instance.
6703
6771
  #
6704
- # * For tasks hosted on Amazon EC2 instances, the Amazon ECS container
6705
- # agent must register the available logging drivers with the
6772
+ # * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS
6773
+ # container agent must register the available logging drivers with the
6706
6774
  # `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
6707
6775
  # containers placed on that instance can use these log configuration
6708
6776
  # options. For more information, see [Amazon ECS container agent
6709
6777
  # configuration][5] in the *Amazon Elastic Container Service Developer
6710
6778
  # Guide*.
6711
6779
  #
6712
- # * For tasks on Fargate, because you do not have access to the
6780
+ # * For tasks that are on Fargate, because you don't have access to the
6713
6781
  # underlying infrastructure your tasks are hosted on, any additional
6714
- # software needed will have to be installed outside of the task. For
6715
- # example, the Fluentd output aggregators or a remote host running
6716
- # Logstash to send Gelf logs to.
6782
+ # software needed must be installed outside of the task. For example,
6783
+ # the Fluentd output aggregators or a remote host running Logstash to
6784
+ # send Gelf logs to.
6717
6785
  #
6718
6786
  #
6719
6787
  #
@@ -6757,11 +6825,11 @@ module Aws::ECS
6757
6825
  # [Custom log routing][2] in the *Amazon Elastic Container Service
6758
6826
  # Developer Guide*.
6759
6827
  #
6760
- # <note markdown="1"> If you have a custom driver that is not listed, you can fork the
6761
- # Amazon ECS container agent project that is [available on GitHub][3]
6828
+ # <note markdown="1"> If you have a custom driver that isn't listed, you can fork the
6829
+ # Amazon ECS container agent project that's [available on GitHub][3]
6762
6830
  # and customize it to work with that driver. We encourage you to
6763
6831
  # submit pull requests for changes that you would like to have
6764
- # included. However, we do not currently provide support for running
6832
+ # included. However, we don't currently provide support for running
6765
6833
  # modified copies of this software.
6766
6834
  #
6767
6835
  # </note>
@@ -6805,7 +6873,8 @@ module Aws::ECS
6805
6873
  # Details about the managed agent status for the container.
6806
6874
  #
6807
6875
  # @!attribute [rw] last_started_at
6808
- # The Unix timestamp for when the managed agent was last started.
6876
+ # The Unix timestamp for the time when the managed agent was last
6877
+ # started.
6809
6878
  # @return [Time]
6810
6879
  #
6811
6880
  # @!attribute [rw] name
@@ -6845,7 +6914,7 @@ module Aws::ECS
6845
6914
  # }
6846
6915
  #
6847
6916
  # @!attribute [rw] container_name
6848
- # The name of the container associated with the managed agent.
6917
+ # The name of the container that's associated with the managed agent.
6849
6918
  # @return [String]
6850
6919
  #
6851
6920
  # @!attribute [rw] managed_agent_name
@@ -6876,7 +6945,7 @@ module Aws::ECS
6876
6945
  #
6877
6946
  # When managed scaling is enabled, Amazon ECS manages the scale-in and
6878
6947
  # scale-out actions of the Auto Scaling group. Amazon ECS manages a
6879
- # target tracking scaling policy using an Amazon ECS-managed CloudWatch
6948
+ # target tracking scaling policy using an Amazon ECS managed CloudWatch
6880
6949
  # metric with the specified `targetCapacity` value as the target value
6881
6950
  # for the metric. For more information, see [Using Managed Scaling][1]
6882
6951
  # in the *Amazon Elastic Container Service Developer Guide*.
@@ -6900,26 +6969,27 @@ module Aws::ECS
6900
6969
  # }
6901
6970
  #
6902
6971
  # @!attribute [rw] status
6903
- # Whether or not to enable managed scaling for the capacity provider.
6972
+ # Determines whether to enable managed scaling for the capacity
6973
+ # provider.
6904
6974
  # @return [String]
6905
6975
  #
6906
6976
  # @!attribute [rw] target_capacity
6907
6977
  # The target capacity value for the capacity provider. The specified
6908
6978
  # value must be greater than `0` and less than or equal to `100`. A
6909
- # value of `100` will result in the Amazon EC2 instances in your Auto
6910
- # Scaling group being completely utilized.
6979
+ # value of `100` results in the Amazon EC2 instances in your Auto
6980
+ # Scaling group being completely used.
6911
6981
  # @return [Integer]
6912
6982
  #
6913
6983
  # @!attribute [rw] minimum_scaling_step_size
6914
- # The minimum number of container instances that Amazon ECS will scale
6915
- # in or scale out at one time. If this parameter is omitted, the
6916
- # default value of `1` is used.
6984
+ # The minimum number of container instances that Amazon ECS scales in
6985
+ # or scales out at one time. If this parameter is omitted, the default
6986
+ # value of `1` is used.
6917
6987
  # @return [Integer]
6918
6988
  #
6919
6989
  # @!attribute [rw] maximum_scaling_step_size
6920
- # The maximum number of container instances that Amazon ECS will scale
6921
- # in or scale out at one time. If this parameter is omitted, the
6922
- # default value of `10000` is used.
6990
+ # The maximum number of container instances that Amazon ECS scales in
6991
+ # or scales out at one time. If this parameter is omitted, the default
6992
+ # value of `10000` is used.
6923
6993
  # @return [Integer]
6924
6994
  #
6925
6995
  # @!attribute [rw] instance_warmup_period
@@ -6941,17 +7011,17 @@ module Aws::ECS
6941
7011
  include Aws::Structure
6942
7012
  end
6943
7013
 
6944
- # Amazon ECS is unable to determine the current version of the Amazon
6945
- # ECS container agent on the container instance and does not have enough
7014
+ # Amazon ECS can't determine the current version of the Amazon ECS
7015
+ # container agent on the container instance and doesn't have enough
6946
7016
  # information to proceed with an update. This could be because the agent
6947
- # running on the container instance is an older or custom version that
6948
- # does not use our version information.
7017
+ # running on the container instance is a previous or custom version that
7018
+ # doesn't use our version information.
6949
7019
  #
6950
7020
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/MissingVersionException AWS API Documentation
6951
7021
  #
6952
7022
  class MissingVersionException < Aws::EmptyStructure; end
6953
7023
 
6954
- # Details on a volume mount point that is used in a container
7024
+ # Details for a volume mount point that's used in a container
6955
7025
  # definition.
6956
7026
  #
6957
7027
  # @note When making an API call, you may pass MountPoint
@@ -7009,12 +7079,12 @@ module Aws::ECS
7009
7079
  # @return [String]
7010
7080
  #
7011
7081
  # @!attribute [rw] container_port
7012
- # The port number on the container that is used with the network
7082
+ # The port number on the container that's used with the network
7013
7083
  # binding.
7014
7084
  # @return [Integer]
7015
7085
  #
7016
7086
  # @!attribute [rw] host_port
7017
- # The port number on the host that is used with the network binding.
7087
+ # The port number on the host that's used with the network binding.
7018
7088
  # @return [Integer]
7019
7089
  #
7020
7090
  # @!attribute [rw] protocol
@@ -7047,7 +7117,7 @@ module Aws::ECS
7047
7117
  # }
7048
7118
  #
7049
7119
  # @!attribute [rw] awsvpc_configuration
7050
- # The VPC subnets and security groups associated with a task.
7120
+ # The VPC subnets and security groups that are associated with a task.
7051
7121
  #
7052
7122
  # <note markdown="1"> All specified subnets and security groups must be from the same VPC.
7053
7123
  #
@@ -7087,9 +7157,10 @@ module Aws::ECS
7087
7157
  include Aws::Structure
7088
7158
  end
7089
7159
 
7090
- # There is no update available for this Amazon ECS container agent. This
7091
- # could be because the agent is already running the latest version, or
7092
- # it is so old that there is no update path to the current version.
7160
+ # There's no update available for this Amazon ECS container agent. This
7161
+ # might be because the agent is already running the latest version or
7162
+ # because it's so old that there's no update path to the current
7163
+ # version.
7093
7164
  #
7094
7165
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NoUpdateAvailableException AWS API Documentation
7095
7166
  #
@@ -7099,8 +7170,8 @@ module Aws::ECS
7099
7170
  # information, see [Task Placement Constraints][1] in the *Amazon
7100
7171
  # Elastic Container Service Developer Guide*.
7101
7172
  #
7102
- # <note markdown="1"> If you are using the Fargate launch type, task placement constraints
7103
- # are not supported.
7173
+ # <note markdown="1"> If you're using the Fargate launch type, task placement constraints
7174
+ # aren't supported.
7104
7175
  #
7105
7176
  # </note>
7106
7177
  #
@@ -7166,16 +7237,16 @@ module Aws::ECS
7166
7237
  # placement strategy spreads placement across available candidates
7167
7238
  # evenly based on the `field` parameter. The `binpack` strategy places
7168
7239
  # tasks on available candidates that have the least available amount
7169
- # of the resource that is specified with the `field` parameter. For
7240
+ # of the resource that's specified with the `field` parameter. For
7170
7241
  # example, if you binpack on memory, a task is placed on the instance
7171
- # with the least amount of remaining memory (but still enough to run
7172
- # the task).
7242
+ # with the least amount of remaining memory but still enough to run
7243
+ # the task.
7173
7244
  # @return [String]
7174
7245
  #
7175
7246
  # @!attribute [rw] field
7176
7247
  # The field to apply the placement strategy against. For the `spread`
7177
7248
  # placement strategy, valid values are `instanceId` (or `host`, which
7178
- # has the same effect), or any platform or custom attribute that is
7249
+ # has the same effect), or any platform or custom attribute that's
7179
7250
  # applied to a container instance, such as
7180
7251
  # `attribute:ecs.availability-zone`. For the `binpack` placement
7181
7252
  # strategy, valid values are `cpu` and `memory`. For the `random`
@@ -7203,13 +7274,13 @@ module Aws::ECS
7203
7274
  # }
7204
7275
  #
7205
7276
  # @!attribute [rw] id
7206
- # The ID for the GPU(s) on the container instance. The available GPU
7207
- # IDs can also be obtained on the container instance in the
7277
+ # The ID for the GPUs on the container instance. The available GPU IDs
7278
+ # can also be obtained on the container instance in the
7208
7279
  # `/var/lib/ecs/gpu/nvidia_gpu_info.json` file.
7209
7280
  # @return [String]
7210
7281
  #
7211
7282
  # @!attribute [rw] type
7212
- # The type of device that is available on the container instance. The
7283
+ # The type of device that's available on the container instance. The
7213
7284
  # only supported value is `GPU`.
7214
7285
  # @return [String]
7215
7286
  #
@@ -7222,14 +7293,14 @@ module Aws::ECS
7222
7293
  include Aws::Structure
7223
7294
  end
7224
7295
 
7225
- # The specified platform version does not satisfy the task definition's
7226
- # required capabilities.
7296
+ # The specified platform version doesn't satisfy the required
7297
+ # capabilities of the task definition.
7227
7298
  #
7228
7299
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformTaskDefinitionIncompatibilityException AWS API Documentation
7229
7300
  #
7230
7301
  class PlatformTaskDefinitionIncompatibilityException < Aws::EmptyStructure; end
7231
7302
 
7232
- # The specified platform version does not exist.
7303
+ # The specified platform version doesn't exist.
7233
7304
  #
7234
7305
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformUnknownException AWS API Documentation
7235
7306
  #
@@ -7239,13 +7310,12 @@ module Aws::ECS
7239
7310
  # instance to send or receive traffic. Port mappings are specified as
7240
7311
  # part of the container definition.
7241
7312
  #
7242
- # If you are using containers in a task with the `awsvpc` or `host`
7243
- # network mode, exposed ports should be specified using `containerPort`.
7244
- # The `hostPort` can be left blank or it must be the same value as the
7245
- # `containerPort`.
7313
+ # If you use containers in a task with the `awsvpc` or `host` network
7314
+ # mode, specify the exposed ports using `containerPort`. The `hostPort`
7315
+ # can be left blank or it must be the same value as the `containerPort`.
7246
7316
  #
7247
- # <note markdown="1"> You cannot expose the same container port for multiple protocols. An
7248
- # error will be returned if this is attempted
7317
+ # <note markdown="1"> You can't expose the same container port for multiple protocols. If
7318
+ # you attempt this, an error is returned.
7249
7319
  #
7250
7320
  # </note>
7251
7321
  #
@@ -7263,15 +7333,14 @@ module Aws::ECS
7263
7333
  # }
7264
7334
  #
7265
7335
  # @!attribute [rw] container_port
7266
- # The port number on the container that is bound to the user-specified
7336
+ # The port number on the container that's bound to the user-specified
7267
7337
  # or automatically assigned host port.
7268
7338
  #
7269
- # If you are using containers in a task with the `awsvpc` or `host`
7270
- # network mode, exposed ports should be specified using
7271
- # `containerPort`.
7339
+ # If you use containers in a task with the `awsvpc` or `host` network
7340
+ # mode, specify the exposed ports using `containerPort`.
7272
7341
  #
7273
- # If you are using containers in a task with the `bridge` network mode
7274
- # and you specify a container port and not a host port, your container
7342
+ # If you use containers in a task with the `bridge` network mode and
7343
+ # you specify a container port and not a host port, your container
7275
7344
  # automatically receives a host port in the ephemeral port range. For
7276
7345
  # more information, see `hostPort`. Port mappings that are
7277
7346
  # automatically assigned in this way do not count toward the 100
@@ -7282,14 +7351,14 @@ module Aws::ECS
7282
7351
  # The port number on the container instance to reserve for your
7283
7352
  # container.
7284
7353
  #
7285
- # If you are using containers in a task with the `awsvpc` or `host`
7286
- # network mode, the `hostPort` can either be left blank or set to the
7287
- # same value as the `containerPort`.
7354
+ # If you use containers in a task with the `awsvpc` or `host` network
7355
+ # mode, the `hostPort` can either be left blank or set to the same
7356
+ # value as the `containerPort`.
7288
7357
  #
7289
- # If you are using containers in a task with the `bridge` network
7290
- # mode, you can specify a non-reserved host port for your container
7291
- # port mapping, or you can omit the `hostPort` (or set it to `0`)
7292
- # while specifying a `containerPort` and your container automatically
7358
+ # If you use containers in a task with the `bridge` network mode, you
7359
+ # can specify a non-reserved host port for your container port
7360
+ # mapping, or you can omit the `hostPort` (or set it to `0`) while
7361
+ # specifying a `containerPort` and your container automatically
7293
7362
  # receives a port in the ephemeral port range for your container
7294
7363
  # instance operating system and Docker version.
7295
7364
  #
@@ -7310,12 +7379,12 @@ module Aws::ECS
7310
7379
  # The default reserved ports are 22 for SSH, the Docker ports 2375 and
7311
7380
  # 2376, and the Amazon ECS container agent ports 51678-51680. Any host
7312
7381
  # port that was previously specified in a running task is also
7313
- # reserved while the task is running (after a task stops, the host
7314
- # port is released). The current reserved ports are displayed in the
7315
- # `remainingResources` of DescribeContainerInstances output. A
7316
- # container instance can have up to 100 reserved ports at a time,
7317
- # including the default reserved ports. Automatically assigned ports
7318
- # don't count toward the 100 reserved ports limit.
7382
+ # reserved while the task is running. That is, after a task stops, the
7383
+ # host port is released. The current reserved ports are displayed in
7384
+ # the `remainingResources` of DescribeContainerInstances output. A
7385
+ # container instance can have up to 100 reserved ports at a time. This
7386
+ # number includes the default reserved ports. Automatically assigned
7387
+ # ports aren't included in the 100 reserved ports quota.
7319
7388
  # @return [Integer]
7320
7389
  #
7321
7390
  # @!attribute [rw] protocol
@@ -7335,13 +7404,13 @@ module Aws::ECS
7335
7404
 
7336
7405
  # The configuration details for the App Mesh proxy.
7337
7406
  #
7338
- # For tasks using the EC2 launch type, the container instances require
7339
- # at least version 1.26.0 of the container agent and at least version
7340
- # 1.26.0-1 of the `ecs-init` package to enable a proxy configuration. If
7341
- # your container instances are launched from the Amazon ECS-optimized
7342
- # AMI version `20190301` or later, then they contain the required
7343
- # versions of the container agent and `ecs-init`. For more information,
7344
- # see [Amazon ECS-optimized Linux AMI][1]
7407
+ # For tasks that use the EC2 launch type, the container instances
7408
+ # require at least version 1.26.0 of the container agent and at least
7409
+ # version 1.26.0-1 of the `ecs-init` package to enable a proxy
7410
+ # configuration. If your container instances are launched from the
7411
+ # Amazon ECS optimized AMI version `20190301` or later, then they
7412
+ # contain the required versions of the container agent and `ecs-init`.
7413
+ # For more information, see [Amazon ECS-optimized Linux AMI][1]
7345
7414
  #
7346
7415
  #
7347
7416
  #
@@ -7545,8 +7614,8 @@ module Aws::ECS
7545
7614
  #
7546
7615
  # @!attribute [rw] attributes
7547
7616
  # The attributes to apply to your resource. You can specify up to 10
7548
- # custom attributes per resource. You can specify up to 10 attributes
7549
- # in a single call.
7617
+ # custom attributes for each resource. You can specify up to 10
7618
+ # attributes in a single call.
7550
7619
  # @return [Array<Types::Attribute>]
7551
7620
  #
7552
7621
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributesRequest AWS API Documentation
@@ -7587,7 +7656,7 @@ module Aws::ECS
7587
7656
  #
7588
7657
  # @!attribute [rw] cluster
7589
7658
  # The short name or full Amazon Resource Name (ARN) of the cluster to
7590
- # modify the capacity provider settings for. If you do not specify a
7659
+ # modify the capacity provider settings for. If you don't specify a
7591
7660
  # cluster, the default cluster is assumed.
7592
7661
  # @return [String]
7593
7662
  #
@@ -7699,9 +7768,9 @@ module Aws::ECS
7699
7768
  # }
7700
7769
  #
7701
7770
  # @!attribute [rw] cluster
7702
- # The short name or full Amazon Resource Name (ARN) of the cluster
7703
- # with which to register your container instance. If you do not
7704
- # specify a cluster, the default cluster is assumed.
7771
+ # The short name or full Amazon Resource Name (ARN) of the cluster to
7772
+ # register your container instance with. If you do not specify a
7773
+ # cluster, the default cluster is assumed.
7705
7774
  # @return [String]
7706
7775
  #
7707
7776
  # @!attribute [rw] instance_identity_document
@@ -7724,7 +7793,7 @@ module Aws::ECS
7724
7793
  #
7725
7794
  # @!attribute [rw] version_info
7726
7795
  # The version information for the Amazon ECS container agent and
7727
- # Docker daemon running on the container instance.
7796
+ # Docker daemon that runs on the container instance.
7728
7797
  # @return [Types::VersionInfo]
7729
7798
  #
7730
7799
  # @!attribute [rw] container_instance_arn
@@ -7744,7 +7813,7 @@ module Aws::ECS
7744
7813
  # @!attribute [rw] tags
7745
7814
  # The metadata that you apply to the container instance to help you
7746
7815
  # categorize and organize them. Each tag consists of a key and an
7747
- # optional value, both of which you define.
7816
+ # optional value. You define both.
7748
7817
  #
7749
7818
  # The following basic restrictions apply to tags:
7750
7819
  #
@@ -8038,9 +8107,9 @@ module Aws::ECS
8038
8107
  # }
8039
8108
  #
8040
8109
  # @!attribute [rw] family
8041
- # You must specify a `family` for a task definition, which allows you
8042
- # to track multiple versions of the same task definition. The `family`
8043
- # is used as a name for your task definition. Up to 255 letters
8110
+ # You must specify a `family` for a task definition. You can use it
8111
+ # track multiple versions of the same task definition. The `family` is
8112
+ # used as a name for your task definition. Up to 255 letters
8044
8113
  # (uppercase and lowercase), numbers, underscores, and hyphens are
8045
8114
  # allowed.
8046
8115
  # @return [String]
@@ -8122,28 +8191,27 @@ module Aws::ECS
8122
8191
  #
8123
8192
  # @!attribute [rw] volumes
8124
8193
  # A list of volume definitions in JSON format that containers in your
8125
- # task may use.
8194
+ # task might use.
8126
8195
  # @return [Array<Types::Volume>]
8127
8196
  #
8128
8197
  # @!attribute [rw] placement_constraints
8129
8198
  # An array of placement constraint objects to use for the task. You
8130
- # can specify a maximum of 10 constraints per task (this limit
8199
+ # can specify a maximum of 10 constraints for each task. This limit
8131
8200
  # includes constraints in the task definition and those specified at
8132
- # runtime).
8201
+ # runtime.
8133
8202
  # @return [Array<Types::TaskDefinitionPlacementConstraint>]
8134
8203
  #
8135
8204
  # @!attribute [rw] requires_compatibilities
8136
- # The task launch type that Amazon ECS should validate the task
8137
- # definition against. A client exception is returned if the task
8138
- # definition doesn't validate against the compatibilities specified.
8139
- # If no value is specified, the parameter is omitted from the
8140
- # response.
8205
+ # The task launch type that Amazon ECS validates the task definition
8206
+ # against. A client exception is returned if the task definition
8207
+ # doesn't validate against the compatibilities specified. If no value
8208
+ # is specified, the parameter is omitted from the response.
8141
8209
  # @return [Array<String>]
8142
8210
  #
8143
8211
  # @!attribute [rw] cpu
8144
8212
  # The number of CPU units used by the task. It can be expressed as an
8145
- # integer using CPU units, for example `1024`, or as a string using
8146
- # vCPUs, for example `1 vCPU` or `1 vcpu`, in a task definition.
8213
+ # integer using CPU units (for example, `1024`) or as a string using
8214
+ # vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition.
8147
8215
  # String values are converted to an integer indicating the CPU units
8148
8216
  # when the task definition is registered.
8149
8217
  #
@@ -8153,14 +8221,17 @@ module Aws::ECS
8153
8221
  #
8154
8222
  # </note>
8155
8223
  #
8156
- # If you are using the EC2 launch type, this field is optional.
8224
+ # If you're using the EC2 launch type, this field is optional.
8157
8225
  # Supported values are between `128` CPU units (`0.125` vCPUs) and
8158
8226
  # `10240` CPU units (`10` vCPUs).
8159
8227
  #
8160
- # If you are using the Fargate launch type, this field is required and
8228
+ # If you're using the Fargate launch type, this field is required and
8161
8229
  # you must use one of the following values, which determines your
8162
8230
  # range of supported values for the `memory` parameter:
8163
8231
  #
8232
+ # The CPU units cannot be less than 1 vCPU when you use Windows
8233
+ # containers on Fargate.
8234
+ #
8164
8235
  # * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
8165
8236
  # GB), 2048 (2 GB)
8166
8237
  #
@@ -8180,9 +8251,9 @@ module Aws::ECS
8180
8251
  #
8181
8252
  # @!attribute [rw] memory
8182
8253
  # The amount of memory (in MiB) used by the task. It can be expressed
8183
- # as an integer using MiB, for example `1024`, or as a string using
8184
- # GB, for example `1GB` or `1 GB`, in a task definition. String values
8185
- # are converted to an integer indicating the MiB when the task
8254
+ # as an integer using MiB (for example ,`1024`) or as a string using
8255
+ # GB (for example, `1GB` or `1 GB`) in a task definition. String
8256
+ # values are converted to an integer indicating the MiB when the task
8186
8257
  # definition is registered.
8187
8258
  #
8188
8259
  # <note markdown="1"> Task-level CPU and memory parameters are ignored for Windows
@@ -8194,8 +8265,11 @@ module Aws::ECS
8194
8265
  # If using the EC2 launch type, this field is optional.
8195
8266
  #
8196
8267
  # If using the Fargate launch type, this field is required and you
8197
- # must use one of the following values, which determines your range of
8198
- # supported values for the `cpu` parameter:
8268
+ # must use one of the following values. This determines your range of
8269
+ # supported values for the `cpu` parameter.
8270
+ #
8271
+ # The CPU units cannot be less than 1 vCPU when you use Windows
8272
+ # containers on Fargate.
8199
8273
  #
8200
8274
  # * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
8201
8275
  # 256 (.25 vCPU)
@@ -8216,7 +8290,7 @@ module Aws::ECS
8216
8290
  # @!attribute [rw] tags
8217
8291
  # The metadata that you apply to the task definition to help you
8218
8292
  # categorize and organize them. Each tag consists of a key and an
8219
- # optional value, both of which you define.
8293
+ # optional value. You define both of them.
8220
8294
  #
8221
8295
  # The following basic restrictions apply to tags:
8222
8296
  #
@@ -8416,11 +8490,11 @@ module Aws::ECS
8416
8490
  # The Amazon Resource Name (ARN) of the secret containing the private
8417
8491
  # repository credentials.
8418
8492
  #
8419
- # <note markdown="1"> When you are using the Amazon ECS API, CLI, or Amazon Web Services
8420
- # SDK, if the secret exists in the same Region as the task that you
8421
- # are launching then you can use either the full ARN or the name of
8422
- # the secret. When you are using the Amazon Web Services Management
8423
- # Console, you must specify the full ARN of the secret.
8493
+ # <note markdown="1"> When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if
8494
+ # the secret exists in the same Region as the task that you're
8495
+ # launching then you can use either the full ARN or the name of the
8496
+ # secret. When you use the Amazon Web Services Management Console, you
8497
+ # must specify the full ARN of the secret.
8424
8498
  #
8425
8499
  # </note>
8426
8500
  # @return [String]
@@ -8453,8 +8527,8 @@ module Aws::ECS
8453
8527
  # @return [String]
8454
8528
  #
8455
8529
  # @!attribute [rw] type
8456
- # The type of the resource, such as `INTEGER`, `DOUBLE`, `LONG`, or
8457
- # `STRINGSET`.
8530
+ # The type of the resource. Valid values: `INTEGER`, `DOUBLE`, `LONG`,
8531
+ # or `STRINGSET`.
8458
8532
  # @return [String]
8459
8533
  #
8460
8534
  # @!attribute [rw] double_value
@@ -8490,13 +8564,13 @@ module Aws::ECS
8490
8564
  include Aws::Structure
8491
8565
  end
8492
8566
 
8493
- # The specified resource is in-use and cannot be removed.
8567
+ # The specified resource is in-use and can't be removed.
8494
8568
  #
8495
8569
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceInUseException AWS API Documentation
8496
8570
  #
8497
8571
  class ResourceInUseException < Aws::EmptyStructure; end
8498
8572
 
8499
- # The specified resource could not be found.
8573
+ # The specified resource wasn't found.
8500
8574
  #
8501
8575
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceNotFoundException AWS API Documentation
8502
8576
  #
@@ -8525,13 +8599,13 @@ module Aws::ECS
8525
8599
  # The value for the specified resource type.
8526
8600
  #
8527
8601
  # If the `GPU` type is used, the value is the number of physical
8528
- # `GPUs` the Amazon ECS container agent will reserve for the
8529
- # container. The number of GPUs reserved for all containers in a task
8530
- # should not exceed the number of available GPUs on the container
8531
- # instance the task is launched on.
8602
+ # `GPUs` the Amazon ECS container agent reserves for the container.
8603
+ # The number of GPUs that's reserved for all containers in a task
8604
+ # can't exceed the number of available GPUs on the container instance
8605
+ # that the task is launched on.
8532
8606
  #
8533
- # If the `InferenceAccelerator` type is used, the `value` should match
8534
- # the `deviceName` for an InferenceAccelerator specified in a task
8607
+ # If the `InferenceAccelerator` type is used, the `value` matches the
8608
+ # `deviceName` for an InferenceAccelerator specified in a task
8535
8609
  # definition.
8536
8610
  # @return [String]
8537
8611
  #
@@ -8656,14 +8730,14 @@ module Aws::ECS
8656
8730
  # @return [Array<Types::CapacityProviderStrategyItem>]
8657
8731
  #
8658
8732
  # @!attribute [rw] cluster
8659
- # The short name or full Amazon Resource Name (ARN) of the cluster on
8660
- # which to run your task. If you do not specify a cluster, the default
8733
+ # The short name or full Amazon Resource Name (ARN) of the cluster to
8734
+ # run your task on. If you do not specify a cluster, the default
8661
8735
  # cluster is assumed.
8662
8736
  # @return [String]
8663
8737
  #
8664
8738
  # @!attribute [rw] count
8665
8739
  # The number of instantiations of the specified task to place on your
8666
- # cluster. You can specify up to 10 tasks per call.
8740
+ # cluster. You can specify up to 10 tasks for each call.
8667
8741
  # @return [Integer]
8668
8742
  #
8669
8743
  # @!attribute [rw] enable_ecs_managed_tags
@@ -8677,8 +8751,8 @@ module Aws::ECS
8677
8751
  # @return [Boolean]
8678
8752
  #
8679
8753
  # @!attribute [rw] enable_execute_command
8680
- # Whether or not to enable the execute command functionality for the
8681
- # containers in this task. If `true`, this enables execute command
8754
+ # Determines whether to enable the execute command functionality for
8755
+ # the containers in this task. If `true`, this enables execute command
8682
8756
  # functionality on all containers in the task.
8683
8757
  # @return [Boolean]
8684
8758
  #
@@ -8689,7 +8763,7 @@ module Aws::ECS
8689
8763
  # @return [String]
8690
8764
  #
8691
8765
  # @!attribute [rw] launch_type
8692
- # The infrastructure on which to run your standalone task. For more
8766
+ # The infrastructure to run your standalone task on. For more
8693
8767
  # information, see [Amazon ECS launch types][1] in the *Amazon Elastic
8694
8768
  # Container Service Developer Guide*.
8695
8769
  #
@@ -8705,8 +8779,8 @@ module Aws::ECS
8705
8779
  # The `EC2` launch type runs your tasks on Amazon EC2 instances
8706
8780
  # registered to your cluster.
8707
8781
  #
8708
- # The `EXTERNAL` launch type runs your tasks on your on-premise server
8709
- # or virtual machine (VM) capacity registered to your cluster.
8782
+ # The `EXTERNAL` launch type runs your tasks on your on-premises
8783
+ # server or virtual machine (VM) capacity registered to your cluster.
8710
8784
  #
8711
8785
  # A task can use either a launch type or a capacity provider strategy.
8712
8786
  # If a `launchType` is specified, the `capacityProviderStrategy`
@@ -8724,7 +8798,7 @@ module Aws::ECS
8724
8798
  # @!attribute [rw] network_configuration
8725
8799
  # The network configuration for the task. This parameter is required
8726
8800
  # for task definitions that use the `awsvpc` network mode to receive
8727
- # their own elastic network interface, and it is not supported for
8801
+ # their own elastic network interface, and it isn't supported for
8728
8802
  # other network modes. For more information, see [Task networking][1]
8729
8803
  # in the *Amazon Elastic Container Service Developer Guide*.
8730
8804
  #
@@ -8737,7 +8811,7 @@ module Aws::ECS
8737
8811
  # A list of container overrides in JSON format that specify the name
8738
8812
  # of a container in the specified task definition and the overrides it
8739
8813
  # should receive. You can override the default command for a container
8740
- # (that is specified in the task definition or Docker image) with a
8814
+ # (that's specified in the task definition or Docker image) with a
8741
8815
  # `command` override. You can also override existing environment
8742
8816
  # variables (that are specified in the task definition or Docker
8743
8817
  # image) on a container or add new environment variables to it with an
@@ -8749,20 +8823,20 @@ module Aws::ECS
8749
8823
  #
8750
8824
  # @!attribute [rw] placement_constraints
8751
8825
  # An array of placement constraint objects to use for the task. You
8752
- # can specify up to 10 constraints per task (including constraints in
8753
- # the task definition and those specified at runtime).
8826
+ # can specify up to 10 constraints for each task (including
8827
+ # constraints in the task definition and those specified at runtime).
8754
8828
  # @return [Array<Types::PlacementConstraint>]
8755
8829
  #
8756
8830
  # @!attribute [rw] placement_strategy
8757
8831
  # The placement strategy objects to use for the task. You can specify
8758
- # a maximum of 5 strategy rules per task.
8832
+ # a maximum of 5 strategy rules for each task.
8759
8833
  # @return [Array<Types::PlacementStrategy>]
8760
8834
  #
8761
8835
  # @!attribute [rw] platform_version
8762
- # The platform version the task should use. A platform version is only
8763
- # specified for tasks hosted on Fargate. If one is not specified, the
8764
- # `LATEST` platform version is used by default. For more information,
8765
- # see [Fargate platform versions][1] in the *Amazon Elastic Container
8836
+ # The platform version the task uses. A platform version is only
8837
+ # specified for tasks hosted on Fargate. If one isn't specified, the
8838
+ # `LATEST` platform version is used. For more information, see
8839
+ # [Fargate platform versions][1] in the *Amazon Elastic Container
8766
8840
  # Service Developer Guide*.
8767
8841
  #
8768
8842
  #
@@ -8772,7 +8846,7 @@ module Aws::ECS
8772
8846
  #
8773
8847
  # @!attribute [rw] propagate_tags
8774
8848
  # Specifies whether to propagate the tags from the task definition to
8775
- # the task. If no value is specified, the tags are not propagated.
8849
+ # the task. If no value is specified, the tags aren't propagated.
8776
8850
  # Tags can only be propagated to the task during task creation. To add
8777
8851
  # tags to a task after task creation, use the TagResource API action.
8778
8852
  #
@@ -8794,7 +8868,7 @@ module Aws::ECS
8794
8868
  # `startedBy` parameter. You can then identify which tasks belong to
8795
8869
  # that job by filtering the results of a ListTasks call with the
8796
8870
  # `startedBy` value. Up to 36 letters (uppercase and lowercase),
8797
- # numbers, hyphens, and underscores are allowed.
8871
+ # numbers, hyphens (-), and underscores (\_) are allowed.
8798
8872
  #
8799
8873
  # If a task is started by an Amazon ECS service, then the `startedBy`
8800
8874
  # parameter contains the deployment ID of the service that starts it.
@@ -8833,10 +8907,10 @@ module Aws::ECS
8833
8907
  #
8834
8908
  # @!attribute [rw] task_definition
8835
8909
  # The `family` and `revision` (`family:revision`) or full ARN of the
8836
- # task definition to run. If a `revision` is not specified, the latest
8910
+ # task definition to run. If a `revision` isn't specified, the latest
8837
8911
  # `ACTIVE` revision is used.
8838
8912
  #
8839
- # The full ARN value must match the value that you specified ias the
8913
+ # The full ARN value must match the value that you specified as the
8840
8914
  # `Resource` of the IAM principal's permissions policy. For example,
8841
8915
  # if the `Resource` is
8842
8916
  # arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
@@ -8888,6 +8962,14 @@ module Aws::ECS
8888
8962
 
8889
8963
  # Information about the platform for the Amazon ECS service or task.
8890
8964
  #
8965
+ # For more informataion about `RuntimePlatform`, see
8966
+ # [RuntimePlatform][1] in the *Amazon Elastic Container Service
8967
+ # Developer Guide*.
8968
+ #
8969
+ #
8970
+ #
8971
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform
8972
+ #
8891
8973
  # @note When making an API call, you may pass RuntimePlatform
8892
8974
  # data as a hash:
8893
8975
  #
@@ -8898,6 +8980,10 @@ module Aws::ECS
8898
8980
  #
8899
8981
  # @!attribute [rw] cpu_architecture
8900
8982
  # The CPU architecture.
8983
+ #
8984
+ # You can run your Linux tasks on an ARM-based platform by setting the
8985
+ # value to `ARM64`. This option is avaiable for tasks that run on
8986
+ # Linuc Amazon EC2 instance or Linux containers on Fargate.
8901
8987
  # @return [String]
8902
8988
  #
8903
8989
  # @!attribute [rw] operating_system_family
@@ -8977,7 +9063,7 @@ module Aws::ECS
8977
9063
  # the parameter in the SSM Parameter Store.
8978
9064
  #
8979
9065
  # <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
8980
- # the task you are launching, then you can use either the full ARN or
9066
+ # the task you're launching, then you can use either the full ARN or
8981
9067
  # name of the parameter. If the parameter exists in a different
8982
9068
  # Region, then the full ARN must be specified.
8983
9069
  #
@@ -9019,9 +9105,9 @@ module Aws::ECS
9019
9105
  # @!attribute [rw] service_name
9020
9106
  # The name of your service. Up to 255 letters (uppercase and
9021
9107
  # lowercase), numbers, underscores, and hyphens are allowed. Service
9022
- # names must be unique within a cluster, but you can have similarly
9023
- # named services in multiple clusters within a Region or across
9024
- # multiple Regions.
9108
+ # names must be unique within a cluster. However, you can have
9109
+ # similarly named services in multiple clusters within a Region or
9110
+ # across multiple Regions.
9025
9111
  # @return [String]
9026
9112
  #
9027
9113
  # @!attribute [rw] cluster_arn
@@ -9030,14 +9116,14 @@ module Aws::ECS
9030
9116
  # @return [String]
9031
9117
  #
9032
9118
  # @!attribute [rw] load_balancers
9033
- # A list of Elastic Load Balancing load balancer objects, containing
9034
- # the load balancer name, the container name (as it appears in a
9035
- # container definition), and the container port to access from the
9036
- # load balancer.
9119
+ # A list of Elastic Load Balancing load balancer objects. It contains
9120
+ # the load balancer name, the container name, and the container port
9121
+ # to access from the load balancer. The container name is as it
9122
+ # appears in a container definition.
9037
9123
  # @return [Array<Types::LoadBalancer>]
9038
9124
  #
9039
9125
  # @!attribute [rw] service_registries
9040
- # The details of the service discovery registries to assign to this
9126
+ # The details for the service discovery registries to assign to this
9041
9127
  # service. For more information, see [Service Discovery][1].
9042
9128
  #
9043
9129
  #
@@ -9072,16 +9158,16 @@ module Aws::ECS
9072
9158
  # @return [String]
9073
9159
  #
9074
9160
  # @!attribute [rw] capacity_provider_strategy
9075
- # The capacity provider strategy the service is using. When using the
9161
+ # The capacity provider strategy the service uses. When using the
9076
9162
  # DescribeServices API, this field is omitted if the service was
9077
9163
  # created using a launch type.
9078
9164
  # @return [Array<Types::CapacityProviderStrategyItem>]
9079
9165
  #
9080
9166
  # @!attribute [rw] platform_version
9081
- # The platform version on which to run your service. A platform
9082
- # version is only specified for tasks hosted on Fargate. If one is not
9083
- # specified, the `LATEST` platform version is used by default. For
9084
- # more information, see [Fargate Platform Versions][1] in the *Amazon
9167
+ # The platform version to run your service on. A platform version is
9168
+ # only specified for tasks that are hosted on Fargate. If one isn't
9169
+ # specified, the `LATEST` platform version is used. For more
9170
+ # information, see [Fargate Platform Versions][1] in the *Amazon
9085
9171
  # Elastic Container Service Developer Guide*.
9086
9172
  #
9087
9173
  #
@@ -9090,12 +9176,12 @@ module Aws::ECS
9090
9176
  # @return [String]
9091
9177
  #
9092
9178
  # @!attribute [rw] platform_family
9093
- # The operating system that your tasks in the service are running on.
9094
- # A platform family is specified only for tasks using the Fargate
9095
- # launch type.
9179
+ # The operating system that your tasks in the service run on. A
9180
+ # platform family is specified only for tasks using the Fargate launch
9181
+ # type.
9096
9182
  #
9097
9183
  # All tasks that run as part of this service must use the same
9098
- # `platformFamily` value as the service, for example, `LINUX`.
9184
+ # `platformFamily` value as the service (for example, `LINUX`).
9099
9185
  # @return [String]
9100
9186
  #
9101
9187
  # @!attribute [rw] task_definition
@@ -9122,9 +9208,9 @@ module Aws::ECS
9122
9208
  # @return [Array<Types::Deployment>]
9123
9209
  #
9124
9210
  # @!attribute [rw] role_arn
9125
- # The ARN of the IAM role associated with the service that allows the
9126
- # Amazon ECS container agent to register container instances with an
9127
- # Elastic Load Balancing load balancer.
9211
+ # The ARN of the IAM role that's associated with the service. It
9212
+ # allows the Amazon ECS container agent to register container
9213
+ # instances with an Elastic Load Balancing load balancer.
9128
9214
  # @return [String]
9129
9215
  #
9130
9216
  # @!attribute [rw] events
@@ -9133,7 +9219,7 @@ module Aws::ECS
9133
9219
  # @return [Array<Types::ServiceEvent>]
9134
9220
  #
9135
9221
  # @!attribute [rw] created_at
9136
- # The Unix timestamp for when the service was created.
9222
+ # The Unix timestamp for the time when the service was created.
9137
9223
  # @return [Time]
9138
9224
  #
9139
9225
  # @!attribute [rw] placement_constraints
@@ -9161,7 +9247,7 @@ module Aws::ECS
9161
9247
  # The scheduling strategy to use for the service. For more
9162
9248
  # information, see [Services][1].
9163
9249
  #
9164
- # There are two service scheduler strategies available:
9250
+ # There are two service scheduler strategies available.
9165
9251
  #
9166
9252
  # * `REPLICA`-The replica scheduling strategy places and maintains the
9167
9253
  # desired number of tasks across your cluster. By default, the
@@ -9170,13 +9256,13 @@ module Aws::ECS
9170
9256
  # placement decisions.
9171
9257
  #
9172
9258
  # * `DAEMON`-The daemon scheduling strategy deploys exactly one task
9173
- # on each active container instance that meets all of the task
9259
+ # on each active container instance. This taskmeets all of the task
9174
9260
  # placement constraints that you specify in your cluster. The
9175
9261
  # service scheduler also evaluates the task placement constraints
9176
- # for running tasks and will stop tasks that do not meet the
9177
- # placement constraints.
9262
+ # for running tasks. It stop tasks that don't meet the placement
9263
+ # constraints.
9178
9264
  #
9179
- # <note markdown="1"> Fargate tasks do not support the `DAEMON` scheduling strategy.
9265
+ # <note markdown="1"> Fargate tasks don't support the `DAEMON` scheduling strategy.
9180
9266
  #
9181
9267
  # </note>
9182
9268
  #
@@ -9187,14 +9273,14 @@ module Aws::ECS
9187
9273
  #
9188
9274
  # @!attribute [rw] deployment_controller
9189
9275
  # The deployment controller type the service is using. When using the
9190
- # DescribeServices API, this field is omitted if the service is using
9191
- # the `ECS` deployment controller type.
9276
+ # DescribeServices API, this field is omitted if the service uses the
9277
+ # `ECS` deployment controller type.
9192
9278
  # @return [Types::DeploymentController]
9193
9279
  #
9194
9280
  # @!attribute [rw] tags
9195
9281
  # The metadata that you apply to the service to help you categorize
9196
- # and organize them. Each tag consists of a key and an optional value,
9197
- # both of which you define.
9282
+ # and organize them. Each tag consists of a key and an optional value.
9283
+ # You define bot the key and value.
9198
9284
  #
9199
9285
  # The following basic restrictions apply to tags:
9200
9286
  #
@@ -9227,8 +9313,8 @@ module Aws::ECS
9227
9313
  # @return [String]
9228
9314
  #
9229
9315
  # @!attribute [rw] enable_ecs_managed_tags
9230
- # Specifies whether to enable Amazon ECS managed tags for the tasks in
9231
- # the service. For more information, see [Tagging Your Amazon ECS
9316
+ # Determines whether to enable Amazon ECS managed tags for the tasks
9317
+ # in the service. For more information, see [Tagging Your Amazon ECS
9232
9318
  # Resources][1] in the *Amazon Elastic Container Service Developer
9233
9319
  # Guide*.
9234
9320
  #
@@ -9238,15 +9324,15 @@ module Aws::ECS
9238
9324
  # @return [Boolean]
9239
9325
  #
9240
9326
  # @!attribute [rw] propagate_tags
9241
- # Specifies whether to propagate the tags from the task definition or
9242
- # the service to the task. If no value is specified, the tags are not
9327
+ # Determines whether to propagate the tags from the task definition or
9328
+ # the service to the task. If no value is specified, the tags aren't
9243
9329
  # propagated.
9244
9330
  # @return [String]
9245
9331
  #
9246
9332
  # @!attribute [rw] enable_execute_command
9247
- # Whether or not the execute command functionality is enabled for the
9248
- # service. If `true`, the execute command functionality is enabled for
9249
- # all containers in tasks as part of the service.
9333
+ # Determines whether the execute command functionality is enabled for
9334
+ # the service. If `true`, the execute command functionality is enabled
9335
+ # for all containers in tasks as part of the service.
9250
9336
  # @return [Boolean]
9251
9337
  #
9252
9338
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Service AWS API Documentation
@@ -9287,14 +9373,14 @@ module Aws::ECS
9287
9373
  include Aws::Structure
9288
9374
  end
9289
9375
 
9290
- # Details on an event associated with a service.
9376
+ # The details for an event that's associated with a service.
9291
9377
  #
9292
9378
  # @!attribute [rw] id
9293
- # The ID string of the event.
9379
+ # The ID string for the event.
9294
9380
  # @return [String]
9295
9381
  #
9296
9382
  # @!attribute [rw] created_at
9297
- # The Unix timestamp for when the event was triggered.
9383
+ # The Unix timestamp for the time when the event was triggered.
9298
9384
  # @return [Time]
9299
9385
  #
9300
9386
  # @!attribute [rw] message
@@ -9311,23 +9397,23 @@ module Aws::ECS
9311
9397
  include Aws::Structure
9312
9398
  end
9313
9399
 
9314
- # The specified service is not active. You can't update a service that
9315
- # is inactive. If you have previously deleted a service, you can
9400
+ # The specified service isn't active. You can't update a service
9401
+ # that's inactive. If you have previously deleted a service, you can
9316
9402
  # re-create it with CreateService.
9317
9403
  #
9318
9404
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotActiveException AWS API Documentation
9319
9405
  #
9320
9406
  class ServiceNotActiveException < Aws::EmptyStructure; end
9321
9407
 
9322
- # The specified service could not be found. You can view your available
9323
- # services with ListServices. Amazon ECS services are cluster-specific
9324
- # and Region-specific.
9408
+ # The specified service wasn't found. You can view your available
9409
+ # services with ListServices. Amazon ECS services are cluster specific
9410
+ # and Region specific.
9325
9411
  #
9326
9412
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotFoundException AWS API Documentation
9327
9413
  #
9328
9414
  class ServiceNotFoundException < Aws::EmptyStructure; end
9329
9415
 
9330
- # Details of the service registry.
9416
+ # The details for the service registry.
9331
9417
  #
9332
9418
  # @note When making an API call, you may pass ServiceRegistry
9333
9419
  # data as a hash:
@@ -9351,31 +9437,32 @@ module Aws::ECS
9351
9437
  #
9352
9438
  # @!attribute [rw] port
9353
9439
  # The port value used if your service discovery service specified an
9354
- # SRV record. This field may be used if both the `awsvpc` network mode
9355
- # and SRV records are used.
9440
+ # SRV record. This field might be used if both the `awsvpc` network
9441
+ # mode and SRV records are used.
9356
9442
  # @return [Integer]
9357
9443
  #
9358
9444
  # @!attribute [rw] container_name
9359
- # The container name value, already specified in the task definition,
9360
- # to be used for your service discovery service. If the task
9445
+ # The container name value to be used for your service discovery
9446
+ # service. It's already specified in the task definition. If the task
9361
9447
  # definition that your service task specifies uses the `bridge` or
9362
9448
  # `host` network mode, you must specify a `containerName` and
9363
9449
  # `containerPort` combination from the task definition. If the task
9364
9450
  # definition that your service task specifies uses the `awsvpc`
9365
9451
  # network mode and a type SRV DNS record is used, you must specify
9366
9452
  # either a `containerName` and `containerPort` combination or a `port`
9367
- # value, but not both.
9453
+ # value. However, you can't specify both.
9368
9454
  # @return [String]
9369
9455
  #
9370
9456
  # @!attribute [rw] container_port
9371
- # The port value, already specified in the task definition, to be used
9372
- # for your service discovery service. If the task definition your
9373
- # service task specifies uses the `bridge` or `host` network mode, you
9374
- # must specify a `containerName` and `containerPort` combination from
9375
- # the task definition. If the task definition your service task
9376
- # specifies uses the `awsvpc` network mode and a type SRV DNS record
9377
- # is used, you must specify either a `containerName` and
9378
- # `containerPort` combination or a `port` value, but not both.
9457
+ # The port value to be used for your service discovery service. It's
9458
+ # already specified in the task definition. If the task definition
9459
+ # your service task specifies uses the `bridge` or `host` network
9460
+ # mode, you must specify a `containerName` and `containerPort`
9461
+ # combination from the task definition. If the task definition your
9462
+ # service task specifies uses the `awsvpc` network mode and a type SRV
9463
+ # DNS record is used, you must specify either a `containerName` and
9464
+ # `containerPort` combination or a `port` value. However, you can't
9465
+ # specify both.
9379
9466
  # @return [Integer]
9380
9467
  #
9381
9468
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRegistry AWS API Documentation
@@ -9389,7 +9476,7 @@ module Aws::ECS
9389
9476
  include Aws::Structure
9390
9477
  end
9391
9478
 
9392
- # The details of the execute command session.
9479
+ # The details for the execute command session.
9393
9480
  #
9394
9481
  # @!attribute [rw] session_id
9395
9482
  # The ID of the execute command session.
@@ -9403,7 +9490,7 @@ module Aws::ECS
9403
9490
  #
9404
9491
  # @!attribute [rw] token_value
9405
9492
  # An encrypted token value containing session and caller information.
9406
- # Used to authenticate the connection to the container.
9493
+ # It's used to authenticate the connection to the container.
9407
9494
  # @return [String]
9408
9495
  #
9409
9496
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Session AWS API Documentation
@@ -9423,12 +9510,12 @@ module Aws::ECS
9423
9510
  # @return [String]
9424
9511
  #
9425
9512
  # @!attribute [rw] value
9426
- # Whether the account setting is enabled or disabled for the specified
9427
- # resource.
9513
+ # Determines whether the account setting is enabled or disabled for
9514
+ # the specified resource.
9428
9515
  # @return [String]
9429
9516
  #
9430
9517
  # @!attribute [rw] principal_arn
9431
- # The ARN of the principal, which can be an IAM user, IAM role, or the
9518
+ # The ARN of the principal. It can be an IAM user, IAM role, or the
9432
9519
  # root user. If this field is omitted, the authenticated user is
9433
9520
  # assumed.
9434
9521
  # @return [String]
@@ -9514,15 +9601,15 @@ module Aws::ECS
9514
9601
  # }
9515
9602
  #
9516
9603
  # @!attribute [rw] cluster
9517
- # The short name or full Amazon Resource Name (ARN) of the cluster on
9518
- # which to start your task. If you do not specify a cluster, the
9604
+ # The short name or full Amazon Resource Name (ARN) of the cluster
9605
+ # where to start your task. If you do not specify a cluster, the
9519
9606
  # default cluster is assumed.
9520
9607
  # @return [String]
9521
9608
  #
9522
9609
  # @!attribute [rw] container_instances
9523
9610
  # The container instance IDs or full ARN entries for the container
9524
- # instances on which you would like to place your task. You can
9525
- # specify up to 10 container instances.
9611
+ # instances where you would like to place your task. You can specify
9612
+ # up to 10 container instances.
9526
9613
  # @return [Array<String>]
9527
9614
  #
9528
9615
  # @!attribute [rw] enable_ecs_managed_tags
@@ -9556,8 +9643,8 @@ module Aws::ECS
9556
9643
  # @!attribute [rw] overrides
9557
9644
  # A list of container overrides in JSON format that specify the name
9558
9645
  # of a container in the specified task definition and the overrides it
9559
- # should receive. You can override the default command for a container
9560
- # (that is specified in the task definition or Docker image) with a
9646
+ # receives. You can override the default command for a container
9647
+ # (that's specified in the task definition or Docker image) with a
9561
9648
  # `command` override. You can also override existing environment
9562
9649
  # variables (that are specified in the task definition or Docker
9563
9650
  # image) on a container or add new environment variables to it with an
@@ -9571,7 +9658,7 @@ module Aws::ECS
9571
9658
  #
9572
9659
  # @!attribute [rw] propagate_tags
9573
9660
  # Specifies whether to propagate the tags from the task definition or
9574
- # the service to the task. If no value is specified, the tags are not
9661
+ # the service to the task. If no value is specified, the tags aren't
9575
9662
  # propagated.
9576
9663
  # @return [String]
9577
9664
  #
@@ -9586,9 +9673,9 @@ module Aws::ECS
9586
9673
  # `startedBy` parameter. You can then identify which tasks belong to
9587
9674
  # that job by filtering the results of a ListTasks call with the
9588
9675
  # `startedBy` value. Up to 36 letters (uppercase and lowercase),
9589
- # numbers, hyphens, and underscores are allowed.
9676
+ # numbers, hyphens (-), and underscores (\_) are allowed.
9590
9677
  #
9591
- # If a task is started by an Amazon ECS service, then the `startedBy`
9678
+ # If a task is started by an Amazon ECS service, the `startedBy`
9592
9679
  # parameter contains the deployment ID of the service that starts it.
9593
9680
  # @return [String]
9594
9681
  #
@@ -9625,7 +9712,7 @@ module Aws::ECS
9625
9712
  #
9626
9713
  # @!attribute [rw] task_definition
9627
9714
  # The `family` and `revision` (`family:revision`) or full ARN of the
9628
- # task definition to start. If a `revision` is not specified, the
9715
+ # task definition to start. If a `revision` isn't specified, the
9629
9716
  # latest `ACTIVE` revision is used.
9630
9717
  # @return [String]
9631
9718
  #
@@ -9687,7 +9774,7 @@ module Aws::ECS
9687
9774
  #
9688
9775
  # @!attribute [rw] reason
9689
9776
  # An optional message specified when a task is stopped. For example,
9690
- # if you are using a custom scheduler, you can use this parameter to
9777
+ # if you're using a custom scheduler, you can use this parameter to
9691
9778
  # specify the reason for stopping the task here, and the message
9692
9779
  # appears in subsequent DescribeTasks API operations on this task. Up
9693
9780
  # to 255 characters are allowed in this message.
@@ -9801,7 +9888,7 @@ module Aws::ECS
9801
9888
  # @return [String]
9802
9889
  #
9803
9890
  # @!attribute [rw] exit_code
9804
- # The exit code returned for the state change request.
9891
+ # The exit code that's returned for the state change request.
9805
9892
  # @return [Integer]
9806
9893
  #
9807
9894
  # @!attribute [rw] reason
@@ -9902,7 +9989,7 @@ module Aws::ECS
9902
9989
  # @return [String]
9903
9990
  #
9904
9991
  # @!attribute [rw] containers
9905
- # Any containers associated with the state change request.
9992
+ # Any containers that's associated with the state change request.
9906
9993
  # @return [Array<Types::ContainerStateChange>]
9907
9994
  #
9908
9995
  # @!attribute [rw] attachments
@@ -9910,19 +9997,21 @@ module Aws::ECS
9910
9997
  # @return [Array<Types::AttachmentStateChange>]
9911
9998
  #
9912
9999
  # @!attribute [rw] managed_agents
9913
- # The details for the managed agent associated with the task.
10000
+ # The details for the managed agent that's associated with the task.
9914
10001
  # @return [Array<Types::ManagedAgentStateChange>]
9915
10002
  #
9916
10003
  # @!attribute [rw] pull_started_at
9917
- # The Unix timestamp for when the container image pull began.
10004
+ # The Unix timestamp for the time when the container image pull
10005
+ # started.
9918
10006
  # @return [Time]
9919
10007
  #
9920
10008
  # @!attribute [rw] pull_stopped_at
9921
- # The Unix timestamp for when the container image pull completed.
10009
+ # The Unix timestamp for the time when the container image pull
10010
+ # completed.
9922
10011
  # @return [Time]
9923
10012
  #
9924
10013
  # @!attribute [rw] execution_stopped_at
9925
- # The Unix timestamp for when the task execution stopped.
10014
+ # The Unix timestamp for the time when the task execution stopped.
9926
10015
  # @return [Time]
9927
10016
  #
9928
10017
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChangeRequest AWS API Documentation
@@ -9959,21 +10048,21 @@ module Aws::ECS
9959
10048
  # the [Docker Remote API][2] and the `--sysctl` option to [docker
9960
10049
  # run][3].
9961
10050
  #
9962
- # It is not recommended that you specify network-related
9963
- # `systemControls` parameters for multiple containers in a single task
9964
- # that also uses either the `awsvpc` or `host` network mode for the
9965
- # following reasons:
10051
+ # We don't recommend that you specify network-related `systemControls`
10052
+ # parameters for multiple containers in a single task. This task also
10053
+ # uses either the `awsvpc` or `host` network mode. It does it for the
10054
+ # following reasons.
9966
10055
  #
9967
10056
  # * For tasks that use the `awsvpc` network mode, if you set
9968
10057
  # `systemControls` for any container, it applies to all containers in
9969
10058
  # the task. If you set different `systemControls` for multiple
9970
- # containers in a single task, the container that is started last
10059
+ # containers in a single task, the container that's started last
9971
10060
  # determines which `systemControls` take effect.
9972
10061
  #
9973
10062
  # * For tasks that use the `host` network mode, the `systemControls`
9974
- # parameter applies to the container instance's kernel parameter as
9975
- # well as that of all containers of any tasks running on that
9976
- # container instance.
10063
+ # parameter applies to the container instance's kernel parameter and
10064
+ # that of all containers of any tasks running on that container
10065
+ # instance.
9977
10066
  #
9978
10067
  #
9979
10068
  #
@@ -9990,11 +10079,11 @@ module Aws::ECS
9990
10079
  # }
9991
10080
  #
9992
10081
  # @!attribute [rw] namespace
9993
- # The namespaced kernel parameter for which to set a `value`.
10082
+ # The namespaced kernel parameter to set a `value` for.
9994
10083
  # @return [String]
9995
10084
  #
9996
10085
  # @!attribute [rw] value
9997
- # The value for the namespaced kernel parameter specified in
10086
+ # The value for the namespaced kernel parameter that's specified in
9998
10087
  # `namespace`.
9999
10088
  # @return [String]
10000
10089
  #
@@ -10008,8 +10097,8 @@ module Aws::ECS
10008
10097
  end
10009
10098
 
10010
10099
  # The metadata that you apply to a resource to help you categorize and
10011
- # organize them. Each tag consists of a key and an optional value, both
10012
- # of which you define.
10100
+ # organize them. Each tag consists of a key and an optional value. You
10101
+ # define them.
10013
10102
  #
10014
10103
  # The following basic restrictions apply to tags:
10015
10104
  #
@@ -10078,7 +10167,7 @@ module Aws::ECS
10078
10167
  # }
10079
10168
  #
10080
10169
  # @!attribute [rw] resource_arn
10081
- # The Amazon Resource Name (ARN) of the resource to which to add tags.
10170
+ # The Amazon Resource Name (ARN) of the resource to add tags to.
10082
10171
  # Currently, the supported resources are Amazon ECS capacity
10083
10172
  # providers, tasks, services, task definitions, clusters, and
10084
10173
  # container instances.
@@ -10127,14 +10216,14 @@ module Aws::ECS
10127
10216
  #
10128
10217
  class TagResourceResponse < Aws::EmptyStructure; end
10129
10218
 
10130
- # The target container is not properly configured with the execute
10219
+ # The target container isn't properly configured with the execute
10131
10220
  # command agent or the container is no longer active or running.
10132
10221
  #
10133
10222
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotConnectedException AWS API Documentation
10134
10223
  #
10135
10224
  class TargetNotConnectedException < Aws::EmptyStructure; end
10136
10225
 
10137
- # The specified target could not be found. You can view your available
10226
+ # The specified target wasn't found. You can view your available
10138
10227
  # container instances with ListContainerInstances. Amazon ECS container
10139
10228
  # instances are cluster-specific and Region-specific.
10140
10229
  #
@@ -10145,8 +10234,8 @@ module Aws::ECS
10145
10234
  # Details on a task in a cluster.
10146
10235
  #
10147
10236
  # @!attribute [rw] attachments
10148
- # The Elastic Network Adapter associated with the task if the task
10149
- # uses the `awsvpc` network mode.
10237
+ # The Elastic Network Adapter that's associated with the task if the
10238
+ # task uses the `awsvpc` network mode.
10150
10239
  # @return [Array<Types::Attachment>]
10151
10240
  #
10152
10241
  # @!attribute [rw] attributes
@@ -10154,11 +10243,11 @@ module Aws::ECS
10154
10243
  # @return [Array<Types::Attribute>]
10155
10244
  #
10156
10245
  # @!attribute [rw] availability_zone
10157
- # The availability zone of the task.
10246
+ # The Availability Zone for the task.
10158
10247
  # @return [String]
10159
10248
  #
10160
10249
  # @!attribute [rw] capacity_provider_name
10161
- # The capacity provider associated with the task.
10250
+ # The capacity provider that's associated with the task.
10162
10251
  # @return [String]
10163
10252
  #
10164
10253
  # @!attribute [rw] cluster_arn
@@ -10170,8 +10259,8 @@ module Aws::ECS
10170
10259
  # @return [String]
10171
10260
  #
10172
10261
  # @!attribute [rw] connectivity_at
10173
- # The Unix timestamp for when the task last went into `CONNECTED`
10174
- # status.
10262
+ # The Unix timestamp for the time when the task last went into
10263
+ # `CONNECTED` status.
10175
10264
  # @return [Time]
10176
10265
  #
10177
10266
  # @!attribute [rw] container_instance_arn
@@ -10179,24 +10268,27 @@ module Aws::ECS
10179
10268
  # @return [String]
10180
10269
  #
10181
10270
  # @!attribute [rw] containers
10182
- # The containers associated with the task.
10271
+ # The containers that's associated with the task.
10183
10272
  # @return [Array<Types::Container>]
10184
10273
  #
10185
10274
  # @!attribute [rw] cpu
10186
10275
  # The number of CPU units used by the task as expressed in a task
10187
- # definition. It can be expressed as an integer using CPU units, for
10188
- # example `1024`. It can also be expressed as a string using vCPUs,
10189
- # for example `1 vCPU` or `1 vcpu`. String values are converted to an
10190
- # integer indicating the CPU units when the task definition is
10276
+ # definition. It can be expressed as an integer using CPU units (for
10277
+ # example, `1024`). It can also be expressed as a string using vCPUs
10278
+ # (for example, `1 vCPU` or `1 vcpu`). String values are converted to
10279
+ # an integer that indicates the CPU units when the task definition is
10191
10280
  # registered.
10192
10281
  #
10193
- # If you are using the EC2 launch type, this field is optional.
10194
- # Supported values are between `128` CPU units (`0.125` vCPUs) and
10195
- # `10240` CPU units (`10` vCPUs).
10282
+ # If you use the EC2 launch type, this field is optional. Supported
10283
+ # values are between `128` CPU units (`0.125` vCPUs) and `10240` CPU
10284
+ # units (`10` vCPUs).
10196
10285
  #
10197
- # If you are using the Fargate launch type, this field is required and
10198
- # you must use one of the following values, which determines your
10199
- # range of supported values for the `memory` parameter:
10286
+ # If you use the Fargate launch type, this field is required. You must
10287
+ # use one of the following values. These values determine the range of
10288
+ # supported values for the `memory` parameter:
10289
+ #
10290
+ # The CPU units cannot be less than 1 vCPU when you use Windows
10291
+ # containers on Fargate.
10200
10292
  #
10201
10293
  # * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
10202
10294
  # GB), 2048 (2 GB)
@@ -10216,8 +10308,9 @@ module Aws::ECS
10216
10308
  # @return [String]
10217
10309
  #
10218
10310
  # @!attribute [rw] created_at
10219
- # The Unix timestamp for when the task was created (the task entered
10220
- # the `PENDING` state).
10311
+ # The Unix timestamp for the time when the task was created. More
10312
+ # specifically, it's for the time when the task entered the `PENDING`
10313
+ # state.
10221
10314
  # @return [Time]
10222
10315
  #
10223
10316
  # @!attribute [rw] desired_status
@@ -10230,43 +10323,44 @@ module Aws::ECS
10230
10323
  # @return [String]
10231
10324
  #
10232
10325
  # @!attribute [rw] enable_execute_command
10233
- # Whether or not execute command functionality is enabled for this
10234
- # task. If `true`, this enables execute command functionality on all
10326
+ # Determines whether execute command functionality is enabled for this
10327
+ # task. If `true`, execute command functionality is enabled on all the
10235
10328
  # containers in the task.
10236
10329
  # @return [Boolean]
10237
10330
  #
10238
10331
  # @!attribute [rw] execution_stopped_at
10239
- # The Unix timestamp for when the task execution stopped.
10332
+ # The Unix timestamp for the time when the task execution stopped.
10240
10333
  # @return [Time]
10241
10334
  #
10242
10335
  # @!attribute [rw] group
10243
- # The name of the task group associated with the task.
10336
+ # The name of the task group that's associated with the task.
10244
10337
  # @return [String]
10245
10338
  #
10246
10339
  # @!attribute [rw] health_status
10247
- # The health status for the task, which is determined by the health of
10340
+ # The health status for the task. It's determined by the health of
10248
10341
  # the essential containers in the task. If all essential containers in
10249
- # the task are reporting as `HEALTHY`, then the task status also
10250
- # reports as `HEALTHY`. If any essential containers in the task are
10251
- # reporting as `UNHEALTHY` or `UNKNOWN`, then the task status also
10252
- # reports as `UNHEALTHY` or `UNKNOWN`, accordingly.
10253
- #
10254
- # <note markdown="1"> The Amazon ECS container agent does not monitor or report on Docker
10255
- # health checks that are embedded in a container image (such as those
10256
- # specified in a parent image or from the image's Dockerfile) and not
10257
- # specified in the container definition. Health check parameters that
10258
- # are specified in a container definition override any Docker health
10259
- # checks that exist in the container image.
10342
+ # the task are reporting as `HEALTHY`, the task status also reports as
10343
+ # `HEALTHY`. If any essential containers in the task are reporting as
10344
+ # `UNHEALTHY` or `UNKNOWN`, the task status also reports as
10345
+ # `UNHEALTHY` or `UNKNOWN`.
10346
+ #
10347
+ # <note markdown="1"> The Amazon ECS container agent doesn't monitor or report on Docker
10348
+ # health checks that are embedded in a container image and not
10349
+ # specified in the container definition. For example, this includes
10350
+ # those specified in a parent image or from the image's Dockerfile.
10351
+ # Health check parameters that are specified in a container definition
10352
+ # override any Docker health checks that are found in the container
10353
+ # image.
10260
10354
  #
10261
10355
  # </note>
10262
10356
  # @return [String]
10263
10357
  #
10264
10358
  # @!attribute [rw] inference_accelerators
10265
- # The Elastic Inference accelerator associated with the task.
10359
+ # The Elastic Inference accelerator that's associated with the task.
10266
10360
  # @return [Array<Types::InferenceAccelerator>]
10267
10361
  #
10268
10362
  # @!attribute [rw] last_status
10269
- # The last known status of the task. For more information, see [Task
10363
+ # The last known status for the task. For more information, see [Task
10270
10364
  # Lifecycle][1].
10271
10365
  #
10272
10366
  #
@@ -10275,9 +10369,9 @@ module Aws::ECS
10275
10369
  # @return [String]
10276
10370
  #
10277
10371
  # @!attribute [rw] launch_type
10278
- # The infrastructure on which your task is running. For more
10279
- # information, see [Amazon ECS launch types][1] in the *Amazon Elastic
10280
- # Container Service Developer Guide*.
10372
+ # The infrastructure where your task runs on. For more information,
10373
+ # see [Amazon ECS launch types][1] in the *Amazon Elastic Container
10374
+ # Service Developer Guide*.
10281
10375
  #
10282
10376
  #
10283
10377
  #
@@ -10285,17 +10379,17 @@ module Aws::ECS
10285
10379
  # @return [String]
10286
10380
  #
10287
10381
  # @!attribute [rw] memory
10288
- # The amount of memory (in MiB) used by the task as expressed in a
10289
- # task definition. It can be expressed as an integer using MiB, for
10290
- # example `1024`. It can also be expressed as a string using GB, for
10291
- # example `1GB` or `1 GB`. String values are converted to an integer
10292
- # indicating the MiB when the task definition is registered.
10382
+ # The amount of memory (in MiB) that the task uses as expressed in a
10383
+ # task definition. It can be expressed as an integer using MiB (for
10384
+ # example, `1024`). If it's expressed as a string using GB (for
10385
+ # example, `1GB` or `1 GB`), it's converted to an integer indicating
10386
+ # the MiB when the task definition is registered.
10293
10387
  #
10294
- # If you are using the EC2 launch type, this field is optional.
10388
+ # If you use the EC2 launch type, this field is optional.
10295
10389
  #
10296
- # If you are using the Fargate launch type, this field is required and
10297
- # you must use one of the following values, which determines your
10298
- # range of supported values for the `cpu` parameter:
10390
+ # If you use the Fargate launch type, this field is required. You must
10391
+ # use one of the following values. The value that you choose
10392
+ # determines the range of supported values for the `cpu` parameter.
10299
10393
  #
10300
10394
  # * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
10301
10395
  # 256 (.25 vCPU)
@@ -10318,11 +10412,11 @@ module Aws::ECS
10318
10412
  # @return [Types::TaskOverride]
10319
10413
  #
10320
10414
  # @!attribute [rw] platform_version
10321
- # The platform version on which your task is running. A platform
10322
- # version is only specified for tasks using the Fargate launch type.
10323
- # If one is not specified, the `LATEST` platform version is used by
10324
- # default. For more information, see [Fargate Platform Versions][1] in
10325
- # the *Amazon Elastic Container Service Developer Guide*.
10415
+ # The platform version where your task runs on. A platform version is
10416
+ # only specified for tasks that use the Fargate launch type. If you
10417
+ # didn't specify one, the `LATEST` platform version is used. For more
10418
+ # information, see [Fargate Platform Versions][1] in the *Amazon
10419
+ # Elastic Container Service Developer Guide*.
10326
10420
  #
10327
10421
  #
10328
10422
  #
@@ -10331,39 +10425,42 @@ module Aws::ECS
10331
10425
  #
10332
10426
  # @!attribute [rw] platform_family
10333
10427
  # The operating system that your tasks are running on. A platform
10334
- # family is specified only for tasks using the Fargate launch type.
10428
+ # family is specified only for tasks that use the Fargate launch type.
10335
10429
  #
10336
10430
  # All tasks that run as part of this service must use the same
10337
- # `platformFamily` value as the service, for example, `LINUX.`.
10431
+ # `platformFamily` value as the service (for example, `LINUX.`).
10338
10432
  # @return [String]
10339
10433
  #
10340
10434
  # @!attribute [rw] pull_started_at
10341
- # The Unix timestamp for when the container image pull began.
10435
+ # The Unix timestamp for the time when the container image pull began.
10342
10436
  # @return [Time]
10343
10437
  #
10344
10438
  # @!attribute [rw] pull_stopped_at
10345
- # The Unix timestamp for when the container image pull completed.
10439
+ # The Unix timestamp for the time when the container image pull
10440
+ # completed.
10346
10441
  # @return [Time]
10347
10442
  #
10348
10443
  # @!attribute [rw] started_at
10349
- # The Unix timestamp for when the task started (the task transitioned
10350
- # from the `PENDING` state to the `RUNNING` state).
10444
+ # The Unix timestamp for the time when the task started. More
10445
+ # specifically, it's for the time when the task transitioned from the
10446
+ # `PENDING` state to the `RUNNING` state.
10351
10447
  # @return [Time]
10352
10448
  #
10353
10449
  # @!attribute [rw] started_by
10354
- # The tag specified when a task is started. If the task is started by
10355
- # an Amazon ECS service, then the `startedBy` parameter contains the
10356
- # deployment ID of the service that starts it.
10450
+ # The tag specified when a task is started. If an Amazon ECS service
10451
+ # started the task, the `startedBy` parameter contains the deployment
10452
+ # ID of that service.
10357
10453
  # @return [String]
10358
10454
  #
10359
10455
  # @!attribute [rw] stop_code
10360
10456
  # The stop code indicating why a task was stopped. The `stoppedReason`
10361
- # may contain additional details.
10457
+ # might contain additional details.
10362
10458
  # @return [String]
10363
10459
  #
10364
10460
  # @!attribute [rw] stopped_at
10365
- # The Unix timestamp for when the task was stopped (the task
10366
- # transitioned from the `RUNNING` state to the `STOPPED` state).
10461
+ # The Unix timestamp for the time when the task was stopped. More
10462
+ # specifically, it's for the time when the task transitioned from the
10463
+ # `RUNNING` state to the `STOPPED` state.
10367
10464
  # @return [Time]
10368
10465
  #
10369
10466
  # @!attribute [rw] stopped_reason
@@ -10371,14 +10468,15 @@ module Aws::ECS
10371
10468
  # @return [String]
10372
10469
  #
10373
10470
  # @!attribute [rw] stopping_at
10374
- # The Unix timestamp for when the task stops (transitions from the
10375
- # `RUNNING` state to `STOPPED`).
10471
+ # The Unix timestamp for the time when the task stops. More
10472
+ # specifically, it's for the time when the task transitions from the
10473
+ # `RUNNING` state to `STOPPED`.
10376
10474
  # @return [Time]
10377
10475
  #
10378
10476
  # @!attribute [rw] tags
10379
10477
  # The metadata that you apply to the task to help you categorize and
10380
- # organize them. Each tag consists of a key and an optional value,
10381
- # both of which you define.
10478
+ # organize the task. Each tag consists of a key and an optional value.
10479
+ # You define both the key and value.
10382
10480
  #
10383
10481
  # The following basic restrictions apply to tags:
10384
10482
  #
@@ -10416,8 +10514,8 @@ module Aws::ECS
10416
10514
  #
10417
10515
  # @!attribute [rw] version
10418
10516
  # The version counter for the task. Every time a task experiences a
10419
- # change that triggers a CloudWatch event, the version counter is
10420
- # incremented. If you are replicating your Amazon ECS task state with
10517
+ # change that starts a CloudWatch event, the version counter is
10518
+ # incremented. If you replicate your Amazon ECS task state with
10421
10519
  # CloudWatch Events, you can compare the version of a task reported by
10422
10520
  # the Amazon ECS API actions with the version reported in CloudWatch
10423
10521
  # Events for the task (inside the `detail` object) to verify that the
@@ -10495,8 +10593,8 @@ module Aws::ECS
10495
10593
  #
10496
10594
  # @!attribute [rw] family
10497
10595
  # The name of a family that this task definition is registered to. Up
10498
- # to 255 letters (uppercase and lowercase), numbers, hyphens, and
10499
- # underscores are allowed.
10596
+ # to 255 characters are allowed. Letters (both uppercase and lowercase
10597
+ # letters), numbers, hyphens (-), and underscores (\_) are allowed.
10500
10598
  #
10501
10599
  # A family groups multiple versions of a task definition. Amazon ECS
10502
10600
  # gives the first task definition that you registered to a family a
@@ -10513,10 +10611,9 @@ module Aws::ECS
10513
10611
  #
10514
10612
  # IAM roles for tasks on Windows require that the `-EnableTaskIAMRole`
10515
10613
  # option is set when you launch the Amazon ECS-optimized Windows AMI.
10516
- # Your containers must also run some configuration code in order to
10517
- # take advantage of the feature. For more information, see [Windows
10518
- # IAM roles for tasks][2] in the *Amazon Elastic Container Service
10519
- # Developer Guide*.
10614
+ # Your containers must also run some configuration code to use the
10615
+ # feature. For more information, see [Windows IAM roles for tasks][2]
10616
+ # in the *Amazon Elastic Container Service Developer Guide*.
10520
10617
  #
10521
10618
  #
10522
10619
  #
@@ -10587,8 +10684,8 @@ module Aws::ECS
10587
10684
  # version number of a task definition in a family. When you register a
10588
10685
  # task definition for the first time, the revision is `1`. Each time
10589
10686
  # that you register a new revision of a task definition in the same
10590
- # family, the revision value always increases by one, even if you have
10591
- # deregistered previous revisions in this family.
10687
+ # family, the revision value always increases by one. This is even if
10688
+ # you deregistered previous revisions in this family.
10592
10689
  # @return [Integer]
10593
10690
  #
10594
10691
  # @!attribute [rw] volumes
@@ -10596,7 +10693,7 @@ module Aws::ECS
10596
10693
  # information, see [Using data volumes in tasks][1] in the *Amazon
10597
10694
  # Elastic Container Service Developer Guide*.
10598
10695
  #
10599
- # <note markdown="1"> The `host` and `sourcePath` parameters are not supported for tasks
10696
+ # <note markdown="1"> The `host` and `sourcePath` parameters aren't supported for tasks
10600
10697
  # run on Fargate.
10601
10698
  #
10602
10699
  # </note>
@@ -10614,13 +10711,13 @@ module Aws::ECS
10614
10711
  # The container instance attributes required by your task. When an
10615
10712
  # Amazon EC2 instance is registered to your cluster, the Amazon ECS
10616
10713
  # container agent assigns some standard attributes to the instance.
10617
- # You can apply custom attributes, specified as key-value pairs using
10618
- # the Amazon ECS console or the PutAttributes API. These attributes
10619
- # are used when considering task placement for tasks hosted on Amazon
10620
- # EC2 instances. For more information, see [Attributes][1] in the
10621
- # *Amazon Elastic Container Service Developer Guide*.
10714
+ # You can apply custom attributes. These are specified as key-value
10715
+ # pairs using the Amazon ECS console or the PutAttributes API. These
10716
+ # attributes are used when determining task placement for tasks hosted
10717
+ # on Amazon EC2 instances. For more information, see [Attributes][1]
10718
+ # in the *Amazon Elastic Container Service Developer Guide*.
10622
10719
  #
10623
- # <note markdown="1"> This parameter is not supported for tasks run on Fargate.
10720
+ # <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
10624
10721
  #
10625
10722
  # </note>
10626
10723
  #
@@ -10632,7 +10729,7 @@ module Aws::ECS
10632
10729
  # @!attribute [rw] placement_constraints
10633
10730
  # An array of placement constraint objects to use for tasks.
10634
10731
  #
10635
- # <note markdown="1"> This parameter is not supported for tasks run on Fargate.
10732
+ # <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
10636
10733
  #
10637
10734
  # </note>
10638
10735
  # @return [Array<Types::TaskDefinitionPlacementConstraint>]
@@ -10664,11 +10761,14 @@ module Aws::ECS
10664
10761
  # @return [Array<String>]
10665
10762
  #
10666
10763
  # @!attribute [rw] cpu
10667
- # The number of `cpu` units used by the task. If you are using the EC2
10668
- # launch type, this field is optional and any value can be used. If
10669
- # you are using the Fargate launch type, this field is required and
10670
- # you must use one of the following values, which determines your
10671
- # range of valid values for the `memory` parameter:
10764
+ # The number of `cpu` units used by the task. If you use the EC2
10765
+ # launch type, this field is optional. Any value can be used. If you
10766
+ # use the Fargate launch type, this field is required. You must use
10767
+ # one of the following values. The value that you choose determines
10768
+ # your range of valid values for the `memory` parameter.
10769
+ #
10770
+ # The CPU units cannot be less than 1 vCPU when you use Windows
10771
+ # containers on Fargate.
10672
10772
  #
10673
10773
  # * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
10674
10774
  # GB), 2048 (2 GB)
@@ -10690,16 +10790,16 @@ module Aws::ECS
10690
10790
  # @!attribute [rw] memory
10691
10791
  # The amount (in MiB) of memory used by the task.
10692
10792
  #
10693
- # If your tasks will be run on Amazon EC2 instances, you must specify
10694
- # either a task-level memory value or a container-level memory value.
10695
- # This field is optional and any value can be used. If a task-level
10696
- # memory value is specified then the container-level memory value is
10697
- # optional. For more information regarding container-level memory and
10698
- # memory reservation, see [ContainerDefinition][1].
10793
+ # If your tasks runs on Amazon EC2 instances, you must specify either
10794
+ # a task-level memory value or a container-level memory value. This
10795
+ # field is optional and any value can be used. If a task-level memory
10796
+ # value is specified, the container-level memory value is optional.
10797
+ # For more information regarding container-level memory and memory
10798
+ # reservation, see [ContainerDefinition][1].
10699
10799
  #
10700
- # If your tasks will be run on Fargate, this field is required and you
10701
- # must use one of the following values, which determines your range of
10702
- # valid values for the `cpu` parameter:
10800
+ # If your tasks runs on Fargate, this field is required. You must use
10801
+ # one of the following values. The value you choose determines your
10802
+ # range of valid values for the `cpu` parameter.
10703
10803
  #
10704
10804
  # * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
10705
10805
  # 256 (.25 vCPU)
@@ -10722,7 +10822,7 @@ module Aws::ECS
10722
10822
  # @return [String]
10723
10823
  #
10724
10824
  # @!attribute [rw] inference_accelerators
10725
- # The Elastic Inference accelerator associated with the task.
10825
+ # The Elastic Inference accelerator that's associated with the task.
10726
10826
  # @return [Array<Types::InferenceAccelerator>]
10727
10827
  #
10728
10828
  # @!attribute [rw] pid_mode
@@ -10798,9 +10898,9 @@ module Aws::ECS
10798
10898
  # Your Amazon ECS container instances require at least version 1.26.0
10799
10899
  # of the container agent and at least version 1.26.0-1 of the
10800
10900
  # `ecs-init` package to enable a proxy configuration. If your
10801
- # container instances are launched from the Amazon ECS-optimized AMI
10802
- # version `20190301` or later, then they contain the required versions
10803
- # of the container agent and `ecs-init`. For more information, see
10901
+ # container instances are launched from the Amazon ECS optimized AMI
10902
+ # version `20190301` or later, they contain the required versions of
10903
+ # the container agent and `ecs-init`. For more information, see
10804
10904
  # [Amazon ECS-optimized Linux AMI][1] in the *Amazon Elastic Container
10805
10905
  # Service Developer Guide*.
10806
10906
  #
@@ -10810,11 +10910,13 @@ module Aws::ECS
10810
10910
  # @return [Types::ProxyConfiguration]
10811
10911
  #
10812
10912
  # @!attribute [rw] registered_at
10813
- # The Unix timestamp for when the task definition was registered.
10913
+ # The Unix timestamp for the time when the task definition was
10914
+ # registered.
10814
10915
  # @return [Time]
10815
10916
  #
10816
10917
  # @!attribute [rw] deregistered_at
10817
- # The Unix timestamp for when the task definition was deregistered.
10918
+ # The Unix timestamp for the time when the task definition was
10919
+ # deregistered.
10818
10920
  # @return [Time]
10819
10921
  #
10820
10922
  # @!attribute [rw] registered_by
@@ -10861,7 +10963,7 @@ module Aws::ECS
10861
10963
  # definition. For more information, see [Task placement constraints][1]
10862
10964
  # in the *Amazon Elastic Container Service Developer Guide*.
10863
10965
  #
10864
- # <note markdown="1"> Task placement constraints are not supported for tasks run on Fargate.
10966
+ # <note markdown="1"> Task placement constraints aren't supported for tasks run on Fargate.
10865
10967
  #
10866
10968
  # </note>
10867
10969
  #
@@ -10901,7 +11003,7 @@ module Aws::ECS
10901
11003
  include Aws::Structure
10902
11004
  end
10903
11005
 
10904
- # The overrides associated with a task.
11006
+ # The overrides that are associated with a task.
10905
11007
  #
10906
11008
  # @note When making an API call, you may pass TaskOverride
10907
11009
  # data as a hash:
@@ -10950,7 +11052,7 @@ module Aws::ECS
10950
11052
  # }
10951
11053
  #
10952
11054
  # @!attribute [rw] container_overrides
10953
- # One or more container overrides sent to a task.
11055
+ # One or more container overrides that are sent to a task.
10954
11056
  # @return [Array<Types::ContainerOverride>]
10955
11057
  #
10956
11058
  # @!attribute [rw] cpu
@@ -10991,8 +11093,8 @@ module Aws::ECS
10991
11093
  # @!attribute [rw] ephemeral_storage
10992
11094
  # The ephemeral storage setting override for the task.
10993
11095
  #
10994
- # <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
10995
- # the following platform versions:
11096
+ # <note markdown="1"> This parameter is only supported for tasks hosted on Fargate that
11097
+ # use the following platform versions:
10996
11098
  #
10997
11099
  # * Linux platform version `1.4.0` or later.
10998
11100
  #
@@ -11039,17 +11141,17 @@ module Aws::ECS
11039
11141
  # @return [String]
11040
11142
  #
11041
11143
  # @!attribute [rw] started_by
11042
- # The tag specified when a task set is started. If the task set is
11043
- # created by an CodeDeploy deployment, the `startedBy` parameter is
11044
- # `CODE_DEPLOY`. For a task set created for an external deployment,
11045
- # the startedBy field isn't used.
11144
+ # The tag specified when a task set is started. If an CodeDeploy
11145
+ # deployment created the task set, the `startedBy` parameter is
11146
+ # `CODE_DEPLOY`. If an external deployment created the task set, the
11147
+ # startedBy field isn't used.
11046
11148
  # @return [String]
11047
11149
  #
11048
11150
  # @!attribute [rw] external_id
11049
11151
  # The external ID associated with the task set.
11050
11152
  #
11051
- # If a task set is created by an CodeDeploy deployment, the
11052
- # `externalId` parameter contains the CodeDeploy deployment ID.
11153
+ # If an CodeDeploy deployment created a task set, the `externalId`
11154
+ # parameter contains the CodeDeploy deployment ID.
11053
11155
  #
11054
11156
  # If a task set is created for an external deployment and is
11055
11157
  # associated with a service discovery registry, the `externalId`
@@ -11058,7 +11160,7 @@ module Aws::ECS
11058
11160
  # @return [String]
11059
11161
  #
11060
11162
  # @!attribute [rw] status
11061
- # The status of the task set. The following describes each state:
11163
+ # The status of the task set. The following describes each state.
11062
11164
  #
11063
11165
  # PRIMARY
11064
11166
  #
@@ -11066,17 +11168,17 @@ module Aws::ECS
11066
11168
  #
11067
11169
  # ACTIVE
11068
11170
  #
11069
- # : The task set is not serving production traffic.
11171
+ # : The task set isn't serving production traffic.
11070
11172
  #
11071
11173
  # DRAINING
11072
11174
  #
11073
- # : The tasks in the task set are being stopped and their
11175
+ # : The tasks in the task set are being stopped, and their
11074
11176
  # corresponding targets are being deregistered from their target
11075
11177
  # group.
11076
11178
  # @return [String]
11077
11179
  #
11078
11180
  # @!attribute [rw] task_definition
11079
- # The task definition the task set is using.
11181
+ # The task definition that the task set is using.
11080
11182
  # @return [String]
11081
11183
  #
11082
11184
  # @!attribute [rw] computed_desired_count
@@ -11090,7 +11192,7 @@ module Aws::ECS
11090
11192
  # The number of tasks in the task set that are in the `PENDING` status
11091
11193
  # during a deployment. A task in the `PENDING` state is preparing to
11092
11194
  # enter the `RUNNING` state. A task set enters the `PENDING` status
11093
- # when it launches for the first time or when it is restarted after
11195
+ # when it launches for the first time or when it's restarted after
11094
11196
  # being in the `STOPPED` state.
11095
11197
  # @return [Integer]
11096
11198
  #
@@ -11101,11 +11203,11 @@ module Aws::ECS
11101
11203
  # @return [Integer]
11102
11204
  #
11103
11205
  # @!attribute [rw] created_at
11104
- # The Unix timestamp for when the task set was created.
11206
+ # The Unix timestamp for the time when the task set was created.
11105
11207
  # @return [Time]
11106
11208
  #
11107
11209
  # @!attribute [rw] updated_at
11108
- # The Unix timestamp for when the task set was last updated.
11210
+ # The Unix timestamp for the time when the task set was last updated.
11109
11211
  # @return [Time]
11110
11212
  #
11111
11213
  # @!attribute [rw] launch_type
@@ -11119,11 +11221,12 @@ module Aws::ECS
11119
11221
  # @return [String]
11120
11222
  #
11121
11223
  # @!attribute [rw] capacity_provider_strategy
11122
- # The capacity provider strategy associated with the task set.
11224
+ # The capacity provider strategy that are associated with the task
11225
+ # set.
11123
11226
  # @return [Array<Types::CapacityProviderStrategyItem>]
11124
11227
  #
11125
11228
  # @!attribute [rw] platform_version
11126
- # The Fargate platform version on which the tasks in the task set are
11229
+ # The Fargate platform version where the tasks in the task set are
11127
11230
  # running. A platform version is only specified for tasks run on
11128
11231
  # Fargate. For more information, see [Fargate platform versions][1] in
11129
11232
  # the *Amazon Elastic Container Service Developer Guide*.
@@ -11135,8 +11238,8 @@ module Aws::ECS
11135
11238
  #
11136
11239
  # @!attribute [rw] platform_family
11137
11240
  # The operating system that your tasks in the set are running on. A
11138
- # platform family is specified only for tasks using the Fargate launch
11139
- # type.
11241
+ # platform family is specified only for tasks that use the Fargate
11242
+ # launch type.
11140
11243
  #
11141
11244
  # All tasks in the set must have the same value.
11142
11245
  # @return [String]
@@ -11146,11 +11249,11 @@ module Aws::ECS
11146
11249
  # @return [Types::NetworkConfiguration]
11147
11250
  #
11148
11251
  # @!attribute [rw] load_balancers
11149
- # Details on a load balancer that is used with a task set.
11252
+ # Details on a load balancer that are used with a task set.
11150
11253
  # @return [Array<Types::LoadBalancer>]
11151
11254
  #
11152
11255
  # @!attribute [rw] service_registries
11153
- # The details of the service discovery registries to assign to this
11256
+ # The details for the service discovery registries to assign to this
11154
11257
  # task set. For more information, see [Service discovery][1].
11155
11258
  #
11156
11259
  #
@@ -11159,38 +11262,38 @@ module Aws::ECS
11159
11262
  # @return [Array<Types::ServiceRegistry>]
11160
11263
  #
11161
11264
  # @!attribute [rw] scale
11162
- # A floating-point percentage of the desired number of tasks to place
11265
+ # A floating-point percentage of your desired number of tasks to place
11163
11266
  # and keep running in the task set.
11164
11267
  # @return [Types::Scale]
11165
11268
  #
11166
11269
  # @!attribute [rw] stability_status
11167
- # The stability status, which indicates whether the task set has
11270
+ # The stability status. This indicates whether the task set has
11168
11271
  # reached a steady state. If the following conditions are met, the
11169
- # task set will be in `STEADY_STATE`\:
11272
+ # task set sre in `STEADY_STATE`\:
11170
11273
  #
11171
11274
  # * The task `runningCount` is equal to the `computedDesiredCount`.
11172
11275
  #
11173
11276
  # * The `pendingCount` is `0`.
11174
11277
  #
11175
- # * There are no tasks running on container instances in the
11278
+ # * There are no tasks that are running on container instances in the
11176
11279
  # `DRAINING` status.
11177
11280
  #
11178
11281
  # * All tasks are reporting a healthy status from the load balancers,
11179
11282
  # service discovery, and container health checks.
11180
11283
  #
11181
- # If any of those conditions are not met, the stability status returns
11284
+ # If any of those conditions aren't met, the stability status returns
11182
11285
  # `STABILIZING`.
11183
11286
  # @return [String]
11184
11287
  #
11185
11288
  # @!attribute [rw] stability_status_at
11186
- # The Unix timestamp for when the task set stability status was
11187
- # retrieved.
11289
+ # The Unix timestamp for the time when the task set stability status
11290
+ # was retrieved.
11188
11291
  # @return [Time]
11189
11292
  #
11190
11293
  # @!attribute [rw] tags
11191
11294
  # The metadata that you apply to the task set to help you categorize
11192
- # and organize them. Each tag consists of a key and an optional value,
11193
- # both of which you define.
11295
+ # and organize them. Each tag consists of a key and an optional value.
11296
+ # You define both.
11194
11297
  #
11195
11298
  # The following basic restrictions apply to tags:
11196
11299
  #
@@ -11249,9 +11352,9 @@ module Aws::ECS
11249
11352
  include Aws::Structure
11250
11353
  end
11251
11354
 
11252
- # The specified task set could not be found. You can view your available
11253
- # task sets with DescribeTaskSets. Task sets are specific to each
11254
- # cluster, service and Region.
11355
+ # The specified task set wasn't found. You can view your available task
11356
+ # sets with DescribeTaskSets. Task sets are specific to each cluster,
11357
+ # service and Region.
11255
11358
  #
11256
11359
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSetNotFoundException AWS API Documentation
11257
11360
  #
@@ -11338,7 +11441,7 @@ module Aws::ECS
11338
11441
  include Aws::Structure
11339
11442
  end
11340
11443
 
11341
- # The specified task is not supported in this Region.
11444
+ # The specified task isn't supported in this Region.
11342
11445
  #
11343
11446
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UnsupportedFeatureException AWS API Documentation
11344
11447
  #
@@ -11353,8 +11456,8 @@ module Aws::ECS
11353
11456
  # }
11354
11457
  #
11355
11458
  # @!attribute [rw] resource_arn
11356
- # The Amazon Resource Name (ARN) of the resource from which to delete
11357
- # tags. Currently, the supported resources are Amazon ECS capacity
11459
+ # The Amazon Resource Name (ARN) of the resource to delete tags from.
11460
+ # Currently, the supported resources are Amazon ECS capacity
11358
11461
  # providers, tasks, services, task definitions, clusters, and
11359
11462
  # container instances.
11360
11463
  # @return [String]
@@ -11398,8 +11501,8 @@ module Aws::ECS
11398
11501
  # @return [String]
11399
11502
  #
11400
11503
  # @!attribute [rw] auto_scaling_group_provider
11401
- # An object representing the parameters to update for the Auto Scaling
11402
- # group capacity provider.
11504
+ # An object that represent the parameters to update for the Auto
11505
+ # Scaling group capacity provider.
11403
11506
  # @return [Types::AutoScalingGroupProviderUpdate]
11404
11507
  #
11405
11508
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCapacityProviderRequest AWS API Documentation
@@ -11503,8 +11606,8 @@ module Aws::ECS
11503
11606
  # @!attribute [rw] settings
11504
11607
  # The setting to use by default for a cluster. This parameter is used
11505
11608
  # to enable CloudWatch Container Insights for a cluster. If this value
11506
- # is specified, it will override the `containerInsights` value set
11507
- # with PutAccountSetting or PutAccountSettingDefault.
11609
+ # is specified, it overrides the `containerInsights` value set with
11610
+ # PutAccountSetting or PutAccountSettingDefault.
11508
11611
  # @return [Array<Types::ClusterSetting>]
11509
11612
  #
11510
11613
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
@@ -11544,7 +11647,7 @@ module Aws::ECS
11544
11647
  #
11545
11648
  # @!attribute [rw] container_instance
11546
11649
  # The container instance ID or full ARN entries for the container
11547
- # instance on which you would like to update the Amazon ECS container
11650
+ # instance where you would like to update the Amazon ECS container
11548
11651
  # agent.
11549
11652
  # @return [String]
11550
11653
  #
@@ -11558,7 +11661,7 @@ module Aws::ECS
11558
11661
  end
11559
11662
 
11560
11663
  # @!attribute [rw] container_instance
11561
- # The container instance for which the container agent was updated.
11664
+ # The container instance that the container agent was updated for.
11562
11665
  # @return [Types::ContainerInstance]
11563
11666
  #
11564
11667
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgentResponse AWS API Documentation
@@ -11589,13 +11692,13 @@ module Aws::ECS
11589
11692
  # @return [Array<String>]
11590
11693
  #
11591
11694
  # @!attribute [rw] status
11592
- # The container instance state with which to update the container
11593
- # instance. The only valid values for this action are `ACTIVE` and
11594
- # `DRAINING`. A container instance can only be updated to `DRAINING`
11595
- # status once it has reached an `ACTIVE` state. If a container
11596
- # instance is in `REGISTERING`, `DEREGISTERING`, or
11597
- # `REGISTRATION_FAILED` state you can describe the container instance
11598
- # but will be unable to update the container instance state.
11695
+ # The container instance state to update the container instance with.
11696
+ # The only valid values for this action are `ACTIVE` and `DRAINING`. A
11697
+ # container instance can only be updated to `DRAINING` status once it
11698
+ # has reached an `ACTIVE` state. If a container instance is in
11699
+ # `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you
11700
+ # can describe the container instance but can't update the container
11701
+ # instance state.
11599
11702
  # @return [String]
11600
11703
  #
11601
11704
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateRequest AWS API Documentation
@@ -11625,10 +11728,10 @@ module Aws::ECS
11625
11728
  include Aws::Structure
11626
11729
  end
11627
11730
 
11628
- # There is already a current Amazon ECS container agent update in
11629
- # progress on the specified container instance. If the container agent
11630
- # becomes disconnected while it is in a transitional stage, such as
11631
- # `PENDING` or `STAGING`, the update process can get stuck in that
11731
+ # There's already a current Amazon ECS container agent update in
11732
+ # progress on the container instance that's specified. If the container
11733
+ # agent becomes disconnected while it's in a transitional stage, such
11734
+ # as `PENDING` or `STAGING`, the update process can get stuck in that
11632
11735
  # state. However, when the agent reconnects, it resumes where it stopped
11633
11736
  # previously.
11634
11737
  #
@@ -11732,8 +11835,8 @@ module Aws::ECS
11732
11835
  #
11733
11836
  # @!attribute [rw] cluster
11734
11837
  # The short name or full Amazon Resource Name (ARN) of the cluster
11735
- # that your service is running on. If you do not specify a cluster,
11736
- # the default cluster is assumed.
11838
+ # that your service runs on. If you do not specify a cluster, the
11839
+ # default cluster is assumed.
11737
11840
  # @return [String]
11738
11841
  #
11739
11842
  # @!attribute [rw] service
@@ -11757,12 +11860,13 @@ module Aws::ECS
11757
11860
  # @!attribute [rw] capacity_provider_strategy
11758
11861
  # The capacity provider strategy to update the service to use.
11759
11862
  #
11760
- # If the service is using the default capacity provider strategy for
11761
- # the cluster, the service can be updated to use one or more capacity
11863
+ # if the service uses the default capacity provider strategy for the
11864
+ # cluster, the service can be updated to use one or more capacity
11762
11865
  # providers as opposed to the default capacity provider strategy.
11763
- # However, when a service is using a capacity provider strategy that
11764
- # is not the default capacity provider strategy, the service cannot be
11765
- # updated to use the cluster's default capacity provider strategy.
11866
+ # However, when a service is using a capacity provider strategy
11867
+ # that's not the default capacity provider strategy, the service
11868
+ # can't be updated to use the cluster's default capacity provider
11869
+ # strategy.
11766
11870
  #
11767
11871
  # A capacity provider strategy consists of one or more capacity
11768
11872
  # providers along with the `base` and `weight` to assign to them. A
@@ -11804,9 +11908,9 @@ module Aws::ECS
11804
11908
  # service. To remove all existing placement constraints, specify an
11805
11909
  # empty array.
11806
11910
  #
11807
- # You can specify a maximum of 10 constraints per task (this limit
11808
- # includes constraints in the task definition and those specified at
11809
- # runtime).
11911
+ # You can specify a maximum of 10 constraints for each task. This
11912
+ # limit includes constraints in the task definition and those
11913
+ # specified at runtime.
11810
11914
  # @return [Array<Types::PlacementConstraint>]
11811
11915
  #
11812
11916
  # @!attribute [rw] placement_strategy
@@ -11816,16 +11920,16 @@ module Aws::ECS
11816
11920
  # override the existing placement strategy defined for the service. To
11817
11921
  # remove an existing placement strategy, specify an empty object.
11818
11922
  #
11819
- # You can specify a maximum of five strategy rules per service.
11923
+ # You can specify a maximum of five strategy rules for each service.
11820
11924
  # @return [Array<Types::PlacementStrategy>]
11821
11925
  #
11822
11926
  # @!attribute [rw] platform_version
11823
- # The platform version on which your tasks in the service are running.
11824
- # A platform version is only specified for tasks using the Fargate
11927
+ # The platform version that your tasks in the service run on. A
11928
+ # platform version is only specified for tasks using the Fargate
11825
11929
  # launch type. If a platform version is not specified, the `LATEST`
11826
- # platform version is used by default. For more information, see
11827
- # [Fargate Platform Versions][1] in the *Amazon Elastic Container
11828
- # Service Developer Guide*.
11930
+ # platform version is used. For more information, see [Fargate
11931
+ # Platform Versions][1] in the *Amazon Elastic Container Service
11932
+ # Developer Guide*.
11829
11933
  #
11830
11934
  #
11831
11935
  #
@@ -11833,26 +11937,26 @@ module Aws::ECS
11833
11937
  # @return [String]
11834
11938
  #
11835
11939
  # @!attribute [rw] force_new_deployment
11836
- # Whether to force a new deployment of the service. Deployments are
11837
- # not forced by default. You can use this option to trigger a new
11838
- # deployment with no service definition changes. For example, you can
11839
- # update a service's tasks to use a newer Docker image with the same
11840
- # image/tag combination (`my_image:latest`) or to roll Fargate tasks
11841
- # onto a newer platform version.
11940
+ # Determines whether to force a new deployment of the service. By
11941
+ # default, deployments aren't forced. You can use this option to
11942
+ # start a new deployment with no service definition changes. For
11943
+ # example, you can update a service's tasks to use a newer Docker
11944
+ # image with the same image/tag combination (`my_image:latest`) or to
11945
+ # roll Fargate tasks onto a newer platform version.
11842
11946
  # @return [Boolean]
11843
11947
  #
11844
11948
  # @!attribute [rw] health_check_grace_period_seconds
11845
11949
  # The period of time, in seconds, that the Amazon ECS service
11846
- # scheduler should ignore unhealthy Elastic Load Balancing target
11847
- # health checks after a task has first started. This is only valid if
11848
- # your service is configured to use a load balancer. If your
11849
- # service's tasks take a while to start and respond to Elastic Load
11850
- # Balancing health checks, you can specify a health check grace period
11851
- # of up to 2,147,483,647 seconds. During that time, the Amazon ECS
11852
- # service scheduler ignores the Elastic Load Balancing health check
11853
- # status. This grace period can prevent the ECS service scheduler from
11854
- # marking tasks as unhealthy and stopping them before they have time
11855
- # to come up.
11950
+ # scheduler ignores unhealthy Elastic Load Balancing target health
11951
+ # checks after a task has first started. This is only valid if your
11952
+ # service is configured to use a load balancer. If your service's
11953
+ # tasks take a while to start and respond to Elastic Load Balancing
11954
+ # health checks, you can specify a health check grace period of up to
11955
+ # 2,147,483,647 seconds. During that time, the Amazon ECS service
11956
+ # scheduler ignores the Elastic Load Balancing health check status.
11957
+ # This grace period can prevent the ECS service scheduler from marking
11958
+ # tasks as unhealthy and stopping them before they have time to come
11959
+ # up.
11856
11960
  # @return [Integer]
11857
11961
  #
11858
11962
  # @!attribute [rw] enable_execute_command
@@ -11911,12 +12015,12 @@ module Aws::ECS
11911
12015
  #
11912
12016
  # @!attribute [rw] cluster
11913
12017
  # The short name or full Amazon Resource Name (ARN) of the cluster
11914
- # that hosts the service that the task set exists in.
12018
+ # that hosts the service that the task set is found in.
11915
12019
  # @return [String]
11916
12020
  #
11917
12021
  # @!attribute [rw] service
11918
12022
  # The short name or full Amazon Resource Name (ARN) of the service
11919
- # that the task set exists in.
12023
+ # that the task set is found in.
11920
12024
  # @return [String]
11921
12025
  #
11922
12026
  # @!attribute [rw] task_set
@@ -11978,7 +12082,7 @@ module Aws::ECS
11978
12082
  # @return [String]
11979
12083
  #
11980
12084
  # @!attribute [rw] docker_version
11981
- # The Docker version running on the container instance.
12085
+ # The Docker version that's running on the container instance.
11982
12086
  # @return [String]
11983
12087
  #
11984
12088
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VersionInfo AWS API Documentation
@@ -11991,14 +12095,14 @@ module Aws::ECS
11991
12095
  include Aws::Structure
11992
12096
  end
11993
12097
 
11994
- # A data volume used in a task definition. For tasks that use the Amazon
11995
- # Elastic File System (Amazon EFS), specify an `efsVolumeConfiguration`.
11996
- # For Windows tasks that use Amazon FSx for Windows File Server file
11997
- # system, specify a `fsxWindowsFileServerVolumeConfiguration`. For tasks
11998
- # that use a Docker volume, specify a `DockerVolumeConfiguration`. For
11999
- # tasks that use a bind mount host volume, specify a `host` and optional
12000
- # `sourcePath`. For more information, see [Using Data Volumes in
12001
- # Tasks][1].
12098
+ # A data volume that's used in a task definition. For tasks that use
12099
+ # the Amazon Elastic File System (Amazon EFS), specify an
12100
+ # `efsVolumeConfiguration`. For Windows tasks that use Amazon FSx for
12101
+ # Windows File Server file system, specify a
12102
+ # `fsxWindowsFileServerVolumeConfiguration`. For tasks that use a Docker
12103
+ # volume, specify a `DockerVolumeConfiguration`. For tasks that use a
12104
+ # bind mount host volume, specify a `host` and optional `sourcePath`.
12105
+ # For more information, see [Using Data Volumes in Tasks][1].
12002
12106
  #
12003
12107
  #
12004
12108
  #
@@ -12051,40 +12155,40 @@ module Aws::ECS
12051
12155
  # @return [String]
12052
12156
  #
12053
12157
  # @!attribute [rw] host
12054
- # This parameter is specified when you are using bind mount host
12055
- # volumes. The contents of the `host` parameter determine whether your
12056
- # bind mount host volume persists on the host container instance and
12057
- # where it is stored. If the `host` parameter is empty, then the
12058
- # Docker daemon assigns a host path for your data volume. However, the
12059
- # data is not guaranteed to persist after the containers associated
12060
- # with it stop running.
12158
+ # This parameter is specified when you use bind mount host volumes.
12159
+ # The contents of the `host` parameter determine whether your bind
12160
+ # mount host volume persists on the host container instance and where
12161
+ # it's stored. If the `host` parameter is empty, then the Docker
12162
+ # daemon assigns a host path for your data volume. However, the data
12163
+ # isn't guaranteed to persist after the containers that are
12164
+ # associated with it stop running.
12061
12165
  #
12062
12166
  # Windows containers can mount whole directories on the same drive as
12063
- # `$env:ProgramData`. Windows containers cannot mount directories on a
12064
- # different drive, and mount point cannot be across drives. For
12167
+ # `$env:ProgramData`. Windows containers can't mount directories on a
12168
+ # different drive, and mount point can't be across drives. For
12065
12169
  # example, you can mount `C:\my\path:C:\my\path` and `D:\:D:`, but
12066
12170
  # not `D:\my\path:C:\my\path` or `D:\:C:\my\path`.
12067
12171
  # @return [Types::HostVolumeProperties]
12068
12172
  #
12069
12173
  # @!attribute [rw] docker_volume_configuration
12070
- # This parameter is specified when you are using Docker volumes.
12174
+ # This parameter is specified when you use Docker volumes.
12071
12175
  #
12072
12176
  # Windows containers only support the use of the `local` driver. To
12073
12177
  # use bind mounts, specify the `host` parameter instead.
12074
12178
  #
12075
- # <note markdown="1"> Docker volumes are not supported by tasks run on Fargate.
12179
+ # <note markdown="1"> Docker volumes aren't supported by tasks run on Fargate.
12076
12180
  #
12077
12181
  # </note>
12078
12182
  # @return [Types::DockerVolumeConfiguration]
12079
12183
  #
12080
12184
  # @!attribute [rw] efs_volume_configuration
12081
- # This parameter is specified when you are using an Amazon Elastic
12082
- # File System file system for task storage.
12185
+ # This parameter is specified when you use an Amazon Elastic File
12186
+ # System file system for task storage.
12083
12187
  # @return [Types::EFSVolumeConfiguration]
12084
12188
  #
12085
12189
  # @!attribute [rw] fsx_windows_file_server_volume_configuration
12086
- # This parameter is specified when you are using Amazon FSx for
12087
- # Windows File Server file system for task storage.
12190
+ # This parameter is specified when you use Amazon FSx for Windows File
12191
+ # Server file system for task storage.
12088
12192
  # @return [Types::FSxWindowsFileServerVolumeConfiguration]
12089
12193
  #
12090
12194
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Volume AWS API Documentation
@@ -12111,8 +12215,8 @@ module Aws::ECS
12111
12215
  # }
12112
12216
  #
12113
12217
  # @!attribute [rw] source_container
12114
- # The name of another container within the same task definition from
12115
- # which to mount volumes.
12218
+ # The name of another container within the same task definition to
12219
+ # mount volumes from.
12116
12220
  # @return [String]
12117
12221
  #
12118
12222
  # @!attribute [rw] read_only