Amazon ECS API Reference for KECS
Reference skill for implementing ECS-compatible APIs in KECS.
Overview
This skill provides detailed specifications for the following ECS API categories:
- Cluster API - Cluster management (
cluster-api.md)
- Service API - Service management (
service-api.md)
- Task API - Task execution and management (
task-api.md)
- Task Definition API - Task definition management (
task-definition-api.md)
- Other APIs - Tags, TaskSets, Attributes, Account Settings, etc. (
other-apis.md)
Use Cases
- Implementing new ECS API endpoints
- Verifying request/response structures of existing APIs
- Aligning error codes and behaviors with AWS ECS
- Writing API compatibility tests
Common API Specifications
HTTP Request Format
POST / HTTP/1.1
Host: ecs.{region}.amazonaws.com
Content-Type: application/x-amz-json-1.1
X-Amz-Target: AmazonEC2ContainerServiceV20141113.{ActionName}
Common Error Codes
| Error |
HTTP |
Description |
| ClientException |
400 |
Client-side error (insufficient permissions, invalid ID, etc.) |
| InvalidParameterException |
400 |
Invalid parameter |
| ServerException |
500 |
Server error |
| ClusterNotFoundException |
400 |
Cluster not found |
| ServiceNotFoundException |
400 |
Service not found |
Tag Limits
- Maximum 50 tags per resource
- Key length: Maximum 128 characters (UTF-8)
- Value length: Maximum 256 characters (UTF-8)
aws: prefix is reserved (cannot edit or delete)
Pagination
- maxResults: 1-100 (default 10 or 100 depending on API)
- nextToken: Opaque continuation token
ARN Format
arn:aws:ecs:{region}:{account}:{resource-type}/{resource-id}
Resource types: cluster, service, task, task-definition, container-instance, capacity-provider, task-set
Detailed Specifications
Refer to the following support files for detailed API specifications:
cluster-api.md - CreateCluster, DescribeClusters, ListClusters, DeleteCluster, UpdateClusterservice-api.md - CreateService, DescribeServices, UpdateService, DeleteService, ListServicestask-api.md - RunTask, StopTask, DescribeTasks, ListTasks, ExecuteCommandtask-definition-api.md - RegisterTaskDefinition, DeregisterTaskDefinition, DescribeTaskDefinition, ListTaskDefinitionsother-apis.md - TagResource, ListTagsForResource, CreateTaskSet, PutAttributes, PutAccountSetting, etc.
