Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@aws-sdk/client-ecs
Advanced tools
@aws-sdk/client-ecs - npm Package Compare versions
Comparing version 3.703.0 to 3.708.0
@@ -30,7 +30,9 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used | ||
| * in capacity provider strategies to facilitate cluster auto scaling.</p> | ||
| * <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use | ||
| * the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers. These providers are | ||
| * available to all accounts in the Amazon Web Services Regions that Fargate supports.</p> | ||
| * <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS | ||
| * cluster and are used in capacity provider strategies to facilitate cluster auto | ||
| * scaling.</p> | ||
| * <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on | ||
| * Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers. | ||
| * These providers are available to all accounts in the Amazon Web Services Regions that Fargate | ||
| * supports.</p> | ||
| * @example | ||
@@ -102,12 +104,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -117,3 +120,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -127,6 +131,7 @@ * @throws {@link LimitExceededException} (client fault) | ||
| * @throws {@link UpdateInProgressException} (client fault) | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container instance that's | ||
| * specified. If the container agent becomes disconnected while it's in a transitional stage, such as | ||
| * <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. | ||
| * However, when the agent reconnects, it resumes where it stopped previously.</p> | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container | ||
| * instance that's specified. If the container agent becomes disconnected while it's in a | ||
| * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update | ||
| * process can get stuck in that state. However, when the agent reconnects, it resumes | ||
| * where it stopped previously.</p> | ||
| * | ||
@@ -133,0 +138,0 @@ * @throws {@link ECSServiceException} |
@@ -30,12 +30,12 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when | ||
| * you launch your first container instance. However, you can create your own cluster with a unique | ||
| * name.</p> | ||
| * <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> | ||
| * cluster when you launch your first container instance. However, you can create your own | ||
| * cluster with a unique name.</p> | ||
| * <note> | ||
| * <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation, | ||
| * Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can | ||
| * manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes | ||
| * the call doesn't have permissions to create the service-linked role, it isn't created. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked | ||
| * roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> | ||
| * API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your | ||
| * account. This is so that it can manage required resources in other Amazon Web Services services on | ||
| * your behalf. However, if the user that makes the call doesn't have permissions to | ||
| * create the service-linked role, it isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using | ||
| * service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * </note> | ||
@@ -178,12 +178,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -193,3 +194,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -196,0 +198,0 @@ * @throws {@link NamespaceNotFoundException} (client fault) |
@@ -30,5 +30,6 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Runs and maintains your desired number of tasks from a specified task definition. If the number of | ||
| * tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the | ||
| * task in the specified cluster. To update an existing service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> | ||
| * <p>Runs and maintains your desired number of tasks from a specified task definition. If | ||
| * the number of tasks running in a service drops below the <code>desiredCount</code>, | ||
| * Amazon ECS runs another copy of the task in the specified cluster. To update an existing | ||
| * service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> | ||
| * <note> | ||
@@ -40,13 +41,13 @@ * <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> | ||
| * </note> | ||
| * <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your | ||
| * service behind one or more load balancers. The load balancers distribute traffic across the tasks that | ||
| * are associated with the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load | ||
| * balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a | ||
| * service. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON | ||
| * service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS | ||
| * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Tasks for services that don't use a load balancer are considered healthy if they're in the | ||
| * <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if | ||
| * they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> | ||
| * <p>In addition to maintaining the desired count of tasks in your service, you can | ||
| * optionally run your service behind one or more load balancers. The load balancers | ||
| * distribute traffic across the tasks that are associated with the service. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or | ||
| * updating a service. <code>volumeConfigurations</code> is only supported for REPLICA | ||
| * service and not DAEMON service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Tasks for services that don't use a load balancer are considered healthy if they're in | ||
| * the <code>RUNNING</code> state. Tasks for services that use a load balancer are | ||
| * considered healthy if they're in the <code>RUNNING</code> state and are reported as | ||
| * healthy by the load balancer.</p> | ||
| * <p>There are two service scheduler strategies available:</p> | ||
@@ -56,61 +57,63 @@ * <ul> | ||
| * <p> | ||
| * <code>REPLICA</code> - The replica scheduling strategy places and maintains your | ||
| * desired number of tasks across your cluster. By default, the service scheduler spreads tasks | ||
| * across Availability Zones. You can use task placement strategies and constraints to customize | ||
| * task placement decisions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service | ||
| * scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <code>REPLICA</code> - The replica scheduling strategy places and | ||
| * maintains your desired number of tasks across your cluster. By default, the | ||
| * service scheduler spreads tasks across Availability Zones. You can use task | ||
| * placement strategies and constraints to customize task placement decisions. For | ||
| * more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each | ||
| * active container instance that meets all of the task placement constraints that you specify in | ||
| * your cluster. The service scheduler also evaluates the task placement constraints for running | ||
| * tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, | ||
| * you don't need to specify a desired number of tasks, a task placement strategy, or use Service | ||
| * Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service | ||
| * scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one | ||
| * task on each active container instance that meets all of the task placement | ||
| * constraints that you specify in your cluster. The service scheduler also | ||
| * evaluates the task placement constraints for running tasks. It also stops tasks | ||
| * that don't meet the placement constraints. When using this strategy, you don't | ||
| * need to specify a desired number of tasks, a task placement strategy, or use | ||
| * Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * </li> | ||
| * </ul> | ||
| * <p>You can optionally specify a deployment configuration for your service. The deployment is initiated | ||
| * by changing properties. For example, the deployment might be initiated by the task definition or by | ||
| * your desired count of a service. You can use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>. The default value for a replica service for | ||
| * <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service for | ||
| * <code>minimumHealthyPercent</code> is 0%.</p> | ||
| * <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy percent represents | ||
| * a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state | ||
| * during a deployment. Specifically, it represents it as a percentage of your desired number of tasks | ||
| * (rounded up to the nearest integer). This happens when any of your container instances are in the | ||
| * <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. | ||
| * Using this parameter, you can deploy without using additional cluster capacity. For example, if you set | ||
| * your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler | ||
| * might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in | ||
| * the <code>RUNNING</code> state, tasks for services that don't use a load balancer are considered | ||
| * healthy . If they're in the <code>RUNNING</code> state and reported as healthy by the load balancer, | ||
| * tasks for services that <i>do</i> use a load balancer are considered healthy . The | ||
| * <p>You can optionally specify a deployment configuration for your service. The deployment | ||
| * is initiated by changing properties. For example, the deployment might be initiated by | ||
| * the task definition or by your desired count of a service. You can use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>. The default value for a replica service for | ||
| * <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service | ||
| * for <code>minimumHealthyPercent</code> is 0%.</p> | ||
| * <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy | ||
| * percent represents a lower limit on the number of tasks in a service that must remain in | ||
| * the <code>RUNNING</code> state during a deployment. Specifically, it represents it as a | ||
| * percentage of your desired number of tasks (rounded up to the nearest integer). This | ||
| * happens when any of your container instances are in the <code>DRAINING</code> state if | ||
| * the service contains tasks using the EC2 launch type. Using this | ||
| * parameter, you can deploy without using additional cluster capacity. For example, if you | ||
| * set your service to have desired number of four tasks and a minimum healthy percent of | ||
| * 50%, the scheduler might stop two existing tasks to free up cluster capacity before | ||
| * starting two new tasks. If they're in the <code>RUNNING</code> state, tasks for services | ||
| * that don't use a load balancer are considered healthy . If they're in the | ||
| * <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for | ||
| * services that <i>do</i> use a load balancer are considered healthy . The | ||
| * default value for minimum healthy percent is 100%.</p> | ||
| * <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum | ||
| * percent</b> parameter represents an upper limit on the number of tasks in a service that are | ||
| * allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment. Specifically, it | ||
| * represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). | ||
| * This happens when any of your container instances are in the <code>DRAINING</code> state if the service | ||
| * contains tasks using the EC2 launch type. Using this parameter, you can define the | ||
| * deployment batch size. For example, if your service has a desired number of four tasks and a maximum | ||
| * percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks | ||
| * (provided that the cluster resources required to do this are available). The default value for maximum | ||
| * percent is 200%.</p> | ||
| * <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller | ||
| * types and tasks that use the EC2 launch type, the <b>minimum healthy | ||
| * percent</b> and <b>maximum percent</b> values are used only to | ||
| * define the lower and upper limit on the number of the tasks in the service that remain in the | ||
| * <code>RUNNING</code> state. This is while the container instances are in the <code>DRAINING</code> | ||
| * state. If the tasks in the service use the Fargate launch type, the minimum healthy | ||
| * percent and maximum percent values aren't used. This is the case even if they're currently visible when | ||
| * describing your service.</p> | ||
| * <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify | ||
| * only parameters that aren't controlled at the task set level. The only required parameter is the | ||
| * service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment | ||
| * types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>When the service scheduler launches new tasks, it determines task placement. For information about | ||
| * task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task | ||
| * placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i> | ||
| * <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the | ||
| * number of tasks in a service that are allowed in the <code>RUNNING</code> or | ||
| * <code>PENDING</code> state during a deployment. Specifically, it represents it as a | ||
| * percentage of the desired number of tasks (rounded down to the nearest integer). This | ||
| * happens when any of your container instances are in the <code>DRAINING</code> state if | ||
| * the service contains tasks using the EC2 launch type. Using this | ||
| * parameter, you can define the deployment batch size. For example, if your service has a | ||
| * desired number of four tasks and a maximum percent value of 200%, the scheduler may | ||
| * start four new tasks before stopping the four older tasks (provided that the cluster | ||
| * resources required to do this are available). The default value for maximum percent is | ||
| * 200%.</p> | ||
| * <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> | ||
| * deployment controller types and tasks that use the EC2 launch type, the | ||
| * <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit | ||
| * on the number of the tasks in the service that remain in the <code>RUNNING</code> state. | ||
| * This is while the container instances are in the <code>DRAINING</code> state. If the | ||
| * tasks in the service use the Fargate launch type, the minimum healthy | ||
| * percent and maximum percent values aren't used. This is the case even if they're | ||
| * currently visible when describing your service.</p> | ||
| * <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you | ||
| * can specify only parameters that aren't controlled at the task set level. The only | ||
| * required parameter is the service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>When the service scheduler launches new tasks, it determines task placement. For | ||
| * information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS | ||
| * task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i> | ||
| * </p> | ||
@@ -580,12 +583,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -598,3 +602,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -601,0 +606,0 @@ * @throws {@link NamespaceNotFoundException} (client fault) |
@@ -30,4 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Create a task set in the specified cluster and service. This is used when a service uses the | ||
| * <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment | ||
| * <p>Create a task set in the specified cluster and service. This is used when a service | ||
| * uses the <code>EXTERNAL</code> deployment controller type. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment | ||
| * types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
@@ -37,4 +38,4 @@ * <note> | ||
| * </note> | ||
| * <p>For information about the maximum number of task sets and other quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>For information about the maximum number of task sets and other quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -183,12 +184,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -201,3 +203,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -218,7 +221,8 @@ * @throws {@link NamespaceNotFoundException} (client fault) | ||
| * @throws {@link ServiceNotActiveException} (client fault) | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you have | ||
| * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you | ||
| * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -225,0 +229,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -30,3 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Disables an account setting for a specified user, role, or the root user for an account.</p> | ||
| * <p>Disables an account setting for a specified user, role, or the root user for an | ||
| * account.</p> | ||
| * @example | ||
@@ -62,12 +63,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -77,3 +79,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -80,0 +83,0 @@ * @throws {@link ServerException} (server fault) |
@@ -73,6 +73,8 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
| * @throws {@link TargetNotFoundException} (client fault) | ||
| * <p>The specified target wasn't found. You can view your available container instances with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and | ||
| * <p>The specified target wasn't found. You can view your available container instances | ||
| * with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and | ||
| * Region-specific.</p> | ||
@@ -79,0 +81,0 @@ * |
@@ -32,12 +32,14 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <note> | ||
| * <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are reserved and can't | ||
| * be deleted. You can disassociate them from a cluster using either <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or by deleting the cluster.</p> | ||
| * <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are | ||
| * reserved and can't be deleted. You can disassociate them from a cluster using either | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or by deleting the cluster.</p> | ||
| * </note> | ||
| * <p>Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity | ||
| * provider strategy from all services. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> API can be used to | ||
| * remove a capacity provider from a service's capacity provider strategy. When updating a service, the | ||
| * <code>forceNewDeployment</code> option can be used to ensure that any tasks using the Amazon EC2 | ||
| * instance capacity provided by the capacity provider are transitioned to use the capacity from the | ||
| * remaining capacity providers. Only capacity providers that aren't associated with a cluster can be | ||
| * deleted. To remove a capacity provider from a cluster, you can either use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or delete the cluster.</p> | ||
| * <p>Prior to a capacity provider being deleted, the capacity provider must be removed from | ||
| * the capacity provider strategy from all services. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> API | ||
| * can be used to remove a capacity provider from a service's capacity provider strategy. | ||
| * When updating a service, the <code>forceNewDeployment</code> option can be used to | ||
| * ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity | ||
| * provider are transitioned to use the capacity from the remaining capacity providers. | ||
| * Only capacity providers that aren't associated with a cluster can be deleted. To remove | ||
| * a capacity provider from a cluster, you can either use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or delete the cluster.</p> | ||
| * @example | ||
@@ -91,12 +93,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -106,3 +109,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -109,0 +113,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,9 +30,8 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code> state. Clusters | ||
| * with an <code>INACTIVE</code> status might remain discoverable in your account for a period of time. | ||
| * However, this behavior is subject to change in the future. We don't recommend that you rely on | ||
| * <code>INACTIVE</code> clusters persisting.</p> | ||
| * <p>You must deregister all container instances from this cluster before you may delete it. You can list | ||
| * the container instances in a cluster with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a> | ||
| * and deregister them with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p> | ||
| * <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code> | ||
| * state. Clusters with an <code>INACTIVE</code> status might remain discoverable in your | ||
| * account for a period of time. However, this behavior is subject to change in the future. | ||
| * We don't recommend that you rely on <code>INACTIVE</code> clusters persisting.</p> | ||
| * <p>You must deregister all container instances from this cluster before you may delete | ||
| * it. You can list the container instances in a cluster with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a> and deregister them with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p> | ||
| * @example | ||
@@ -132,12 +131,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -147,8 +147,11 @@ * </ul> | ||
| * @throws {@link ClusterContainsContainerInstancesException} (client fault) | ||
| * <p>You can't delete a cluster that has registered container instances. First, deregister the container | ||
| * instances before you can delete the cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p> | ||
| * <p>You can't delete a cluster that has registered container instances. First, deregister | ||
| * the container instances before you can delete the cluster. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p> | ||
| * | ||
| * @throws {@link ClusterContainsServicesException} (client fault) | ||
| * <p>You can't delete a cluster that contains services. First, update the service to reduce its desired | ||
| * task count to 0, and then delete the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html">DeleteService</a>.</p> | ||
| * <p>You can't delete a cluster that contains services. First, update the service to reduce | ||
| * its desired task count to 0, and then delete the service. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> and | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html">DeleteService</a>.</p> | ||
| * | ||
@@ -162,3 +165,4 @@ * @throws {@link ClusterContainsTasksException} (client fault) | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -169,6 +173,7 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link UpdateInProgressException} (client fault) | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container instance that's | ||
| * specified. If the container agent becomes disconnected while it's in a transitional stage, such as | ||
| * <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. | ||
| * However, when the agent reconnects, it resumes where it stopped previously.</p> | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container | ||
| * instance that's specified. If the container agent becomes disconnected while it's in a | ||
| * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update | ||
| * process can get stuck in that state. However, when the agent reconnects, it resumes | ||
| * where it stopped previously.</p> | ||
| * | ||
@@ -175,0 +180,0 @@ * @throws {@link ECSServiceException} |
@@ -30,19 +30,22 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Deletes a specified service within a cluster. You can delete a service if you have no running tasks | ||
| * in it and the desired task count is zero. If the service is actively maintaining tasks, you can't | ||
| * delete it, and you must update the service to a desired task count of zero. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> | ||
| * <p>Deletes a specified service within a cluster. You can delete a service if you have no | ||
| * running tasks in it and the desired task count is zero. If the service is actively | ||
| * maintaining tasks, you can't delete it, and you must update the service to a desired | ||
| * task count of zero. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> | ||
| * <note> | ||
| * <p>When you delete a service, if there are still running tasks that require cleanup, the service | ||
| * status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer | ||
| * visible in the console or in the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a> API operation. | ||
| * After all tasks have transitioned to either <code>STOPPING</code> or <code>STOPPED</code> status, | ||
| * the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the | ||
| * <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> API operation. However, in the future, <code>INACTIVE</code> services | ||
| * may be cleaned up and purged from Amazon ECS record keeping, and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> calls on | ||
| * those services return a <code>ServiceNotFoundException</code> error.</p> | ||
| * <p>When you delete a service, if there are still running tasks that require cleanup, | ||
| * the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the | ||
| * service is no longer visible in the console or in the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a> | ||
| * API operation. After all tasks have transitioned to either <code>STOPPING</code> or | ||
| * <code>STOPPED</code> status, the service status moves from <code>DRAINING</code> | ||
| * to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or | ||
| * <code>INACTIVE</code> status can still be viewed with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> API operation. However, in the future, | ||
| * <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record | ||
| * keeping, and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> calls on those services return a | ||
| * <code>ServiceNotFoundException</code> error.</p> | ||
| * </note> | ||
| * <important> | ||
| * <p>If you attempt to create a new service with the same name as an existing service in either | ||
| * <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an error.</p> | ||
| * <p>If you attempt to create a new service with the same name as an existing service | ||
| * in either <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an | ||
| * error.</p> | ||
| * </important> | ||
@@ -353,12 +356,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -371,3 +375,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -378,3 +383,4 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -381,0 +387,0 @@ * @throws {@link ECSServiceException} |
@@ -31,18 +31,21 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Deletes one or more task definitions.</p> | ||
| * <p>You must deregister a task definition revision before you delete it. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html">DeregisterTaskDefinition</a>.</p> | ||
| * <p>You must deregister a task definition revision before you delete it. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html">DeregisterTaskDefinition</a>.</p> | ||
| * <p>When you delete a task definition revision, it is immediately transitions from the | ||
| * <code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and services that | ||
| * reference a <code>DELETE_IN_PROGRESS</code> task definition revision continue to run without | ||
| * disruption. Existing services that reference a <code>DELETE_IN_PROGRESS</code> task definition revision | ||
| * can still scale up or down by modifying the service's desired count.</p> | ||
| * <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new tasks or create | ||
| * new services. You also can't update an existing service to reference a <code>DELETE_IN_PROGRESS</code> | ||
| * task definition revision.</p> | ||
| * <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until all the | ||
| * associated tasks and services have been terminated.</p> | ||
| * <p>When you delete all <code>INACTIVE</code> task definition revisions, the task definition name is not | ||
| * displayed in the console and not returned in the API. If a task definition revisions are in the | ||
| * <code>DELETE_IN_PROGRESS</code> state, the task definition name is displayed in the console and | ||
| * returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the | ||
| * next time you create a task definition with that name.</p> | ||
| * <code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and | ||
| * services that reference a <code>DELETE_IN_PROGRESS</code> task definition revision | ||
| * continue to run without disruption. Existing services that reference a | ||
| * <code>DELETE_IN_PROGRESS</code> task definition revision can still scale up or down | ||
| * by modifying the service's desired count.</p> | ||
| * <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new | ||
| * tasks or create new services. You also can't update an existing service to reference a | ||
| * <code>DELETE_IN_PROGRESS</code> task definition revision.</p> | ||
| * <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until | ||
| * all the associated tasks and services have been terminated.</p> | ||
| * <p>When you delete all <code>INACTIVE</code> task definition revisions, the task | ||
| * definition name is not displayed in the console and not returned in the API. If a task | ||
| * definition revisions are in the <code>DELETE_IN_PROGRESS</code> state, the task | ||
| * definition name is displayed in the console and returned in the API. The task definition | ||
| * name is retained by Amazon ECS and the revision is incremented the next time you create a | ||
| * task definition with that name.</p> | ||
| * @example | ||
@@ -356,12 +359,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -371,3 +375,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -374,0 +379,0 @@ * @throws {@link ServerException} (server fault) |
@@ -31,4 +31,3 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Deletes a specified task set within a service. This is used when a service uses the | ||
| * <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment | ||
| * types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -130,12 +129,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -148,3 +148,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -155,10 +156,12 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotActiveException} (client fault) | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you have | ||
| * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you | ||
| * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
| * @throws {@link TaskSetNotFoundException} (client fault) | ||
| * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p> | ||
| * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and | ||
| * Region.</p> | ||
| * | ||
@@ -165,0 +168,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -30,14 +30,15 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer | ||
| * available to run tasks.</p> | ||
| * <p>If you intend to use the container instance for some other purpose after deregistration, we recommend | ||
| * that you stop all of the tasks running on the container instance before deregistration. That prevents | ||
| * any orphaned tasks from consuming resources.</p> | ||
| * <p>Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the | ||
| * EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to | ||
| * stop billing.</p> | ||
| * <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is | ||
| * no longer available to run tasks.</p> | ||
| * <p>If you intend to use the container instance for some other purpose after | ||
| * deregistration, we recommend that you stop all of the tasks running on the container | ||
| * instance before deregistration. That prevents any orphaned tasks from consuming | ||
| * resources.</p> | ||
| * <p>Deregistering a container instance removes the instance from a cluster, but it doesn't | ||
| * terminate the EC2 instance. If you are finished using the instance, be sure to terminate | ||
| * it in the Amazon EC2 console to stop billing.</p> | ||
| * <note> | ||
| * <p>If you terminate a running container instance, Amazon ECS automatically deregisters the instance from | ||
| * your cluster (stopped container instances or instances with disconnected agents aren't | ||
| * automatically deregistered when terminated).</p> | ||
| * <p>If you terminate a running container instance, Amazon ECS automatically deregisters the | ||
| * instance from your cluster (stopped container instances or instances with | ||
| * disconnected agents aren't automatically deregistered when terminated).</p> | ||
| * </note> | ||
@@ -149,12 +150,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -167,3 +169,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -170,0 +173,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,19 +30,20 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Deregisters the specified task definition by family and revision. Upon deregistration, the task | ||
| * definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an | ||
| * <code>INACTIVE</code> task definition continue to run without disruption. Existing services that | ||
| * reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the | ||
| * service's desired count. If you want to delete a task definition revision, you must first deregister | ||
| * the task definition revision.</p> | ||
| * <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new services, and | ||
| * you can't update an existing service to reference an <code>INACTIVE</code> task definition. However, | ||
| * there may be up to a 10-minute window following deregistration where these restrictions have not yet | ||
| * taken effect.</p> | ||
| * <p>Deregisters the specified task definition by family and revision. Upon deregistration, | ||
| * the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that | ||
| * reference an <code>INACTIVE</code> task definition continue to run without disruption. | ||
| * Existing services that reference an <code>INACTIVE</code> task definition can still | ||
| * scale up or down by modifying the service's desired count. If you want to delete a task | ||
| * definition revision, you must first deregister the task definition revision.</p> | ||
| * <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new | ||
| * services, and you can't update an existing service to reference an <code>INACTIVE</code> | ||
| * task definition. However, there may be up to a 10-minute window following deregistration | ||
| * where these restrictions have not yet taken effect.</p> | ||
| * <note> | ||
| * <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your account | ||
| * indefinitely. However, this behavior is subject to change in the future. We don't recommend that | ||
| * you rely on <code>INACTIVE</code> task definitions persisting beyond the lifecycle of any | ||
| * associated tasks and services.</p> | ||
| * <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your | ||
| * account indefinitely. However, this behavior is subject to change in the future. We | ||
| * don't recommend that you rely on <code>INACTIVE</code> task definitions persisting | ||
| * beyond the lifecycle of any associated tasks and services.</p> | ||
| * </note> | ||
| * <p>You must deregister a task definition revision before you delete it. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html">DeleteTaskDefinitions</a>.</p> | ||
| * <p>You must deregister a task definition revision before you delete it. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html">DeleteTaskDefinitions</a>.</p> | ||
| * @example | ||
@@ -342,12 +343,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -357,3 +359,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -360,0 +363,0 @@ * @throws {@link ServerException} (server fault) |
@@ -96,12 +96,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -111,3 +112,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -114,0 +116,0 @@ * @throws {@link ServerException} (server fault) |
@@ -140,12 +140,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -155,3 +156,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -158,0 +160,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,4 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Describes one or more container instances. Returns metadata about each container instance | ||
| * requested.</p> | ||
| * <p>Describes one or more container instances. Returns metadata about each container | ||
| * instance requested.</p> | ||
| * @example | ||
@@ -151,12 +151,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -169,3 +170,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -172,0 +174,0 @@ * @throws {@link ServerException} (server fault) |
@@ -31,3 +31,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Describes one or more of your service deployments.</p> | ||
| * <p>A service deployment happens when you release a software update for the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployments.html">Amazon ECS service deployments</a>.</p> | ||
| * <p>A service deployment happens when you release a software update for the service. For | ||
| * more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployments.html">Amazon ECS service | ||
| * deployments</a>.</p> | ||
| * @example | ||
@@ -130,12 +132,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -148,3 +151,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -155,3 +159,4 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -158,0 +163,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -31,4 +31,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Describes one or more service revisions.</p> | ||
| * <p>A service revision is a version of the service that includes the values for the Amazon ECS | ||
| * resources (for example, task definition) and the environment resources (for example, | ||
| * <p>A service revision is a version of the service that includes the values for the Amazon | ||
| * ECS resources (for example, task definition) and the environment resources (for example, | ||
| * load balancers, subnets, and security groups). For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html">Amazon ECS service revisions</a>.</p> | ||
@@ -203,12 +203,13 @@ * <p>You can't describe a service revision that was created before October 25, 2024.</p> | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -221,3 +222,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -228,3 +230,4 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -231,0 +234,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -348,12 +348,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -366,3 +367,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -369,0 +371,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,8 +30,9 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find | ||
| * information about a specific task definition, or you can simply specify the family to find the latest | ||
| * <code>ACTIVE</code> revision in that family.</p> | ||
| * <p>Describes a task definition. You can specify a <code>family</code> and | ||
| * <code>revision</code> to find information about a specific task definition, or you | ||
| * can simply specify the family to find the latest <code>ACTIVE</code> revision in that | ||
| * family.</p> | ||
| * <note> | ||
| * <p>You can only describe <code>INACTIVE</code> task definitions while an active task or service | ||
| * references them.</p> | ||
| * <p>You can only describe <code>INACTIVE</code> task definitions while an active task | ||
| * or service references them.</p> | ||
| * </note> | ||
@@ -341,12 +342,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -356,3 +358,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -359,0 +362,0 @@ * @throws {@link ServerException} (server fault) |
@@ -32,5 +32,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Currently, stopped tasks appear in the returned results for at least one hour.</p> | ||
| * <p>If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the | ||
| * response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are | ||
| * not included in the response.</p> | ||
| * <p>If you have tasks with tags, and then delete the cluster, the tagged tasks are | ||
| * returned in the response. If you create a new cluster with the same name as the deleted | ||
| * cluster, the tagged tasks are not included in the response.</p> | ||
| * @example | ||
@@ -234,12 +234,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -252,3 +253,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -255,0 +257,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,4 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Describes the task sets in the specified cluster and service. This is used when a service uses the | ||
| * <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment | ||
| * <p>Describes the task sets in the specified cluster and service. This is used when a | ||
| * service uses the <code>EXTERNAL</code> deployment controller type. For more information, | ||
| * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment | ||
| * Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
@@ -143,12 +144,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -161,3 +163,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -168,7 +171,8 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotActiveException} (client fault) | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you have | ||
| * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you | ||
| * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -175,0 +179,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -61,12 +61,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -73,0 +74,0 @@ * </ul> |
@@ -31,7 +31,9 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Runs a command remotely on a container within a task.</p> | ||
| * <p>If you use a condition key in your IAM policy to refine the conditions for the policy statement, | ||
| * for example limit the actions to a specific cluster, you receive an <code>AccessDeniedException</code> | ||
| * when there is a mismatch between the condition key value and the corresponding parameter value.</p> | ||
| * <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using Amazon ECS Exec for debugging</a> in the | ||
| * <i>Amazon ECS Developer Guide</i>. </p> | ||
| * <p>If you use a condition key in your IAM policy to refine the conditions for the | ||
| * policy statement, for example limit the actions to a specific cluster, you receive an | ||
| * <code>AccessDeniedException</code> when there is a mismatch between the condition | ||
| * key value and the corresponding parameter value.</p> | ||
| * <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using Amazon ECS | ||
| * Exec for debugging</a> in the <i>Amazon ECS Developer Guide</i>. | ||
| * </p> | ||
| * @example | ||
@@ -77,12 +79,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -95,3 +98,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -102,4 +106,4 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link TargetNotConnectedException} (client fault) | ||
| * <p>The execute command cannot run. This error can be caused by any of the following configuration | ||
| * issues:</p> | ||
| * <p>The execute command cannot run. This error can be caused by any of the following | ||
| * configuration issues:</p> | ||
| * <ul> | ||
@@ -113,8 +117,8 @@ * <li> | ||
| * <li> | ||
| * <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems | ||
| * Manager Session Manager</p> | ||
| * <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for | ||
| * Systems Manager Session Manager</p> | ||
| * </li> | ||
| * </ul> | ||
| * <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS Exec</a> in | ||
| * the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS | ||
| * Exec</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * | ||
@@ -121,0 +125,0 @@ * @throws {@link ECSServiceException} |
@@ -74,12 +74,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -92,3 +93,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -95,0 +97,0 @@ * @throws {@link ResourceNotFoundException} (client fault) |
@@ -68,12 +68,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -83,3 +84,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -86,0 +88,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,7 +30,8 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify | ||
| * a target type and cluster, <code>ListAttributes</code> returns a list of attribute objects, one for | ||
| * each attribute on each resource. You can filter the list of results to a single attribute name to only | ||
| * return results that have that name. You can also filter the results by attribute name and value. You | ||
| * can do this, for example, to see which container instances in a cluster are running a Linux AMI | ||
| * <p>Lists the attributes for Amazon ECS resources within a specified target type and cluster. | ||
| * When you specify a target type and cluster, <code>ListAttributes</code> returns a list | ||
| * of attribute objects, one for each attribute on each resource. You can filter the list | ||
| * of results to a single attribute name to only return results that have that name. You | ||
| * can also filter the results by attribute name and value. You can do this, for example, | ||
| * to see which container instances in a cluster are running a Linux AMI | ||
| * (<code>ecs.os-type=linux</code>). </p> | ||
@@ -77,3 +78,4 @@ * @example | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -80,0 +82,0 @@ * @throws {@link ECSServiceException} |
@@ -59,12 +59,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -74,3 +75,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -77,0 +79,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,6 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Returns a list of container instances in a specified cluster. You can filter the results of a | ||
| * <code>ListContainerInstances</code> operation with cluster query language statements inside the | ||
| * <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster | ||
| * Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Returns a list of container instances in a specified cluster. You can filter the | ||
| * results of a <code>ListContainerInstances</code> operation with cluster query language | ||
| * statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -66,12 +65,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -84,3 +84,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -87,0 +88,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,3 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>This operation lists all the service deployments that meet the specified filter criteria.</p> | ||
| * <p>This operation lists all the service deployments that meet the specified filter | ||
| * criteria.</p> | ||
| * <p>A service deployment happens when you release a softwre update for the service. You | ||
@@ -86,12 +87,13 @@ * route traffic from the running service revisions to the new service revison and control | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -101,3 +103,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -108,3 +111,4 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -111,0 +115,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -30,6 +30,7 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>This operation lists all of the services that are associated with a Cloud Map namespace. This list | ||
| * might include services in different clusters. In contrast, <code>ListServices</code> can only list | ||
| * services in one cluster at a time. If you need to filter the list of services in a single cluster by | ||
| * various parameters, use <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>This operation lists all of the services that are associated with a Cloud Map | ||
| * namespace. This list might include services in different clusters. In contrast, | ||
| * <code>ListServices</code> can only list services in one cluster at a time. If you | ||
| * need to filter the list of services in a single cluster by various parameters, use | ||
| * <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -64,12 +65,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -79,3 +81,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -82,0 +85,0 @@ * @throws {@link NamespaceNotFoundException} (client fault) |
@@ -30,4 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Returns a list of services. You can filter the results by cluster, launch type, and scheduling | ||
| * strategy.</p> | ||
| * <p>Returns a list of services. You can filter the results by cluster, launch type, and | ||
| * scheduling strategy.</p> | ||
| * @example | ||
@@ -64,12 +64,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -82,3 +83,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -85,0 +87,0 @@ * @throws {@link ServerException} (server fault) |
@@ -60,12 +60,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -78,3 +79,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -81,0 +83,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,7 +30,9 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Returns a list of task definition families that are registered to your account. This list includes | ||
| * task definition families that no longer have any <code>ACTIVE</code> task definition revisions.</p> | ||
| * <p>You can filter out task definition families that don't contain any <code>ACTIVE</code> task | ||
| * definition revisions by setting the <code>status</code> parameter to <code>ACTIVE</code>. You can also | ||
| * filter the results with the <code>familyPrefix</code> parameter.</p> | ||
| * <p>Returns a list of task definition families that are registered to your account. This | ||
| * list includes task definition families that no longer have any <code>ACTIVE</code> task | ||
| * definition revisions.</p> | ||
| * <p>You can filter out task definition families that don't contain any <code>ACTIVE</code> | ||
| * task definition revisions by setting the <code>status</code> parameter to | ||
| * <code>ACTIVE</code>. You can also filter the results with the | ||
| * <code>familyPrefix</code> parameter.</p> | ||
| * @example | ||
@@ -66,12 +68,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -81,3 +84,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -84,0 +88,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,5 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Returns a list of task definitions that are registered to your account. You can filter the results by | ||
| * family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> | ||
| * parameter.</p> | ||
| * <p>Returns a list of task definitions that are registered to your account. You can filter | ||
| * the results by family name with the <code>familyPrefix</code> parameter or by status | ||
| * with the <code>status</code> parameter.</p> | ||
| * @example | ||
@@ -65,12 +65,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -80,3 +81,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -83,0 +85,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,5 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Returns a list of tasks. You can filter the results by cluster, task definition family, container | ||
| * instance, launch type, what IAM principal started the task, or by the desired status of the | ||
| * task.</p> | ||
| * <p>Returns a list of tasks. You can filter the results by cluster, task definition | ||
| * family, container instance, launch type, what IAM principal started the task, or by | ||
| * the desired status of the task.</p> | ||
| * <p>Recently stopped tasks might appear in the returned results. </p> | ||
@@ -70,12 +70,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -88,3 +89,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -95,3 +97,4 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -98,0 +101,0 @@ * @throws {@link ECSServiceException} |
@@ -31,5 +31,6 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Modifies an account setting. Account settings are set on a per-Region basis.</p> | ||
| * <p>If you change the root user account setting, the default settings are reset for users and roles that do | ||
| * not have specified individual account settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account Settings</a> in the | ||
| * <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>If you change the root user account setting, the default settings are reset for users and | ||
| * roles that do not have specified individual account settings. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account | ||
| * Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -66,12 +67,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -81,3 +83,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -84,0 +87,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,4 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Modifies an account setting for all users on an account for whom no individual account setting has | ||
| * been specified. Account settings are set on a per-Region basis.</p> | ||
| * <p>Modifies an account setting for all users on an account for whom no individual account | ||
| * setting has been specified. Account settings are set on a per-Region basis.</p> | ||
| * @example | ||
@@ -63,12 +63,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -78,3 +79,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -81,0 +83,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,5 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If | ||
| * the attribute exists, its value is replaced with the specified value. To delete an attribute, use | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, | ||
| * it's created. If the attribute exists, its value is replaced with the specified value. | ||
| * To delete an attribute, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -73,4 +73,5 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link AttributeLimitExceededException} (client fault) | ||
| * <p>You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource | ||
| * with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListAttributes.html">ListAttributes</a>. You can remove existing attributes on a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>.</p> | ||
| * <p>You can apply up to 10 custom attributes for each resource. You can view the | ||
| * attributes of a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListAttributes.html">ListAttributes</a>. | ||
| * You can remove existing attributes on a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>.</p> | ||
| * | ||
@@ -81,6 +82,8 @@ * @throws {@link ClusterNotFoundException} (client fault) | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
| * @throws {@link TargetNotFoundException} (client fault) | ||
| * <p>The specified target wasn't found. You can view your available container instances with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and | ||
| * <p>The specified target wasn't found. You can view your available container instances | ||
| * with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and | ||
| * Region-specific.</p> | ||
@@ -87,0 +90,0 @@ * |
@@ -30,14 +30,16 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Modifies the available capacity providers and the default capacity provider strategy for a | ||
| * cluster.</p> | ||
| * <p>You must specify both the available capacity providers and a default capacity provider strategy for | ||
| * the cluster. If the specified cluster has existing capacity providers associated with it, you must | ||
| * specify all existing capacity providers in addition to any new ones you want to add. Any existing | ||
| * capacity providers that are associated with a cluster that are omitted from a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API call will be disassociated with the cluster. You can only | ||
| * disassociate an existing capacity provider from a cluster if it's not being used by any existing | ||
| * tasks.</p> | ||
| * <p>When creating a service or running a task on a cluster, if no capacity provider or launch type is | ||
| * specified, then the cluster's default capacity provider strategy is used. We recommend that you define | ||
| * a default capacity provider strategy for your cluster. However, you must specify an empty array | ||
| * (<code>[]</code>) to bypass defining a default strategy.</p> | ||
| * <p>Modifies the available capacity providers and the default capacity provider strategy | ||
| * for a cluster.</p> | ||
| * <p>You must specify both the available capacity providers and a default capacity provider | ||
| * strategy for the cluster. If the specified cluster has existing capacity providers | ||
| * associated with it, you must specify all existing capacity providers in addition to any | ||
| * new ones you want to add. Any existing capacity providers that are associated with a | ||
| * cluster that are omitted from a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API call will be disassociated with the | ||
| * cluster. You can only disassociate an existing capacity provider from a cluster if it's | ||
| * not being used by any existing tasks.</p> | ||
| * <p>When creating a service or running a task on a cluster, if no capacity provider or | ||
| * launch type is specified, then the cluster's default capacity provider strategy is used. | ||
| * We recommend that you define a default capacity provider strategy for your cluster. | ||
| * However, you must specify an empty array (<code>[]</code>) to bypass defining a default | ||
| * strategy.</p> | ||
| * @example | ||
@@ -147,12 +149,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -165,3 +168,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -175,6 +179,7 @@ * @throws {@link ResourceInUseException} (client fault) | ||
| * @throws {@link UpdateInProgressException} (client fault) | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container instance that's | ||
| * specified. If the container agent becomes disconnected while it's in a transitional stage, such as | ||
| * <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. | ||
| * However, when the agent reconnects, it resumes where it stopped previously.</p> | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container | ||
| * instance that's specified. If the container agent becomes disconnected while it's in a | ||
| * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update | ||
| * process can get stuck in that state. However, when the agent reconnects, it resumes | ||
| * where it stopped previously.</p> | ||
| * | ||
@@ -181,0 +186,0 @@ * @throws {@link ECSServiceException} |
@@ -33,4 +33,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * </note> | ||
| * <p>Registers an EC2 instance into the specified cluster. This instance becomes available to place | ||
| * containers on.</p> | ||
| * <p>Registers an EC2 instance into the specified cluster. This instance becomes available | ||
| * to place containers on.</p> | ||
| * @example | ||
@@ -179,12 +179,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -194,3 +195,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -197,0 +199,0 @@ * @throws {@link ServerException} (server fault) |
@@ -31,16 +31,17 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Registers a new task definition from the supplied <code>family</code> and | ||
| * <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the | ||
| * <code>volumes</code> parameter. For more information about task definition parameters and defaults, | ||
| * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task | ||
| * <code>containerDefinitions</code>. Optionally, you can add data volumes to your | ||
| * containers with the <code>volumes</code> parameter. For more information about task | ||
| * definition parameters and defaults, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task | ||
| * Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When you specify a | ||
| * role for a task, its containers can then use the latest versions of the CLI or SDKs to make API | ||
| * requests to the Amazon Web Services services that are specified in the policy that's associated with the role. For | ||
| * more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Roles for Tasks</a> in the | ||
| * <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can specify a Docker networking mode for the containers in your task definition with the | ||
| * <code>networkMode</code> parameter. If you specify the <code>awsvpc</code> network mode, the task | ||
| * is allocated an elastic network interface, and you must specify a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html">NetworkConfiguration</a> when | ||
| * you create a service or run a task with the task definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task | ||
| * Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When | ||
| * you specify a role for a task, its containers can then use the latest versions of the | ||
| * CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the | ||
| * policy that's associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM | ||
| * Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can specify a Docker networking mode for the containers in your task definition | ||
| * with the <code>networkMode</code> parameter. If you specify the <code>awsvpc</code> | ||
| * network mode, the task is allocated an elastic network interface, and you must specify a | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html">NetworkConfiguration</a> when you create a service or run a task with the task | ||
| * definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task Networking</a> | ||
| * in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -603,12 +604,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -618,3 +620,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -621,0 +624,0 @@ * @throws {@link ServerException} (server fault) |
@@ -37,27 +37,29 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * </note> | ||
| * <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using | ||
| * placement constraints and placement strategies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling | ||
| * Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place tasks manually | ||
| * on specific container instances.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a | ||
| * service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS | ||
| * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the | ||
| * system supporting the API. This means that the result of an API command you run that affects your Amazon ECS | ||
| * resources might not be immediately visible to all subsequent commands you run. Keep this in mind when | ||
| * you carry out an API command that immediately follows a previous API command.</p> | ||
| * <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places | ||
| * tasks using placement constraints and placement strategies. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place | ||
| * tasks manually on specific container instances.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or | ||
| * updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>The Amazon ECS API follows an eventual consistency model. This is because of the | ||
| * distributed nature of the system supporting the API. This means that the result of an | ||
| * API command you run that affects your Amazon ECS resources might not be immediately visible | ||
| * to all subsequent commands you run. Keep this in mind when you carry out an API command | ||
| * that immediately follows a previous API command.</p> | ||
| * <p>To manage eventual consistency, you can do the following:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>Confirm the state of the resource before you run a command to modify it. Run the | ||
| * DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough | ||
| * time for the previous command to propagate through the system. To do this, run the | ||
| * DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing | ||
| * gradually up to five minutes of wait time.</p> | ||
| * <p>Confirm the state of the resource before you run a command to modify it. Run | ||
| * the DescribeTasks command using an exponential backoff algorithm to ensure that | ||
| * you allow enough time for the previous command to propagate through the system. | ||
| * To do this, run the DescribeTasks command repeatedly, starting with a couple of | ||
| * seconds of wait time and increasing gradually up to five minutes of wait | ||
| * time.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an | ||
| * accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of | ||
| * wait time, and increase gradually up to about five minutes of wait time.</p> | ||
| * <p>Add wait time between subsequent commands, even if the DescribeTasks command | ||
| * returns an accurate response. Apply an exponential backoff algorithm starting | ||
| * with a couple of seconds of wait time, and increase gradually up to about five | ||
| * minutes of wait time.</p> | ||
| * </li> | ||
@@ -386,12 +388,13 @@ * </ul> | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -405,5 +408,5 @@ * </ul> | ||
| * <p>The <code>RunTask</code> request could not be processed due to conflicts. The provided | ||
| * <code>clientToken</code> is already in use with a different <code>RunTask</code> request. The | ||
| * <code>resourceIds</code> are the existing task ARNs which are already associated with the | ||
| * <code>clientToken</code>. </p> | ||
| * <code>clientToken</code> is already in use with a different <code>RunTask</code> | ||
| * request. The <code>resourceIds</code> are the existing task ARNs which are already | ||
| * associated with the <code>clientToken</code>. </p> | ||
| * <p>To fix this issue:</p> | ||
@@ -415,4 +418,4 @@ * <ul> | ||
| * <li> | ||
| * <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original set of | ||
| * parameters</p> | ||
| * <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original | ||
| * set of parameters</p> | ||
| * </li> | ||
@@ -422,3 +425,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -425,0 +429,0 @@ * @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault) |
@@ -30,4 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Starts a new task from the specified task definition on the specified container instance or | ||
| * instances.</p> | ||
| * <p>Starts a new task from the specified task definition on the specified container | ||
| * instance or instances.</p> | ||
| * <note> | ||
@@ -39,8 +39,6 @@ * <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> | ||
| * </note> | ||
| * <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling | ||
| * Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a | ||
| * service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS | ||
| * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or | ||
| * updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -338,12 +336,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -356,3 +355,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -359,0 +359,0 @@ * @throws {@link ServerException} (server fault) |
@@ -31,14 +31,16 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <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 | ||
| * <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> | ||
| * <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> | ||
| * <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> | ||
| * <note> | ||
| * <p>The default 30-second timeout can be configured on the Amazon ECS container agent with the | ||
| * <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS | ||
| * Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>The default 30-second timeout can be configured on the Amazon ECS container agent with | ||
| * the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the | ||
| * <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * </note> | ||
@@ -230,12 +232,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -248,3 +251,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -251,0 +255,0 @@ * @throws {@link ServerException} (server fault) |
@@ -67,12 +67,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -82,3 +83,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -85,0 +87,0 @@ * @throws {@link ServerException} (server fault) |
@@ -77,12 +77,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -89,0 +90,0 @@ * </ul> |
@@ -101,12 +101,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -116,3 +117,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -119,0 +121,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,5 +30,6 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing | ||
| * tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is | ||
| * deleted, the tags that are associated with that resource are deleted as well.</p> | ||
| * <p>Associates the specified tags to a resource with the specified | ||
| * <code>resourceArn</code>. If existing tags on a resource aren't specified in the | ||
| * request parameters, they aren't changed. When a resource is deleted, the tags that are | ||
| * associated with that resource are deleted as well.</p> | ||
| * @example | ||
@@ -62,12 +63,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -80,3 +82,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -83,0 +86,0 @@ * @throws {@link ResourceNotFoundException} (client fault) |
@@ -56,12 +56,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -74,3 +75,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -77,0 +79,0 @@ * @throws {@link ResourceNotFoundException} (client fault) |
@@ -90,12 +90,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -105,3 +106,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -108,0 +110,0 @@ * @throws {@link ServerException} (server fault) |
@@ -151,12 +151,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -169,3 +170,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -172,0 +174,0 @@ * @throws {@link NamespaceNotFoundException} (client fault) |
@@ -131,12 +131,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -149,3 +150,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -152,0 +154,0 @@ * @throws {@link ServerException} (server fault) |
@@ -30,21 +30,21 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container | ||
| * agent doesn't interrupt running tasks or services on the container instance. The process for updating | ||
| * the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized | ||
| * AMI or another operating system.</p> | ||
| * <p>Updates the Amazon ECS container agent on a specified container instance. Updating the | ||
| * Amazon ECS container agent doesn't interrupt running tasks or services on the container | ||
| * instance. The process for updating the agent differs depending on whether your container | ||
| * instance was launched with the Amazon ECS-optimized AMI or another operating system.</p> | ||
| * <note> | ||
| * <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances using the | ||
| * Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the | ||
| * <code>ecs-init</code> package. This updates the agent. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating | ||
| * the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances | ||
| * using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, | ||
| * you can update the <code>ecs-init</code> package. This updates the agent. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the | ||
| * Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * </note> | ||
| * <note> | ||
| * <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not apply to Windows | ||
| * container instances. We recommend that you launch new container instances to update the agent | ||
| * version in your Windows clusters.</p> | ||
| * <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not | ||
| * apply to Windows container instances. We recommend that you launch new container | ||
| * instances to update the agent version in your Windows clusters.</p> | ||
| * </note> | ||
| * <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with | ||
| * the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on | ||
| * other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating | ||
| * the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon | ||
| * Linux AMI with the <code>ecs-init</code> service installed and running. For help | ||
| * updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -154,12 +154,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -172,13 +173,15 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
| * @throws {@link MissingVersionException} (client fault) | ||
| * <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and | ||
| * doesn't have enough information to proceed with an update. This could be because the agent running on | ||
| * the container instance is a previous or custom version that doesn't use our version information.</p> | ||
| * <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the | ||
| * container instance and doesn't have enough information to proceed with an update. This | ||
| * could be because the agent running on the container instance is a previous or custom | ||
| * version that doesn't use our version information.</p> | ||
| * | ||
| * @throws {@link NoUpdateAvailableException} (client fault) | ||
| * <p>There's no update available for this Amazon ECS container agent. This might be because the agent is | ||
| * already running the latest version or because it's so old that there's no update path to the current | ||
| * version.</p> | ||
| * <p>There's no update available for this Amazon ECS container agent. This might be because the | ||
| * agent is already running the latest version or because it's so old that there's no | ||
| * update path to the current version.</p> | ||
| * | ||
@@ -189,6 +192,7 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link UpdateInProgressException} (client fault) | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container instance that's | ||
| * specified. If the container agent becomes disconnected while it's in a transitional stage, such as | ||
| * <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. | ||
| * However, when the agent reconnects, it resumes where it stopped previously.</p> | ||
| * <p>There's already a current Amazon ECS container agent update in progress on the container | ||
| * instance that's specified. If the container agent becomes disconnected while it's in a | ||
| * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update | ||
| * process can get stuck in that state. However, when the agent reconnects, it resumes | ||
| * where it stopped previously.</p> | ||
| * | ||
@@ -195,0 +199,0 @@ * @throws {@link ECSServiceException} |
@@ -31,18 +31,20 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Modifies the status of an Amazon ECS container instance.</p> | ||
| * <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a | ||
| * container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example | ||
| * to perform system updates, update the Docker daemon, or scale down the cluster size.</p> | ||
| * <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the | ||
| * status of a container instance to <code>DRAINING</code> to manually remove an instance | ||
| * from a cluster, for example to perform system updates, update the Docker daemon, or | ||
| * scale down the cluster size.</p> | ||
| * <important> | ||
| * <p>A container instance can't be changed to <code>DRAINING</code> until it has reached an | ||
| * <code>ACTIVE</code> status. If the instance is in any other status, an error will be | ||
| * received.</p> | ||
| * <p>A container instance can't be changed to <code>DRAINING</code> until it has | ||
| * reached an <code>ACTIVE</code> status. If the instance is in any other status, an | ||
| * error will be received.</p> | ||
| * </important> | ||
| * <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being | ||
| * scheduled for placement on the container instance and replacement service tasks are started on other | ||
| * container instances in the cluster if the resources are available. Service tasks on the container | ||
| * instance that are in the <code>PENDING</code> state are stopped immediately.</p> | ||
| * <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and | ||
| * replaced according to the service's deployment configuration parameters, | ||
| * <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment | ||
| * configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> | ||
| * <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks | ||
| * from being scheduled for placement on the container instance and replacement service | ||
| * tasks are started on other container instances in the cluster if the resources are | ||
| * available. Service tasks on the container instance that are in the <code>PENDING</code> | ||
| * state are stopped immediately.</p> | ||
| * <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are | ||
| * stopped and replaced according to the service's deployment configuration parameters, | ||
| * <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change | ||
| * the deployment configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> | ||
| * <ul> | ||
@@ -52,26 +54,28 @@ * <li> | ||
| * <code>desiredCount</code> temporarily during task replacement. For example, | ||
| * <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two | ||
| * existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler | ||
| * can't remove existing tasks until the replacement tasks are considered healthy. Tasks for | ||
| * services that do not use a load balancer are considered healthy if they're in the | ||
| * <code>RUNNING</code> state. Tasks for services that use a load balancer are considered | ||
| * healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load | ||
| * balancer.</p> | ||
| * <code>desiredCount</code> is four tasks, a minimum of 50% allows the | ||
| * scheduler to stop two existing tasks before starting two new tasks. If the | ||
| * minimum is 100%, the service scheduler can't remove existing tasks until the | ||
| * replacement tasks are considered healthy. Tasks for services that do not use a | ||
| * load balancer are considered healthy if they're in the <code>RUNNING</code> | ||
| * state. Tasks for services that use a load balancer are considered healthy if | ||
| * they're in the <code>RUNNING</code> state and are reported as healthy by the | ||
| * load balancer.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running | ||
| * tasks during task replacement. You can use this to define the replacement batch size. For | ||
| * example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks | ||
| * before stopping the four tasks to be drained, provided that the cluster resources required to | ||
| * do this are available. If the maximum is 100%, then replacement tasks can't start until the | ||
| * draining tasks have stopped.</p> | ||
| * <p>The <code>maximumPercent</code> parameter represents an upper limit on the | ||
| * number of running tasks during task replacement. You can use this to define the | ||
| * replacement batch size. For example, if <code>desiredCount</code> is four tasks, | ||
| * a maximum of 200% starts four new tasks before stopping the four tasks to be | ||
| * drained, provided that the cluster resources required to do this are available. | ||
| * If the maximum is 100%, then replacement tasks can't start until the draining | ||
| * tasks have stopped.</p> | ||
| * </li> | ||
| * </ul> | ||
| * <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service aren't | ||
| * affected. You must wait for them to finish or stop them manually.</p> | ||
| * <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can | ||
| * verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p> | ||
| * <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code> | ||
| * status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the | ||
| * instance again.</p> | ||
| * <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service | ||
| * aren't affected. You must wait for them to finish or stop them manually.</p> | ||
| * <p>A container instance has completed draining when it has no more <code>RUNNING</code> | ||
| * tasks. You can verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p> | ||
| * <p>When a container instance has been drained, you can set a container instance to | ||
| * <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler | ||
| * can begin scheduling tasks on the instance again.</p> | ||
| * @example | ||
@@ -193,12 +197,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -211,3 +216,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -214,0 +220,0 @@ * @throws {@link ServerException} (server fault) |
@@ -34,45 +34,46 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * </note> | ||
| * <p>For services using the rolling update (<code>ECS</code>) you can update the desired count, deployment | ||
| * configuration, network configuration, load balancers, service registries, enable ECS managed tags | ||
| * option, propagate tags option, task placement constraints and strategies, and task definition. When you | ||
| * update any of these parameters, Amazon ECS starts new tasks with the new configuration. </p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a | ||
| * task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS | ||
| * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. You can update your volume configurations and trigger a new | ||
| * deployment. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON | ||
| * service. If you leave <code>volumeConfigurations</code> | ||
| * <code>null</code>, it doesn't trigger a new deployment. For more infomation on volumes, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS | ||
| * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the desired | ||
| * count, deployment configuration, health check grace period, task placement constraints and strategies, | ||
| * enable ECS managed tags option, and propagate tags can be updated using this API. If the network | ||
| * configuration, platform version, task definition, or load balancer need to be updated, create a new | ||
| * CodeDeploy deployment. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the | ||
| * <i>CodeDeploy API Reference</i>.</p> | ||
| * <p>For services using an external deployment controller, you can update only the desired count, task | ||
| * placement constraints and strategies, health check grace period, enable ECS managed tags option, and | ||
| * propagate tags option, using this API. If the launch type, load balancer, network configuration, | ||
| * platform version, or task definition need to be updated, create a new task set For more information, | ||
| * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.</p> | ||
| * <p>You can add to or subtract from the number of instantiations of a task definition in a service by | ||
| * specifying the cluster that the service is running in and a new <code>desiredCount</code> | ||
| * parameter.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a | ||
| * task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS | ||
| * volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>If you have updated the container image of your application, you can create a new task definition | ||
| * with that image and deploy it to your service. The service scheduler uses the minimum healthy percent | ||
| * and maximum percent parameters (in the service's deployment configuration) to determine the deployment | ||
| * strategy.</p> | ||
| * <p>For services using the rolling update (<code>ECS</code>) you can update the desired | ||
| * count, deployment configuration, network configuration, load balancers, service | ||
| * registries, enable ECS managed tags option, propagate tags option, task placement | ||
| * constraints and strategies, and task definition. When you update any of these | ||
| * parameters, Amazon ECS starts new tasks with the new configuration. </p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or | ||
| * running a task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. You can update | ||
| * your volume configurations and trigger a new deployment. | ||
| * <code>volumeConfigurations</code> is only supported for REPLICA service and not | ||
| * DAEMON service. If you leave <code>volumeConfigurations</code> | ||
| * <code>null</code>, it doesn't trigger a new deployment. For more infomation on volumes, | ||
| * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, | ||
| * only the desired count, deployment configuration, health check grace period, task | ||
| * placement constraints and strategies, enable ECS managed tags option, and propagate tags | ||
| * can be updated using this API. If the network configuration, platform version, task | ||
| * definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p> | ||
| * <p>For services using an external deployment controller, you can update only the desired | ||
| * count, task placement constraints and strategies, health check grace period, enable ECS | ||
| * managed tags option, and propagate tags option, using this API. If the launch type, load | ||
| * balancer, network configuration, platform version, or task definition need to be | ||
| * updated, create a new task set For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.</p> | ||
| * <p>You can add to or subtract from the number of instantiations of a task definition in a | ||
| * service by specifying the cluster that the service is running in and a new | ||
| * <code>desiredCount</code> parameter.</p> | ||
| * <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or | ||
| * running a task, or when creating or updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>If you have updated the container image of your application, you can create a new task | ||
| * definition with that image and deploy it to your service. The service scheduler uses the | ||
| * minimum healthy percent and maximum percent parameters (in the service's deployment | ||
| * configuration) to determine the deployment strategy.</p> | ||
| * <note> | ||
| * <p>If your updated Docker image uses the same tag as what is in the existing task definition for | ||
| * your service (for example, <code>my_image:latest</code>), you don't need to create a new revision | ||
| * of your task definition. You can update the service using the <code>forceNewDeployment</code> | ||
| * option. The new tasks launched by the deployment pull the current image/tag combination from your | ||
| * repository when they start.</p> | ||
| * <p>If your updated Docker image uses the same tag as what is in the existing task | ||
| * definition for your service (for example, <code>my_image:latest</code>), you don't | ||
| * need to create a new revision of your task definition. You can update the service | ||
| * using the <code>forceNewDeployment</code> option. The new tasks launched by the | ||
| * deployment pull the current image/tag combination from your repository when they | ||
| * start.</p> | ||
| * </note> | ||
| * <p>You can also update the deployment configuration of a service. When a deployment is triggered by | ||
| * updating the task definition of a service, the service scheduler uses the deployment configuration | ||
| * parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the | ||
| * deployment strategy.</p> | ||
| * <p>You can also update the deployment configuration of a service. When a deployment is | ||
| * triggered by updating the task definition of a service, the service scheduler uses the | ||
| * deployment configuration parameters, <code>minimumHealthyPercent</code> and | ||
| * <code>maximumPercent</code>, to determine the deployment strategy.</p> | ||
| * <ul> | ||
@@ -82,43 +83,48 @@ * <li> | ||
| * <code>desiredCount</code> temporarily during a deployment. For example, if | ||
| * <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two | ||
| * existing tasks before starting two new tasks. Tasks for services that don't use a load balancer | ||
| * are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that | ||
| * use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are | ||
| * reported as healthy by the load balancer.</p> | ||
| * <code>desiredCount</code> is four tasks, a minimum of 50% allows the | ||
| * scheduler to stop two existing tasks before starting two new tasks. Tasks for | ||
| * services that don't use a load balancer are considered healthy if they're in the | ||
| * <code>RUNNING</code> state. Tasks for services that use a load balancer are | ||
| * considered healthy if they're in the <code>RUNNING</code> state and are reported | ||
| * as healthy by the load balancer.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running | ||
| * tasks during a deployment. You can use it to define the deployment batch size. For example, if | ||
| * <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before | ||
| * stopping the four older tasks (provided that the cluster resources required to do this are | ||
| * available).</p> | ||
| * <p>The <code>maximumPercent</code> parameter represents an upper limit on the | ||
| * number of running tasks during a deployment. You can use it to define the | ||
| * deployment batch size. For example, if <code>desiredCount</code> is four tasks, | ||
| * a maximum of 200% starts four new tasks before stopping the four older tasks | ||
| * (provided that the cluster resources required to do this are available).</p> | ||
| * </li> | ||
| * </ul> | ||
| * <p>When <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> | ||
| * is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second | ||
| * timeout. After this, <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the | ||
| * container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no | ||
| * <code>SIGKILL</code> is sent.</p> | ||
| * <p>When the service scheduler launches new tasks, it determines task placement in your cluster with the | ||
| * following logic.</p> | ||
| * <p>When <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> | ||
| * stops a task during a deployment, the equivalent of <code>docker stop</code> is issued | ||
| * to the containers running in the task. This results in a <code>SIGTERM</code> and a | ||
| * 30-second timeout. After this, <code>SIGKILL</code> is sent and the containers are | ||
| * forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits | ||
| * within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> | ||
| * <p>When the service scheduler launches new tasks, it determines task placement in your | ||
| * cluster with the following logic.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>Determine which of the container instances in your cluster can support your service's task | ||
| * definition. For example, they have the required CPU, memory, ports, and container instance | ||
| * attributes.</p> | ||
| * <p>Determine which of the container instances in your cluster can support your | ||
| * service's task definition. For example, they have the required CPU, memory, | ||
| * ports, and container instance attributes.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this | ||
| * manner even though you can choose a different placement strategy.</p> | ||
| * <p>By default, the service scheduler attempts to balance tasks across | ||
| * Availability Zones in this manner even though you can choose a different | ||
| * placement strategy.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>Sort the valid container instances by the fewest number of running tasks for this | ||
| * service in the same Availability Zone as the instance. For example, if zone A has one | ||
| * running service task and zones B and C each have zero, valid container instances in | ||
| * either zone B or C are considered optimal for placement.</p> | ||
| * <p>Sort the valid container instances by the fewest number of running | ||
| * tasks for this service in the same Availability Zone as the instance. | ||
| * For example, if zone A has one running service task and zones B and C | ||
| * each have zero, valid container instances in either zone B or C are | ||
| * considered optimal for placement.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>Place the new service task on a valid container instance in an optimal Availability | ||
| * Zone (based on the previous steps), favoring container instances with the fewest number | ||
| * of running tasks for this service.</p> | ||
| * <p>Place the new service task on a valid container instance in an optimal | ||
| * Availability Zone (based on the previous steps), favoring container | ||
| * instances with the fewest number of running tasks for this | ||
| * service.</p> | ||
| * </li> | ||
@@ -128,15 +134,15 @@ * </ul> | ||
| * </ul> | ||
| * <p>When the service scheduler stops running tasks, it attempts to maintain balance across the | ||
| * Availability Zones in your cluster using the following logic: </p> | ||
| * <p>When the service scheduler stops running tasks, it attempts to maintain balance across | ||
| * the Availability Zones in your cluster using the following logic: </p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>Sort the container instances by the largest number of running tasks for this service in the | ||
| * same Availability Zone as the instance. For example, if zone A has one running service task and | ||
| * zones B and C each have two, container instances in either zone B or C are considered optimal | ||
| * for termination.</p> | ||
| * <p>Sort the container instances by the largest number of running tasks for this | ||
| * service in the same Availability Zone as the instance. For example, if zone A | ||
| * has one running service task and zones B and C each have two, container | ||
| * instances in either zone B or C are considered optimal for termination.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous | ||
| * steps), favoring container instances with the largest number of running tasks for this | ||
| * service.</p> | ||
| * <p>Stop the task on a container instance in an optimal Availability Zone (based | ||
| * on the previous steps), favoring container instances with the largest number of | ||
| * running tasks for this service.</p> | ||
| * </li> | ||
@@ -158,3 +164,4 @@ * </ul> | ||
| * </ul> | ||
| * <p>For more information about the role see the <code>CreateService</code> request parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role"> | ||
| * <p>For more information about the role see the <code>CreateService</code> request | ||
| * parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role"> | ||
| * <code>role</code> | ||
@@ -614,12 +621,13 @@ * </a>. </p> | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -632,3 +640,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -649,7 +658,8 @@ * @throws {@link NamespaceNotFoundException} (client fault) | ||
| * @throws {@link ServiceNotActiveException} (client fault) | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you have | ||
| * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you | ||
| * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
@@ -656,0 +666,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -30,5 +30,6 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Modifies which task set in a service is the primary task set. Any parameters that are updated on the | ||
| * primary task set in a service will transition to the service. This is used when a service uses the | ||
| * <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment | ||
| * <p>Modifies which task set in a service is the primary task set. Any parameters that are | ||
| * updated on the primary task set in a service will transition to the service. This is | ||
| * used when a service uses the <code>EXTERNAL</code> deployment controller type. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment | ||
| * Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
@@ -130,12 +131,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -148,3 +150,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -155,10 +158,12 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotActiveException} (client fault) | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you have | ||
| * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you | ||
| * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
| * @throws {@link TaskSetNotFoundException} (client fault) | ||
| * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p> | ||
| * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and | ||
| * Region.</p> | ||
| * | ||
@@ -165,0 +170,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -31,11 +31,13 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Updates the protection status of a task. You can set <code>protectionEnabled</code> to | ||
| * <code>true</code> to protect your task from termination during scale-in events from <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service | ||
| * <code>true</code> to protect your task from termination during scale-in events from | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service | ||
| * Autoscaling</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">deployments</a>.</p> | ||
| * <p>Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the | ||
| * <code>protectionEnabled</code> property making the task eligible for termination by a subsequent | ||
| * scale-in event.</p> | ||
| * <p>You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes | ||
| * (48 hours). To specify the custom expiration period, set the <code>expiresInMinutes</code> property. | ||
| * The <code>expiresInMinutes</code> property is always reset when you invoke this operation for a task | ||
| * that already has <code>protectionEnabled</code> set to <code>true</code>. You can keep extending the | ||
| * <code>protectionEnabled</code> property making the task eligible for termination by | ||
| * a subsequent scale-in event.</p> | ||
| * <p>You can specify a custom expiration period for task protection from 1 minute to up to | ||
| * 2,880 minutes (48 hours). To specify the custom expiration period, set the | ||
| * <code>expiresInMinutes</code> property. The <code>expiresInMinutes</code> property | ||
| * is always reset when you invoke this operation for a task that already has | ||
| * <code>protectionEnabled</code> set to <code>true</code>. You can keep extending the | ||
| * protection expiration period of a task by invoking this operation repeatedly.</p> | ||
@@ -47,9 +49,10 @@ * <p>To learn more about Amazon ECS task protection, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html">Task scale-in | ||
| * <note> | ||
| * <p>This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation | ||
| * for a standalone task will result in an <code>TASK_NOT_VALID</code> failure. For more information, | ||
| * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html">API failure reasons</a>.</p> | ||
| * <p>This operation is only supported for tasks belonging to an Amazon ECS service. Invoking | ||
| * this operation for a standalone task will result in an <code>TASK_NOT_VALID</code> | ||
| * failure. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html">API failure | ||
| * reasons</a>.</p> | ||
| * </note> | ||
| * <important> | ||
| * <p>If you prefer to set task protection from within the container, we recommend using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html">Task scale-in | ||
| * protection endpoint</a>.</p> | ||
| * <p>If you prefer to set task protection from within the container, we recommend using | ||
| * the <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html">Task scale-in protection endpoint</a>.</p> | ||
| * </important> | ||
@@ -101,12 +104,13 @@ * @example | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -119,3 +123,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -122,0 +127,0 @@ * @throws {@link ResourceNotFoundException} (client fault) |
@@ -30,5 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code> deployment controller | ||
| * type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment Types</a> in the | ||
| * <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code> | ||
| * deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment | ||
| * Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @example | ||
@@ -133,12 +133,13 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link ClientException} (client fault) | ||
| * <p>These errors are usually caused by a client action. This client action might be using an action or | ||
| * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might | ||
| * be specifying an identifier that isn't valid.</p> | ||
| * <p>These errors are usually caused by a client action. This client action might be using | ||
| * an action or resource on behalf of a user that doesn't have permissions to use the | ||
| * action or resource. Or, it might be specifying an identifier that isn't valid.</p> | ||
| * <p>The following list includes additional causes for the error:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is | ||
| * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has | ||
| * been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service | ||
| * quotas</a>.</p> | ||
| * <p>The <code>RunTask</code> could not be processed because you use managed | ||
| * scaling and there is a capacity error because the quota of tasks in the | ||
| * <code>PROVISIONING</code> per cluster has been reached. For information | ||
| * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS | ||
| * service quotas</a>.</p> | ||
| * </li> | ||
@@ -151,3 +152,4 @@ * </ul> | ||
| * @throws {@link InvalidParameterException} (client fault) | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> | ||
| * <p>The specified parameter isn't valid. Review the available parameters for the API | ||
| * request.</p> | ||
| * | ||
@@ -158,10 +160,12 @@ * @throws {@link ServerException} (server fault) | ||
| * @throws {@link ServiceNotActiveException} (client fault) | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you have | ||
| * previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * <p>The specified service isn't active. You can't update a service that's inactive. If you | ||
| * have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p> | ||
| * | ||
| * @throws {@link ServiceNotFoundException} (client fault) | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p> | ||
| * <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region | ||
| * specific.</p> | ||
| * | ||
| * @throws {@link TaskSetNotFoundException} (client fault) | ||
| * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p> | ||
| * <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and | ||
| * Region.</p> | ||
| * | ||
@@ -168,0 +172,0 @@ * @throws {@link UnsupportedFeatureException} (client fault) |
@@ -434,13 +434,14 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types"; | ||
| * <fullname>Amazon Elastic Container Service</fullname> | ||
| * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, | ||
| * stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's | ||
| * managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your | ||
| * tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> | ||
| * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes | ||
| * it easy to get the state of your cluster from a centralized service, and gives you access to many | ||
| * familiar Amazon EC2 features.</p> | ||
| * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource | ||
| * needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your | ||
| * own cluster management and configuration management systems. You also don't need to worry about scaling | ||
| * your management infrastructure. </p> | ||
| * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes | ||
| * it easy to run, stop, and manage Docker containers. You can host your cluster on a | ||
| * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on | ||
| * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) | ||
| * or External (on-premises) instances that you manage.</p> | ||
| * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API | ||
| * calls. This makes it easy to get the state of your cluster from a centralized service, | ||
| * and gives you access to many familiar Amazon EC2 features.</p> | ||
| * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on | ||
| * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you | ||
| * don't need to operate your own cluster management and configuration management systems. | ||
| * You also don't need to worry about scaling your management infrastructure. </p> | ||
| * @public | ||
@@ -447,0 +448,0 @@ */ |
@@ -214,13 +214,14 @@ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header"; | ||
| * <fullname>Amazon Elastic Container Service</fullname> | ||
| * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, | ||
| * stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's | ||
| * managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your | ||
| * tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> | ||
| * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes | ||
| * it easy to get the state of your cluster from a centralized service, and gives you access to many | ||
| * familiar Amazon EC2 features.</p> | ||
| * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource | ||
| * needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your | ||
| * own cluster management and configuration management systems. You also don't need to worry about scaling | ||
| * your management infrastructure. </p> | ||
| * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes | ||
| * it easy to run, stop, and manage Docker containers. You can host your cluster on a | ||
| * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on | ||
| * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) | ||
| * or External (on-premises) instances that you manage.</p> | ||
| * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API | ||
| * calls. This makes it easy to get the state of your cluster from a centralized service, | ||
| * and gives you access to many familiar Amazon EC2 features.</p> | ||
| * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on | ||
| * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you | ||
| * don't need to operate your own cluster management and configuration management systems. | ||
| * You also don't need to worry about scaling your management infrastructure. </p> | ||
| * @public | ||
@@ -227,0 +228,0 @@ */ |
| /** | ||
| * <fullname>Amazon Elastic Container Service</fullname> | ||
| * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, | ||
| * stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's | ||
| * managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your | ||
| * tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> | ||
| * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes | ||
| * it easy to get the state of your cluster from a centralized service, and gives you access to many | ||
| * familiar Amazon EC2 features.</p> | ||
| * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource | ||
| * needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your | ||
| * own cluster management and configuration management systems. You also don't need to worry about scaling | ||
| * your management infrastructure. </p> | ||
| * <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes | ||
| * it easy to run, stop, and manage Docker containers. You can host your cluster on a | ||
| * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on | ||
| * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) | ||
| * or External (on-premises) instances that you manage.</p> | ||
| * <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API | ||
| * calls. This makes it easy to get the state of your cluster from a centralized service, | ||
| * and gives you access to many familiar Amazon EC2 features.</p> | ||
| * <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on | ||
| * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you | ||
| * don't need to operate your own cluster management and configuration management systems. | ||
| * You also don't need to worry about scaling your management infrastructure. </p> | ||
| * | ||
@@ -15,0 +16,0 @@ * @packageDocumentation |
@@ -15,15 +15,15 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>The managed termination protection setting to use for the Auto Scaling group capacity provider. This | ||
| * determines whether the Auto Scaling group has managed termination protection.</p> | ||
| * <p>The managed termination protection setting to use for the Auto Scaling group capacity | ||
| * provider. This determines whether the Auto Scaling group has managed termination | ||
| * protection.</p> | ||
| * <important> | ||
| * <p>When using managed termination protection, managed scaling must also be used otherwise managed | ||
| * termination protection doesn't work.</p> | ||
| * <p>When using managed termination protection, managed scaling must also be used | ||
| * otherwise managed termination protection doesn't work.</p> | ||
| * </important> | ||
| * <p>When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling | ||
| * group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and | ||
| * each instance in the Auto Scaling group must have instance protection from scale-in actions on. For | ||
| * more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection">Instance | ||
| * Protection</a> in the <i>Auto Scaling User Guide</i>.</p> | ||
| * <p>When managed termination protection is off, your Amazon EC2 instances aren't protected from termination | ||
| * when the Auto Scaling group scales in.</p> | ||
| * <p>When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an | ||
| * Auto Scaling group that contain tasks from being terminated during a scale-in action. | ||
| * The Auto Scaling group and each instance in the Auto Scaling group must have instance | ||
| * protection from scale-in actions on. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p> | ||
| * <p>When managed termination protection is off, your Amazon EC2 instances aren't protected from | ||
| * termination when the Auto Scaling group scales in.</p> | ||
| * @public | ||
@@ -120,10 +120,11 @@ */ | ||
| /** | ||
| * <p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container | ||
| * Insights for a cluster. If this value is specified, it overrides the <code>containerInsights</code> | ||
| * value set with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html">PutAccountSetting</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html">PutAccountSettingDefault</a>.</p> | ||
| * <p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch | ||
| * Container Insights for a cluster. If this value is specified, it overrides the | ||
| * <code>containerInsights</code> value set with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html">PutAccountSetting</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html">PutAccountSettingDefault</a>.</p> | ||
| * <important> | ||
| * <p>Currently, if you delete an existing cluster that does not have Container Insights turned on, and | ||
| * then create a new cluster with the same name with Container Insights tuned on, Container Insights | ||
| * will not actually be turned on. If you want to preserve the same name for your existing cluster and | ||
| * turn on Container Insights, you must wait 7 days before you can re-create it.</p> | ||
| * <p>Currently, if you delete an existing cluster that does not have Container Insights | ||
| * turned on, and then create a new cluster with the same name with Container Insights | ||
| * tuned on, Container Insights will not actually be turned on. If you want to preserve | ||
| * the same name for your existing cluster and turn on Container Insights, you must | ||
| * wait 7 days before you can re-create it.</p> | ||
| * </important> | ||
@@ -145,5 +146,6 @@ * @public | ||
| /** | ||
| * <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and | ||
| * doesn't have enough information to proceed with an update. This could be because the agent running on | ||
| * the container instance is a previous or custom version that doesn't use our version information.</p> | ||
| * <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the | ||
| * container instance and doesn't have enough information to proceed with an update. This | ||
| * could be because the agent running on the container instance is a previous or custom | ||
| * version that doesn't use our version information.</p> | ||
| * @public | ||
@@ -160,5 +162,5 @@ */ | ||
| /** | ||
| * <p>There's no update available for this Amazon ECS container agent. This might be because the agent is | ||
| * already running the latest version or because it's so old that there's no update path to the current | ||
| * version.</p> | ||
| * <p>There's no update available for this Amazon ECS container agent. This might be because the | ||
| * agent is already running the latest version or because it's so old that there's no | ||
| * update path to the current version.</p> | ||
| * @public | ||
@@ -179,4 +181,4 @@ */ | ||
| /** | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. | ||
| * If you do not specify a cluster, the default cluster is assumed.</p> | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is | ||
| * running on. If you do not specify a cluster, the default cluster is assumed.</p> | ||
| * @public | ||
@@ -186,4 +188,4 @@ */ | ||
| /** | ||
| * <p>The container instance ID or full ARN entries for the container instance where you would like to | ||
| * update the Amazon ECS container agent.</p> | ||
| * <p>The container instance ID or full ARN entries for the container instance where you | ||
| * would like to update the Amazon ECS container agent.</p> | ||
| * @public | ||
@@ -208,4 +210,4 @@ */ | ||
| /** | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. | ||
| * If you do not specify a cluster, the default cluster is assumed.</p> | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to | ||
| * update. If you do not specify a cluster, the default cluster is assumed.</p> | ||
| * @public | ||
@@ -220,8 +222,8 @@ */ | ||
| /** | ||
| * <p>The container instance state to update the container instance with. The only valid values for this | ||
| * action are <code>ACTIVE</code> and <code>DRAINING</code>. A container instance can only be updated to | ||
| * <code>DRAINING</code> status once it has reached an <code>ACTIVE</code> state. If a container | ||
| * instance is in <code>REGISTERING</code>, <code>DEREGISTERING</code>, or | ||
| * <code>REGISTRATION_FAILED</code> state you can describe the container instance but can't update the | ||
| * container instance state.</p> | ||
| * <p>The container instance state to update the container instance with. The only valid | ||
| * values for this action are <code>ACTIVE</code> and <code>DRAINING</code>. A container | ||
| * instance can only be updated to <code>DRAINING</code> status once it has reached an | ||
| * <code>ACTIVE</code> state. If a container instance is in <code>REGISTERING</code>, | ||
| * <code>DEREGISTERING</code>, or <code>REGISTRATION_FAILED</code> state you can | ||
| * describe the container instance but can't update the container instance state.</p> | ||
| * @public | ||
@@ -262,3 +264,4 @@ */ | ||
| /** | ||
| * <p>The number of instantiations of the task to place and keep running in your service.</p> | ||
| * <p>The number of instantiations of the task to place and keep running in your | ||
| * service.</p> | ||
| * @public | ||
@@ -268,7 +271,7 @@ */ | ||
| /** | ||
| * <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the | ||
| * task definition to run in your service. If a <code>revision</code> is not specified, the latest | ||
| * <code>ACTIVE</code> revision is used. If you modify the task definition with | ||
| * <code>UpdateService</code>, Amazon ECS spawns a task with the new version of the task definition and | ||
| * then stops an old task after the new version is running.</p> | ||
| * <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or | ||
| * full ARN of the task definition to run in your service. If a <code>revision</code> is | ||
| * not specified, the latest <code>ACTIVE</code> revision is used. If you modify the task | ||
| * definition with <code>UpdateService</code>, Amazon ECS spawns a task with the new version of | ||
| * the task definition and then stops an old task after the new version is running.</p> | ||
| * @public | ||
@@ -279,17 +282,21 @@ */ | ||
| * <p>The capacity provider strategy to update the service to use.</p> | ||
| * <p>if the service uses the default capacity provider strategy for the cluster, the service can be | ||
| * updated to use one or more capacity providers as opposed to the default capacity provider strategy. | ||
| * However, when a service is using a capacity provider strategy that's not the default capacity provider | ||
| * strategy, the service can't be updated to use the cluster's default capacity provider strategy.</p> | ||
| * <p>if the service uses the default capacity provider strategy for the cluster, the | ||
| * service can be updated to use one or more capacity providers as opposed to the default | ||
| * capacity provider strategy. However, when a service is using a capacity provider | ||
| * strategy that's not the default capacity provider strategy, the service can't be updated | ||
| * to use the cluster's default capacity provider strategy.</p> | ||
| * <p>A capacity provider strategy consists of one or more capacity providers along with the | ||
| * <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated | ||
| * with the cluster to be used in a capacity provider strategy. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. | ||
| * Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> | ||
| * <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already | ||
| * be created. New capacity providers can be created with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html">CreateClusterCapacityProvider</a> API operation.</p> | ||
| * <code>base</code> and <code>weight</code> to assign to them. A capacity provider | ||
| * must be associated with the cluster to be used in a capacity provider strategy. The | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API is used to associate a capacity provider | ||
| * with a cluster. Only capacity providers with an <code>ACTIVE</code> or | ||
| * <code>UPDATING</code> status can be used.</p> | ||
| * <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity | ||
| * provider must already be created. New capacity providers can be created with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html">CreateClusterCapacityProvider</a> API operation.</p> | ||
| * <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or | ||
| * <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are available to all | ||
| * accounts and only need to be associated with a cluster to be used.</p> | ||
| * <p>The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a>API operation is used to update the list of available capacity | ||
| * providers for a cluster after the cluster is created.</p> | ||
| * <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are | ||
| * available to all accounts and only need to be associated with a cluster to be | ||
| * used.</p> | ||
| * <p>The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a>API operation is used to update the list of | ||
| * available capacity providers for a cluster after the cluster is created.</p> | ||
| * <p></p> | ||
@@ -300,4 +307,4 @@ * @public | ||
| /** | ||
| * <p>Optional deployment parameters that control how many tasks run during the deployment and the ordering | ||
| * of stopping and starting tasks.</p> | ||
| * <p>Optional deployment parameters that control how many tasks run during the deployment | ||
| * and the ordering of stopping and starting tasks.</p> | ||
| * @public | ||
@@ -319,8 +326,9 @@ */ | ||
| /** | ||
| * <p>An array of task placement constraint objects to update the service to use. If no value is specified, | ||
| * the existing placement constraints for the service will remain unchanged. If this value is specified, | ||
| * it will override any existing placement constraints defined for the service. To remove all existing | ||
| * placement constraints, specify an empty array.</p> | ||
| * <p>You can specify a maximum of 10 constraints for each task. This limit includes constraints in the | ||
| * task definition and those specified at runtime.</p> | ||
| * <p>An array of task placement constraint objects to update the service to use. If no | ||
| * value is specified, the existing placement constraints for the service will remain | ||
| * unchanged. If this value is specified, it will override any existing placement | ||
| * constraints defined for the service. To remove all existing placement constraints, | ||
| * specify an empty array.</p> | ||
| * <p>You can specify a maximum of 10 constraints for each task. This limit includes | ||
| * constraints in the task definition and those specified at runtime.</p> | ||
| * @public | ||
@@ -330,6 +338,6 @@ */ | ||
| /** | ||
| * <p>The task placement strategy objects to update the service to use. If no value is specified, the | ||
| * existing placement strategy for the service will remain unchanged. If this value is specified, it will | ||
| * override the existing placement strategy defined for the service. To remove an existing placement | ||
| * strategy, specify an empty object.</p> | ||
| * <p>The task placement strategy objects to update the service to use. If no value is | ||
| * specified, the existing placement strategy for the service will remain unchanged. If | ||
| * this value is specified, it will override the existing placement strategy defined for | ||
| * the service. To remove an existing placement strategy, specify an empty object.</p> | ||
| * <p>You can specify a maximum of five strategy rules for each service.</p> | ||
@@ -340,6 +348,7 @@ * @public | ||
| /** | ||
| * <p>The platform version that your tasks in the service run on. A platform version is only specified for | ||
| * tasks using the Fargate launch type. If a platform version is not specified, the | ||
| * <code>LATEST</code> platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in | ||
| * the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>The platform version that your tasks in the service run on. A platform version is only | ||
| * specified for tasks using the Fargate launch type. If a platform version | ||
| * is not specified, the <code>LATEST</code> platform version is used. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform | ||
| * Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * @public | ||
@@ -349,6 +358,7 @@ */ | ||
| /** | ||
| * <p>Determines whether to force a new deployment of the service. By default, deployments aren't forced. | ||
| * You can use this option to start a new deployment with no service definition changes. For example, you | ||
| * can update a service's tasks to use a newer Docker image with the same image/tag combination | ||
| * (<code>my_image:latest</code>) or to roll Fargate tasks onto a newer platform version.</p> | ||
| * <p>Determines whether to force a new deployment of the service. By default, deployments | ||
| * aren't forced. You can use this option to start a new deployment with no service | ||
| * definition changes. For example, you can update a service's tasks to use a newer Docker | ||
| * image with the same image/tag combination (<code>my_image:latest</code>) or to roll | ||
| * Fargate tasks onto a newer platform version.</p> | ||
| * @public | ||
@@ -358,10 +368,12 @@ */ | ||
| /** | ||
| * <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container | ||
| * health checks after a task has first started. If you don't specify a health check grace | ||
| * period value, the default value of <code>0</code> is used. If you don't use any of the health checks, | ||
| * then <code>healthCheckGracePeriodSeconds</code> is unused.</p> | ||
| * <p>If your service's tasks take a while to start and respond to health checks, you can specify a | ||
| * health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS | ||
| * service scheduler ignores health check status. This grace period can prevent the service scheduler from | ||
| * marking tasks as unhealthy and stopping them before they have time to come up.</p> | ||
| * <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy | ||
| * Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't | ||
| * specify a health check grace period value, the default value of <code>0</code> is used. | ||
| * If you don't use any of the health checks, then | ||
| * <code>healthCheckGracePeriodSeconds</code> is unused.</p> | ||
| * <p>If your service's tasks take a while to start and respond to health checks, you can | ||
| * specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). | ||
| * During that time, the Amazon ECS service scheduler ignores health check status. This grace | ||
| * period can prevent the service scheduler from marking tasks as unhealthy and stopping | ||
| * them before they have time to come up.</p> | ||
| * @public | ||
@@ -371,5 +383,6 @@ */ | ||
| /** | ||
| * <p>If <code>true</code>, this enables execute command functionality on all task containers.</p> | ||
| * <p>If you do not want to override the value that was set when the service was created, you can set this | ||
| * to <code>null</code> when performing this action.</p> | ||
| * <p>If <code>true</code>, this enables execute command functionality on all task | ||
| * containers.</p> | ||
| * <p>If you do not want to override the value that was set when the service was created, | ||
| * you can set this to <code>null</code> when performing this action.</p> | ||
| * @public | ||
@@ -379,8 +392,8 @@ */ | ||
| /** | ||
| * <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, | ||
| * see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your | ||
| * Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Only tasks launched after the update will reflect the update. To update the tags on all tasks, set | ||
| * <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS starts new tasks with the | ||
| * updated tags.</p> | ||
| * <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For | ||
| * more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS | ||
| * Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> | ||
| * <p>Only tasks launched after the update will reflect the update. To update the tags on | ||
| * all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS | ||
| * starts new tasks with the updated tags.</p> | ||
| * @public | ||
@@ -390,20 +403,22 @@ */ | ||
| /** | ||
| * <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and | ||
| * the container port to access from the load balancer. The container name is as it appears in a container | ||
| * definition.</p> | ||
| * <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the | ||
| * updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.</p> | ||
| * <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can | ||
| * update from a single target group to multiple target groups and from multiple target groups to a single | ||
| * target group.</p> | ||
| * <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using | ||
| * <code> | ||
| * <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the | ||
| * container name, and the container port to access from the load balancer. The container | ||
| * name is as it appears in a container definition.</p> | ||
| * <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks | ||
| * with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks | ||
| * are running.</p> | ||
| * <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target | ||
| * groups. You can update from a single target group to multiple target groups and from | ||
| * multiple target groups to a single target group.</p> | ||
| * <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by | ||
| * using <code> | ||
| * <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> | ||
| * </code> | ||
| * through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more | ||
| * information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register multiple target | ||
| * groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p> | ||
| * <p>For services that use the external deployment controller, you can add, update, or remove load | ||
| * balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. Note that | ||
| * multiple target groups are not supported for external deployments. For more information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p> | ||
| * </code> through CodeDeploy. Note that multiple target groups | ||
| * are not supported for blue/green deployments. For more information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register | ||
| * multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p> | ||
| * <p>For services that use the external deployment controller, you can add, update, or | ||
| * remove load balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. | ||
| * Note that multiple target groups are not supported for external deployments. For more | ||
| * information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register | ||
| * multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p> | ||
| * <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p> | ||
@@ -414,7 +429,7 @@ * @public | ||
| /** | ||
| * <p>Determines whether to propagate the tags from the task definition or the service to the task. If no | ||
| * value is specified, the tags aren't propagated.</p> | ||
| * <p>Only tasks launched after the update will reflect the update. To update the tags on all tasks, set | ||
| * <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS starts new tasks with the | ||
| * updated tags.</p> | ||
| * <p>Determines whether to propagate the tags from the task definition or the service to | ||
| * the task. If no value is specified, the tags aren't propagated.</p> | ||
| * <p>Only tasks launched after the update will reflect the update. To update the tags on | ||
| * all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS | ||
| * starts new tasks with the updated tags.</p> | ||
| * @public | ||
@@ -424,9 +439,10 @@ */ | ||
| /** | ||
| * <p>The details for the service discovery registries to assign to this service. For more information, see | ||
| * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service | ||
| * <p>The details for the service discovery registries to assign to this service. For more | ||
| * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service | ||
| * Discovery</a>.</p> | ||
| * <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the | ||
| * updated service registries configuration, and then stops the old tasks when the new tasks are | ||
| * running.</p> | ||
| * <p>You can remove existing <code>serviceRegistries</code> by passing an empty list.</p> | ||
| * <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new | ||
| * tasks with the updated service registries configuration, and then stops the old tasks | ||
| * when the new tasks are running.</p> | ||
| * <p>You can remove existing <code>serviceRegistries</code> by passing an empty | ||
| * list.</p> | ||
| * @public | ||
@@ -448,6 +464,7 @@ */ | ||
| /** | ||
| * <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure the size, | ||
| * volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html">ServiceManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume must match the | ||
| * <code>name</code> from the task definition. If set to null, no new deployment is triggered. | ||
| * Otherwise, if this configuration differs from the existing one, it triggers a new deployment.</p> | ||
| * <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure | ||
| * the size, volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html">ServiceManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume | ||
| * must match the <code>name</code> from the task definition. If set to null, no new | ||
| * deployment is triggered. Otherwise, if this configuration differs from the existing one, | ||
| * it triggers a new deployment.</p> | ||
| * @public | ||
@@ -457,3 +474,4 @@ */ | ||
| /** | ||
| * <p>An object representing the VPC Lattice configuration for the service being updated.</p> | ||
| * <p>An object representing the VPC Lattice configuration for the service being | ||
| * updated.</p> | ||
| * @public | ||
@@ -478,4 +496,4 @@ */ | ||
| /** | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists | ||
| * in.</p> | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task | ||
| * set exists in.</p> | ||
| * @public | ||
@@ -511,4 +529,4 @@ */ | ||
| /** | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist | ||
| * in.</p> | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task | ||
| * sets exist in.</p> | ||
| * @public | ||
@@ -523,4 +541,4 @@ */ | ||
| /** | ||
| * <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to unset protection, | ||
| * making it eligible for termination.</p> | ||
| * <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to | ||
| * unset protection, making it eligible for termination.</p> | ||
| * @public | ||
@@ -530,9 +548,9 @@ */ | ||
| /** | ||
| * <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the duration for task | ||
| * protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During | ||
| * this time, your task will not be terminated by scale-in events from Service Auto Scaling or | ||
| * deployments. After this time period lapses, <code>protectionEnabled</code> will be reset to | ||
| * <code>false</code>.</p> | ||
| * <p>If you don’t specify the time, then the task is automatically protected for 120 minutes (2 | ||
| * hours).</p> | ||
| * <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the | ||
| * duration for task protection in minutes. You can specify a value from 1 minute to up to | ||
| * 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in | ||
| * events from Service Auto Scaling or deployments. After this time period lapses, | ||
| * <code>protectionEnabled</code> will be reset to <code>false</code>.</p> | ||
| * <p>If you don’t specify the time, then the task is automatically protected for 120 | ||
| * minutes (2 hours).</p> | ||
| * @public | ||
@@ -555,9 +573,10 @@ */ | ||
| * <p> | ||
| * <code>protectionEnabled</code>: The protection status of the task. If scale-in protection is | ||
| * turned on for a task, the value is <code>true</code>. Otherwise, it is | ||
| * <code>false</code>.</p> | ||
| * <code>protectionEnabled</code>: The protection status of the task. If scale-in | ||
| * protection is turned on for a task, the value is <code>true</code>. Otherwise, | ||
| * it is <code>false</code>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <code>expirationDate</code>: The epoch time when protection for the task will expire.</p> | ||
| * <code>expirationDate</code>: The epoch time when protection for the task will | ||
| * expire.</p> | ||
| * </li> | ||
@@ -579,4 +598,4 @@ * </ul> | ||
| /** | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found | ||
| * in.</p> | ||
| * <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task | ||
| * set is found in.</p> | ||
| * @public | ||
@@ -596,4 +615,4 @@ */ | ||
| /** | ||
| * <p>A floating-point percentage of the desired number of tasks to place and keep running in the task | ||
| * set.</p> | ||
| * <p>A floating-point percentage of the desired number of tasks to place and keep running | ||
| * in the task set.</p> | ||
| * @public | ||
@@ -600,0 +619,0 @@ */ |
| { | ||
| "name": "@aws-sdk/client-ecs", | ||
| "description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native", | ||
| "version": "3.703.0", | ||
| "version": "3.708.0", | ||
| "scripts": { | ||
@@ -6,0 +6,0 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", |
@@ -11,13 +11,14 @@ <!-- generated file, do not edit directly --> | ||
| <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, | ||
| stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's | ||
| managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your | ||
| tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> | ||
| <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes | ||
| it easy to get the state of your cluster from a centralized service, and gives you access to many | ||
| familiar Amazon EC2 features.</p> | ||
| <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource | ||
| needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your | ||
| own cluster management and configuration management systems. You also don't need to worry about scaling | ||
| your management infrastructure. </p> | ||
| <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes | ||
| it easy to run, stop, and manage Docker containers. You can host your cluster on a | ||
| serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on | ||
| Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) | ||
| or External (on-premises) instances that you manage.</p> | ||
| <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API | ||
| calls. This makes it easy to get the state of your cluster from a centralized service, | ||
| and gives you access to many familiar Amazon EC2 features.</p> | ||
| <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on | ||
| your resource needs, isolation policies, and availability requirements. With Amazon ECS, you | ||
| don't need to operate your own cluster management and configuration management systems. | ||
| You also don't need to worry about scaling your management infrastructure. </p> | ||
@@ -24,0 +25,0 @@ ## Installing |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.38%
2023505
- Lines of code
- increased by1.54%
45177
- Number of lines in readme file
- increased by0.14%
691
No dependency changes