@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
|
@@ -191,18 +191,13 @@ declare const DescribeCapacityProvidersCommand_base: {
|
|
|
191
191
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
192
192
|
*
|
|
193
193
|
* @throws {@link ClientException} (client fault)
|
|
194
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
195
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
196
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
194
|
+
* <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>
|
|
197
195
|
*
|
|
198
196
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
199
197
|
* <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>
|
|
200
198
|
*
|
|
201
199
|
* @throws {@link InvalidParameterException} (client fault)
|
|
202
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
203
|
-
* request.</p>
|
|
204
|
-
* <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
|
|
205
|
-
* service event messages</a>. </p>
|
|
200
|
+
* <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>
|
|
206
201
|
*
|
|
207
202
|
* @throws {@link ServerException} (server fault)
|
|
208
203
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -214,17 +209,10 @@ declare const DescribeCapacityProvidersCommand_base: {
|
|
|
214
209
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
215
210
|
*
|
|
216
211
|
*
|
|
217
|
-
* @example To describe
|
|
212
|
+
* @example To describe all capacity providers
|
|
218
213
|
* ```javascript
|
|
219
|
-
* // This example retrieves details about
|
|
220
|
-
* const input = {
|
|
221
|
-
* capacityProviders: [
|
|
222
|
-
* "MyCapacityProvider"
|
|
223
|
-
* ],
|
|
224
|
-
* include: [
|
|
225
|
-
* "TAGS"
|
|
226
|
-
* ]
|
|
227
|
-
* };
|
|
214
|
+
* // This example retrieves details about all capacity providers.
|
|
215
|
+
* const input = { /* empty *\/ };
|
|
228
216
|
* const command = new DescribeCapacityProvidersCommand(input);
|
|
229
217
|
* const response = await client.send(command);
|
|
230
218
|
* /* response is
|
|
@@ -244,22 +232,36 @@ declare const DescribeCapacityProvidersCommand_base: {
|
|
|
244
232
|
* capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
|
|
245
233
|
* name: "MyCapacityProvider",
|
|
246
234
|
* status: "ACTIVE",
|
|
247
|
-
* tags:
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
235
|
+
* tags: []
|
|
236
|
+
* },
|
|
237
|
+
* {
|
|
238
|
+
* capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE",
|
|
239
|
+
* name: "FARGATE",
|
|
240
|
+
* status: "ACTIVE",
|
|
241
|
+
* tags: []
|
|
242
|
+
* },
|
|
243
|
+
* {
|
|
244
|
+
* capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT",
|
|
245
|
+
* name: "FARGATE_SPOT",
|
|
246
|
+
* status: "ACTIVE",
|
|
247
|
+
* tags: []
|
|
253
248
|
* }
|
|
254
249
|
* ]
|
|
255
250
|
* }
|
|
256
251
|
* *\/
|
|
257
252
|
* ```
|
|
258
253
|
*
|
|
259
|
-
* @example To describe
|
|
254
|
+
* @example To describe a specific capacity provider
|
|
260
255
|
* ```javascript
|
|
261
|
-
* // This example retrieves details about
|
|
262
|
-
* const input = {
|
|
256
|
+
* // This example retrieves details about the capacity provider MyCapacityProvider
|
|
257
|
+
* const input = {
|
|
258
|
+
* capacityProviders: [
|
|
259
|
+
* "MyCapacityProvider"
|
|
260
|
+
* ],
|
|
261
|
+
* include: [
|
|
262
|
+
* "TAGS"
|
|
263
|
+
* ]
|
|
264
|
+
* };
|
|
263
265
|
* const command = new DescribeCapacityProvidersCommand(input);
|
|
264
266
|
* const response = await client.send(command);
|
|
265
267
|
* /* response is
|
|
@@ -279,19 +281,12 @@ declare const DescribeCapacityProvidersCommand_base: {
|
|
|
279
281
|
* capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
|
|
280
282
|
* name: "MyCapacityProvider",
|
|
281
283
|
* status: "ACTIVE",
|
|
282
|
-
* tags:
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* tags: []
|
|
289
|
-
* },
|
|
290
|
-
* {
|
|
291
|
-
* capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT",
|
|
292
|
-
* name: "FARGATE_SPOT",
|
|
293
|
-
* status: "ACTIVE",
|
|
294
|
-
* tags: []
|
|
284
|
+
* tags: [
|
|
285
|
+
* {
|
|
286
|
+
* key: "environment",
|
|
287
|
+
* value: "production"
|
|
288
|
+
* }
|
|
289
|
+
* ]
|
|
295
290
|
* }
|
|
296
291
|
* ]
|
|
297
292
|
* }
|
|
@@ -27,9 +27,7 @@ declare const DescribeClustersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes one or more of your clusters.</p>
|
|
31
|
-
* <p> For CLI
|
|
32
|
-
* examples, see <a href="https://github.com/aws/aws-cli/blob/develop/awscli/examples/ecs/describe-clusters.rst">describe-clusters.rst</a> on GitHub.</p>
|
|
30
|
+
* <p>Describes one or more of your clusters.</p> <p> For CLI examples, see <a href="https://github.com/aws/aws-cli/blob/develop/awscli/examples/ecs/describe-clusters.rst">describe-clusters.rst</a> on GitHub.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -140,15 +138,10 @@ declare const DescribeClustersCommand_base: {
|
|
|
140
138
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
141
139
|
*
|
|
142
140
|
* @throws {@link ClientException} (client fault)
|
|
143
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
144
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
145
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
141
|
+
* <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>
|
|
146
142
|
*
|
|
147
143
|
* @throws {@link InvalidParameterException} (client fault)
|
|
148
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
149
|
-
* request.</p>
|
|
150
|
-
* <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
|
|
151
|
-
* 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>
|
|
152
145
|
*
|
|
153
146
|
* @throws {@link ServerException} (server fault)
|
|
154
147
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,8 +27,7 @@ declare const DescribeContainerInstancesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes one or more container instances. Returns metadata about each container
|
|
31
|
-
* instance requested.</p>
|
|
30
|
+
* <p>Describes one or more container instances. Returns metadata about each container instance requested.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -149,18 +148,13 @@ declare const DescribeContainerInstancesCommand_base: {
|
|
|
149
148
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
150
149
|
*
|
|
151
150
|
* @throws {@link ClientException} (client fault)
|
|
152
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
153
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
154
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
151
|
+
* <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>
|
|
155
152
|
*
|
|
156
153
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
157
154
|
* <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>
|
|
158
155
|
*
|
|
159
156
|
* @throws {@link InvalidParameterException} (client fault)
|
|
160
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
161
|
-
* request.</p>
|
|
162
|
-
* <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
|
|
163
|
-
* service event messages</a>. </p>
|
|
157
|
+
* <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>
|
|
164
158
|
*
|
|
165
159
|
* @throws {@link ServerException} (server fault)
|
|
166
160
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,13 +27,7 @@ declare const DescribeExpressGatewayServiceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves detailed information about an Express service, including current status,
|
|
31
|
-
* configuration, managed infrastructure, and service revisions.</p>
|
|
32
|
-
* <p>Returns comprehensive service details, active service revisions, ingress paths with
|
|
33
|
-
* endpoints, and managed Amazon Web Services resource status including load balancers and auto-scaling
|
|
34
|
-
* policies.</p>
|
|
35
|
-
* <p>Use the <code>include</code> parameter to retrieve additional information such as
|
|
36
|
-
* resource tags.</p>
|
|
30
|
+
* <p>Retrieves detailed information about an Express service, including current status, configuration, managed infrastructure, and service revisions.</p> <p>Returns comprehensive service details, active service revisions, ingress paths with endpoints, and managed Amazon Web Services resource status including load balancers and auto-scaling policies.</p> <p>Use the <code>include</code> parameter to retrieve additional information such as resource tags.</p>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|
|
@@ -141,18 +135,13 @@ declare const DescribeExpressGatewayServiceCommand_base: {
|
|
|
141
135
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
142
136
|
*
|
|
143
137
|
* @throws {@link ClientException} (client fault)
|
|
144
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
145
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
146
|
-
* 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>
|
|
147
139
|
*
|
|
148
140
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
149
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>
|
|
150
142
|
*
|
|
151
143
|
* @throws {@link InvalidParameterException} (client fault)
|
|
152
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
153
|
-
* request.</p>
|
|
154
|
-
* <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
|
|
155
|
-
* 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>
|
|
156
145
|
*
|
|
157
146
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
158
147
|
* <p>The specified resource wasn't found.</p>
|
|
@@ -27,10 +27,7 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes one or more of your service deployments.</p>
|
|
31
|
-
* <p>A service deployment happens when you release a software update for the service. For
|
|
32
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html">View service history
|
|
33
|
-
* using Amazon ECS service deployments</a>.</p>
|
|
30
|
+
* <p>Describes one or more of your service deployments.</p> <p>A service deployment happens when you release a software update for the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html">View service history using Amazon ECS service deployments</a>.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -155,25 +152,19 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
155
152
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
156
153
|
*
|
|
157
154
|
* @throws {@link ClientException} (client fault)
|
|
158
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
159
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
160
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
155
|
+
* <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>
|
|
161
156
|
*
|
|
162
157
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
163
158
|
* <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>
|
|
164
159
|
*
|
|
165
160
|
* @throws {@link InvalidParameterException} (client fault)
|
|
166
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
167
|
-
* request.</p>
|
|
168
|
-
* <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
|
|
169
|
-
* service event messages</a>. </p>
|
|
161
|
+
* <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>
|
|
170
162
|
*
|
|
171
163
|
* @throws {@link ServerException} (server fault)
|
|
172
164
|
* <p>These errors are usually caused by a server issue.</p>
|
|
173
165
|
*
|
|
174
166
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
175
|
-
* <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
|
|
176
|
-
* specific.</p>
|
|
167
|
+
* <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>
|
|
177
168
|
*
|
|
178
169
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
179
170
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -182,6 +173,46 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
182
173
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
183
174
|
*
|
|
184
175
|
*
|
|
176
|
+
* @example To describe a service deployment
|
|
177
|
+
* ```javascript
|
|
178
|
+
* // This example describes a service deployment for the service sd-example in the example cluster.
|
|
179
|
+
* const input = {
|
|
180
|
+
* serviceDeploymentArns: [
|
|
181
|
+
* "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5"
|
|
182
|
+
* ]
|
|
183
|
+
* };
|
|
184
|
+
* const command = new DescribeServiceDeploymentsCommand(input);
|
|
185
|
+
* const response = await client.send(command);
|
|
186
|
+
* /* response is
|
|
187
|
+
* {
|
|
188
|
+
* failures: [],
|
|
189
|
+
* serviceDeployments: [
|
|
190
|
+
* {
|
|
191
|
+
* clusterArn: "arn:aws:ecs:us-west-2:123456789012:cluster/example",
|
|
192
|
+
* deploymentConfiguration: {
|
|
193
|
+
* deploymentCircuitBreaker: {
|
|
194
|
+
* enable: false,
|
|
195
|
+
* rollback: false
|
|
196
|
+
* },
|
|
197
|
+
* maximumPercent: 200,
|
|
198
|
+
* minimumHealthyPercent: 100
|
|
199
|
+
* },
|
|
200
|
+
* serviceArn: "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
|
|
201
|
+
* serviceDeploymentArn: "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5",
|
|
202
|
+
* status: "PENDING",
|
|
203
|
+
* targetServiceRevision: {
|
|
204
|
+
* arn: "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095",
|
|
205
|
+
* pendingTaskCount: 0,
|
|
206
|
+
* requestedTaskCount: 0,
|
|
207
|
+
* runningTaskCount: 0
|
|
208
|
+
* },
|
|
209
|
+
* updatedAt: "2024-09-10T16:49:35.57Z"
|
|
210
|
+
* }
|
|
211
|
+
* ]
|
|
212
|
+
* }
|
|
213
|
+
* *\/
|
|
214
|
+
* ```
|
|
215
|
+
*
|
|
185
216
|
* @public
|
|
186
217
|
*/
|
|
187
218
|
export declare class DescribeServiceDeploymentsCommand extends DescribeServiceDeploymentsCommand_base {
|
|
@@ -27,11 +27,7 @@ declare const DescribeServiceRevisionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes one or more service revisions.</p>
|
|
31
|
-
* <p>A service revision is a version of the service that includes the values for the Amazon
|
|
32
|
-
* ECS resources (for example, task definition) and the environment resources (for example,
|
|
33
|
-
* load balancers, subnets, and security groups). For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html">Amazon ECS service revisions</a>.</p>
|
|
34
|
-
* <p>You can't describe a service revision that was created before October 25, 2024.</p>
|
|
30
|
+
* <p>Describes one or more service revisions.</p> <p>A service revision is a version of the service that includes the values for the Amazon ECS resources (for example, task definition) and the environment resources (for example, load balancers, subnets, and security groups). For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html">Amazon ECS service revisions</a>.</p> <p>You can't describe a service revision that was created before October 25, 2024.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -333,25 +329,19 @@ declare const DescribeServiceRevisionsCommand_base: {
|
|
|
333
329
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
334
330
|
*
|
|
335
331
|
* @throws {@link ClientException} (client fault)
|
|
336
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
337
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
338
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
332
|
+
* <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>
|
|
339
333
|
*
|
|
340
334
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
341
335
|
* <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>
|
|
342
336
|
*
|
|
343
337
|
* @throws {@link InvalidParameterException} (client fault)
|
|
344
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
345
|
-
* request.</p>
|
|
346
|
-
* <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
|
|
347
|
-
* service event messages</a>. </p>
|
|
338
|
+
* <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>
|
|
348
339
|
*
|
|
349
340
|
* @throws {@link ServerException} (server fault)
|
|
350
341
|
* <p>These errors are usually caused by a server issue.</p>
|
|
351
342
|
*
|
|
352
343
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
353
|
-
* <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
|
|
354
|
-
* specific.</p>
|
|
344
|
+
* <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>
|
|
355
345
|
*
|
|
356
346
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
357
347
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -360,6 +350,46 @@ declare const DescribeServiceRevisionsCommand_base: {
|
|
|
360
350
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
361
351
|
*
|
|
362
352
|
*
|
|
353
|
+
* @example To describe a service revision
|
|
354
|
+
* ```javascript
|
|
355
|
+
* // This example describes a service revision with the specified ARN
|
|
356
|
+
* const input = {
|
|
357
|
+
* serviceRevisionArns: [
|
|
358
|
+
* "arn:aws:ecs:us-west-2:123456789012:service-revision/testc/sd1/4980306466373577095"
|
|
359
|
+
* ]
|
|
360
|
+
* };
|
|
361
|
+
* const command = new DescribeServiceRevisionsCommand(input);
|
|
362
|
+
* const response = await client.send(command);
|
|
363
|
+
* /* response is
|
|
364
|
+
* {
|
|
365
|
+
* failures: [],
|
|
366
|
+
* serviceRevisions: [
|
|
367
|
+
* {
|
|
368
|
+
* clusterArn: "arn:aws:ecs:us-west-2:123456789012:cluster/example",
|
|
369
|
+
* createdAt: "2024-09-10T16:49:26.39Z",
|
|
370
|
+
* launchType: "FARGATE",
|
|
371
|
+
* networkConfiguration: {
|
|
372
|
+
* awsvpcConfiguration: {
|
|
373
|
+
* assignPublicIp: "ENABLED",
|
|
374
|
+
* securityGroups: [
|
|
375
|
+
* "sg-09605d60a6bc1b296"
|
|
376
|
+
* ],
|
|
377
|
+
* subnets: [
|
|
378
|
+
* "subnet-0a4040e73895f04e1"
|
|
379
|
+
* ]
|
|
380
|
+
* }
|
|
381
|
+
* },
|
|
382
|
+
* platformFamily: "DockerLinux",
|
|
383
|
+
* platformVersion: "1.4.0",
|
|
384
|
+
* serviceArn: "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
|
|
385
|
+
* serviceRevisionArn: "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095",
|
|
386
|
+
* taskDefinition: "arn:aws:ecs:us-west-2:123456789012:task-definition/large-ngingx:1"
|
|
387
|
+
* }
|
|
388
|
+
* ]
|
|
389
|
+
* }
|
|
390
|
+
* *\/
|
|
391
|
+
* ```
|
|
392
|
+
*
|
|
363
393
|
* @public
|
|
364
394
|
*/
|
|
365
395
|
export declare class DescribeServiceRevisionsCommand extends DescribeServiceRevisionsCommand_base {
|
|
@@ -402,18 +402,13 @@ declare const DescribeServicesCommand_base: {
|
|
|
402
402
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
403
403
|
*
|
|
404
404
|
* @throws {@link ClientException} (client fault)
|
|
405
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
406
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
407
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
405
|
+
* <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>
|
|
408
406
|
*
|
|
409
407
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
410
408
|
* <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>
|
|
411
409
|
*
|
|
412
410
|
* @throws {@link InvalidParameterException} (client fault)
|
|
413
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
414
|
-
* request.</p>
|
|
415
|
-
* <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
|
|
416
|
-
* service event messages</a>. </p>
|
|
411
|
+
* <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>
|
|
417
412
|
*
|
|
418
413
|
* @throws {@link ServerException} (server fault)
|
|
419
414
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,14 +27,7 @@ declare const DescribeTaskDefinitionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes a task definition. You can specify a <code>family</code> and
|
|
31
|
-
* <code>revision</code> to find information about a specific task definition, or you
|
|
32
|
-
* can simply specify the family to find the latest <code>ACTIVE</code> revision in that
|
|
33
|
-
* family.</p>
|
|
34
|
-
* <note>
|
|
35
|
-
* <p>You can only describe <code>INACTIVE</code> task definitions while an active task
|
|
36
|
-
* or service references them.</p>
|
|
37
|
-
* </note>
|
|
30
|
+
* <p>Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family.</p> <note> <p>You can only describe <code>INACTIVE</code> task definitions while an active task or service references them.</p> </note>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -341,15 +334,10 @@ declare const DescribeTaskDefinitionCommand_base: {
|
|
|
341
334
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
342
335
|
*
|
|
343
336
|
* @throws {@link ClientException} (client fault)
|
|
344
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
345
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
346
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
337
|
+
* <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>
|
|
347
338
|
*
|
|
348
339
|
* @throws {@link InvalidParameterException} (client fault)
|
|
349
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
350
|
-
* request.</p>
|
|
351
|
-
* <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
|
|
352
|
-
* service event messages</a>. </p>
|
|
340
|
+
* <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>
|
|
353
341
|
*
|
|
354
342
|
* @throws {@link ServerException} (server fault)
|
|
355
343
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,11 +27,7 @@ declare const DescribeTaskSetsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the task sets in the specified cluster and service. This is used when a
|
|
31
|
-
* service uses the <code>EXTERNAL</code> deployment controller type. For more information,
|
|
32
|
-
* see <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>
|
|
30
|
+
* <p>Describes the task sets 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>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -149,29 +145,22 @@ declare const DescribeTaskSetsCommand_base: {
|
|
|
149
145
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
150
146
|
*
|
|
151
147
|
* @throws {@link ClientException} (client fault)
|
|
152
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
153
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
154
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
148
|
+
* <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>
|
|
155
149
|
*
|
|
156
150
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
157
151
|
* <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>
|
|
158
152
|
*
|
|
159
153
|
* @throws {@link InvalidParameterException} (client fault)
|
|
160
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
161
|
-
* request.</p>
|
|
162
|
-
* <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
|
|
163
|
-
* service event messages</a>. </p>
|
|
154
|
+
* <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>
|
|
164
155
|
*
|
|
165
156
|
* @throws {@link ServerException} (server fault)
|
|
166
157
|
* <p>These errors are usually caused by a server issue.</p>
|
|
167
158
|
*
|
|
168
159
|
* @throws {@link ServiceNotActiveException} (client fault)
|
|
169
|
-
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
170
|
-
* 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>
|
|
160
|
+
* <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>
|
|
171
161
|
*
|
|
172
162
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
173
|
-
* <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
|
|
174
|
-
* specific.</p>
|
|
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 specific.</p>
|
|
175
164
|
*
|
|
176
165
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
177
166
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -27,11 +27,7 @@ declare const DescribeTasksCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes a specified task or tasks.</p>
|
|
31
|
-
* <p>Currently, stopped tasks appear in the returned results for at least one hour.</p>
|
|
32
|
-
* <p>If you have tasks with tags, and then delete the cluster, the tagged tasks are
|
|
33
|
-
* returned in the response. If you create a new cluster with the same name as the deleted
|
|
34
|
-
* cluster, the tagged tasks are not included in the response.</p>
|
|
30
|
+
* <p>Describes a specified task or tasks.</p> <p>Currently, stopped tasks appear in the returned results for at least one hour.</p> <p>If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -232,18 +228,13 @@ declare const DescribeTasksCommand_base: {
|
|
|
232
228
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
233
229
|
*
|
|
234
230
|
* @throws {@link ClientException} (client fault)
|
|
235
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
236
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
237
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
231
|
+
* <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>
|
|
238
232
|
*
|
|
239
233
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
240
234
|
* <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>
|
|
241
235
|
*
|
|
242
236
|
* @throws {@link InvalidParameterException} (client fault)
|
|
243
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
244
|
-
* request.</p>
|
|
245
|
-
* <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
|
|
246
|
-
* service event messages</a>. </p>
|
|
237
|
+
* <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>
|
|
247
238
|
*
|
|
248
239
|
* @throws {@link ServerException} (server fault)
|
|
249
240
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,11 +27,7 @@ declare const DiscoverPollEndpointCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use
|
|
32
|
-
* outside of the agent.</p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>
|
|
30
|
+
* <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -61,9 +57,7 @@ declare const DiscoverPollEndpointCommand_base: {
|
|
|
61
57
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
62
58
|
*
|
|
63
59
|
* @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>
|
|
60
|
+
* <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
61
|
*
|
|
68
62
|
* @throws {@link ServerException} (server fault)
|
|
69
63
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,14 +27,7 @@ declare const ExecuteCommandCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Runs a command remotely on a container within a task.</p>
|
|
31
|
-
* <p>If you use a condition key in your IAM policy to refine the conditions for the policy
|
|
32
|
-
* statement, for example limit the actions to a specific cluster, you receive an
|
|
33
|
-
* <code>AccessDeniedException</code> when there is a mismatch between the condition
|
|
34
|
-
* key value and the corresponding parameter value.</p>
|
|
35
|
-
* <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using
|
|
36
|
-
* Amazon ECS Exec for debugging</a> in the <i>Amazon ECS Developer
|
|
37
|
-
* Guide</i>. </p>
|
|
30
|
+
* <p>Runs a command remotely on a container within a task.</p> <p>If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an <code>AccessDeniedException</code> when there is a mismatch between the condition key value and the corresponding parameter value.</p> <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using Amazon ECS Exec for debugging</a> in the <i>Amazon ECS Developer Guide</i>. </p>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -77,40 +70,19 @@ declare const ExecuteCommandCommand_base: {
|
|
|
77
70
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
78
71
|
*
|
|
79
72
|
* @throws {@link ClientException} (client fault)
|
|
80
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
81
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
82
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
73
|
+
* <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>
|
|
83
74
|
*
|
|
84
75
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
85
76
|
* <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>
|
|
86
77
|
*
|
|
87
78
|
* @throws {@link InvalidParameterException} (client fault)
|
|
88
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
89
|
-
* request.</p>
|
|
90
|
-
* <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
|
|
91
|
-
* service event messages</a>. </p>
|
|
79
|
+
* <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>
|
|
92
80
|
*
|
|
93
81
|
* @throws {@link ServerException} (server fault)
|
|
94
82
|
* <p>These errors are usually caused by a server issue.</p>
|
|
95
83
|
*
|
|
96
84
|
* @throws {@link TargetNotConnectedException} (client fault)
|
|
97
|
-
* <p>The execute command cannot run. This error can be caused by any of the following
|
|
98
|
-
* configuration issues:</p>
|
|
99
|
-
* <ul>
|
|
100
|
-
* <li>
|
|
101
|
-
* <p>Incorrect IAM permissions</p>
|
|
102
|
-
* </li>
|
|
103
|
-
* <li>
|
|
104
|
-
* <p>The SSM agent is not installed or is not running</p>
|
|
105
|
-
* </li>
|
|
106
|
-
* <li>
|
|
107
|
-
* <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not
|
|
108
|
-
* one for Systems Manager Session Manager</p>
|
|
109
|
-
* </li>
|
|
110
|
-
* </ul>
|
|
111
|
-
* <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS
|
|
112
|
-
* Exec</a> in the <i>Amazon Elastic Container Service Developer
|
|
113
|
-
* Guide</i>.</p>
|
|
85
|
+
* <p>The execute command cannot run. This error can be caused by any of the following configuration issues:</p> <ul> <li> <p>Incorrect IAM permissions</p> </li> <li> <p>The SSM agent is not installed or is not running</p> </li> <li> <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager</p> </li> </ul> <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS Exec</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
114
86
|
*
|
|
115
87
|
* @throws {@link ECSServiceException}
|
|
116
88
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|