Skip to content

Commit 8dfab18

Browse files
author
awstools
committed
docs(client-ecs): This is a documentation only update to address various tickets for Amazon ECS.
1 parent f62407a commit 8dfab18

File tree

66 files changed

+5439
-4743
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+5439
-4743
lines changed

clients/client-ecs/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,18 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
88

99
<fullname>Amazon Elastic Container Service</fullname>
1010

11-
<p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
12-
stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
13-
managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
14-
tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
15-
<p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
16-
it easy to get the state of your cluster from a centralized service, and gives you access to many
17-
familiar Amazon EC2 features.</p>
18-
<p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
19-
needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
20-
own cluster management and configuration management systems. You also don't need to worry about scaling
21-
your management infrastructure. </p>
11+
<p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
12+
it easy to run, stop, and manage Docker containers. You can host your cluster on a
13+
serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
14+
Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
15+
or External (on-premises) instances that you manage.</p>
16+
<p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
17+
calls. This makes it easy to get the state of your cluster from a centralized service,
18+
and gives you access to many familiar Amazon EC2 features.</p>
19+
<p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
20+
your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
21+
don't need to operate your own cluster management and configuration management systems.
22+
You also don't need to worry about scaling your management infrastructure. </p>
2223

2324
## Installing
2425

clients/client-ecs/src/ECS.ts

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,17 +1242,18 @@ export interface ECS {
12421242

12431243
/**
12441244
* <fullname>Amazon Elastic Container Service</fullname>
1245-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
1246-
* stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
1247-
* managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
1248-
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
1249-
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
1250-
* it easy to get the state of your cluster from a centralized service, and gives you access to many
1251-
* familiar Amazon EC2 features.</p>
1252-
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
1253-
* needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
1254-
* own cluster management and configuration management systems. You also don't need to worry about scaling
1255-
* your management infrastructure. </p>
1245+
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
1246+
* it easy to run, stop, and manage Docker containers. You can host your cluster on a
1247+
* serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
1248+
* Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
1249+
* or External (on-premises) instances that you manage.</p>
1250+
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
1251+
* calls. This makes it easy to get the state of your cluster from a centralized service,
1252+
* and gives you access to many familiar Amazon EC2 features.</p>
1253+
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
1254+
* your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
1255+
* don't need to operate your own cluster management and configuration management systems.
1256+
* You also don't need to worry about scaling your management infrastructure. </p>
12561257
* @public
12571258
*/
12581259
export class ECS extends ECSClient implements ECS {}

clients/client-ecs/src/ECSClient.ts

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -520,17 +520,18 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {}
520520

521521
/**
522522
* <fullname>Amazon Elastic Container Service</fullname>
523-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
524-
* stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
525-
* managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
526-
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
527-
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
528-
* it easy to get the state of your cluster from a centralized service, and gives you access to many
529-
* familiar Amazon EC2 features.</p>
530-
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
531-
* needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
532-
* own cluster management and configuration management systems. You also don't need to worry about scaling
533-
* your management infrastructure. </p>
523+
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
524+
* it easy to run, stop, and manage Docker containers. You can host your cluster on a
525+
* serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
526+
* Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
527+
* or External (on-premises) instances that you manage.</p>
528+
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
529+
* calls. This makes it easy to get the state of your cluster from a centralized service,
530+
* and gives you access to many familiar Amazon EC2 features.</p>
531+
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
532+
* your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
533+
* don't need to operate your own cluster management and configuration management systems.
534+
* You also don't need to worry about scaling your management infrastructure. </p>
534535
* @public
535536
*/
536537
export class ECSClient extends __Client<

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

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,13 @@ export interface CreateCapacityProviderCommandInput extends CreateCapacityProvid
2828
export interface CreateCapacityProviderCommandOutput extends CreateCapacityProviderResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used
32-
* in capacity provider strategies to facilitate cluster auto scaling.</p>
33-
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use
34-
* the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers. These providers are
35-
* available to all accounts in the Amazon Web Services Regions that Fargate supports.</p>
31+
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
32+
* cluster and are used in capacity provider strategies to facilitate cluster auto
33+
* scaling.</p>
34+
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
35+
* Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.
36+
* These providers are available to all accounts in the Amazon Web Services Regions that Fargate
37+
* supports.</p>
3638
* @example
3739
* Use a bare-bones client and the command you need to make an API call.
3840
* ```javascript
@@ -99,21 +101,23 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
99101
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
100102
*
101103
* @throws {@link ClientException} (client fault)
102-
* <p>These errors are usually caused by a client action. This client action might be using an action or
103-
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
104-
* be specifying an identifier that isn't valid.</p>
104+
* <p>These errors are usually caused by a client action. This client action might be using
105+
* an action or resource on behalf of a user that doesn't have permissions to use the
106+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
105107
* <p>The following list includes additional causes for the error:</p>
106108
* <ul>
107109
* <li>
108-
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
109-
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
110-
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
111-
* quotas</a>.</p>
110+
* <p>The <code>RunTask</code> could not be processed because you use managed
111+
* scaling and there is a capacity error because the quota of tasks in the
112+
* <code>PROVISIONING</code> per cluster has been reached. For information
113+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
114+
* service quotas</a>.</p>
112115
* </li>
113116
* </ul>
114117
*
115118
* @throws {@link InvalidParameterException} (client fault)
116-
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
119+
* <p>The specified parameter isn't valid. Review the available parameters for the API
120+
* request.</p>
117121
*
118122
* @throws {@link LimitExceededException} (client fault)
119123
* <p>The limit for the resource was exceeded.</p>
@@ -122,10 +126,11 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
122126
* <p>These errors are usually caused by a server issue.</p>
123127
*
124128
* @throws {@link UpdateInProgressException} (client fault)
125-
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's
126-
* specified. If the container agent becomes disconnected while it's in a transitional stage, such as
127-
* <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state.
128-
* However, when the agent reconnects, it resumes where it stopped previously.</p>
129+
* <p>There's already a current Amazon ECS container agent update in progress on the container
130+
* instance that's specified. If the container agent becomes disconnected while it's in a
131+
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
132+
* process can get stuck in that state. However, when the agent reconnects, it resumes
133+
* where it stopped previously.</p>
129134
*
130135
* @throws {@link ECSServiceException}
131136
* <p>Base exception class for all service exceptions from ECS service.</p>

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

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ export interface CreateClusterCommandInput extends CreateClusterRequest {}
2828
export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when
32-
* you launch your first container instance. However, you can create your own cluster with a unique
33-
* name.</p>
31+
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
32+
* cluster when you launch your first container instance. However, you can create your own
33+
* cluster with a unique name.</p>
3434
* <note>
35-
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation,
36-
* Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can
37-
* manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes
38-
* the call doesn't have permissions to create the service-linked role, it isn't created. For more
39-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked
40-
* roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
35+
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a>
36+
* API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your
37+
* account. This is so that it can manage required resources in other Amazon Web Services services on
38+
* your behalf. However, if the user that makes the call doesn't have permissions to
39+
* create the service-linked role, it isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
40+
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4141
* </note>
4242
* @example
4343
* 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
175175
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
176176
*
177177
* @throws {@link ClientException} (client fault)
178-
* <p>These errors are usually caused by a client action. This client action might be using an action or
179-
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
180-
* be specifying an identifier that isn't valid.</p>
178+
* <p>These errors are usually caused by a client action. This client action might be using
179+
* an action or resource on behalf of a user that doesn't have permissions to use the
180+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
181181
* <p>The following list includes additional causes for the error:</p>
182182
* <ul>
183183
* <li>
184-
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
185-
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
186-
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
187-
* quotas</a>.</p>
184+
* <p>The <code>RunTask</code> could not be processed because you use managed
185+
* scaling and there is a capacity error because the quota of tasks in the
186+
* <code>PROVISIONING</code> per cluster has been reached. For information
187+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
188+
* service quotas</a>.</p>
188189
* </li>
189190
* </ul>
190191
*
191192
* @throws {@link InvalidParameterException} (client fault)
192-
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
193+
* <p>The specified parameter isn't valid. Review the available parameters for the API
194+
* request.</p>
193195
*
194196
* @throws {@link NamespaceNotFoundException} (client fault)
195197
* <p>The specified namespace wasn't found.</p>

0 commit comments

Comments
 (0)