Skip to content

Commit fabb029

Browse files
author
AWS
committed
Amazon EC2 Container Service Update: Documentation only release for Amazon ECS
1 parent 459729d commit fabb029

File tree

2 files changed

+36
-56
lines changed

2 files changed

+36
-56
lines changed

‎.changes/next-release/feature-AmazonEC2ContainerService-4dff711.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon EC2 Container Service",
4+
"contributor": "",
5+
"description": "Documentation only release for Amazon ECS"
6+
}

‎services/ecs/src/main/resources/codegen-resources/service-2.json

Lines changed: 30 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@
731731
{"shape":"BlockedException"},
732732
{"shape":"ConflictException"}
733733
],
734-
"documentation":"<p>Starts a new task using the specified task definition.</p> <note> <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> </note> <note> <p>Amazon Elastic Inference (EI) is no longer available to customers.</p> </note> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place tasks manually on specific container instances.</p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types\">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul>"
734+
"documentation":"<p>Starts a new task using the specified task definition.</p> <note> <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> </note> <note> <p>Amazon Elastic Inference (EI) is no longer available to customers.</p> </note> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place tasks manually on specific container instances.</p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types\">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul> <p>If you get a <code>ConflictException</code> error, the <code>RunTask</code> request could not be processed due to conflicts. The provided <code>clientToken</code> is already in use with a different <code>RunTask</code> request. The <code>resourceIds</code> are the existing task ARNs which are already associated with the <code>clientToken</code>. </p> <p>To fix this issue:</p> <ul> <li> <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p> </li> <li> <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original set of parameters</p> </li> </ul>"
735735
},
736736
"StartTask":{
737737
"name":"StartTask",
@@ -767,7 +767,7 @@
767767
{"shape":"ServiceDeploymentNotFoundException"},
768768
{"shape":"UnsupportedFeatureException"}
769769
],
770-
"documentation":"<p>Stops an ongoing service deployment.</p> <p>The following stop types are avaiable:</p> <ul> <li> <p>ROLLBACK - This option rolls back the service deployment to the previous service revision. </p> <p>You can use this option even if you didn't configure the service deployment for the rollback option. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stop-service-deployment.html\">Stopping Amazon ECS service deployments</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
770+
"documentation":"<p>Stops an ongoing service deployment.</p> <note> <p>StopServiceDeployment isn't currently supported.</p> </note>"
771771
},
772772
"StopTask":{
773773
"name":"StopTask",
@@ -1037,8 +1037,7 @@
10371037
"shapes":{
10381038
"AccessDeniedException":{
10391039
"type":"structure",
1040-
"members":{
1041-
},
1040+
"members":{},
10421041
"documentation":"<p>You don't have authorization to perform the requested action.</p>",
10431042
"exception":true
10441043
},
@@ -1145,8 +1144,7 @@
11451144
},
11461145
"AttributeLimitExceededException":{
11471146
"type":"structure",
1148-
"members":{
1149-
},
1147+
"members":{},
11501148
"documentation":"<p>You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListAttributes.html\">ListAttributes</a>. You can remove existing attributes on a resource with <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html\">DeleteAttributes</a>.</p>",
11511149
"exception":true
11521150
},
@@ -1223,8 +1221,7 @@
12231221
},
12241222
"BlockedException":{
12251223
"type":"structure",
1226-
"members":{
1227-
},
1224+
"members":{},
12281225
"documentation":"<p>Your Amazon Web Services account was blocked. For more information, contact <a href=\"http://aws.amazon.com/contact-us/\"> Amazon Web ServicesSupport</a>.</p>",
12291226
"exception":true
12301227
},
@@ -1438,22 +1435,19 @@
14381435
},
14391436
"ClusterContainsContainerInstancesException":{
14401437
"type":"structure",
1441-
"members":{
1442-
},
1438+
"members":{},
14431439
"documentation":"<p>You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html\">DeregisterContainerInstance</a>.</p>",
14441440
"exception":true
14451441
},
14461442
"ClusterContainsServicesException":{
14471443
"type":"structure",
1448-
"members":{
1449-
},
1444+
"members":{},
14501445
"documentation":"<p>You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html\">UpdateService</a> and <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html\">DeleteService</a>.</p>",
14511446
"exception":true
14521447
},
14531448
"ClusterContainsTasksException":{
14541449
"type":"structure",
1455-
"members":{
1456-
},
1450+
"members":{},
14571451
"documentation":"<p>You can't delete a cluster that has active tasks.</p>",
14581452
"exception":true
14591453
},
@@ -1473,8 +1467,7 @@
14731467
},
14741468
"ClusterNotFoundException":{
14751469
"type":"structure",
1476-
"members":{
1477-
},
1470+
"members":{},
14781471
"documentation":"<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>",
14791472
"exception":true
14801473
},
@@ -1545,7 +1538,7 @@
15451538
"documentation":"<p>The existing task ARNs which are already associated with the <code>clientToken</code>.</p>"
15461539
}
15471540
},
1548-
"documentation":"<p>The <code>RunTask</code> request could not be processed due to conflicts. The provided <code>clientToken</code> is already in use with a different <code>RunTask</code> request. The <code>resourceIds</code> are the existing task ARNs which are already associated with the <code>clientToken</code>. </p> <p>To fix this issue:</p> <ul> <li> <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p> </li> <li> <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original set of parameters</p> </li> </ul>",
1541+
"documentation":"<p>The request could not be processed because of conflict in the current state of the resource. </p>",
15491542
"exception":true
15501543
},
15511544
"Connectivity":{
@@ -3656,8 +3649,7 @@
36563649
},
36573650
"InvalidParameterException":{
36583651
"type":"structure",
3659-
"members":{
3660-
},
3652+
"members":{},
36613653
"documentation":"<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>",
36623654
"exception":true
36633655
},
@@ -3707,8 +3699,7 @@
37073699
},
37083700
"LimitExceededException":{
37093701
"type":"structure",
3710-
"members":{
3711-
},
3702+
"members":{},
37123703
"documentation":"<p>The limit for the resource was exceeded.</p>",
37133704
"exception":true
37143705
},
@@ -4355,8 +4346,7 @@
43554346
},
43564347
"MissingVersionException":{
43574348
"type":"structure",
4358-
"members":{
4359-
},
4349+
"members":{},
43604350
"documentation":"<p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.</p>",
43614351
"exception":true
43624352
},
@@ -4384,8 +4374,7 @@
43844374
},
43854375
"NamespaceNotFoundException":{
43864376
"type":"structure",
4387-
"members":{
4388-
},
4377+
"members":{},
43894378
"documentation":"<p>The specified namespace wasn't found.</p>",
43904379
"exception":true
43914380
},
@@ -4466,8 +4455,7 @@
44664455
},
44674456
"NoUpdateAvailableException":{
44684457
"type":"structure",
4469-
"members":{
4470-
},
4458+
"members":{},
44714459
"documentation":"<p>There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.</p>",
44724460
"exception":true
44734461
},
@@ -4570,15 +4558,13 @@
45704558
},
45714559
"PlatformTaskDefinitionIncompatibilityException":{
45724560
"type":"structure",
4573-
"members":{
4574-
},
4561+
"members":{},
45754562
"documentation":"<p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>",
45764563
"exception":true
45774564
},
45784565
"PlatformUnknownException":{
45794566
"type":"structure",
4580-
"members":{
4581-
},
4567+
"members":{},
45824568
"documentation":"<p>The specified platform version doesn't exist.</p>",
45834569
"exception":true
45844570
},
@@ -4984,15 +4970,13 @@
49844970
},
49854971
"ResourceInUseException":{
49864972
"type":"structure",
4987-
"members":{
4988-
},
4973+
"members":{},
49894974
"documentation":"<p>The specified resource is in-use and can't be removed.</p>",
49904975
"exception":true
49914976
},
49924977
"ResourceNotFoundException":{
49934978
"type":"structure",
4994-
"members":{
4995-
},
4979+
"members":{},
49964980
"documentation":"<p>The specified resource wasn't found.</p>",
49974981
"exception":true
49984982
},
@@ -5629,8 +5613,7 @@
56295613
},
56305614
"ServiceDeploymentNotFoundException":{
56315615
"type":"structure",
5632-
"members":{
5633-
},
5616+
"members":{},
56345617
"documentation":"<p>The service deploy ARN that you specified in the <code>StopServiceDeployment</code> doesn't exist. You can use <code>ListServiceDeployments</code> to retrieve the service deployment ARNs.</p>",
56355618
"exception":true
56365619
},
@@ -5748,15 +5731,13 @@
57485731
},
57495732
"ServiceNotActiveException":{
57505733
"type":"structure",
5751-
"members":{
5752-
},
5734+
"members":{},
57535735
"documentation":"<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>",
57545736
"exception":true
57555737
},
57565738
"ServiceNotFoundException":{
57575739
"type":"structure",
5758-
"members":{
5759-
},
5740+
"members":{},
57605741
"documentation":"<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>",
57615742
"exception":true
57625743
},
@@ -6076,7 +6057,7 @@
60766057
},
60776058
"stopType":{
60786059
"shape":"StopServiceDeploymentStopType",
6079-
"documentation":"<p>How you want Amazon ECS to stop the task. </p> <p>The valid values are <code>ROLLBACK</code>.</p>"
6060+
"documentation":"<p>How you want Amazon ECS to stop the service. </p> <p>The ROLLBACK and ABORT stopType aren't supported.</p>"
60806061
}
60816062
}
60826063
},
@@ -6317,8 +6298,7 @@
63176298
},
63186299
"TagResourceResponse":{
63196300
"type":"structure",
6320-
"members":{
6321-
}
6301+
"members":{}
63226302
},
63236303
"TagValue":{
63246304
"type":"string",
@@ -6334,15 +6314,13 @@
63346314
},
63356315
"TargetNotConnectedException":{
63366316
"type":"structure",
6337-
"members":{
6338-
},
6317+
"members":{},
63396318
"documentation":"<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>",
63406319
"exception":true
63416320
},
63426321
"TargetNotFoundException":{
63436322
"type":"structure",
6344-
"members":{
6345-
},
6323+
"members":{},
63466324
"documentation":"<p>The specified target wasn't found. You can view your available container instances with <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html\">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and Region-specific.</p>",
63476325
"exception":true
63486326
},
@@ -6903,8 +6881,7 @@
69036881
},
69046882
"TaskSetNotFoundException":{
69056883
"type":"structure",
6906-
"members":{
6907-
},
6884+
"members":{},
69086885
"documentation":"<p>The specified task set wasn't found. You can view your available task sets with <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html\">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p>",
69096886
"exception":true
69106887
},
@@ -7043,8 +7020,7 @@
70437020
},
70447021
"UnsupportedFeatureException":{
70457022
"type":"structure",
7046-
"members":{
7047-
},
7023+
"members":{},
70487024
"documentation":"<p>The specified task isn't supported in this Region.</p>",
70497025
"exception":true
70507026
},
@@ -7067,8 +7043,7 @@
70677043
},
70687044
"UntagResourceResponse":{
70697045
"type":"structure",
7070-
"members":{
7071-
}
7046+
"members":{}
70727047
},
70737048
"UpdateCapacityProviderRequest":{
70747049
"type":"structure",
@@ -7212,8 +7187,7 @@
72127187
},
72137188
"UpdateInProgressException":{
72147189
"type":"structure",
7215-
"members":{
7216-
},
7190+
"members":{},
72177191
"documentation":"<p>There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>",
72187192
"exception":true
72197193
},

0 commit comments

Comments
 (0)