@aws-sdk/client-ecs 3.288.0 → 3.290.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/dist-types/commands/CreateCapacityProviderCommand.d.ts +23 -0
- package/dist-types/commands/CreateClusterCommand.d.ts +37 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +149 -0
- package/dist-types/commands/CreateTaskSetCommand.d.ts +40 -0
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +54 -0
- package/dist-types/commands/DeleteAttributesCommand.d.ts +13 -0
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +13 -0
- package/dist-types/commands/DeleteClusterCommand.d.ts +60 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +31 -0
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +16 -0
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +34 -0
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +29 -0
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +13 -0
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +13 -0
- package/dist-types/commands/DescribeClustersCommand.d.ts +38 -0
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +104 -0
- package/dist-types/commands/DescribeServicesCommand.d.ts +71 -0
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +71 -0
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +30 -0
- package/dist-types/commands/DescribeTasksCommand.d.ts +67 -0
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +9 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +37 -0
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +51 -0
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +78 -0
- package/dist-types/commands/ListAttributesCommand.d.ts +8 -0
- package/dist-types/commands/ListClustersCommand.d.ts +30 -0
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +35 -0
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +16 -0
- package/dist-types/commands/ListServicesCommand.d.ts +32 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +37 -0
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +51 -0
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +55 -0
- package/dist-types/commands/ListTasksCommand.d.ts +58 -0
- package/dist-types/commands/PutAccountSettingCommand.d.ts +56 -0
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +34 -0
- package/dist-types/commands/PutAttributesCommand.d.ts +18 -0
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +26 -0
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +13 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +66 -0
- package/dist-types/commands/RunTaskCommand.d.ts +73 -0
- package/dist-types/commands/StartTaskCommand.d.ts +16 -0
- package/dist-types/commands/StopTaskCommand.d.ts +16 -0
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +16 -0
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +12 -0
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +36 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +33 -0
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +13 -0
- package/dist-types/commands/UpdateClusterCommand.d.ts +16 -0
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +34 -0
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +16 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +61 -0
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +34 -0
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +106 -0
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +34 -0
- package/package.json +30 -30
|
@@ -35,6 +35,29 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
|
|
|
35
35
|
* @see {@link CreateCapacityProviderCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link ClientException} (client fault)
|
|
39
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
40
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
41
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
44
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
45
|
+
* request.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
48
|
+
* <p>The limit for the resource was exceeded.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ServerException} (server fault)
|
|
51
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link UpdateInProgressException} (client fault)
|
|
54
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
55
|
+
* instance that's specified. If the container agent becomes disconnected while it's in a
|
|
56
|
+
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
|
|
57
|
+
* process can get stuck in that state. However, when the agent reconnects, it resumes
|
|
58
|
+
* where it stopped previously.</p>
|
|
59
|
+
*
|
|
60
|
+
*
|
|
38
61
|
*/
|
|
39
62
|
export declare class CreateCapacityProviderCommand extends $Command<CreateCapacityProviderCommandInput, CreateCapacityProviderCommandOutput, ECSClientResolvedConfig> {
|
|
40
63
|
readonly input: CreateCapacityProviderCommandInput;
|
|
@@ -39,6 +39,43 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
|
|
|
39
39
|
* @see {@link CreateClusterCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @throws {@link ClientException} (client fault)
|
|
43
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
44
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
45
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
48
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
49
|
+
* request.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ServerException} (server fault)
|
|
52
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
53
|
+
*
|
|
54
|
+
*
|
|
55
|
+
* @example To create a new cluster
|
|
56
|
+
* ```javascript
|
|
57
|
+
* // This example creates a cluster in your default region.
|
|
58
|
+
* const input = {
|
|
59
|
+
* "clusterName": "my_cluster"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new CreateClusterCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* /* response ==
|
|
64
|
+
* {
|
|
65
|
+
* "cluster": {
|
|
66
|
+
* "activeServicesCount": 0,
|
|
67
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster",
|
|
68
|
+
* "clusterName": "my_cluster",
|
|
69
|
+
* "pendingTasksCount": 0,
|
|
70
|
+
* "registeredContainerInstancesCount": 0,
|
|
71
|
+
* "runningTasksCount": 0,
|
|
72
|
+
* "status": "ACTIVE"
|
|
73
|
+
* }
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: to-create-a-new-cluster-1472514079365
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
42
79
|
*/
|
|
43
80
|
export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, ECSClientResolvedConfig> {
|
|
44
81
|
readonly input: CreateClusterCommandInput;
|
|
@@ -105,6 +105,155 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
105
105
|
* @see {@link CreateServiceCommandOutput} for command's `response` shape.
|
|
106
106
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
107
107
|
*
|
|
108
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
109
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ClientException} (client fault)
|
|
112
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
113
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
114
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
117
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
120
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
121
|
+
* request.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
124
|
+
* <p>The specified namespace wasn't found.</p>
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
127
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
128
|
+
* definition.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link PlatformUnknownException} (client fault)
|
|
131
|
+
* <p>The specified platform version doesn't exist.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ServerException} (server fault)
|
|
134
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
137
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
138
|
+
*
|
|
139
|
+
*
|
|
140
|
+
* @example To create a new service
|
|
141
|
+
* ```javascript
|
|
142
|
+
* // This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.
|
|
143
|
+
* const input = {
|
|
144
|
+
* "desiredCount": 10,
|
|
145
|
+
* "serviceName": "ecs-simple-service",
|
|
146
|
+
* "taskDefinition": "hello_world"
|
|
147
|
+
* };
|
|
148
|
+
* const command = new CreateServiceCommand(input);
|
|
149
|
+
* const response = await client.send(command);
|
|
150
|
+
* /* response ==
|
|
151
|
+
* {
|
|
152
|
+
* "service": {
|
|
153
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
154
|
+
* "createdAt": "2016-08-29T16:13:47.298Z",
|
|
155
|
+
* "deploymentConfiguration": {
|
|
156
|
+
* "maximumPercent": 200,
|
|
157
|
+
* "minimumHealthyPercent": 100
|
|
158
|
+
* },
|
|
159
|
+
* "deployments": [
|
|
160
|
+
* {
|
|
161
|
+
* "createdAt": "2016-08-29T16:13:47.298Z",
|
|
162
|
+
* "desiredCount": 10,
|
|
163
|
+
* "id": "ecs-svc/9223370564342348388",
|
|
164
|
+
* "pendingCount": 0,
|
|
165
|
+
* "runningCount": 0,
|
|
166
|
+
* "status": "PRIMARY",
|
|
167
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
|
|
168
|
+
* "updatedAt": "2016-08-29T16:13:47.298Z"
|
|
169
|
+
* },
|
|
170
|
+
* {
|
|
171
|
+
* "createdAt": "2016-08-29T15:52:44.481Z",
|
|
172
|
+
* "desiredCount": 0,
|
|
173
|
+
* "id": "ecs-svc/9223370564343611322",
|
|
174
|
+
* "pendingCount": 0,
|
|
175
|
+
* "runningCount": 0,
|
|
176
|
+
* "status": "ACTIVE",
|
|
177
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
|
|
178
|
+
* "updatedAt": "2016-08-29T16:11:38.941Z"
|
|
179
|
+
* }
|
|
180
|
+
* ],
|
|
181
|
+
* "desiredCount": 10,
|
|
182
|
+
* "events": [],
|
|
183
|
+
* "loadBalancers": [],
|
|
184
|
+
* "pendingCount": 0,
|
|
185
|
+
* "runningCount": 0,
|
|
186
|
+
* "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service",
|
|
187
|
+
* "serviceName": "ecs-simple-service",
|
|
188
|
+
* "status": "ACTIVE",
|
|
189
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
|
|
190
|
+
* }
|
|
191
|
+
* }
|
|
192
|
+
* *\/
|
|
193
|
+
* // example id: to-create-a-new-service-1472512584282
|
|
194
|
+
* ```
|
|
195
|
+
*
|
|
196
|
+
* @example To create a new service behind a load balancer
|
|
197
|
+
* ```javascript
|
|
198
|
+
* // This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.
|
|
199
|
+
* const input = {
|
|
200
|
+
* "desiredCount": 10,
|
|
201
|
+
* "loadBalancers": [
|
|
202
|
+
* {
|
|
203
|
+
* "containerName": "simple-app",
|
|
204
|
+
* "containerPort": 80,
|
|
205
|
+
* "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2"
|
|
206
|
+
* }
|
|
207
|
+
* ],
|
|
208
|
+
* "role": "ecsServiceRole",
|
|
209
|
+
* "serviceName": "ecs-simple-service-elb",
|
|
210
|
+
* "taskDefinition": "console-sample-app-static"
|
|
211
|
+
* };
|
|
212
|
+
* const command = new CreateServiceCommand(input);
|
|
213
|
+
* const response = await client.send(command);
|
|
214
|
+
* /* response ==
|
|
215
|
+
* {
|
|
216
|
+
* "service": {
|
|
217
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
218
|
+
* "createdAt": "2016-08-29T16:02:54.884Z",
|
|
219
|
+
* "deploymentConfiguration": {
|
|
220
|
+
* "maximumPercent": 200,
|
|
221
|
+
* "minimumHealthyPercent": 100
|
|
222
|
+
* },
|
|
223
|
+
* "deployments": [
|
|
224
|
+
* {
|
|
225
|
+
* "createdAt": "2016-08-29T16:02:54.884Z",
|
|
226
|
+
* "desiredCount": 10,
|
|
227
|
+
* "id": "ecs-svc/9223370564343000923",
|
|
228
|
+
* "pendingCount": 0,
|
|
229
|
+
* "runningCount": 0,
|
|
230
|
+
* "status": "PRIMARY",
|
|
231
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6",
|
|
232
|
+
* "updatedAt": "2016-08-29T16:02:54.884Z"
|
|
233
|
+
* }
|
|
234
|
+
* ],
|
|
235
|
+
* "desiredCount": 10,
|
|
236
|
+
* "events": [],
|
|
237
|
+
* "loadBalancers": [
|
|
238
|
+
* {
|
|
239
|
+
* "containerName": "simple-app",
|
|
240
|
+
* "containerPort": 80,
|
|
241
|
+
* "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2"
|
|
242
|
+
* }
|
|
243
|
+
* ],
|
|
244
|
+
* "pendingCount": 0,
|
|
245
|
+
* "roleArn": "arn:aws:iam::012345678910:role/ecsServiceRole",
|
|
246
|
+
* "runningCount": 0,
|
|
247
|
+
* "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb",
|
|
248
|
+
* "serviceName": "ecs-simple-service-elb",
|
|
249
|
+
* "status": "ACTIVE",
|
|
250
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6"
|
|
251
|
+
* }
|
|
252
|
+
* }
|
|
253
|
+
* *\/
|
|
254
|
+
* // example id: to-create-a-new-service-behind-a-load-balancer-1472512484823
|
|
255
|
+
* ```
|
|
256
|
+
*
|
|
108
257
|
*/
|
|
109
258
|
export declare class CreateServiceCommand extends $Command<CreateServiceCommandInput, CreateServiceCommandOutput, ECSClientResolvedConfig> {
|
|
110
259
|
readonly input: CreateServiceCommandInput;
|
|
@@ -32,6 +32,46 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
|
|
|
32
32
|
* @see {@link CreateTaskSetCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
36
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link ClientException} (client fault)
|
|
39
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
40
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
41
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
44
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
47
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
48
|
+
* request.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
51
|
+
* <p>The specified namespace wasn't found.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
54
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
55
|
+
* definition.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link PlatformUnknownException} (client fault)
|
|
58
|
+
* <p>The specified platform version doesn't exist.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ServerException} (server fault)
|
|
61
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ServiceNotActiveException} (client fault)
|
|
64
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
65
|
+
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
68
|
+
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
69
|
+
* specific.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
72
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
35
75
|
*/
|
|
36
76
|
export declare class CreateTaskSetCommand extends $Command<CreateTaskSetCommandInput, CreateTaskSetCommandOutput, ECSClientResolvedConfig> {
|
|
37
77
|
readonly input: CreateTaskSetCommandInput;
|
|
@@ -30,6 +30,60 @@ export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingR
|
|
|
30
30
|
* @see {@link DeleteAccountSettingCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link ClientException} (client fault)
|
|
34
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
35
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
36
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
39
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
40
|
+
* request.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link ServerException} (server fault)
|
|
43
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* @example To delete your account setting
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // This example deletes the account setting for your user for the specified resource type.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "name": "serviceLongArnFormat"
|
|
51
|
+
* };
|
|
52
|
+
* const command = new DeleteAccountSettingCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* /* response ==
|
|
55
|
+
* {
|
|
56
|
+
* "setting": {
|
|
57
|
+
* "name": "serviceLongArnFormat",
|
|
58
|
+
* "value": "enabled",
|
|
59
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
60
|
+
* }
|
|
61
|
+
* }
|
|
62
|
+
* *\/
|
|
63
|
+
* // example id: to-delete-the-account-setting-for-your-user-account-1549524548115
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @example To delete the account settings for a specific IAM user or IAM role
|
|
67
|
+
* ```javascript
|
|
68
|
+
* // 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.
|
|
69
|
+
* const input = {
|
|
70
|
+
* "name": "containerInstanceLongArnFormat",
|
|
71
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
72
|
+
* };
|
|
73
|
+
* const command = new DeleteAccountSettingCommand(input);
|
|
74
|
+
* const response = await client.send(command);
|
|
75
|
+
* /* response ==
|
|
76
|
+
* {
|
|
77
|
+
* "setting": {
|
|
78
|
+
* "name": "containerInstanceLongArnFormat",
|
|
79
|
+
* "value": "enabled",
|
|
80
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
81
|
+
* }
|
|
82
|
+
* }
|
|
83
|
+
* *\/
|
|
84
|
+
* // example id: to-delete-the-account-setting-for-a-specific-iam-user-or-iam-role-1549524612917
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
33
87
|
*/
|
|
34
88
|
export declare class DeleteAccountSettingCommand extends $Command<DeleteAccountSettingCommandInput, DeleteAccountSettingCommandOutput, ECSClientResolvedConfig> {
|
|
35
89
|
readonly input: DeleteAccountSettingCommandInput;
|
|
@@ -29,6 +29,19 @@ export interface DeleteAttributesCommandOutput extends DeleteAttributesResponse,
|
|
|
29
29
|
* @see {@link DeleteAttributesCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
33
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
36
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
37
|
+
* request.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link TargetNotFoundException} (client fault)
|
|
40
|
+
* <p>The specified target wasn't found. You can view your available container instances
|
|
41
|
+
* with <a>ListContainerInstances</a>. Amazon ECS container instances are
|
|
42
|
+
* cluster-specific and Region-specific.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
32
45
|
*/
|
|
33
46
|
export declare class DeleteAttributesCommand extends $Command<DeleteAttributesCommandInput, DeleteAttributesCommandOutput, ECSClientResolvedConfig> {
|
|
34
47
|
readonly input: DeleteAttributesCommandInput;
|
|
@@ -43,6 +43,19 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi
|
|
|
43
43
|
* @see {@link DeleteCapacityProviderCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @throws {@link ClientException} (client fault)
|
|
47
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
48
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
49
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
52
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
53
|
+
* request.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ServerException} (server fault)
|
|
56
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
57
|
+
*
|
|
58
|
+
*
|
|
46
59
|
*/
|
|
47
60
|
export declare class DeleteCapacityProviderCommand extends $Command<DeleteCapacityProviderCommandInput, DeleteCapacityProviderCommandOutput, ECSClientResolvedConfig> {
|
|
48
61
|
readonly input: DeleteCapacityProviderCommandInput;
|
|
@@ -34,6 +34,66 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
|
|
|
34
34
|
* @see {@link DeleteClusterCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link ClientException} (client fault)
|
|
38
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
39
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
40
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link ClusterContainsContainerInstancesException} (client fault)
|
|
43
|
+
* <p>You can't delete a cluster that has registered container instances. First, deregister
|
|
44
|
+
* the container instances before you can delete the cluster. For more information, see
|
|
45
|
+
* <a>DeregisterContainerInstance</a>.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ClusterContainsServicesException} (client fault)
|
|
48
|
+
* <p>You can't delete a cluster that contains services. First, update the service to reduce
|
|
49
|
+
* its desired task count to 0, and then delete the service. For more information, see
|
|
50
|
+
* <a>UpdateService</a> and <a>DeleteService</a>.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ClusterContainsTasksException} (client fault)
|
|
53
|
+
* <p>You can't delete a cluster that has active tasks.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
56
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
59
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
60
|
+
* request.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ServerException} (server fault)
|
|
63
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link UpdateInProgressException} (client fault)
|
|
66
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
67
|
+
* instance that's specified. If the container agent becomes disconnected while it's in a
|
|
68
|
+
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
|
|
69
|
+
* process can get stuck in that state. However, when the agent reconnects, it resumes
|
|
70
|
+
* where it stopped previously.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @example To delete an empty cluster
|
|
74
|
+
* ```javascript
|
|
75
|
+
* // This example deletes an empty cluster in your default region.
|
|
76
|
+
* const input = {
|
|
77
|
+
* "cluster": "my_cluster"
|
|
78
|
+
* };
|
|
79
|
+
* const command = new DeleteClusterCommand(input);
|
|
80
|
+
* const response = await client.send(command);
|
|
81
|
+
* /* response ==
|
|
82
|
+
* {
|
|
83
|
+
* "cluster": {
|
|
84
|
+
* "activeServicesCount": 0,
|
|
85
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster",
|
|
86
|
+
* "clusterName": "my_cluster",
|
|
87
|
+
* "pendingTasksCount": 0,
|
|
88
|
+
* "registeredContainerInstancesCount": 0,
|
|
89
|
+
* "runningTasksCount": 0,
|
|
90
|
+
* "status": "INACTIVE"
|
|
91
|
+
* }
|
|
92
|
+
* }
|
|
93
|
+
* *\/
|
|
94
|
+
* // example id: to-delete-an-empty-cluster-1472512705352
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
37
97
|
*/
|
|
38
98
|
export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, ECSClientResolvedConfig> {
|
|
39
99
|
readonly input: DeleteClusterCommandInput;
|
|
@@ -49,6 +49,37 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
|
|
|
49
49
|
* @see {@link DeleteServiceCommandOutput} for command's `response` shape.
|
|
50
50
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
51
51
|
*
|
|
52
|
+
* @throws {@link ClientException} (client fault)
|
|
53
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
54
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
55
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
58
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
61
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
62
|
+
* request.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ServerException} (server fault)
|
|
65
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
68
|
+
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
69
|
+
* specific.</p>
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* @example To delete a service
|
|
73
|
+
* ```javascript
|
|
74
|
+
* // This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.
|
|
75
|
+
* const input = {
|
|
76
|
+
* "service": "my-http-service"
|
|
77
|
+
* };
|
|
78
|
+
* const command = new DeleteServiceCommand(input);
|
|
79
|
+
* await client.send(command);
|
|
80
|
+
* // example id: e8183e38-f86e-4390-b811-f74f30a6007d
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
52
83
|
*/
|
|
53
84
|
export declare class DeleteServiceCommand extends $Command<DeleteServiceCommandInput, DeleteServiceCommandOutput, ECSClientResolvedConfig> {
|
|
54
85
|
readonly input: DeleteServiceCommandInput;
|
|
@@ -42,6 +42,22 @@ export interface DeleteTaskDefinitionsCommandOutput extends DeleteTaskDefinition
|
|
|
42
42
|
* @see {@link DeleteTaskDefinitionsCommandOutput} for command's `response` shape.
|
|
43
43
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
44
44
|
*
|
|
45
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
46
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link ClientException} (client fault)
|
|
49
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
50
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
51
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
54
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
55
|
+
* request.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ServerException} (server fault)
|
|
58
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
59
|
+
*
|
|
60
|
+
*
|
|
45
61
|
*/
|
|
46
62
|
export declare class DeleteTaskDefinitionsCommand extends $Command<DeleteTaskDefinitionsCommandInput, DeleteTaskDefinitionsCommandOutput, ECSClientResolvedConfig> {
|
|
47
63
|
readonly input: DeleteTaskDefinitionsCommandInput;
|
|
@@ -30,6 +30,40 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
|
|
|
30
30
|
* @see {@link DeleteTaskSetCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link ClientException} (client fault)
|
|
37
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
38
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
39
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
42
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
45
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
46
|
+
* request.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link ServerException} (server fault)
|
|
49
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ServiceNotActiveException} (client fault)
|
|
52
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
53
|
+
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
56
|
+
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
57
|
+
* specific.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link TaskSetNotFoundException} (client fault)
|
|
60
|
+
* <p>The specified task set wasn't found. You can view your available task sets with <a>DescribeTaskSets</a>. Task sets are specific to each cluster, service and
|
|
61
|
+
* Region.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
64
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
33
67
|
*/
|
|
34
68
|
export declare class DeleteTaskSetCommand extends $Command<DeleteTaskSetCommandInput, DeleteTaskSetCommandOutput, ECSClientResolvedConfig> {
|
|
35
69
|
readonly input: DeleteTaskSetCommandInput;
|
|
@@ -42,6 +42,35 @@ export interface DeregisterContainerInstanceCommandOutput extends DeregisterCont
|
|
|
42
42
|
* @see {@link DeregisterContainerInstanceCommandOutput} for command's `response` shape.
|
|
43
43
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
44
44
|
*
|
|
45
|
+
* @throws {@link ClientException} (client fault)
|
|
46
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
47
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
48
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
51
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
54
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
55
|
+
* request.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ServerException} (server fault)
|
|
58
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
59
|
+
*
|
|
60
|
+
*
|
|
61
|
+
* @example To deregister a container instance from a cluster
|
|
62
|
+
* ```javascript
|
|
63
|
+
* // This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.
|
|
64
|
+
* const input = {
|
|
65
|
+
* "cluster": "default",
|
|
66
|
+
* "containerInstance": "container_instance_UUID",
|
|
67
|
+
* "force": true
|
|
68
|
+
* };
|
|
69
|
+
* const command = new DeregisterContainerInstanceCommand(input);
|
|
70
|
+
* await client.send(command);
|
|
71
|
+
* // example id: bf624927-cf64-4f4b-8b7e-c024a4e682f6
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
45
74
|
*/
|
|
46
75
|
export declare class DeregisterContainerInstanceCommand extends $Command<DeregisterContainerInstanceCommandInput, DeregisterContainerInstanceCommandOutput, ECSClientResolvedConfig> {
|
|
47
76
|
readonly input: DeregisterContainerInstanceCommandInput;
|
|
@@ -46,6 +46,19 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef
|
|
|
46
46
|
* @see {@link DeregisterTaskDefinitionCommandOutput} for command's `response` shape.
|
|
47
47
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
48
48
|
*
|
|
49
|
+
* @throws {@link ClientException} (client fault)
|
|
50
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
51
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
52
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
55
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
56
|
+
* request.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ServerException} (server fault)
|
|
59
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
60
|
+
*
|
|
61
|
+
*
|
|
49
62
|
*/
|
|
50
63
|
export declare class DeregisterTaskDefinitionCommand extends $Command<DeregisterTaskDefinitionCommandInput, DeregisterTaskDefinitionCommandOutput, ECSClientResolvedConfig> {
|
|
51
64
|
readonly input: DeregisterTaskDefinitionCommandInput;
|
|
@@ -29,6 +29,19 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity
|
|
|
29
29
|
* @see {@link DescribeCapacityProvidersCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ClientException} (client fault)
|
|
33
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
34
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
35
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
38
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
39
|
+
* request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ServerException} (server fault)
|
|
42
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
32
45
|
*/
|
|
33
46
|
export declare class DescribeCapacityProvidersCommand extends $Command<DescribeCapacityProvidersCommandInput, DescribeCapacityProvidersCommandOutput, ECSClientResolvedConfig> {
|
|
34
47
|
readonly input: DescribeCapacityProvidersCommandInput;
|