Table of Contents
A low-level client representing Amazon EC2 Container Service (ECS):
import boto3
client = boto3.client('ecs')
These are the available methods:
Check if an operation can be paginated.
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.
Note
When you call the CreateCluster API operation, Amazon ECS attempts to create the 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 .
See also: AWS API Documentation
Request Syntax
response = client.create_cluster(
clusterName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
The metadata that you apply to the cluster 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.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'cluster': {
'clusterArn': 'string',
'clusterName': 'string',
'status': 'string',
'registeredContainerInstancesCount': 123,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'activeServicesCount': 123,
'statistics': [
{
'name': 'string',
'value': 'string'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your new cluster.
clusterArn (string) --
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, ``arn:aws:ecs:region :012345678910 :cluster/test `` ..
clusterName (string) --
A user-generated string that you use to identify your cluster.
status (string) --
The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
registeredContainerInstancesCount (integer) --
The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
runningTasksCount (integer) --
The number of tasks in the cluster that are in the RUNNING state.
pendingTasksCount (integer) --
The number of tasks in the cluster that are in the PENDING state.
activeServicesCount (integer) --
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .
statistics (list) --
Additional information about your clusters that are separated by launch type, including:
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the cluster 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Examples
This example creates a cluster in your default region.
response = client.create_cluster(
clusterName='my_cluster',
)
print(response)
Expected Output:
{
'cluster': {
'activeServicesCount': 0,
'clusterArn': 'arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster',
'clusterName': 'my_cluster',
'pendingTasksCount': 0,
'registeredContainerInstancesCount': 0,
'runningTasksCount': 0,
'status': 'ACTIVE',
},
'ResponseMetadata': {
'...': '...',
},
}
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 copy of the task in the specified cluster. To update an existing service, see UpdateService .
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes 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 .
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.
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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are 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 the CODE_DEPLOY deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used 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 are not used, although they are currently visible when describing your service.
Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
See also: AWS API Documentation
Request Syntax
response = client.create_service(
cluster='string',
serviceName='string',
taskDefinition='string',
loadBalancers=[
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
serviceRegistries=[
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
desiredCount=123,
clientToken='string',
launchType='EC2'|'FARGATE',
platformVersion='string',
role='string',
deploymentConfiguration={
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
placementConstraints=[
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
placementStrategy=[
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
healthCheckGracePeriodSeconds=123,
schedulingStrategy='REPLICA'|'DAEMON',
deploymentController={
'type': 'ECS'|'CODE_DEPLOY'
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
enableECSManagedTags=True|False,
propagateTags='TASK_DEFINITION'|'SERVICE'
)
[REQUIRED]
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
[REQUIRED]
The family and revision (family:revision ) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
A load balancer object representing the load balancer to use with your service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The name of a load balancer.
The name of the container (as it appears in a container definition) to associate with the load balancer.
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
The details of the service discovery registries to assign to this service. For more information, see Service Discovery .
Note
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions .
Details of the service registry.
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service .
The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
Warning
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .
If your specified role has a path other than / , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide .
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
If a service is using the rolling update (ECS ) deployment type, 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 the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the 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 maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS ) deployment type, 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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower 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 value is not used, although it is returned when describing your service.
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
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 type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
The scheduling strategy to use for the service. For more information, see Services .
There are two service scheduler strategies available:
Note
Tasks using the Fargate launch type or the CODE_DEPLOY deploymenet controller do not support the DAEMON scheduling strategy.
The deployment controller to use for the service.
The deployment controller type to use.
There are two deployment controller types available:
ECS
The rolling update (ECS ) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration .
CODE_DEPLOY
The blue/green (CODE_DEPLOY ) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'serviceName': 'string',
'clusterArn': 'string',
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'status': 'string',
'desiredCount': 123,
'runningCount': 123,
'pendingCount': 123,
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'startedBy': 'string',
'externalId': 'string',
'status': 'string',
'taskDefinition': 'string',
'computedDesiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
},
],
'deployments': [
{
'id': 'string',
'status': 'string',
'taskDefinition': 'string',
'desiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
}
},
],
'roleArn': 'string',
'events': [
{
'id': 'string',
'createdAt': datetime(2015, 1, 1),
'message': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'placementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'placementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'healthCheckGracePeriodSeconds': 123,
'schedulingStrategy': 'REPLICA'|'DAEMON',
'deploymentController': {
'type': 'ECS'|'CODE_DEPLOY'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'enableECSManagedTags': True|False,
'propagateTags': 'TASK_DEFINITION'|'SERVICE'
}
}
Response Structure
(dict) --
service (dict) --
The full description of your service following the create call.
If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.
If the service is using the CODE_DEPLOY deployment controller, the deploymentController , taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.
serviceArn (string) --
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region :012345678910 :service/my-service `` .
serviceName (string) --
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers (list) --
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service .
port (integer) --
The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
containerName (string) --
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
containerPort (integer) --
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
status (string) --
The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
desiredCount (integer) --
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
runningCount (integer) --
The number of tasks in the cluster that are in the RUNNING state.
pendingCount (integer) --
The number of tasks in the cluster that are in the PENDING state.
launchType (string) --
The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
taskDefinition (string) --
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
deploymentConfiguration (dict) --
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
maximumPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the 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 maximum percent value is not used, although it is returned when describing your service.
minimumHealthyPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower 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 value is not used, although it is returned when describing your service.
taskSets (list) --
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.
(dict) --
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.
id (string) --
The ID of the task set.
taskSetArn (string) --
The Amazon Resource Name (ARN) of the task set.
startedBy (string) --
The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY .
externalId (string) --
The deployment ID of the AWS CodeDeploy deployment.
status (string) --
The status of the task set. The following describes each state:
PRIMARY
The task set is serving production traffic.
ACTIVE
The task set is not serving production traffic.
DRAINING
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
taskDefinition (string) --
The task definition the task set is using.
computedDesiredCount (integer) --
The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
pendingCount (integer) --
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
runningCount (integer) --
The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
createdAt (datetime) --
The Unix timestamp for when the task set was created.
updatedAt (datetime) --
The Unix timestamp for when the task set was last updated.
launchType (string) --
The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The network configuration for the task set.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
loadBalancers (list) --
Details on a load balancer that is used with a task set.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the service.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set.
unit (string) --
The unit of measure for the scale value.
stabilityStatus (string) --
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE :
If any of those conditions are not met, the stability status returns STABILIZING .
stabilityStatusAt (datetime) --
The Unix timestamp for when the task set stability status was retrieved.
deployments (list) --
The current state of deployments for the service.
(dict) --
The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.
id (string) --
The ID of the deployment.
status (string) --
The status of the deployment. The following describes each state:
PRIMARY
The most recent deployment of a service.
ACTIVE
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
INACTIVE
A deployment that has been completely replaced.
taskDefinition (string) --
The most recent task definition that was specified for the tasks in the service to use.
desiredCount (integer) --
The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount (integer) --
The number of tasks in the deployment that are in the PENDING status.
runningCount (integer) --
The number of tasks in the deployment that are in the RUNNING status.
createdAt (datetime) --
The Unix timestamp for when the service deployment was created.
updatedAt (datetime) --
The Unix timestamp for when the service deployment was last updated.
launchType (string) --
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
roleArn (string) --
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
events (list) --
The event stream for your service. A maximum of 100 of the latest events are displayed.
(dict) --
Details on an event associated with a service.
id (string) --
The ID string of the event.
createdAt (datetime) --
The Unix timestamp for when the event was triggered.
message (string) --
The event message.
createdAt (datetime) --
The Unix timestamp for when the service was created.
placementConstraints (list) --
The placement constraints for the tasks in the service.
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
expression (string) --
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
placementStrategy (list) --
The placement strategy that determines how tasks for the service are placed.
(dict) --
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
healthCheckGracePeriodSeconds (integer) --
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
schedulingStrategy (string) --
The scheduling strategy to use for the service. For more information, see Services .
There are two service scheduler strategies available:
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using.
type (string) --
The deployment controller type to use.
There are two deployment controller types available:
ECS
The rolling update (ECS ) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration .
CODE_DEPLOY
The blue/green (CODE_DEPLOY ) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
tags (list) --
The metadata that you apply to the service 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
createdBy (string) --
The principal that created the service.
enableECSManagedTags (boolean) --
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
propagateTags (string) --
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
Examples
This example creates a service in your default region called ecs-simple-service. The service uses the hello_world task definition and it maintains 10 copies of that task.
response = client.create_service(
desiredCount=10,
serviceName='ecs-simple-service',
taskDefinition='hello_world',
)
print(response)
Expected Output:
{
'service': {
'clusterArn': 'arn:aws:ecs:us-east-1:012345678910:cluster/default',
'createdAt': datetime(2016, 8, 29, 16, 13, 47, 0, 242, 0),
'deploymentConfiguration': {
'maximumPercent': 200,
'minimumHealthyPercent': 100,
},
'deployments': [
{
'createdAt': datetime(2016, 8, 29, 16, 13, 47, 0, 242, 0),
'desiredCount': 10,
'id': 'ecs-svc/9223370564342348388',
'pendingCount': 0,
'runningCount': 0,
'status': 'PRIMARY',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
'updatedAt': datetime(2016, 8, 29, 16, 13, 47, 0, 242, 0),
},
{
'createdAt': datetime(2016, 8, 29, 15, 52, 44, 0, 242, 0),
'desiredCount': 0,
'id': 'ecs-svc/9223370564343611322',
'pendingCount': 0,
'runningCount': 0,
'status': 'ACTIVE',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
'updatedAt': datetime(2016, 8, 29, 16, 11, 38, 0, 242, 0),
},
],
'desiredCount': 10,
'events': [
],
'loadBalancers': [
],
'pendingCount': 0,
'runningCount': 0,
'serviceArn': 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service',
'serviceName': 'ecs-simple-service',
'status': 'ACTIVE',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
},
'ResponseMetadata': {
'...': '...',
},
}
This example creates a service in your default region called ecs-simple-service-elb. The service uses the ecs-demo task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.
response = client.create_service(
desiredCount=10,
loadBalancers=[
{
'containerName': 'simple-app',
'containerPort': 80,
'loadBalancerName': 'EC2Contai-EcsElast-15DCDAURT3ZO2',
},
],
role='ecsServiceRole',
serviceName='ecs-simple-service-elb',
taskDefinition='console-sample-app-static',
)
print(response)
Expected Output:
{
'service': {
'clusterArn': 'arn:aws:ecs:us-east-1:012345678910:cluster/default',
'createdAt': datetime(2016, 8, 29, 16, 2, 54, 0, 242, 0),
'deploymentConfiguration': {
'maximumPercent': 200,
'minimumHealthyPercent': 100,
},
'deployments': [
{
'createdAt': datetime(2016, 8, 29, 16, 2, 54, 0, 242, 0),
'desiredCount': 10,
'id': 'ecs-svc/9223370564343000923',
'pendingCount': 0,
'runningCount': 0,
'status': 'PRIMARY',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6',
'updatedAt': datetime(2016, 8, 29, 16, 2, 54, 0, 242, 0),
},
],
'desiredCount': 10,
'events': [
],
'loadBalancers': [
{
'containerName': 'simple-app',
'containerPort': 80,
'loadBalancerName': 'EC2Contai-EcsElast-15DCDAURT3ZO2',
},
],
'pendingCount': 0,
'roleArn': 'arn:aws:iam::012345678910:role/ecsServiceRole',
'runningCount': 0,
'serviceArn': 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb',
'serviceName': 'ecs-simple-service-elb',
'status': 'ACTIVE',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6',
},
'ResponseMetadata': {
'...': '...',
},
}
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.
See also: AWS API Documentation
Request Syntax
response = client.delete_account_setting(
name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
principalArn='string'
)
[REQUIRED]
The resource name for which to disable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.
dict
Response Syntax
{
'setting': {
'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
'value': 'string',
'principalArn': 'string'
}
}
Response Structure
(dict) --
setting (dict) --
The account setting for the specified principal ARN.
name (string) --
The account resource name.
value (string) --
The current account setting for the resource name. If enabled , then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled , then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
principalArn (string) --
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
Deletes one or more custom attributes from an Amazon ECS resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_attributes(
cluster='string',
attributes=[
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
]
)
[REQUIRED]
The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
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 .
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
dict
Response Syntax
{
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
]
}
Response Structure
(dict) --
attributes (list) --
A list of attribute objects that were successfully deleted from your resource.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_cluster(
cluster='string'
)
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster to delete.
{
'cluster': {
'clusterArn': 'string',
'clusterName': 'string',
'status': 'string',
'registeredContainerInstancesCount': 123,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'activeServicesCount': 123,
'statistics': [
{
'name': 'string',
'value': 'string'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
The full description of the deleted cluster.
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, ``arn:aws:ecs:region :012345678910 :cluster/test `` ..
A user-generated string that you use to identify your cluster.
The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .
Additional information about your clusters that are separated by launch type, including:
A key-value pair object.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
The value of the key-value pair. For environment variables, this is the value of the environment variable.
The metadata that you apply to the cluster 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.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Examples
This example deletes an empty cluster in your default region.
response = client.delete_cluster(
cluster='my_cluster',
)
print(response)
Expected Output:
{
'cluster': {
'activeServicesCount': 0,
'clusterArn': 'arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster',
'clusterName': 'my_cluster',
'pendingTasksCount': 0,
'registeredContainerInstancesCount': 0,
'runningTasksCount': 0,
'status': 'INACTIVE',
},
'ResponseMetadata': {
'...': '...',
},
}
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 .
Note
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 the tasks have stopped, then 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.
Warning
If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
See also: AWS API Documentation
Request Syntax
response = client.delete_service(
cluster='string',
service='string',
force=True|False
)
[REQUIRED]
The name of the service to delete.
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'serviceName': 'string',
'clusterArn': 'string',
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'status': 'string',
'desiredCount': 123,
'runningCount': 123,
'pendingCount': 123,
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'startedBy': 'string',
'externalId': 'string',
'status': 'string',
'taskDefinition': 'string',
'computedDesiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
},
],
'deployments': [
{
'id': 'string',
'status': 'string',
'taskDefinition': 'string',
'desiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
}
},
],
'roleArn': 'string',
'events': [
{
'id': 'string',
'createdAt': datetime(2015, 1, 1),
'message': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'placementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'placementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'healthCheckGracePeriodSeconds': 123,
'schedulingStrategy': 'REPLICA'|'DAEMON',
'deploymentController': {
'type': 'ECS'|'CODE_DEPLOY'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'enableECSManagedTags': True|False,
'propagateTags': 'TASK_DEFINITION'|'SERVICE'
}
}
Response Structure
(dict) --
service (dict) --
The full description of the deleted service.
serviceArn (string) --
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region :012345678910 :service/my-service `` .
serviceName (string) --
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers (list) --
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service .
port (integer) --
The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
containerName (string) --
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
containerPort (integer) --
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
status (string) --
The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
desiredCount (integer) --
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
runningCount (integer) --
The number of tasks in the cluster that are in the RUNNING state.
pendingCount (integer) --
The number of tasks in the cluster that are in the PENDING state.
launchType (string) --
The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
taskDefinition (string) --
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
deploymentConfiguration (dict) --
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
maximumPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the 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 maximum percent value is not used, although it is returned when describing your service.
minimumHealthyPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower 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 value is not used, although it is returned when describing your service.
taskSets (list) --
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.
(dict) --
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.
id (string) --
The ID of the task set.
taskSetArn (string) --
The Amazon Resource Name (ARN) of the task set.
startedBy (string) --
The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY .
externalId (string) --
The deployment ID of the AWS CodeDeploy deployment.
status (string) --
The status of the task set. The following describes each state:
PRIMARY
The task set is serving production traffic.
ACTIVE
The task set is not serving production traffic.
DRAINING
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
taskDefinition (string) --
The task definition the task set is using.
computedDesiredCount (integer) --
The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
pendingCount (integer) --
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
runningCount (integer) --
The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
createdAt (datetime) --
The Unix timestamp for when the task set was created.
updatedAt (datetime) --
The Unix timestamp for when the task set was last updated.
launchType (string) --
The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The network configuration for the task set.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
loadBalancers (list) --
Details on a load balancer that is used with a task set.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the service.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set.
unit (string) --
The unit of measure for the scale value.
stabilityStatus (string) --
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE :
If any of those conditions are not met, the stability status returns STABILIZING .
stabilityStatusAt (datetime) --
The Unix timestamp for when the task set stability status was retrieved.
deployments (list) --
The current state of deployments for the service.
(dict) --
The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.
id (string) --
The ID of the deployment.
status (string) --
The status of the deployment. The following describes each state:
PRIMARY
The most recent deployment of a service.
ACTIVE
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
INACTIVE
A deployment that has been completely replaced.
taskDefinition (string) --
The most recent task definition that was specified for the tasks in the service to use.
desiredCount (integer) --
The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount (integer) --
The number of tasks in the deployment that are in the PENDING status.
runningCount (integer) --
The number of tasks in the deployment that are in the RUNNING status.
createdAt (datetime) --
The Unix timestamp for when the service deployment was created.
updatedAt (datetime) --
The Unix timestamp for when the service deployment was last updated.
launchType (string) --
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
roleArn (string) --
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
events (list) --
The event stream for your service. A maximum of 100 of the latest events are displayed.
(dict) --
Details on an event associated with a service.
id (string) --
The ID string of the event.
createdAt (datetime) --
The Unix timestamp for when the event was triggered.
message (string) --
The event message.
createdAt (datetime) --
The Unix timestamp for when the service was created.
placementConstraints (list) --
The placement constraints for the tasks in the service.
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
expression (string) --
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
placementStrategy (list) --
The placement strategy that determines how tasks for the service are placed.
(dict) --
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
healthCheckGracePeriodSeconds (integer) --
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
schedulingStrategy (string) --
The scheduling strategy to use for the service. For more information, see Services .
There are two service scheduler strategies available:
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using.
type (string) --
The deployment controller type to use.
There are two deployment controller types available:
ECS
The rolling update (ECS ) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration .
CODE_DEPLOY
The blue/green (CODE_DEPLOY ) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
tags (list) --
The metadata that you apply to the service 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
createdBy (string) --
The principal that created the service.
enableECSManagedTags (boolean) --
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
propagateTags (string) --
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
Examples
This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.
response = client.delete_service(
service='my-http-service',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
Note
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).
See also: AWS API Documentation
Request Syntax
response = client.deregister_container_instance(
cluster='string',
containerInstance='string',
force=True|False
)
[REQUIRED]
The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID `` .
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
dict
Response Syntax
{
'containerInstance': {
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'version': 123,
'versionInfo': {
'agentVersion': 'string',
'agentHash': 'string',
'dockerVersion': 'string'
},
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'registeredAt': datetime(2015, 1, 1),
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
containerInstance (dict) --
The container instance that was deregistered.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID `` .
ec2InstanceId (string) --
The EC2 instance ID of the container instance.
version (integer) --
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
versionInfo (dict) --
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion (string) --
The version number of the Amazon ECS container agent.
agentHash (string) --
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion (string) --
The Docker version running on the container instance.
remainingResources (list) --
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
registeredResources (list) --
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
status (string) --
The status of the container instance. The valid values are ACTIVE , INACTIVE , or DRAINING . ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide .
agentConnected (boolean) --
This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false . Only instances connected to an agent can accept placement requests.
runningTasksCount (integer) --
The number of tasks on the container instance that are in the RUNNING status.
pendingTasksCount (integer) --
The number of tasks on the container instance that are in the PENDING status.
agentUpdateStatus (string) --
The status of the most recent agent update. If an update has never been requested, this value is NULL .
attributes (list) --
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt (datetime) --
The Unix timestamp for when the container instance was registered.
attachments (list) --
The elastic network interfaces associated with the container instance.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the container instance 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Examples
This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.
response = client.deregister_container_instance(
cluster='default',
containerInstance='container_instance_UUID',
force=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
Note
At this time, 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.
See also: AWS API Documentation
Request Syntax
response = client.deregister_task_definition(
taskDefinition='string'
)
[REQUIRED]
The family and revision (family:revision ) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision .
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'repositoryCredentials': {
'credentialsParameter': 'string'
},
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'links': [
'string',
],
'portMappings': [
{
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'essential': True|False,
'entryPoint': [
'string',
],
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'sourceVolume': 'string',
'containerPath': 'string',
'readOnly': True|False
},
],
'volumesFrom': [
{
'sourceContainer': 'string',
'readOnly': True|False
},
],
'linuxParameters': {
'capabilities': {
'add': [
'string',
],
'drop': [
'string',
]
},
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'read'|'write'|'mknod',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
],
'hostname': 'string',
'user': 'string',
'workingDirectory': 'string',
'disableNetworking': True|False,
'privileged': True|False,
'readonlyRootFilesystem': True|False,
'dnsServers': [
'string',
],
'dnsSearchDomains': [
'string',
],
'extraHosts': [
{
'hostname': 'string',
'ipAddress': 'string'
},
],
'dockerSecurityOptions': [
'string',
],
'interactive': True|False,
'pseudoTerminal': True|False,
'dockerLabels': {
'string': 'string'
},
'ulimits': [
{
'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
'softLimit': 123,
'hardLimit': 123
},
],
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
}
},
'healthCheck': {
'command': [
'string',
],
'interval': 123,
'timeout': 123,
'retries': 123,
'startPeriod': 123
},
'systemControls': [
{
'namespace': 'string',
'value': 'string'
},
],
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'family': 'string',
'taskRoleArn': 'string',
'executionRoleArn': 'string',
'networkMode': 'bridge'|'host'|'awsvpc'|'none',
'revision': 123,
'volumes': [
{
'name': 'string',
'host': {
'sourcePath': 'string'
},
'dockerVolumeConfiguration': {
'scope': 'task'|'shared',
'autoprovision': True|False,
'driver': 'string',
'driverOpts': {
'string': 'string'
},
'labels': {
'string': 'string'
}
}
},
],
'status': 'ACTIVE'|'INACTIVE',
'requiresAttributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'placementConstraints': [
{
'type': 'memberOf',
'expression': 'string'
},
],
'compatibilities': [
'EC2'|'FARGATE',
],
'requiresCompatibilities': [
'EC2'|'FARGATE',
],
'cpu': 'string',
'memory': 'string',
'pidMode': 'host'|'task',
'ipcMode': 'host'|'task'|'none'
}
}
Response Structure
The full description of the deregistered task.
The full Amazon Resource Name (ARN) of the task definition.
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run .
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either `` repository-url /image :tag `` or `` repository-url /image @*digest* `` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .
The private repository authentication credentials to use.
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run .
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
Note
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run .
If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.
For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run .
You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge . The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ . This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to ` docker run https://docs.docker.com/engine/reference/commandline/run/`__ .
Note
This parameter is not supported for Windows containers.
Warning
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only specify the containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
Port mappings on Windows use the NetNAT gateway address rather than localhost . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to none , then you can't specify port mappings. If the network mode of a task definition is set to host , then host ports must either be undefined or they must match the container port in the port mapping.
Note
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
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 awsvpc or host network mode, exposed ports should be specified using containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
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.
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort .
If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort . Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort .
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
Note
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.
The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .
If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false , then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .
Warning
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint .
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd . If there are multiple arguments, each argument should be a separated string in the array.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run .
Warning
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
A key-value pair object.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
The value of the key-value pair. For environment variables, this is the value of the environment variable.
The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
Details on a volume mount point that is used in a container definition.
The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume .
The path on the container to mount the host volume at.
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run .
Details on a data volume from another container in the same task definition.
The name of another container within the same task definition from which to mount volumes.
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities .
Note
This parameter is not supported for Windows containers.
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note
If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run .
Note
If you are using tasks that use the Fargate launch type, the add parameter is not supported.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run .
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .
Note
If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
An object representing a container instance host device.
The path for the device on the host container instance.
The path inside the container at which to expose the host device.
The explicit permissions to provide to the container for the device. By default, the container has permissions for read , write , and mknod for the device.
Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run .
Note
If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .
Note
If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
The container path, mount options, and size of the tmpfs mount.
The absolute file path where the tmpfs volume is to be mounted.
The size (in MiB) of the tmpfs volume.
The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide .
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 .
The value to set as the environment variable on the container.
The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run .
Note
The hostname parameter is not supported if you are using the awsvpc network mode.
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
Note
This parameter is not supported for Windows containers.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run .
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API .
Note
This parameter is not supported for Windows containers.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
Note
This parameter is not supported for Windows containers.
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run .
Note
This parameter is not supported for Windows containers.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run .
Note
This parameter is not supported for Windows containers.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run .
Note
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition .
The hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run .
Note
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
This parameter is not supported for Windows containers.
When this parameter is true , this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run .
When this parameter is true , a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run .
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run . Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
This parameter is not supported for Windows containers.
The ulimit settings to pass to the container.
The type of the ulimit .
The soft limit for the ulimit type.
The hard limit for the ulimit type.
The log configuration specification for the container.
If you are using the Fargate launch type, the only supported value is awslogs .
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run . By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Note
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs . For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide .
Note
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run .
A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API .
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
Note
If a health check succeeds within the startPeriod , then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
Note
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:
The namespaced kernel parameter for which to set a value .
The value for the namespaced kernel parameter specified in namespace .
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
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
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
The type of resource to assign to a container. The only supported value is GPU .
The family of your task definition, used as the definition name.
The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
The Docker networking mode to use for the containers in the task. The valid values are none , bridge , awsvpc , and host . The default Docker network mode is bridge . If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc , the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value 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 .
Note
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference .
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 . Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration . For tasks that use a bind mount host volume, specify a host and optional sourcePath . For more information, see Using Data Volumes in Tasks .
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints .
This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or D:\:C:\my\path .
When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is not supported.
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 local driver. To use bind mounts, specify a host instead.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
If this value is true , the Docker volume is created if it does not already exist.
Note
This field is only used if the scope is shared .
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery . This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
The status of the task definition.
The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
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 .
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
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 type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
The launch type that the task is using.
The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
The process namespace to use for the containers in the task. The valid values are host or task . If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference .
If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The IPC resource namespace to use for the containers in the task. The valid values are host , task , or none . If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference .
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
Describes one or more of your clusters.
See also: AWS API Documentation
Request Syntax
response = client.describe_clusters(
clusters=[
'string',
],
include=[
'STATISTICS'|'TAGS',
]
)
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
Additional information about your clusters to be separated by launch type, including:
dict
Response Syntax
{
'clusters': [
{
'clusterArn': 'string',
'clusterName': 'string',
'status': 'string',
'registeredContainerInstancesCount': 123,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'activeServicesCount': 123,
'statistics': [
{
'name': 'string',
'value': 'string'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
clusters (list) --
The list of clusters.
(dict) --
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.
clusterArn (string) --
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, ``arn:aws:ecs:region :012345678910 :cluster/test `` ..
clusterName (string) --
A user-generated string that you use to identify your cluster.
status (string) --
The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
registeredContainerInstancesCount (integer) --
The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
runningTasksCount (integer) --
The number of tasks in the cluster that are in the RUNNING state.
pendingTasksCount (integer) --
The number of tasks in the cluster that are in the PENDING state.
activeServicesCount (integer) --
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .
statistics (list) --
Additional information about your clusters that are separated by launch type, including:
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the cluster 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Examples
This example provides a description of the specified cluster in your default region.
response = client.describe_clusters(
clusters=[
'default',
],
)
print(response)
Expected Output:
{
'clusters': [
{
'clusterArn': 'arn:aws:ecs:us-east-1:aws_account_id:cluster/default',
'clusterName': 'default',
'status': 'ACTIVE',
},
],
'failures': [
],
'ResponseMetadata': {
'...': '...',
},
}
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
See also: AWS API Documentation
Request Syntax
response = client.describe_container_instances(
cluster='string',
containerInstances=[
'string',
],
include=[
'TAGS',
]
)
[REQUIRED]
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
dict
Response Syntax
{
'containerInstances': [
{
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'version': 123,
'versionInfo': {
'agentVersion': 'string',
'agentHash': 'string',
'dockerVersion': 'string'
},
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'registeredAt': datetime(2015, 1, 1),
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
containerInstances (list) --
The list of container instances.
(dict) --
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID `` .
ec2InstanceId (string) --
The EC2 instance ID of the container instance.
version (integer) --
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
versionInfo (dict) --
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion (string) --
The version number of the Amazon ECS container agent.
agentHash (string) --
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion (string) --
The Docker version running on the container instance.
remainingResources (list) --
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
registeredResources (list) --
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
status (string) --
The status of the container instance. The valid values are ACTIVE , INACTIVE , or DRAINING . ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide .
agentConnected (boolean) --
This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false . Only instances connected to an agent can accept placement requests.
runningTasksCount (integer) --
The number of tasks on the container instance that are in the RUNNING status.
pendingTasksCount (integer) --
The number of tasks on the container instance that are in the PENDING status.
agentUpdateStatus (string) --
The status of the most recent agent update. If an update has never been requested, this value is NULL .
attributes (list) --
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt (datetime) --
The Unix timestamp for when the container instance was registered.
attachments (list) --
The elastic network interfaces associated with the container instance.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the container instance 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Examples
This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.
response = client.describe_container_instances(
cluster='default',
containerInstances=[
'f2756532-8f13-4d53-87c9-aed50dc94cd7',
],
)
print(response)
Expected Output:
{
'containerInstances': [
{
'agentConnected': True,
'containerInstanceArn': 'arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7',
'ec2InstanceId': 'i-807f3249',
'pendingTasksCount': 0,
'registeredResources': [
{
'name': 'CPU',
'type': 'INTEGER',
'doubleValue': 0.0,
'integerValue': 2048,
'longValue': 0,
},
{
'name': 'MEMORY',
'type': 'INTEGER',
'doubleValue': 0.0,
'integerValue': 3768,
'longValue': 0,
},
{
'name': 'PORTS',
'type': 'STRINGSET',
'doubleValue': 0.0,
'integerValue': 0,
'longValue': 0,
'stringSetValue': [
'2376',
'22',
'51678',
'2375',
],
},
],
'remainingResources': [
{
'name': 'CPU',
'type': 'INTEGER',
'doubleValue': 0.0,
'integerValue': 1948,
'longValue': 0,
},
{
'name': 'MEMORY',
'type': 'INTEGER',
'doubleValue': 0.0,
'integerValue': 3668,
'longValue': 0,
},
{
'name': 'PORTS',
'type': 'STRINGSET',
'doubleValue': 0.0,
'integerValue': 0,
'longValue': 0,
'stringSetValue': [
'2376',
'22',
'80',
'51678',
'2375',
],
},
],
'runningTasksCount': 1,
'status': 'ACTIVE',
},
],
'failures': [
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified services running in your cluster.
See also: AWS API Documentation
Request Syntax
response = client.describe_services(
cluster='string',
services=[
'string',
],
include=[
'TAGS',
]
)
[REQUIRED]
A list of services to describe. You may specify up to 10 services to describe in a single operation.
Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
dict
Response Syntax
{
'services': [
{
'serviceArn': 'string',
'serviceName': 'string',
'clusterArn': 'string',
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'status': 'string',
'desiredCount': 123,
'runningCount': 123,
'pendingCount': 123,
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'startedBy': 'string',
'externalId': 'string',
'status': 'string',
'taskDefinition': 'string',
'computedDesiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
},
],
'deployments': [
{
'id': 'string',
'status': 'string',
'taskDefinition': 'string',
'desiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
}
},
],
'roleArn': 'string',
'events': [
{
'id': 'string',
'createdAt': datetime(2015, 1, 1),
'message': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'placementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'placementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'healthCheckGracePeriodSeconds': 123,
'schedulingStrategy': 'REPLICA'|'DAEMON',
'deploymentController': {
'type': 'ECS'|'CODE_DEPLOY'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'enableECSManagedTags': True|False,
'propagateTags': 'TASK_DEFINITION'|'SERVICE'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
services (list) --
The list of services described.
(dict) --
Details on a service within a cluster
serviceArn (string) --
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region :012345678910 :service/my-service `` .
serviceName (string) --
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers (list) --
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service .
port (integer) --
The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
containerName (string) --
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
containerPort (integer) --
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
status (string) --
The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
desiredCount (integer) --
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
runningCount (integer) --
The number of tasks in the cluster that are in the RUNNING state.
pendingCount (integer) --
The number of tasks in the cluster that are in the PENDING state.
launchType (string) --
The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
taskDefinition (string) --
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
deploymentConfiguration (dict) --
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
maximumPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the 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 maximum percent value is not used, although it is returned when describing your service.
minimumHealthyPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower 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 value is not used, although it is returned when describing your service.
taskSets (list) --
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.
(dict) --
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.
id (string) --
The ID of the task set.
taskSetArn (string) --
The Amazon Resource Name (ARN) of the task set.
startedBy (string) --
The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY .
externalId (string) --
The deployment ID of the AWS CodeDeploy deployment.
status (string) --
The status of the task set. The following describes each state:
PRIMARY
The task set is serving production traffic.
ACTIVE
The task set is not serving production traffic.
DRAINING
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
taskDefinition (string) --
The task definition the task set is using.
computedDesiredCount (integer) --
The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
pendingCount (integer) --
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
runningCount (integer) --
The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
createdAt (datetime) --
The Unix timestamp for when the task set was created.
updatedAt (datetime) --
The Unix timestamp for when the task set was last updated.
launchType (string) --
The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The network configuration for the task set.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
loadBalancers (list) --
Details on a load balancer that is used with a task set.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the service.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set.
unit (string) --
The unit of measure for the scale value.
stabilityStatus (string) --
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE :
If any of those conditions are not met, the stability status returns STABILIZING .
stabilityStatusAt (datetime) --
The Unix timestamp for when the task set stability status was retrieved.
deployments (list) --
The current state of deployments for the service.
(dict) --
The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.
id (string) --
The ID of the deployment.
status (string) --
The status of the deployment. The following describes each state:
PRIMARY
The most recent deployment of a service.
ACTIVE
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
INACTIVE
A deployment that has been completely replaced.
taskDefinition (string) --
The most recent task definition that was specified for the tasks in the service to use.
desiredCount (integer) --
The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount (integer) --
The number of tasks in the deployment that are in the PENDING status.
runningCount (integer) --
The number of tasks in the deployment that are in the RUNNING status.
createdAt (datetime) --
The Unix timestamp for when the service deployment was created.
updatedAt (datetime) --
The Unix timestamp for when the service deployment was last updated.
launchType (string) --
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
roleArn (string) --
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
events (list) --
The event stream for your service. A maximum of 100 of the latest events are displayed.
(dict) --
Details on an event associated with a service.
id (string) --
The ID string of the event.
createdAt (datetime) --
The Unix timestamp for when the event was triggered.
message (string) --
The event message.
createdAt (datetime) --
The Unix timestamp for when the service was created.
placementConstraints (list) --
The placement constraints for the tasks in the service.
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
expression (string) --
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
placementStrategy (list) --
The placement strategy that determines how tasks for the service are placed.
(dict) --
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
healthCheckGracePeriodSeconds (integer) --
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
schedulingStrategy (string) --
The scheduling strategy to use for the service. For more information, see Services .
There are two service scheduler strategies available:
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using.
type (string) --
The deployment controller type to use.
There are two deployment controller types available:
ECS
The rolling update (ECS ) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration .
CODE_DEPLOY
The blue/green (CODE_DEPLOY ) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
tags (list) --
The metadata that you apply to the service 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
createdBy (string) --
The principal that created the service.
enableECSManagedTags (boolean) --
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
propagateTags (string) --
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Examples
This example provides descriptive information about the service named ecs-simple-service.
response = client.describe_services(
services=[
'ecs-simple-service',
],
)
print(response)
Expected Output:
{
'failures': [
],
'services': [
{
'clusterArn': 'arn:aws:ecs:us-east-1:012345678910:cluster/default',
'createdAt': datetime(2016, 8, 29, 16, 25, 52, 0, 242, 0),
'deploymentConfiguration': {
'maximumPercent': 200,
'minimumHealthyPercent': 100,
},
'deployments': [
{
'createdAt': datetime(2016, 8, 29, 16, 25, 52, 0, 242, 0),
'desiredCount': 1,
'id': 'ecs-svc/9223370564341623665',
'pendingCount': 0,
'runningCount': 0,
'status': 'PRIMARY',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
'updatedAt': datetime(2016, 8, 29, 16, 25, 52, 0, 242, 0),
},
],
'desiredCount': 1,
'events': [
{
'createdAt': datetime(2016, 8, 29, 16, 25, 58, 0, 242, 0),
'id': '38c285e5-d335-4b68-8b15-e46dedc8e88d',
# In this example, there is a service event that shows unavailable cluster resources.
'message': '(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide.',
},
],
'loadBalancers': [
],
'pendingCount': 0,
'runningCount': 0,
'serviceArn': 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service',
'serviceName': 'ecs-simple-service',
'status': 'ACTIVE',
'taskDefinition': 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
},
],
'ResponseMetadata': {
'...': '...',
},
}
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.
Note
You can only describe INACTIVE task definitions while an active task or service references them.
See also: AWS API Documentation
Request Syntax
response = client.describe_task_definition(
taskDefinition='string',
include=[
'TAGS',
]
)
[REQUIRED]
The family for the latest ACTIVE revision, family and revision (family:revision ) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.
Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
dict
Response Syntax
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'repositoryCredentials': {
'credentialsParameter': 'string'
},
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'links': [
'string',
],
'portMappings': [
{
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'essential': True|False,
'entryPoint': [
'string',
],
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'sourceVolume': 'string',
'containerPath': 'string',
'readOnly': True|False
},
],
'volumesFrom': [
{
'sourceContainer': 'string',
'readOnly': True|False
},
],
'linuxParameters': {
'capabilities': {
'add': [
'string',
],
'drop': [
'string',
]
},
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'read'|'write'|'mknod',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
],
'hostname': 'string',
'user': 'string',
'workingDirectory': 'string',
'disableNetworking': True|False,
'privileged': True|False,
'readonlyRootFilesystem': True|False,
'dnsServers': [
'string',
],
'dnsSearchDomains': [
'string',
],
'extraHosts': [
{
'hostname': 'string',
'ipAddress': 'string'
},
],
'dockerSecurityOptions': [
'string',
],
'interactive': True|False,
'pseudoTerminal': True|False,
'dockerLabels': {
'string': 'string'
},
'ulimits': [
{
'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
'softLimit': 123,
'hardLimit': 123
},
],
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
}
},
'healthCheck': {
'command': [
'string',
],
'interval': 123,
'timeout': 123,
'retries': 123,
'startPeriod': 123
},
'systemControls': [
{
'namespace': 'string',
'value': 'string'
},
],
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'family': 'string',
'taskRoleArn': 'string',
'executionRoleArn': 'string',
'networkMode': 'bridge'|'host'|'awsvpc'|'none',
'revision': 123,
'volumes': [
{
'name': 'string',
'host': {
'sourcePath': 'string'
},
'dockerVolumeConfiguration': {
'scope': 'task'|'shared',
'autoprovision': True|False,
'driver': 'string',
'driverOpts': {
'string': 'string'
},
'labels': {
'string': 'string'
}
}
},
],
'status': 'ACTIVE'|'INACTIVE',
'requiresAttributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'placementConstraints': [
{
'type': 'memberOf',
'expression': 'string'
},
],
'compatibilities': [
'EC2'|'FARGATE',
],
'requiresCompatibilities': [
'EC2'|'FARGATE',
],
'cpu': 'string',
'memory': 'string',
'pidMode': 'host'|'task',
'ipcMode': 'host'|'task'|'none'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
taskDefinition (dict) --
The full task definition description.
taskDefinitionArn (string) --
The full Amazon Resource Name (ARN) of the task definition.
containerDefinitions (list) --
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
(dict) --
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
name (string) --
The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run .
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either `` repository-url /image :tag `` or `` repository-url /image @*digest* `` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .
repositoryCredentials (dict) --
The private repository authentication credentials to use.
credentialsParameter (string) --
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
cpu (integer) --
The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run .
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
Note
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
memory (integer) --
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run .
If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.
For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run .
You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge . The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ . This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to ` docker run https://docs.docker.com/engine/reference/commandline/run/`__ .
Note
This parameter is not supported for Windows containers.
Warning
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
portMappings (list) --
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only specify the containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
Port mappings on Windows use the NetNAT gateway address rather than localhost . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to none , then you can't specify port mappings. If the network mode of a task definition is set to host , then host ports must either be undefined or they must match the container port in the port mapping.
Note
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
(dict) --
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 awsvpc or host network mode, exposed ports should be specified using containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
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.
containerPort (integer) --
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort .
If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort . Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
hostPort (integer) --
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort .
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
Note
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.
protocol (string) --
The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .
essential (boolean) --
If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false , then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .
entryPoint (list) --
Warning
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint .
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd . If there are multiple arguments, each argument should be a separated string in the array.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run .
Warning
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
(dict) --
Details on a volume mount point that is used in a container definition.
sourceVolume (string) --
The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume .
containerPath (string) --
The path on the container to mount the host volume at.
readOnly (boolean) --
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
volumesFrom (list) --
Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run .
(dict) --
Details on a data volume from another container in the same task definition.
sourceContainer (string) --
The name of another container within the same task definition from which to mount volumes.
readOnly (boolean) --
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities .
Note
This parameter is not supported for Windows containers.
capabilities (dict) --
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note
If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.
add (list) --
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run .
Note
If you are using tasks that use the Fargate launch type, the add parameter is not supported.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
drop (list) --
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run .
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .
Note
If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which to expose the host device.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read , write , and mknod for the device.
initProcessEnabled (boolean) --
Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run .
Note
If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .
Note
If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path where the tmpfs volume is to be mounted.
size (integer) --
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
secrets (list) --
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide .
(dict) --
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 .
name (string) --
The value to set as the environment variable on the container.
valueFrom (string) --
The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
hostname (string) --
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run .
Note
The hostname parameter is not supported if you are using the awsvpc network mode.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
Note
This parameter is not supported for Windows containers.
workingDirectory (string) --
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run .
disableNetworking (boolean) --
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API .
Note
This parameter is not supported for Windows containers.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
Note
This parameter is not supported for Windows containers.
dnsServers (list) --
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run .
Note
This parameter is not supported for Windows containers.
dnsSearchDomains (list) --
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run .
Note
This parameter is not supported for Windows containers.
extraHosts (list) --
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run .
Note
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
(dict) --
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition .
hostname (string) --
The hostname to use in the /etc/hosts entry.
ipAddress (string) --
The IP address to use in the /etc/hosts entry.
dockerSecurityOptions (list) --
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run .
Note
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
This parameter is not supported for Windows containers.
interactive (boolean) --
When this parameter is true , this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run .
pseudoTerminal (boolean) --
When this parameter is true , a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run .
dockerLabels (dict) --
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run . Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
This parameter is not supported for Windows containers.
(dict) --
The ulimit settings to pass to the container.
name (string) --
The type of the ulimit .
softLimit (integer) --
The soft limit for the ulimit type.
hardLimit (integer) --
The hard limit for the ulimit type.
logConfiguration (dict) --
The log configuration specification for the container.
If you are using the Fargate launch type, the only supported value is awslogs .
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run . By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Note
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
logDriver (string) --
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs . For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide .
Note
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
healthCheck (dict) --
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run .
command (list) --
A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API .
interval (integer) --
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
timeout (integer) --
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
retries (integer) --
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
startPeriod (integer) --
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
Note
If a health check succeeds within the startPeriod , then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
systemControls (list) --
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
Note
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
(dict) --
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:
namespace (string) --
The namespaced kernel parameter for which to set a value .
value (string) --
The value for the namespaced kernel parameter specified in namespace .
resourceRequirements (list) --
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
(dict) --
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
value (string) --
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
type (string) --
The type of resource to assign to a container. The only supported value is GPU .
family (string) --
The family of your task definition, used as the definition name.
taskRoleArn (string) --
The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
networkMode (string) --
The Docker networking mode to use for the containers in the task. The valid values are none , bridge , awsvpc , and host . The default Docker network mode is bridge . If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc , the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value 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 .
Note
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference .
revision (integer) --
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 . Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
volumes (list) --
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
(dict) --
A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration . For tasks that use a bind mount host volume, specify a host and optional sourcePath . For more information, see Using Data Volumes in Tasks .
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints .
host (dict) --
This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or D:\:C:\my\path .
sourcePath (string) --
When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is not supported.
dockerVolumeConfiguration (dict) --
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 local driver. To use bind mounts, specify a host instead.
scope (string) --
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision (boolean) --
If this value is true , the Docker volume is created if it does not already exist.
Note
This field is only used if the scope is shared .
driver (string) --
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery . This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
driverOpts (dict) --
A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
labels (dict) --
Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
status (string) --
The status of the task definition.
requiresAttributes (list) --
The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
placementConstraints (list) --
An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
(dict) --
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 .
type (string) --
The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
expression (string) --
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
compatibilities (list) --
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
requiresCompatibilities (list) --
The launch type that the task is using.
cpu (string) --
The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
memory (string) --
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
pidMode (string) --
The process namespace to use for the containers in the task. The valid values are host or task . If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference .
If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
ipcMode (string) --
The IPC resource namespace to use for the containers in the task. The valid values are host , task , or none . If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference .
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
tags (list) --
The metadata that is applied to the task definition 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Examples
This example provides a description of the specified task definition.
response = client.describe_task_definition(
taskDefinition='hello_world:8',
)
print(response)
Expected Output:
{
'taskDefinition': {
'containerDefinitions': [
{
'name': 'wordpress',
'cpu': 10,
'environment': [
],
'essential': True,
'image': 'wordpress',
'links': [
'mysql',
],
'memory': 500,
'mountPoints': [
],
'portMappings': [
{
'containerPort': 80,
'hostPort': 80,
},
],
'volumesFrom': [
],
},
{
'name': 'mysql',
'cpu': 10,
'environment': [
{
'name': 'MYSQL_ROOT_PASSWORD',
'value': 'password',
},
],
'essential': True,
'image': 'mysql',
'memory': 500,
'mountPoints': [
],
'portMappings': [
],
'volumesFrom': [
],
},
],
'family': 'hello_world',
'revision': 8,
'taskDefinitionArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8',
'volumes': [
],
},
'ResponseMetadata': {
'...': '...',
},
}
Describes a specified task or tasks.
See also: AWS API Documentation
Request Syntax
response = client.describe_tasks(
cluster='string',
tasks=[
'string',
],
include=[
'TAGS',
]
)
[REQUIRED]
A list of up to 100 task IDs or full ARN entries.
Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'taskRoleArn': 'string',
'executionRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'cpu': 'string',
'memory': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'networkInterfaces': [
{
'attachmentId': 'string',
'privateIpv4Address': 'string',
'ipv6Address': 'string'
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'cpu': 'string',
'memory': 'string',
'memoryReservation': 'string',
'gpuIds': [
'string',
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'executionStoppedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppingAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string',
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
The list of tasks.
(dict) --
Details on a task in a cluster.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
resourceRequirements (list) --
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
(dict) --
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
value (string) --
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
type (string) --
The type of resource to assign to a container. The only supported value is GPU .
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
cpu (string) --
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024 . It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu . String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
memory (string) --
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024 . It can also be expressed as a string using GB, for example 1GB or 1 GB . String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The ARN of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
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.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
networkInterfaces (list) --
The network interfaces associated with the container.
(dict) --
An object representing the elastic network interface for tasks that use the awsvpc network mode.
attachmentId (string) --
The attachment ID for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
healthStatus (string) --
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN .
cpu (string) --
The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.
memory (string) --
The hard limit (in MiB) of memory set for the container.
memoryReservation (string) --
The soft limit (in MiB) of memory set for the container.
gpuIds (list) --
The IDs of each GPU assigned to the container.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason that the task was stopped.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
launchType (string) --
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
attachments (list) --
The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
healthStatus (string) --
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY , then the task status also reports as HEALTHY . If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN , then the task status also reports as UNHEALTHY or UNKNOWN , accordingly.
Note
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
tags (list) --
The metadata that you apply to the task 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Examples
This example provides a description of the specified task, using the task UUID as an identifier.
response = client.describe_tasks(
tasks=[
'c5cba4eb-5dad-405e-96db-71ef8eefe6a8',
],
)
print(response)
Expected Output:
{
'failures': [
],
'tasks': [
{
'clusterArn': 'arn:aws:ecs:<region>:<aws_account_id>:cluster/default',
'containerInstanceArn': 'arn:aws:ecs:<region>:<aws_account_id>:container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb',
'containers': [
{
'name': 'ecs-demo',
'containerArn': 'arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6',
'lastStatus': 'RUNNING',
'networkBindings': [
{
'bindIP': '0.0.0.0',
'containerPort': 80,
'hostPort': 80,
},
],
'taskArn': 'arn:aws:ecs:<region>:<aws_account_id>:task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8',
},
],
'desiredStatus': 'RUNNING',
'lastStatus': 'RUNNING',
'overrides': {
'containerOverrides': [
{
'name': 'ecs-demo',
},
],
},
'startedBy': 'ecs-svc/9223370608528463088',
'taskArn': 'arn:aws:ecs:<region>:<aws_account_id>:task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8',
'taskDefinitionArn': 'arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.discover_poll_endpoint(
containerInstance='string',
cluster='string'
)
dict
Response Syntax
{
'endpoint': 'string',
'telemetryEndpoint': 'string'
}
Response Structure
(dict) --
endpoint (string) --
The endpoint for the Amazon ECS agent to poll.
telemetryEndpoint (string) --
The telemetry endpoint for the Amazon ECS agent.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists the account settings for an Amazon ECS resource for a specified principal.
See also: AWS API Documentation
Request Syntax
response = client.list_account_settings(
name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
value='string',
principalArn='string',
effectiveSettings=True|False,
nextToken='string',
maxResults=123
)
The nextToken value returned from a previous paginated ListAccountSettings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'settings': [
{
'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
'value': 'string',
'principalArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
settings (list) --
The account settings for the resource.
(dict) --
The current account setting for a resource.
name (string) --
The account resource name.
value (string) --
The current account setting for the resource name. If enabled , then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled , then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
principalArn (string) --
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
nextToken (string) --
The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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 ).
See also: AWS API Documentation
Request Syntax
response = client.list_attributes(
cluster='string',
targetType='container-instance',
attributeName='string',
attributeValue='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The type of the target with which to list attributes.
The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
attributes (list) --
A list of attribute objects that meet the criteria of the request.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
nextToken (string) --
The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Returns a list of existing clusters.
See also: AWS API Documentation
Request Syntax
response = client.list_clusters(
nextToken='string',
maxResults=123
)
The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'clusterArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
clusterArns (list) --
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
nextToken (string) --
The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example lists all of your available clusters in your default region.
response = client.list_clusters(
)
print(response)
Expected Output:
{
'clusterArns': [
'arn:aws:ecs:us-east-1:<aws_account_id>:cluster/test',
'arn:aws:ecs:us-east-1:<aws_account_id>:cluster/default',
],
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances 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 .
See also: AWS API Documentation
Request Syntax
response = client.list_container_instances(
cluster='string',
filter='string',
nextToken='string',
maxResults=123,
status='ACTIVE'|'DRAINING'
)
The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'containerInstanceArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
containerInstanceArns (list) --
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
nextToken (string) --
The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example lists all of your available container instances in the specified cluster in your default region.
response = client.list_container_instances(
cluster='default',
)
print(response)
Expected Output:
{
'containerInstanceArns': [
'arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f',
'arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb',
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the services that are running in a specified cluster.
See also: AWS API Documentation
Request Syntax
response = client.list_services(
cluster='string',
nextToken='string',
maxResults=123,
launchType='EC2'|'FARGATE',
schedulingStrategy='REPLICA'|'DAEMON'
)
The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'serviceArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
serviceArns (list) --
The list of full ARN entries for each service associated with the specified cluster.
nextToken (string) --
The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example lists the services running in the default cluster for an account.
response = client.list_services(
)
print(response)
Expected Output:
{
'serviceArns': [
'arn:aws:ecs:us-east-1:012345678910:service/my-http-service',
],
'ResponseMetadata': {
'...': '...',
},
}
List the tags for an Amazon ECS resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
The tags for the resource.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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).
You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE . You can also filter the results with the familyPrefix parameter.
See also: AWS API Documentation
Request Syntax
response = client.list_task_definition_families(
familyPrefix='string',
status='ACTIVE'|'INACTIVE'|'ALL',
nextToken='string',
maxResults=123
)
The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'families': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
families (list) --
The list of task definition family names that match the ListTaskDefinitionFamilies request.
nextToken (string) --
The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example lists all of your registered task definition families.
response = client.list_task_definition_families(
)
print(response)
Expected Output:
{
'families': [
'node-js-app',
'web-timer',
'hpcc',
'hpcc-c4-8xlarge',
],
'ResponseMetadata': {
'...': '...',
},
}
This example lists the task definition revisions that start with "hpcc".
response = client.list_task_definition_families(
familyPrefix='hpcc',
)
print(response)
Expected Output:
{
'families': [
'hpcc',
'hpcc-c4-8xlarge',
],
'ResponseMetadata': {
'...': '...',
},
}
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.
See also: AWS API Documentation
Request Syntax
response = client.list_task_definitions(
familyPrefix='string',
status='ACTIVE'|'INACTIVE',
sort='ASC'|'DESC',
nextToken='string',
maxResults=123
)
The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'taskDefinitionArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
taskDefinitionArns (list) --
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.
nextToken (string) --
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example lists all of your registered task definitions.
response = client.list_task_definitions(
)
print(response)
Expected Output:
{
'taskDefinitionArns': [
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6',
],
'ResponseMetadata': {
'...': '...',
},
}
This example lists the task definition revisions of a specified family.
response = client.list_task_definitions(
familyPrefix='wordpress',
)
print(response)
Expected Output:
{
'taskDefinitionArns': [
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5',
'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6',
],
'ResponseMetadata': {
'...': '...',
},
}
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.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
See also: AWS API Documentation
Request Syntax
response = client.list_tasks(
cluster='string',
containerInstance='string',
family='string',
nextToken='string',
maxResults=123,
startedBy='string',
serviceName='string',
desiredStatus='RUNNING'|'PENDING'|'STOPPED',
launchType='EC2'|'FARGATE'
)
The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED . This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING , which shows tasks that Amazon ECS has set the desired status to RUNNING .
Note
Although you can filter results based on a desired status of PENDING , this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING ).
dict
Response Syntax
{
'taskArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
taskArns (list) --
The list of task ARN entries for the ListTasks request.
nextToken (string) --
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example lists all of the tasks in a cluster.
response = client.list_tasks(
cluster='default',
)
print(response)
Expected Output:
{
'taskArns': [
'arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84',
'arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1',
],
'ResponseMetadata': {
'...': '...',
},
}
This example lists the tasks of a specified container instance. Specifying a containerInstance value limits the results to tasks that belong to that container instance.
response = client.list_tasks(
cluster='default',
containerInstance='f6bbb147-5370-4ace-8c73-c7181ded911f',
)
print(response)
Expected Output:
{
'taskArns': [
'arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84',
],
'ResponseMetadata': {
'...': '...',
},
}
Modifies the ARN and resource ID format of a resource type for a specified IAM user, IAM role, or the root user for an account. If the account setting for the root user is changed, it sets the default setting for all of the IAM users and roles for which no individual account setting has been set. The opt-in and opt-out account setting can 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. Enabling this setting is required to use new Amazon ECS features such as resource tagging. For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_account_setting(
name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
value='string',
principalArn='string'
)
[REQUIRED]
The resource name for which to enable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.
[REQUIRED]
The account setting value for the specified principal ARN. Accepted values are enabled and disabled .
dict
Response Syntax
{
'setting': {
'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
'value': 'string',
'principalArn': 'string'
}
}
Response Structure
(dict) --
setting (dict) --
The current account setting for a resource.
name (string) --
The account resource name.
value (string) --
The current account setting for the resource name. If enabled , then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled , then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
principalArn (string) --
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
Modifies the ARN and resource ID format of a resource type for all IAM users on an account for which no individual account setting has been set. Enabling this setting is required to use new Amazon ECS features such as resource tagging.
See also: AWS API Documentation
Request Syntax
response = client.put_account_setting_default(
name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
value='string'
)
[REQUIRED]
The resource type to enable the new format for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks are affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances are affected.
[REQUIRED]
The account setting value for the specified principal ARN. Accepted values are enabled and disabled .
dict
Response Syntax
{
'setting': {
'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
'value': 'string',
'principalArn': 'string'
}
}
Response Structure
(dict) --
setting (dict) --
The current account setting for a resource.
name (string) --
The account resource name.
value (string) --
The current account setting for the resource name. If enabled , then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled , then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
principalArn (string) --
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
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, use DeleteAttributes . For more information, see Attributes in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_attributes(
cluster='string',
attributes=[
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
]
)
[REQUIRED]
The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
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 .
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
dict
Response Syntax
{
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
]
}
Response Structure
(dict) --
attributes (list) --
The attributes applied to your resource.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.register_container_instance(
cluster='string',
instanceIdentityDocument='string',
instanceIdentityDocumentSignature='string',
totalResources=[
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
versionInfo={
'agentVersion': 'string',
'agentHash': 'string',
'dockerVersion': 'string'
},
containerInstanceArn='string',
attributes=[
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
platformDevices=[
{
'id': 'string',
'type': 'GPU'
},
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
The resources available on the instance.
Describes the resources available for a container instance.
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
When the integerValue type is set, the value of the resource must be an integer.
When the stringSetValue type is set, the value of the resource must be a string type.
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
The version number of the Amazon ECS container agent.
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
The Docker version running on the container instance.
The container instance attributes that this container instance supports.
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 .
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
The devices that are available on the container instance. The only supported device type is a GPU.
The devices that are available on the container instance. The only supported device type is a GPU.
The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The type of device that is available on the container instance. The only supported value is GPU .
The metadata that you apply to the container instance 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.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'containerInstance': {
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'version': 123,
'versionInfo': {
'agentVersion': 'string',
'agentHash': 'string',
'dockerVersion': 'string'
},
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'registeredAt': datetime(2015, 1, 1),
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
containerInstance (dict) --
The container instance that was registered.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID `` .
ec2InstanceId (string) --
The EC2 instance ID of the container instance.
version (integer) --
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
versionInfo (dict) --
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion (string) --
The version number of the Amazon ECS container agent.
agentHash (string) --
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion (string) --
The Docker version running on the container instance.
remainingResources (list) --
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
registeredResources (list) --
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
status (string) --
The status of the container instance. The valid values are ACTIVE , INACTIVE , or DRAINING . ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide .
agentConnected (boolean) --
This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false . Only instances connected to an agent can accept placement requests.
runningTasksCount (integer) --
The number of tasks on the container instance that are in the RUNNING status.
pendingTasksCount (integer) --
The number of tasks on the container instance that are in the PENDING status.
agentUpdateStatus (string) --
The status of the most recent agent update. If an update has never been requested, this value is NULL .
attributes (list) --
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt (datetime) --
The Unix timestamp for when the container instance was registered.
attachments (list) --
The elastic network interfaces associated with the container instance.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the container instance 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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 .
You can specify a Docker networking mode for the containers in your task definition with the 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 .
See also: AWS API Documentation
Request Syntax
response = client.register_task_definition(
family='string',
taskRoleArn='string',
executionRoleArn='string',
networkMode='bridge'|'host'|'awsvpc'|'none',
containerDefinitions=[
{
'name': 'string',
'image': 'string',
'repositoryCredentials': {
'credentialsParameter': 'string'
},
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'links': [
'string',
],
'portMappings': [
{
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'essential': True|False,
'entryPoint': [
'string',
],
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'sourceVolume': 'string',
'containerPath': 'string',
'readOnly': True|False
},
],
'volumesFrom': [
{
'sourceContainer': 'string',
'readOnly': True|False
},
],
'linuxParameters': {
'capabilities': {
'add': [
'string',
],
'drop': [
'string',
]
},
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'read'|'write'|'mknod',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
],
'hostname': 'string',
'user': 'string',
'workingDirectory': 'string',
'disableNetworking': True|False,
'privileged': True|False,
'readonlyRootFilesystem': True|False,
'dnsServers': [
'string',
],
'dnsSearchDomains': [
'string',
],
'extraHosts': [
{
'hostname': 'string',
'ipAddress': 'string'
},
],
'dockerSecurityOptions': [
'string',
],
'interactive': True|False,
'pseudoTerminal': True|False,
'dockerLabels': {
'string': 'string'
},
'ulimits': [
{
'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
'softLimit': 123,
'hardLimit': 123
},
],
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
}
},
'healthCheck': {
'command': [
'string',
],
'interval': 123,
'timeout': 123,
'retries': 123,
'startPeriod': 123
},
'systemControls': [
{
'namespace': 'string',
'value': 'string'
},
],
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
volumes=[
{
'name': 'string',
'host': {
'sourcePath': 'string'
},
'dockerVolumeConfiguration': {
'scope': 'task'|'shared',
'autoprovision': True|False,
'driver': 'string',
'driverOpts': {
'string': 'string'
},
'labels': {
'string': 'string'
}
}
},
],
placementConstraints=[
{
'type': 'memberOf',
'expression': 'string'
},
],
requiresCompatibilities=[
'EC2'|'FARGATE',
],
cpu='string',
memory='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
pidMode='host'|'task',
ipcMode='host'|'task'|'none'
)
[REQUIRED]
You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
The Docker networking mode to use for the containers in the task. The valid values are none , bridge , awsvpc , and host . The default Docker network mode is bridge . If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc , the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value 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 .
Note
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference .
[REQUIRED]
A list of container definitions in JSON format that describe the different containers that make up your task.
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run .
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either `` repository-url /image :tag `` or `` repository-url /image @*digest* `` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .
The private repository authentication credentials to use.
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run .
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
Note
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run .
If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.
For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run .
You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge . The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ . This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to ` docker run https://docs.docker.com/engine/reference/commandline/run/`__ .
Note
This parameter is not supported for Windows containers.
Warning
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only specify the containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
Port mappings on Windows use the NetNAT gateway address rather than localhost . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to none , then you can't specify port mappings. If the network mode of a task definition is set to host , then host ports must either be undefined or they must match the container port in the port mapping.
Note
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
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 awsvpc or host network mode, exposed ports should be specified using containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
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.
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort .
If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort . Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort .
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
Note
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.
The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .
If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false , then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .
Warning
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint .
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd . If there are multiple arguments, each argument should be a separated string in the array.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run .
Warning
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
A key-value pair object.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
The value of the key-value pair. For environment variables, this is the value of the environment variable.
The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
Details on a volume mount point that is used in a container definition.
The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume .
The path on the container to mount the host volume at.
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run .
Details on a data volume from another container in the same task definition.
The name of another container within the same task definition from which to mount volumes.
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities .
Note
This parameter is not supported for Windows containers.
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note
If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run .
Note
If you are using tasks that use the Fargate launch type, the add parameter is not supported.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run .
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .
Note
If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
An object representing a container instance host device.
The path for the device on the host container instance.
The path inside the container at which to expose the host device.
The explicit permissions to provide to the container for the device. By default, the container has permissions for read , write , and mknod for the device.
Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run .
Note
If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .
Note
If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
The container path, mount options, and size of the tmpfs mount.
The absolute file path where the tmpfs volume is to be mounted.
The size (in MiB) of the tmpfs volume.
The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide .
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 .
The value to set as the environment variable on the container.
The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run .
Note
The hostname parameter is not supported if you are using the awsvpc network mode.
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
Note
This parameter is not supported for Windows containers.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run .
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API .
Note
This parameter is not supported for Windows containers.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
Note
This parameter is not supported for Windows containers.
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run .
Note
This parameter is not supported for Windows containers.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run .
Note
This parameter is not supported for Windows containers.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run .
Note
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition .
The hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run .
Note
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
This parameter is not supported for Windows containers.
When this parameter is true , this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run .
When this parameter is true , a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run .
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run . Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
This parameter is not supported for Windows containers.
The ulimit settings to pass to the container.
The type of the ulimit .
The soft limit for the ulimit type.
The hard limit for the ulimit type.
The log configuration specification for the container.
If you are using the Fargate launch type, the only supported value is awslogs .
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run . By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Note
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs . For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide .
Note
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run .
A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API .
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
Note
If a health check succeeds within the startPeriod , then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
Note
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:
The namespaced kernel parameter for which to set a value .
The value for the namespaced kernel parameter specified in namespace .
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
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
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
The type of resource to assign to a container. The only supported value is GPU .
A list of volume definitions in JSON format that containers in your task may use.
A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration . For tasks that use a bind mount host volume, specify a host and optional sourcePath . For more information, see Using Data Volumes in Tasks .
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints .
This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or D:\:C:\my\path .
When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is not supported.
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 local driver. To use bind mounts, specify a host instead.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
If this value is true , the Docker volume is created if it does not already exist.
Note
This field is only used if the scope is shared .
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery . This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
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 type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
The launch type required by the task. If no value is specified, it defaults to EC2 .
The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024 , or as a string using vCPUs, for example 1 vCPU or 1 vcpu , in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Note
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024 , or as a string using GB, for example 1GB or 1 GB , in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Note
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
The metadata that you apply to the task definition 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.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
The process namespace to use for the containers in the task. The valid values are host or task . If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference .
If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The IPC resource namespace to use for the containers in the task. The valid values are host , task , or none . If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference .
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
dict
Response Syntax
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'repositoryCredentials': {
'credentialsParameter': 'string'
},
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'links': [
'string',
],
'portMappings': [
{
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'essential': True|False,
'entryPoint': [
'string',
],
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'sourceVolume': 'string',
'containerPath': 'string',
'readOnly': True|False
},
],
'volumesFrom': [
{
'sourceContainer': 'string',
'readOnly': True|False
},
],
'linuxParameters': {
'capabilities': {
'add': [
'string',
],
'drop': [
'string',
]
},
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'read'|'write'|'mknod',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
],
'hostname': 'string',
'user': 'string',
'workingDirectory': 'string',
'disableNetworking': True|False,
'privileged': True|False,
'readonlyRootFilesystem': True|False,
'dnsServers': [
'string',
],
'dnsSearchDomains': [
'string',
],
'extraHosts': [
{
'hostname': 'string',
'ipAddress': 'string'
},
],
'dockerSecurityOptions': [
'string',
],
'interactive': True|False,
'pseudoTerminal': True|False,
'dockerLabels': {
'string': 'string'
},
'ulimits': [
{
'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
'softLimit': 123,
'hardLimit': 123
},
],
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
}
},
'healthCheck': {
'command': [
'string',
],
'interval': 123,
'timeout': 123,
'retries': 123,
'startPeriod': 123
},
'systemControls': [
{
'namespace': 'string',
'value': 'string'
},
],
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'family': 'string',
'taskRoleArn': 'string',
'executionRoleArn': 'string',
'networkMode': 'bridge'|'host'|'awsvpc'|'none',
'revision': 123,
'volumes': [
{
'name': 'string',
'host': {
'sourcePath': 'string'
},
'dockerVolumeConfiguration': {
'scope': 'task'|'shared',
'autoprovision': True|False,
'driver': 'string',
'driverOpts': {
'string': 'string'
},
'labels': {
'string': 'string'
}
}
},
],
'status': 'ACTIVE'|'INACTIVE',
'requiresAttributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'placementConstraints': [
{
'type': 'memberOf',
'expression': 'string'
},
],
'compatibilities': [
'EC2'|'FARGATE',
],
'requiresCompatibilities': [
'EC2'|'FARGATE',
],
'cpu': 'string',
'memory': 'string',
'pidMode': 'host'|'task',
'ipcMode': 'host'|'task'|'none'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
taskDefinition (dict) --
The full description of the registered task definition.
taskDefinitionArn (string) --
The full Amazon Resource Name (ARN) of the task definition.
containerDefinitions (list) --
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
(dict) --
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
name (string) --
The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run .
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either `` repository-url /image :tag `` or `` repository-url /image @*digest* `` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .
repositoryCredentials (dict) --
The private repository authentication credentials to use.
credentialsParameter (string) --
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
cpu (integer) --
The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run .
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
Note
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
memory (integer) --
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run .
If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.
For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run .
You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge . The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ . This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to ` docker run https://docs.docker.com/engine/reference/commandline/run/`__ .
Note
This parameter is not supported for Windows containers.
Warning
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
portMappings (list) --
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only specify the containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
Port mappings on Windows use the NetNAT gateway address rather than localhost . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to none , then you can't specify port mappings. If the network mode of a task definition is set to host , then host ports must either be undefined or they must match the container port in the port mapping.
Note
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
(dict) --
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 awsvpc or host network mode, exposed ports should be specified using containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
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.
containerPort (integer) --
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort .
If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort . Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
hostPort (integer) --
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort .
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
Note
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.
protocol (string) --
The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .
essential (boolean) --
If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false , then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .
entryPoint (list) --
Warning
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint .
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd . If there are multiple arguments, each argument should be a separated string in the array.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run .
Warning
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
(dict) --
Details on a volume mount point that is used in a container definition.
sourceVolume (string) --
The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume .
containerPath (string) --
The path on the container to mount the host volume at.
readOnly (boolean) --
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
volumesFrom (list) --
Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run .
(dict) --
Details on a data volume from another container in the same task definition.
sourceContainer (string) --
The name of another container within the same task definition from which to mount volumes.
readOnly (boolean) --
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities .
Note
This parameter is not supported for Windows containers.
capabilities (dict) --
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note
If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.
add (list) --
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run .
Note
If you are using tasks that use the Fargate launch type, the add parameter is not supported.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
drop (list) --
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run .
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .
Note
If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which to expose the host device.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read , write , and mknod for the device.
initProcessEnabled (boolean) --
Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run .
Note
If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .
Note
If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path where the tmpfs volume is to be mounted.
size (integer) --
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
secrets (list) --
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide .
(dict) --
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 .
name (string) --
The value to set as the environment variable on the container.
valueFrom (string) --
The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
hostname (string) --
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run .
Note
The hostname parameter is not supported if you are using the awsvpc network mode.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
Note
This parameter is not supported for Windows containers.
workingDirectory (string) --
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run .
disableNetworking (boolean) --
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API .
Note
This parameter is not supported for Windows containers.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
Note
This parameter is not supported for Windows containers.
dnsServers (list) --
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run .
Note
This parameter is not supported for Windows containers.
dnsSearchDomains (list) --
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run .
Note
This parameter is not supported for Windows containers.
extraHosts (list) --
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run .
Note
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
(dict) --
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition .
hostname (string) --
The hostname to use in the /etc/hosts entry.
ipAddress (string) --
The IP address to use in the /etc/hosts entry.
dockerSecurityOptions (list) --
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run .
Note
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
This parameter is not supported for Windows containers.
interactive (boolean) --
When this parameter is true , this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run .
pseudoTerminal (boolean) --
When this parameter is true , a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run .
dockerLabels (dict) --
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run . Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
This parameter is not supported for Windows containers.
(dict) --
The ulimit settings to pass to the container.
name (string) --
The type of the ulimit .
softLimit (integer) --
The soft limit for the ulimit type.
hardLimit (integer) --
The hard limit for the ulimit type.
logConfiguration (dict) --
The log configuration specification for the container.
If you are using the Fargate launch type, the only supported value is awslogs .
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run . By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Note
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Note
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
logDriver (string) --
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs . For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide .
Note
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
healthCheck (dict) --
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run .
command (list) --
A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API .
interval (integer) --
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
timeout (integer) --
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
retries (integer) --
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
startPeriod (integer) --
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
Note
If a health check succeeds within the startPeriod , then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
systemControls (list) --
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
Note
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
(dict) --
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run .
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:
namespace (string) --
The namespaced kernel parameter for which to set a value .
value (string) --
The value for the namespaced kernel parameter specified in namespace .
resourceRequirements (list) --
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
(dict) --
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
value (string) --
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
type (string) --
The type of resource to assign to a container. The only supported value is GPU .
family (string) --
The family of your task definition, used as the definition name.
taskRoleArn (string) --
The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
networkMode (string) --
The Docker networking mode to use for the containers in the task. The valid values are none , bridge , awsvpc , and host . The default Docker network mode is bridge . If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc , the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value 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 .
Note
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference .
revision (integer) --
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 . Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
volumes (list) --
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
(dict) --
A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration . For tasks that use a bind mount host volume, specify a host and optional sourcePath . For more information, see Using Data Volumes in Tasks .
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints .
host (dict) --
This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or D:\:C:\my\path .
sourcePath (string) --
When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is not supported.
dockerVolumeConfiguration (dict) --
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 local driver. To use bind mounts, specify a host instead.
scope (string) --
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision (boolean) --
If this value is true , the Docker volume is created if it does not already exist.
Note
This field is only used if the scope is shared .
driver (string) --
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery . This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
driverOpts (dict) --
A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
labels (dict) --
Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to ` docker volume create https://docs.docker.com/engine/reference/commandline/volume_create/`__ .
status (string) --
The status of the task definition.
requiresAttributes (list) --
The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
placementConstraints (list) --
An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
(dict) --
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 .
type (string) --
The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
expression (string) --
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
compatibilities (list) --
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
requiresCompatibilities (list) --
The launch type that the task is using.
cpu (string) --
The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
memory (string) --
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
pidMode (string) --
The process namespace to use for the containers in the task. The valid values are host or task . If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference .
If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
ipcMode (string) --
The IPC resource namespace to use for the containers in the task. The valid values are host , task , or none . If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference .
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide .
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
tags (list) --
The list of tags associated with the task definition.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Examples
This example registers a task definition to the specified family.
response = client.register_task_definition(
containerDefinitions=[
{
'name': 'sleep',
'command': [
'sleep',
'360',
],
'cpu': 10,
'essential': True,
'image': 'busybox',
'memory': 10,
},
],
family='sleep360',
taskRoleArn='',
volumes=[
],
)
print(response)
Expected Output:
{
'taskDefinition': {
'containerDefinitions': [
{
'name': 'sleep',
'command': [
'sleep',
'360',
],
'cpu': 10,
'environment': [
],
'essential': True,
'image': 'busybox',
'memory': 10,
'mountPoints': [
],
'portMappings': [
],
'volumesFrom': [
],
},
],
'family': 'sleep360',
'revision': 1,
'taskDefinitionArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:19',
'volumes': [
],
},
'ResponseMetadata': {
'...': '...',
},
}
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:
See also: AWS API Documentation
Request Syntax
response = client.run_task(
cluster='string',
taskDefinition='string',
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'taskRoleArn': 'string',
'executionRoleArn': 'string'
},
count=123,
startedBy='string',
group='string',
placementConstraints=[
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
placementStrategy=[
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
launchType='EC2'|'FARGATE',
platformVersion='string',
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
enableECSManagedTags=True|False,
propagateTags='TASK_DEFINITION'|'SERVICE'
)
[REQUIRED]
The family and revision (family:revision ) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
Note
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides sent to a task.
The overrides that should be sent to a container.
The name of the container that receives the override. This parameter is required if any override is specified.
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
A key-value pair object.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
The value of the key-value pair. For environment variables, this is the value of the environment variable.
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
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
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
The type of resource to assign to a container. The only supported value is GPU .
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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 type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
The metadata that you apply to the task 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.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
Note
An error will be received if you specify the SERVICE option when running a task.
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'taskRoleArn': 'string',
'executionRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'cpu': 'string',
'memory': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'networkInterfaces': [
{
'attachmentId': 'string',
'privateIpv4Address': 'string',
'ipv6Address': 'string'
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'cpu': 'string',
'memory': 'string',
'memoryReservation': 'string',
'gpuIds': [
'string',
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'executionStoppedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppingAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string',
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
(dict) --
Details on a task in a cluster.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
resourceRequirements (list) --
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
(dict) --
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
value (string) --
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
type (string) --
The type of resource to assign to a container. The only supported value is GPU .
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
cpu (string) --
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024 . It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu . String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
memory (string) --
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024 . It can also be expressed as a string using GB, for example 1GB or 1 GB . String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The ARN of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
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.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
networkInterfaces (list) --
The network interfaces associated with the container.
(dict) --
An object representing the elastic network interface for tasks that use the awsvpc network mode.
attachmentId (string) --
The attachment ID for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
healthStatus (string) --
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN .
cpu (string) --
The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.
memory (string) --
The hard limit (in MiB) of memory set for the container.
memoryReservation (string) --
The soft limit (in MiB) of memory set for the container.
gpuIds (list) --
The IDs of each GPU assigned to the container.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason that the task was stopped.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
launchType (string) --
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
attachments (list) --
The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
healthStatus (string) --
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY , then the task status also reports as HEALTHY . If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN , then the task status also reports as UNHEALTHY or UNKNOWN , accordingly.
Note
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
tags (list) --
The metadata that you apply to the task 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Examples
This example runs the specified task definition on your default cluster.
response = client.run_task(
cluster='default',
taskDefinition='sleep360:1',
)
print(response)
Expected Output:
{
'tasks': [
{
'containerInstanceArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb',
'containers': [
{
'name': 'sleep',
'containerArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:container/58591c8e-be29-4ddf-95aa-ee459d4c59fd',
'lastStatus': 'PENDING',
'taskArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0',
},
],
'desiredStatus': 'RUNNING',
'lastStatus': 'PENDING',
'overrides': {
'containerOverrides': [
{
'name': 'sleep',
},
],
},
'taskArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0',
'taskDefinitionArn': 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.start_task(
cluster='string',
taskDefinition='string',
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'taskRoleArn': 'string',
'executionRoleArn': 'string'
},
containerInstances=[
'string',
],
startedBy='string',
group='string',
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
enableECSManagedTags=True|False,
propagateTags='TASK_DEFINITION'|'SERVICE'
)
[REQUIRED]
The family and revision (family:revision ) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
Note
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides sent to a task.
The overrides that should be sent to a container.
The name of the container that receives the override. This parameter is required if any override is specified.
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
A key-value pair object.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
The value of the key-value pair. For environment variables, this is the value of the environment variable.
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
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
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
The type of resource to assign to a container. The only supported value is GPU .
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
[REQUIRED]
The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
The metadata that you apply to the task 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.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'taskRoleArn': 'string',
'executionRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'cpu': 'string',
'memory': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'networkInterfaces': [
{
'attachmentId': 'string',
'privateIpv4Address': 'string',
'ipv6Address': 'string'
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'cpu': 'string',
'memory': 'string',
'memoryReservation': 'string',
'gpuIds': [
'string',
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'executionStoppedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppingAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string',
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.
(dict) --
Details on a task in a cluster.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
resourceRequirements (list) --
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
(dict) --
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
value (string) --
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
type (string) --
The type of resource to assign to a container. The only supported value is GPU .
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
cpu (string) --
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024 . It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu . String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
memory (string) --
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024 . It can also be expressed as a string using GB, for example 1GB or 1 GB . String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The ARN of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
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.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
networkInterfaces (list) --
The network interfaces associated with the container.
(dict) --
An object representing the elastic network interface for tasks that use the awsvpc network mode.
attachmentId (string) --
The attachment ID for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
healthStatus (string) --
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN .
cpu (string) --
The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.
memory (string) --
The hard limit (in MiB) of memory set for the container.
memoryReservation (string) --
The soft limit (in MiB) of memory set for the container.
gpuIds (list) --
The IDs of each GPU assigned to the container.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason that the task was stopped.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
launchType (string) --
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
attachments (list) --
The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
healthStatus (string) --
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY , then the task status also reports as HEALTHY . If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN , then the task status also reports as UNHEALTHY or UNKNOWN , accordingly.
Note
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
tags (list) --
The metadata that you apply to the task 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
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.
Note
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.stop_task(
cluster='string',
task='string',
reason='string'
)
[REQUIRED]
The task ID or full ARN entry of the task to stop.
dict
Response Syntax
{
'task': {
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
]
},
],
'taskRoleArn': 'string',
'executionRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'cpu': 'string',
'memory': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'networkInterfaces': [
{
'attachmentId': 'string',
'privateIpv4Address': 'string',
'ipv6Address': 'string'
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'cpu': 'string',
'memory': 'string',
'memoryReservation': 'string',
'gpuIds': [
'string',
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'executionStoppedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppingAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string',
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
task (dict) --
The task that was stopped.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
resourceRequirements (list) --
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
(dict) --
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
value (string) --
The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
type (string) --
The type of resource to assign to a container. The only supported value is GPU .
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
cpu (string) --
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024 . It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu . String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
memory (string) --
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024 . It can also be expressed as a string using GB, for example 1GB or 1 GB . String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The ARN of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
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.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
networkInterfaces (list) --
The network interfaces associated with the container.
(dict) --
An object representing the elastic network interface for tasks that use the awsvpc network mode.
attachmentId (string) --
The attachment ID for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
healthStatus (string) --
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN .
cpu (string) --
The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.
memory (string) --
The hard limit (in MiB) of memory set for the container.
memoryReservation (string) --
The soft limit (in MiB) of memory set for the container.
gpuIds (list) --
The IDs of each GPU assigned to the container.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason that the task was stopped.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
launchType (string) --
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
attachments (list) --
The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
healthStatus (string) --
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY , then the task status also reports as HEALTHY . If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN , then the task status also reports as UNHEALTHY or UNKNOWN , accordingly.
Note
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
tags (list) --
The metadata that you apply to the task 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.submit_container_state_change(
cluster='string',
task='string',
containerName='string',
status='string',
exitCode=123,
reason='string',
networkBindings=[
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
]
)
The network bindings of the container.
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.
The IP address that the container is bound to on the container instance.
The port number on the container that is used with the network binding.
The port number on the host that is used with the network binding.
The protocol used for the network binding.
dict
Response Syntax
{
'acknowledgment': 'string'
}
Response Structure
(dict) --
acknowledgment (string) --
Acknowledgement of the state change.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.submit_task_state_change(
cluster='string',
task='string',
status='string',
reason='string',
containers=[
{
'containerName': 'string',
'exitCode': 123,
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
],
'reason': 'string',
'status': 'string'
},
],
attachments=[
{
'attachmentArn': 'string',
'status': 'string'
},
],
pullStartedAt=datetime(2015, 1, 1),
pullStoppedAt=datetime(2015, 1, 1),
executionStoppedAt=datetime(2015, 1, 1)
)
Any containers associated with the state change request.
An object representing a change in state for a container.
The name of the container.
The exit code for the container, if the state change is a result of the container exiting.
Any network bindings associated with the container.
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.
The IP address that the container is bound to on the container instance.
The port number on the container that is used with the network binding.
The port number on the host that is used with the network binding.
The protocol used for the network binding.
The reason for the state change.
The status of the container.
Any attachments associated with the state change request.
An object representing a change in state for a task attachment.
The Amazon Resource Name (ARN) of the attachment.
The status of the attachment.
dict
Response Syntax
{
'acknowledgment': 'string'
}
Response Structure
(dict) --
acknowledgment (string) --
Acknowledgement of the state change.
Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
[REQUIRED]
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{}
Response Structure
Deletes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
[REQUIRED]
The keys of the tags to be removed.
dict
Response Syntax
{}
Response Structure
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 .
See also: AWS API Documentation
Request Syntax
response = client.update_container_agent(
cluster='string',
containerInstance='string'
)
[REQUIRED]
The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
dict
Response Syntax
{
'containerInstance': {
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'version': 123,
'versionInfo': {
'agentVersion': 'string',
'agentHash': 'string',
'dockerVersion': 'string'
},
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'registeredAt': datetime(2015, 1, 1),
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
containerInstance (dict) --
The container instance for which the container agent was updated.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID `` .
ec2InstanceId (string) --
The EC2 instance ID of the container instance.
version (integer) --
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
versionInfo (dict) --
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion (string) --
The version number of the Amazon ECS container agent.
agentHash (string) --
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion (string) --
The Docker version running on the container instance.
remainingResources (list) --
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
registeredResources (list) --
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
status (string) --
The status of the container instance. The valid values are ACTIVE , INACTIVE , or DRAINING . ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide .
agentConnected (boolean) --
This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false . Only instances connected to an agent can accept placement requests.
runningTasksCount (integer) --
The number of tasks on the container instance that are in the RUNNING status.
pendingTasksCount (integer) --
The number of tasks on the container instance that are in the PENDING status.
agentUpdateStatus (string) --
The status of the most recent agent update. If an update has never been requested, this value is NULL .
attributes (list) --
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt (datetime) --
The Unix timestamp for when the container instance was registered.
attachments (list) --
The elastic network interfaces associated with the container instance.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the container instance 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Modifies the status of an Amazon ECS container instance.
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.
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 .
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 .
When you set a container instance to ACTIVE , the Amazon ECS scheduler can begin scheduling tasks on the instance again.
See also: AWS API Documentation
Request Syntax
response = client.update_container_instances_state(
cluster='string',
containerInstances=[
'string',
],
status='ACTIVE'|'DRAINING'
)
[REQUIRED]
A list of container instance IDs or full ARN entries.
[REQUIRED]
The container instance state with which to update the container instance.
dict
Response Syntax
{
'containerInstances': [
{
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'version': 123,
'versionInfo': {
'agentVersion': 'string',
'agentHash': 'string',
'dockerVersion': 'string'
},
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False,
'runningTasksCount': 123,
'pendingTasksCount': 123,
'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'registeredAt': datetime(2015, 1, 1),
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
containerInstances (list) --
The list of container instances.
(dict) --
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID `` .
ec2InstanceId (string) --
The EC2 instance ID of the container instance.
version (integer) --
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
versionInfo (dict) --
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion (string) --
The version number of the Amazon ECS container agent.
agentHash (string) --
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion (string) --
The Docker version running on the container instance.
remainingResources (list) --
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
registeredResources (list) --
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
status (string) --
The status of the container instance. The valid values are ACTIVE , INACTIVE , or DRAINING . ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide .
agentConnected (boolean) --
This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false . Only instances connected to an agent can accept placement requests.
runningTasksCount (integer) --
The number of tasks on the container instance that are in the RUNNING status.
pendingTasksCount (integer) --
The number of tasks on the container instance that are in the PENDING status.
agentUpdateStatus (string) --
The status of the most recent agent update. If an update has never been requested, this value is NULL .
attributes (list) --
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt (datetime) --
The Unix timestamp for when the container instance was registered.
attachments (list) --
The elastic network interfaces associated with the container instance.
(dict) --
An object representing a container instance or task attachment.
id (string) --
The unique identifier for the attachment.
type (string) --
The type of the attachment, such as ElasticNetworkInterface .
status (string) --
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
details (list) --
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags (list) --
The metadata that you apply to the container instance 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Modifies the parameters of a service.
For services using the rolling update (ECS ) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY ) deployment controller, only the desired count, deployment configuration, 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 .
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.
Note
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.
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:
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
See also: AWS API Documentation
Request Syntax
response = client.update_service(
cluster='string',
service='string',
desiredCount=123,
taskDefinition='string',
deploymentConfiguration={
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
platformVersion='string',
forceNewDeployment=True|False,
healthCheckGracePeriodSeconds=123
)
[REQUIRED]
The name of the service to update.
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
If a service is using the rolling update (ECS ) deployment type, 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 the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the 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 maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS ) deployment type, 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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower 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 value is not used, although it is returned when describing your service.
The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .
Note
Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'serviceName': 'string',
'clusterArn': 'string',
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'status': 'string',
'desiredCount': 123,
'runningCount': 123,
'pendingCount': 123,
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'startedBy': 'string',
'externalId': 'string',
'status': 'string',
'taskDefinition': 'string',
'computedDesiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
},
],
'deployments': [
{
'id': 'string',
'status': 'string',
'taskDefinition': 'string',
'desiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'launchType': 'EC2'|'FARGATE',
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
}
},
],
'roleArn': 'string',
'events': [
{
'id': 'string',
'createdAt': datetime(2015, 1, 1),
'message': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'placementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'placementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'healthCheckGracePeriodSeconds': 123,
'schedulingStrategy': 'REPLICA'|'DAEMON',
'deploymentController': {
'type': 'ECS'|'CODE_DEPLOY'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'enableECSManagedTags': True|False,
'propagateTags': 'TASK_DEFINITION'|'SERVICE'
}
}
Response Structure
(dict) --
service (dict) --
The full description of your service following the update call.
serviceArn (string) --
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region :012345678910 :service/my-service `` .
serviceName (string) --
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers (list) --
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service .
port (integer) --
The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
containerName (string) --
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
containerPort (integer) --
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
status (string) --
The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
desiredCount (integer) --
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
runningCount (integer) --
The number of tasks in the cluster that are in the RUNNING state.
pendingCount (integer) --
The number of tasks in the cluster that are in the PENDING state.
launchType (string) --
The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
taskDefinition (string) --
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .
deploymentConfiguration (dict) --
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
maximumPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the 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 maximum percent value is not used, although it is returned when describing your service.
minimumHealthyPercent (integer) --
If a service is using the rolling update (ECS ) deployment type, 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 may 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 are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY ) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower 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 value is not used, although it is returned when describing your service.
taskSets (list) --
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.
(dict) --
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.
id (string) --
The ID of the task set.
taskSetArn (string) --
The Amazon Resource Name (ARN) of the task set.
startedBy (string) --
The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY .
externalId (string) --
The deployment ID of the AWS CodeDeploy deployment.
status (string) --
The status of the task set. The following describes each state:
PRIMARY
The task set is serving production traffic.
ACTIVE
The task set is not serving production traffic.
DRAINING
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
taskDefinition (string) --
The task definition the task set is using.
computedDesiredCount (integer) --
The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
pendingCount (integer) --
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
runningCount (integer) --
The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
createdAt (datetime) --
The Unix timestamp for when the task set was created.
updatedAt (datetime) --
The Unix timestamp for when the task set was last updated.
launchType (string) --
The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The network configuration for the task set.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
loadBalancers (list) --
Details on a load balancer that is used with a task set.
(dict) --
Details on a load balancer that is used with a service.
If the service is using the ECS deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.
Warning
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance , because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancerName (string) --
The name of a load balancer.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the service.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set.
unit (string) --
The unit of measure for the scale value.
stabilityStatus (string) --
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE :
If any of those conditions are not met, the stability status returns STABILIZING .
stabilityStatusAt (datetime) --
The Unix timestamp for when the task set stability status was retrieved.
deployments (list) --
The current state of deployments for the service.
(dict) --
The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.
id (string) --
The ID of the deployment.
status (string) --
The status of the deployment. The following describes each state:
PRIMARY
The most recent deployment of a service.
ACTIVE
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
INACTIVE
A deployment that has been completely replaced.
taskDefinition (string) --
The most recent task definition that was specified for the tasks in the service to use.
desiredCount (integer) --
The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount (integer) --
The number of tasks in the deployment that are in the PENDING status.
runningCount (integer) --
The number of tasks in the deployment that are in the RUNNING status.
createdAt (datetime) --
The Unix timestamp for when the service deployment was created.
updatedAt (datetime) --
The Unix timestamp for when the service deployment was last updated.
launchType (string) --
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
platformVersion (string) --
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
roleArn (string) --
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
events (list) --
The event stream for your service. A maximum of 100 of the latest events are displayed.
(dict) --
Details on an event associated with a service.
id (string) --
The ID string of the event.
createdAt (datetime) --
The Unix timestamp for when the event was triggered.
message (string) --
The event message.
createdAt (datetime) --
The Unix timestamp for when the service was created.
placementConstraints (list) --
The placement constraints for the tasks in the service.
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
expression (string) --
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
placementStrategy (list) --
The placement strategy that determines how tasks for the service are placed.
(dict) --
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
networkConfiguration (dict) --
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
awsvpcConfiguration (dict) --
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets (list) --
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration .
Note
All specified subnets must be from the same VPC.
securityGroups (list) --
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration .
Note
All specified security groups must be from the same VPC.
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
healthCheckGracePeriodSeconds (integer) --
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
schedulingStrategy (string) --
The scheduling strategy to use for the service. For more information, see Services .
There are two service scheduler strategies available:
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using.
type (string) --
The deployment controller type to use.
There are two deployment controller types available:
ECS
The rolling update (ECS ) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration .
CODE_DEPLOY
The blue/green (CODE_DEPLOY ) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
tags (list) --
The metadata that you apply to the service 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.
(dict) --
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.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
createdBy (string) --
The principal that created the service.
enableECSManagedTags (boolean) --
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
propagateTags (string) --
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
Examples
This example updates the my-http-service service to use the amazon-ecs-sample task definition.
response = client.update_service(
service='my-http-service',
taskDefinition='amazon-ecs-sample',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example updates the desired count of the my-http-service service to 10.
response = client.update_service(
desiredCount=10,
service='my-http-service',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
paginator = client.get_paginator('list_account_settings')
Creates an iterator that will paginate through responses from ECS.Client.list_account_settings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
value='string',
principalArn='string',
effectiveSettings=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'settings': [
{
'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat',
'value': 'string',
'principalArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
settings (list) --
The account settings for the resource.
(dict) --
The current account setting for a resource.
name (string) --
The account resource name.
value (string) --
The current account setting for the resource name. If enabled , then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled , then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
principalArn (string) --
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_attributes')
Creates an iterator that will paginate through responses from ECS.Client.list_attributes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
cluster='string',
targetType='container-instance',
attributeName='string',
attributeValue='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The type of the target with which to list attributes.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
attributes (list) --
A list of attribute objects that meet the criteria of the request.
(dict) --
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 .
name (string) --
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
value (string) --
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
targetType (string) --
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId (string) --
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_clusters')
Creates an iterator that will paginate through responses from ECS.Client.list_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'clusterArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
A token to resume pagination.
paginator = client.get_paginator('list_container_instances')
Creates an iterator that will paginate through responses from ECS.Client.list_container_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
cluster='string',
filter='string',
status='ACTIVE'|'DRAINING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'containerInstanceArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
containerInstanceArns (list) --
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_services')
Creates an iterator that will paginate through responses from ECS.Client.list_services().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
cluster='string',
launchType='EC2'|'FARGATE',
schedulingStrategy='REPLICA'|'DAEMON',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'serviceArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
serviceArns (list) --
The list of full ARN entries for each service associated with the specified cluster.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_task_definition_families')
Creates an iterator that will paginate through responses from ECS.Client.list_task_definition_families().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
familyPrefix='string',
status='ACTIVE'|'INACTIVE'|'ALL',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'families': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
families (list) --
The list of task definition family names that match the ListTaskDefinitionFamilies request.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_task_definitions')
Creates an iterator that will paginate through responses from ECS.Client.list_task_definitions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
familyPrefix='string',
status='ACTIVE'|'INACTIVE',
sort='ASC'|'DESC',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'taskDefinitionArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
taskDefinitionArns (list) --
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_tasks')
Creates an iterator that will paginate through responses from ECS.Client.list_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
cluster='string',
containerInstance='string',
family='string',
startedBy='string',
serviceName='string',
desiredStatus='RUNNING'|'PENDING'|'STOPPED',
launchType='EC2'|'FARGATE',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED . This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING , which shows tasks that Amazon ECS has set the desired status to RUNNING .
Note
Although you can filter results based on a desired status of PENDING , this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING ).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'taskArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
taskArns (list) --
The list of task ARN entries for the ListTasks request.
NextToken (string) --
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('services_inactive')
Polls ECS.Client.describe_services() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
cluster='string',
services=[
'string',
],
include=[
'TAGS',
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
A list of services to describe. You may specify up to 10 services to describe in a single operation.
Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('services_stable')
Polls ECS.Client.describe_services() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
cluster='string',
services=[
'string',
],
include=[
'TAGS',
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
A list of services to describe. You may specify up to 10 services to describe in a single operation.
Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('tasks_running')
Polls ECS.Client.describe_tasks() every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
cluster='string',
tasks=[
'string',
],
include=[
'TAGS',
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
A list of up to 100 task IDs or full ARN entries.
Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 6
The maximum number of attempts to be made. Default: 100
None
waiter = client.get_waiter('tasks_stopped')
Polls ECS.Client.describe_tasks() every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
cluster='string',
tasks=[
'string',
],
include=[
'TAGS',
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
A list of up to 100 task IDs or full ARN entries.
Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 6
The maximum number of attempts to be made. Default: 100
None