Skip to content

Commit

Permalink
docs(client-ecs): Documentation only release to address various tickets
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Aug 20, 2024
1 parent b474584 commit a4a0836
Show file tree
Hide file tree
Showing 38 changed files with 253 additions and 255 deletions.
4 changes: 2 additions & 2 deletions clients/client-ecs/src/commands/CreateClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
/**
* <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 with the <code>CreateCluster</code> action.</p>
* cluster with a unique name.</p>
* <note>
* <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to
* <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
Expand Down
8 changes: 4 additions & 4 deletions clients/client-ecs/src/commands/CreateServiceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
* <p>Runs and maintains your desired number of tasks from a specified task definition. If
* the number of tasks running in a service drops below the <code>desiredCount</code>,
* Amazon ECS runs another copy of the task in the specified cluster. To update an existing
* service, see the <a>UpdateService</a> action.</p>
* service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
* <note>
* <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>
* </note>
Expand Down Expand Up @@ -69,7 +69,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
* </ul>
* <p>You can optionally specify a deployment configuration for your service. The deployment
* is initiated by changing properties. For example, the deployment might be initiated by
* 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
* 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
* <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service
* for <code>minimumHealthyPercent</code> is 0%.</p>
* <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy
Expand Down Expand Up @@ -107,7 +107,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
* currently visible when describing your service.</p>
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
* can specify only parameters that aren't controlled at the task set level. The only
* 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>
* 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>
* <p>When the service scheduler launches new tasks, it determines task placement. For
* information 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>
Expand Down Expand Up @@ -575,7 +575,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
* </ul>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand Down
6 changes: 3 additions & 3 deletions clients/client-ecs/src/commands/CreateTaskSetCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
* </ul>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand All @@ -216,10 +216,10 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
*
* @throws {@link ServiceNotActiveException} (client fault)
* <p>The specified service isn't active. You can't update a service that's inactive. If you
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
* 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>
*
* @throws {@link ServiceNotFoundException} (client fault)
* <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
* <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
* specific.</p>
*
* @throws {@link UnsupportedFeatureException} (client fault)
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ecs/src/commands/DeleteAttributesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export interface DeleteAttributesCommandOutput extends DeleteAttributesResponse,
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,17 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi
* <p>Deletes the specified capacity provider.</p>
* <note>
* <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are
* reserved and can't be deleted. You can disassociate them from a cluster using either
* the <a>PutClusterCapacityProviders</a> API or by deleting the
* 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
* cluster.</p>
* </note>
* <p>Prior to a capacity provider being deleted, the capacity provider must be removed from
* the capacity provider strategy from all services. The <a>UpdateService</a>
* the capacity provider strategy from all services. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>
* API can be used to remove a capacity provider from a service's capacity provider
* strategy. When updating a service, the <code>forceNewDeployment</code> option can be
* used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity
* provider are transitioned to use the capacity from the remaining capacity providers.
* Only capacity providers that aren't associated with a cluster can be deleted. To remove
* a capacity provider from a cluster, you can either use <a>PutClusterCapacityProviders</a> or delete the cluster.</p>
* 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
8 changes: 4 additions & 4 deletions clients/client-ecs/src/commands/DeleteClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
* account for a period of time. However, this behavior is subject to change in the future.
* We don't recommend that you rely on <code>INACTIVE</code> clusters persisting.</p>
* <p>You must deregister all container instances from this cluster before you may delete
* it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>
* 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -145,18 +145,18 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
* @throws {@link ClusterContainsContainerInstancesException} (client fault)
* <p>You can't delete a cluster that has registered container instances. First, deregister
* the container instances before you can delete the cluster. For more information, see
* <a>DeregisterContainerInstance</a>.</p>
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
*
* @throws {@link ClusterContainsServicesException} (client fault)
* <p>You can't delete a cluster that contains services. First, update the service to reduce
* its desired task count to 0, and then delete the service. For more information, see
* <a>UpdateService</a> and <a>DeleteService</a>.</p>
* <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>
*
* @throws {@link ClusterContainsTasksException} (client fault)
* <p>You can't delete a cluster that has active tasks.</p>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand Down
12 changes: 6 additions & 6 deletions clients/client-ecs/src/commands/DeleteServiceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,17 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
* <p>Deletes a specified service within a cluster. You can delete a service if you have no
* running tasks in it and the desired task count is zero. If the service is actively
* maintaining tasks, you can't delete it, and you must update the service to a desired
* task count of zero. For more information, see <a>UpdateService</a>.</p>
* task count of zero. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
* <note>
* <p>When you delete a service, if there are still running tasks that require cleanup,
* the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the
* service is no longer visible in the console or in the <a>ListServices</a>
* 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>
* API operation. After all tasks have transitioned to either <code>STOPPING</code> or
* <code>STOPPED</code> status, the service status moves from <code>DRAINING</code>
* to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or
* <code>INACTIVE</code> status can still be viewed with the <a>DescribeServices</a> API operation. However, in the future,
* <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,
* <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record
* keeping, and <a>DescribeServices</a> calls on those services return a
* keeping, and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> calls on those services return a
* <code>ServiceNotFoundException</code> error.</p>
* </note>
* <important>
Expand Down Expand Up @@ -360,7 +360,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
* </ul>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand All @@ -370,7 +370,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
* <p>These errors are usually caused by a server issue.</p>
*
* @throws {@link ServiceNotFoundException} (client fault)
* <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
* <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
* specific.</p>
*
* @throws {@link ECSServiceException}
Expand Down
8 changes: 4 additions & 4 deletions clients/client-ecs/src/commands/DeleteTaskSetCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
* </ul>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand All @@ -152,14 +152,14 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
*
* @throws {@link ServiceNotActiveException} (client fault)
* <p>The specified service isn't active. You can't update a service that's inactive. If you
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
* 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>
*
* @throws {@link ServiceNotFoundException} (client fault)
* <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
* <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
* specific.</p>
*
* @throws {@link TaskSetNotFoundException} (client fault)
* <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
* <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
* Region.</p>
*
* @throws {@link UnsupportedFeatureException} (client fault)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ export interface DeregisterContainerInstanceCommandOutput
* </ul>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
* </ul>
*
* @throws {@link ClusterNotFoundException} (client fault)
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
* <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>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter isn't valid. Review the available parameters for the API
Expand Down
Loading

0 comments on commit a4a0836

Please sign in to comment.