docs(client-ecs): Updating stop-task API to encapsulate containers with custom stop signal

Author: awstools

clients/client-ecs/src/commands/StopTaskCommand.ts

@@ -30,10 +30,12 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare
  * <p>Stops a running task. Any tags associated with the task will be deleted.</p>
  *          <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker
  * 				stop</code> is issued to the containers running in the task. This results in a
- * 				<code>SIGTERM</code> value and a default 30-second timeout, after which the
- * 				<code>SIGKILL</code> value is sent and the containers are forcibly stopped. If the
- * 			container handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds
- * 			from receiving it, no <code>SIGKILL</code> value is sent.</p>
+ * 				stop signal value and a default 30-second timeout, after which the
+ * 				<code>SIGKILL</code> value is sent and the containers are forcibly stopped. This
+ * 				signal can be defined in your container image with the <code>STOPSIGNAL</code> instruction
+ * 				and will default to <code>SIGTERM</code>. If the container handles the <code>SIGTERM</code>
+ * 				value gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> value
+ * 				is sent.</p>
  *          <p>For Windows containers, POSIX signals do not work and runtime stops the container by
  * 			sending a <code>CTRL_SHUTDOWN_EVENT</code>. For more information, see <a href="https://github.com/moby/moby/issues/25982">Unable to react to graceful shutdown
  * 				of (Windows) container #25982</a> on GitHub.</p>

codegen/sdk-codegen/aws-models/ecs.json

@@ -15356,7 +15356,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Stops a running task. Any tags associated with the task will be deleted.</p>\n         <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker\n\t\t\t\tstop</code> is issued to the containers running in the task. This results in a\n\t\t\t\t<code>SIGTERM</code> value and a default 30-second timeout, after which the\n\t\t\t\t<code>SIGKILL</code> value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no <code>SIGKILL</code> value is sent.</p>\n         <p>For Windows containers, POSIX signals do not work and runtime stops the container by\n\t\t\tsending a <code>CTRL_SHUTDOWN_EVENT</code>. For more information, see <a href=\"https://github.com/moby/moby/issues/25982\">Unable to react to graceful shutdown\n\t\t\t\tof (Windows) container #25982</a> on GitHub.</p>\n         <note>\n            <p>The default 30-second timeout can be configured on the Amazon ECS container agent\n\t\t\t\twith the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see\n\t\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the\n\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Stops a running task. Any tags associated with the task will be deleted.</p>\n         <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker\n\t\t\t\tstop</code> is issued to the containers running in the task. This results in a\n\t\t\t\tstop signal value and a default 30-second timeout, after which the\n\t\t\t\t<code>SIGKILL</code> value is sent and the containers are forcibly stopped. This \n\t\t\t\tsignal can be defined in your container image with the <code>STOPSIGNAL</code> instruction\n\t\t\t\tand will default to <code>SIGTERM</code>. If the container handles the <code>SIGTERM</code>\n\t\t\t\tvalue gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> value\n\t\t\t\tis sent.</p>\n         <p>For Windows containers, POSIX signals do not work and runtime stops the container by\n\t\t\tsending a <code>CTRL_SHUTDOWN_EVENT</code>. For more information, see <a href=\"https://github.com/moby/moby/issues/25982\">Unable to react to graceful shutdown\n\t\t\t\tof (Windows) container #25982</a> on GitHub.</p>\n         <note>\n            <p>The default 30-second timeout can be configured on the Amazon ECS container agent\n\t\t\t\twith the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see\n\t\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the\n\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n         </note>",
         "smithy.api#examples": [
           {
             "title": "To stop a task",