@aws-sdk/client-ecs 3.993.0 → 3.995.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.
- package/README.md +1 -15
- package/dist-cjs/index.js +164 -164
- package/dist-cjs/models/errors.js +86 -86
- package/dist-cjs/schemas/schemas_0.js +5 -5
- package/dist-es/models/enums.js +156 -156
- package/dist-es/models/errors.js +68 -68
- package/dist-es/schemas/schemas_0.js +5 -5
- package/dist-es/waiters/waitForServicesInactive.js +2 -2
- package/dist-es/waiters/waitForServicesStable.js +2 -2
- package/dist-es/waiters/waitForTasksRunning.js +2 -2
- package/dist-es/waiters/waitForTasksStopped.js +2 -2
- package/dist-types/ECS.d.ts +1 -15
- package/dist-types/ECSClient.d.ts +1 -15
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +4 -16
- package/dist-types/commands/CreateClusterCommand.d.ts +3 -20
- package/dist-types/commands/CreateExpressGatewayServiceCommand.d.ts +4 -18
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -236
- package/dist-types/commands/CreateTaskSetCommand.d.ts +6 -25
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -18
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -7
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +3 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +7 -30
- package/dist-types/commands/DeleteExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/DeleteServiceCommand.d.ts +4 -30
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +3 -27
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +6 -16
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +3 -21
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +3 -25
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +34 -39
- package/dist-types/commands/DescribeClustersCommand.d.ts +3 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +3 -9
- package/dist-types/commands/DescribeExpressGatewayServiceCommand.d.ts +3 -14
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +44 -13
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +44 -14
- package/dist-types/commands/DescribeServicesCommand.d.ts +2 -7
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +3 -15
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +5 -16
- package/dist-types/commands/DescribeTasksCommand.d.ts +3 -12
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +4 -32
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +2 -7
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +9 -14
- package/dist-types/commands/ListAttributesCommand.d.ts +2 -11
- package/dist-types/commands/ListClustersCommand.d.ts +2 -7
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +3 -11
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +4 -15
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +3 -13
- package/dist-types/commands/ListServicesCommand.d.ts +3 -9
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -7
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -24
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -20
- package/dist-types/commands/ListTasksCommand.d.ts +14 -23
- package/dist-types/commands/PutAccountSettingCommand.d.ts +12 -22
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +3 -9
- package/dist-types/commands/PutAttributesCommand.d.ts +4 -14
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +4 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -13
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +3 -26
- package/dist-types/commands/RunTaskCommand.d.ts +6 -75
- package/dist-types/commands/StartTaskCommand.d.ts +3 -23
- package/dist-types/commands/StopServiceDeploymentCommand.d.ts +5 -25
- package/dist-types/commands/StopTaskCommand.d.ts +3 -25
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +3 -12
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +3 -12
- package/dist-types/commands/TagResourceCommand.d.ts +3 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -7
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +3 -10
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -7
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +2 -7
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +6 -41
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +3 -56
- package/dist-types/commands/UpdateExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/UpdateServiceCommand.d.ts +14 -146
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +6 -19
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +15 -47
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +6 -17
- package/dist-types/index.d.ts +1 -15
- package/dist-types/models/enums.d.ts +338 -338
- package/dist-types/models/errors.d.ts +74 -128
- package/dist-types/models/models_0.d.ts +3435 -9819
- package/dist-types/ts3.4/models/enums.d.ts +222 -222
- package/dist-types/ts3.4/models/errors.d.ts +61 -61
- package/dist-types/ts3.4/models/models_0.d.ts +1055 -1055
- package/package.json +3 -3
|
@@ -27,18 +27,7 @@ declare const CreateTaskSetCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Create a task set in the specified cluster and service. This is used when a service
|
|
31
|
-
* uses the <code>EXTERNAL</code> deployment controller type. For more information, see
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
|
|
33
|
-
* types</a> in the <i>Amazon Elastic Container Service Developer
|
|
34
|
-
* Guide</i>.</p>
|
|
35
|
-
* <note>
|
|
36
|
-
* <p>On March 21, 2024, a change was made to resolve the task definition revision
|
|
37
|
-
* before authorization. When a task definition revision is not specified,
|
|
38
|
-
* authorization will occur using the latest revision of a task definition.</p>
|
|
39
|
-
* </note>
|
|
40
|
-
* <p>For information about the maximum number of task sets and other quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service quotas</a> in the <i>Amazon Elastic Container Service
|
|
41
|
-
* Developer Guide</i>.</p>
|
|
30
|
+
* <p>Create a task set in the specified cluster and service. This is used when a service uses the <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> <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> <p>For information about the maximum number of task sets and other quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
42
31
|
* @example
|
|
43
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
33
|
* ```javascript
|
|
@@ -196,25 +185,19 @@ declare const CreateTaskSetCommand_base: {
|
|
|
196
185
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
197
186
|
*
|
|
198
187
|
* @throws {@link ClientException} (client fault)
|
|
199
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
200
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
201
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
188
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
202
189
|
*
|
|
203
190
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
204
191
|
* <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>
|
|
205
192
|
*
|
|
206
193
|
* @throws {@link InvalidParameterException} (client fault)
|
|
207
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
208
|
-
* request.</p>
|
|
209
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
210
|
-
* service event messages</a>. </p>
|
|
194
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
211
195
|
*
|
|
212
196
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
213
197
|
* <p>The specified namespace wasn't found.</p>
|
|
214
198
|
*
|
|
215
199
|
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
216
|
-
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
217
|
-
* definition.</p>
|
|
200
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
|
|
218
201
|
*
|
|
219
202
|
* @throws {@link PlatformUnknownException} (client fault)
|
|
220
203
|
* <p>The specified platform version doesn't exist.</p>
|
|
@@ -223,12 +206,10 @@ declare const CreateTaskSetCommand_base: {
|
|
|
223
206
|
* <p>These errors are usually caused by a server issue.</p>
|
|
224
207
|
*
|
|
225
208
|
* @throws {@link ServiceNotActiveException} (client fault)
|
|
226
|
-
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
227
|
-
* 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>
|
|
209
|
+
* <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 href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
|
|
228
210
|
*
|
|
229
211
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
230
|
-
* <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
|
|
231
|
-
* specific.</p>
|
|
212
|
+
* <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>
|
|
232
213
|
*
|
|
233
214
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
234
215
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -27,8 +27,7 @@ declare const DeleteAccountSettingCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Disables an account setting for a specified user, role, or the root user for an
|
|
31
|
-
* account.</p>
|
|
30
|
+
* <p>Disables an account setting for a specified user, role, or the root user for an account.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -61,15 +60,10 @@ declare const DeleteAccountSettingCommand_base: {
|
|
|
61
60
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
62
61
|
*
|
|
63
62
|
* @throws {@link ClientException} (client fault)
|
|
64
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
65
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
66
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
63
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
67
64
|
*
|
|
68
65
|
* @throws {@link InvalidParameterException} (client fault)
|
|
69
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
70
|
-
* request.</p>
|
|
71
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
72
|
-
* service event messages</a>. </p>
|
|
66
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
73
67
|
*
|
|
74
68
|
* @throws {@link ServerException} (server fault)
|
|
75
69
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -78,19 +72,18 @@ declare const DeleteAccountSettingCommand_base: {
|
|
|
78
72
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
79
73
|
*
|
|
80
74
|
*
|
|
81
|
-
* @example To delete
|
|
75
|
+
* @example To delete your account setting
|
|
82
76
|
* ```javascript
|
|
83
|
-
* // This example deletes the account setting for
|
|
77
|
+
* // This example deletes the account setting for your user for the specified resource type.
|
|
84
78
|
* const input = {
|
|
85
|
-
* name: "
|
|
86
|
-
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
79
|
+
* name: "serviceLongArnFormat"
|
|
87
80
|
* };
|
|
88
81
|
* const command = new DeleteAccountSettingCommand(input);
|
|
89
82
|
* const response = await client.send(command);
|
|
90
83
|
* /* response is
|
|
91
84
|
* {
|
|
92
85
|
* setting: {
|
|
93
|
-
* name: "
|
|
86
|
+
* name: "serviceLongArnFormat",
|
|
94
87
|
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
95
88
|
* value: "enabled"
|
|
96
89
|
* }
|
|
@@ -98,18 +91,19 @@ declare const DeleteAccountSettingCommand_base: {
|
|
|
98
91
|
* *\/
|
|
99
92
|
* ```
|
|
100
93
|
*
|
|
101
|
-
* @example To delete
|
|
94
|
+
* @example To delete the account settings for a specific IAM user or IAM role
|
|
102
95
|
* ```javascript
|
|
103
|
-
* // This example deletes the account setting for
|
|
96
|
+
* // This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.
|
|
104
97
|
* const input = {
|
|
105
|
-
* name: "
|
|
98
|
+
* name: "containerInstanceLongArnFormat",
|
|
99
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
106
100
|
* };
|
|
107
101
|
* const command = new DeleteAccountSettingCommand(input);
|
|
108
102
|
* const response = await client.send(command);
|
|
109
103
|
* /* response is
|
|
110
104
|
* {
|
|
111
105
|
* setting: {
|
|
112
|
-
* name: "
|
|
106
|
+
* name: "containerInstanceLongArnFormat",
|
|
113
107
|
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
114
108
|
* value: "enabled"
|
|
115
109
|
* }
|
|
@@ -72,15 +72,10 @@ declare const DeleteAttributesCommand_base: {
|
|
|
72
72
|
* <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>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link InvalidParameterException} (client fault)
|
|
75
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
76
|
-
* request.</p>
|
|
77
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
78
|
-
* service event messages</a>. </p>
|
|
75
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
79
76
|
*
|
|
80
77
|
* @throws {@link TargetNotFoundException} (client fault)
|
|
81
|
-
* <p>The specified target wasn't found. You can view your available container instances
|
|
82
|
-
* with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific
|
|
83
|
-
* and Region-specific.</p>
|
|
78
|
+
* <p>The specified target wasn't found. You can view your available container instances with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and Region-specific.</p>
|
|
84
79
|
*
|
|
85
80
|
* @throws {@link ECSServiceException}
|
|
86
81
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,20 +27,7 @@ declare const DeleteCapacityProviderCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the specified capacity provider.</p>
|
|
31
|
-
* <note>
|
|
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>
|
|
35
|
-
* </note>
|
|
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>
|
|
30
|
+
* <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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</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 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 href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> or delete the cluster.</p>
|
|
44
31
|
* @example
|
|
45
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
46
33
|
* ```javascript
|
|
@@ -187,18 +174,13 @@ declare const DeleteCapacityProviderCommand_base: {
|
|
|
187
174
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
188
175
|
*
|
|
189
176
|
* @throws {@link ClientException} (client fault)
|
|
190
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
191
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
192
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
177
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
193
178
|
*
|
|
194
179
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
195
180
|
* <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>
|
|
196
181
|
*
|
|
197
182
|
* @throws {@link InvalidParameterException} (client fault)
|
|
198
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
199
|
-
* request.</p>
|
|
200
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
201
|
-
* service event messages</a>. </p>
|
|
183
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
202
184
|
*
|
|
203
185
|
* @throws {@link ServerException} (server fault)
|
|
204
186
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,12 +27,7 @@ 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>
|
|
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>
|
|
30
|
+
* <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code> state. Clusters with an <code>INACTIVE</code> status might remain discoverable in your 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 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>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -129,27 +124,16 @@ declare const DeleteClusterCommand_base: {
|
|
|
129
124
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
130
125
|
*
|
|
131
126
|
* @throws {@link ClientException} (client fault)
|
|
132
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
133
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
134
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
127
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
135
128
|
*
|
|
136
129
|
* @throws {@link ClusterContainsCapacityProviderException} (client fault)
|
|
137
|
-
* <p>The cluster contains one or more capacity providers that prevent the requested
|
|
138
|
-
* operation. This exception occurs when you try to delete a cluster that still has active
|
|
139
|
-
* capacity providers, including Amazon ECS Managed Instances capacity providers. You must
|
|
140
|
-
* first delete all capacity providers from the cluster before you can delete the cluster
|
|
141
|
-
* itself.</p>
|
|
130
|
+
* <p>The cluster contains one or more capacity providers that prevent the requested operation. This exception occurs when you try to delete a cluster that still has active capacity providers, including Amazon ECS Managed Instances capacity providers. You must first delete all capacity providers from the cluster before you can delete the cluster itself.</p>
|
|
142
131
|
*
|
|
143
132
|
* @throws {@link ClusterContainsContainerInstancesException} (client fault)
|
|
144
|
-
* <p>You can't delete a cluster that has registered container instances. First, deregister
|
|
145
|
-
* the container instances before you can delete the cluster. For more information, see
|
|
146
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
|
|
133
|
+
* <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 href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html">DeregisterContainerInstance</a>.</p>
|
|
147
134
|
*
|
|
148
135
|
* @throws {@link ClusterContainsServicesException} (client fault)
|
|
149
|
-
* <p>You can't delete a cluster that contains services. First, update the service to reduce
|
|
150
|
-
* its desired task count to 0, and then delete the service. For more information, see
|
|
151
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a> and
|
|
152
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html">DeleteService</a>.</p>
|
|
136
|
+
* <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 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>
|
|
153
137
|
*
|
|
154
138
|
* @throws {@link ClusterContainsTasksException} (client fault)
|
|
155
139
|
* <p>You can't delete a cluster that has active tasks.</p>
|
|
@@ -158,20 +142,13 @@ declare const DeleteClusterCommand_base: {
|
|
|
158
142
|
* <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>
|
|
159
143
|
*
|
|
160
144
|
* @throws {@link InvalidParameterException} (client fault)
|
|
161
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
162
|
-
* request.</p>
|
|
163
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
164
|
-
* service event messages</a>. </p>
|
|
145
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
165
146
|
*
|
|
166
147
|
* @throws {@link ServerException} (server fault)
|
|
167
148
|
* <p>These errors are usually caused by a server issue.</p>
|
|
168
149
|
*
|
|
169
150
|
* @throws {@link UpdateInProgressException} (client fault)
|
|
170
|
-
* <p>There's already a current Amazon ECS container agent update in progress on the
|
|
171
|
-
* container instance that's specified. If the container agent becomes disconnected while
|
|
172
|
-
* it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the
|
|
173
|
-
* update process can get stuck in that state. However, when the agent reconnects, it
|
|
174
|
-
* resumes where it stopped previously.</p>
|
|
151
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>
|
|
175
152
|
*
|
|
176
153
|
* @throws {@link ECSServiceException}
|
|
177
154
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,14 +27,7 @@ declare const DeleteExpressGatewayServiceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an Express service and removes all associated Amazon Web Services resources. This operation
|
|
31
|
-
* stops service tasks, removes the Application Load Balancer, target groups, security groups,
|
|
32
|
-
* auto-scaling policies, and other managed infrastructure components.</p>
|
|
33
|
-
* <p>The service enters a <code>DRAINING</code> state where existing tasks complete current
|
|
34
|
-
* requests without starting new tasks. After all tasks stop, the service and infrastructure
|
|
35
|
-
* are permanently removed.</p>
|
|
36
|
-
* <p>This operation cannot be reversed. Back up important data and verify the service is no
|
|
37
|
-
* longer needed before deletion.</p>
|
|
30
|
+
* <p>Deletes an Express service and removes all associated Amazon Web Services resources. This operation stops service tasks, removes the Application Load Balancer, target groups, security groups, auto-scaling policies, and other managed infrastructure components.</p> <p>The service enters a <code>DRAINING</code> state where existing tasks complete current requests without starting new tasks. After all tasks stop, the service and infrastructure are permanently removed.</p> <p>This operation cannot be reversed. Back up important data and verify the service is no longer needed before deletion.</p>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -139,29 +132,22 @@ declare const DeleteExpressGatewayServiceCommand_base: {
|
|
|
139
132
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
140
133
|
*
|
|
141
134
|
* @throws {@link ClientException} (client fault)
|
|
142
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
143
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
144
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
135
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
145
136
|
*
|
|
146
137
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
147
138
|
* <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>
|
|
148
139
|
*
|
|
149
140
|
* @throws {@link InvalidParameterException} (client fault)
|
|
150
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
151
|
-
* request.</p>
|
|
152
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
153
|
-
* service event messages</a>. </p>
|
|
141
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
154
142
|
*
|
|
155
143
|
* @throws {@link ServerException} (server fault)
|
|
156
144
|
* <p>These errors are usually caused by a server issue.</p>
|
|
157
145
|
*
|
|
158
146
|
* @throws {@link ServiceNotActiveException} (client fault)
|
|
159
|
-
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
160
|
-
* 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>
|
|
147
|
+
* <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 href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
|
|
161
148
|
*
|
|
162
149
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
163
|
-
* <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
|
|
164
|
-
* specific.</p>
|
|
150
|
+
* <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>
|
|
165
151
|
*
|
|
166
152
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
167
153
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -27,27 +27,7 @@ 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
|
|
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
|
-
* <note>
|
|
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
|
|
43
|
-
* record 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>
|
|
45
|
-
* </note>
|
|
46
|
-
* <important>
|
|
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>
|
|
50
|
-
* </important>
|
|
30
|
+
* <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 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 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 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 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> <p>If you attempt to create a new service with the same name as an existing service in either <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an error.</p> </important>
|
|
51
31
|
* @example
|
|
52
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
53
33
|
* ```javascript
|
|
@@ -409,25 +389,19 @@ declare const DeleteServiceCommand_base: {
|
|
|
409
389
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
410
390
|
*
|
|
411
391
|
* @throws {@link ClientException} (client fault)
|
|
412
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
413
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
414
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
392
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
415
393
|
*
|
|
416
394
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
417
395
|
* <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>
|
|
418
396
|
*
|
|
419
397
|
* @throws {@link InvalidParameterException} (client fault)
|
|
420
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
421
|
-
* request.</p>
|
|
422
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
423
|
-
* service event messages</a>. </p>
|
|
398
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
424
399
|
*
|
|
425
400
|
* @throws {@link ServerException} (server fault)
|
|
426
401
|
* <p>These errors are usually caused by a server issue.</p>
|
|
427
402
|
*
|
|
428
403
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
429
|
-
* <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
|
|
430
|
-
* specific.</p>
|
|
404
|
+
* <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>
|
|
431
405
|
*
|
|
432
406
|
* @throws {@link ECSServiceException}
|
|
433
407
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,26 +27,7 @@ declare const DeleteTaskDefinitionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes one or more task definitions.</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>
|
|
33
|
-
* <p>When you delete a task definition revision, it is immediately transitions from the
|
|
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
|
|
49
|
-
* a task definition with that name.</p>
|
|
30
|
+
* <p>Deletes one or more task definitions.</p> <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> <p>When you delete a task definition revision, it is immediately transitions from the <code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and services that reference a <code>DELETE_IN_PROGRESS</code> task definition revision continue to run without disruption. Existing services that reference a <code>DELETE_IN_PROGRESS</code> task definition revision can still scale up or down by modifying the service's desired count.</p> <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new tasks or create new services. You also can't update an existing service to reference a <code>DELETE_IN_PROGRESS</code> task definition revision.</p> <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until all the associated tasks and services have been terminated.</p> <p>When you delete all <code>INACTIVE</code> task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the <code>DELETE_IN_PROGRESS</code> state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.</p>
|
|
50
31
|
* @example
|
|
51
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
33
|
* ```javascript
|
|
@@ -358,15 +339,10 @@ declare const DeleteTaskDefinitionsCommand_base: {
|
|
|
358
339
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
359
340
|
*
|
|
360
341
|
* @throws {@link ClientException} (client fault)
|
|
361
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
362
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
363
|
-
* action or resource. Or, it might 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 an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
364
343
|
*
|
|
365
344
|
* @throws {@link InvalidParameterException} (client fault)
|
|
366
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
367
|
-
* request.</p>
|
|
368
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
369
|
-
* service event messages</a>. </p>
|
|
345
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
370
346
|
*
|
|
371
347
|
* @throws {@link ServerException} (server fault)
|
|
372
348
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,9 +27,7 @@ declare const DeleteTaskSetCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
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 types</a> in the <i>Amazon Elastic Container
|
|
32
|
-
* Service Developer Guide</i>.</p>
|
|
30
|
+
* <p>Deletes a specified task set within a service. This is used when a service uses the <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
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -134,33 +132,25 @@ declare const DeleteTaskSetCommand_base: {
|
|
|
134
132
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
135
133
|
*
|
|
136
134
|
* @throws {@link ClientException} (client fault)
|
|
137
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
138
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
139
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
135
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
140
136
|
*
|
|
141
137
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
142
138
|
* <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>
|
|
143
139
|
*
|
|
144
140
|
* @throws {@link InvalidParameterException} (client fault)
|
|
145
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
146
|
-
* request.</p>
|
|
147
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
148
|
-
* service event messages</a>. </p>
|
|
141
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
149
142
|
*
|
|
150
143
|
* @throws {@link ServerException} (server fault)
|
|
151
144
|
* <p>These errors are usually caused by a server issue.</p>
|
|
152
145
|
*
|
|
153
146
|
* @throws {@link ServiceNotActiveException} (client fault)
|
|
154
|
-
* <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 href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
|
|
147
|
+
* <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 href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
|
|
156
148
|
*
|
|
157
149
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
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
|
|
159
|
-
* specific.</p>
|
|
150
|
+
* <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>
|
|
160
151
|
*
|
|
161
152
|
* @throws {@link TaskSetNotFoundException} (client fault)
|
|
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
|
|
163
|
-
* Region.</p>
|
|
153
|
+
* <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>
|
|
164
154
|
*
|
|
165
155
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
166
156
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -27,20 +27,7 @@ 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
|
|
31
|
-
* is 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>
|
|
39
|
-
* <note>
|
|
40
|
-
* <p>If you terminate a running container instance, Amazon ECS automatically
|
|
41
|
-
* deregisters the instance from your cluster (stopped container instances or instances
|
|
42
|
-
* with disconnected agents aren't automatically deregistered when terminated).</p>
|
|
43
|
-
* </note>
|
|
30
|
+
* <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.</p> <p>If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.</p> <p>Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.</p> <note> <p>If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).</p> </note>
|
|
44
31
|
* @example
|
|
45
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
46
33
|
* ```javascript
|
|
@@ -148,18 +135,13 @@ declare const DeregisterContainerInstanceCommand_base: {
|
|
|
148
135
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
149
136
|
*
|
|
150
137
|
* @throws {@link ClientException} (client fault)
|
|
151
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
152
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
153
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
138
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
154
139
|
*
|
|
155
140
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
156
141
|
* <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
142
|
*
|
|
158
143
|
* @throws {@link InvalidParameterException} (client fault)
|
|
159
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
160
|
-
* request.</p>
|
|
161
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
162
|
-
* service event messages</a>. </p>
|
|
144
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
163
145
|
*
|
|
164
146
|
* @throws {@link ServerException} (server fault)
|
|
165
147
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,24 +27,7 @@ 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,
|
|
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
|
-
* <note>
|
|
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
|
-
* </note>
|
|
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>
|
|
30
|
+
* <p>Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.</p> <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you can't update an existing service to reference an <code>INACTIVE</code> task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.</p> <note> <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on <code>INACTIVE</code> task definitions persisting beyond the lifecycle of any associated tasks and services.</p> </note> <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>
|
|
48
31
|
* @example
|
|
49
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
33
|
* ```javascript
|
|
@@ -342,15 +325,10 @@ declare const DeregisterTaskDefinitionCommand_base: {
|
|
|
342
325
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
343
326
|
*
|
|
344
327
|
* @throws {@link ClientException} (client fault)
|
|
345
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
346
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
347
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
328
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
348
329
|
*
|
|
349
330
|
* @throws {@link InvalidParameterException} (client fault)
|
|
350
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
351
|
-
* request.</p>
|
|
352
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
353
|
-
* service event messages</a>. </p>
|
|
331
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
354
332
|
*
|
|
355
333
|
* @throws {@link ServerException} (server fault)
|
|
356
334
|
* <p>These errors are usually caused by a server issue.</p>
|