AWS.ECS
Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of Amazon EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
Summary↑
| create_cluster(client, input, options \\ []) | Creates a new Amazon ECS cluster. By default, your account will receive a |
| create_service(client, input, options \\ []) | Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below |
| delete_cluster(client, input, options \\ []) | Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with |
| delete_service(client, input, options \\ []) | Deletes a specified service within a cluster |
| deregister_container_instance(client, input, options \\ []) | Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks |
| deregister_task_definition(client, input, options \\ []) | Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as |
| describe_clusters(client, input, options \\ []) | Describes one or more of your clusters |
| describe_container_instances(client, input, options \\ []) | Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested |
| describe_services(client, input, options \\ []) | Describes the specified services running in your cluster |
| describe_task_definition(client, input, options \\ []) | Describes a task definition. You can specify a |
| describe_tasks(client, input, options \\ []) | Describes a specified task or tasks |
| discover_poll_endpoint(client, input, options \\ []) | This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent |
| list_clusters(client, input, options \\ []) | Returns a list of existing clusters |
| list_container_instances(client, input, options \\ []) | Returns a list of container instances in a specified cluster |
| list_services(client, input, options \\ []) | Lists the services that are running in a specified cluster |
| list_task_definition_families(client, input, options \\ []) | Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any |
| list_task_definitions(client, input, options \\ []) | Returns a list of task definitions that are registered to your account. You can filter the results by family name with the |
| list_tasks(client, input, options \\ []) | Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the |
| register_container_instance(client, input, options \\ []) | This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent |
| register_task_definition(client, input, options \\ []) | Registers a new task definition from the supplied |
| run_task(client, input, options \\ []) | Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use |
| start_task(client, input, options \\ []) | Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use |
| stop_task(client, input, options \\ []) | Stops a running task |
| submit_container_state_change(client, input, options \\ []) | This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent |
| submit_task_state_change(client, input, options \\ []) | This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent |
| update_container_agent(client, input, options \\ []) | Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system |
| update_service(client, input, options \\ []) | Modify the desired count or task definition used in a service |
Functions
Creates a new Amazon ECS cluster. By default, your account will receive a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS will spawn another instantiation of the task in the specified cluster.
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
Deletes a specified service within a cluster.
Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
When you terminate a container instance, it is automatically deregistered from your cluster.
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).
Describes one or more of your clusters.
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Describes the specified services running in your cluster.
Describes a task definition. You can specify a family and revision to find information on a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or service references them.
Describes a specified task or tasks.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
Returns a list of existing clusters.
Returns a list of container instances in a specified cluster.
Lists the services that are running in a specified cluster.
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definitions). You can filter the results with the familyPrefix parameter.
Returns 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 with the status parameter.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.
Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.
The count parameter is limited to 10 tasks per call.
Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.
The list of container instances to start tasks on is limited to 10.
Stops a running task.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
Modify the desired count or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.