Skip to content

Commit 784d37c

Browse files
author
awstools
committed
docs(client-ecs): This is a documentation only update for Amazon ECS to address various tickets.
1 parent e04cd1f commit 784d37c

File tree

59 files changed

+66
-15
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+66
-15
lines changed

‎clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
118118
* @throws {@link InvalidParameterException} (client fault)
119119
* <p>The specified parameter isn't valid. Review the available parameters for the API
120120
* request.</p>
121+
* <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>
121122
*
122123
* @throws {@link LimitExceededException} (client fault)
123124
* <p>The limit for the resource was exceeded.</p>

‎clients/client-ecs/src/commands/CreateClusterCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
192192
* @throws {@link InvalidParameterException} (client fault)
193193
* <p>The specified parameter isn't valid. Review the available parameters for the API
194194
* request.</p>
195+
* <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>
195196
*
196197
* @throws {@link NamespaceNotFoundException} (client fault)
197198
* <p>The specified namespace wasn't found.</p>

‎clients/client-ecs/src/commands/CreateServiceCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -598,6 +598,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
598598
* @throws {@link InvalidParameterException} (client fault)
599599
* <p>The specified parameter isn't valid. Review the available parameters for the API
600600
* request.</p>
601+
* <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>
601602
*
602603
* @throws {@link NamespaceNotFoundException} (client fault)
603604
* <p>The specified namespace wasn't found.</p>

‎clients/client-ecs/src/commands/CreateTaskSetCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
200200
* @throws {@link InvalidParameterException} (client fault)
201201
* <p>The specified parameter isn't valid. Review the available parameters for the API
202202
* request.</p>
203+
* <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>
203204
*
204205
* @throws {@link NamespaceNotFoundException} (client fault)
205206
* <p>The specified namespace wasn't found.</p>

‎clients/client-ecs/src/commands/DeleteAccountSettingCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingR
7777
* @throws {@link InvalidParameterException} (client fault)
7878
* <p>The specified parameter isn't valid. Review the available parameters for the API
7979
* request.</p>
80+
* <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>
8081
*
8182
* @throws {@link ServerException} (server fault)
8283
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeleteAttributesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ export interface DeleteAttributesCommandOutput extends DeleteAttributesResponse,
7373
* @throws {@link InvalidParameterException} (client fault)
7474
* <p>The specified parameter isn't valid. Review the available parameters for the API
7575
* request.</p>
76+
* <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>
7677
*
7778
* @throws {@link TargetNotFoundException} (client fault)
7879
* <p>The specified target wasn't found. You can view your available container instances

‎clients/client-ecs/src/commands/DeleteCapacityProviderCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi
107107
* @throws {@link InvalidParameterException} (client fault)
108108
* <p>The specified parameter isn't valid. Review the available parameters for the API
109109
* request.</p>
110+
* <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>
110111
*
111112
* @throws {@link ServerException} (server fault)
112113
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeleteClusterCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
162162
* @throws {@link InvalidParameterException} (client fault)
163163
* <p>The specified parameter isn't valid. Review the available parameters for the API
164164
* request.</p>
165+
* <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>
165166
*
166167
* @throws {@link ServerException} (server fault)
167168
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeleteServiceCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
373373
* @throws {@link InvalidParameterException} (client fault)
374374
* <p>The specified parameter isn't valid. Review the available parameters for the API
375375
* request.</p>
376+
* <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>
376377
*
377378
* @throws {@link ServerException} (server fault)
378379
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeleteTaskDefinitionsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,7 @@ export interface DeleteTaskDefinitionsCommandOutput extends DeleteTaskDefinition
374374
* @throws {@link InvalidParameterException} (client fault)
375375
* <p>The specified parameter isn't valid. Review the available parameters for the API
376376
* request.</p>
377+
* <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>
377378
*
378379
* @throws {@link ServerException} (server fault)
379380
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeleteTaskSetCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
146146
* @throws {@link InvalidParameterException} (client fault)
147147
* <p>The specified parameter isn't valid. Review the available parameters for the API
148148
* request.</p>
149+
* <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>
149150
*
150151
* @throws {@link ServerException} (server fault)
151152
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ export interface DeregisterContainerInstanceCommandOutput
169169
* @throws {@link InvalidParameterException} (client fault)
170170
* <p>The specified parameter isn't valid. Review the available parameters for the API
171171
* request.</p>
172+
* <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>
172173
*
173174
* @throws {@link ServerException} (server fault)
174175
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,7 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef
358358
* @throws {@link InvalidParameterException} (client fault)
359359
* <p>The specified parameter isn't valid. Review the available parameters for the API
360360
* request.</p>
361+
* <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>
361362
*
362363
* @throws {@link ServerException} (server fault)
363364
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity
111111
* @throws {@link InvalidParameterException} (client fault)
112112
* <p>The specified parameter isn't valid. Review the available parameters for the API
113113
* request.</p>
114+
* <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>
114115
*
115116
* @throws {@link ServerException} (server fault)
116117
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeClustersCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
155155
* @throws {@link InvalidParameterException} (client fault)
156156
* <p>The specified parameter isn't valid. Review the available parameters for the API
157157
* request.</p>
158+
* <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>
158159
*
159160
* @throws {@link ServerException} (server fault)
160161
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
168168
* @throws {@link InvalidParameterException} (client fault)
169169
* <p>The specified parameter isn't valid. Review the available parameters for the API
170170
* request.</p>
171+
* <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>
171172
*
172173
* @throws {@link ServerException} (server fault)
173174
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ export interface DescribeServiceDeploymentsCommandOutput extends DescribeService
149149
* @throws {@link InvalidParameterException} (client fault)
150150
* <p>The specified parameter isn't valid. Review the available parameters for the API
151151
* 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 service event messages</a>. </p>
152153
*
153154
* @throws {@link ServerException} (server fault)
154155
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ export interface DescribeServiceRevisionsCommandOutput extends DescribeServiceRe
220220
* @throws {@link InvalidParameterException} (client fault)
221221
* <p>The specified parameter isn't valid. Review the available parameters for the API
222222
* request.</p>
223+
* <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>
223224
*
224225
* @throws {@link ServerException} (server fault)
225226
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeServicesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,7 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse,
366366
* @throws {@link InvalidParameterException} (client fault)
367367
* <p>The specified parameter isn't valid. Review the available parameters for the API
368368
* request.</p>
369+
* <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>
369370
*
370371
* @throws {@link ServerException} (server fault)
371372
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinit
357357
* @throws {@link InvalidParameterException} (client fault)
358358
* <p>The specified parameter isn't valid. Review the available parameters for the API
359359
* request.</p>
360+
* <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>
360361
*
361362
* @throws {@link ServerException} (server fault)
362363
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse,
161161
* @throws {@link InvalidParameterException} (client fault)
162162
* <p>The specified parameter isn't valid. Review the available parameters for the API
163163
* request.</p>
164+
* <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>
164165
*
165166
* @throws {@link ServerException} (server fault)
166167
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/DescribeTasksCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
251251
* @throws {@link InvalidParameterException} (client fault)
252252
* <p>The specified parameter isn't valid. Review the available parameters for the API
253253
* request.</p>
254+
* <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>
254255
*
255256
* @throws {@link ServerException} (server fault)
256257
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ExecuteCommandCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
100100
* @throws {@link InvalidParameterException} (client fault)
101101
* <p>The specified parameter isn't valid. Review the available parameters for the API
102102
* request.</p>
103+
* <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>
103104
*
104105
* @throws {@link ServerException} (server fault)
105106
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/GetTaskProtectionCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons
9292
* @throws {@link InvalidParameterException} (client fault)
9393
* <p>The specified parameter isn't valid. Review the available parameters for the API
9494
* request.</p>
95+
* <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>
9596
*
9697
* @throws {@link ResourceNotFoundException} (client fault)
9798
* <p>The specified resource wasn't found.</p>

‎clients/client-ecs/src/commands/ListAccountSettingsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes
8383
* @throws {@link InvalidParameterException} (client fault)
8484
* <p>The specified parameter isn't valid. Review the available parameters for the API
8585
* request.</p>
86+
* <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>
8687
*
8788
* @throws {@link ServerException} (server fault)
8889
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ListAttributesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ export interface ListAttributesCommandOutput extends ListAttributesResponse, __M
7777
* @throws {@link InvalidParameterException} (client fault)
7878
* <p>The specified parameter isn't valid. Review the available parameters for the API
7979
* request.</p>
80+
* <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>
8081
*
8182
* @throws {@link ECSServiceException}
8283
* <p>Base exception class for all service exceptions from ECS service.</p>

‎clients/client-ecs/src/commands/ListClustersCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad
7474
* @throws {@link InvalidParameterException} (client fault)
7575
* <p>The specified parameter isn't valid. Review the available parameters for the API
7676
* 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 service event messages</a>. </p>
7778
*
7879
* @throws {@link ServerException} (server fault)
7980
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ListContainerInstancesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
8282
* @throws {@link InvalidParameterException} (client fault)
8383
* <p>The specified parameter isn't valid. Review the available parameters for the API
8484
* request.</p>
85+
* <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>
8586
*
8687
* @throws {@link ServerException} (server fault)
8788
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ListServiceDeploymentsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ export interface ListServiceDeploymentsCommandOutput extends ListServiceDeployme
101101
* @throws {@link InvalidParameterException} (client fault)
102102
* <p>The specified parameter isn't valid. Review the available parameters for the API
103103
* request.</p>
104+
* <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>
104105
*
105106
* @throws {@link ServerException} (server fault)
106107
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ListServicesByNamespaceCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ export interface ListServicesByNamespaceCommandOutput extends ListServicesByName
7979
* @throws {@link InvalidParameterException} (client fault)
8080
* <p>The specified parameter isn't valid. Review the available parameters for the API
8181
* request.</p>
82+
* <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>
8283
*
8384
* @throws {@link NamespaceNotFoundException} (client fault)
8485
* <p>The specified namespace wasn't found.</p>

‎clients/client-ecs/src/commands/ListServicesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad
8181
* @throws {@link InvalidParameterException} (client fault)
8282
* <p>The specified parameter isn't valid. Review the available parameters for the API
8383
* request.</p>
84+
* <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>
8485
*
8586
* @throws {@link ServerException} (server fault)
8687
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ListTagsForResourceCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
7878
* @throws {@link InvalidParameterException} (client fault)
7979
* <p>The specified parameter isn't valid. Review the available parameters for the API
8080
* request.</p>
81+
* <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>
8182
*
8283
* @throws {@link ServerException} (server fault)
8384
* <p>These errors are usually caused by a server issue.</p>

‎clients/client-ecs/src/commands/ListTaskDefinitionFamiliesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit
8282
* @throws {@link InvalidParameterException} (client fault)
8383
* <p>The specified parameter isn't valid. Review the available parameters for the API
8484
* request.</p>
85+
* <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>
8586
*
8687
* @throws {@link ServerException} (server fault)
8788
* <p>These errors are usually caused by a server issue.</p>

0 commit comments

Comments
 (0)