aws_ecs
Amazon Elastic Container Service
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.Summary
Functions
-
create_capacity_provider(Client, Input)
Creates a new capacity provider.
- create_capacity_provider(Client, Input, Options)
-
create_cluster(Client, Input)
Creates a new Amazon ECS cluster.
- create_cluster(Client, Input, Options)
-
create_service(Client, Input)
Runs and maintains a desired number of tasks from a specified task definition.
- create_service(Client, Input, Options)
-
create_task_set(Client, Input)
Create a task set in the specified cluster and service.
- create_task_set(Client, Input, Options)
-
delete_account_setting(Client, Input)
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
- delete_account_setting(Client, Input, Options)
-
delete_attributes(Client, Input)
Deletes one or more custom attributes from an Amazon ECS resource.
- delete_attributes(Client, Input, Options)
-
delete_capacity_provider(Client, Input)
Deletes the specified capacity provider.
- delete_capacity_provider(Client, Input, Options)
-
delete_cluster(Client, Input)
Deletes the specified cluster.
- delete_cluster(Client, Input, Options)
-
delete_service(Client, Input)
Deletes a specified service within a cluster.
- delete_service(Client, Input, Options)
-
delete_task_set(Client, Input)
Deletes a specified task set within a service.
- delete_task_set(Client, Input, Options)
-
deregister_container_instance(Client, Input)
Deregisters an Amazon ECS container instance from the specified cluster.
- deregister_container_instance(Client, Input, Options)
-
deregister_task_definition(Client, Input)
Deregisters the specified task definition by family and revision.
- deregister_task_definition(Client, Input, Options)
-
describe_capacity_providers(Client, Input)
Describes one or more of your capacity providers.
- describe_capacity_providers(Client, Input, Options)
-
describe_clusters(Client, Input)
Describes one or more of your clusters.
- describe_clusters(Client, Input, Options)
-
describe_container_instances(Client, Input)
Describes Amazon Elastic Container Service container instances.
- describe_container_instances(Client, Input, Options)
-
describe_services(Client, Input)
Describes the specified services running in your cluster.
- describe_services(Client, Input, Options)
-
describe_task_definition(Client, Input)
Describes a task definition.
- describe_task_definition(Client, Input, Options)
-
describe_task_sets(Client, Input)
Describes the task sets in the specified cluster and service.
- describe_task_sets(Client, Input, Options)
-
describe_tasks(Client, Input)
Describes a specified task or tasks.
- describe_tasks(Client, Input, Options)
-
discover_poll_endpoint(Client, Input)
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- discover_poll_endpoint(Client, Input, Options)
-
list_account_settings(Client, Input)
Lists the account settings for a specified principal.
- list_account_settings(Client, Input, Options)
-
list_attributes(Client, Input)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
- list_attributes(Client, Input, Options)
-
list_clusters(Client, Input)
Returns a list of existing clusters.
- list_clusters(Client, Input, Options)
-
list_container_instances(Client, Input)
Returns a list of container instances in a specified cluster.
- list_container_instances(Client, Input, Options)
-
list_services(Client, Input)
Lists the services that are running in a specified cluster.
- list_services(Client, Input, Options)
-
list_tags_for_resource(Client, Input)
List the tags for an Amazon ECS resource.
- list_tags_for_resource(Client, Input, Options)
-
list_task_definition_families(Client, Input)
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 definition revisions). - list_task_definition_families(Client, Input, Options)
-
list_task_definitions(Client, Input)
Returns a list of task definitions that are registered to your account.
- list_task_definitions(Client, Input, Options)
-
list_tasks(Client, Input)
Returns a list of tasks for a specified cluster.
- list_tasks(Client, Input, Options)
-
put_account_setting(Client, Input)
Modifies an account setting.
- put_account_setting(Client, Input, Options)
-
put_account_setting_default(Client, Input)
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified.
- put_account_setting_default(Client, Input, Options)
-
put_attributes(Client, Input)
Create or update an attribute on an Amazon ECS resource.
- put_attributes(Client, Input, Options)
-
put_cluster_capacity_providers(Client, Input)
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
- put_cluster_capacity_providers(Client, Input, Options)
-
register_container_instance(Client, Input)
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- register_container_instance(Client, Input, Options)
-
register_task_definition(Client, Input)
Registers a new task definition from the supplied
family
andcontainerDefinitions
. - register_task_definition(Client, Input, Options)
-
run_task(Client, Input)
Starts a new task using the specified task definition.
- run_task(Client, Input, Options)
-
start_task(Client, Input)
Starts a new task from the specified task definition on the specified container instance or instances.
- start_task(Client, Input, Options)
-
stop_task(Client, Input)
Stops a running task.
- stop_task(Client, Input, Options)
-
submit_attachment_state_changes(Client, Input)
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- submit_attachment_state_changes(Client, Input, Options)
-
submit_container_state_change(Client, Input)
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- submit_container_state_change(Client, Input, Options)
-
submit_task_state_change(Client, Input)
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- submit_task_state_change(Client, Input, Options)
-
tag_resource(Client, Input)
Associates the specified tags to a resource with the specified
resourceArn
. - tag_resource(Client, Input, Options)
-
untag_resource(Client, Input)
Deletes specified tags from a resource.
- untag_resource(Client, Input, Options)
-
update_capacity_provider(Client, Input)
Modifies the parameters for a capacity provider.
- update_capacity_provider(Client, Input, Options)
-
update_cluster_settings(Client, Input)
Modifies the settings to use for a cluster.
- update_cluster_settings(Client, Input, Options)
-
update_container_agent(Client, Input)
Updates the Amazon ECS container agent on a specified container instance.
- update_container_agent(Client, Input, Options)
-
update_container_instances_state(Client, Input)
Modifies the status of an Amazon ECS container instance.
- update_container_instances_state(Client, Input, Options)
-
update_service(Client, Input)
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms").
- update_service(Client, Input, Options)
-
update_service_primary_task_set(Client, Input)
Modifies which task set in a service is the primary task set.
- update_service_primary_task_set(Client, Input, Options)
-
update_task_set(Client, Input)
Modifies a task set.
- update_task_set(Client, Input, Options)
Functions
create_capacity_provider(Client, Input)
Creates a new capacity provider.
Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use theFARGATE
and FARGATE_SPOT
capacity
providers which are already created and available to all accounts in
Regions supported by AWS Fargate.
create_capacity_provider(Client, Input, Options)
create_cluster(Client, Input)
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.
CreateCluster
API operation, Amazon ECS attempts to
create the Amazon ECS service-linked role for your account so that
required resources in other AWS services can be managed on your behalf.
However, if the IAM user that makes the call does not have permissions to
create the service-linked role, it is not created. For more information,
see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic
Container Service Developer Guide.
create_cluster(Client, Input, Options)
create_service(Client, Input)
Runs and maintains a desired number of tasks from a specified task definition.
If the number of tasks running in a service drops below the
desiredCount
, Amazon ECS runs another copy of the task in the specified
cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that do not use a load balancer are considered healthy
if they're in the RUNNING
state. Tasks for services that do use a load
balancer are considered healthy if they're in the RUNNING
state and the
container instance that they're hosted on is reported as healthy by the
load balancer.
There are two service scheduler strategies available:
REPLICA
- The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.DAEMON
- The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your
service. The deployment is triggered by changing properties, such as the
task definition or the desired count of a service, with an UpdateService
operation. The default value for a replica service for
minimumHealthyPercent
is 100%. The default value for a daemon service
for minimumHealthyPercent
is 0%.
If a service is using the ECS
deployment controller, the minimum healthy
percent represents a lower limit on the number of tasks in a service that
must remain in the RUNNING
state during a deployment, as a percentage of
the desired number of tasks (rounded up to the nearest integer), and while
any container instances are in the DRAINING
state if the service
contains tasks using the EC2 launch type. This parameter enables you to
deploy without using additional cluster capacity. For example, if your
service has a desired number of four tasks and a minimum healthy percent
of 50%, the scheduler might stop two existing tasks to free up cluster
capacity before starting two new tasks. Tasks for services that do not use
a load balancer are considered healthy if they're in the RUNNING
state.
Tasks for services that do use a load balancer are considered healthy if
they're in the RUNNING
state and they're reported as healthy by the load
balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS
deployment controller, the maximum percent
parameter represents an upper limit on the number of tasks in a service
that are allowed in the RUNNING
or PENDING
state during a deployment,
as a percentage of the desired number of tasks (rounded down to the
nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This
parameter enables you to define the deployment batch size. For example, if
your service has a desired number of four tasks and a maximum percent
value of 200%, the scheduler may start four new tasks before stopping the
four older tasks (provided that the cluster resources required to do this
are available). The default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY
or EXTERNAL
deployment
controller types and tasks that use the EC2 launch type, the minimum
healthy percent and maximum percent values are used only to define the
lower and upper limit on the number of the tasks in the service that
remain in the RUNNING
state while the container instances are in the
DRAINING
state. If the tasks in the service use the Fargate launch type,
the minimum healthy percent and maximum percent values aren't used,
although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL
deployment controller,
you can specify only parameters that aren't controlled at the task set
level. The only required parameter is the service name. You control your
services using the CreateTaskSet
operation. For more information, see
Amazon ECS Deployment Types in the Amazon Elastic Container Service
Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the
placementStrategy
parameter):Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
create_service(Client, Input, Options)
create_task_set(Client, Input)
Create a task set in the specified cluster and service.
This is used when a service uses theEXTERNAL
deployment controller
type. For more information, see Amazon ECS Deployment Types in the Amazon
Elastic Container Service Developer Guide.
create_task_set(Client, Input, Options)
delete_account_setting(Client, Input)
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
delete_account_setting(Client, Input, Options)
delete_attributes(Client, Input)
Deletes one or more custom attributes from an Amazon ECS resource.
delete_attributes(Client, Input, Options)
delete_capacity_provider(Client, Input)
Deletes the specified capacity provider.
The FARGATE
and FARGATE_SPOT
capacity providers are reserved and
cannot be deleted. You can disassociate them from a cluster using either
the PutClusterCapacityProviders
API or by deleting the cluster.
UpdateService
API can be used to remove a capacity provider from a
service's capacity provider strategy. When updating a service, the
forceNewDeployment
option can be used to ensure that any tasks using the
Amazon EC2 instance capacity provided by the capacity provider are
transitioned to use the capacity from the remaining capacity providers.
Only capacity providers that are not associated with a cluster can be
deleted. To remove a capacity provider from a cluster, you can either use
PutClusterCapacityProviders
or delete the cluster.
delete_capacity_provider(Client, Input, Options)
delete_cluster(Client, Input)
Deletes the specified cluster.
The cluster will transition to the INACTIVE
state. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of
time. However, this behavior is subject to change in the future, so you
should not rely on INACTIVE
clusters persisting.
ListContainerInstances
and deregister them with
DeregisterContainerInstance
.
delete_cluster(Client, Input, Options)
delete_service(Client, Input)
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 ACTIVE
to DRAINING
, and the
service is no longer visible in the console or in the ListServices
API
operation. After all tasks have transitioned to either STOPPING
or
STOPPED
status, the service status moves from DRAINING
to INACTIVE
.
Services in the DRAINING
or INACTIVE
status can still be viewed with
the DescribeServices
API operation. However, in the future, INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and
DescribeServices
calls on those services return a
ServiceNotFoundException
error.
ACTIVE
or DRAINING
status, you receive an error.
delete_service(Client, Input, Options)
delete_task_set(Client, Input)
Deletes a specified task set within a service.
This is used when a service uses theEXTERNAL
deployment controller
type. For more information, see Amazon ECS Deployment Types in the Amazon
Elastic Container Service Developer Guide.
delete_task_set(Client, Input, Options)
deregister_container_instance(Client, Input)
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. That prevents 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.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).deregister_container_instance(Client, Input, Options)
deregister_task_definition(Client, Input)
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. However, there may be up to a 10-minute window
following deregistration where these restrictions have not yet taken
effect.
INACTIVE
task definitions remain discoverable in your
account indefinitely. However, this behavior is subject to change in the
future, so you should not rely on INACTIVE
task definitions persisting
beyond the lifecycle of any associated tasks and services.
deregister_task_definition(Client, Input, Options)
describe_capacity_providers(Client, Input)
Describes one or more of your capacity providers.
describe_capacity_providers(Client, Input, Options)
describe_clusters(Client, Input)
Describes one or more of your clusters.
describe_clusters(Client, Input, Options)
describe_container_instances(Client, Input)
Describes Amazon Elastic Container Service container instances.
Returns metadata about registered and remaining resources on each container instance requested.describe_container_instances(Client, Input, Options)
describe_services(Client, Input)
Describes the specified services running in your cluster.
describe_services(Client, Input, Options)
describe_task_definition(Client, Input)
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.
INACTIVE
task definitions while an active task or
service references them.
describe_task_definition(Client, Input, Options)
describe_task_sets(Client, Input)
Describes the task sets in the specified cluster and service.
This is used when a service uses theEXTERNAL
deployment controller
type. For more information, see Amazon ECS Deployment Types in the Amazon
Elastic Container Service Developer Guide.
describe_task_sets(Client, Input, Options)
describe_tasks(Client, Input)
Describes a specified task or tasks.
describe_tasks(Client, Input, Options)
discover_poll_endpoint(Client, Input)
This 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 for updates.discover_poll_endpoint(Client, Input, Options)
list_account_settings(Client, Input)
Lists the account settings for a specified principal.
list_account_settings(Client, Input, Options)
list_attributes(Client, Input)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
When you specify a target type and cluster,ListAttributes
returns a
list of attribute objects, one for each attribute on each resource. You
can filter the list of results to a single attribute name to only return
results that have that name. You can also filter the results by attribute
name and value, for example, to see which container instances in a cluster
are running a Linux AMI (ecs.os-type=linux
).
list_attributes(Client, Input, Options)
list_clusters(Client, Input)
Returns a list of existing clusters.
list_clusters(Client, Input, Options)
list_container_instances(Client, Input)
Returns a list of container instances in a specified cluster.
You can filter the results of aListContainerInstances
operation with
cluster query language statements inside the filter
parameter. For more
information, see Cluster Query Language in the Amazon Elastic Container
Service Developer Guide.
list_container_instances(Client, Input, Options)
list_services(Client, Input)
Lists the services that are running in a specified cluster.
list_services(Client, Input, Options)
list_tags_for_resource(Client, Input)
List the tags for an Amazon ECS resource.
list_tags_for_resource(Client, Input, Options)
list_task_definition_families(Client, Input)
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 definition revisions).
ACTIVE
task definition revisions by setting the status
parameter to
ACTIVE
. You can also filter the results with the familyPrefix
parameter.
list_task_definition_families(Client, Input, Options)
list_task_definitions(Client, Input)
Returns a list of task definitions that are registered to your account.
You can filter the results by family name with thefamilyPrefix
parameter or by status with the status
parameter.
list_task_definitions(Client, Input, Options)
list_tasks(Client, Input)
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.
list_tasks(Client, Input, Options)
put_account_setting(Client, Input)
Modifies an account setting.
Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat
, taskLongArnFormat
, or
containerInstanceLongArnFormat
are specified, the Amazon Resource Name
(ARN) and resource ID format of the resource type for a specified IAM
user, IAM role, or the root user for an account is affected. The opt-in
and opt-out account setting must be set for each Amazon ECS resource
separately. The ARN and resource ID format of a resource will be defined
by the opt-in status of the IAM user or role that created the resource.
You must enable this setting to use Amazon ECS features such as resource
tagging.
When awsvpcTrunking
is specified, the elastic network interface (ENI)
limit for any new container instances that support the feature is changed.
If awsvpcTrunking
is enabled, any new container instances that support
the feature are launched have the increased ENI limits available to them.
For more information, see Elastic Network Interface Trunking in the Amazon
Elastic Container Service Developer Guide.
containerInsights
is specified, the default setting indicating
whether CloudWatch Container Insights is enabled for your clusters is
changed. If containerInsights
is enabled, any new clusters that are
created will have Container Insights enabled unless you disable it during
cluster creation. For more information, see CloudWatch Container Insights
in the Amazon Elastic Container Service Developer Guide.
put_account_setting(Client, Input, Options)
put_account_setting_default(Client, Input)
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified.
Account settings are set on a per-Region basis.put_account_setting_default(Client, Input, Options)
put_attributes(Client, Input)
Create or update an attribute on an Amazon ECS resource.
If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, useDeleteAttributes
. For more information, see Attributes in the Amazon
Elastic Container Service Developer Guide.
put_attributes(Client, Input, Options)
put_cluster_capacity_providers(Client, Input)
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default
capacity provider strategy for the cluster. If the specified cluster has
existing capacity providers associated with it, you must specify all
existing capacity providers in addition to any new ones you want to add.
Any existing capacity providers associated with a cluster that are omitted
from a PutClusterCapacityProviders
API call will be disassociated with
the cluster. You can only disassociate an existing capacity provider from
a cluster if it's not being used by any existing tasks.
[]
) to bypass defining a default strategy.
put_cluster_capacity_providers(Client, Input, Options)
register_container_instance(Client, Input)
This 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. This instance becomes available to place containers on.register_container_instance(Client, Input, Options)
register_task_definition(Client, Input)
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 Elastic Container
Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter. When you specify an IAM role for a task, its containers can
then use the latest versions of the AWS CLI or SDKs to make API requests
to the AWS services that are specified in the IAM policy associated with
the role. For more information, see IAM Roles for Tasks in the Amazon
Elastic Container Service Developer Guide.
networkMode
parameter. The available network modes
correspond to those described in Network settings in the Docker run
reference. If you specify the awsvpc
network mode, the task is allocated
an elastic network interface, and you must specify a
NetworkConfiguration
when you create a service or run a task with the
task definition. For more information, see Task Networking in the Amazon
Elastic Container Service Developer Guide.
register_task_definition(Client, Input, Options)
run_task(Client, Input)
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask
to use your own scheduler or place
tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
run_task(Client, Input, Options)
start_task(Client, Input)
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can useRunTask
to place tasks for you. For more
information, see Scheduling Tasks in the Amazon Elastic Container Service
Developer Guide.
start_task(Client, Input, Options)
stop_task(Client, Input)
Stops a running task.
Any tags associated with the task will be deleted.
When StopTask
is called on a task, the equivalent of docker stop
is
issued to the containers running in the task. This results in a SIGTERM
value and a default 30-second timeout, after which the SIGKILL
value is
sent and the containers are forcibly stopped. If the container handles the
SIGTERM
value gracefully and exits within 30 seconds from receiving it,
no SIGKILL
value is sent.
ECS_CONTAINER_STOP_TIMEOUT
variable. For more
information, see Amazon ECS Container Agent Configuration in the Amazon
Elastic Container Service Developer Guide.
stop_task(Client, Input, Options)
submit_attachment_state_changes(Client, Input)
This 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.submit_attachment_state_changes(Client, Input, Options)
submit_container_state_change(Client, Input)
This 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.submit_container_state_change(Client, Input, Options)
submit_task_state_change(Client, Input)
This 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.submit_task_state_change(Client, Input, Options)
tag_resource(Client, Input)
Associates the specified tags to a resource with the specified
resourceArn
.
tag_resource(Client, Input, Options)
untag_resource(Client, Input)
Deletes specified tags from a resource.
untag_resource(Client, Input, Options)
update_capacity_provider(Client, Input)
Modifies the parameters for a capacity provider.
update_capacity_provider(Client, Input, Options)
update_cluster_settings(Client, Input)
Modifies the settings to use for a cluster.
update_cluster_settings(Client, Input, Options)
update_container_agent(Client, Input)
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 Elastic Container
Service Developer Guide.
update_container_agent(Client, Input, Options)
update_container_instances_state(Client, Input)
Modifies 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 instance to DRAINING
to manually remove an
instance from a cluster, for example to perform system updates, update the
Docker daemon, or scale down the cluster size.
A container instance cannot be changed to DRAINING
until it has reached
an ACTIVE
status. If the instance is in any other status, an error will
be received.
When you set a container instance to DRAINING
, Amazon ECS prevents new
tasks from being scheduled for placement on the container instance and
replacement service tasks are started on other container instances in the
cluster if the resources are available. Service tasks on the container
instance that are in the PENDING
state are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state
are stopped and replaced according to the service's deployment
configuration parameters, minimumHealthyPercent
and maximumPercent
.
You can change the deployment configuration of your service using
UpdateService
.
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
temporarily during task replacement. For example,desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in theRUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer.The
maximumPercent
parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, ifdesiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a
service are not affected. You must wait for them to finish or stop them
manually.
A container instance has completed draining when it has no more RUNNING
tasks. You can verify this using ListTasks
.
ACTIVE
status and once it has reached that status the Amazon
ECS scheduler can begin scheduling tasks on the instance again.
update_container_instances_state(Client, Input, Options)
update_service(Client, Input)
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms").
These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the
desired count, deployment configuration, network configuration, task
placement constraints and strategies, or task definition used can be
updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller,
only the desired count, deployment configuration, task placement
constraints and strategies, and health check grace period can be updated
using this API. If the network configuration, platform version, or task
definition need to be updated, a new AWS CodeDeploy deployment should be
created. For more information, see CreateDeployment in the AWS CodeDeploy
API Reference.
For services using an external deployment controller, you can update only
the desired count, task placement constraints and strategies, and health
check grace period using this API. If the launch type, load balancer,
network configuration, platform version, or task definition need to be
updated, you should create a new task set. For more information, see
CreateTaskSet
.
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.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing
task definition for your service (for example, my_image:latest
), you do
not need to create a new revision of your task definition. You can update
the service using the forceNewDeployment
option. The new tasks launched
by the deployment pull the current image/tag combination from your
repository when they start.
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,
minimumHealthyPercent
and maximumPercent
, to determine the deployment
strategy.
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
temporarily during a deployment. For example, ifdesiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in theRUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer.The
maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, ifdesiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService
stops a task during a deployment, the
equivalent of docker stop
is 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 determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
update_service(Client, Input, Options)
update_service_primary_task_set(Client, Input)
Modifies 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 service. This is used when a service uses theEXTERNAL
deployment controller type. For more information, see Amazon ECS
Deployment Types in the Amazon Elastic Container Service Developer Guide.
update_service_primary_task_set(Client, Input, Options)
update_task_set(Client, Input)
Modifies a task set.
This is used when a service uses theEXTERNAL
deployment controller
type. For more information, see Amazon ECS Deployment Types in the Amazon
Elastic Container Service Developer Guide.