Skip to content

Commit

Permalink
docs(client-ecs): This is a documentation only update to address vari…
Browse files Browse the repository at this point in the history 
…ous tickets for Amazon ECS.
  • Loading branch information
awstools committed Dec 9, 2024
1 parent f62407a commit 8dfab18
Show file tree
Hide file tree
Showing 66 changed files with 5,439 additions and 4,743 deletions.
23 changes: 12 additions & 11 deletions clients/client-ecs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.

<fullname>Amazon Elastic Container Service</fullname>

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

## Installing

Expand Down
23 changes: 12 additions & 11 deletions clients/client-ecs/src/ECS.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1242,17 +1242,18 @@ export interface ECS {

/**
* <fullname>Amazon Elastic Container Service</fullname>
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
* stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
* managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
* it easy to get the state of your cluster from a centralized service, and gives you access to many
* familiar Amazon EC2 features.</p>
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
* needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
* own cluster management and configuration management systems. You also don't need to worry about scaling
* your management infrastructure. </p>
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
* it easy to run, stop, and manage Docker containers. You can host your cluster on a
* serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
* Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
* or External (on-premises) instances that you manage.</p>
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
* calls. This makes it easy to get the state of your cluster from a centralized service,
* and gives you access to many familiar Amazon EC2 features.</p>
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
* your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
* don't need to operate your own cluster management and configuration management systems.
* You also don't need to worry about scaling your management infrastructure. </p>
* @public
*/
export class ECS extends ECSClient implements ECS {}
Expand Down
23 changes: 12 additions & 11 deletions clients/client-ecs/src/ECSClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -520,17 +520,18 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {}

/**
* <fullname>Amazon Elastic Container Service</fullname>
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
* stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
* managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
* it easy to get the state of your cluster from a centralized service, and gives you access to many
* familiar Amazon EC2 features.</p>
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
* needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
* own cluster management and configuration management systems. You also don't need to worry about scaling
* your management infrastructure. </p>
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
* it easy to run, stop, and manage Docker containers. You can host your cluster on a
* serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
* Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
* or External (on-premises) instances that you manage.</p>
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
* calls. This makes it easy to get the state of your cluster from a centralized service,
* and gives you access to many familiar Amazon EC2 features.</p>
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
* your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
* don't need to operate your own cluster management and configuration management systems.
* You also don't need to worry about scaling your management infrastructure. </p>
* @public
*/
export class ECSClient extends __Client<
Expand Down
39 changes: 22 additions & 17 deletions clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ export interface CreateCapacityProviderCommandInput extends CreateCapacityProvid
export interface CreateCapacityProviderCommandOutput extends CreateCapacityProviderResponse, __MetadataBearer {}

/**
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used
* in capacity provider strategies to facilitate cluster auto scaling.</p>
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use
* the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers. These providers are
* available to all accounts in the Amazon Web Services Regions that Fargate supports.</p>
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
* cluster and are used in capacity provider strategies to facilitate cluster auto
* scaling.</p>
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
* Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.
* These providers are available to all accounts in the Amazon Web Services Regions that Fargate
* supports.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -99,21 +101,23 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
*
* @throws {@link ClientException} (client fault)
* <p>These errors are usually caused by a client action. This client action might be using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
* be specifying an identifier that isn't valid.</p>
* <p>These errors are usually caused by a client action. This client action might be using
* an action or resource on behalf of a user that doesn't have permissions to use the
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
* <p>The following list includes additional causes for the error:</p>
* <ul>
* <li>
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
* quotas</a>.</p>
* <p>The <code>RunTask</code> could not be processed because you use managed
* scaling and there is a capacity error because the quota of tasks in the
* <code>PROVISIONING</code> per cluster has been reached. For information
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
* service quotas</a>.</p>
* </li>
* </ul>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
* <p>The specified parameter isn't valid. Review the available parameters for the API
* request.</p>
*
* @throws {@link LimitExceededException} (client fault)
* <p>The limit for the resource was exceeded.</p>
Expand All @@ -122,10 +126,11 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
* <p>These errors are usually caused by a server issue.</p>
*
* @throws {@link UpdateInProgressException} (client fault)
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's
* specified. If the container agent becomes disconnected while it's in a transitional stage, such as
* <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state.
* However, when the agent reconnects, it resumes where it stopped previously.</p>
* <p>There's already a current Amazon ECS container agent update in progress on the container
* instance that's specified. If the container agent becomes disconnected while it's in a
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
* process can get stuck in that state. However, when the agent reconnects, it resumes
* where it stopped previously.</p>
*
* @throws {@link ECSServiceException}
* <p>Base exception class for all service exceptions from ECS service.</p>
Expand Down
36 changes: 19 additions & 17 deletions clients/client-ecs/src/commands/CreateClusterCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ export interface CreateClusterCommandInput extends CreateClusterRequest {}
export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {}

/**
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when
* you launch your first container instance. However, you can create your own cluster with a unique
* name.</p>
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
* cluster when you launch your first container instance. However, you can create your own
* cluster with a unique name.</p>
* <note>
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation,
* Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can
* manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes
* the call doesn't have permissions to create the service-linked role, it isn't created. For more
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked
* roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a>
* API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your
* account. This is so that it can manage required resources in other Amazon Web Services services on
* your behalf. However, if the user that makes the call doesn't have permissions to
* create the service-linked role, it isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -175,21 +175,23 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
*
* @throws {@link ClientException} (client fault)
* <p>These errors are usually caused by a client action. This client action might be using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
* be specifying an identifier that isn't valid.</p>
* <p>These errors are usually caused by a client action. This client action might be using
* an action or resource on behalf of a user that doesn't have permissions to use the
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
* <p>The following list includes additional causes for the error:</p>
* <ul>
* <li>
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
* quotas</a>.</p>
* <p>The <code>RunTask</code> could not be processed because you use managed
* scaling and there is a capacity error because the quota of tasks in the
* <code>PROVISIONING</code> per cluster has been reached. For information
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
* service quotas</a>.</p>
* </li>
* </ul>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
* <p>The specified parameter isn't valid. Review the available parameters for the API
* request.</p>
*
* @throws {@link NamespaceNotFoundException} (client fault)
* <p>The specified namespace wasn't found.</p>
Expand Down
Loading

0 comments on commit 8dfab18

Please sign in to comment.