AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
Attribute | The attributes applicable to a container instance when it is registered. | |
ClientException | ECS exception | |
Cluster | 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. | |
ClusterContainsContainerInstancesException | ECS exception | |
ClusterContainsServicesException | ECS exception | |
ClusterNotFoundException | ECS exception | |
Container | A Docker container that is part of a task. | |
ContainerDefinition | Container definitions are used in task definitions to describe the different containers that are launched as part of a task. | |
ContainerInstance | An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster. | |
ContainerOverride | The overrides that should be sent to a container. | |
CreateClusterRequest |
Container for the parameters to the CreateCluster operation.
Creates a new Amazon ECS cluster. By default, your account receives 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.
|
|
CreateClusterResponse | Configuration for accessing Amazon CreateCluster service | |
CreateClusterResult | ||
CreateServiceRequest |
Container for the parameters to the CreateService operation.
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 spawns another instantiation of the task in the specified cluster. To update an
existing service, see UpdateService.
You can optionally specify a deployment configuration for your service. During a deployment
(which is triggered by changing the task definition of a service with an UpdateService
operation), the service scheduler uses the
If the
The When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
|
|
CreateServiceResponse | Configuration for accessing Amazon CreateService service | |
CreateServiceResult | ||
DeleteClusterRequest | Container for the parameters to the DeleteCluster operation. 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. | |
DeleteClusterResponse | Configuration for accessing Amazon DeleteCluster service | |
DeleteClusterResult | ||
DeleteServiceRequest |
Container for the parameters to the DeleteService operation.
Deletes 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 is actively
maintaining tasks, you cannot delete it, and you must update the service to a desired
task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup,
the service status moves from |
|
DeleteServiceResponse | Configuration for accessing Amazon DeleteService service | |
DeleteServiceResult | ||
Deployment | The details of an Amazon ECS service deployment. | |
DeploymentConfiguration | Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. | |
DeregisterContainerInstanceRequest |
Container for the parameters to the DeregisterContainerInstance operation.
Deregisters 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 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. |
|
DeregisterContainerInstanceResponse | Configuration for accessing Amazon DeregisterContainerInstance service | |
DeregisterContainerInstanceResult | ||
DeregisterTaskDefinitionRequest |
Container for the parameters to the DeregisterTaskDefinition operation.
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 |
|
DeregisterTaskDefinitionResponse | Configuration for accessing Amazon DeregisterTaskDefinition service | |
DeregisterTaskDefinitionResult | ||
DescribeClustersRequest | Container for the parameters to the DescribeClusters operation. Describes one or more of your clusters. | |
DescribeClustersResponse | Configuration for accessing Amazon DescribeClusters service | |
DescribeClustersResult | ||
DescribeContainerInstancesRequest | Container for the parameters to the DescribeContainerInstances operation. Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. | |
DescribeContainerInstancesResponse | Configuration for accessing Amazon DescribeContainerInstances service | |
DescribeContainerInstancesResult | ||
DescribeServicesRequest | Container for the parameters to the DescribeServices operation. Describes the specified services running in your cluster. | |
DescribeServicesResponse | Configuration for accessing Amazon DescribeServices service | |
DescribeServicesResult | ||
DescribeTaskDefinitionRequest |
Container for the parameters to the DescribeTaskDefinition operation.
Describes 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 to find the latest ACTIVE revision in that family.
You can only describe |
|
DescribeTaskDefinitionResponse | Configuration for accessing Amazon DescribeTaskDefinition service | |
DescribeTaskDefinitionResult | ||
DescribeTasksRequest | Container for the parameters to the DescribeTasks operation. Describes a specified task or tasks. | |
DescribeTasksResponse | Configuration for accessing Amazon DescribeTasks service | |
DescribeTasksResult | ||
Failure | A failed resource. | |
HostEntry |
Hostnames and IP address entries that are added to the /etc/hosts file
of a container via the extraHosts parameter of its ContainerDefinition.
|
|
HostVolumeProperties | Details on a container instance host volume. | |
InvalidParameterException | ECS exception | |
KeyValuePair | A key and value pair object. | |
ListClustersRequest | Container for the parameters to the ListClusters operation. Returns a list of existing clusters. | |
ListClustersResponse | Configuration for accessing Amazon ListClusters service | |
ListClustersResult | ||
ListContainerInstancesRequest | Container for the parameters to the ListContainerInstances operation. Returns a list of container instances in a specified cluster. | |
ListContainerInstancesResponse | Configuration for accessing Amazon ListContainerInstances service | |
ListContainerInstancesResult | ||
ListServicesRequest | Container for the parameters to the ListServices operation. Lists the services that are running in a specified cluster. | |
ListServicesResponse | Configuration for accessing Amazon ListServices service | |
ListServicesResult | ||
ListTaskDefinitionFamiliesRequest |
Container for the parameters to the ListTaskDefinitionFamilies operation.
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.
|
|
ListTaskDefinitionFamiliesResponse | Configuration for accessing Amazon ListTaskDefinitionFamilies service | |
ListTaskDefinitionFamiliesResult | ||
ListTaskDefinitionsRequest |
Container for the parameters to the ListTaskDefinitions operation.
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.
|
|
ListTaskDefinitionsResponse | Configuration for accessing Amazon ListTaskDefinitions service | |
ListTaskDefinitionsResult | ||
ListTasksRequest |
Container for the parameters to the ListTasks operation.
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.
|
|
ListTasksResponse | Configuration for accessing Amazon ListTasks service | |
ListTasksResult | ||
LoadBalancer | Details on a load balancer that is used with a service. | |
LogConfiguration | Log configuration options to send to a custom log driver for the container. | |
MissingVersionException | ECS exception | |
MountPoint | Details on a volume mount point that is used in a container definition. | |
NetworkBinding |
Details on the network bindings between a container and its host container instance.
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the networkBindings section
of DescribeTasks API responses.
|
|
NoUpdateAvailableException | ECS exception | |
PortMapping |
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.
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the networkBindings section
of DescribeTasks API responses.
|
|
RegisterTaskDefinitionRequest |
Container for the parameters to the RegisterTaskDefinition operation.
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 about task definition parameters and defaults, see
Amazon
ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
|
|
RegisterTaskDefinitionResponse | Configuration for accessing Amazon RegisterTaskDefinition service | |
RegisterTaskDefinitionResult | ||
Resource | Describes the resources available for a container instance. | |
RunTaskRequest |
Container for the parameters to the RunTask operation.
Start a task using random placement and the default Amazon ECS scheduler. To use your
own scheduler or place a task on a specific container instance, use StartTask
instead.
The |
|
RunTaskResponse | Configuration for accessing Amazon RunTask service | |
RunTaskResult | ||
ServerException | ECS exception | |
Service | Details on a service within a cluster | |
ServiceEvent | Details on an event associated with a service. | |
ServiceNotActiveException | ECS exception | |
ServiceNotFoundException | ECS exception | |
StartTaskRequest |
Container for the parameters to the StartTask operation.
Starts a new task from the specified task definition on the specified container instance
or instances. 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. |
|
StartTaskResponse | Configuration for accessing Amazon StartTask service | |
StartTaskResult | ||
StopTaskRequest |
Container for the parameters to the StopTask operation.
Stops a running task.
When StopTask is called on a task, the equivalent of |
|
StopTaskResponse | Configuration for accessing Amazon StopTask service | |
StopTaskResult | ||
Task | Details on a task in a cluster. | |
TaskDefinition | Details of a task definition. | |
TaskOverride | The overrides associated with a task. | |
Ulimit |
The ulimit settings to pass to the container.
|
|
UpdateContainerAgentRequest |
Container for the parameters to the UpdateContainerAgent operation.
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.
|
|
UpdateContainerAgentResponse | Configuration for accessing Amazon UpdateContainerAgent service | |
UpdateContainerAgentResult | ||
UpdateInProgressException | ECS exception | |
UpdateServiceRequest |
Container for the parameters to the UpdateService operation.
Modifies the desired count, deployment configuration, 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 You can use UpdateService to modify your task definition and deploy a new version of your service.
You can also update the deployment configuration of a service. When a deployment is
triggered by updating the task definition of a service, the service scheduler uses
the deployment configuration parameters,
If the
The When UpdateService stops a task during a deployment, the equivalent of docker stopis issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout, after which SIGKILL is sent and the containers
are forcibly stopped. If the container handles the SIGTERM gracefully
and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
|
|
UpdateServiceResponse | Configuration for accessing Amazon UpdateService service | |
UpdateServiceResult | ||
VersionInfo | The Docker and Amazon ECS container agent version information about a container instance. | |
Volume | A data volume used in a task definition. | |
VolumeFrom | Details on a data volume from another container. |