@aws-sdk/client-ecs 3.699.0 → 3.708.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +12 -11
  2. package/dist-types/ECS.d.ts +12 -11
  3. package/dist-types/ECSClient.d.ts +12 -11
  4. package/dist-types/commands/CreateCapacityProviderCommand.d.ts +22 -17
  5. package/dist-types/commands/CreateClusterCommand.d.ts +19 -17
  6. package/dist-types/commands/CreateServiceCommand.d.ts +80 -75
  7. package/dist-types/commands/CreateTaskSetCommand.d.ts +19 -15
  8. package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -9
  9. package/dist-types/commands/DeleteAttributesCommand.d.ts +4 -2
  10. package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +21 -17
  11. package/dist-types/commands/DeleteClusterCommand.d.ts +28 -23
  12. package/dist-types/commands/DeleteServiceCommand.d.ts +29 -23
  13. package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +28 -23
  14. package/dist-types/commands/DeleteTaskSetCommand.d.ts +17 -14
  15. package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +22 -19
  16. package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +26 -23
  17. package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +10 -8
  18. package/dist-types/commands/DescribeClustersCommand.d.ts +11 -8
  19. package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +12 -10
  20. package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +15 -10
  21. package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +14 -11
  22. package/dist-types/commands/DescribeServicesCommand.d.ts +10 -8
  23. package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +16 -13
  24. package/dist-types/commands/DescribeTaskSetsCommand.d.ts +17 -13
  25. package/dist-types/commands/DescribeTasksCommand.d.ts +13 -11
  26. package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +8 -7
  27. package/dist-types/commands/ExecuteCommandCommand.d.ts +23 -19
  28. package/dist-types/commands/GetTaskProtectionCommand.d.ts +10 -8
  29. package/dist-types/commands/ListAccountSettingsCommand.d.ts +10 -8
  30. package/dist-types/commands/ListAttributesCommand.d.ts +8 -6
  31. package/dist-types/commands/ListClustersCommand.d.ts +10 -8
  32. package/dist-types/commands/ListContainerInstancesCommand.d.ts +13 -12
  33. package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +14 -10
  34. package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +15 -12
  35. package/dist-types/commands/ListServicesCommand.d.ts +12 -10
  36. package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -8
  37. package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +17 -13
  38. package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -11
  39. package/dist-types/commands/ListTasksCommand.d.ts +15 -12
  40. package/dist-types/commands/PutAccountSettingCommand.d.ts +14 -11
  41. package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +12 -10
  42. package/dist-types/commands/PutAttributesCommand.d.ts +10 -7
  43. package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +29 -24
  44. package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +12 -10
  45. package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +24 -21
  46. package/dist-types/commands/RunTaskCommand.d.ts +37 -33
  47. package/dist-types/commands/StartTaskCommand.d.ts +16 -16
  48. package/dist-types/commands/StopTaskCommand.d.ts +22 -18
  49. package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +10 -8
  50. package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +8 -7
  51. package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +10 -8
  52. package/dist-types/commands/TagResourceCommand.d.ts +14 -11
  53. package/dist-types/commands/UntagResourceCommand.d.ts +10 -8
  54. package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +10 -8
  55. package/dist-types/commands/UpdateClusterCommand.d.ts +10 -8
  56. package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +10 -8
  57. package/dist-types/commands/UpdateContainerAgentCommand.d.ts +37 -33
  58. package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +48 -42
  59. package/dist-types/commands/UpdateServiceCommand.d.ts +101 -91
  60. package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +20 -15
  61. package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +25 -20
  62. package/dist-types/commands/UpdateTaskSetCommand.d.ts +19 -15
  63. package/dist-types/index.d.ts +12 -11
  64. package/dist-types/models/models_0.d.ts +3401 -2878
  65. package/dist-types/models/models_1.d.ts +165 -146
  66. package/package.json +1 -1
@@ -29,16 +29,18 @@ declare const DeleteCapacityProviderCommand_base: {
29
29
  /**
30
30
  * <p>Deletes the specified capacity provider.</p>
31
31
  * <note>
32
- * <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are reserved and can't
33
- * 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>
32
+ * <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are
33
+ * reserved and can't be deleted. You can disassociate them from a cluster using either
34
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or by deleting the cluster.</p>
34
35
  * </note>
35
- * <p>Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity
36
- * 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
37
- * remove a capacity provider from a service's capacity provider strategy. When updating a service, the
38
- * <code>forceNewDeployment</code> option can be used to ensure that any tasks using the Amazon EC2
39
- * instance capacity provided by the capacity provider are transitioned to use the capacity from the
40
- * remaining capacity providers. Only capacity providers that aren't associated with a cluster can be
41
- * deleted. To remove a capacity provider from a cluster, you can either use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or delete the cluster.</p>
36
+ * <p>Prior to a capacity provider being deleted, the capacity provider must be removed from
37
+ * the capacity provider strategy from all services. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> API
38
+ * can be used to remove a capacity provider from a service's capacity provider strategy.
39
+ * When updating a service, the <code>forceNewDeployment</code> option can be used to
40
+ * ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity
41
+ * provider are transitioned to use the capacity from the remaining capacity providers.
42
+ * Only capacity providers that aren't associated with a cluster can be deleted. To remove
43
+ * a capacity provider from a cluster, you can either use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or delete the cluster.</p>
42
44
  * @example
43
45
  * Use a bare-bones client and the command you need to make an API call.
44
46
  * ```javascript
@@ -87,21 +89,23 @@ declare const DeleteCapacityProviderCommand_base: {
87
89
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
88
90
  *
89
91
  * @throws {@link ClientException} (client fault)
90
- * <p>These errors are usually caused by a client action. This client action might be using an action or
91
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
92
- * be specifying an identifier that isn't valid.</p>
92
+ * <p>These errors are usually caused by a client action. This client action might be using
93
+ * an action or resource on behalf of a user that doesn't have permissions to use the
94
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
93
95
  * <p>The following list includes additional causes for the error:</p>
94
96
  * <ul>
95
97
  * <li>
96
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
97
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
98
- * 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
99
- * quotas</a>.</p>
98
+ * <p>The <code>RunTask</code> could not be processed because you use managed
99
+ * scaling and there is a capacity error because the quota of tasks in the
100
+ * <code>PROVISIONING</code> per cluster has been reached. For information
101
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
102
+ * service quotas</a>.</p>
100
103
  * </li>
101
104
  * </ul>
102
105
  *
103
106
  * @throws {@link InvalidParameterException} (client fault)
104
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
107
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
108
+ * request.</p>
105
109
  *
106
110
  * @throws {@link ServerException} (server fault)
107
111
  * <p>These errors are usually caused by a server issue.</p>
@@ -27,13 +27,12 @@ declare const DeleteClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code> state. Clusters
31
- * with an <code>INACTIVE</code> status might remain discoverable in your account for a period of time.
32
- * However, this behavior is subject to change in the future. We don't recommend that you rely on
33
- * <code>INACTIVE</code> clusters persisting.</p>
34
- * <p>You must deregister all container instances from this cluster before you may delete it. You can list
35
- * the container instances in a cluster with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>
36
- * and deregister them with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
30
+ * <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code>
31
+ * state. Clusters with an <code>INACTIVE</code> status might remain discoverable in your
32
+ * account for a period of time. However, this behavior is subject to change in the future.
33
+ * We don't recommend that you rely on <code>INACTIVE</code> clusters persisting.</p>
34
+ * <p>You must deregister all container instances from this cluster before you may delete
35
+ * 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>
37
36
  * @example
38
37
  * Use a bare-bones client and the command you need to make an API call.
39
38
  * ```javascript
@@ -128,26 +127,30 @@ declare const DeleteClusterCommand_base: {
128
127
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
129
128
  *
130
129
  * @throws {@link ClientException} (client fault)
131
- * <p>These errors are usually caused by a client action. This client action might be using an action or
132
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
133
- * be specifying an identifier that isn't valid.</p>
130
+ * <p>These errors are usually caused by a client action. This client action might be using
131
+ * an action or resource on behalf of a user that doesn't have permissions to use the
132
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
134
133
  * <p>The following list includes additional causes for the error:</p>
135
134
  * <ul>
136
135
  * <li>
137
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
138
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
139
- * 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
140
- * quotas</a>.</p>
136
+ * <p>The <code>RunTask</code> could not be processed because you use managed
137
+ * scaling and there is a capacity error because the quota of tasks in the
138
+ * <code>PROVISIONING</code> per cluster has been reached. For information
139
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
140
+ * service quotas</a>.</p>
141
141
  * </li>
142
142
  * </ul>
143
143
  *
144
144
  * @throws {@link ClusterContainsContainerInstancesException} (client fault)
145
- * <p>You can't delete a cluster that has registered container instances. First, deregister the container
146
- * instances before you can delete the cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
145
+ * <p>You can't delete a cluster that has registered container instances. First, deregister
146
+ * the container instances before you can delete the cluster. For more information, see
147
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
147
148
  *
148
149
  * @throws {@link ClusterContainsServicesException} (client fault)
149
- * <p>You can't delete a cluster that contains services. First, update the service to reduce its desired
150
- * task count to 0, and then delete the service. For more information, see <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>
150
+ * <p>You can't delete a cluster that contains services. First, update the service to reduce
151
+ * its desired task count to 0, and then delete the service. For more information, see
152
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> and
153
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html">DeleteService</a>.</p>
151
154
  *
152
155
  * @throws {@link ClusterContainsTasksException} (client fault)
153
156
  * <p>You can't delete a cluster that has active tasks.</p>
@@ -156,16 +159,18 @@ declare const DeleteClusterCommand_base: {
156
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>
157
160
  *
158
161
  * @throws {@link InvalidParameterException} (client fault)
159
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
162
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
163
+ * request.</p>
160
164
  *
161
165
  * @throws {@link ServerException} (server fault)
162
166
  * <p>These errors are usually caused by a server issue.</p>
163
167
  *
164
168
  * @throws {@link UpdateInProgressException} (client fault)
165
- * <p>There's already a current Amazon ECS container agent update in progress on the container instance that's
166
- * specified. If the container agent becomes disconnected while it's in a transitional stage, such as
167
- * <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state.
168
- * However, when the agent reconnects, it resumes where it stopped previously.</p>
169
+ * <p>There's already a current Amazon ECS container agent update in progress on the container
170
+ * instance that's specified. If the container agent becomes disconnected while it's in a
171
+ * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
172
+ * process can get stuck in that state. However, when the agent reconnects, it resumes
173
+ * where it stopped previously.</p>
169
174
  *
170
175
  * @throws {@link ECSServiceException}
171
176
  * <p>Base exception class for all service exceptions from ECS service.</p>
@@ -27,23 +27,26 @@ declare const DeleteServiceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a specified service within a cluster. You can delete a service if you have no running tasks
31
- * in it and the desired task count is zero. If the service is actively maintaining tasks, you can't
32
- * delete it, and you must update the service to a desired task count of zero. For more information, see
33
- * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
30
+ * <p>Deletes a specified service within a cluster. You can delete a service if you have no
31
+ * running tasks in it and the desired task count is zero. If the service is actively
32
+ * maintaining tasks, you can't delete it, and you must update the service to a desired
33
+ * task count of zero. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
34
34
  * <note>
35
- * <p>When you delete a service, if there are still running tasks that require cleanup, the service
36
- * status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer
37
- * visible in the console or in the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a> API operation.
38
- * After all tasks have transitioned to either <code>STOPPING</code> or <code>STOPPED</code> status,
39
- * the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the
40
- * <code>DRAINING</code> or <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
41
- * may be cleaned up and purged from Amazon ECS record keeping, and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> calls on
42
- * those services return a <code>ServiceNotFoundException</code> error.</p>
35
+ * <p>When you delete a service, if there are still running tasks that require cleanup,
36
+ * the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the
37
+ * 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>
38
+ * API operation. After all tasks have transitioned to either <code>STOPPING</code> or
39
+ * <code>STOPPED</code> status, the service status moves from <code>DRAINING</code>
40
+ * to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or
41
+ * <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,
42
+ * <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record
43
+ * keeping, and <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html">DescribeServices</a> calls on those services return a
44
+ * <code>ServiceNotFoundException</code> error.</p>
43
45
  * </note>
44
46
  * <important>
45
- * <p>If you attempt to create a new service with the same name as an existing service in either
46
- * <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an error.</p>
47
+ * <p>If you attempt to create a new service with the same name as an existing service
48
+ * in either <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an
49
+ * error.</p>
47
50
  * </important>
48
51
  * @example
49
52
  * Use a bare-bones client and the command you need to make an API call.
@@ -349,16 +352,17 @@ declare const DeleteServiceCommand_base: {
349
352
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
350
353
  *
351
354
  * @throws {@link ClientException} (client fault)
352
- * <p>These errors are usually caused by a client action. This client action might be using an action or
353
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
354
- * be specifying an identifier that isn't valid.</p>
355
+ * <p>These errors are usually caused by a client action. This client action might be using
356
+ * an action or resource on behalf of a user that doesn't have permissions to use the
357
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
355
358
  * <p>The following list includes additional causes for the error:</p>
356
359
  * <ul>
357
360
  * <li>
358
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
359
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
360
- * 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
361
- * quotas</a>.</p>
361
+ * <p>The <code>RunTask</code> could not be processed because you use managed
362
+ * scaling and there is a capacity error because the quota of tasks in the
363
+ * <code>PROVISIONING</code> per cluster has been reached. For information
364
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
365
+ * service quotas</a>.</p>
362
366
  * </li>
363
367
  * </ul>
364
368
  *
@@ -366,13 +370,15 @@ declare const DeleteServiceCommand_base: {
366
370
  * <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>
367
371
  *
368
372
  * @throws {@link InvalidParameterException} (client fault)
369
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
373
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
374
+ * request.</p>
370
375
  *
371
376
  * @throws {@link ServerException} (server fault)
372
377
  * <p>These errors are usually caused by a server issue.</p>
373
378
  *
374
379
  * @throws {@link ServiceNotFoundException} (client fault)
375
- * <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>
380
+ * <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
381
+ * specific.</p>
376
382
  *
377
383
  * @throws {@link ECSServiceException}
378
384
  * <p>Base exception class for all service exceptions from ECS service.</p>
@@ -28,22 +28,25 @@ declare const DeleteTaskDefinitionsCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Deletes one or more task definitions.</p>
31
- * <p>You must deregister a task definition revision before you delete it. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html">DeregisterTaskDefinition</a>.</p>
31
+ * <p>You must deregister a task definition revision before you delete it. For more
32
+ * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html">DeregisterTaskDefinition</a>.</p>
32
33
  * <p>When you delete a task definition revision, it is immediately transitions from the
33
- * <code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and services that
34
- * reference a <code>DELETE_IN_PROGRESS</code> task definition revision continue to run without
35
- * disruption. Existing services that reference a <code>DELETE_IN_PROGRESS</code> task definition revision
36
- * can still scale up or down by modifying the service's desired count.</p>
37
- * <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new tasks or create
38
- * new services. You also can't update an existing service to reference a <code>DELETE_IN_PROGRESS</code>
39
- * task definition revision.</p>
40
- * <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until all the
41
- * associated tasks and services have been terminated.</p>
42
- * <p>When you delete all <code>INACTIVE</code> task definition revisions, the task definition name is not
43
- * displayed in the console and not returned in the API. If a task definition revisions are in the
44
- * <code>DELETE_IN_PROGRESS</code> state, the task definition name is displayed in the console and
45
- * returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the
46
- * next time you create a task definition with that name.</p>
34
+ * <code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and
35
+ * services that reference a <code>DELETE_IN_PROGRESS</code> task definition revision
36
+ * continue to run without disruption. Existing services that reference a
37
+ * <code>DELETE_IN_PROGRESS</code> task definition revision can still scale up or down
38
+ * by modifying the service's desired count.</p>
39
+ * <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new
40
+ * tasks or create new services. You also can't update an existing service to reference a
41
+ * <code>DELETE_IN_PROGRESS</code> task definition revision.</p>
42
+ * <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until
43
+ * all the associated tasks and services have been terminated.</p>
44
+ * <p>When you delete all <code>INACTIVE</code> task definition revisions, the task
45
+ * definition name is not displayed in the console and not returned in the API. If a task
46
+ * definition revisions are in the <code>DELETE_IN_PROGRESS</code> state, the task
47
+ * definition name is displayed in the console and returned in the API. The task definition
48
+ * name is retained by Amazon ECS and the revision is incremented the next time you create a
49
+ * task definition with that name.</p>
47
50
  * @example
48
51
  * Use a bare-bones client and the command you need to make an API call.
49
52
  * ```javascript
@@ -352,21 +355,23 @@ declare const DeleteTaskDefinitionsCommand_base: {
352
355
  * <p>You don't have authorization to perform the requested action.</p>
353
356
  *
354
357
  * @throws {@link ClientException} (client fault)
355
- * <p>These errors are usually caused by a client action. This client action might be using an action or
356
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
357
- * be specifying an identifier that isn't valid.</p>
358
+ * <p>These errors are usually caused by a client action. This client action might be using
359
+ * an action or resource on behalf of a user that doesn't have permissions to use the
360
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
358
361
  * <p>The following list includes additional causes for the error:</p>
359
362
  * <ul>
360
363
  * <li>
361
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
362
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
363
- * 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
364
- * quotas</a>.</p>
364
+ * <p>The <code>RunTask</code> could not be processed because you use managed
365
+ * scaling and there is a capacity error because the quota of tasks in the
366
+ * <code>PROVISIONING</code> per cluster has been reached. For information
367
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
368
+ * service quotas</a>.</p>
365
369
  * </li>
366
370
  * </ul>
367
371
  *
368
372
  * @throws {@link InvalidParameterException} (client fault)
369
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
373
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
374
+ * request.</p>
370
375
  *
371
376
  * @throws {@link ServerException} (server fault)
372
377
  * <p>These errors are usually caused by a server issue.</p>
@@ -28,8 +28,7 @@ declare const DeleteTaskSetCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Deletes a specified task set within a service. This is used when a service uses the
31
- * <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
32
- * types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
31
+ * <code>EXTERNAL</code> deployment controller type. 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>
33
32
  * @example
34
33
  * Use a bare-bones client and the command you need to make an API call.
35
34
  * ```javascript
@@ -126,16 +125,17 @@ declare const DeleteTaskSetCommand_base: {
126
125
  * <p>You don't have authorization to perform the requested action.</p>
127
126
  *
128
127
  * @throws {@link ClientException} (client fault)
129
- * <p>These errors are usually caused by a client action. This client action might be using an action or
130
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
131
- * be specifying an identifier that isn't valid.</p>
128
+ * <p>These errors are usually caused by a client action. This client action might be using
129
+ * an action or resource on behalf of a user that doesn't have permissions to use the
130
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
132
131
  * <p>The following list includes additional causes for the error:</p>
133
132
  * <ul>
134
133
  * <li>
135
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
136
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
137
- * 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
138
- * quotas</a>.</p>
134
+ * <p>The <code>RunTask</code> could not be processed because you use managed
135
+ * scaling and there is a capacity error because the quota of tasks in the
136
+ * <code>PROVISIONING</code> per cluster has been reached. For information
137
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
138
+ * service quotas</a>.</p>
139
139
  * </li>
140
140
  * </ul>
141
141
  *
@@ -143,20 +143,23 @@ declare const DeleteTaskSetCommand_base: {
143
143
  * <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>
144
144
  *
145
145
  * @throws {@link InvalidParameterException} (client fault)
146
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
146
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
147
+ * request.</p>
147
148
  *
148
149
  * @throws {@link ServerException} (server fault)
149
150
  * <p>These errors are usually caused by a server issue.</p>
150
151
  *
151
152
  * @throws {@link ServiceNotActiveException} (client fault)
152
- * <p>The specified service isn't active. You can't update a service that's inactive. If you have
153
- * 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>
153
+ * <p>The specified service isn't active. You can't update a service that's inactive. If you
154
+ * 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>
154
155
  *
155
156
  * @throws {@link ServiceNotFoundException} (client fault)
156
- * <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>
157
+ * <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
158
+ * specific.</p>
157
159
  *
158
160
  * @throws {@link TaskSetNotFoundException} (client fault)
159
- * <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>
161
+ * <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
162
+ * Region.</p>
160
163
  *
161
164
  * @throws {@link UnsupportedFeatureException} (client fault)
162
165
  * <p>The specified task isn't supported in this Region.</p>
@@ -27,18 +27,19 @@ declare const DeregisterContainerInstanceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer
31
- * available to run tasks.</p>
32
- * <p>If you intend to use the container instance for some other purpose after deregistration, we recommend
33
- * that you stop all of the tasks running on the container instance before deregistration. That prevents
34
- * any orphaned tasks from consuming resources.</p>
35
- * <p>Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the
36
- * EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to
37
- * stop billing.</p>
30
+ * <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is
31
+ * no longer available to run tasks.</p>
32
+ * <p>If you intend to use the container instance for some other purpose after
33
+ * deregistration, we recommend that you stop all of the tasks running on the container
34
+ * instance before deregistration. That prevents any orphaned tasks from consuming
35
+ * resources.</p>
36
+ * <p>Deregistering a container instance removes the instance from a cluster, but it doesn't
37
+ * terminate the EC2 instance. If you are finished using the instance, be sure to terminate
38
+ * it in the Amazon EC2 console to stop billing.</p>
38
39
  * <note>
39
- * <p>If you terminate a running container instance, Amazon ECS automatically deregisters the instance from
40
- * your cluster (stopped container instances or instances with disconnected agents aren't
41
- * automatically deregistered when terminated).</p>
40
+ * <p>If you terminate a running container instance, Amazon ECS automatically deregisters the
41
+ * instance from your cluster (stopped container instances or instances with
42
+ * disconnected agents aren't automatically deregistered when terminated).</p>
42
43
  * </note>
43
44
  * @example
44
45
  * Use a bare-bones client and the command you need to make an API call.
@@ -145,16 +146,17 @@ declare const DeregisterContainerInstanceCommand_base: {
145
146
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
146
147
  *
147
148
  * @throws {@link ClientException} (client fault)
148
- * <p>These errors are usually caused by a client action. This client action might be using an action or
149
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
150
- * be specifying an identifier that isn't valid.</p>
149
+ * <p>These errors are usually caused by a client action. This client action might be using
150
+ * an action or resource on behalf of a user that doesn't have permissions to use the
151
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
151
152
  * <p>The following list includes additional causes for the error:</p>
152
153
  * <ul>
153
154
  * <li>
154
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
155
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
156
- * 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
157
- * quotas</a>.</p>
155
+ * <p>The <code>RunTask</code> could not be processed because you use managed
156
+ * scaling and there is a capacity error because the quota of tasks in the
157
+ * <code>PROVISIONING</code> per cluster has been reached. For information
158
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
159
+ * service quotas</a>.</p>
158
160
  * </li>
159
161
  * </ul>
160
162
  *
@@ -162,7 +164,8 @@ declare const DeregisterContainerInstanceCommand_base: {
162
164
  * <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>
163
165
  *
164
166
  * @throws {@link InvalidParameterException} (client fault)
165
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
167
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
168
+ * request.</p>
166
169
  *
167
170
  * @throws {@link ServerException} (server fault)
168
171
  * <p>These errors are usually caused by a server issue.</p>
@@ -27,23 +27,24 @@ declare const DeregisterTaskDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deregisters the specified task definition by family and revision. Upon deregistration, the task
31
- * definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an
32
- * <code>INACTIVE</code> task definition continue to run without disruption. Existing services that
33
- * reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the
34
- * service's desired count. If you want to delete a task definition revision, you must first deregister
35
- * the task definition revision.</p>
36
- * <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new services, and
37
- * you can't update an existing service to reference an <code>INACTIVE</code> task definition. However,
38
- * there may be up to a 10-minute window following deregistration where these restrictions have not yet
39
- * taken effect.</p>
30
+ * <p>Deregisters the specified task definition by family and revision. Upon deregistration,
31
+ * the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that
32
+ * reference an <code>INACTIVE</code> task definition continue to run without disruption.
33
+ * Existing services that reference an <code>INACTIVE</code> task definition can still
34
+ * scale up or down by modifying the service's desired count. If you want to delete a task
35
+ * definition revision, you must first deregister the task definition revision.</p>
36
+ * <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new
37
+ * services, and you can't update an existing service to reference an <code>INACTIVE</code>
38
+ * task definition. However, there may be up to a 10-minute window following deregistration
39
+ * where these restrictions have not yet taken effect.</p>
40
40
  * <note>
41
- * <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your account
42
- * indefinitely. However, this behavior is subject to change in the future. We don't recommend that
43
- * you rely on <code>INACTIVE</code> task definitions persisting beyond the lifecycle of any
44
- * associated tasks and services.</p>
41
+ * <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your
42
+ * account indefinitely. However, this behavior is subject to change in the future. We
43
+ * don't recommend that you rely on <code>INACTIVE</code> task definitions persisting
44
+ * beyond the lifecycle of any associated tasks and services.</p>
45
45
  * </note>
46
- * <p>You must deregister a task definition revision before you delete it. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html">DeleteTaskDefinitions</a>.</p>
46
+ * <p>You must deregister a task definition revision before you delete it. For more
47
+ * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html">DeleteTaskDefinitions</a>.</p>
47
48
  * @example
48
49
  * Use a bare-bones client and the command you need to make an API call.
49
50
  * ```javascript
@@ -338,21 +339,23 @@ declare const DeregisterTaskDefinitionCommand_base: {
338
339
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
339
340
  *
340
341
  * @throws {@link ClientException} (client fault)
341
- * <p>These errors are usually caused by a client action. This client action might be using an action or
342
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
343
- * be specifying an identifier that isn't valid.</p>
342
+ * <p>These errors are usually caused by a client action. This client action might be using
343
+ * an action or resource on behalf of a user that doesn't have permissions to use the
344
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
344
345
  * <p>The following list includes additional causes for the error:</p>
345
346
  * <ul>
346
347
  * <li>
347
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
348
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
349
- * 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
350
- * quotas</a>.</p>
348
+ * <p>The <code>RunTask</code> could not be processed because you use managed
349
+ * scaling and there is a capacity error because the quota of tasks in the
350
+ * <code>PROVISIONING</code> per cluster has been reached. For information
351
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
352
+ * service quotas</a>.</p>
351
353
  * </li>
352
354
  * </ul>
353
355
  *
354
356
  * @throws {@link InvalidParameterException} (client fault)
355
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
357
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
358
+ * request.</p>
356
359
  *
357
360
  * @throws {@link ServerException} (server fault)
358
361
  * <p>These errors are usually caused by a server issue.</p>
@@ -93,21 +93,23 @@ declare const DescribeCapacityProvidersCommand_base: {
93
93
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
94
94
  *
95
95
  * @throws {@link ClientException} (client fault)
96
- * <p>These errors are usually caused by a client action. This client action might be using an action or
97
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
98
- * be specifying an identifier that isn't valid.</p>
96
+ * <p>These errors are usually caused by a client action. This client action might be using
97
+ * an action or resource on behalf of a user that doesn't have permissions to use the
98
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
99
99
  * <p>The following list includes additional causes for the error:</p>
100
100
  * <ul>
101
101
  * <li>
102
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
103
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
104
- * 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
105
- * quotas</a>.</p>
102
+ * <p>The <code>RunTask</code> could not be processed because you use managed
103
+ * scaling and there is a capacity error because the quota of tasks in the
104
+ * <code>PROVISIONING</code> per cluster has been reached. For information
105
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
106
+ * service quotas</a>.</p>
106
107
  * </li>
107
108
  * </ul>
108
109
  *
109
110
  * @throws {@link InvalidParameterException} (client fault)
110
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
111
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
112
+ * request.</p>
111
113
  *
112
114
  * @throws {@link ServerException} (server fault)
113
115
  * <p>These errors are usually caused by a server issue.</p>
@@ -28,6 +28,7 @@ declare const DescribeClustersCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Describes one or more of your clusters.</p>
31
+ * <p> For CLI examples, see <a href="https://github.com/aws/aws-cli/blob/develop/awscli/examples/ecs/describe-clusters.rst">describe-clusters.rst</a> on GitHub.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -136,21 +137,23 @@ declare const DescribeClustersCommand_base: {
136
137
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
137
138
  *
138
139
  * @throws {@link ClientException} (client fault)
139
- * <p>These errors are usually caused by a client action. This client action might be using an action or
140
- * resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
141
- * be specifying an identifier that isn't valid.</p>
140
+ * <p>These errors are usually caused by a client action. This client action might be using
141
+ * an action or resource on behalf of a user that doesn't have permissions to use the
142
+ * action or resource. Or, it might be specifying an identifier that isn't valid.</p>
142
143
  * <p>The following list includes additional causes for the error:</p>
143
144
  * <ul>
144
145
  * <li>
145
- * <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
146
- * a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
147
- * 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
148
- * quotas</a>.</p>
146
+ * <p>The <code>RunTask</code> could not be processed because you use managed
147
+ * scaling and there is a capacity error because the quota of tasks in the
148
+ * <code>PROVISIONING</code> per cluster has been reached. For information
149
+ * about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
150
+ * service quotas</a>.</p>
149
151
  * </li>
150
152
  * </ul>
151
153
  *
152
154
  * @throws {@link InvalidParameterException} (client fault)
153
- * <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
155
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
156
+ * request.</p>
154
157
  *
155
158
  * @throws {@link ServerException} (server fault)
156
159
  * <p>These errors are usually caused by a server issue.</p>