Skip to content

Commit a4a0836

Browse files
author
awstools
committed
docs(client-ecs): Documentation only release to address various tickets
1 parent b474584 commit a4a0836

38 files changed

+253
-255
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
3030
/**
3131
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
3232
* cluster when you launch your first container instance. However, you can create your own
33-
* cluster with a unique name with the <code>CreateCluster</code> action.</p>
33+
* cluster with a unique name.</p>
3434
* <note>
35-
* <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to
35+
* <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
3636
* create the Amazon ECS service-linked role for your account. This is so that it can manage
3737
* required resources in other Amazon Web Services services on your behalf. However, if the user that
3838
* makes the call doesn't have permissions to create the service-linked role, it isn't

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
3131
* <p>Runs and maintains your desired number of tasks from a specified task definition. If
3232
* the number of tasks running in a service drops below the <code>desiredCount</code>,
3333
* Amazon ECS runs another copy of the task in the specified cluster. To update an existing
34-
* service, see the <a>UpdateService</a> action.</p>
34+
* service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
3535
* <note>
3636
* <p>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.</p>
3737
* </note>
@@ -69,7 +69,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
6969
* </ul>
7070
* <p>You can optionally specify a deployment configuration for your service. The deployment
7171
* is initiated by changing properties. For example, the deployment might be initiated by
72-
* the task definition or by your desired count of a service. This is done with an <a>UpdateService</a> operation. The default value for a replica service for
72+
* the task definition or by your desired count of a service. You can use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>. The default value for a replica service for
7373
* <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service
7474
* for <code>minimumHealthyPercent</code> is 0%.</p>
7575
* <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy
@@ -107,7 +107,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
107107
* currently visible when describing your service.</p>
108108
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
109109
* can specify only parameters that aren't controlled at the task set level. The only
110-
* 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>
110+
* required parameter is the service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. 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>
111111
* <p>When the service scheduler launches new tasks, it determines task placement. For
112112
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
113113
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
@@ -575,7 +575,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
575575
* </ul>
576576
*
577577
* @throws {@link ClusterNotFoundException} (client fault)
578-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
578+
* <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>
579579
*
580580
* @throws {@link InvalidParameterException} (client fault)
581581
* <p>The specified parameter isn't valid. Review the available parameters for the API

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
195195
* </ul>
196196
*
197197
* @throws {@link ClusterNotFoundException} (client fault)
198-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
198+
* <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>
199199
*
200200
* @throws {@link InvalidParameterException} (client fault)
201201
* <p>The specified parameter isn't valid. Review the available parameters for the API
@@ -216,10 +216,10 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
216216
*
217217
* @throws {@link ServiceNotActiveException} (client fault)
218218
* <p>The specified service isn't active. You can't update a service that's inactive. If you
219-
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
219+
* have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
220220
*
221221
* @throws {@link ServiceNotFoundException} (client fault)
222-
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
222+
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
223223
* specific.</p>
224224
*
225225
* @throws {@link UnsupportedFeatureException} (client fault)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export interface DeleteAttributesCommandOutput extends DeleteAttributesResponse,
6868
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
6969
*
7070
* @throws {@link ClusterNotFoundException} (client fault)
71-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
71+
* <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>
7272
*
7373
* @throws {@link InvalidParameterException} (client fault)
7474
* <p>The specified parameter isn't valid. Review the available parameters for the API

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,17 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi
3131
* <p>Deletes the specified capacity provider.</p>
3232
* <note>
3333
* <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are
34-
* reserved and can't be deleted. You can disassociate them from a cluster using either
35-
* the <a>PutClusterCapacityProviders</a> API or by deleting the
34+
* reserved and can't be deleted. You can disassociate them from a cluster using either <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html">PutCapacityProviderProviders</a> or by deleting the
3635
* cluster.</p>
3736
* </note>
3837
* <p>Prior to a capacity provider being deleted, the capacity provider must be removed from
39-
* the capacity provider strategy from all services. The <a>UpdateService</a>
38+
* the capacity provider strategy from all services. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>
4039
* API can be used to remove a capacity provider from a service's capacity provider
4140
* strategy. When updating a service, the <code>forceNewDeployment</code> option can be
4241
* used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity
4342
* provider are transitioned to use the capacity from the remaining capacity providers.
4443
* Only capacity providers that aren't associated with a cluster can be deleted. To remove
45-
* a capacity provider from a cluster, you can either use <a>PutClusterCapacityProviders</a> or delete the cluster.</p>
44+
* a capacity provider from a cluster, you can either use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html">PutCapacityProviderProviders</a> or delete the cluster.</p>
4645
* @example
4746
* Use a bare-bones client and the command you need to make an API call.
4847
* ```javascript

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
3333
* account for a period of time. However, this behavior is subject to change in the future.
3434
* We don't recommend that you rely on <code>INACTIVE</code> clusters persisting.</p>
3535
* <p>You must deregister all container instances from this cluster before you may delete
36-
* it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>
36+
* it. You can list the container instances in a cluster with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a> and deregister them with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -145,18 +145,18 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
145145
* @throws {@link ClusterContainsContainerInstancesException} (client fault)
146146
* <p>You can't delete a cluster that has registered container instances. First, deregister
147147
* the container instances before you can delete the cluster. For more information, see
148-
* <a>DeregisterContainerInstance</a>.</p>
148+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
149149
*
150150
* @throws {@link ClusterContainsServicesException} (client fault)
151151
* <p>You can't delete a cluster that contains services. First, update the service to reduce
152152
* its desired task count to 0, and then delete the service. For more information, see
153-
* <a>UpdateService</a> and <a>DeleteService</a>.</p>
153+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html">DeleteService</a>.</p>
154154
*
155155
* @throws {@link ClusterContainsTasksException} (client fault)
156156
* <p>You can't delete a cluster that has active tasks.</p>
157157
*
158158
* @throws {@link ClusterNotFoundException} (client fault)
159-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
159+
* <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>
160160
*
161161
* @throws {@link InvalidParameterException} (client fault)
162162
* <p>The specified parameter isn't valid. Review the available parameters for the API

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,17 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
3131
* <p>Deletes a specified service within a cluster. You can delete a service if you have no
3232
* running tasks in it and the desired task count is zero. If the service is actively
3333
* maintaining tasks, you can't delete it, and you must update the service to a desired
34-
* task count of zero. For more information, see <a>UpdateService</a>.</p>
34+
* task count of zero. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
3535
* <note>
3636
* <p>When you delete a service, if there are still running tasks that require cleanup,
3737
* the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the
38-
* service is no longer visible in the console or in the <a>ListServices</a>
38+
* service is no longer visible in the console or in the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>
3939
* API operation. After all tasks have transitioned to either <code>STOPPING</code> or
4040
* <code>STOPPED</code> status, the service status moves from <code>DRAINING</code>
4141
* to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or
42-
* <code>INACTIVE</code> status can still be viewed with the <a>DescribeServices</a> API operation. However, in the future,
42+
* <code>INACTIVE</code> status can still be viewed with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> API operation. However, in the future,
4343
* <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record
44-
* keeping, and <a>DescribeServices</a> calls on those services return a
44+
* keeping, and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> calls on those services return a
4545
* <code>ServiceNotFoundException</code> error.</p>
4646
* </note>
4747
* <important>
@@ -360,7 +360,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
360360
* </ul>
361361
*
362362
* @throws {@link ClusterNotFoundException} (client fault)
363-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
363+
* <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>
364364
*
365365
* @throws {@link InvalidParameterException} (client fault)
366366
* <p>The specified parameter isn't valid. Review the available parameters for the API
@@ -370,7 +370,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
370370
* <p>These errors are usually caused by a server issue.</p>
371371
*
372372
* @throws {@link ServiceNotFoundException} (client fault)
373-
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
373+
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
374374
* specific.</p>
375375
*
376376
* @throws {@link ECSServiceException}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
141141
* </ul>
142142
*
143143
* @throws {@link ClusterNotFoundException} (client fault)
144-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
144+
* <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>
145145
*
146146
* @throws {@link InvalidParameterException} (client fault)
147147
* <p>The specified parameter isn't valid. Review the available parameters for the API
@@ -152,14 +152,14 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
152152
*
153153
* @throws {@link ServiceNotActiveException} (client fault)
154154
* <p>The specified service isn't active. You can't update a service that's inactive. If you
155-
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
155+
* have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
156156
*
157157
* @throws {@link ServiceNotFoundException} (client fault)
158-
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
158+
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
159159
* specific.</p>
160160
*
161161
* @throws {@link TaskSetNotFoundException} (client fault)
162-
* <p>The specified task set wasn't found. You can view your available task sets with <a>DescribeTaskSets</a>. Task sets are specific to each cluster, service and
162+
* <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and
163163
* Region.</p>
164164
*
165165
* @throws {@link UnsupportedFeatureException} (client fault)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ export interface DeregisterContainerInstanceCommandOutput
164164
* </ul>
165165
*
166166
* @throws {@link ClusterNotFoundException} (client fault)
167-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
167+
* <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>
168168
*
169169
* @throws {@link InvalidParameterException} (client fault)
170170
* <p>The specified parameter isn't valid. Review the available parameters for the API

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
163163
* </ul>
164164
*
165165
* @throws {@link ClusterNotFoundException} (client fault)
166-
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
166+
* <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>
167167
*
168168
* @throws {@link InvalidParameterException} (client fault)
169169
* <p>The specified parameter isn't valid. Review the available parameters for the API

0 commit comments

Comments
 (0)