Skip to content

Commit 20258a5

Browse files
author
awstools
committed
feat(client-ecs): Migrated to Smithy. No functional changes
1 parent 83535fc commit 20258a5

File tree

77 files changed

+24593
-30963
lines changed

Some content is hidden

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

77 files changed

+24593
-30963
lines changed

clients/client-ecs/README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,7 @@
66

77
AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
88

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

2511
## Installing
2612
To install this package, simply type add or install @aws-sdk/client-ecs

clients/client-ecs/src/ECS.ts

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1651,21 +1651,7 @@ export interface ECS {
16511651
}
16521652

16531653
/**
1654-
* <fullname>Amazon Elastic Container Service</fullname>
1655-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container
1656-
* management service. It makes it easy to run, stop, and manage Docker containers. You can
1657-
* host your cluster on a serverless infrastructure that's managed by Amazon ECS by
1658-
* launching your services or tasks on Fargate. For more control, you can host your
1659-
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External
1660-
* (on-premises) instances that you manage.</p>
1661-
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple
1662-
* API calls. This makes it easy to get the state of your cluster from a centralized
1663-
* service, and gives you access to many familiar Amazon EC2 features.</p>
1664-
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster
1665-
* based on your resource needs, isolation policies, and availability requirements. With
1666-
* Amazon ECS, you don't need to operate your own cluster management and configuration
1667-
* management systems. You also don't need to worry about scaling your management
1668-
* infrastructure. </p>
1654+
* <fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure. </p>
16691655
* @public
16701656
*/
16711657
export class ECS extends ECSClient implements ECS {}

clients/client-ecs/src/ECSClient.ts

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -578,21 +578,7 @@ export type ECSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
578578
export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {}
579579

580580
/**
581-
* <fullname>Amazon Elastic Container Service</fullname>
582-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container
583-
* management service. It makes it easy to run, stop, and manage Docker containers. You can
584-
* host your cluster on a serverless infrastructure that's managed by Amazon ECS by
585-
* launching your services or tasks on Fargate. For more control, you can host your
586-
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External
587-
* (on-premises) instances that you manage.</p>
588-
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple
589-
* API calls. This makes it easy to get the state of your cluster from a centralized
590-
* service, and gives you access to many familiar Amazon EC2 features.</p>
591-
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster
592-
* based on your resource needs, isolation policies, and availability requirements. With
593-
* Amazon ECS, you don't need to operate your own cluster management and configuration
594-
* management systems. You also don't need to worry about scaling your management
595-
* infrastructure. </p>
581+
* <fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure. </p>
596582
* @public
597583
*/
598584
export class ECSClient extends __Client<

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

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,7 @@ export interface CreateCapacityProviderCommandInput extends CreateCapacityProvid
2727
export interface CreateCapacityProviderCommandOutput extends CreateCapacityProviderResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates a capacity provider. Capacity providers are associated with a cluster and are
31-
* used in capacity provider strategies to facilitate cluster auto scaling. You can create
32-
* capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the
33-
* predefined <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.</p>
30+
* <p>Creates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.</p>
3431
* @example
3532
* Use a bare-bones client and the command you need to make an API call.
3633
* ```javascript
@@ -288,18 +285,13 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
288285
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
289286
*
290287
* @throws {@link ClientException} (client fault)
291-
* <p>These errors are usually caused by a client action. This client action might be using
292-
* an action or resource on behalf of a user that doesn't have permissions to use the
293-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
288+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
294289
*
295290
* @throws {@link ClusterNotFoundException} (client fault)
296291
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
297292
*
298293
* @throws {@link InvalidParameterException} (client fault)
299-
* <p>The specified parameter isn't valid. Review the available parameters for the API
300-
* request.</p>
301-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
302-
* service event messages</a>. </p>
294+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
303295
*
304296
* @throws {@link LimitExceededException} (client fault)
305297
* <p>The limit for the resource was exceeded.</p>
@@ -311,11 +303,7 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
311303
* <p>The specified task isn't supported in this Region.</p>
312304
*
313305
* @throws {@link UpdateInProgressException} (client fault)
314-
* <p>There's already a current Amazon ECS container agent update in progress on the
315-
* container instance that's specified. If the container agent becomes disconnected while
316-
* it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the
317-
* update process can get stuck in that state. However, when the agent reconnects, it
318-
* resumes where it stopped previously.</p>
306+
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>
319307
*
320308
* @throws {@link ECSServiceException}
321309
* <p>Base exception class for all service exceptions from ECS service.</p>

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

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,7 @@ export interface CreateClusterCommandInput extends CreateClusterRequest {}
2727
export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates a new Amazon ECS cluster. By default, your account receives a
31-
* <code>default</code> cluster when you launch your first container instance. However,
32-
* you can create your own cluster with a unique name.</p>
33-
* <note>
34-
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a>
35-
* API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for
36-
* your account. This is so that it can manage required resources in other Amazon Web
37-
* Services services on your behalf. However, if the user that makes the
38-
* call doesn't have permissions to create the service-linked role, it isn't created.
39-
* 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
41-
* Container Service Developer Guide</i>.</p>
42-
* </note>
30+
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name.</p> <note> <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>
4331
* @example
4432
* Use a bare-bones client and the command you need to make an API call.
4533
* ```javascript
@@ -178,15 +166,10 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
178166
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
179167
*
180168
* @throws {@link ClientException} (client fault)
181-
* <p>These errors are usually caused by a client action. This client action might be using
182-
* an action or resource on behalf of a user that doesn't have permissions to use the
183-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
169+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
184170
*
185171
* @throws {@link InvalidParameterException} (client fault)
186-
* <p>The specified parameter isn't valid. Review the available parameters for the API
187-
* request.</p>
188-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
189-
* service event messages</a>. </p>
172+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
190173
*
191174
* @throws {@link NamespaceNotFoundException} (client fault)
192175
* <p>The specified namespace wasn't found.</p>

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

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,7 @@ export interface CreateExpressGatewayServiceCommandInput extends CreateExpressGa
2727
export interface CreateExpressGatewayServiceCommandOutput extends CreateExpressGatewayServiceResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates an Express service that simplifies deploying containerized web applications on
31-
* Amazon ECS with managed Amazon Web Services infrastructure. This operation provisions and configures
32-
* Application Load Balancers, target groups, security groups, and auto-scaling policies
33-
* automatically.</p>
34-
* <p>Specify a primary container configuration with your application image and basic
35-
* settings. Amazon ECS creates the necessary Amazon Web Services resources for traffic distribution, health
36-
* monitoring, network access control, and capacity management.</p>
37-
* <p>Provide an execution role for task operations and an infrastructure role for managing
38-
* Amazon Web Services resources on your behalf.</p>
30+
* <p>Creates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure. This operation provisions and configures Application Load Balancers, target groups, security groups, and auto-scaling policies automatically.</p> <p>Specify a primary container configuration with your application image and basic settings. Amazon ECS creates the necessary Amazon Web Services resources for traffic distribution, health monitoring, network access control, and capacity management.</p> <p>Provide an execution role for task operations and an infrastructure role for managing Amazon Web Services resources on your behalf.</p>
3931
* @example
4032
* Use a bare-bones client and the command you need to make an API call.
4133
* ```javascript
@@ -193,22 +185,16 @@ export interface CreateExpressGatewayServiceCommandOutput extends CreateExpressG
193185
* <p>You don't have authorization to perform the requested action.</p>
194186
*
195187
* @throws {@link ClientException} (client fault)
196-
* <p>These errors are usually caused by a client action. This client action might be using
197-
* an action or resource on behalf of a user that doesn't have permissions to use the
198-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
188+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
199189
*
200190
* @throws {@link ClusterNotFoundException} (client fault)
201191
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
202192
*
203193
* @throws {@link InvalidParameterException} (client fault)
204-
* <p>The specified parameter isn't valid. Review the available parameters for the API
205-
* request.</p>
206-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
207-
* service event messages</a>. </p>
194+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
208195
*
209196
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
210-
* <p>The specified platform version doesn't satisfy the required capabilities of the task
211-
* definition.</p>
197+
* <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
212198
*
213199
* @throws {@link PlatformUnknownException} (client fault)
214200
* <p>The specified platform version doesn't exist.</p>

0 commit comments

Comments
 (0)