docs(client-ecs): Documentation only update for Amazon ECS.

Author: awstools

Diff for: clients/client-ecs/src/models/models_0.ts

@@ -1447,6 +1447,15 @@ export interface DeploymentConfiguration {
    * 					the task towards the minimum healthy percent total.</p>
    *             </li>
    *          </ul>
+   *          <p>The default value for a replica service for
+   * 			<code>minimumHealthyPercent</code> is 100%. The default
+   * 			<code>minimumHealthyPercent</code> value for a service using
+   * 			the <code>DAEMON</code> service schedule is 0% for the CLI,
+   * 			the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.</p>
+   *          <p>The minimum number of healthy tasks during a deployment is the
+   * 			<code>desiredCount</code> multiplied by the
+   * 			<code>minimumHealthyPercent</code>/100, rounded up to the
+   * 			nearest integer value.</p>
    *          <p>If a service is using either the blue/green (<code>CODE_DEPLOY</code>) or
    * 				<code>EXTERNAL</code> deployment types and is running tasks that use the
    * 			EC2 launch type, the <b>minimum healthy
@@ -11534,22 +11543,17 @@ export interface RunTaskRequest {
    * <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
    * 			full ARN of the task definition to run. If a <code>revision</code> isn't specified,
    * 			the latest <code>ACTIVE</code> revision is used.</p>
-   *          <p>When you create a policy for run-task, you can set the resource to be the latest task
-   * 			definition revision, or a specific revision.</p>
    *          <p>The full ARN value must match the value that you specified as the
    * 				<code>Resource</code> of the principal's permissions policy.</p>
-   *          <p>When you specify the policy resource as the latest task definition version (by setting
-   * 			the <code>Resource</code> in the policy to
-   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>),
-   * 			then set this value to
-   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p>
-   *          <p>When you specify the policy resource as a specific task definition version (by setting
-   * 			the <code>Resource</code> in the policy to
-   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code> or
-   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>),
-   * 			then set this value to
-   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code>.</p>
-   *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service developer Guide.</p>
+   *          <p>When you specify a task definition, you must either specify a specific revision, or
+   * 			all revisions in the ARN.</p>
+   *          <p>To specify a specific revision, include the revision number in the ARN. For example,
+   * 			to specify revision 2, use
+   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2</code>.</p>
+   *          <p>To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all
+   * 			revisions, use
+   * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>.</p>
+   *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service Developer Guide.</p>
    * @public
    */
   taskDefinition: string | undefined;

Diff for: codegen/sdk-codegen/aws-models/ecs.json

@@ -4242,7 +4242,7 @@
         "minimumHealthyPercent": {
           "target": "com.amazonaws.ecs#BoxedInteger",
           "traits": {
-            "smithy.api#documentation": "<p>If a service is using the rolling update (<code>ECS</code>) deployment type, the\n\t\t\t\t<code>minimumHealthyPercent</code> represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the <code>RUNNING</code> state during a deployment,\n\t\t\tas a percentage of the <code>desiredCount</code> (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a <code>desiredCount</code> of four tasks and a\n\t\t\t\t<code>minimumHealthyPercent</code> of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks. </p>\n         <p>For services that <i>do not</i> use a load balancer, the following\n\t\t\tshould be noted:</p>\n         <ul>\n            <li>\n               <p>A service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.</p>\n            </li>\n            <li>\n               <p>If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a <code>RUNNING</code>\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.</p>\n            </li>\n            <li>\n               <p>If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings. </p>\n            </li>\n         </ul>\n         <p>For services that <i>do</i> use a load balancer, the following should be\n\t\t\tnoted:</p>\n         <ul>\n            <li>\n               <p>If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.</p>\n            </li>\n            <li>\n               <p>If a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.</p>\n            </li>\n         </ul>\n         <p>If a service is using either the blue/green (<code>CODE_DEPLOY</code>) or\n\t\t\t\t<code>EXTERNAL</code> deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the <b>minimum healthy\n\t\t\t\tpercent</b> value is set to the default value and is used to define the lower\n\t\t\tlimit on the number of the tasks in the service that remain in the <code>RUNNING</code>\n\t\t\tstate while the container instances are in the <code>DRAINING</code> state. If a service\n\t\t\tis using either the blue/green (<code>CODE_DEPLOY</code>) or <code>EXTERNAL</code>\n\t\t\tdeployment types and is running tasks that use the Fargate launch type,\n\t\t\tthe minimum healthy percent value is not used, although it is returned when describing\n\t\t\tyour service.</p>"
+            "smithy.api#documentation": "<p>If a service is using the rolling update (<code>ECS</code>) deployment type, the\n\t\t\t\t<code>minimumHealthyPercent</code> represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the <code>RUNNING</code> state during a deployment,\n\t\t\tas a percentage of the <code>desiredCount</code> (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a <code>desiredCount</code> of four tasks and a\n\t\t\t\t<code>minimumHealthyPercent</code> of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks. </p>\n         <p>For services that <i>do not</i> use a load balancer, the following\n\t\t\tshould be noted:</p>\n         <ul>\n            <li>\n               <p>A service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.</p>\n            </li>\n            <li>\n               <p>If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a <code>RUNNING</code>\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.</p>\n            </li>\n            <li>\n               <p>If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings. </p>\n            </li>\n         </ul>\n         <p>For services that <i>do</i> use a load balancer, the following should be\n\t\t\tnoted:</p>\n         <ul>\n            <li>\n               <p>If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.</p>\n            </li>\n            <li>\n               <p>If a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.</p>\n            </li>\n         </ul>\n         <p>The default value for a replica service for\n\t\t\t<code>minimumHealthyPercent</code> is 100%. The default\n\t\t\t<code>minimumHealthyPercent</code> value for a service using\n\t\t\tthe <code>DAEMON</code> service schedule is 0% for the CLI,\n\t\t\tthe Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.</p>\n         <p>The minimum number of healthy tasks during a deployment is the\n\t\t\t<code>desiredCount</code> multiplied by the\n\t\t\t<code>minimumHealthyPercent</code>/100, rounded up to the\n\t\t\tnearest integer value.</p>\n         <p>If a service is using either the blue/green (<code>CODE_DEPLOY</code>) or\n\t\t\t\t<code>EXTERNAL</code> deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the <b>minimum healthy\n\t\t\t\tpercent</b> value is set to the default value and is used to define the lower\n\t\t\tlimit on the number of the tasks in the service that remain in the <code>RUNNING</code>\n\t\t\tstate while the container instances are in the <code>DRAINING</code> state. If a service\n\t\t\tis using either the blue/green (<code>CODE_DEPLOY</code>) or <code>EXTERNAL</code>\n\t\t\tdeployment types and is running tasks that use the Fargate launch type,\n\t\t\tthe minimum healthy percent value is not used, although it is returned when describing\n\t\t\tyour service.</p>"
           }
         },
         "alarms": {
@@ -9522,7 +9522,7 @@
         "taskDefinition": {
           "target": "com.amazonaws.ecs#String",
           "traits": {
-            "smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull ARN of the task definition to run. If a <code>revision</code> isn't specified,\n\t\t\tthe latest <code>ACTIVE</code> revision is used.</p>\n         <p>When you create a policy for run-task, you can set the resource to be the latest task\n\t\t\tdefinition revision, or a specific revision.</p>\n         <p>The full ARN value must match the value that you specified as the\n\t\t\t\t<code>Resource</code> of the principal's permissions policy.</p>\n         <p>When you specify the policy resource as the latest task definition version (by setting\n\t\t\tthe <code>Resource</code> in the policy to\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>),\n\t\t\tthen set this value to\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p>\n         <p>When you specify the policy resource as a specific task definition version (by setting\n\t\t\tthe <code>Resource</code> in the policy to\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code> or\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>),\n\t\t\tthen set this value to\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code>.</p>\n         <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources\">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service developer Guide.</p>",
+            "smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull ARN of the task definition to run. If a <code>revision</code> isn't specified,\n\t\t\tthe latest <code>ACTIVE</code> revision is used.</p>\n         <p>The full ARN value must match the value that you specified as the\n\t\t\t\t<code>Resource</code> of the principal's permissions policy.</p>\n         <p>When you specify a task definition, you must either specify a specific revision, or\n\t\t\tall revisions in the ARN.</p>\n         <p>To specify a specific revision, include the revision number in the ARN. For example,\n\t\t\tto specify revision 2, use\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2</code>.</p>\n         <p>To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all\n\t\t\trevisions, use\n\t\t\t\t<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>.</p>\n         <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources\">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service Developer Guide.</p>",
             "smithy.api#required": {}
           }
         },