From 8dfab180d9ca2fff0ee68c8e6ba1dd18e835e14d Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 9 Dec 2024 19:38:05 +0000 Subject: [PATCH] docs(client-ecs): This is a documentation only update to address various tickets for Amazon ECS. --- clients/client-ecs/README.md | 23 +- clients/client-ecs/src/ECS.ts | 23 +- clients/client-ecs/src/ECSClient.ts | 23 +- .../commands/CreateCapacityProviderCommand.ts | 39 +- .../src/commands/CreateClusterCommand.ts | 36 +- .../src/commands/CreateServiceCommand.ts | 155 +- .../src/commands/CreateTaskSetCommand.ts | 34 +- .../commands/DeleteAccountSettingCommand.ts | 21 +- .../src/commands/DeleteAttributesCommand.ts | 6 +- .../commands/DeleteCapacityProviderCommand.ts | 38 +- .../src/commands/DeleteClusterCommand.ts | 51 +- .../src/commands/DeleteServiceCommand.ts | 52 +- .../commands/DeleteTaskDefinitionsCommand.ts | 51 +- .../src/commands/DeleteTaskSetCommand.ts | 31 +- .../DeregisterContainerInstanceCommand.ts | 41 +- .../DeregisterTaskDefinitionCommand.ts | 49 +- .../DescribeCapacityProvidersCommand.ts | 18 +- .../src/commands/DescribeClustersCommand.ts | 18 +- .../DescribeContainerInstancesCommand.ts | 22 +- .../DescribeServiceDeploymentsCommand.ts | 25 +- .../DescribeServiceRevisionsCommand.ts | 25 +- .../src/commands/DescribeServicesCommand.ts | 18 +- .../commands/DescribeTaskDefinitionCommand.ts | 29 +- .../src/commands/DescribeTaskSetsCommand.ts | 30 +- .../src/commands/DescribeTasksCommand.ts | 24 +- .../commands/DiscoverPollEndpointCommand.ts | 15 +- .../src/commands/ExecuteCommandCommand.ts | 42 +- .../src/commands/GetTaskProtectionCommand.ts | 18 +- .../commands/ListAccountSettingsCommand.ts | 18 +- .../src/commands/ListAttributesCommand.ts | 14 +- .../src/commands/ListClustersCommand.ts | 18 +- .../commands/ListContainerInstancesCommand.ts | 25 +- .../commands/ListServiceDeploymentsCommand.ts | 24 +- .../ListServicesByNamespaceCommand.ts | 27 +- .../src/commands/ListServicesCommand.ts | 22 +- .../commands/ListTagsForResourceCommand.ts | 18 +- .../ListTaskDefinitionFamiliesCommand.ts | 30 +- .../commands/ListTaskDefinitionsCommand.ts | 24 +- .../src/commands/ListTasksCommand.ts | 27 +- .../src/commands/PutAccountSettingCommand.ts | 25 +- .../PutAccountSettingDefaultCommand.ts | 22 +- .../src/commands/PutAttributesCommand.ts | 17 +- .../PutClusterCapacityProvidersCommand.ts | 53 +- .../RegisterContainerInstanceCommand.ts | 22 +- .../commands/RegisterTaskDefinitionCommand.ts | 45 +- .../client-ecs/src/commands/RunTaskCommand.ts | 70 +- .../src/commands/StartTaskCommand.ts | 32 +- .../src/commands/StopTaskCommand.ts | 40 +- .../SubmitAttachmentStateChangesCommand.ts | 18 +- .../SubmitContainerStateChangeCommand.ts | 15 +- .../commands/SubmitTaskStateChangeCommand.ts | 18 +- .../src/commands/TagResourceCommand.ts | 25 +- .../src/commands/UntagResourceCommand.ts | 18 +- .../commands/UpdateCapacityProviderCommand.ts | 18 +- .../src/commands/UpdateClusterCommand.ts | 18 +- .../commands/UpdateClusterSettingsCommand.ts | 18 +- .../commands/UpdateContainerAgentCommand.ts | 70 +- .../UpdateContainerInstancesStateCommand.ts | 90 +- .../src/commands/UpdateServiceCommand.ts | 192 +- .../UpdateServicePrimaryTaskSetCommand.ts | 35 +- .../commands/UpdateTaskProtectionCommand.ts | 45 +- .../src/commands/UpdateTaskSetCommand.ts | 34 +- clients/client-ecs/src/index.ts | 23 +- clients/client-ecs/src/models/models_0.ts | 6262 +++++++++-------- clients/client-ecs/src/models/models_1.ts | 311 +- codegen/sdk-codegen/aws-models/ecs.json | 1442 ++-- 66 files changed, 5439 insertions(+), 4743 deletions(-) diff --git a/clients/client-ecs/README.md b/clients/client-ecs/README.md index dad091a8a4e1..7976c0b8c0b9 100644 --- a/clients/client-ecs/README.md +++ b/clients/client-ecs/README.md @@ -8,17 +8,18 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native. Amazon Elastic Container Service -

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.

-

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.

-

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.

+

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.

+

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.

+

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.

## Installing diff --git a/clients/client-ecs/src/ECS.ts b/clients/client-ecs/src/ECS.ts index 3c94e7826d13..7cfc5480f946 100644 --- a/clients/client-ecs/src/ECS.ts +++ b/clients/client-ecs/src/ECS.ts @@ -1242,17 +1242,18 @@ export interface ECS { /** * Amazon Elastic Container Service - *

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.

- *

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.

- *

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.

+ *

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.

+ *

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.

+ *

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.

* @public */ export class ECS extends ECSClient implements ECS {} diff --git a/clients/client-ecs/src/ECSClient.ts b/clients/client-ecs/src/ECSClient.ts index a07f25972b58..909ce62972bc 100644 --- a/clients/client-ecs/src/ECSClient.ts +++ b/clients/client-ecs/src/ECSClient.ts @@ -520,17 +520,18 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {} /** * Amazon Elastic Container Service - *

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.

- *

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.

- *

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.

+ *

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.

+ *

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.

+ *

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.

* @public */ export class ECSClient extends __Client< diff --git a/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts b/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts index 3e8426d94745..32899f9f73d6 100644 --- a/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts +++ b/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts @@ -28,11 +28,13 @@ export interface CreateCapacityProviderCommandInput extends CreateCapacityProvid export interface CreateCapacityProviderCommandOutput extends CreateCapacityProviderResponse, __MetadataBearer {} /** - *

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.

- *

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use - * the FARGATE and FARGATE_SPOT capacity providers. These providers are - * available to all accounts in the Amazon Web Services Regions that Fargate supports.

+ *

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.

+ *

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on + * Fargate use the FARGATE and FARGATE_SPOT capacity providers. + * These providers are available to all accounts in the Amazon Web Services Regions that Fargate + * supports.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -99,21 +101,23 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link LimitExceededException} (client fault) *

The limit for the resource was exceeded.

@@ -122,10 +126,11 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi *

These errors are usually caused by a server issue.

* * @throws {@link UpdateInProgressException} (client fault) - *

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 - * PENDING or STAGING, the update process can get stuck in that state. - * However, when the agent reconnects, it resumes where it stopped previously.

+ *

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 PENDING or STAGING, the update + * process can get stuck in that state. However, when the agent reconnects, it resumes + * where it stopped previously.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/CreateClusterCommand.ts b/clients/client-ecs/src/commands/CreateClusterCommand.ts index ad826a1702e3..8ba0074cc003 100644 --- a/clients/client-ecs/src/commands/CreateClusterCommand.ts +++ b/clients/client-ecs/src/commands/CreateClusterCommand.ts @@ -28,16 +28,16 @@ export interface CreateClusterCommandInput extends CreateClusterRequest {} export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {} /** - *

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when - * you launch your first container instance. However, you can create your own cluster with a unique - * name.

+ *

Creates a new Amazon ECS cluster. By default, your account receives a default + * cluster when you launch your first container instance. However, you can create your own + * cluster with a unique name.

* - *

When you call the CreateCluster 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 Using service-linked - * roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

+ *

When you call the CreateCluster + * 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 Using + * service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -175,21 +175,23 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link NamespaceNotFoundException} (client fault) *

The specified namespace wasn't found.

diff --git a/clients/client-ecs/src/commands/CreateServiceCommand.ts b/clients/client-ecs/src/commands/CreateServiceCommand.ts index e1f5b7e200b5..2d098a883607 100644 --- a/clients/client-ecs/src/commands/CreateServiceCommand.ts +++ b/clients/client-ecs/src/commands/CreateServiceCommand.ts @@ -28,89 +28,92 @@ export interface CreateServiceCommandInput extends CreateServiceRequest {} export interface CreateServiceCommandOutput extends CreateServiceResponse, __MetadataBearer {} /** - *

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 desiredCount, Amazon ECS runs another copy of the - * task in the specified cluster. To update an existing service, use UpdateService.

+ *

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 desiredCount, + * Amazon ECS runs another copy of the task in the specified cluster. To update an existing + * service, use UpdateService.

* *

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.

* * *

Amazon Elastic Inference (EI) is no longer available to customers.

* - *

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 Service load - * balancing in the Amazon Elastic Container Service Developer Guide.

- *

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a - * service. volumeConfigurations is only supported for REPLICA service and not DAEMON - * service. For more infomation, see Amazon EBS - * volumes in the Amazon Elastic Container Service Developer Guide.

- *

Tasks for services that don't use a load balancer are considered healthy if they're in the - * RUNNING state. Tasks for services that use a load balancer are considered healthy if - * they're in the RUNNING state and are reported as healthy by the load balancer.

+ *

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 Service load balancing in the Amazon Elastic Container Service Developer Guide.

+ *

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or + * updating a service. volumeConfigurations is only supported for REPLICA + * service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

+ *

Tasks for services that don't use a load balancer are considered healthy if they're in + * the RUNNING state. Tasks for services that use a load balancer are + * considered healthy if they're in the RUNNING state and are reported as + * healthy by the load balancer.

*

There are two service scheduler strategies available:

* - *

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 UpdateService. The default value for a replica service for - * minimumHealthyPercent is 100%. The default value for a daemon service for - * minimumHealthyPercent is 0%.

- *

If a service uses the ECS deployment controller, the minimum healthy percent represents - * a lower limit on the number of tasks in a service that must remain in the RUNNING 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 - * DRAINING 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 RUNNING state, tasks for services that don't use a load balancer are considered - * healthy . If they're in the RUNNING state and reported as healthy by the load balancer, - * tasks for services that do use a load balancer are considered healthy . The + *

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 UpdateService. The default value for a replica service for + * minimumHealthyPercent is 100%. The default value for a daemon service + * for minimumHealthyPercent is 0%.

+ *

If a service uses the ECS deployment controller, the minimum healthy + * percent represents a lower limit on the number of tasks in a service that must remain in + * the RUNNING 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 DRAINING 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 RUNNING state, tasks for services + * that don't use a load balancer are considered healthy . If they're in the + * RUNNING state and reported as healthy by the load balancer, tasks for + * services that do use a load balancer are considered healthy . The * default value for minimum healthy percent is 100%.

- *

If a service uses the ECS deployment controller, the maximum - * percent parameter represents an upper limit on the number of tasks in a service that are - * allowed in the RUNNING or PENDING 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 DRAINING 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%.

- *

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller - * types and tasks that use the EC2 launch type, the minimum healthy - * percent and maximum percent values are used only to - * define the lower and upper limit on the number of the tasks in the service that remain in the - * RUNNING state. This is while the container instances are in the DRAINING - * 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.

- *

When creating a service that uses the EXTERNAL 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 CreateTaskSet. For more information, see Amazon ECS deployment - * types in the Amazon Elastic Container Service Developer Guide.

- *

When the service scheduler launches new tasks, it determines task placement. For information about - * task placement and task placement strategies, see Amazon ECS task - * placement in the Amazon Elastic Container Service Developer Guide + *

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the + * number of tasks in a service that are allowed in the RUNNING or + * PENDING 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 DRAINING 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%.

+ *

If a service uses either the CODE_DEPLOY or EXTERNAL + * deployment controller types and tasks that use the EC2 launch type, the + * minimum healthy percent and maximum percent values are used only to define the lower and upper limit + * on the number of the tasks in the service that remain in the RUNNING state. + * This is while the container instances are in the DRAINING 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.

+ *

When creating a service that uses the EXTERNAL 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 CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

+ *

When the service scheduler launches new tasks, it determines task placement. For + * information about task placement and task placement strategies, see Amazon ECS + * task placement in the Amazon Elastic Container Service Developer Guide *

* @example * Use a bare-bones client and the command you need to make an API call. @@ -575,16 +578,17 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -592,7 +596,8 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link NamespaceNotFoundException} (client fault) *

The specified namespace wasn't found.

diff --git a/clients/client-ecs/src/commands/CreateTaskSetCommand.ts b/clients/client-ecs/src/commands/CreateTaskSetCommand.ts index d88414947b9f..dd1214963c33 100644 --- a/clients/client-ecs/src/commands/CreateTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/CreateTaskSetCommand.ts @@ -28,14 +28,15 @@ export interface CreateTaskSetCommandInput extends CreateTaskSetRequest {} export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __MetadataBearer {} /** - *

Create a task set in the specified cluster and service. This is used when a service uses the - * EXTERNAL deployment controller type. For more information, see Amazon ECS deployment + *

Create a task set in the specified cluster and service. This is used when a service + * uses the EXTERNAL deployment controller type. For more information, see + * Amazon ECS deployment * types in the Amazon Elastic Container Service Developer Guide.

* *

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.

* - *

For information about the maximum number of task sets and other quotas, see Amazon ECS service - * quotas in the Amazon Elastic Container Service Developer Guide.

+ *

For information about the maximum number of task sets and other quotas, see Amazon ECS + * service quotas in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -179,16 +180,17 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -196,7 +198,8 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link NamespaceNotFoundException} (client fault) *

The specified namespace wasn't found.

@@ -212,11 +215,12 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotActiveException} (client fault) - *

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 CreateService.

+ *

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 CreateService.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/DeleteAccountSettingCommand.ts b/clients/client-ecs/src/commands/DeleteAccountSettingCommand.ts index 3074dc390082..ae98d2dbceb6 100644 --- a/clients/client-ecs/src/commands/DeleteAccountSettingCommand.ts +++ b/clients/client-ecs/src/commands/DeleteAccountSettingCommand.ts @@ -28,7 +28,8 @@ export interface DeleteAccountSettingCommandInput extends DeleteAccountSettingRe export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingResponse, __MetadataBearer {} /** - *

Disables an account setting for a specified user, role, or the root user for an account.

+ *

Disables an account setting for a specified user, role, or the root user for an + * account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,21 +60,23 @@ export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingR * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DeleteAttributesCommand.ts b/clients/client-ecs/src/commands/DeleteAttributesCommand.ts index a46ecb2b91d0..6c44c6b3b927 100644 --- a/clients/client-ecs/src/commands/DeleteAttributesCommand.ts +++ b/clients/client-ecs/src/commands/DeleteAttributesCommand.ts @@ -71,10 +71,12 @@ export interface DeleteAttributesCommandOutput extends DeleteAttributesResponse, *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link TargetNotFoundException} (client fault) - *

The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and + *

The specified target wasn't found. You can view your available container instances + * with ListContainerInstances. Amazon ECS container instances are cluster-specific and * Region-specific.

* * @throws {@link ECSServiceException} diff --git a/clients/client-ecs/src/commands/DeleteCapacityProviderCommand.ts b/clients/client-ecs/src/commands/DeleteCapacityProviderCommand.ts index d93187618c1e..7970fc3e1a5b 100644 --- a/clients/client-ecs/src/commands/DeleteCapacityProviderCommand.ts +++ b/clients/client-ecs/src/commands/DeleteCapacityProviderCommand.ts @@ -30,16 +30,18 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi /** *

Deletes the specified capacity provider.

* - *

The FARGATE and FARGATE_SPOT capacity providers are reserved and can't - * be deleted. You can disassociate them from a cluster using either PutClusterCapacityProviders or by deleting the cluster.

+ *

The FARGATE and FARGATE_SPOT capacity providers are + * reserved and can't be deleted. You can disassociate them from a cluster using either + * PutClusterCapacityProviders or by deleting the cluster.

* - *

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity - * provider strategy from all services. The UpdateService API can be used to - * remove a capacity provider from a service's capacity provider strategy. When updating a service, the - * forceNewDeployment 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 PutClusterCapacityProviders or delete the cluster.

+ *

Prior to a capacity provider being deleted, the capacity provider must be removed from + * the capacity provider strategy from all services. The UpdateService API + * can be used to remove a capacity provider from a service's capacity provider strategy. + * When updating a service, the forceNewDeployment 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 PutClusterCapacityProviders or delete the cluster.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -88,21 +90,23 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DeleteClusterCommand.ts b/clients/client-ecs/src/commands/DeleteClusterCommand.ts index d09f3eb6f6f7..c2d5df53797f 100644 --- a/clients/client-ecs/src/commands/DeleteClusterCommand.ts +++ b/clients/client-ecs/src/commands/DeleteClusterCommand.ts @@ -28,13 +28,12 @@ export interface DeleteClusterCommandInput extends DeleteClusterRequest {} export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __MetadataBearer {} /** - *

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters - * with an INACTIVE 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 - * INACTIVE clusters persisting.

- *

You must deregister all container instances from this cluster before you may delete it. You can list - * the container instances in a cluster with ListContainerInstances - * and deregister them with DeregisterContainerInstance.

+ *

Deletes the specified cluster. The cluster transitions to the INACTIVE + * state. Clusters with an INACTIVE 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 INACTIVE clusters persisting.

+ *

You must deregister all container instances from this cluster before you may delete + * it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -129,26 +128,30 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link ClusterContainsContainerInstancesException} (client fault) - *

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 DeregisterContainerInstance.

+ *

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 + * DeregisterContainerInstance.

* * @throws {@link ClusterContainsServicesException} (client fault) - *

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 UpdateService and DeleteService.

+ *

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 + * UpdateService and + * DeleteService.

* * @throws {@link ClusterContainsTasksException} (client fault) *

You can't delete a cluster that has active tasks.

@@ -157,16 +160,18 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link UpdateInProgressException} (client fault) - *

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 - * PENDING or STAGING, the update process can get stuck in that state. - * However, when the agent reconnects, it resumes where it stopped previously.

+ *

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 PENDING or STAGING, the update + * process can get stuck in that state. However, when the agent reconnects, it resumes + * where it stopped previously.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/DeleteServiceCommand.ts b/clients/client-ecs/src/commands/DeleteServiceCommand.ts index 13ad6e9d7171..8949f1c492bc 100644 --- a/clients/client-ecs/src/commands/DeleteServiceCommand.ts +++ b/clients/client-ecs/src/commands/DeleteServiceCommand.ts @@ -28,23 +28,26 @@ export interface DeleteServiceCommandInput extends DeleteServiceRequest {} export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __MetadataBearer {} /** - *

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 - * UpdateService.

+ *

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 UpdateService.

* - *

When you delete a service, if there are still running tasks that require cleanup, the service - * status moves from ACTIVE to DRAINING, and the service is no longer - * visible in the console or in the ListServices API operation. - * After all tasks have transitioned to either STOPPING or STOPPED status, - * the service status moves from DRAINING to INACTIVE. Services in the - * DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services - * may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on - * those services return a ServiceNotFoundException error.

+ *

When you delete a service, if there are still running tasks that require cleanup, + * the service status moves from ACTIVE to DRAINING, and the + * service is no longer visible in the console or in the ListServices + * API operation. After all tasks have transitioned to either STOPPING or + * STOPPED status, the service status moves from DRAINING + * to INACTIVE. Services in the DRAINING or + * INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, + * INACTIVE services may be cleaned up and purged from Amazon ECS record + * keeping, and DescribeServices calls on those services return a + * ServiceNotFoundException error.

* * - *

If you attempt to create a new service with the same name as an existing service in either - * ACTIVE or DRAINING status, you receive an error.

+ *

If you attempt to create a new service with the same name as an existing service + * in either ACTIVE or DRAINING status, you receive an + * error.

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -350,16 +353,17 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -367,13 +371,15 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/DeleteTaskDefinitionsCommand.ts b/clients/client-ecs/src/commands/DeleteTaskDefinitionsCommand.ts index f4f80afa4f89..8391fad3ad52 100644 --- a/clients/client-ecs/src/commands/DeleteTaskDefinitionsCommand.ts +++ b/clients/client-ecs/src/commands/DeleteTaskDefinitionsCommand.ts @@ -29,22 +29,25 @@ export interface DeleteTaskDefinitionsCommandOutput extends DeleteTaskDefinition /** *

Deletes one or more task definitions.

- *

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

+ *

You must deregister a task definition revision before you delete it. For more + * information, see DeregisterTaskDefinition.

*

When you delete a task definition revision, it is immediately transitions from the - * INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that - * reference a DELETE_IN_PROGRESS task definition revision continue to run without - * disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision - * can still scale up or down by modifying the service's desired count.

- *

You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create - * new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS - * task definition revision.

- *

A task definition revision will stay in DELETE_IN_PROGRESS status until all the - * associated tasks and services have been terminated.

- *

When you delete all INACTIVE 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 - * DELETE_IN_PROGRESS 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.

+ * INACTIVE to DELETE_IN_PROGRESS. Existing tasks and + * services that reference a DELETE_IN_PROGRESS task definition revision + * continue to run without disruption. Existing services that reference a + * DELETE_IN_PROGRESS task definition revision can still scale up or down + * by modifying the service's desired count.

+ *

You can't use a DELETE_IN_PROGRESS task definition revision to run new + * tasks or create new services. You also can't update an existing service to reference a + * DELETE_IN_PROGRESS task definition revision.

+ *

A task definition revision will stay in DELETE_IN_PROGRESS status until + * all the associated tasks and services have been terminated.

+ *

When you delete all INACTIVE 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 DELETE_IN_PROGRESS 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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -353,21 +356,23 @@ export interface DeleteTaskDefinitionsCommandOutput extends DeleteTaskDefinition *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts b/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts index 54e7f7059c2e..5a526c4716d2 100644 --- a/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts @@ -29,8 +29,7 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met /** *

Deletes a specified task set within a service. This is used when a service uses the - * EXTERNAL deployment controller type. For more information, see Amazon ECS deployment - * types in the Amazon Elastic Container Service Developer Guide.

+ * EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -127,16 +126,17 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -144,20 +144,23 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotActiveException} (client fault) - *

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 CreateService.

+ *

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 CreateService.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link TaskSetNotFoundException} (client fault) - *

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

+ *

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and + * Region.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts b/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts index e54812e44afb..f6ff4c134725 100644 --- a/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts +++ b/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts @@ -30,18 +30,19 @@ export interface DeregisterContainerInstanceCommandOutput __MetadataBearer {} /** - *

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer - * available to run tasks.

- *

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.

- *

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.

+ *

Deregisters an Amazon ECS container instance from the specified cluster. This instance is + * no longer available to run tasks.

+ *

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.

+ *

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.

* - *

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).

+ *

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).

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -148,16 +149,17 @@ export interface DeregisterContainerInstanceCommandOutput * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -165,7 +167,8 @@ export interface DeregisterContainerInstanceCommandOutput *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts b/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts index d9873e089681..c600a1343b9f 100644 --- a/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts +++ b/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts @@ -28,23 +28,24 @@ export interface DeregisterTaskDefinitionCommandInput extends DeregisterTaskDefi export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDefinitionResponse, __MetadataBearer {} /** - *

Deregisters the specified task definition by family and revision. Upon deregistration, the task - * definition is marked as INACTIVE. Existing tasks and services that reference an - * INACTIVE task definition continue to run without disruption. Existing services that - * reference an INACTIVE 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.

- *

You can't use an INACTIVE task definition to run new tasks or create new services, and - * you can't update an existing service to reference an INACTIVE task definition. However, - * there may be up to a 10-minute window following deregistration where these restrictions have not yet - * taken effect.

+ *

Deregisters the specified task definition by family and revision. Upon deregistration, + * the task definition is marked as INACTIVE. Existing tasks and services that + * reference an INACTIVE task definition continue to run without disruption. + * Existing services that reference an INACTIVE 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.

+ *

You can't use an INACTIVE task definition to run new tasks or create new + * services, and you can't update an existing service to reference an INACTIVE + * task definition. However, there may be up to a 10-minute window following deregistration + * where these restrictions have not yet taken effect.

* - *

At this time, INACTIVE 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 INACTIVE task definitions persisting beyond the lifecycle of any - * associated tasks and services.

+ *

At this time, INACTIVE 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 INACTIVE task definitions persisting + * beyond the lifecycle of any associated tasks and services.

* - *

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

+ *

You must deregister a task definition revision before you delete it. For more + * information, see DeleteTaskDefinitions.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -339,21 +340,23 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts b/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts index cdba7b7e189f..068bf369ee56 100644 --- a/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts +++ b/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts @@ -94,21 +94,23 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DescribeClustersCommand.ts b/clients/client-ecs/src/commands/DescribeClustersCommand.ts index 84836858b915..91df0241dd57 100644 --- a/clients/client-ecs/src/commands/DescribeClustersCommand.ts +++ b/clients/client-ecs/src/commands/DescribeClustersCommand.ts @@ -138,21 +138,23 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse, * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts b/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts index 08ac0787db7f..6754a0bef4f9 100644 --- a/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts +++ b/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts @@ -28,8 +28,8 @@ export interface DescribeContainerInstancesCommandInput extends DescribeContaine export interface DescribeContainerInstancesCommandOutput extends DescribeContainerInstancesResponse, __MetadataBearer {} /** - *

Describes one or more container instances. Returns metadata about each container instance - * requested.

+ *

Describes one or more container instances. Returns metadata about each container + * instance requested.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -148,16 +148,17 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -165,7 +166,8 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts b/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts index b8ab190a0781..de00a618c94a 100644 --- a/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts +++ b/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts @@ -29,7 +29,9 @@ export interface DescribeServiceDeploymentsCommandOutput extends DescribeService /** *

Describes one or more of your service deployments.

- *

A service deployment happens when you release a software update for the service. For more information, see Amazon ECS service deployments.

+ *

A service deployment happens when you release a software update for the service. For + * more information, see Amazon ECS service + * deployments.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -127,16 +129,17 @@ export interface DescribeServiceDeploymentsCommandOutput extends DescribeService *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -144,13 +147,15 @@ export interface DescribeServiceDeploymentsCommandOutput extends DescribeService *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts b/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts index 22d230a76c76..a8da585f5dd8 100644 --- a/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts +++ b/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts @@ -29,8 +29,8 @@ export interface DescribeServiceRevisionsCommandOutput extends DescribeServiceRe /** *

Describes one or more service revisions.

- *

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, + *

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 Amazon ECS service revisions.

*

You can't describe a service revision that was created before October 25, 2024.

* @example @@ -200,16 +200,17 @@ export interface DescribeServiceRevisionsCommandOutput extends DescribeServiceRe *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -217,13 +218,15 @@ export interface DescribeServiceRevisionsCommandOutput extends DescribeServiceRe *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/DescribeServicesCommand.ts b/clients/client-ecs/src/commands/DescribeServicesCommand.ts index 2839f2cfdbbe..7bed7d242ea6 100644 --- a/clients/client-ecs/src/commands/DescribeServicesCommand.ts +++ b/clients/client-ecs/src/commands/DescribeServicesCommand.ts @@ -346,16 +346,17 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -363,7 +364,8 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts b/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts index b94269e2bd2a..6469ea027885 100644 --- a/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts +++ b/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts @@ -28,12 +28,13 @@ export interface DescribeTaskDefinitionCommandInput extends DescribeTaskDefiniti export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinitionResponse, __MetadataBearer {} /** - *

Describes a task definition. You can specify a family and revision to find - * information about a specific task definition, or you can simply specify the family to find the latest - * ACTIVE revision in that family.

+ *

Describes a task definition. You can specify a family and + * revision to find information about a specific task definition, or you + * can simply specify the family to find the latest ACTIVE revision in that + * family.

* - *

You can only describe INACTIVE task definitions while an active task or service - * references them.

+ *

You can only describe INACTIVE task definitions while an active task + * or service references them.

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -338,21 +339,23 @@ export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinit * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts b/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts index f4645703369b..08cb0cf1e1c7 100644 --- a/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts +++ b/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts @@ -28,8 +28,9 @@ export interface DescribeTaskSetsCommandInput extends DescribeTaskSetsRequest {} export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse, __MetadataBearer {} /** - *

Describes the task sets in the specified cluster and service. This is used when a service uses the - * EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment + *

Describes the task sets in the specified cluster and service. This is used when a + * service uses the EXTERNAL deployment controller type. For more information, + * see Amazon ECS Deployment * Types in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -140,16 +141,17 @@ export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse, *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -157,17 +159,19 @@ export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse, *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotActiveException} (client fault) - *

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 CreateService.

+ *

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 CreateService.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/DescribeTasksCommand.ts b/clients/client-ecs/src/commands/DescribeTasksCommand.ts index e72f551116f0..61559811d2d0 100644 --- a/clients/client-ecs/src/commands/DescribeTasksCommand.ts +++ b/clients/client-ecs/src/commands/DescribeTasksCommand.ts @@ -30,9 +30,9 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met /** *

Describes a specified task or tasks.

*

Currently, stopped tasks appear in the returned results for at least one hour.

- *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -231,16 +231,17 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -248,7 +249,8 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/DiscoverPollEndpointCommand.ts b/clients/client-ecs/src/commands/DiscoverPollEndpointCommand.ts index c29b97578b0b..08519b4fc364 100644 --- a/clients/client-ecs/src/commands/DiscoverPollEndpointCommand.ts +++ b/clients/client-ecs/src/commands/DiscoverPollEndpointCommand.ts @@ -59,16 +59,17 @@ export interface DiscoverPollEndpointCommandOutput extends DiscoverPollEndpointR * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * diff --git a/clients/client-ecs/src/commands/ExecuteCommandCommand.ts b/clients/client-ecs/src/commands/ExecuteCommandCommand.ts index 7a357669843b..6b51117cdc62 100644 --- a/clients/client-ecs/src/commands/ExecuteCommandCommand.ts +++ b/clients/client-ecs/src/commands/ExecuteCommandCommand.ts @@ -33,11 +33,13 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M /** *

Runs a command remotely on a container within a task.

- *

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 AccessDeniedException - * when there is a mismatch between the condition key value and the corresponding parameter value.

- *

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the - * Amazon ECS Developer Guide.

+ *

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 + * AccessDeniedException when there is a mismatch between the condition + * key value and the corresponding parameter value.

+ *

For information about required permissions and considerations, see Using Amazon ECS + * Exec for debugging in the Amazon ECS Developer Guide. + *

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -78,16 +80,17 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -95,14 +98,15 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link TargetNotConnectedException} (client fault) - *

The execute command cannot run. This error can be caused by any of the following configuration - * issues:

+ *

The execute command cannot run. This error can be caused by any of the following + * configuration issues:

* - *

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in - * the Amazon Elastic Container Service Developer Guide.

+ *

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS + * Exec in the Amazon Elastic Container Service Developer Guide.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/GetTaskProtectionCommand.ts b/clients/client-ecs/src/commands/GetTaskProtectionCommand.ts index a4864f9ef89e..7301d17dfa7f 100644 --- a/clients/client-ecs/src/commands/GetTaskProtectionCommand.ts +++ b/clients/client-ecs/src/commands/GetTaskProtectionCommand.ts @@ -72,16 +72,17 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -89,7 +90,8 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource wasn't found.

diff --git a/clients/client-ecs/src/commands/ListAccountSettingsCommand.ts b/clients/client-ecs/src/commands/ListAccountSettingsCommand.ts index 81cb1e4bfb19..e00fb1d4e941 100644 --- a/clients/client-ecs/src/commands/ListAccountSettingsCommand.ts +++ b/clients/client-ecs/src/commands/ListAccountSettingsCommand.ts @@ -66,21 +66,23 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListAttributesCommand.ts b/clients/client-ecs/src/commands/ListAttributesCommand.ts index b8275723d16d..adf4688b2ebe 100644 --- a/clients/client-ecs/src/commands/ListAttributesCommand.ts +++ b/clients/client-ecs/src/commands/ListAttributesCommand.ts @@ -28,11 +28,12 @@ export interface ListAttributesCommandInput extends ListAttributesRequest {} export interface ListAttributesCommandOutput extends ListAttributesResponse, __MetadataBearer {} /** - *

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify - * a target type and cluster, ListAttributes 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 + *

Lists the attributes for Amazon ECS resources within a specified target type and cluster. + * When you specify a target type and cluster, ListAttributes 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 * (ecs.os-type=linux).

* @example * Use a bare-bones client and the command you need to make an API call. @@ -74,7 +75,8 @@ export interface ListAttributesCommandOutput extends ListAttributesResponse, __M *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/ListClustersCommand.ts b/clients/client-ecs/src/commands/ListClustersCommand.ts index bfdda7f16212..3f29ab18b518 100644 --- a/clients/client-ecs/src/commands/ListClustersCommand.ts +++ b/clients/client-ecs/src/commands/ListClustersCommand.ts @@ -57,21 +57,23 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListContainerInstancesCommand.ts b/clients/client-ecs/src/commands/ListContainerInstancesCommand.ts index 2ec387fa604e..eec98c3474fe 100644 --- a/clients/client-ecs/src/commands/ListContainerInstancesCommand.ts +++ b/clients/client-ecs/src/commands/ListContainerInstancesCommand.ts @@ -28,10 +28,9 @@ export interface ListContainerInstancesCommandInput extends ListContainerInstanc export interface ListContainerInstancesCommandOutput extends ListContainerInstancesResponse, __MetadataBearer {} /** - *

Returns a list of container instances in a specified cluster. You can filter the results of a - * ListContainerInstances operation with cluster query language statements inside the - * filter parameter. For more information, see Cluster - * Query Language in the Amazon Elastic Container Service Developer Guide.

+ *

Returns a list of container instances in a specified cluster. You can filter the + * results of a ListContainerInstances operation with cluster query language + * statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,16 +62,17 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -80,7 +80,8 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListServiceDeploymentsCommand.ts b/clients/client-ecs/src/commands/ListServiceDeploymentsCommand.ts index d6a1466ebe44..26708be41a48 100644 --- a/clients/client-ecs/src/commands/ListServiceDeploymentsCommand.ts +++ b/clients/client-ecs/src/commands/ListServiceDeploymentsCommand.ts @@ -28,7 +28,8 @@ export interface ListServiceDeploymentsCommandInput extends ListServiceDeploymen export interface ListServiceDeploymentsCommandOutput extends ListServiceDeploymentsResponse, __MetadataBearer {} /** - *

This operation lists all the service deployments that meet the specified filter criteria.

+ *

This operation lists all the service deployments that meet the specified filter + * criteria.

*

A service deployment happens when you release a softwre update for the service. You * route traffic from the running service revisions to the new service revison and control * the number of running tasks.

@@ -83,27 +84,30 @@ export interface ListServiceDeploymentsCommandOutput extends ListServiceDeployme *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/ListServicesByNamespaceCommand.ts b/clients/client-ecs/src/commands/ListServicesByNamespaceCommand.ts index eb93c56538de..1e8848d2db64 100644 --- a/clients/client-ecs/src/commands/ListServicesByNamespaceCommand.ts +++ b/clients/client-ecs/src/commands/ListServicesByNamespaceCommand.ts @@ -28,10 +28,11 @@ export interface ListServicesByNamespaceCommandInput extends ListServicesByNames export interface ListServicesByNamespaceCommandOutput extends ListServicesByNamespaceResponse, __MetadataBearer {} /** - *

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, ListServices 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 ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

+ *

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, + * ListServices 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 + * ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,21 +62,23 @@ export interface ListServicesByNamespaceCommandOutput extends ListServicesByName * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link NamespaceNotFoundException} (client fault) *

The specified namespace wasn't found.

diff --git a/clients/client-ecs/src/commands/ListServicesCommand.ts b/clients/client-ecs/src/commands/ListServicesCommand.ts index 60a8b2d4ade0..6a3cf586ec31 100644 --- a/clients/client-ecs/src/commands/ListServicesCommand.ts +++ b/clients/client-ecs/src/commands/ListServicesCommand.ts @@ -28,8 +28,8 @@ export interface ListServicesCommandInput extends ListServicesRequest {} export interface ListServicesCommandOutput extends ListServicesResponse, __MetadataBearer {} /** - *

Returns a list of services. You can filter the results by cluster, launch type, and scheduling - * strategy.

+ *

Returns a list of services. You can filter the results by cluster, launch type, and + * scheduling strategy.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,16 +61,17 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -78,7 +79,8 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListTagsForResourceCommand.ts b/clients/client-ecs/src/commands/ListTagsForResourceCommand.ts index af09ee43fa0d..0b2ab7ec67a3 100644 --- a/clients/client-ecs/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-ecs/src/commands/ListTagsForResourceCommand.ts @@ -58,16 +58,17 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -75,7 +76,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListTaskDefinitionFamiliesCommand.ts b/clients/client-ecs/src/commands/ListTaskDefinitionFamiliesCommand.ts index cc58ea12bf96..f3ff28721ba8 100644 --- a/clients/client-ecs/src/commands/ListTaskDefinitionFamiliesCommand.ts +++ b/clients/client-ecs/src/commands/ListTaskDefinitionFamiliesCommand.ts @@ -28,11 +28,13 @@ export interface ListTaskDefinitionFamiliesCommandInput extends ListTaskDefiniti export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinitionFamiliesResponse, __MetadataBearer {} /** - *

Returns a list of task definition families that are registered to your account. This list includes - * task definition families that no longer have any ACTIVE task definition revisions.

- *

You can filter out task definition families that don't contain any ACTIVE task - * definition revisions by setting the status parameter to ACTIVE. You can also - * filter the results with the familyPrefix parameter.

+ *

Returns a list of task definition families that are registered to your account. This + * list includes task definition families that no longer have any ACTIVE task + * definition revisions.

+ *

You can filter out task definition families that don't contain any ACTIVE + * task definition revisions by setting the status parameter to + * ACTIVE. You can also filter the results with the + * familyPrefix parameter.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,21 +65,23 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListTaskDefinitionsCommand.ts b/clients/client-ecs/src/commands/ListTaskDefinitionsCommand.ts index 3587013cbfea..7278947164ff 100644 --- a/clients/client-ecs/src/commands/ListTaskDefinitionsCommand.ts +++ b/clients/client-ecs/src/commands/ListTaskDefinitionsCommand.ts @@ -28,9 +28,9 @@ export interface ListTaskDefinitionsCommandInput extends ListTaskDefinitionsRequ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsResponse, __MetadataBearer {} /** - *

Returns a list of task definitions that are registered to your account. You can filter the results by - * family name with the familyPrefix parameter or by status with the status - * parameter.

+ *

Returns a list of task definitions that are registered to your account. You can filter + * the results by family name with the familyPrefix parameter or by status + * with the status parameter.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -62,21 +62,23 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/ListTasksCommand.ts b/clients/client-ecs/src/commands/ListTasksCommand.ts index 53b327244d1a..c28a82c94c2a 100644 --- a/clients/client-ecs/src/commands/ListTasksCommand.ts +++ b/clients/client-ecs/src/commands/ListTasksCommand.ts @@ -28,9 +28,9 @@ export interface ListTasksCommandInput extends ListTasksRequest {} export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBearer {} /** - *

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.

+ *

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.

*

Recently stopped tasks might appear in the returned results.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -67,16 +67,17 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -84,13 +85,15 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/PutAccountSettingCommand.ts b/clients/client-ecs/src/commands/PutAccountSettingCommand.ts index 9c5e32c43f8b..60fa2da0d246 100644 --- a/clients/client-ecs/src/commands/PutAccountSettingCommand.ts +++ b/clients/client-ecs/src/commands/PutAccountSettingCommand.ts @@ -29,9 +29,10 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons /** *

Modifies an account setting. Account settings are set on a per-Region basis.

- *

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 Account Settings in the - * Amazon Elastic Container Service Developer Guide.

+ *

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 + * Account + * Settings in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,21 +64,23 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/PutAccountSettingDefaultCommand.ts b/clients/client-ecs/src/commands/PutAccountSettingDefaultCommand.ts index f1fe9eff3c2c..e94d3738c4e7 100644 --- a/clients/client-ecs/src/commands/PutAccountSettingDefaultCommand.ts +++ b/clients/client-ecs/src/commands/PutAccountSettingDefaultCommand.ts @@ -28,8 +28,8 @@ export interface PutAccountSettingDefaultCommandInput extends PutAccountSettingD export interface PutAccountSettingDefaultCommandOutput extends PutAccountSettingDefaultResponse, __MetadataBearer {} /** - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -60,21 +60,23 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/PutAttributesCommand.ts b/clients/client-ecs/src/commands/PutAttributesCommand.ts index 9f76e374a998..5a1fe7338ed6 100644 --- a/clients/client-ecs/src/commands/PutAttributesCommand.ts +++ b/clients/client-ecs/src/commands/PutAttributesCommand.ts @@ -28,9 +28,9 @@ export interface PutAttributesCommandInput extends PutAttributesRequest {} export interface PutAttributesCommandOutput extends PutAttributesResponse, __MetadataBearer {} /** - *

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 - * DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

+ *

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 DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,17 +70,20 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link AttributeLimitExceededException} (client fault) - *

You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource - * with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

+ *

You can apply up to 10 custom attributes for each resource. You can view the + * attributes of a resource with ListAttributes. + * You can remove existing attributes on a resource with DeleteAttributes.

* * @throws {@link ClusterNotFoundException} (client fault) *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link TargetNotFoundException} (client fault) - *

The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and + *

The specified target wasn't found. You can view your available container instances + * with ListContainerInstances. Amazon ECS container instances are cluster-specific and * Region-specific.

* * @throws {@link ECSServiceException} diff --git a/clients/client-ecs/src/commands/PutClusterCapacityProvidersCommand.ts b/clients/client-ecs/src/commands/PutClusterCapacityProvidersCommand.ts index 2f8b12a3e423..ea63e6a023fc 100644 --- a/clients/client-ecs/src/commands/PutClusterCapacityProvidersCommand.ts +++ b/clients/client-ecs/src/commands/PutClusterCapacityProvidersCommand.ts @@ -30,18 +30,20 @@ export interface PutClusterCapacityProvidersCommandOutput __MetadataBearer {} /** - *

Modifies the available capacity providers and the default capacity provider strategy for a - * cluster.

- *

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 PutClusterCapacityProviders 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.

- *

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 - * ([]) to bypass defining a default strategy.

+ *

Modifies the available capacity providers and the default capacity provider strategy + * for a cluster.

+ *

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 PutClusterCapacityProviders 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.

+ *

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 ([]) to bypass defining a default + * strategy.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -146,16 +148,17 @@ export interface PutClusterCapacityProvidersCommandOutput * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -163,7 +166,8 @@ export interface PutClusterCapacityProvidersCommandOutput *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ResourceInUseException} (client fault) *

The specified resource is in-use and can't be removed.

@@ -172,10 +176,11 @@ export interface PutClusterCapacityProvidersCommandOutput *

These errors are usually caused by a server issue.

* * @throws {@link UpdateInProgressException} (client fault) - *

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 - * PENDING or STAGING, the update process can get stuck in that state. - * However, when the agent reconnects, it resumes where it stopped previously.

+ *

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 PENDING or STAGING, the update + * process can get stuck in that state. However, when the agent reconnects, it resumes + * where it stopped previously.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/RegisterContainerInstanceCommand.ts b/clients/client-ecs/src/commands/RegisterContainerInstanceCommand.ts index 034c3d0bbc07..954fa1ea3246 100644 --- a/clients/client-ecs/src/commands/RegisterContainerInstanceCommand.ts +++ b/clients/client-ecs/src/commands/RegisterContainerInstanceCommand.ts @@ -31,8 +31,8 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine * *

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

* - *

Registers an EC2 instance into the specified cluster. This instance becomes available to place - * containers on.

+ *

Registers an EC2 instance into the specified cluster. This instance becomes available + * to place containers on.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -176,21 +176,23 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/RegisterTaskDefinitionCommand.ts b/clients/client-ecs/src/commands/RegisterTaskDefinitionCommand.ts index 517fcb46bdbd..642e1e1b53ff 100644 --- a/clients/client-ecs/src/commands/RegisterTaskDefinitionCommand.ts +++ b/clients/client-ecs/src/commands/RegisterTaskDefinitionCommand.ts @@ -29,20 +29,21 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit /** *

Registers a new task definition from the supplied family and - * containerDefinitions. Optionally, you can add data volumes to your containers with the - * volumes parameter. For more information about task definition parameters and defaults, - * see Amazon ECS Task + * containerDefinitions. Optionally, you can add data volumes to your + * containers with the volumes parameter. For more information about task + * definition parameters and defaults, see Amazon ECS Task * Definitions in the Amazon Elastic Container Service Developer Guide.

- *

You can specify a role for your task with the taskRoleArn 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 IAM Roles for Tasks in the - * Amazon Elastic Container Service Developer Guide.

- *

You can specify a Docker networking mode for the containers in your task definition with the - * networkMode parameter. If you specify the awsvpc network mode, the task - * is allocated an elastic network interface, and you must specify a NetworkConfiguration when - * you create a service or run a task with the task definition. For more information, see Task - * Networking in the Amazon Elastic Container Service Developer Guide.

+ *

You can specify a role for your task with the taskRoleArn 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 IAM + * Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

+ *

You can specify a Docker networking mode for the containers in your task definition + * with the networkMode parameter. If you specify the awsvpc + * network mode, the task is allocated an elastic network interface, and you must specify a + * NetworkConfiguration when you create a service or run a task with the task + * definition. For more information, see Task Networking + * in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -600,21 +601,23 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/RunTaskCommand.ts b/clients/client-ecs/src/commands/RunTaskCommand.ts index 6cf85f1484d2..c8a059d1db09 100644 --- a/clients/client-ecs/src/commands/RunTaskCommand.ts +++ b/clients/client-ecs/src/commands/RunTaskCommand.ts @@ -35,31 +35,33 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer * *

Amazon Elastic Inference (EI) is no longer available to customers.

* - *

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 Scheduling - * Tasks in the Amazon Elastic Container Service Developer Guide.

- *

Alternatively, you can use StartTask to use your own scheduler or place tasks manually - * on specific container instances.

- *

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a - * service. For more infomation, see Amazon EBS - * volumes in the Amazon Elastic Container Service Developer Guide.

- *

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.

+ *

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 + * Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

+ *

Alternatively, you can use StartTask to use your own scheduler or place + * tasks manually on specific container instances.

+ *

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or + * updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

+ *

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.

*

To manage eventual consistency, you can do the following:

* * @example @@ -383,16 +385,17 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer * Amazon Web Services Support.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -401,22 +404,23 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer * * @throws {@link ConflictException} (client fault) *

The RunTask request could not be processed due to conflicts. The provided - * clientToken is already in use with a different RunTask request. The - * resourceIds are the existing task ARNs which are already associated with the - * clientToken.

+ * clientToken is already in use with a different RunTask + * request. The resourceIds are the existing task ARNs which are already + * associated with the clientToken.

*

To fix this issue:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault) *

The specified platform version doesn't satisfy the required capabilities of the task diff --git a/clients/client-ecs/src/commands/StartTaskCommand.ts b/clients/client-ecs/src/commands/StartTaskCommand.ts index 6c749d9a438d..ff12b70828e7 100644 --- a/clients/client-ecs/src/commands/StartTaskCommand.ts +++ b/clients/client-ecs/src/commands/StartTaskCommand.ts @@ -28,20 +28,18 @@ export interface StartTaskCommandInput extends StartTaskRequest {} export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBearer {} /** - *

Starts a new task from the specified task definition on the specified container instance or - * instances.

+ *

Starts a new task from the specified task definition on the specified container + * instance or instances.

* *

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.

* * *

Amazon Elastic Inference (EI) is no longer available to customers.

* - *

Alternatively, you can useRunTask to place tasks for you. For more information, see - * Scheduling - * Tasks in the Amazon Elastic Container Service Developer Guide.

- *

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a - * service. For more infomation, see Amazon EBS - * volumes in the Amazon Elastic Container Service Developer Guide.

+ *

Alternatively, you can useRunTask to place tasks for you. For more + * information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

+ *

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or + * updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -334,16 +332,17 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -351,7 +350,8 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/StopTaskCommand.ts b/clients/client-ecs/src/commands/StopTaskCommand.ts index c143c3d3bdf0..b46711ead71e 100644 --- a/clients/client-ecs/src/commands/StopTaskCommand.ts +++ b/clients/client-ecs/src/commands/StopTaskCommand.ts @@ -29,18 +29,20 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare /** *

Stops a running task. Any tags associated with the task will be deleted.

- *

When you call StopTask on a task, the equivalent of docker stop is issued - * to the containers running in the task. This results in a SIGTERM value and a default - * 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly - * stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds + *

When you call StopTask on a task, the equivalent of docker + * stop is issued to the containers running in the task. This results in a + * SIGTERM value and a default 30-second timeout, after which the + * SIGKILL value is sent and the containers are forcibly stopped. If the + * container handles the SIGTERM value gracefully and exits within 30 seconds * from receiving it, no SIGKILL value is sent.

- *

For Windows containers, POSIX signals do not work and runtime stops the container by sending a - * CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows) - * container #25982 on GitHub.

+ *

For Windows containers, POSIX signals do not work and runtime stops the container by + * sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown + * of (Windows) container #25982 on GitHub.

* - *

The default 30-second timeout can be configured on the Amazon ECS container agent with the - * ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS - * Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

+ *

The default 30-second timeout can be configured on the Amazon ECS container agent with + * the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see + * Amazon ECS Container Agent Configuration in the + * Amazon Elastic Container Service Developer Guide.

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -227,16 +229,17 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -244,7 +247,8 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts b/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts index 8c2c77bfe299..4f20193ca9ee 100644 --- a/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts +++ b/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts @@ -70,21 +70,23 @@ export interface SubmitAttachmentStateChangesCommandOutput *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts b/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts index 27530e621fda..077fc7f3e8b0 100644 --- a/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts +++ b/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts @@ -75,16 +75,17 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * diff --git a/clients/client-ecs/src/commands/SubmitTaskStateChangeCommand.ts b/clients/client-ecs/src/commands/SubmitTaskStateChangeCommand.ts index 56d5f470f9df..c7c04cb1a3c7 100644 --- a/clients/client-ecs/src/commands/SubmitTaskStateChangeCommand.ts +++ b/clients/client-ecs/src/commands/SubmitTaskStateChangeCommand.ts @@ -99,21 +99,23 @@ export interface SubmitTaskStateChangeCommandOutput extends SubmitTaskStateChang *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/TagResourceCommand.ts b/clients/client-ecs/src/commands/TagResourceCommand.ts index d2e0293e3fc4..02921f8c566f 100644 --- a/clients/client-ecs/src/commands/TagResourceCommand.ts +++ b/clients/client-ecs/src/commands/TagResourceCommand.ts @@ -28,9 +28,10 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *

Associates the specified tags to a resource with the specified resourceArn. 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.

+ *

Associates the specified tags to a resource with the specified + * resourceArn. 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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,16 +60,17 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -76,7 +78,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource wasn't found.

diff --git a/clients/client-ecs/src/commands/UntagResourceCommand.ts b/clients/client-ecs/src/commands/UntagResourceCommand.ts index 41b42f52db54..4830022bab81 100644 --- a/clients/client-ecs/src/commands/UntagResourceCommand.ts +++ b/clients/client-ecs/src/commands/UntagResourceCommand.ts @@ -54,16 +54,17 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -71,7 +72,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource wasn't found.

diff --git a/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts b/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts index 90b77cbfe484..7f49c6a0e78e 100644 --- a/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts +++ b/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts @@ -88,21 +88,23 @@ export interface UpdateCapacityProviderCommandOutput extends UpdateCapacityProvi * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/UpdateClusterCommand.ts b/clients/client-ecs/src/commands/UpdateClusterCommand.ts index b93d0b9cde7c..8805fe9197e3 100644 --- a/clients/client-ecs/src/commands/UpdateClusterCommand.ts +++ b/clients/client-ecs/src/commands/UpdateClusterCommand.ts @@ -149,16 +149,17 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -166,7 +167,8 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link NamespaceNotFoundException} (client fault) *

The specified namespace wasn't found.

diff --git a/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts b/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts index af02d86bba2f..92c0b495ff9e 100644 --- a/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts +++ b/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts @@ -129,16 +129,17 @@ export interface UpdateClusterSettingsCommandOutput extends UpdateClusterSetting * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -146,7 +147,8 @@ export interface UpdateClusterSettingsCommandOutput extends UpdateClusterSetting *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts b/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts index e2bf9f594dfb..e76be08b15fe 100644 --- a/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts +++ b/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts @@ -28,25 +28,25 @@ export interface UpdateContainerAgentCommandInput extends UpdateContainerAgentRe export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentResponse, __MetadataBearer {} /** - *

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.

+ *

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.

* - *

The UpdateContainerAgent 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 - * ecs-init package. This updates the agent. For more information, see Updating - * the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

+ *

The UpdateContainerAgent 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 ecs-init package. This updates the agent. For more + * information, see Updating the + * Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

* * - *

Agent updates with the UpdateContainerAgent 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.

+ *

Agent updates with the UpdateContainerAgent 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.

* - *

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with - * the ecs-init service installed and running. For help updating the Amazon ECS container agent on - * other operating systems, see Manually updating - * the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

+ *

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon + * Linux AMI with the ecs-init service installed and running. For help + * updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -151,16 +151,17 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -168,26 +169,29 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link MissingVersionException} (client fault) - *

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.

+ *

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.

* * @throws {@link NoUpdateAvailableException} (client fault) - *

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.

+ *

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.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link UpdateInProgressException} (client fault) - *

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 - * PENDING or STAGING, the update process can get stuck in that state. - * However, when the agent reconnects, it resumes where it stopped previously.

+ *

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 PENDING or STAGING, the update + * process can get stuck in that state. However, when the agent reconnects, it resumes + * where it stopped previously.

* * @throws {@link ECSServiceException} *

Base exception class for all service exceptions from ECS service.

diff --git a/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts b/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts index 291786de1369..9b7e41f46746 100644 --- a/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts +++ b/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts @@ -34,50 +34,54 @@ export interface UpdateContainerInstancesStateCommandOutput /** *

Modifies the status of an Amazon ECS container instance.

- *

Once a container instance has reached an ACTIVE state, you can change the status of a - * container instance to DRAINING to manually remove an instance from a cluster, for example - * to perform system updates, update the Docker daemon, or scale down the cluster size.

+ *

Once a container instance has reached an ACTIVE state, you can change the + * status of a container instance to DRAINING to manually remove an instance + * from a cluster, for example to perform system updates, update the Docker daemon, or + * scale down the cluster size.

* - *

A container instance can't be changed to DRAINING until it has reached an - * ACTIVE status. If the instance is in any other status, an error will be - * received.

+ *

A container instance can't be changed to DRAINING until it has + * reached an ACTIVE status. If the instance is in any other status, an + * error will be received.

* - *

When you set a container instance to DRAINING, 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 PENDING state are stopped immediately.

- *

Service tasks on the container instance that are in the RUNNING state are stopped and - * replaced according to the service's deployment configuration parameters, - * minimumHealthyPercent and maximumPercent. You can change the deployment - * configuration of your service using UpdateService.

+ *

When you set a container instance to DRAINING, 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 PENDING + * state are stopped immediately.

+ *

Service tasks on the container instance that are in the RUNNING state are + * stopped and replaced according to the service's deployment configuration parameters, + * minimumHealthyPercent and maximumPercent. You can change + * the deployment configuration of your service using UpdateService.

* - *

Any PENDING or RUNNING tasks that do not belong to a service aren't - * affected. You must wait for them to finish or stop them manually.

- *

A container instance has completed draining when it has no more RUNNING tasks. You can - * verify this using ListTasks.

- *

When a container instance has been drained, you can set a container instance to ACTIVE - * status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the - * instance again.

+ *

Any PENDING or RUNNING tasks that do not belong to a service + * aren't affected. You must wait for them to finish or stop them manually.

+ *

A container instance has completed draining when it has no more RUNNING + * tasks. You can verify this using ListTasks.

+ *

When a container instance has been drained, you can set a container instance to + * ACTIVE status and once it has reached that status the Amazon ECS scheduler + * can begin scheduling tasks on the instance again.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -194,16 +198,17 @@ export interface UpdateContainerInstancesStateCommandOutput * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -211,7 +216,8 @@ export interface UpdateContainerInstancesStateCommandOutput *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

diff --git a/clients/client-ecs/src/commands/UpdateServiceCommand.ts b/clients/client-ecs/src/commands/UpdateServiceCommand.ts index c1fe0021eed1..5b41e9571321 100644 --- a/clients/client-ecs/src/commands/UpdateServiceCommand.ts +++ b/clients/client-ecs/src/commands/UpdateServiceCommand.ts @@ -32,111 +32,117 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met * *

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.

* - *

For services using the rolling update (ECS) 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.

- *

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 Amazon EBS - * volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new - * deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON - * service. If you leave volumeConfigurations - * null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS - * volumes in the Amazon Elastic Container Service Developer Guide.

- *

For services using the blue/green (CODE_DEPLOY) 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 CreateDeployment in the - * CodeDeploy API Reference.

- *

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 CreateTaskSet.

- *

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 desiredCount - * parameter.

- *

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 Amazon EBS - * volumes in the Amazon Elastic Container Service Developer Guide.

- *

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.

+ *

For services using the rolling update (ECS) 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.

+ *

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 Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update + * your volume configurations and trigger a new deployment. + * volumeConfigurations is only supported for REPLICA service and not + * DAEMON service. If you leave volumeConfigurations + * null, it doesn't trigger a new deployment. For more infomation on volumes, + * see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

+ *

For services using the blue/green (CODE_DEPLOY) 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 CreateDeployment in the CodeDeploy API Reference.

+ *

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 CreateTaskSet.

+ *

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 + * desiredCount parameter.

+ *

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 Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

+ *

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.

* - *

If your updated Docker image uses the same tag as what is in the existing task definition for - * your service (for example, my_image:latest), you don't need to create a new revision - * of your task definition. You can update the service using the forceNewDeployment - * option. The new tasks launched by the deployment pull the current image/tag combination from your - * repository when they start.

+ *

If your updated Docker image uses the same tag as what is in the existing task + * definition for your service (for example, my_image:latest), you don't + * need to create a new revision of your task definition. You can update the service + * using the forceNewDeployment option. The new tasks launched by the + * deployment pull the current image/tag combination from your repository when they + * start.

* - *

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, minimumHealthyPercent and maximumPercent, to determine the - * deployment strategy.

+ *

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, minimumHealthyPercent and + * maximumPercent, to determine the deployment strategy.

* - *

When UpdateService stops a task during a deployment, the equivalent of docker stop - * is issued to the containers running in the task. This results in a SIGTERM and a 30-second - * timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the - * container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no - * SIGKILL is sent.

- *

When the service scheduler launches new tasks, it determines task placement in your cluster with the - * following logic.

+ *

When UpdateService + * stops a task during a deployment, the equivalent of docker stop is issued + * to the containers running in the task. This results in a SIGTERM and a + * 30-second timeout. After this, SIGKILL is sent and the containers are + * forcibly stopped. If the container handles the SIGTERM gracefully and exits + * within 30 seconds from receiving it, no SIGKILL is sent.

+ *

When the service scheduler launches new tasks, it determines task placement in your + * cluster with the following logic.

* - *

When the service scheduler stops running tasks, it attempts to maintain balance across the - * Availability Zones in your cluster using the following logic:

+ *

When the service scheduler stops running tasks, it attempts to maintain balance across + * the Availability Zones in your cluster using the following logic:

* * @@ -153,7 +159,8 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *

* * - *

For more information about the role see the CreateService request parameter + *

For more information about the role see the CreateService request + * parameter * role * .

* @@ -608,16 +615,17 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -625,7 +633,8 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link NamespaceNotFoundException} (client fault) *

The specified namespace wasn't found.

@@ -641,11 +650,12 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotActiveException} (client fault) - *

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 CreateService.

+ *

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 CreateService.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts b/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts index c9c2e561423c..27b9b810c3a3 100644 --- a/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts @@ -30,9 +30,10 @@ export interface UpdateServicePrimaryTaskSetCommandOutput __MetadataBearer {} /** - *

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 - * EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment + *

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 EXTERNAL deployment controller type. For more + * information, see Amazon ECS Deployment * Types in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -129,16 +130,17 @@ export interface UpdateServicePrimaryTaskSetCommandOutput *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -146,20 +148,23 @@ export interface UpdateServicePrimaryTaskSetCommandOutput *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotActiveException} (client fault) - *

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 CreateService.

+ *

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 CreateService.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link TaskSetNotFoundException} (client fault) - *

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

+ *

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and + * Region.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/commands/UpdateTaskProtectionCommand.ts b/clients/client-ecs/src/commands/UpdateTaskProtectionCommand.ts index e4e96868440d..5b7ba765d057 100644 --- a/clients/client-ecs/src/commands/UpdateTaskProtectionCommand.ts +++ b/clients/client-ecs/src/commands/UpdateTaskProtectionCommand.ts @@ -29,28 +29,31 @@ export interface UpdateTaskProtectionCommandOutput extends UpdateTaskProtectionR /** *

Updates the protection status of a task. You can set protectionEnabled to - * true to protect your task from termination during scale-in events from Service + * true to protect your task from termination during scale-in events from + * Service * Autoscaling or deployments.

*

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the - * protectionEnabled property making the task eligible for termination by a subsequent - * scale-in event.

- *

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 expiresInMinutes property. - * The expiresInMinutes property is always reset when you invoke this operation for a task - * that already has protectionEnabled set to true. You can keep extending the + * protectionEnabled property making the task eligible for termination by + * a subsequent scale-in event.

+ *

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 + * expiresInMinutes property. The expiresInMinutes property + * is always reset when you invoke this operation for a task that already has + * protectionEnabled set to true. You can keep extending the * protection expiration period of a task by invoking this operation repeatedly.

*

To learn more about Amazon ECS task protection, see Task scale-in * protection in the * Amazon Elastic Container Service Developer Guide * .

* - *

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation - * for a standalone task will result in an TASK_NOT_VALID failure. For more information, - * see API failure reasons.

+ *

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking + * this operation for a standalone task will result in an TASK_NOT_VALID + * failure. For more information, see API failure + * reasons.

* * - *

If you prefer to set task protection from within the container, we recommend using the Task scale-in - * protection endpoint.

+ *

If you prefer to set task protection from within the container, we recommend using + * the Task scale-in protection endpoint.

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -97,16 +100,17 @@ export interface UpdateTaskProtectionCommandOutput extends UpdateTaskProtectionR *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -114,7 +118,8 @@ export interface UpdateTaskProtectionCommandOutput extends UpdateTaskProtectionR *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource wasn't found.

diff --git a/clients/client-ecs/src/commands/UpdateTaskSetCommand.ts b/clients/client-ecs/src/commands/UpdateTaskSetCommand.ts index f4fd11bd1e9b..b18976d85752 100644 --- a/clients/client-ecs/src/commands/UpdateTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/UpdateTaskSetCommand.ts @@ -28,9 +28,9 @@ export interface UpdateTaskSetCommandInput extends UpdateTaskSetRequest {} export interface UpdateTaskSetCommandOutput extends UpdateTaskSetResponse, __MetadataBearer {} /** - *

Modifies a task set. This is used when a service uses the EXTERNAL deployment controller - * type. For more information, see Amazon ECS Deployment Types in the - * Amazon Elastic Container Service Developer Guide.

+ *

Modifies a task set. This is used when a service uses the EXTERNAL + * deployment controller type. For more information, see Amazon ECS Deployment + * Types in the Amazon Elastic Container Service Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -130,16 +130,17 @@ export interface UpdateTaskSetCommandOutput extends UpdateTaskSetResponse, __Met *

You don't have authorization to perform the requested action.

* * @throws {@link ClientException} (client fault) - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @@ -147,20 +148,23 @@ export interface UpdateTaskSetCommandOutput extends UpdateTaskSetResponse, __Met *

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

* * @throws {@link InvalidParameterException} (client fault) - *

The specified parameter isn't valid. Review the available parameters for the API request.

+ *

The specified parameter isn't valid. Review the available parameters for the API + * request.

* * @throws {@link ServerException} (server fault) *

These errors are usually caused by a server issue.

* * @throws {@link ServiceNotActiveException} (client fault) - *

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 CreateService.

+ *

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 CreateService.

* * @throws {@link ServiceNotFoundException} (client fault) - *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

+ *

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region + * specific.

* * @throws {@link TaskSetNotFoundException} (client fault) - *

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

+ *

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and + * Region.

* * @throws {@link UnsupportedFeatureException} (client fault) *

The specified task isn't supported in this Region.

diff --git a/clients/client-ecs/src/index.ts b/clients/client-ecs/src/index.ts index 39b141f82498..da05cd9a4f8f 100644 --- a/clients/client-ecs/src/index.ts +++ b/clients/client-ecs/src/index.ts @@ -2,17 +2,18 @@ /* eslint-disable */ /** * Amazon Elastic Container Service - *

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.

- *

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.

- *

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.

+ *

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.

+ *

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.

+ *

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.

* * @packageDocumentation */ diff --git a/clients/client-ecs/src/models/models_0.ts b/clients/client-ecs/src/models/models_0.ts index 02b769506155..ea4f65017b2a 100644 --- a/clients/client-ecs/src/models/models_0.ts +++ b/clients/client-ecs/src/models/models_0.ts @@ -42,16 +42,17 @@ export const AgentUpdateStatus = { export type AgentUpdateStatus = (typeof AgentUpdateStatus)[keyof typeof AgentUpdateStatus]; /** - *

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.

+ *

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.

*

The following list includes additional causes for the error:

* * @public @@ -102,11 +103,12 @@ export type ManagedScalingStatus = (typeof ManagedScalingStatus)[keyof typeof Ma /** *

The managed scaling settings for the Auto Scaling group capacity provider.

- *

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto - * Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with - * the specified targetCapacity value as the target value for the metric. For more - * information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

- *

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

+ *

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of + * the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS + * managed CloudWatch metric with the specified targetCapacity value as the target + * value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

+ *

If managed scaling is off, the user must manage the scaling of the Auto Scaling + * group.

* @public */ export interface ManagedScaling { @@ -117,39 +119,42 @@ export interface ManagedScaling { status?: ManagedScalingStatus | undefined; /** - *

The target capacity utilization as a percentage for the capacity provider. The specified value must - * be greater than 0 and less than or equal to 100. For example, if you want the - * capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a - * targetCapacity of 90. The default value of 100 percent - * results in the Amazon EC2 instances in your Auto Scaling group being completely used.

+ *

The target capacity utilization as a percentage for the capacity provider. The + * specified value must be greater than 0 and less than or equal to + * 100. For example, if you want the capacity provider to maintain 10% + * spare capacity, then that means the utilization is 90%, so use a + * targetCapacity of 90. The default value of + * 100 percent results in the Amazon EC2 instances in your Auto Scaling group + * being completely used.

* @public */ targetCapacity?: number | undefined; /** - *

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is - * not affected by this parameter If this parameter is omitted, the default value of 1 is - * used.

- *

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the - * actual demand is less than the minimum scaling step size.

- *

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 - * instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value - * and will ignore both the maximum scaling step size as well as the capacity demand.

+ *

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale + * in process is not affected by this parameter If this parameter is omitted, the default + * value of 1 is used.

+ *

When additional capacity is required, Amazon ECS will scale up the minimum scaling step + * size even if the actual demand is less than the minimum scaling step size.

+ *

If you use a capacity provider with an Auto Scaling group configured with more than + * one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum + * scaling step size value and will ignore both the maximum scaling step size as well as + * the capacity demand.

* @public */ minimumScalingStepSize?: number | undefined; /** - *

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is - * omitted, the default value of 10000 is used.

+ *

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this + * parameter is omitted, the default value of 10000 is used.

* @public */ maximumScalingStepSize?: number | undefined; /** - *

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics - * for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is - * used.

+ *

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute + * to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value + * of 300 seconds is used.

* @public */ instanceWarmupPeriod?: number | undefined; @@ -176,7 +181,8 @@ export type ManagedTerminationProtection = */ export interface AutoScalingGroupProvider { /** - *

The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

+ *

The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group + * name.

* @public */ autoScalingGroupArn: string | undefined; @@ -188,20 +194,19 @@ export interface AutoScalingGroupProvider { managedScaling?: ManagedScaling | undefined; /** - *

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. The default is - * off.

+ *

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. The default is off.

* - *

When using managed termination protection, managed scaling must also be used otherwise managed - * termination protection doesn't work.

+ *

When using managed termination protection, managed scaling must also be used + * otherwise managed termination protection doesn't work.

* - *

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 as well. - * For more information, see Instance - * Protection in the Auto Scaling User Guide.

- *

When managed termination protection is off, your Amazon EC2 instances aren't protected from termination - * when the Auto Scaling group scales in.

+ *

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 as well. For more information, see Instance Protection in the Auto Scaling User Guide.

+ *

When managed termination protection is off, your Amazon EC2 instances aren't protected from + * termination when the Auto Scaling group scales in.

* @public */ managedTerminationProtection?: ManagedTerminationProtection | undefined; @@ -214,8 +219,8 @@ export interface AutoScalingGroupProvider { } /** - *

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists - * of a key and an optional value. You define them.

+ *

The metadata that you apply to a resource to help you categorize and organize them. + * Each tag consists of a key and an optional value. You define them.

*

The following basic restrictions apply to tags:

*