Amazon EC2 Container Service
Amazon Elastic Container Service Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Elastic Container Service Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage. Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features. You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.
Endpoints 88
Gateway
- POSTAssociate gateway with cluster
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.AssociateGatewayWithClusterAssociates a gateway with an Amazon ECS cluster. After a cluster is associated with a gateway, services in that cluster can use the gateway for ingress. No… - POSTCreate gateway
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateGatewayCreates a gateway. A gateway defines and dynamically manages ingress paths for your Amazon ECS services, handling traffic routing and infrastructure across… - POSTDelete gateway
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteGatewayDeletes a gateway. Before you can delete a gateway, deletion protection must be disabled and the gateway must not have any cluster associations that are in… - POSTDescribe gateway
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeGatewayDescribes a gateway, including its configuration, status, and the type-specific infrastructure settings that it uses. - POSTDescribe gateway resources
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeGatewayResourcesReturns the infrastructure that a gateway has created and manages, so that you can follow the traffic path from top-level shared resources, such as load… - POSTDisassociate gateway from cluster
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DisassociateGatewayFromClusterRemoves the association between a gateway and an Amazon ECS cluster. The association remains in the DISASSOCIATING state until you remove all of the gateway… - POSTList gateway cluster associations
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListGatewayClusterAssociationsReturns a list of the associations between gateways and clusters. You can filter the results by gateway, cluster, and status. The results are paginated. We… - POSTList gateways
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListGatewaysReturns a list of gateways in your account. You can filter the results by gateway name and status. The results are paginated. We recommend that you use… - POSTUpdate gateway
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateGatewayModifies the configuration of a gateway. You can change only the properties that can be applied without interrupting traffic, and the configuration variant…
Capacity provider
- POSTCreate capacity provider
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateCapacityProviderCreates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling.… - POSTDelete capacity provider
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteCapacityProviderDeletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a… - POSTDescribe capacity providers
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeCapacityProvidersDescribes one or more of your capacity providers. - POSTUpdate capacity provider
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateCapacityProviderModifies the parameters for a capacity provider. These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not existing ones.
Cluster
- POSTCreate cluster
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateClusterCreates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create… - POSTDelete cluster
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteClusterDeletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a… - POSTDeregister container instance
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeregisterContainerInstanceDeregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container… - POSTDescribe clusters
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeClustersDescribes one or more of your clusters. For CLI examples, see describe-clusters.rst on GitHub. - POSTExecute command
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ExecuteCommandRuns a command remotely on a container within a task. If you use a condition key in your IAM policy to refine the conditions for the policy statement, for… - POSTList attributes
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListAttributesLists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a… - POSTList clusters
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListClustersReturns a list of existing clusters. - POSTList container instances
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListContainerInstancesReturns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language… - POSTPut cluster capacity providers
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutClusterCapacityProvidersModifies the available capacity providers and the default capacity provider strategy for a cluster. You must specify both the available capacity providers and… - POSTSubmit attachment state changes
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.SubmitAttachmentStateChangesThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that an attachment changed states. - POSTSubmit container state change
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.SubmitContainerStateChangeThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a container changed states. - POSTSubmit task state change
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.SubmitTaskStateChangeThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a task changed states. - POSTUpdate cluster
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateClusterUpdates the cluster. - POSTUpdate cluster settings
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateClusterSettingsModifies the settings to use for a cluster.
Daemon
- POSTCreate daemon
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateDaemonCreates a new daemon in the specified cluster and capacity providers. A daemon deploys cross-cutting software agents such as security monitoring, telemetry,… - POSTDelete daemon
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteDaemonDeletes the specified daemon. The daemon must be in an ACTIVE state to be deleted. Deleting a daemon stops all running daemon tasks on the associated… - POSTDescribe daemon
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeDaemonDescribes the specified daemon. - POSTList daemon deployments
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListDaemonDeploymentsReturns a list of daemon deployments for a specified daemon. You can filter the results by status or creation time. - POSTList daemons
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListDaemonsReturns a list of daemons. You can filter the results by cluster or capacity provider. - POSTUpdate daemon
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateDaemonUpdates the specified daemon. When you update a daemon, a new deployment is triggered that progressively rolls out the changes to the container instances…
Service
- POSTCreate express gateway service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateExpressGatewayServiceCreates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure. This… - POSTCreate service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateServiceRuns and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount ,… - POSTDelete express gateway service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteExpressGatewayServiceDeletes an Express service and removes all associated Amazon Web Services resources. This operation stops service tasks, removes the Application Load… - POSTDelete service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteServiceDeletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service… - POSTDescribe express gateway service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeExpressGatewayServiceRetrieves detailed information about an Express service, including current status, configuration, managed infrastructure, and service revisions. Returns… - POSTDescribe services
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServicesDescribes the specified services running in your cluster. - POSTList service deployments
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListServiceDeploymentsThis operation lists all the service deployments that meet the specified filter criteria. A service deployment happens when you release a software update for… - POSTList services
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListServicesReturns a list of services. You can filter the results by cluster, launch type, and scheduling strategy. - POSTStop service deployment
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.StopServiceDeploymentStops an ongoing service deployment. The following stop types are avaiable: ROLLBACK - This option rolls back the service deployment to the previous service… - POSTUpdate express gateway service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateExpressGatewayServiceUpdates an existing Express service configuration. Modifies container settings, resource allocation, auto-scaling configuration, and other service parameters… - POSTUpdate service
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateServiceModifies the parameters of a service. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task… - POSTUpdate service primary task set
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateServicePrimaryTaskSetModifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the…
Task set
- POSTCreate task set
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateTaskSetCreate a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see… - POSTDelete task set
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteTaskSetDeletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS… - POSTDescribe task sets
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTaskSetsDescribes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information,… - POSTUpdate task set
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateTaskSetModifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the…
Container instance
- POSTDelete attributes
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteAttributesDeletes one or more custom attributes from an Amazon ECS resource. - POSTDescribe container instances
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeContainerInstancesDescribes one or more container instances. Returns metadata about each container instance requested. - POSTList tasks
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTasksReturns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task,… - POSTPut attributes
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutAttributesCreate or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the… - POSTRegister container instance
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RegisterContainerInstanceThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster.… - POSTUpdate container agent
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateContainerAgentUpdates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services… - POSTUpdate container instances state
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateContainerInstancesStateModifies the status of an Amazon ECS container instance. Once a container instance has reached an ACTIVE state, you can change the status of a container…
Daemon task definition
- POSTDelete daemon task definition
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteDaemonTaskDefinitionDeletes the specified daemon task definition. After a daemon task definition is deleted, no new daemons can be created using this definition. Existing daemons… - POSTDescribe daemon task definition
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeDaemonTaskDefinitionDescribes a daemon task definition. You can specify a family and revision to find information about a specific daemon task definition, or you can simply… - POSTList daemon task definitions
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListDaemonTaskDefinitionsReturns a list of daemon task definitions that are registered to your account. You can filter the results by family name, status, or both to find daemon task… - POSTRegister daemon task definition
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RegisterDaemonTaskDefinitionRegisters a new daemon task definition from the supplied family and containerDefinitions . Optionally, you can add data volumes to your containers with the…
Task definition
- POSTDelete task definitions
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteTaskDefinitionsDeletes one or more task definitions. You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition… - POSTList task definitions
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTaskDefinitionsReturns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status… - POSTRegister task definition
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RegisterTaskDefinitionRegisters a new task definition from the supplied family and containerDefinitions . Optionally, you can add data volumes to your containers with the volumes…
Daemon deployment
- POSTDescribe daemon deployments
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeDaemonDeploymentsDescribes one or more of your daemon deployments. A daemon deployment orchestrates the progressive rollout of daemon task updates across container instances…
Daemon revision
- POSTDescribe daemon revisions
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeDaemonRevisionsDescribes one or more of your daemon revisions. A daemon revision is a snapshot of a daemon's configuration at the time a deployment was initiated. It…
Gateway route
- POSTDescribe gateway route
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeGatewayRouteDescribes a gateway route, including its status, the service it routes traffic to, and the service-specific infrastructure, such as target groups and listener… - POSTList gateway routes
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListGatewayRoutesReturns a list of gateway routes. A gateway route represents the association between a service and a gateway and the service-specific infrastructure the…
Service deployment
- POSTDescribe service deployments
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServiceDeploymentsDescribes one or more of your service deployments. A service deployment happens when you release a software update for the service. For more information, see…
Service revision
- POSTDescribe service revisions
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServiceRevisionsDescribes one or more service revisions. A service revision is a version of the service that includes the values for the Amazon ECS resources (for example,…
Task
- POSTDescribe tasks
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTasksDescribes a specified task or tasks. Currently, stopped tasks appear in the returned results for at least one hour. If you have tasks with tags, and then… - POSTGet task protection
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.GetTaskProtectionRetrieves the protection status of tasks in an Amazon ECS service. - POSTRun task
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RunTaskStarts a new task using the specified task definition. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When… - POSTStart task
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.StartTaskStarts a new task from the specified task definition on the specified container instance or instances. On March 21, 2024, a change was made to resolve the… - POSTStop task
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.StopTaskStops a running task. Any tags associated with the task will be deleted. When you call StopTask on a task, the equivalent of docker stop is issued to the… - POSTUpdate task protection
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateTaskProtectionUpdates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service…
- POSTContinue service deployment
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ContinueServiceDeploymentContinues or rolls back an Amazon ECS service deployment that is paused at a lifecycle hook. When a service deployment reaches a lifecycle stage that has a… - POSTDelete account setting
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteAccountSettingDisables an account setting for a specified user, role, or the root user for an account. - POSTDeregister task definition
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeregisterTaskDefinitionDeregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE . Existing tasks and services… - POSTDescribe task definition
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTaskDefinitionDescribes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family… - POSTDiscover poll endpoint
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DiscoverPollEndpointThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Returns an endpoint for the Amazon ECS agent to poll… - POSTList account settings
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListAccountSettingsLists the account settings for a specified principal. - POSTList services by namespace
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListServicesByNamespaceThis operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast,… - POSTList tags for resource
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTagsForResourceList the tags for an Amazon ECS resource. - POSTList task definition families
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTaskDefinitionFamiliesReturns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE… - POSTPut account setting
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutAccountSettingModifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for… - POSTPut account setting default
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutAccountSettingDefaultModifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region… - POSTTag resource
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.TagResourceAssociates the specified tags to a resource with the specified resourceArn . If existing tags on a resource aren't specified in the request parameters, they… - POSTUntag resource
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UntagResourceDeletes specified tags from a resource.
API details
- Base URL
https://ecs.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 88 operations on 88 pathsPOST 88
- Main resources
- Cluster 14Service 12Gateway 9Container instance 7Daemon 6Task 6Capacity provider 4Daemon task definition 4Task set 4Task definition 3
- Description format
- AWS Smithy model, API version
2014-11-13 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon EC2 Container Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon EC2 Container Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate gateway with cluster” (POST /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.AssociateGatewayWithCluster), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon EC2 Container Service?
Amazon Elastic Container Service Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to… It is listed under Developer tools and has 88 endpoints.
Who publishes the Amazon EC2 Container Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon EC2 Container Service?
Requests go to https://ecs.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon EC2 Container Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon EC2 Container Service have?
88 operations on 88 paths (88 POST). The largest groups are Cluster, Service, Gateway, Container instance.
Is forking the Amazon EC2 Container Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.