Amazon Elastic 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. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
Amazon ECS lets you launch and stop container-based 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.
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 ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
An object representing a container instance or task attachment.
An object representing a change in state for a task attachment.
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
An object representing the networking details for a task or service.
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
A Docker container that is part of a task.
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
The overrides that should be sent to a container.
An object representing a change in state for a container.
The details of an Amazon ECS service deployment. This is used when a service uses the
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
An object representing a container instance host device.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the
A client for the Amazon ECS API.
A failed resource.
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
The following are notes about container health check support:
Hostnames and IP address entries that are added to the
Details on a container instance bind mount host volume.
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
A key-value pair object.
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
Details on a load balancer that is used with a service.
If the service is using the
If the service is using the
Services with tasks that use the
Log configuration options to send to a custom log driver for the container.
Details on a volume mount point that is used in a container definition.
Details on the network bindings between a container and its host container instance. After a task reaches the
An object representing the network configuration for a task or service.
An object representing the elastic network interface for tasks that use the
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
The devices that are available on the container instance. The only supported device type is a GPU.
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you are using containers in a task with the
After a task reaches the
The repository credentials for private registry authentication.
Describes the resources available for a container instance.
The type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS in the Amazon Elastic Container Service Developer Guide
A floating-point percentage of the desired number of tasks to place and keep running in the service. This is used when a service uses the
An object representing the secret to expose to your container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
Details on a service within a cluster
Details on an event associated with a service.
Details of the service registry.
The current account setting for a resource.
It is not recommended that you specify network-related
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Details on a task in a cluster.
Details of a task definition.
An object representing a constraint on task placement in the task definition.
If you are using the Fargate launch type, task placement constraints are not supported.
For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
The overrides associated with a task.
Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
The container path, mount options, and size of the tmpfs mount.
The Docker and Amazon ECS container agent version information about a container instance.
A data volume used in a task definition. For tasks that use a Docker volume, specify a
Details on a data volume from another container in the same task definition.
Errors returned by CreateCluster
Errors returned by CreateService
Errors returned by DeleteAccountSetting
Errors returned by DeleteAttributes
Errors returned by DeleteCluster
Errors returned by DeleteService
Errors returned by DeregisterContainerInstance
Errors returned by DeregisterTaskDefinition
Errors returned by DescribeClusters
Errors returned by DescribeContainerInstances
Errors returned by DescribeServices
Errors returned by DescribeTaskDefinition
Errors returned by DescribeTasks
Errors returned by DiscoverPollEndpoint
Errors returned by ListAccountSettings
Errors returned by ListAttributes
Errors returned by ListClusters
Errors returned by ListContainerInstances
Errors returned by ListServices
Errors returned by ListTagsForResource
Errors returned by ListTaskDefinitionFamilies
Errors returned by ListTaskDefinitions
Errors returned by ListTasks
Errors returned by PutAccountSettingDefault
Errors returned by PutAccountSetting
Errors returned by PutAttributes
Errors returned by RegisterContainerInstance
Errors returned by RegisterTaskDefinition
Errors returned by RunTask
Errors returned by StartTask
Errors returned by StopTask
Errors returned by SubmitContainerStateChange
Errors returned by SubmitTaskStateChange
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateContainerAgent
Errors returned by UpdateContainerInstancesState
Errors returned by UpdateService
Trait representing the capabilities of the Amazon ECS API. Amazon ECS clients implement this trait.