Skip to content

Commit bfa01d6

Browse files
author
awstools
committed
docs(client-ecs): Documentation updates for Amazon ECS
1 parent 8d9c286 commit bfa01d6

15 files changed

+277
-308
lines changed

‎clients/client-ecs/src/ECS.ts

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -322,8 +322,7 @@ export class ECS extends ECSClient {
322322
* required resources in other Amazon Web Services services on your behalf. However, if the IAM user
323323
* that makes the call doesn't have permissions to create the service-linked role, it
324324
* isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
325-
* service-linked roles for Amazon ECS</a> in the
326-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
325+
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
327326
* </note>
328327
*/
329328
public createCluster(
@@ -363,8 +362,7 @@ export class ECS extends ECSClient {
363362
* <p>In addition to maintaining the desired count of tasks in your service, you can
364363
* optionally run your service behind one or more load balancers. The load balancers
365364
* distribute traffic across the tasks that are associated with the service. For more
366-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
367-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
365+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
368366
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
369367
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
370368
* considered healthy if they're in the <code>RUNNING</code> state and are reported as
@@ -377,8 +375,7 @@ export class ECS extends ECSClient {
377375
* maintains your desired number of tasks across your cluster. By default, the
378376
* service scheduler spreads tasks across Availability Zones. You can use task
379377
* placement strategies and constraints to customize task placement decisions. For
380-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
381-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
378+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
382379
* </li>
383380
* <li>
384381
* <p>
@@ -388,8 +385,7 @@ export class ECS extends ECSClient {
388385
* evaluates the task placement constraints for running tasks. It also stops tasks
389386
* that don't meet the placement constraints. When using this strategy, you don't
390387
* need to specify a desired number of tasks, a task placement strategy, or use
391-
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
392-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
388+
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
393389
* </li>
394390
* </ul>
395391
* <p>You can optionally specify a deployment configuration for your service. The deployment
@@ -433,8 +429,9 @@ export class ECS extends ECSClient {
433429
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
434430
* can specify only parameters that aren't controlled at the task set level. The only
435431
* required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
436-
* <p>When the service scheduler launches new tasks, it determines task placement. For information
437-
* about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
432+
* <p>When the service scheduler launches new tasks, it determines task placement. For
433+
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
434+
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
438435
*/
439436
public createService(
440437
args: CreateServiceCommandInput,
@@ -1265,8 +1262,7 @@ export class ECS extends ECSClient {
12651262
/**
12661263
* <p>Returns a list of container instances in a specified cluster. You can filter the
12671264
* results of a <code>ListContainerInstances</code> operation with cluster query language
1268-
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the
1269-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1265+
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
12701266
*/
12711267
public listContainerInstances(
12721268
args: ListContainerInstancesCommandInput,
@@ -1328,11 +1324,11 @@ export class ECS extends ECSClient {
13281324
}
13291325

13301326
/**
1331-
* <p>This operation lists all of the services that are associated with a Cloud Map namespace. This list
1332-
* might include services in different clusters. In contrast, <code>ListServices</code> can
1333-
* only list services in one cluster at a time. If you need to filter the list of
1334-
* services in a single cluster by various parameters, use <code>ListServices</code>.
1335-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1327+
* <p>This operation lists all of the services that are associated with a Cloud Map
1328+
* namespace. This list might include services in different clusters. In contrast,
1329+
* <code>ListServices</code> can only list services in one cluster at a time. If you
1330+
* need to filter the list of services in a single cluster by various parameters, use
1331+
* <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
13361332
*/
13371333
public listServicesByNamespace(
13381334
args: ListServicesByNamespaceCommandInput,
@@ -1590,8 +1586,7 @@ export class ECS extends ECSClient {
15901586
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
15911587
* it's created. If the attribute exists, its value is replaced with the specified value.
15921588
* To delete an attribute, use <a>DeleteAttributes</a>. For more information,
1593-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the
1594-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1589+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
15951590
*/
15961591
public putAttributes(
15971592
args: PutAttributesCommandInput,
@@ -1756,8 +1751,7 @@ export class ECS extends ECSClient {
17561751
* <p>Starts a new task using the specified task definition.</p>
17571752
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
17581753
* tasks using placement constraints and placement strategies. For more information, see
1759-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the
1760-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1754+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
17611755
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
17621756
* place tasks manually on specific container instances.</p>
17631757
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the
@@ -1810,8 +1804,7 @@ export class ECS extends ECSClient {
18101804
* <p>Starts a new task from the specified task definition on the specified container
18111805
* instance or instances.</p>
18121806
* <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
1813-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the
1814-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1807+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
18151808
*/
18161809
public startTask(args: StartTaskCommandInput, options?: __HttpHandlerOptions): Promise<StartTaskCommandOutput>;
18171810
public startTask(args: StartTaskCommandInput, cb: (err: any, data?: StartTaskCommandOutput) => void): void;
@@ -1848,7 +1841,7 @@ export class ECS extends ECSClient {
18481841
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent with
18491842
* the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see
18501843
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the
1851-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1844+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
18521845
* </note>
18531846
*/
18541847
public stopTask(args: StopTaskCommandInput, options?: __HttpHandlerOptions): Promise<StopTaskCommandOutput>;
@@ -2146,8 +2139,7 @@ export class ECS extends ECSClient {
21462139
* using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
21472140
* you can update the <code>ecs-init</code> package. This updates the agent. For more
21482141
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
2149-
* Amazon ECS container agent</a> in the
2150-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
2142+
* Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
21512143
* </note>
21522144
* <note>
21532145
* <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not
@@ -2156,8 +2148,7 @@ export class ECS extends ECSClient {
21562148
* </note>
21572149
* <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon
21582150
* Linux AMI with the <code>ecs-init</code> service installed and running. For help
2159-
* updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the
2160-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
2151+
* updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
21612152
*/
21622153
public updateContainerAgent(
21632154
args: UpdateContainerAgentCommandInput,
@@ -2379,8 +2370,7 @@ export class ECS extends ECSClient {
23792370
* <p>You must have a service-linked role when you update any of the following service
23802371
* properties. If you specified a custom IAM role when you created the service, Amazon ECS
23812372
* automatically replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your
2382-
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the
2383-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
2373+
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
23842374
* <ul>
23852375
* <li>
23862376
* <p>

‎clients/client-ecs/src/commands/CreateClusterCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
3838
* required resources in other Amazon Web Services services on your behalf. However, if the IAM user
3939
* that makes the call doesn't have permissions to create the service-linked role, it
4040
* isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
41-
* service-linked roles for Amazon ECS</a> in the
42-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
41+
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4342
* </note>
4443
* @example
4544
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ecs/src/commands/CreateServiceCommand.ts

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
3636
* <p>In addition to maintaining the desired count of tasks in your service, you can
3737
* optionally run your service behind one or more load balancers. The load balancers
3838
* distribute traffic across the tasks that are associated with the service. For more
39-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
40-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
39+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4140
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
4241
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
4342
* considered healthy if they're in the <code>RUNNING</code> state and are reported as
@@ -50,8 +49,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
5049
* maintains your desired number of tasks across your cluster. By default, the
5150
* service scheduler spreads tasks across Availability Zones. You can use task
5251
* placement strategies and constraints to customize task placement decisions. For
53-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
54-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
52+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
5553
* </li>
5654
* <li>
5755
* <p>
@@ -61,8 +59,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
6159
* evaluates the task placement constraints for running tasks. It also stops tasks
6260
* that don't meet the placement constraints. When using this strategy, you don't
6361
* need to specify a desired number of tasks, a task placement strategy, or use
64-
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
65-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
62+
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
6663
* </li>
6764
* </ul>
6865
* <p>You can optionally specify a deployment configuration for your service. The deployment
@@ -106,8 +103,9 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
106103
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
107104
* can specify only parameters that aren't controlled at the task set level. The only
108105
* required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
109-
* <p>When the service scheduler launches new tasks, it determines task placement. For information
110-
* about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
106+
* <p>When the service scheduler launches new tasks, it determines task placement. For
107+
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
108+
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
111109
* @example
112110
* Use a bare-bones client and the command you need to make an API call.
113111
* ```javascript

‎clients/client-ecs/src/commands/ListContainerInstancesCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
3131
/**
3232
* <p>Returns a list of container instances in a specified cluster. You can filter the
3333
* results of a <code>ListContainerInstances</code> operation with cluster query language
34-
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the
35-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
34+
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
3635
* @example
3736
* Use a bare-bones client and the command you need to make an API call.
3837
* ```javascript

0 commit comments

Comments
 (0)