aws-sdk-ecs 1.89.0 → 1.90.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.
@@ -350,24 +350,24 @@ module Aws::ECS
350
350
  # with an Amazon ECS cluster and are used in capacity provider
351
351
  # strategies to facilitate cluster auto scaling.
352
352
  #
353
- # Only capacity providers using an Auto Scaling group can be created.
353
+ # Only capacity providers that use an Auto Scaling group can be created.
354
354
  # Amazon ECS tasks on Fargate use the `FARGATE` and `FARGATE_SPOT`
355
- # capacity providers which are already created and available to all
356
- # accounts in Regions supported by Fargate.
355
+ # capacity providers. These providers are available to all accounts in
356
+ # the Amazon Web Services Regions that Fargate supports.
357
357
  #
358
358
  # @option params [required, String] :name
359
- # The name of the capacity provider. Up to 255 characters are allowed,
360
- # including letters (upper and lowercase), numbers, underscores, and
361
- # hyphens. The name cannot be prefixed with "`aws`", "`ecs`", or
362
- # "`fargate`".
359
+ # The name of the capacity provider. Up to 255 characters are allowed.
360
+ # They include letters (both upper and lowercase letters), numbers,
361
+ # underscores (\_), and hyphens (-). The name can't be prefixed with
362
+ # "`aws`", "`ecs`", or "`fargate`".
363
363
  #
364
364
  # @option params [required, Types::AutoScalingGroupProvider] :auto_scaling_group_provider
365
365
  # The details of the Auto Scaling group for the capacity provider.
366
366
  #
367
367
  # @option params [Array<Types::Tag>] :tags
368
- # The metadata that you apply to the capacity provider to help you
369
- # categorize and organize them. Each tag consists of a key and an
370
- # optional value, both of which you define.
368
+ # The metadata that you apply to the capacity provider to categorize and
369
+ # organize them more conveniently. Each tag consists of a key and an
370
+ # optional value. You define both of them.
371
371
  #
372
372
  # The following basic restrictions apply to tags:
373
373
  #
@@ -454,10 +454,10 @@ module Aws::ECS
454
454
  # `CreateCluster` action.
455
455
  #
456
456
  # <note markdown="1"> When you call the CreateCluster API operation, Amazon ECS attempts to
457
- # create the Amazon ECS service-linked role for your account so that
458
- # required resources in other Amazon Web Services services can be
459
- # managed on your behalf. However, if the IAM user that makes the call
460
- # does not have permissions to create the service-linked role, it is not
457
+ # create the Amazon ECS service-linked role for your account. This is so
458
+ # that it can manage required resources in other Amazon Web Services
459
+ # services on your behalf. However, if the IAM user that makes the call
460
+ # doesn't have permissions to create the service-linked role, it isn't
461
461
  # created. For more information, see [Using Service-Linked Roles for
462
462
  # Amazon ECS][1] in the *Amazon Elastic Container Service Developer
463
463
  # Guide*.
@@ -469,15 +469,15 @@ module Aws::ECS
469
469
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
470
470
  #
471
471
  # @option params [String] :cluster_name
472
- # The name of your cluster. If you do not specify a name for your
473
- # cluster, you create a cluster named `default`. Up to 255 letters
474
- # (uppercase and lowercase), numbers, underscores, and hyphens are
475
- # allowed.
472
+ # The name of your cluster. If you don't specify a name for your
473
+ # cluster, you create a cluster that's named `default`. Up to 255
474
+ # letters (uppercase and lowercase), numbers, underscores, and hyphens
475
+ # are allowed.
476
476
  #
477
477
  # @option params [Array<Types::Tag>] :tags
478
478
  # The metadata that you apply to the cluster to help you categorize and
479
- # organize them. Each tag consists of a key and an optional value, both
480
- # of which you define.
479
+ # organize them. Each tag consists of a key and an optional value. You
480
+ # define both.
481
481
  #
482
482
  # The following basic restrictions apply to tags:
483
483
  #
@@ -507,7 +507,7 @@ module Aws::ECS
507
507
  # @option params [Array<Types::ClusterSetting>] :settings
508
508
  # The setting to use when creating a cluster. This parameter is used to
509
509
  # enable CloudWatch Container Insights for a cluster. If this value is
510
- # specified, it will override the `containerInsights` value set with
510
+ # specified, it overrides the `containerInsights` value set with
511
511
  # PutAccountSetting or PutAccountSettingDefault.
512
512
  #
513
513
  # @option params [Types::ClusterConfiguration] :configuration
@@ -521,9 +521,9 @@ module Aws::ECS
521
521
  # the CreateService or RunTask actions.
522
522
  #
523
523
  # If specifying a capacity provider that uses an Auto Scaling group, the
524
- # capacity provider must already be created and not already associated
525
- # with another cluster. New Auto Scaling group capacity providers can be
526
- # created with the CreateCapacityProvider API operation.
524
+ # capacity provider must be created but not associated with another
525
+ # cluster. New Auto Scaling group capacity providers can be created with
526
+ # the CreateCapacityProvider API operation.
527
527
  #
528
528
  # To use a Fargate capacity provider, specify either the `FARGATE` or
529
529
  # `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
@@ -536,13 +536,13 @@ module Aws::ECS
536
536
  #
537
537
  # @option params [Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
538
538
  # The capacity provider strategy to set as the default for the cluster.
539
- # When a default capacity provider strategy is set for a cluster, when
540
- # calling the RunTask or CreateService APIs with no capacity provider
539
+ # After a default capacity provider strategy is set for a cluster, when
540
+ # you call the RunTask or CreateService APIs with no capacity provider
541
541
  # strategy or launch type specified, the default capacity provider
542
542
  # strategy for the cluster is used.
543
543
  #
544
- # If a default capacity provider strategy is not defined for a cluster
545
- # during creation, it can be defined later with the
544
+ # If a default capacity provider strategy isn't defined for a cluster
545
+ # when it was created, it can be defined later with the
546
546
  # PutClusterCapacityProviders API operation.
547
547
  #
548
548
  # @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -659,7 +659,7 @@ module Aws::ECS
659
659
  req.send_request(options)
660
660
  end
661
661
 
662
- # Runs and maintains a desired number of tasks from a specified task
662
+ # Runs and maintains your desired number of tasks from a specified task
663
663
  # definition. If the number of tasks running in a service drops below
664
664
  # the `desiredCount`, Amazon ECS runs another copy of the task in the
665
665
  # specified cluster. To update an existing service, see the
@@ -672,26 +672,27 @@ module Aws::ECS
672
672
  # Balancing][1] in the *Amazon Elastic Container Service Developer
673
673
  # Guide*.
674
674
  #
675
- # Tasks for services that *do not* use a load balancer are considered
675
+ # Tasks for services that don't use a load balancer are considered
676
676
  # healthy if they're in the `RUNNING` state. Tasks for services that
677
- # *do* use a load balancer are considered healthy if they're in the
677
+ # use a load balancer are considered healthy if they're in the
678
678
  # `RUNNING` state and the container instance that they're hosted on is
679
679
  # reported as healthy by the load balancer.
680
680
  #
681
681
  # There are two service scheduler strategies available:
682
682
  #
683
- # * `REPLICA` - The replica scheduling strategy places and maintains the
684
- # desired number of tasks across your cluster. By default, the service
685
- # scheduler spreads tasks across Availability Zones. You can use task
686
- # placement strategies and constraints to customize task placement
687
- # decisions. For more information, see [Service Scheduler Concepts][2]
688
- # in the *Amazon Elastic Container Service Developer Guide*.
683
+ # * `REPLICA` - The replica scheduling strategy places and maintains
684
+ # your desired number of tasks across your cluster. By default, the
685
+ # service scheduler spreads tasks across Availability Zones. You can
686
+ # use task placement strategies and constraints to customize task
687
+ # placement decisions. For more information, see [Service Scheduler
688
+ # Concepts][2] in the *Amazon Elastic Container Service Developer
689
+ # Guide*.
689
690
  #
690
691
  # * `DAEMON` - The daemon scheduling strategy deploys exactly one task
691
692
  # on each active container instance that meets all of the task
692
693
  # placement constraints that you specify in your cluster. The service
693
694
  # scheduler also evaluates the task placement constraints for running
694
- # tasks and will stop tasks that do not meet the placement
695
+ # tasks. It also stops tasks that don't meet the placement
695
696
  # constraints. When using this strategy, you don't need to specify a
696
697
  # desired number of tasks, a task placement strategy, or use Service
697
698
  # Auto Scaling policies. For more information, see [Service Scheduler
@@ -699,51 +700,53 @@ module Aws::ECS
699
700
  # Guide*.
700
701
  #
701
702
  # You can optionally specify a deployment configuration for your
702
- # service. The deployment is triggered by changing properties, such as
703
- # the task definition or the desired count of a service, with an
704
- # UpdateService operation. The default value for a replica service for
703
+ # service. The deployment is initiated by changing properties. For
704
+ # example, the deployment might be initiated by the task definition or
705
+ # by your desired count of a service. This is done with an UpdateService
706
+ # operation. The default value for a replica service for
705
707
  # `minimumHealthyPercent` is 100%. The default value for a daemon
706
708
  # service for `minimumHealthyPercent` is 0%.
707
709
  #
708
- # If a service is using the `ECS` deployment controller, the minimum
709
- # healthy percent represents a lower limit on the number of tasks in a
710
- # service that must remain in the `RUNNING` state during a deployment,
711
- # as a percentage of the desired number of tasks (rounded up to the
712
- # nearest integer), and while any container instances are in the
713
- # `DRAINING` state if the service contains tasks using the EC2 launch
714
- # type. This parameter enables you to deploy without using additional
715
- # cluster capacity. For example, if your service has a desired number of
716
- # four tasks and a minimum healthy percent of 50%, the scheduler might
717
- # stop two existing tasks to free up cluster capacity before starting
718
- # two new tasks. Tasks for services that *do not* use a load balancer
719
- # are considered healthy if they're in the `RUNNING` state. Tasks for
720
- # services that *do* use a load balancer are considered healthy if
721
- # they're in the `RUNNING` state and they're reported as healthy by
722
- # the load balancer. The default value for minimum healthy percent is
723
- # 100%.
724
- #
725
- # If a service is using the `ECS` deployment controller, the **maximum
710
+ # If a service uses the `ECS` deployment controller, the minimum healthy
711
+ # percent represents a lower limit on the number of tasks in a service
712
+ # that must remain in the `RUNNING` state during a deployment.
713
+ # Specifically, it represents it as a percentage of your desired number
714
+ # of tasks (rounded up to the nearest integer). This happens when any of
715
+ # your container instances are in the `DRAINING` state if the service
716
+ # contains tasks using the EC2 launch type. Using this parameter, you
717
+ # can deploy without using additional cluster capacity. For example, if
718
+ # you set your service to have desired number of four tasks and a
719
+ # minimum healthy percent of 50%, the scheduler might stop two existing
720
+ # tasks to free up cluster capacity before starting two new tasks. If
721
+ # they're in the `RUNNING` state, tasks for services that don't use a
722
+ # load balancer are considered healthy . If they're in the `RUNNING`
723
+ # state and reported as healthy by the load balancer, tasks for services
724
+ # that *do* use a load balancer are considered healthy . The default
725
+ # value for minimum healthy percent is 100%.
726
+ #
727
+ # If a service uses the `ECS` deployment controller, the **maximum
726
728
  # percent** parameter represents an upper limit on the number of tasks
727
729
  # in a service that are allowed in the `RUNNING` or `PENDING` state
728
- # during a deployment, as a percentage of the desired number of tasks
729
- # (rounded down to the nearest integer), and while any container
730
- # instances are in the `DRAINING` state if the service contains tasks
731
- # using the EC2 launch type. This parameter enables you to define the
732
- # deployment batch size. For example, if your service has a desired
733
- # number of four tasks and a maximum percent value of 200%, the
734
- # scheduler may start four new tasks before stopping the four older
735
- # tasks (provided that the cluster resources required to do this are
736
- # available). The default value for maximum percent is 200%.
737
- #
738
- # If a service is using either the `CODE_DEPLOY` or `EXTERNAL`
739
- # deployment controller types and tasks that use the EC2 launch type,
740
- # the **minimum healthy percent** and **maximum percent** values are
741
- # used only to define the lower and upper limit on the number of the
742
- # tasks in the service that remain in the `RUNNING` state while the
730
+ # during a deployment. Specifically, it represents it as a percentage of
731
+ # the desired number of tasks (rounded down to the nearest integer).
732
+ # This happens when any of your container instances are in the
733
+ # `DRAINING` state if the service contains tasks using the EC2 launch
734
+ # type. Using this parameter, you can define the deployment batch size.
735
+ # For example, if your service has a desired number of four tasks and a
736
+ # maximum percent value of 200%, the scheduler may start four new tasks
737
+ # before stopping the four older tasks (provided that the cluster
738
+ # resources required to do this are available). The default value for
739
+ # maximum percent is 200%.
740
+ #
741
+ # If a service uses either the `CODE_DEPLOY` or `EXTERNAL` deployment
742
+ # controller types and tasks that use the EC2 launch type, the **minimum
743
+ # healthy percent** and **maximum percent** values are used only to
744
+ # define the lower and upper limit on the number of the tasks in the
745
+ # service that remain in the `RUNNING` state. This is while the
743
746
  # container instances are in the `DRAINING` state. If the tasks in the
744
747
  # service use the Fargate launch type, the minimum healthy percent and
745
- # maximum percent values aren't used, although they're currently
746
- # visible when describing your service.
748
+ # maximum percent values aren't used. This is the case even if they're
749
+ # currently visible when describing your service.
747
750
  #
748
751
  # When creating a service that uses the `EXTERNAL` deployment
749
752
  # controller, you can specify only parameters that aren't controlled at
@@ -756,13 +759,13 @@ module Aws::ECS
756
759
  # placement in your cluster using the following logic:
757
760
  #
758
761
  # * Determine which of the container instances in your cluster can
759
- # support your service's task definition (for example, they have the
760
- # required CPU, memory, ports, and container instance attributes).
762
+ # support the task definition of your service. For example, they have
763
+ # the required CPU, memory, ports, and container instance attributes.
761
764
  #
762
765
  # * By default, the service scheduler attempts to balance tasks across
763
- # Availability Zones in this manner (although you can choose a
764
- # different placement strategy) with the `placementStrategy`
765
- # parameter):
766
+ # Availability Zones in this manner. This is the case even if you can
767
+ # choose a different placement strategy with the `placementStrategy`
768
+ # parameter.
766
769
  #
767
770
  # * Sort the valid container instances, giving priority to instances
768
771
  # that have the fewest number of running tasks for this service in
@@ -772,7 +775,7 @@ module Aws::ECS
772
775
  # for placement.
773
776
  #
774
777
  # * Place the new service task on a valid container instance in an
775
- # optimal Availability Zone (based on the previous steps), favoring
778
+ # optimal Availability Zone based on the previous steps, favoring
776
779
  # container instances with the fewest number of running tasks for
777
780
  # this service.
778
781
  #
@@ -783,9 +786,9 @@ module Aws::ECS
783
786
  # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
784
787
  #
785
788
  # @option params [String] :cluster
786
- # The short name or full Amazon Resource Name (ARN) of the cluster on
787
- # which to run your service. If you do not specify a cluster, the
788
- # default cluster is assumed.
789
+ # The short name or full Amazon Resource Name (ARN) of the cluster that
790
+ # you run your service on. If you do not specify a cluster, the default
791
+ # cluster is assumed.
789
792
  #
790
793
  # @option params [required, String] :service_name
791
794
  # The name of your service. Up to 255 letters (uppercase and lowercase),
@@ -795,10 +798,10 @@ module Aws::ECS
795
798
  #
796
799
  # @option params [String] :task_definition
797
800
  # The `family` and `revision` (`family:revision`) or full ARN of the
798
- # task definition to run in your service. If a `revision` is not
801
+ # task definition to run in your service. If a `revision` isn't
799
802
  # specified, the latest `ACTIVE` revision is used.
800
803
  #
801
- # A task definition must be specified if the service is using either the
804
+ # A task definition must be specified if the service uses either the
802
805
  # `ECS` or `CODE_DEPLOY` deployment controllers.
803
806
  #
804
807
  # @option params [Array<Types::LoadBalancer>] :load_balancers
@@ -806,54 +809,56 @@ module Aws::ECS
806
809
  # your service. For more information, see [Service Load Balancing][1] in
807
810
  # the *Amazon Elastic Container Service Developer Guide*.
808
811
  #
809
- # If the service is using the rolling update (`ECS`) deployment
810
- # controller and using either an Application Load Balancer or Network
811
- # Load Balancer, you must specify one or more target group ARNs to
812
- # attach to the service. The service-linked role is required for
813
- # services that make use of multiple target groups. For more
814
- # information, see [Using service-linked roles for Amazon ECS][2] in the
815
- # *Amazon Elastic Container Service Developer Guide*.
812
+ # If the service uses the rolling update (`ECS`) deployment controller
813
+ # and using either an Application Load Balancer or Network Load
814
+ # Balancer, you must specify one or more target group ARNs to attach to
815
+ # the service. The service-linked role is required for services that use
816
+ # multiple target groups. For more information, see [Using
817
+ # service-linked roles for Amazon ECS][2] in the *Amazon Elastic
818
+ # Container Service Developer Guide*.
816
819
  #
817
- # If the service is using the `CODE_DEPLOY` deployment controller, the
820
+ # If the service uses the `CODE_DEPLOY` deployment controller, the
818
821
  # service is required to use either an Application Load Balancer or
819
822
  # Network Load Balancer. When creating an CodeDeploy deployment group,
820
823
  # you specify two target groups (referred to as a `targetGroupPair`).
821
824
  # During a deployment, CodeDeploy determines which task set in your
822
- # service has the status `PRIMARY` and associates one target group with
823
- # it, and then associates the other target group with the replacement
824
- # task set. The load balancer can also have up to two listeners: a
825
- # required listener for production traffic and an optional listener that
826
- # allows you perform validation tests with Lambda functions before
827
- # routing production traffic to it.
825
+ # service has the status `PRIMARY`, and it associates one target group
826
+ # with it. Then, it also associates the other target group with the
827
+ # replacement task set. The load balancer can also have up to two
828
+ # listeners: a required listener for production traffic and an optional
829
+ # listener that you can use to perform validation tests with Lambda
830
+ # functions before routing production traffic to it.
828
831
  #
829
832
  # After you create a service using the `ECS` deployment controller, the
830
833
  # load balancer name or target group ARN, container name, and container
831
- # port specified in the service definition are immutable. If you are
832
- # using the `CODE_DEPLOY` deployment controller, these values can be
834
+ # port that's specified in the service definition are immutable. If you
835
+ # use the `CODE_DEPLOY` deployment controller, these values can be
833
836
  # changed when updating the service.
834
837
  #
835
838
  # For Application Load Balancers and Network Load Balancers, this object
836
- # must contain the load balancer target group ARN, the container name
837
- # (as it appears in a container definition), and the container port to
838
- # access from the load balancer. The load balancer name parameter must
839
- # be omitted. When a task from this service is placed on a container
840
- # instance, the container instance and port combination is registered as
841
- # a target in the target group specified here.
839
+ # must contain the load balancer target group ARN, the container name,
840
+ # and the container port to access from the load balancer. The container
841
+ # name must be as it appears in a container definition. The load
842
+ # balancer name parameter must be omitted. When a task from this service
843
+ # is placed on a container instance, the container instance and port
844
+ # combination is registered as a target in the target group that's
845
+ # specified here.
842
846
  #
843
847
  # For Classic Load Balancers, this object must contain the load balancer
844
- # name, the container name (as it appears in a container definition),
845
- # and the container port to access from the load balancer. The target
846
- # group ARN parameter must be omitted. When a task from this service is
847
- # placed on a container instance, the container instance is registered
848
- # with the load balancer specified here.
848
+ # name, the container name , and the container port to access from the
849
+ # load balancer. The container name must be as it appears in a container
850
+ # definition. The target group ARN parameter must be omitted. When a
851
+ # task from this service is placed on a container instance, the
852
+ # container instance is registered with the load balancer that's
853
+ # specified here.
849
854
  #
850
855
  # Services with tasks that use the `awsvpc` network mode (for example,
851
856
  # those with the Fargate launch type) only support Application Load
852
- # Balancers and Network Load Balancers. Classic Load Balancers are not
857
+ # Balancers and Network Load Balancers. Classic Load Balancers aren't
853
858
  # supported. Also, when you create any target groups for these services,
854
- # you must choose `ip` as the target type, not `instance`, because tasks
855
- # that use the `awsvpc` network mode are associated with an elastic
856
- # network interface, not an Amazon EC2 instance.
859
+ # you must choose `ip` as the target type, not `instance`. This is
860
+ # because tasks that use the `awsvpc` network mode are associated with
861
+ # an elastic network interface, not an Amazon EC2 instance.
857
862
  #
858
863
  #
859
864
  #
@@ -865,7 +870,7 @@ module Aws::ECS
865
870
  # service. For more information, see [Service discovery][1].
866
871
  #
867
872
  # <note markdown="1"> Each service may be associated with one service registry. Multiple
868
- # service registries per service isn't supported.
873
+ # service registries for each service isn't supported.
869
874
  #
870
875
  # </note>
871
876
  #
@@ -877,16 +882,17 @@ module Aws::ECS
877
882
  # The number of instantiations of the specified task definition to place
878
883
  # and keep running on your cluster.
879
884
  #
880
- # This is required if `schedulingStrategy` is `REPLICA` or is not
881
- # specified. If `schedulingStrategy` is `DAEMON` then this is not
885
+ # This is required if `schedulingStrategy` is `REPLICA` or isn't
886
+ # specified. If `schedulingStrategy` is `DAEMON` then this isn't
882
887
  # required.
883
888
  #
884
889
  # @option params [String] :client_token
885
- # Unique, case-sensitive identifier that you provide to ensure the
886
- # idempotency of the request. Up to 32 ASCII characters are allowed.
890
+ # An identifier that you provide to ensure the idempotency of the
891
+ # request. It must be unique and is case sensitive. Up to 32 ASCII
892
+ # characters are allowed.
887
893
  #
888
894
  # @option params [String] :launch_type
889
- # The infrastructure on which to run your service. For more information,
895
+ # The infrastructure that you run your service on. For more information,
890
896
  # see [Amazon ECS launch types][1] in the *Amazon Elastic Container
891
897
  # Service Developer Guide*.
892
898
  #
@@ -902,7 +908,7 @@ module Aws::ECS
902
908
  # The `EC2` launch type runs your tasks on Amazon EC2 instances
903
909
  # registered to your cluster.
904
910
  #
905
- # The `EXTERNAL` launch type runs your tasks on your on-premise server
911
+ # The `EXTERNAL` launch type runs your tasks on your on-premises server
906
912
  # or virtual machine (VM) capacity registered to your cluster.
907
913
  #
908
914
  # A service can use either a launch type or a capacity provider
@@ -928,9 +934,9 @@ module Aws::ECS
928
934
  # @option params [String] :platform_version
929
935
  # The platform version that your tasks in the service are running on. A
930
936
  # platform version is specified only for tasks using the Fargate launch
931
- # type. If one isn't specified, the `LATEST` platform version is used
932
- # by default. For more information, see [Fargate platform versions][1]
933
- # in the *Amazon Elastic Container Service Developer Guide*.
937
+ # type. If one isn't specified, the `LATEST` platform version is used.
938
+ # For more information, see [Fargate platform versions][1] in the
939
+ # *Amazon Elastic Container Service Developer Guide*.
934
940
  #
935
941
  #
936
942
  #
@@ -940,19 +946,19 @@ module Aws::ECS
940
946
  # The name or full Amazon Resource Name (ARN) of the IAM role that
941
947
  # allows Amazon ECS to make calls to your load balancer on your behalf.
942
948
  # This parameter is only permitted if you are using a load balancer with
943
- # your service and your task definition does not use the `awsvpc`
949
+ # your service and your task definition doesn't use the `awsvpc`
944
950
  # network mode. If you specify the `role` parameter, you must also
945
951
  # specify a load balancer object with the `loadBalancers` parameter.
946
952
  #
947
953
  # If your account has already created the Amazon ECS service-linked
948
- # role, that role is used by default for your service unless you specify
949
- # a role here. The service-linked role is required if your task
950
- # definition uses the `awsvpc` network mode or if the service is
951
- # configured to use service discovery, an external deployment
952
- # controller, multiple target groups, or Elastic Inference accelerators
953
- # in which case you should not specify a role here. For more
954
- # information, see [Using service-linked roles for Amazon ECS][1] in the
955
- # *Amazon Elastic Container Service Developer Guide*.
954
+ # role, that role is used for your service unless you specify a role
955
+ # here. The service-linked role is required if your task definition uses
956
+ # the `awsvpc` network mode or if the service is configured to use
957
+ # service discovery, an external deployment controller, multiple target
958
+ # groups, or Elastic Inference accelerators in which case you don't
959
+ # specify a role here. For more information, see [Using service-linked
960
+ # roles for Amazon ECS][1] in the *Amazon Elastic Container Service
961
+ # Developer Guide*.
956
962
  #
957
963
  # If your specified role has a path other than `/`, then you must either
958
964
  # specify the full role ARN (this is recommended) or prefix the role
@@ -972,18 +978,18 @@ module Aws::ECS
972
978
  #
973
979
  # @option params [Array<Types::PlacementConstraint>] :placement_constraints
974
980
  # An array of placement constraint objects to use for tasks in your
975
- # service. You can specify a maximum of 10 constraints per task (this
976
- # limit includes constraints in the task definition and those specified
977
- # at runtime).
981
+ # service. You can specify a maximum of 10 constraints for each task.
982
+ # This limit includes constraints in the task definition and those
983
+ # specified at runtime.
978
984
  #
979
985
  # @option params [Array<Types::PlacementStrategy>] :placement_strategy
980
986
  # The placement strategy objects to use for tasks in your service. You
981
- # can specify a maximum of 5 strategy rules per service.
987
+ # can specify a maximum of 5 strategy rules for each service.
982
988
  #
983
989
  # @option params [Types::NetworkConfiguration] :network_configuration
984
990
  # The network configuration for the service. This parameter is required
985
991
  # for task definitions that use the `awsvpc` network mode to receive
986
- # their own elastic network interface, and it is not supported for other
992
+ # their own elastic network interface, and it isn't supported for other
987
993
  # network modes. For more information, see [Task networking][1] in the
988
994
  # *Amazon Elastic Container Service Developer Guide*.
989
995
  #
@@ -993,18 +999,18 @@ module Aws::ECS
993
999
  #
994
1000
  # @option params [Integer] :health_check_grace_period_seconds
995
1001
  # The period of time, in seconds, that the Amazon ECS service scheduler
996
- # should ignore unhealthy Elastic Load Balancing target health checks
997
- # after a task has first started. This is only used when your service is
1002
+ # ignores unhealthy Elastic Load Balancing target health checks after a
1003
+ # task has first started. This is only used when your service is
998
1004
  # configured to use a load balancer. If your service has a load balancer
999
1005
  # defined and you don't specify a health check grace period value, the
1000
1006
  # default value of `0` is used.
1001
1007
  #
1002
1008
  # If your service's tasks take a while to start and respond to Elastic
1003
1009
  # Load Balancing health checks, you can specify a health check grace
1004
- # period of up to 2,147,483,647 seconds. During that time, the Amazon
1005
- # ECS service scheduler ignores health check status. This grace period
1006
- # can prevent the service scheduler from marking tasks as unhealthy and
1007
- # stopping them before they have time to come up.
1010
+ # period of up to 2,147,483,647 seconds (about 69 years). During that
1011
+ # time, the Amazon ECS service scheduler ignores health check status.
1012
+ # This grace period can prevent the service scheduler from marking tasks
1013
+ # as unhealthy and stopping them before they have time to come up.
1008
1014
  #
1009
1015
  # @option params [String] :scheduling_strategy
1010
1016
  # The scheduling strategy to use for the service. For more information,
@@ -1016,14 +1022,14 @@ module Aws::ECS
1016
1022
  # desired number of tasks across your cluster. By default, the service
1017
1023
  # scheduler spreads tasks across Availability Zones. You can use task
1018
1024
  # placement strategies and constraints to customize task placement
1019
- # decisions. This scheduler strategy is required if the service is
1020
- # using the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.
1025
+ # decisions. This scheduler strategy is required if the service uses
1026
+ # the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.
1021
1027
  #
1022
1028
  # * `DAEMON`-The daemon scheduling strategy deploys exactly one task on
1023
1029
  # each active container instance that meets all of the task placement
1024
1030
  # constraints that you specify in your cluster. The service scheduler
1025
1031
  # also evaluates the task placement constraints for running tasks and
1026
- # will stop tasks that do not meet the placement constraints. When
1032
+ # will stop tasks that don't meet the placement constraints. When
1027
1033
  # you're using this strategy, you don't need to specify a desired
1028
1034
  # number of tasks, a task placement strategy, or use Service Auto
1029
1035
  # Scaling policies.
@@ -1086,15 +1092,15 @@ module Aws::ECS
1086
1092
  # @option params [String] :propagate_tags
1087
1093
  # Specifies whether to propagate the tags from the task definition or
1088
1094
  # the service to the tasks in the service. If no value is specified, the
1089
- # tags are not propagated. Tags can only be propagated to the tasks
1095
+ # tags aren't propagated. Tags can only be propagated to the tasks
1090
1096
  # within the service during service creation. To add tags to a task
1091
1097
  # after service creation or task creation, use the TagResource API
1092
1098
  # action.
1093
1099
  #
1094
1100
  # @option params [Boolean] :enable_execute_command
1095
- # Whether or not the execute command functionality is enabled for the
1096
- # service. If `true`, this enables execute command functionality on all
1097
- # containers in the service tasks.
1101
+ # Determines whether the execute command functionality is enabled for
1102
+ # the service. If `true`, this enables execute command functionality on
1103
+ # all containers in the service tasks.
1098
1104
  #
1099
1105
  # @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1100
1106
  #
@@ -1474,7 +1480,7 @@ module Aws::ECS
1474
1480
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
1475
1481
  #
1476
1482
  # @option params [String] :launch_type
1477
- # The launch type that new tasks in the task set will use. For more
1483
+ # The launch type that new tasks in the task set uses. For more
1478
1484
  # information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
1479
1485
  # Container Service Developer Guide*.
1480
1486
  #
@@ -1514,24 +1520,23 @@ module Aws::ECS
1514
1520
  # is created.
1515
1521
  #
1516
1522
  # @option params [String] :platform_version
1517
- # The platform version that the tasks in the task set should use. A
1518
- # platform version is specified only for tasks using the Fargate launch
1519
- # type. If one isn't specified, the `LATEST` platform version is used
1520
- # by default.
1523
+ # The platform version that the tasks in the task set uses. A platform
1524
+ # version is specified only for tasks using the Fargate launch type. If
1525
+ # one isn't specified, the `LATEST` platform version is used.
1521
1526
  #
1522
1527
  # @option params [Types::Scale] :scale
1523
1528
  # A floating-point percentage of the desired number of tasks to place
1524
1529
  # and keep running in the task set.
1525
1530
  #
1526
1531
  # @option params [String] :client_token
1527
- # Unique, case-sensitive identifier that you provide to ensure the
1528
- # idempotency of the request. Up to 32 ASCII characters are allowed.
1532
+ # The identifier that you provide to ensure the idempotency of the
1533
+ # request. It's case sensitive and must be unique. It can be up to 32
1534
+ # ASCII characters are allowed.
1529
1535
  #
1530
1536
  # @option params [Array<Types::Tag>] :tags
1531
1537
  # The metadata that you apply to the task set to help you categorize and
1532
- # organize them. Each tag consists of a key and an optional value, both
1533
- # of which you define. When a service is deleted, the tags are deleted
1534
- # as well.
1538
+ # organize them. Each tag consists of a key and an optional value. You
1539
+ # define both. When a service is deleted, the tags are deleted.
1535
1540
  #
1536
1541
  # The following basic restrictions apply to tags:
1537
1542
  #
@@ -1672,7 +1677,7 @@ module Aws::ECS
1672
1677
  # root user for an account.
1673
1678
  #
1674
1679
  # @option params [required, String] :name
1675
- # The resource name for which to disable the account setting. If
1680
+ # The resource name to disable the account setting for. If
1676
1681
  # `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
1677
1682
  # services is affected. If `taskLongArnFormat` is specified, the ARN and
1678
1683
  # resource ID for your Amazon ECS tasks is affected. If
@@ -1682,12 +1687,12 @@ module Aws::ECS
1682
1687
  # container instances is affected.
1683
1688
  #
1684
1689
  # @option params [String] :principal_arn
1685
- # The ARN of the principal, which can be an IAM user, IAM role, or the
1686
- # root user. If you specify the root user, it disables the account
1687
- # setting for all IAM users, IAM roles, and the root user of the account
1688
- # unless an IAM user or role explicitly overrides these settings. If
1689
- # this field is omitted, the setting is changed only for the
1690
- # authenticated user.
1690
+ # The Amazon Resource Name (ARN) of the principal. It can be an IAM
1691
+ # user, IAM role, or the root user. If you specify the root user, it
1692
+ # disables the account setting for all IAM users, IAM roles, and the
1693
+ # root user of the account unless an IAM user or role explicitly
1694
+ # overrides these settings. If this field is omitted, the setting is
1695
+ # changed only for the authenticated user.
1691
1696
  #
1692
1697
  # @return [Types::DeleteAccountSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1693
1698
  #
@@ -1761,9 +1766,10 @@ module Aws::ECS
1761
1766
  #
1762
1767
  # @option params [required, Array<Types::Attribute>] :attributes
1763
1768
  # The attributes to delete from your resource. You can specify up to 10
1764
- # attributes per request. For custom attributes, specify the attribute
1765
- # name and target ID, but do not specify the value. If you specify the
1766
- # target ID using the short form, you must also specify the target type.
1769
+ # attributes for each request. For custom attributes, specify the
1770
+ # attribute name and target ID, but don't specify the value. If you
1771
+ # specify the target ID using the short form, you must also specify the
1772
+ # target type.
1767
1773
  #
1768
1774
  # @return [Types::DeleteAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1769
1775
  #
@@ -1803,7 +1809,7 @@ module Aws::ECS
1803
1809
  # Deletes the specified capacity provider.
1804
1810
  #
1805
1811
  # <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
1806
- # cannot be deleted. You can disassociate them from a cluster using
1812
+ # can't be deleted. You can disassociate them from a cluster using
1807
1813
  # either the PutClusterCapacityProviders API or by deleting the cluster.
1808
1814
  #
1809
1815
  # </note>
@@ -1815,7 +1821,7 @@ module Aws::ECS
1815
1821
  # `forceNewDeployment` option can be used to ensure that any tasks using
1816
1822
  # the Amazon EC2 instance capacity provided by the capacity provider are
1817
1823
  # transitioned to use the capacity from the remaining capacity
1818
- # providers. Only capacity providers that are not associated with a
1824
+ # providers. Only capacity providers that aren't associated with a
1819
1825
  # cluster can be deleted. To remove a capacity provider from a cluster,
1820
1826
  # you can either use PutClusterCapacityProviders or delete the cluster.
1821
1827
  #
@@ -1860,11 +1866,11 @@ module Aws::ECS
1860
1866
  req.send_request(options)
1861
1867
  end
1862
1868
 
1863
- # Deletes the specified cluster. The cluster will transition to the
1864
- # `INACTIVE` state. Clusters with an `INACTIVE` status may remain
1869
+ # Deletes the specified cluster. The cluster transitions to the
1870
+ # `INACTIVE` state. Clusters with an `INACTIVE` status might remain
1865
1871
  # discoverable in your account for a period of time. However, this
1866
- # behavior is subject to change in the future, so you should not rely on
1867
- # `INACTIVE` clusters persisting.
1872
+ # behavior is subject to change in the future. We don't recommend that
1873
+ # you rely on `INACTIVE` clusters persisting.
1868
1874
  #
1869
1875
  # You must deregister all container instances from this cluster before
1870
1876
  # you may delete it. You can list the container instances in a cluster
@@ -1958,7 +1964,7 @@ module Aws::ECS
1958
1964
 
1959
1965
  # Deletes a specified service within a cluster. You can delete a service
1960
1966
  # if you have no running tasks in it and the desired task count is zero.
1961
- # If the service is actively maintaining tasks, you cannot delete it,
1967
+ # If the service is actively maintaining tasks, you can't delete it,
1962
1968
  # and you must update the service to a desired task count of zero. For
1963
1969
  # more information, see UpdateService.
1964
1970
  #
@@ -1988,9 +1994,9 @@ module Aws::ECS
1988
1994
  # The name of the service to delete.
1989
1995
  #
1990
1996
  # @option params [Boolean] :force
1991
- # If `true`, allows you to delete a service even if it has not been
1992
- # scaled down to zero tasks. It is only necessary to use this if the
1993
- # service is using the `REPLICA` scheduling strategy.
1997
+ # If `true`, allows you to delete a service even if it wasn't scaled
1998
+ # down to zero tasks. It's only necessary to use this if the service
1999
+ # uses the `REPLICA` scheduling strategy.
1994
2000
  #
1995
2001
  # @return [Types::DeleteServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1996
2002
  #
@@ -2164,7 +2170,7 @@ module Aws::ECS
2164
2170
  #
2165
2171
  # @option params [required, String] :cluster
2166
2172
  # The short name or full Amazon Resource Name (ARN) of the cluster that
2167
- # hosts the service that the task set exists in to delete.
2173
+ # hosts the service that the task set found in to delete.
2168
2174
  #
2169
2175
  # @option params [required, String] :service
2170
2176
  # The short name or full Amazon Resource Name (ARN) of the service that
@@ -2175,8 +2181,8 @@ module Aws::ECS
2175
2181
  # delete.
2176
2182
  #
2177
2183
  # @option params [Boolean] :force
2178
- # If `true`, this allows you to delete a task set even if it hasn't
2179
- # been scaled down to zero.
2184
+ # If `true`, you can delete a task set even if it hasn't been scaled
2185
+ # down to zero.
2180
2186
  #
2181
2187
  # @return [Types::DeleteTaskSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2182
2188
  #
@@ -2249,18 +2255,18 @@ module Aws::ECS
2249
2255
  # cluster. This instance is no longer available to run tasks.
2250
2256
  #
2251
2257
  # If you intend to use the container instance for some other purpose
2252
- # after deregistration, you should stop all of the tasks running on the
2253
- # container instance before deregistration. That prevents any orphaned
2254
- # tasks from consuming resources.
2258
+ # after deregistration, we recommend that you stop all of the tasks
2259
+ # running on the container instance before deregistration. That prevents
2260
+ # any orphaned tasks from consuming resources.
2255
2261
  #
2256
2262
  # Deregistering a container instance removes the instance from a
2257
- # cluster, but it does not terminate the EC2 instance. If you are
2263
+ # cluster, but it doesn't terminate the EC2 instance. If you are
2258
2264
  # finished using the instance, be sure to terminate it in the Amazon EC2
2259
2265
  # console to stop billing.
2260
2266
  #
2261
2267
  # <note markdown="1"> If you terminate a running container instance, Amazon ECS
2262
2268
  # automatically deregisters the instance from your cluster (stopped
2263
- # container instances or instances with disconnected agents are not
2269
+ # container instances or instances with disconnected agents aren't
2264
2270
  # automatically deregistered when terminated).
2265
2271
  #
2266
2272
  # </note>
@@ -2279,10 +2285,10 @@ module Aws::ECS
2279
2285
  # `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
2280
2286
  #
2281
2287
  # @option params [Boolean] :force
2282
- # Forces the deregistration of the container instance. If you have tasks
2288
+ # Forces the container instance to be deregistered. If you have tasks
2283
2289
  # running on the container instance when you deregister it with the
2284
2290
  # `force` option, these tasks remain running until you terminate the
2285
- # instance or the tasks stop through some other means, but they are
2291
+ # instance or the tasks stop through some other means, but they're
2286
2292
  # orphaned (no longer monitored or accounted for by Amazon ECS). If an
2287
2293
  # orphaned task on your container instance is part of an Amazon ECS
2288
2294
  # service, then the service scheduler starts another copy of that task,
@@ -2368,6 +2374,12 @@ module Aws::ECS
2368
2374
  # resp.container_instance.tags #=> Array
2369
2375
  # resp.container_instance.tags[0].key #=> String
2370
2376
  # resp.container_instance.tags[0].value #=> String
2377
+ # resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
2378
+ # resp.container_instance.health_status.details #=> Array
2379
+ # resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
2380
+ # resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
2381
+ # resp.container_instance.health_status.details[0].last_updated #=> Time
2382
+ # resp.container_instance.health_status.details[0].last_status_change #=> Time
2371
2383
  #
2372
2384
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance AWS API Documentation
2373
2385
  #
@@ -2385,16 +2397,17 @@ module Aws::ECS
2385
2397
  # an `INACTIVE` task definition can still scale up or down by modifying
2386
2398
  # the service's desired count.
2387
2399
  #
2388
- # You cannot use an `INACTIVE` task definition to run new tasks or
2389
- # create new services, and you cannot update an existing service to
2400
+ # You can't use an `INACTIVE` task definition to run new tasks or
2401
+ # create new services, and you can't update an existing service to
2390
2402
  # reference an `INACTIVE` task definition. However, there may be up to a
2391
2403
  # 10-minute window following deregistration where these restrictions
2392
2404
  # have not yet taken effect.
2393
2405
  #
2394
2406
  # <note markdown="1"> At this time, `INACTIVE` task definitions remain discoverable in your
2395
2407
  # account indefinitely. However, this behavior is subject to change in
2396
- # the future, so you should not rely on `INACTIVE` task definitions
2397
- # persisting beyond the lifecycle of any associated tasks and services.
2408
+ # the future. We don't recommend that you rely on `INACTIVE` task
2409
+ # definitions persisting beyond the lifecycle of any associated tasks
2410
+ # and services.
2398
2411
  #
2399
2412
  # </note>
2400
2413
  #
@@ -2593,7 +2606,7 @@ module Aws::ECS
2593
2606
  # @option params [Array<String>] :include
2594
2607
  # Specifies whether or not you want to see the resource tags for the
2595
2608
  # capacity provider. If `TAGS` is specified, the tags are included in
2596
- # the response. If this field is omitted, tags are not included in the
2609
+ # the response. If this field is omitted, tags aren't included in the
2597
2610
  # response.
2598
2611
  #
2599
2612
  # @option params [Integer] :max_results
@@ -2676,8 +2689,9 @@ module Aws::ECS
2676
2689
  # assumed.
2677
2690
  #
2678
2691
  # @option params [Array<String>] :include
2679
- # Whether to include additional information about the clusters in the
2680
- # response. If this field is omitted, this information isn't included.
2692
+ # Determines whether to include additional information about the
2693
+ # clusters in the response. If this field is omitted, this information
2694
+ # isn't included.
2681
2695
  #
2682
2696
  # If `ATTACHMENTS` is specified, the attachments for the container
2683
2697
  # instances or tasks within the cluster are included.
@@ -2800,7 +2814,9 @@ module Aws::ECS
2800
2814
  # @option params [Array<String>] :include
2801
2815
  # Specifies whether you want to see the resource tags for the container
2802
2816
  # instance. If `TAGS` is specified, the tags are included in the
2803
- # response. If this field is omitted, tags are not included in the
2817
+ # response. If `CONTAINER_INSTANCE_HEALTH` is specified, the container
2818
+ # instance health is included in the response. If this field is omitted,
2819
+ # tags and container instance health status aren't included in the
2804
2820
  # response.
2805
2821
  #
2806
2822
  # @return [Types::DescribeContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2901,7 +2917,7 @@ module Aws::ECS
2901
2917
  # resp = client.describe_container_instances({
2902
2918
  # cluster: "String",
2903
2919
  # container_instances: ["String"], # required
2904
- # include: ["TAGS"], # accepts TAGS
2920
+ # include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
2905
2921
  # })
2906
2922
  #
2907
2923
  # @example Response structure
@@ -2952,6 +2968,12 @@ module Aws::ECS
2952
2968
  # resp.container_instances[0].tags #=> Array
2953
2969
  # resp.container_instances[0].tags[0].key #=> String
2954
2970
  # resp.container_instances[0].tags[0].value #=> String
2971
+ # resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
2972
+ # resp.container_instances[0].health_status.details #=> Array
2973
+ # resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
2974
+ # resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
2975
+ # resp.container_instances[0].health_status.details[0].last_updated #=> Time
2976
+ # resp.container_instances[0].health_status.details[0].last_status_change #=> Time
2955
2977
  # resp.failures #=> Array
2956
2978
  # resp.failures[0].arn #=> String
2957
2979
  # resp.failures[0].reason #=> String
@@ -2980,9 +3002,9 @@ module Aws::ECS
2980
3002
  # describe in a single operation.
2981
3003
  #
2982
3004
  # @option params [Array<String>] :include
2983
- # Specifies whether you want to see the resource tags for the service.
3005
+ # Determines whether you want to see the resource tags for the service.
2984
3006
  # If `TAGS` is specified, the tags are included in the response. If this
2985
- # field is omitted, tags are not included in the response.
3007
+ # field is omitted, tags aren't included in the response.
2986
3008
  #
2987
3009
  # @return [Types::DescribeServicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2988
3010
  #
@@ -3214,9 +3236,9 @@ module Aws::ECS
3214
3236
  # Amazon Resource Name (ARN) of the task definition to describe.
3215
3237
  #
3216
3238
  # @option params [Array<String>] :include
3217
- # Specifies whether to see the resource tags for the task definition. If
3218
- # `TAGS` is specified, the tags are included in the response. If this
3219
- # field is omitted, tags are not included in the response.
3239
+ # Determines whether to see the resource tags for the task definition.
3240
+ # If `TAGS` is specified, the tags are included in the response. If this
3241
+ # field is omitted, tags aren't included in the response.
3220
3242
  #
3221
3243
  # @return [Types::DescribeTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3222
3244
  #
@@ -3489,7 +3511,7 @@ module Aws::ECS
3489
3511
  # @option params [Array<String>] :include
3490
3512
  # Specifies whether to see the resource tags for the task set. If `TAGS`
3491
3513
  # is specified, the tags are included in the response. If this field is
3492
- # omitted, tags are not included in the response.
3514
+ # omitted, tags aren't included in the response.
3493
3515
  #
3494
3516
  # @return [Types::DescribeTaskSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3495
3517
  #
@@ -3579,7 +3601,7 @@ module Aws::ECS
3579
3601
  # @option params [Array<String>] :include
3580
3602
  # Specifies whether you want to see the resource tags for the task. If
3581
3603
  # `TAGS` is specified, the tags are included in the response. If this
3582
- # field is omitted, tags are not included in the response.
3604
+ # field is omitted, tags aren't included in the response.
3583
3605
  #
3584
3606
  # @return [Types::DescribeTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3585
3607
  #
@@ -3785,8 +3807,8 @@ module Aws::ECS
3785
3807
  # `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
3786
3808
  #
3787
3809
  # @option params [String] :cluster
3788
- # The short name or full Amazon Resource Name (ARN) of the cluster to
3789
- # which the container instance belongs.
3810
+ # The short name or full Amazon Resource Name (ARN) of the cluster that
3811
+ # the container instance belongs to.
3790
3812
  #
3791
3813
  # @return [Types::DiscoverPollEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3792
3814
  #
@@ -3880,8 +3902,8 @@ module Aws::ECS
3880
3902
  # The name of the account setting you want to list the settings for.
3881
3903
  #
3882
3904
  # @option params [String] :value
3883
- # The value of the account settings with which to filter results. You
3884
- # must also specify an account setting name to use this parameter.
3905
+ # The value of the account settings to filter results with. You must
3906
+ # also specify an account setting name to use this parameter.
3885
3907
  #
3886
3908
  # @option params [String] :principal_arn
3887
3909
  # The ARN of the principal, which can be an IAM user, IAM role, or the
@@ -3894,16 +3916,16 @@ module Aws::ECS
3894
3916
  # </note>
3895
3917
  #
3896
3918
  # @option params [Boolean] :effective_settings
3897
- # Specifies whether to return the effective settings. If `true`, the
3919
+ # Determines whether to return the effective settings. If `true`, the
3898
3920
  # account settings for the root user or the default setting for the
3899
3921
  # `principalArn` are returned. If `false`, the account settings for the
3900
- # `principalArn` are returned if they are set. Otherwise, no account
3922
+ # `principalArn` are returned if they're set. Otherwise, no account
3901
3923
  # settings are returned.
3902
3924
  #
3903
3925
  # @option params [String] :next_token
3904
3926
  # The `nextToken` value returned from a `ListAccountSettings` request
3905
3927
  # indicating that more results are available to fulfill the request and
3906
- # further calls will be needed. If `maxResults` was provided, it is
3928
+ # further calls will be needed. If `maxResults` was provided, it's
3907
3929
  # possible the number of results to be fewer than `maxResults`.
3908
3930
  #
3909
3931
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
@@ -3919,7 +3941,7 @@ module Aws::ECS
3919
3941
  # single page along with a `nextToken` response element. The remaining
3920
3942
  # results of the initial request can be seen by sending another
3921
3943
  # `ListAccountSettings` request with the returned `nextToken` value.
3922
- # This value can be between 1 and 10. If this parameter is not used,
3944
+ # This value can be between 1 and 10. If this parameter isn't used,
3923
3945
  # then `ListAccountSettings` returns up to 10 results and a `nextToken`
3924
3946
  # value if applicable.
3925
3947
  #
@@ -4023,9 +4045,9 @@ module Aws::ECS
4023
4045
  # `ListAttributes` returns a list of attribute objects, one for each
4024
4046
  # attribute on each resource. You can filter the list of results to a
4025
4047
  # single attribute name to only return results that have that name. You
4026
- # can also filter the results by attribute name and value, for example,
4027
- # to see which container instances in a cluster are running a Linux AMI
4028
- # (`ecs.os-type=linux`).
4048
+ # can also filter the results by attribute name and value. You can do
4049
+ # this, for example, to see which container instances in a cluster are
4050
+ # running a Linux AMI (`ecs.os-type=linux`).
4029
4051
  #
4030
4052
  # @option params [String] :cluster
4031
4053
  # The short name or full Amazon Resource Name (ARN) of the cluster to
@@ -4033,20 +4055,20 @@ module Aws::ECS
4033
4055
  # is assumed.
4034
4056
  #
4035
4057
  # @option params [required, String] :target_type
4036
- # The type of the target with which to list attributes.
4058
+ # The type of the target to list attributes with.
4037
4059
  #
4038
4060
  # @option params [String] :attribute_name
4039
- # The name of the attribute with which to filter the results.
4061
+ # The name of the attribute to filter the results with.
4040
4062
  #
4041
4063
  # @option params [String] :attribute_value
4042
- # The value of the attribute with which to filter results. You must also
4064
+ # The value of the attribute to filter results with. You must also
4043
4065
  # specify an attribute name to use this parameter.
4044
4066
  #
4045
4067
  # @option params [String] :next_token
4046
4068
  # The `nextToken` value returned from a `ListAttributes` request
4047
4069
  # indicating that more results are available to fulfill the request and
4048
- # further calls will be needed. If `maxResults` was provided, it is
4049
- # possible the number of results to be fewer than `maxResults`.
4070
+ # further calls are needed. If `maxResults` was provided, it's possible
4071
+ # the number of results to be fewer than `maxResults`.
4050
4072
  #
4051
4073
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
4052
4074
  # to retrieve the next items in a list and not for other programmatic
@@ -4055,14 +4077,14 @@ module Aws::ECS
4055
4077
  # </note>
4056
4078
  #
4057
4079
  # @option params [Integer] :max_results
4058
- # The maximum number of cluster results returned by `ListAttributes` in
4059
- # paginated output. When this parameter is used, `ListAttributes` only
4060
- # returns `maxResults` results in a single page along with a `nextToken`
4061
- # response element. The remaining results of the initial request can be
4062
- # seen by sending another `ListAttributes` request with the returned
4063
- # `nextToken` value. This value can be between 1 and 100. If this
4064
- # parameter is not used, then `ListAttributes` returns up to 100 results
4065
- # and a `nextToken` value if applicable.
4080
+ # The maximum number of cluster results that `ListAttributes` returned
4081
+ # in paginated output. When this parameter is used, `ListAttributes`
4082
+ # only returns `maxResults` results in a single page along with a
4083
+ # `nextToken` response element. The remaining results of the initial
4084
+ # request can be seen by sending another `ListAttributes` request with
4085
+ # the returned `nextToken` value. This value can be between 1 and 100.
4086
+ # If this parameter isn't used, then `ListAttributes` returns up to 100
4087
+ # results and a `nextToken` value if applicable.
4066
4088
  #
4067
4089
  # @return [Types::ListAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4068
4090
  #
@@ -4105,8 +4127,8 @@ module Aws::ECS
4105
4127
  # @option params [String] :next_token
4106
4128
  # The `nextToken` value returned from a `ListClusters` request
4107
4129
  # indicating that more results are available to fulfill the request and
4108
- # further calls will be needed. If `maxResults` was provided, it is
4109
- # possible the number of results to be fewer than `maxResults`.
4130
+ # further calls are needed. If `maxResults` was provided, it's possible
4131
+ # the number of results to be fewer than `maxResults`.
4110
4132
  #
4111
4133
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
4112
4134
  # to retrieve the next items in a list and not for other programmatic
@@ -4115,13 +4137,13 @@ module Aws::ECS
4115
4137
  # </note>
4116
4138
  #
4117
4139
  # @option params [Integer] :max_results
4118
- # The maximum number of cluster results returned by `ListClusters` in
4140
+ # The maximum number of cluster results that `ListClusters` returned in
4119
4141
  # paginated output. When this parameter is used, `ListClusters` only
4120
4142
  # returns `maxResults` results in a single page along with a `nextToken`
4121
4143
  # response element. The remaining results of the initial request can be
4122
4144
  # seen by sending another `ListClusters` request with the returned
4123
4145
  # `nextToken` value. This value can be between 1 and 100. If this
4124
- # parameter is not used, then `ListClusters` returns up to 100 results
4146
+ # parameter isn't used, then `ListClusters` returns up to 100 results
4125
4147
  # and a `nextToken` value if applicable.
4126
4148
  #
4127
4149
  # @return [Types::ListClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -4197,8 +4219,8 @@ module Aws::ECS
4197
4219
  # @option params [String] :next_token
4198
4220
  # The `nextToken` value returned from a `ListContainerInstances` request
4199
4221
  # indicating that more results are available to fulfill the request and
4200
- # further calls will be needed. If `maxResults` was provided, it is
4201
- # possible the number of results to be fewer than `maxResults`.
4222
+ # further calls are needed. If `maxResults` was provided, it's possible
4223
+ # the number of results to be fewer than `maxResults`.
4202
4224
  #
4203
4225
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
4204
4226
  # to retrieve the next items in a list and not for other programmatic
@@ -4207,21 +4229,21 @@ module Aws::ECS
4207
4229
  # </note>
4208
4230
  #
4209
4231
  # @option params [Integer] :max_results
4210
- # The maximum number of container instance results returned by
4211
- # `ListContainerInstances` in paginated output. When this parameter is
4212
- # used, `ListContainerInstances` only returns `maxResults` results in a
4213
- # single page along with a `nextToken` response element. The remaining
4214
- # results of the initial request can be seen by sending another
4215
- # `ListContainerInstances` request with the returned `nextToken` value.
4216
- # This value can be between 1 and 100. If this parameter is not used,
4217
- # then `ListContainerInstances` returns up to 100 results and a
4232
+ # The maximum number of container instance results that
4233
+ # `ListContainerInstances` returned in paginated output. When this
4234
+ # parameter is used, `ListContainerInstances` only returns `maxResults`
4235
+ # results in a single page along with a `nextToken` response element.
4236
+ # The remaining results of the initial request can be seen by sending
4237
+ # another `ListContainerInstances` request with the returned `nextToken`
4238
+ # value. This value can be between 1 and 100. If this parameter isn't
4239
+ # used, then `ListContainerInstances` returns up to 100 results and a
4218
4240
  # `nextToken` value if applicable.
4219
4241
  #
4220
4242
  # @option params [String] :status
4221
4243
  # Filters the container instances by status. For example, if you specify
4222
4244
  # the `DRAINING` status, the results include only container instances
4223
4245
  # that have been set to `DRAINING` using UpdateContainerInstancesState.
4224
- # If you do not specify this parameter, the default is to include
4246
+ # If you don't specify this parameter, the default is to include
4225
4247
  # container instances set to all states other than `INACTIVE`.
4226
4248
  #
4227
4249
  # @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -4294,13 +4316,13 @@ module Aws::ECS
4294
4316
  # </note>
4295
4317
  #
4296
4318
  # @option params [Integer] :max_results
4297
- # The maximum number of service results returned by `ListServices` in
4319
+ # The maximum number of service results that `ListServices` returned in
4298
4320
  # paginated output. When this parameter is used, `ListServices` only
4299
4321
  # returns `maxResults` results in a single page along with a `nextToken`
4300
4322
  # response element. The remaining results of the initial request can be
4301
4323
  # seen by sending another `ListServices` request with the returned
4302
4324
  # `nextToken` value. This value can be between 1 and 100. If this
4303
- # parameter is not used, then `ListServices` returns up to 10 results
4325
+ # parameter isn't used, then `ListServices` returns up to 10 results
4304
4326
  # and a `nextToken` value if applicable.
4305
4327
  #
4306
4328
  # @option params [String] :launch_type
@@ -4360,9 +4382,9 @@ module Aws::ECS
4360
4382
  # List the tags for an Amazon ECS resource.
4361
4383
  #
4362
4384
  # @option params [required, String] :resource_arn
4363
- # The Amazon Resource Name (ARN) that identifies the resource for which
4364
- # to list the tags. Currently, the supported resources are Amazon ECS
4365
- # tasks, services, task definitions, clusters, and container instances.
4385
+ # The Amazon Resource Name (ARN) that identifies the resource to list
4386
+ # the tags for. Currently, the supported resources are Amazon ECS tasks,
4387
+ # services, task definitions, clusters, and container instances.
4366
4388
  #
4367
4389
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4368
4390
  #
@@ -4409,27 +4431,27 @@ module Aws::ECS
4409
4431
  end
4410
4432
 
4411
4433
  # Returns a list of task definition families that are registered to your
4412
- # account (which may include task definition families that no longer
4413
- # have any `ACTIVE` task definition revisions).
4434
+ # account. This list includes task definition families that no longer
4435
+ # have any `ACTIVE` task definition revisions.
4414
4436
  #
4415
- # You can filter out task definition families that do not contain any
4437
+ # You can filter out task definition families that don't contain any
4416
4438
  # `ACTIVE` task definition revisions by setting the `status` parameter
4417
4439
  # to `ACTIVE`. You can also filter the results with the `familyPrefix`
4418
4440
  # parameter.
4419
4441
  #
4420
4442
  # @option params [String] :family_prefix
4421
- # The `familyPrefix` is a string that is used to filter the results of
4443
+ # The `familyPrefix` is a string that's used to filter the results of
4422
4444
  # `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
4423
4445
  # task definition family names that begin with the `familyPrefix` string
4424
4446
  # are returned.
4425
4447
  #
4426
4448
  # @option params [String] :status
4427
- # The task definition family status with which to filter the
4428
- # `ListTaskDefinitionFamilies` results. By default, both `ACTIVE` and
4429
- # `INACTIVE` task definition families are listed. If this parameter is
4430
- # set to `ACTIVE`, only task definition families that have an `ACTIVE`
4431
- # task definition revision are returned. If this parameter is set to
4432
- # `INACTIVE`, only task definition families that do not have any
4449
+ # The task definition family status to filter the
4450
+ # `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
4451
+ # and `INACTIVE` task definition families are listed. If this parameter
4452
+ # is set to `ACTIVE`, only task definition families that have an
4453
+ # `ACTIVE` task definition revision are returned. If this parameter is
4454
+ # set to `INACTIVE`, only task definition families that do not have any
4433
4455
  # `ACTIVE` task definition revisions are returned. If you paginate the
4434
4456
  # resulting output, be sure to keep the `status` value constant in each
4435
4457
  # subsequent request.
@@ -4448,15 +4470,15 @@ module Aws::ECS
4448
4470
  # </note>
4449
4471
  #
4450
4472
  # @option params [Integer] :max_results
4451
- # The maximum number of task definition family results returned by
4452
- # `ListTaskDefinitionFamilies` in paginated output. When this parameter
4453
- # is used, `ListTaskDefinitions` only returns `maxResults` results in a
4454
- # single page along with a `nextToken` response element. The remaining
4455
- # results of the initial request can be seen by sending another
4456
- # `ListTaskDefinitionFamilies` request with the returned `nextToken`
4457
- # value. This value can be between 1 and 100. If this parameter is not
4458
- # used, then `ListTaskDefinitionFamilies` returns up to 100 results and
4459
- # a `nextToken` value if applicable.
4473
+ # The maximum number of task definition family results that
4474
+ # `ListTaskDefinitionFamilies` returned in paginated output. When this
4475
+ # parameter is used, `ListTaskDefinitions` only returns `maxResults`
4476
+ # results in a single page along with a `nextToken` response element.
4477
+ # The remaining results of the initial request can be seen by sending
4478
+ # another `ListTaskDefinitionFamilies` request with the returned
4479
+ # `nextToken` value. This value can be between 1 and 100. If this
4480
+ # parameter isn't used, then `ListTaskDefinitionFamilies` returns up to
4481
+ # 100 results and a `nextToken` value if applicable.
4460
4482
  #
4461
4483
  # @return [Types::ListTaskDefinitionFamiliesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4462
4484
  #
@@ -4528,27 +4550,26 @@ module Aws::ECS
4528
4550
  # `familyPrefix` parameter or by status with the `status` parameter.
4529
4551
  #
4530
4552
  # @option params [String] :family_prefix
4531
- # The full family name with which to filter the `ListTaskDefinitions`
4532
- # results. Specifying a `familyPrefix` limits the listed task
4533
- # definitions to task definition revisions that belong to that family.
4553
+ # The full family name to filter the `ListTaskDefinitions` results with.
4554
+ # Specifying a `familyPrefix` limits the listed task definitions to task
4555
+ # definition revisions that belong to that family.
4534
4556
  #
4535
4557
  # @option params [String] :status
4536
- # The task definition status with which to filter the
4537
- # `ListTaskDefinitions` results. By default, only `ACTIVE` task
4538
- # definitions are listed. By setting this parameter to `INACTIVE`, you
4539
- # can view task definitions that are `INACTIVE` as long as an active
4540
- # task or service still references them. If you paginate the resulting
4541
- # output, be sure to keep the `status` value constant in each subsequent
4542
- # request.
4558
+ # The task definition status to filter the `ListTaskDefinitions` results
4559
+ # with. By default, only `ACTIVE` task definitions are listed. By
4560
+ # setting this parameter to `INACTIVE`, you can view task definitions
4561
+ # that are `INACTIVE` as long as an active task or service still
4562
+ # references them. If you paginate the resulting output, be sure to keep
4563
+ # the `status` value constant in each subsequent request.
4543
4564
  #
4544
4565
  # @option params [String] :sort
4545
- # The order in which to sort the results. Valid values are `ASC` and
4546
- # `DESC`. By default (`ASC`), task definitions are listed
4547
- # lexicographically by family name and in ascending numerical order by
4548
- # revision so that the newest task definitions in a family are listed
4549
- # last. Setting this parameter to `DESC` reverses the sort order on
4550
- # family name and revision so that the newest task definitions in a
4551
- # family are listed first.
4566
+ # The order to sort the results in. Valid values are `ASC` and `DESC`.
4567
+ # By default, (`ASC`) task definitions are listed lexicographically by
4568
+ # family name and in ascending numerical order by revision so that the
4569
+ # newest task definitions in a family are listed last. Setting this
4570
+ # parameter to `DESC` reverses the sort order on family name and
4571
+ # revision. This is so that the newest task definitions in a family are
4572
+ # listed first.
4552
4573
  #
4553
4574
  # @option params [String] :next_token
4554
4575
  # The `nextToken` value returned from a `ListTaskDefinitions` request
@@ -4563,15 +4584,15 @@ module Aws::ECS
4563
4584
  # </note>
4564
4585
  #
4565
4586
  # @option params [Integer] :max_results
4566
- # The maximum number of task definition results returned by
4567
- # `ListTaskDefinitions` in paginated output. When this parameter is
4568
- # used, `ListTaskDefinitions` only returns `maxResults` results in a
4569
- # single page along with a `nextToken` response element. The remaining
4570
- # results of the initial request can be seen by sending another
4571
- # `ListTaskDefinitions` request with the returned `nextToken` value.
4572
- # This value can be between 1 and 100. If this parameter is not used,
4573
- # then `ListTaskDefinitions` returns up to 100 results and a `nextToken`
4574
- # value if applicable.
4587
+ # The maximum number of task definition results that
4588
+ # `ListTaskDefinitions` returned in paginated output. When this
4589
+ # parameter is used, `ListTaskDefinitions` only returns `maxResults`
4590
+ # results in a single page along with a `nextToken` response element.
4591
+ # The remaining results of the initial request can be seen by sending
4592
+ # another `ListTaskDefinitions` request with the returned `nextToken`
4593
+ # value. This value can be between 1 and 100. If this parameter isn't
4594
+ # used, then `ListTaskDefinitions` returns up to 100 results and a
4595
+ # `nextToken` value if applicable.
4575
4596
  #
4576
4597
  # @return [Types::ListTaskDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4577
4598
  #
@@ -4670,7 +4691,7 @@ module Aws::ECS
4670
4691
  # @option params [String] :next_token
4671
4692
  # The `nextToken` value returned from a `ListTasks` request indicating
4672
4693
  # that more results are available to fulfill the request and further
4673
- # calls will be needed. If `maxResults` was provided, it is possible the
4694
+ # calls will be needed. If `maxResults` was provided, it's possible the
4674
4695
  # number of results to be fewer than `maxResults`.
4675
4696
  #
4676
4697
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
@@ -4680,19 +4701,19 @@ module Aws::ECS
4680
4701
  # </note>
4681
4702
  #
4682
4703
  # @option params [Integer] :max_results
4683
- # The maximum number of task results returned by `ListTasks` in
4704
+ # The maximum number of task results that `ListTasks` returned in
4684
4705
  # paginated output. When this parameter is used, `ListTasks` only
4685
4706
  # returns `maxResults` results in a single page along with a `nextToken`
4686
4707
  # response element. The remaining results of the initial request can be
4687
4708
  # seen by sending another `ListTasks` request with the returned
4688
4709
  # `nextToken` value. This value can be between 1 and 100. If this
4689
- # parameter is not used, then `ListTasks` returns up to 100 results and
4710
+ # parameter isn't used, then `ListTasks` returns up to 100 results and
4690
4711
  # a `nextToken` value if applicable.
4691
4712
  #
4692
4713
  # @option params [String] :started_by
4693
- # The `startedBy` value with which to filter the task results.
4694
- # Specifying a `startedBy` value limits the results to tasks that were
4695
- # started with that value.
4714
+ # The `startedBy` value to filter the task results with. Specifying a
4715
+ # `startedBy` value limits the results to tasks that were started with
4716
+ # that value.
4696
4717
  #
4697
4718
  # @option params [String] :service_name
4698
4719
  # The name of the service to use when filtering the `ListTasks` results.
@@ -4703,12 +4724,12 @@ module Aws::ECS
4703
4724
  # The task desired status to use when filtering the `ListTasks` results.
4704
4725
  # Specifying a `desiredStatus` of `STOPPED` limits the results to tasks
4705
4726
  # that Amazon ECS has set the desired status to `STOPPED`. This can be
4706
- # useful for debugging tasks that are not starting properly or have died
4727
+ # useful for debugging tasks that aren't starting properly or have died
4707
4728
  # or finished. The default status filter is `RUNNING`, which shows tasks
4708
4729
  # that Amazon ECS has set the desired status to `RUNNING`.
4709
4730
  #
4710
4731
  # <note markdown="1"> Although you can filter results based on a desired status of
4711
- # `PENDING`, this does not return any results. Amazon ECS never sets the
4732
+ # `PENDING`, this doesn't return any results. Amazon ECS never sets the
4712
4733
  # desired status of a task to that value (only a task's `lastStatus`
4713
4734
  # may have a value of `PENDING`).
4714
4735
  #
@@ -4791,9 +4812,9 @@ module Aws::ECS
4791
4812
  # basis.
4792
4813
  #
4793
4814
  # If you change the account setting for the root user, the default
4794
- # settings for all of the IAM users and roles for which no individual
4795
- # account setting has been specified are reset. For more information,
4796
- # see [Account Settings][1] in the *Amazon Elastic Container Service
4815
+ # settings for all of the IAM users and roles that no individual account
4816
+ # setting was specified are reset for. For more information, see
4817
+ # [Account Settings][1] in the *Amazon Elastic Container Service
4797
4818
  # Developer Guide*.
4798
4819
  #
4799
4820
  # When `serviceLongArnFormat`, `taskLongArnFormat`, or
@@ -4801,10 +4822,10 @@ module Aws::ECS
4801
4822
  # Name (ARN) and resource ID format of the resource type for a specified
4802
4823
  # IAM user, IAM role, or the root user for an account is affected. The
4803
4824
  # opt-in and opt-out account setting must be set for each Amazon ECS
4804
- # resource separately. The ARN and resource ID format of a resource will
4805
- # be defined by the opt-in status of the IAM user or role that created
4806
- # the resource. You must enable this setting to use Amazon ECS features
4807
- # such as resource tagging.
4825
+ # resource separately. The ARN and resource ID format of a resource is
4826
+ # defined by the opt-in status of the IAM user or role that created the
4827
+ # resource. You must enable this setting to use Amazon ECS features such
4828
+ # as resource tagging.
4808
4829
  #
4809
4830
  # When `awsvpcTrunking` is specified, the elastic network interface
4810
4831
  # (ENI) limit for any new container instances that support the feature
@@ -4994,7 +5015,7 @@ module Aws::ECS
4994
5015
  end
4995
5016
 
4996
5017
  # Create or update an attribute on an Amazon ECS resource. If the
4997
- # attribute does not exist, it is created. If the attribute exists, its
5018
+ # attribute doesn't exist, it's created. If the attribute exists, its
4998
5019
  # value is replaced with the specified value. To delete an attribute,
4999
5020
  # use DeleteAttributes. For more information, see [Attributes][1] in the
5000
5021
  # *Amazon Elastic Container Service Developer Guide*.
@@ -5010,8 +5031,8 @@ module Aws::ECS
5010
5031
  #
5011
5032
  # @option params [required, Array<Types::Attribute>] :attributes
5012
5033
  # The attributes to apply to your resource. You can specify up to 10
5013
- # custom attributes per resource. You can specify up to 10 attributes in
5014
- # a single call.
5034
+ # custom attributes for each resource. You can specify up to 10
5035
+ # attributes in a single call.
5015
5036
  #
5016
5037
  # @return [Types::PutAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5017
5038
  #
@@ -5055,21 +5076,21 @@ module Aws::ECS
5055
5076
  # capacity provider strategy for the cluster. If the specified cluster
5056
5077
  # has existing capacity providers associated with it, you must specify
5057
5078
  # all existing capacity providers in addition to any new ones you want
5058
- # to add. Any existing capacity providers associated with a cluster that
5059
- # are omitted from a PutClusterCapacityProviders API call will be
5060
- # disassociated with the cluster. You can only disassociate an existing
5061
- # capacity provider from a cluster if it's not being used by any
5062
- # existing tasks.
5079
+ # to add. Any existing capacity providers that are associated with a
5080
+ # cluster that are omitted from a PutClusterCapacityProviders API call
5081
+ # will be disassociated with the cluster. You can only disassociate an
5082
+ # existing capacity provider from a cluster if it's not being used by
5083
+ # any existing tasks.
5063
5084
  #
5064
5085
  # When creating a service or running a task on a cluster, if no capacity
5065
5086
  # provider or launch type is specified, then the cluster's default
5066
- # capacity provider strategy is used. It is recommended to define a
5067
- # default capacity provider strategy for your cluster, however you may
5087
+ # capacity provider strategy is used. We recommend that you define a
5088
+ # default capacity provider strategy for your cluster. However, you must
5068
5089
  # specify an empty array (`[]`) to bypass defining a default strategy.
5069
5090
  #
5070
5091
  # @option params [required, String] :cluster
5071
5092
  # The short name or full Amazon Resource Name (ARN) of the cluster to
5072
- # modify the capacity provider settings for. If you do not specify a
5093
+ # modify the capacity provider settings for. If you don't specify a
5073
5094
  # cluster, the default cluster is assumed.
5074
5095
  #
5075
5096
  # @option params [required, Array<String>] :capacity_providers
@@ -5184,8 +5205,8 @@ module Aws::ECS
5184
5205
  # becomes available to place containers on.
5185
5206
  #
5186
5207
  # @option params [String] :cluster
5187
- # The short name or full Amazon Resource Name (ARN) of the cluster with
5188
- # which to register your container instance. If you do not specify a
5208
+ # The short name or full Amazon Resource Name (ARN) of the cluster to
5209
+ # register your container instance with. If you do not specify a
5189
5210
  # cluster, the default cluster is assumed.
5190
5211
  #
5191
5212
  # @option params [String] :instance_identity_document
@@ -5205,7 +5226,7 @@ module Aws::ECS
5205
5226
  #
5206
5227
  # @option params [Types::VersionInfo] :version_info
5207
5228
  # The version information for the Amazon ECS container agent and Docker
5208
- # daemon running on the container instance.
5229
+ # daemon that runs on the container instance.
5209
5230
  #
5210
5231
  # @option params [String] :container_instance_arn
5211
5232
  # The ARN of the container instance (if it was previously registered).
@@ -5221,7 +5242,7 @@ module Aws::ECS
5221
5242
  # @option params [Array<Types::Tag>] :tags
5222
5243
  # The metadata that you apply to the container instance to help you
5223
5244
  # categorize and organize them. Each tag consists of a key and an
5224
- # optional value, both of which you define.
5245
+ # optional value. You define both.
5225
5246
  #
5226
5247
  # The following basic restrictions apply to tags:
5227
5248
  #
@@ -5343,6 +5364,12 @@ module Aws::ECS
5343
5364
  # resp.container_instance.tags #=> Array
5344
5365
  # resp.container_instance.tags[0].key #=> String
5345
5366
  # resp.container_instance.tags[0].value #=> String
5367
+ # resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
5368
+ # resp.container_instance.health_status.details #=> Array
5369
+ # resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
5370
+ # resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
5371
+ # resp.container_instance.health_status.details[0].last_updated #=> Time
5372
+ # resp.container_instance.health_status.details[0].last_status_change #=> Time
5346
5373
  #
5347
5374
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance AWS API Documentation
5348
5375
  #
@@ -5364,9 +5391,9 @@ module Aws::ECS
5364
5391
  # parameter. When you specify an IAM role for a task, its containers can
5365
5392
  # then use the latest versions of the CLI or SDKs to make API requests
5366
5393
  # to the Amazon Web Services services that are specified in the IAM
5367
- # policy associated with the role. For more information, see [IAM Roles
5368
- # for Tasks][2] in the *Amazon Elastic Container Service Developer
5369
- # Guide*.
5394
+ # policy that's associated with the role. For more information, see
5395
+ # [IAM Roles for Tasks][2] in the *Amazon Elastic Container Service
5396
+ # Developer Guide*.
5370
5397
  #
5371
5398
  # You can specify a Docker networking mode for the containers in your
5372
5399
  # task definition with the `networkMode` parameter. The available
@@ -5386,7 +5413,7 @@ module Aws::ECS
5386
5413
  # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
5387
5414
  #
5388
5415
  # @option params [required, String] :family
5389
- # You must specify a `family` for a task definition, which allows you to
5416
+ # You must specify a `family` for a task definition. You can use it
5390
5417
  # track multiple versions of the same task definition. The `family` is
5391
5418
  # used as a name for your task definition. Up to 255 letters (uppercase
5392
5419
  # and lowercase), numbers, underscores, and hyphens are allowed.
@@ -5464,23 +5491,23 @@ module Aws::ECS
5464
5491
  #
5465
5492
  # @option params [Array<Types::Volume>] :volumes
5466
5493
  # A list of volume definitions in JSON format that containers in your
5467
- # task may use.
5494
+ # task might use.
5468
5495
  #
5469
5496
  # @option params [Array<Types::TaskDefinitionPlacementConstraint>] :placement_constraints
5470
5497
  # An array of placement constraint objects to use for the task. You can
5471
- # specify a maximum of 10 constraints per task (this limit includes
5472
- # constraints in the task definition and those specified at runtime).
5498
+ # specify a maximum of 10 constraints for each task. This limit includes
5499
+ # constraints in the task definition and those specified at runtime.
5473
5500
  #
5474
5501
  # @option params [Array<String>] :requires_compatibilities
5475
- # The task launch type that Amazon ECS should validate the task
5476
- # definition against. A client exception is returned if the task
5477
- # definition doesn't validate against the compatibilities specified. If
5478
- # no value is specified, the parameter is omitted from the response.
5502
+ # The task launch type that Amazon ECS validates the task definition
5503
+ # against. A client exception is returned if the task definition
5504
+ # doesn't validate against the compatibilities specified. If no value
5505
+ # is specified, the parameter is omitted from the response.
5479
5506
  #
5480
5507
  # @option params [String] :cpu
5481
5508
  # The number of CPU units used by the task. It can be expressed as an
5482
- # integer using CPU units, for example `1024`, or as a string using
5483
- # vCPUs, for example `1 vCPU` or `1 vcpu`, in a task definition. String
5509
+ # integer using CPU units (for example, `1024`) or as a string using
5510
+ # vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition. String
5484
5511
  # values are converted to an integer indicating the CPU units when the
5485
5512
  # task definition is registered.
5486
5513
  #
@@ -5490,14 +5517,17 @@ module Aws::ECS
5490
5517
  #
5491
5518
  # </note>
5492
5519
  #
5493
- # If you are using the EC2 launch type, this field is optional.
5520
+ # If you're using the EC2 launch type, this field is optional.
5494
5521
  # Supported values are between `128` CPU units (`0.125` vCPUs) and
5495
5522
  # `10240` CPU units (`10` vCPUs).
5496
5523
  #
5497
- # If you are using the Fargate launch type, this field is required and
5524
+ # If you're using the Fargate launch type, this field is required and
5498
5525
  # you must use one of the following values, which determines your range
5499
5526
  # of supported values for the `memory` parameter:
5500
5527
  #
5528
+ # The CPU units cannot be less than 1 vCPU when you use Windows
5529
+ # containers on Fargate.
5530
+ #
5501
5531
  # * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
5502
5532
  # GB), 2048 (2 GB)
5503
5533
  #
@@ -5515,8 +5545,8 @@ module Aws::ECS
5515
5545
  #
5516
5546
  # @option params [String] :memory
5517
5547
  # The amount of memory (in MiB) used by the task. It can be expressed as
5518
- # an integer using MiB, for example `1024`, or as a string using GB, for
5519
- # example `1GB` or `1 GB`, in a task definition. String values are
5548
+ # an integer using MiB (for example ,`1024`) or as a string using GB
5549
+ # (for example, `1GB` or `1 GB`) in a task definition. String values are
5520
5550
  # converted to an integer indicating the MiB when the task definition is
5521
5551
  # registered.
5522
5552
  #
@@ -5529,8 +5559,11 @@ module Aws::ECS
5529
5559
  # If using the EC2 launch type, this field is optional.
5530
5560
  #
5531
5561
  # If using the Fargate launch type, this field is required and you must
5532
- # use one of the following values, which determines your range of
5533
- # supported values for the `cpu` parameter:
5562
+ # use one of the following values. This determines your range of
5563
+ # supported values for the `cpu` parameter.
5564
+ #
5565
+ # The CPU units cannot be less than 1 vCPU when you use Windows
5566
+ # containers on Fargate.
5534
5567
  #
5535
5568
  # * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256
5536
5569
  # (.25 vCPU)
@@ -5550,7 +5583,7 @@ module Aws::ECS
5550
5583
  # @option params [Array<Types::Tag>] :tags
5551
5584
  # The metadata that you apply to the task definition to help you
5552
5585
  # categorize and organize them. Each tag consists of a key and an
5553
- # optional value, both of which you define.
5586
+ # optional value. You define both of them.
5554
5587
  #
5555
5588
  # The following basic restrictions apply to tags:
5556
5589
  #
@@ -6169,12 +6202,12 @@ module Aws::ECS
6169
6202
  # Alternatively, you can use StartTask to use your own scheduler or
6170
6203
  # place tasks manually on specific container instances.
6171
6204
  #
6172
- # The Amazon ECS API follows an eventual consistency model, due to the
6173
- # distributed nature of the system supporting the API. This means that
6174
- # the result of an API command you run that affects your Amazon ECS
6175
- # resources might not be immediately visible to all subsequent commands
6176
- # you run. Keep this in mind when you carry out an API command that
6177
- # immediately follows a previous API command.
6205
+ # The Amazon ECS API follows an eventual consistency model. This is
6206
+ # because the distributed nature of the system supporting the API. This
6207
+ # means that the result of an API command you run that affects your
6208
+ # Amazon ECS resources might not be immediately visible to all
6209
+ # subsequent commands you run. Keep this in mind when you carry out an
6210
+ # API command that immediately follows a previous API command.
6178
6211
  #
6179
6212
  # To manage eventual consistency, you can do the following:
6180
6213
  #
@@ -6210,13 +6243,13 @@ module Aws::ECS
6210
6243
  # providers.
6211
6244
  #
6212
6245
  # @option params [String] :cluster
6213
- # The short name or full Amazon Resource Name (ARN) of the cluster on
6214
- # which to run your task. If you do not specify a cluster, the default
6215
- # cluster is assumed.
6246
+ # The short name or full Amazon Resource Name (ARN) of the cluster to
6247
+ # run your task on. If you do not specify a cluster, the default cluster
6248
+ # is assumed.
6216
6249
  #
6217
6250
  # @option params [Integer] :count
6218
6251
  # The number of instantiations of the specified task to place on your
6219
- # cluster. You can specify up to 10 tasks per call.
6252
+ # cluster. You can specify up to 10 tasks for each call.
6220
6253
  #
6221
6254
  # @option params [Boolean] :enable_ecs_managed_tags
6222
6255
  # Specifies whether to enable Amazon ECS managed tags for the task. For
@@ -6228,7 +6261,7 @@ module Aws::ECS
6228
6261
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
6229
6262
  #
6230
6263
  # @option params [Boolean] :enable_execute_command
6231
- # Whether or not to enable the execute command functionality for the
6264
+ # Determines whether to enable the execute command functionality for the
6232
6265
  # containers in this task. If `true`, this enables execute command
6233
6266
  # functionality on all containers in the task.
6234
6267
  #
@@ -6238,7 +6271,7 @@ module Aws::ECS
6238
6271
  # `family:my-family-name`).
6239
6272
  #
6240
6273
  # @option params [String] :launch_type
6241
- # The infrastructure on which to run your standalone task. For more
6274
+ # The infrastructure to run your standalone task on. For more
6242
6275
  # information, see [Amazon ECS launch types][1] in the *Amazon Elastic
6243
6276
  # Container Service Developer Guide*.
6244
6277
  #
@@ -6254,7 +6287,7 @@ module Aws::ECS
6254
6287
  # The `EC2` launch type runs your tasks on Amazon EC2 instances
6255
6288
  # registered to your cluster.
6256
6289
  #
6257
- # The `EXTERNAL` launch type runs your tasks on your on-premise server
6290
+ # The `EXTERNAL` launch type runs your tasks on your on-premises server
6258
6291
  # or virtual machine (VM) capacity registered to your cluster.
6259
6292
  #
6260
6293
  # A task can use either a launch type or a capacity provider strategy.
@@ -6272,7 +6305,7 @@ module Aws::ECS
6272
6305
  # @option params [Types::NetworkConfiguration] :network_configuration
6273
6306
  # The network configuration for the task. This parameter is required for
6274
6307
  # task definitions that use the `awsvpc` network mode to receive their
6275
- # own elastic network interface, and it is not supported for other
6308
+ # own elastic network interface, and it isn't supported for other
6276
6309
  # network modes. For more information, see [Task networking][1] in the
6277
6310
  # *Amazon Elastic Container Service Developer Guide*.
6278
6311
  #
@@ -6284,7 +6317,7 @@ module Aws::ECS
6284
6317
  # A list of container overrides in JSON format that specify the name of
6285
6318
  # a container in the specified task definition and the overrides it
6286
6319
  # should receive. You can override the default command for a container
6287
- # (that is specified in the task definition or Docker image) with a
6320
+ # (that's specified in the task definition or Docker image) with a
6288
6321
  # `command` override. You can also override existing environment
6289
6322
  # variables (that are specified in the task definition or Docker image)
6290
6323
  # on a container or add new environment variables to it with an
@@ -6295,19 +6328,19 @@ module Aws::ECS
6295
6328
  #
6296
6329
  # @option params [Array<Types::PlacementConstraint>] :placement_constraints
6297
6330
  # An array of placement constraint objects to use for the task. You can
6298
- # specify up to 10 constraints per task (including constraints in the
6299
- # task definition and those specified at runtime).
6331
+ # specify up to 10 constraints for each task (including constraints in
6332
+ # the task definition and those specified at runtime).
6300
6333
  #
6301
6334
  # @option params [Array<Types::PlacementStrategy>] :placement_strategy
6302
6335
  # The placement strategy objects to use for the task. You can specify a
6303
- # maximum of 5 strategy rules per task.
6336
+ # maximum of 5 strategy rules for each task.
6304
6337
  #
6305
6338
  # @option params [String] :platform_version
6306
- # The platform version the task should use. A platform version is only
6307
- # specified for tasks hosted on Fargate. If one is not specified, the
6308
- # `LATEST` platform version is used by default. For more information,
6309
- # see [Fargate platform versions][1] in the *Amazon Elastic Container
6310
- # Service Developer Guide*.
6339
+ # The platform version the task uses. A platform version is only
6340
+ # specified for tasks hosted on Fargate. If one isn't specified, the
6341
+ # `LATEST` platform version is used. For more information, see [Fargate
6342
+ # platform versions][1] in the *Amazon Elastic Container Service
6343
+ # Developer Guide*.
6311
6344
  #
6312
6345
  #
6313
6346
  #
@@ -6315,7 +6348,7 @@ module Aws::ECS
6315
6348
  #
6316
6349
  # @option params [String] :propagate_tags
6317
6350
  # Specifies whether to propagate the tags from the task definition to
6318
- # the task. If no value is specified, the tags are not propagated. Tags
6351
+ # the task. If no value is specified, the tags aren't propagated. Tags
6319
6352
  # can only be propagated to the task during task creation. To add tags
6320
6353
  # to a task after task creation, use the TagResource API action.
6321
6354
  #
@@ -6335,7 +6368,7 @@ module Aws::ECS
6335
6368
  # `startedBy` parameter. You can then identify which tasks belong to
6336
6369
  # that job by filtering the results of a ListTasks call with the
6337
6370
  # `startedBy` value. Up to 36 letters (uppercase and lowercase),
6338
- # numbers, hyphens, and underscores are allowed.
6371
+ # numbers, hyphens (-), and underscores (\_) are allowed.
6339
6372
  #
6340
6373
  # If a task is started by an Amazon ECS service, then the `startedBy`
6341
6374
  # parameter contains the deployment ID of the service that starts it.
@@ -6372,10 +6405,10 @@ module Aws::ECS
6372
6405
  #
6373
6406
  # @option params [required, String] :task_definition
6374
6407
  # The `family` and `revision` (`family:revision`) or full ARN of the
6375
- # task definition to run. If a `revision` is not specified, the latest
6408
+ # task definition to run. If a `revision` isn't specified, the latest
6376
6409
  # `ACTIVE` revision is used.
6377
6410
  #
6378
- # The full ARN value must match the value that you specified ias the
6411
+ # The full ARN value must match the value that you specified as the
6379
6412
  # `Resource` of the IAM principal's permissions policy. For example, if
6380
6413
  # the `Resource` is
6381
6414
  # arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
@@ -6646,14 +6679,14 @@ module Aws::ECS
6646
6679
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html
6647
6680
  #
6648
6681
  # @option params [String] :cluster
6649
- # The short name or full Amazon Resource Name (ARN) of the cluster on
6650
- # which to start your task. If you do not specify a cluster, the default
6682
+ # The short name or full Amazon Resource Name (ARN) of the cluster where
6683
+ # to start your task. If you do not specify a cluster, the default
6651
6684
  # cluster is assumed.
6652
6685
  #
6653
6686
  # @option params [required, Array<String>] :container_instances
6654
6687
  # The container instance IDs or full ARN entries for the container
6655
- # instances on which you would like to place your task. You can specify
6656
- # up to 10 container instances.
6688
+ # instances where you would like to place your task. You can specify up
6689
+ # to 10 container instances.
6657
6690
  #
6658
6691
  # @option params [Boolean] :enable_ecs_managed_tags
6659
6692
  # Specifies whether to enable Amazon ECS managed tags for the task. For
@@ -6682,8 +6715,8 @@ module Aws::ECS
6682
6715
  # @option params [Types::TaskOverride] :overrides
6683
6716
  # A list of container overrides in JSON format that specify the name of
6684
6717
  # a container in the specified task definition and the overrides it
6685
- # should receive. You can override the default command for a container
6686
- # (that is specified in the task definition or Docker image) with a
6718
+ # receives. You can override the default command for a container
6719
+ # (that's specified in the task definition or Docker image) with a
6687
6720
  # `command` override. You can also override existing environment
6688
6721
  # variables (that are specified in the task definition or Docker image)
6689
6722
  # on a container or add new environment variables to it with an
@@ -6696,7 +6729,7 @@ module Aws::ECS
6696
6729
  #
6697
6730
  # @option params [String] :propagate_tags
6698
6731
  # Specifies whether to propagate the tags from the task definition or
6699
- # the service to the task. If no value is specified, the tags are not
6732
+ # the service to the task. If no value is specified, the tags aren't
6700
6733
  # propagated.
6701
6734
  #
6702
6735
  # @option params [String] :reference_id
@@ -6709,9 +6742,9 @@ module Aws::ECS
6709
6742
  # `startedBy` parameter. You can then identify which tasks belong to
6710
6743
  # that job by filtering the results of a ListTasks call with the
6711
6744
  # `startedBy` value. Up to 36 letters (uppercase and lowercase),
6712
- # numbers, hyphens, and underscores are allowed.
6745
+ # numbers, hyphens (-), and underscores (\_) are allowed.
6713
6746
  #
6714
- # If a task is started by an Amazon ECS service, then the `startedBy`
6747
+ # If a task is started by an Amazon ECS service, the `startedBy`
6715
6748
  # parameter contains the deployment ID of the service that starts it.
6716
6749
  #
6717
6750
  # @option params [Array<Types::Tag>] :tags
@@ -6746,7 +6779,7 @@ module Aws::ECS
6746
6779
  #
6747
6780
  # @option params [required, String] :task_definition
6748
6781
  # The `family` and `revision` (`family:revision`) or full ARN of the
6749
- # task definition to start. If a `revision` is not specified, the latest
6782
+ # task definition to start. If a `revision` isn't specified, the latest
6750
6783
  # `ACTIVE` revision is used.
6751
6784
  #
6752
6785
  # @return [Types::StartTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -6973,7 +7006,7 @@ module Aws::ECS
6973
7006
  #
6974
7007
  # @option params [String] :reason
6975
7008
  # An optional message specified when a task is stopped. For example, if
6976
- # you are using a custom scheduler, you can use this parameter to
7009
+ # you're using a custom scheduler, you can use this parameter to
6977
7010
  # specify the reason for stopping the task here, and the message appears
6978
7011
  # in subsequent DescribeTasks API operations on this task. Up to 255
6979
7012
  # characters are allowed in this message.
@@ -7171,7 +7204,7 @@ module Aws::ECS
7171
7204
  # The status of the state change request.
7172
7205
  #
7173
7206
  # @option params [Integer] :exit_code
7174
- # The exit code returned for the state change request.
7207
+ # The exit code that's returned for the state change request.
7175
7208
  #
7176
7209
  # @option params [String] :reason
7177
7210
  # The reason for the state change request.
@@ -7237,22 +7270,23 @@ module Aws::ECS
7237
7270
  # The reason for the state change request.
7238
7271
  #
7239
7272
  # @option params [Array<Types::ContainerStateChange>] :containers
7240
- # Any containers associated with the state change request.
7273
+ # Any containers that's associated with the state change request.
7241
7274
  #
7242
7275
  # @option params [Array<Types::AttachmentStateChange>] :attachments
7243
7276
  # Any attachments associated with the state change request.
7244
7277
  #
7245
7278
  # @option params [Array<Types::ManagedAgentStateChange>] :managed_agents
7246
- # The details for the managed agent associated with the task.
7279
+ # The details for the managed agent that's associated with the task.
7247
7280
  #
7248
7281
  # @option params [Time,DateTime,Date,Integer,String] :pull_started_at
7249
- # The Unix timestamp for when the container image pull began.
7282
+ # The Unix timestamp for the time when the container image pull started.
7250
7283
  #
7251
7284
  # @option params [Time,DateTime,Date,Integer,String] :pull_stopped_at
7252
- # The Unix timestamp for when the container image pull completed.
7285
+ # The Unix timestamp for the time when the container image pull
7286
+ # completed.
7253
7287
  #
7254
7288
  # @option params [Time,DateTime,Date,Integer,String] :execution_stopped_at
7255
- # The Unix timestamp for when the task execution stopped.
7289
+ # The Unix timestamp for the time when the task execution stopped.
7256
7290
  #
7257
7291
  # @return [Types::SubmitTaskStateChangeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7258
7292
  #
@@ -7316,12 +7350,12 @@ module Aws::ECS
7316
7350
  end
7317
7351
 
7318
7352
  # Associates the specified tags to a resource with the specified
7319
- # `resourceArn`. If existing tags on a resource are not specified in the
7320
- # request parameters, they are not changed. When a resource is deleted,
7321
- # the tags associated with that resource are deleted as well.
7353
+ # `resourceArn`. If existing tags on a resource aren't specified in the
7354
+ # request parameters, they aren't changed. When a resource is deleted,
7355
+ # the tags that are associated with that resource are deleted as well.
7322
7356
  #
7323
7357
  # @option params [required, String] :resource_arn
7324
- # The Amazon Resource Name (ARN) of the resource to which to add tags.
7358
+ # The Amazon Resource Name (ARN) of the resource to add tags to.
7325
7359
  # Currently, the supported resources are Amazon ECS capacity providers,
7326
7360
  # tasks, services, task definitions, clusters, and container instances.
7327
7361
  #
@@ -7398,10 +7432,9 @@ module Aws::ECS
7398
7432
  # Deletes specified tags from a resource.
7399
7433
  #
7400
7434
  # @option params [required, String] :resource_arn
7401
- # The Amazon Resource Name (ARN) of the resource from which to delete
7402
- # tags. Currently, the supported resources are Amazon ECS capacity
7403
- # providers, tasks, services, task definitions, clusters, and container
7404
- # instances.
7435
+ # The Amazon Resource Name (ARN) of the resource to delete tags from.
7436
+ # Currently, the supported resources are Amazon ECS capacity providers,
7437
+ # tasks, services, task definitions, clusters, and container instances.
7405
7438
  #
7406
7439
  # @option params [required, Array<String>] :tag_keys
7407
7440
  # The keys of the tags to be removed.
@@ -7446,7 +7479,7 @@ module Aws::ECS
7446
7479
  # The name of the capacity provider to update.
7447
7480
  #
7448
7481
  # @option params [required, Types::AutoScalingGroupProviderUpdate] :auto_scaling_group_provider
7449
- # An object representing the parameters to update for the Auto Scaling
7482
+ # An object that represent the parameters to update for the Auto Scaling
7450
7483
  # group capacity provider.
7451
7484
  #
7452
7485
  # @return [Types::UpdateCapacityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -7593,7 +7626,7 @@ module Aws::ECS
7593
7626
  # @option params [required, Array<Types::ClusterSetting>] :settings
7594
7627
  # The setting to use by default for a cluster. This parameter is used to
7595
7628
  # enable CloudWatch Container Insights for a cluster. If this value is
7596
- # specified, it will override the `containerInsights` value set with
7629
+ # specified, it overrides the `containerInsights` value set with
7597
7630
  # PutAccountSetting or PutAccountSettingDefault.
7598
7631
  #
7599
7632
  # @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -7662,7 +7695,7 @@ module Aws::ECS
7662
7695
  end
7663
7696
 
7664
7697
  # Updates the Amazon ECS container agent on a specified container
7665
- # instance. Updating the Amazon ECS container agent does not interrupt
7698
+ # instance. Updating the Amazon ECS container agent doesn't interrupt
7666
7699
  # running tasks or services on the container instance. The process for
7667
7700
  # updating the agent differs depending on whether your container
7668
7701
  # instance was launched with the Amazon ECS-optimized AMI or another
@@ -7670,10 +7703,10 @@ module Aws::ECS
7670
7703
  #
7671
7704
  # <note markdown="1"> The `UpdateContainerAgent` API isn't supported for container
7672
7705
  # instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI.
7673
- # To update the container agent, you can update the `ecs-init` package
7674
- # which will update the agent. For more information, see [Updating the
7675
- # Amazon ECS container agent][1] in the *Amazon Elastic Container
7676
- # Service Developer Guide*.
7706
+ # To update the container agent, you can update the `ecs-init` package.
7707
+ # This updates the agent. For more information, see [Updating the Amazon
7708
+ # ECS container agent][1] in the *Amazon Elastic Container Service
7709
+ # Developer Guide*.
7677
7710
  #
7678
7711
  # </note>
7679
7712
  #
@@ -7695,7 +7728,7 @@ module Aws::ECS
7695
7728
  #
7696
7729
  # @option params [required, String] :container_instance
7697
7730
  # The container instance ID or full ARN entries for the container
7698
- # instance on which you would like to update the Amazon ECS container
7731
+ # instance where you would like to update the Amazon ECS container
7699
7732
  # agent.
7700
7733
  #
7701
7734
  # @return [Types::UpdateContainerAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -7756,6 +7789,12 @@ module Aws::ECS
7756
7789
  # resp.container_instance.tags #=> Array
7757
7790
  # resp.container_instance.tags[0].key #=> String
7758
7791
  # resp.container_instance.tags[0].value #=> String
7792
+ # resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
7793
+ # resp.container_instance.health_status.details #=> Array
7794
+ # resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
7795
+ # resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
7796
+ # resp.container_instance.health_status.details[0].last_updated #=> Time
7797
+ # resp.container_instance.health_status.details[0].last_status_change #=> Time
7759
7798
  #
7760
7799
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent AWS API Documentation
7761
7800
  #
@@ -7773,7 +7812,7 @@ module Aws::ECS
7773
7812
  # remove an instance from a cluster, for example to perform system
7774
7813
  # updates, update the Docker daemon, or scale down the cluster size.
7775
7814
  #
7776
- # A container instance cannot be changed to `DRAINING` until it has
7815
+ # A container instance can't be changed to `DRAINING` until it has
7777
7816
  # reached an `ACTIVE` status. If the instance is in any other status, an
7778
7817
  # error will be received.
7779
7818
  #
@@ -7797,22 +7836,23 @@ module Aws::ECS
7797
7836
  # minimum is 100%, the service scheduler can't remove existing tasks
7798
7837
  # until the replacement tasks are considered healthy. Tasks for
7799
7838
  # services that do not use a load balancer are considered healthy if
7800
- # they are in the `RUNNING` state. Tasks for services that use a load
7801
- # balancer are considered healthy if they are in the `RUNNING` state
7802
- # and the container instance they are hosted on is reported as healthy
7839
+ # they're in the `RUNNING` state. Tasks for services that use a load
7840
+ # balancer are considered healthy if they're in the `RUNNING` state
7841
+ # and the container instance they're hosted on is reported as healthy
7803
7842
  # by the load balancer.
7804
7843
  #
7805
7844
  # * The `maximumPercent` parameter represents an upper limit on the
7806
- # number of running tasks during task replacement, which enables you
7807
- # to define the replacement batch size. For example, if `desiredCount`
7808
- # is four tasks, a maximum of 200% starts four new tasks before
7809
- # stopping the four tasks to be drained, provided that the cluster
7810
- # resources required to do this are available. If the maximum is 100%,
7811
- # then replacement tasks can't start until the draining tasks have
7845
+ # number of running tasks during task replacement. You can use this to
7846
+ # define the replacement batch size. For example, if `desiredCount` is
7847
+ # four tasks, a maximum of 200% starts four new tasks before stopping
7848
+ # the four tasks to be drained, provided that the cluster resources
7849
+ # required to do this are available. If the maximum is 100%, then
7850
+ # replacement tasks can't start until the draining tasks have
7812
7851
  # stopped.
7813
7852
  #
7814
- # Any `PENDING` or `RUNNING` tasks that do not belong to a service are
7815
- # not affected. You must wait for them to finish or stop them manually.
7853
+ # Any `PENDING` or `RUNNING` tasks that do not belong to a service
7854
+ # aren't affected. You must wait for them to finish or stop them
7855
+ # manually.
7816
7856
  #
7817
7857
  # A container instance has completed draining when it has no more
7818
7858
  # `RUNNING` tasks. You can verify this using ListTasks.
@@ -7830,13 +7870,13 @@ module Aws::ECS
7830
7870
  # A list of container instance IDs or full ARN entries.
7831
7871
  #
7832
7872
  # @option params [required, String] :status
7833
- # The container instance state with which to update the container
7834
- # instance. The only valid values for this action are `ACTIVE` and
7835
- # `DRAINING`. A container instance can only be updated to `DRAINING`
7836
- # status once it has reached an `ACTIVE` state. If a container instance
7837
- # is in `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state
7838
- # you can describe the container instance but will be unable to update
7839
- # the container instance state.
7873
+ # The container instance state to update the container instance with.
7874
+ # The only valid values for this action are `ACTIVE` and `DRAINING`. A
7875
+ # container instance can only be updated to `DRAINING` status once it
7876
+ # has reached an `ACTIVE` state. If a container instance is in
7877
+ # `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you can
7878
+ # describe the container instance but can't update the container
7879
+ # instance state.
7840
7880
  #
7841
7881
  # @return [Types::UpdateContainerInstancesStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7842
7882
  #
@@ -7899,6 +7939,12 @@ module Aws::ECS
7899
7939
  # resp.container_instances[0].tags #=> Array
7900
7940
  # resp.container_instances[0].tags[0].key #=> String
7901
7941
  # resp.container_instances[0].tags[0].value #=> String
7942
+ # resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
7943
+ # resp.container_instances[0].health_status.details #=> Array
7944
+ # resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
7945
+ # resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
7946
+ # resp.container_instances[0].health_status.details[0].last_updated #=> Time
7947
+ # resp.container_instances[0].health_status.details[0].last_status_change #=> Time
7902
7948
  # resp.failures #=> Array
7903
7949
  # resp.failures[0].arn #=> String
7904
7950
  # resp.failures[0].reason #=> String
@@ -7931,15 +7977,15 @@ module Aws::ECS
7931
7977
  # placement constraints and strategies, and health check grace period
7932
7978
  # can be updated using this API. If the network configuration, platform
7933
7979
  # version, or task definition need to be updated, a new CodeDeploy
7934
- # deployment should be created. For more information, see
7935
- # [CreateDeployment][2] in the *CodeDeploy API Reference*.
7980
+ # deployment is created. For more information, see [CreateDeployment][2]
7981
+ # in the *CodeDeploy API Reference*.
7936
7982
  #
7937
7983
  # For services using an external deployment controller, you can update
7938
7984
  # only the desired count, task placement constraints and strategies, and
7939
7985
  # health check grace period using this API. If the launch type, load
7940
7986
  # balancer, network configuration, platform version, or task definition
7941
- # need to be updated, you should create a new task set. For more
7942
- # information, see CreateTaskSet.
7987
+ # need to be updated, create a new task set. For more information, see
7988
+ # CreateTaskSet.
7943
7989
  #
7944
7990
  # You can add to or subtract from the number of instantiations of a task
7945
7991
  # definition in a service by specifying the cluster that the service is
@@ -7953,7 +7999,7 @@ module Aws::ECS
7953
7999
  #
7954
8000
  # <note markdown="1"> If your updated Docker image uses the same tag as what is in the
7955
8001
  # existing task definition for your service (for example,
7956
- # `my_image:latest`), you do not need to create a new revision of your
8002
+ # `my_image:latest`), you don't need to create a new revision of your
7957
8003
  # task definition. You can update the service using the
7958
8004
  # `forceNewDeployment` option. The new tasks launched by the deployment
7959
8005
  # pull the current image/tag combination from your repository when they
@@ -7971,14 +8017,14 @@ module Aws::ECS
7971
8017
  # `desiredCount` temporarily during a deployment. For example, if
7972
8018
  # `desiredCount` is four tasks, a minimum of 50% allows the scheduler
7973
8019
  # to stop two existing tasks before starting two new tasks. Tasks for
7974
- # services that do not use a load balancer are considered healthy if
7975
- # they are in the `RUNNING` state. Tasks for services that use a load
7976
- # balancer are considered healthy if they are in the `RUNNING` state
7977
- # and the container instance they are hosted on is reported as healthy
8020
+ # services that don't use a load balancer are considered healthy if
8021
+ # they're in the `RUNNING` state. Tasks for services that use a load
8022
+ # balancer are considered healthy if they're in the `RUNNING` state
8023
+ # and the container instance they're hosted on is reported as healthy
7978
8024
  # by the load balancer.
7979
8025
  #
7980
8026
  # * The `maximumPercent` parameter represents an upper limit on the
7981
- # number of running tasks during a deployment, which enables you to
8027
+ # number of running tasks during a deployment. You can use it to
7982
8028
  # define the deployment batch size. For example, if `desiredCount` is
7983
8029
  # four tasks, a maximum of 200% starts four new tasks before stopping
7984
8030
  # the four older tasks (provided that the cluster resources required
@@ -7986,21 +8032,21 @@ module Aws::ECS
7986
8032
  #
7987
8033
  # When UpdateService stops a task during a deployment, the equivalent of
7988
8034
  # `docker stop` is issued to the containers running in the task. This
7989
- # results in a `SIGTERM` and a 30-second timeout, after which `SIGKILL`
8035
+ # results in a `SIGTERM` and a 30-second timeout. After this, `SIGKILL`
7990
8036
  # is sent and the containers are forcibly stopped. If the container
7991
8037
  # handles the `SIGTERM` gracefully and exits within 30 seconds from
7992
8038
  # receiving it, no `SIGKILL` is sent.
7993
8039
  #
7994
8040
  # When the service scheduler launches new tasks, it determines task
7995
- # placement in your cluster with the following logic:
8041
+ # placement in your cluster with the following logic.
7996
8042
  #
7997
8043
  # * Determine which of the container instances in your cluster can
7998
- # support your service's task definition (for example, they have the
7999
- # required CPU, memory, ports, and container instance attributes).
8044
+ # support your service's task definition. For example, they have the
8045
+ # required CPU, memory, ports, and container instance attributes.
8000
8046
  #
8001
8047
  # * By default, the service scheduler attempts to balance tasks across
8002
- # Availability Zones in this manner (although you can choose a
8003
- # different placement strategy):
8048
+ # Availability Zones in this manner even though you can choose a
8049
+ # different placement strategy.
8004
8050
  #
8005
8051
  # * Sort the valid container instances by the fewest number of running
8006
8052
  # tasks for this service in the same Availability Zone as the
@@ -8034,8 +8080,8 @@ module Aws::ECS
8034
8080
  #
8035
8081
  # @option params [String] :cluster
8036
8082
  # The short name or full Amazon Resource Name (ARN) of the cluster that
8037
- # your service is running on. If you do not specify a cluster, the
8038
- # default cluster is assumed.
8083
+ # your service runs on. If you do not specify a cluster, the default
8084
+ # cluster is assumed.
8039
8085
  #
8040
8086
  # @option params [required, String] :service
8041
8087
  # The name of the service to update.
@@ -8055,11 +8101,11 @@ module Aws::ECS
8055
8101
  # @option params [Array<Types::CapacityProviderStrategyItem>] :capacity_provider_strategy
8056
8102
  # The capacity provider strategy to update the service to use.
8057
8103
  #
8058
- # If the service is using the default capacity provider strategy for the
8104
+ # if the service uses the default capacity provider strategy for the
8059
8105
  # cluster, the service can be updated to use one or more capacity
8060
8106
  # providers as opposed to the default capacity provider strategy.
8061
- # However, when a service is using a capacity provider strategy that is
8062
- # not the default capacity provider strategy, the service cannot be
8107
+ # However, when a service is using a capacity provider strategy that's
8108
+ # not the default capacity provider strategy, the service can't be
8063
8109
  # updated to use the cluster's default capacity provider strategy.
8064
8110
  #
8065
8111
  # A capacity provider strategy consists of one or more capacity
@@ -8096,9 +8142,9 @@ module Aws::ECS
8096
8142
  # override any existing placement constraints defined for the service.
8097
8143
  # To remove all existing placement constraints, specify an empty array.
8098
8144
  #
8099
- # You can specify a maximum of 10 constraints per task (this limit
8145
+ # You can specify a maximum of 10 constraints for each task. This limit
8100
8146
  # includes constraints in the task definition and those specified at
8101
- # runtime).
8147
+ # runtime.
8102
8148
  #
8103
8149
  # @option params [Array<Types::PlacementStrategy>] :placement_strategy
8104
8150
  # The task placement strategy objects to update the service to use. If
@@ -8107,32 +8153,31 @@ module Aws::ECS
8107
8153
  # the existing placement strategy defined for the service. To remove an
8108
8154
  # existing placement strategy, specify an empty object.
8109
8155
  #
8110
- # You can specify a maximum of five strategy rules per service.
8156
+ # You can specify a maximum of five strategy rules for each service.
8111
8157
  #
8112
8158
  # @option params [String] :platform_version
8113
- # The platform version on which your tasks in the service are running. A
8114
- # platform version is only specified for tasks using the Fargate launch
8115
- # type. If a platform version is not specified, the `LATEST` platform
8116
- # version is used by default. For more information, see [Fargate
8117
- # Platform Versions][1] in the *Amazon Elastic Container Service
8118
- # Developer Guide*.
8159
+ # The platform version that your tasks in the service run on. A platform
8160
+ # version is only specified for tasks using the Fargate launch type. If
8161
+ # a platform version is not specified, the `LATEST` platform version is
8162
+ # used. For more information, see [Fargate Platform Versions][1] in the
8163
+ # *Amazon Elastic Container Service Developer Guide*.
8119
8164
  #
8120
8165
  #
8121
8166
  #
8122
8167
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
8123
8168
  #
8124
8169
  # @option params [Boolean] :force_new_deployment
8125
- # Whether to force a new deployment of the service. Deployments are not
8126
- # forced by default. You can use this option to trigger a new deployment
8127
- # with no service definition changes. For example, you can update a
8128
- # service's tasks to use a newer Docker image with the same image/tag
8129
- # combination (`my_image:latest`) or to roll Fargate tasks onto a newer
8130
- # platform version.
8170
+ # Determines whether to force a new deployment of the service. By
8171
+ # default, deployments aren't forced. You can use this option to start
8172
+ # a new deployment with no service definition changes. For example, you
8173
+ # can update a service's tasks to use a newer Docker image with the
8174
+ # same image/tag combination (`my_image:latest`) or to roll Fargate
8175
+ # tasks onto a newer platform version.
8131
8176
  #
8132
8177
  # @option params [Integer] :health_check_grace_period_seconds
8133
8178
  # The period of time, in seconds, that the Amazon ECS service scheduler
8134
- # should ignore unhealthy Elastic Load Balancing target health checks
8135
- # after a task has first started. This is only valid if your service is
8179
+ # ignores unhealthy Elastic Load Balancing target health checks after a
8180
+ # task has first started. This is only valid if your service is
8136
8181
  # configured to use a load balancer. If your service's tasks take a
8137
8182
  # while to start and respond to Elastic Load Balancing health checks,
8138
8183
  # you can specify a health check grace period of up to 2,147,483,647
@@ -8461,11 +8506,11 @@ module Aws::ECS
8461
8506
  #
8462
8507
  # @option params [required, String] :cluster
8463
8508
  # The short name or full Amazon Resource Name (ARN) of the cluster that
8464
- # hosts the service that the task set exists in.
8509
+ # hosts the service that the task set is found in.
8465
8510
  #
8466
8511
  # @option params [required, String] :service
8467
8512
  # The short name or full Amazon Resource Name (ARN) of the service that
8468
- # the task set exists in.
8513
+ # the task set is found in.
8469
8514
  #
8470
8515
  # @option params [required, String] :task_set
8471
8516
  # The short name or full Amazon Resource Name (ARN) of the task set to
@@ -8558,7 +8603,7 @@ module Aws::ECS
8558
8603
  params: params,
8559
8604
  config: config)
8560
8605
  context[:gem_name] = 'aws-sdk-ecs'
8561
- context[:gem_version] = '1.89.0'
8606
+ context[:gem_version] = '1.90.0'
8562
8607
  Seahorse::Client::Request.new(handlers, context)
8563
8608
  end
8564
8609