2019/12/03 - Amazon EC2 Container Service - 3 new 22 updated api methods
Changes This release supports ECS Capacity Providers, Fargate Spot, and ECS Cluster Auto Scaling. These features enable new ways for ECS to manage compute capacity used by tasks.
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.
See also: AWS API Documentation
Request Syntax
client.create_capacity_provider(
name='string',
autoScalingGroupProvider={
'autoScalingGroupArn': 'string',
'managedScaling': {
'status': 'ENABLED'|'DISABLED',
'targetCapacity': 123,
'minimumScalingStepSize': 123,
'maximumScalingStepSize': 123
},
'managedTerminationProtection': 'ENABLED'|'DISABLED'
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with "aws ", "ecs ", or "fargate ".
dict
[REQUIRED]
The details of the Auto Scaling group for the capacity provider.
autoScalingGroupArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
managedScaling (dict) --
The managed scaling settings for the Auto Scaling group capacity provider.
status (string) --
Whether or not to enable managed scaling for the capacity provider.
targetCapacity (integer) --
The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100 . A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
minimumScalingStepSize (integer) --
The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.
maximumScalingStepSize (integer) --
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.
managedTerminationProtection (string) --
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide .
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
list
The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
dict
Response Syntax
{
'capacityProvider': {
'capacityProviderArn': 'string',
'name': 'string',
'status': 'ACTIVE',
'autoScalingGroupProvider': {
'autoScalingGroupArn': 'string',
'managedScaling': {
'status': 'ENABLED'|'DISABLED',
'targetCapacity': 123,
'minimumScalingStepSize': 123,
'maximumScalingStepSize': 123
},
'managedTerminationProtection': 'ENABLED'|'DISABLED'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
capacityProvider (dict) --
The full description of the new capacity provider.
capacityProviderArn (string) --
The Amazon Resource Name (ARN) that identifies the capacity provider.
name (string) --
The name of the capacity provider.
status (string) --
The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster.
autoScalingGroupProvider (dict) --
The Auto Scaling group settings for the capacity provider.
autoScalingGroupArn (string) --
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
managedScaling (dict) --
The managed scaling settings for the Auto Scaling group capacity provider.
status (string) --
Whether or not to enable managed scaling for the capacity provider.
targetCapacity (integer) --
The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100 . A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
minimumScalingStepSize (integer) --
The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.
maximumScalingStepSize (integer) --
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.
managedTerminationProtection (string) --
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide .
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
tags (list) --
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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 available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array ([] ) to bypass defining a default strategy.
See also: AWS API Documentation
Request Syntax
client.put_cluster_capacity_providers(
cluster='string',
capacityProviders=[
'string',
],
defaultCapacityProviderStrategy=[
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
]
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
list
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
(string) --
list
[REQUIRED]
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) -- [REQUIRED]
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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'
},
],
'settings': [
{
'name': 'containerInsights',
'value': 'string'
},
],
'capacityProviders': [
'string',
],
'defaultCapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attachmentsStatus': 'string'
}
}
Response Structure
(dict) --
cluster (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:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
settings (list) --
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
capacityProviders (list) --
The capacity providers associated with the cluster.
(string) --
defaultCapacityProviderStrategy (list) --
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
attachments (list) --
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
(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.
attachmentsStatus (string) --
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.
Describes one or more of your capacity providers.
See also: AWS API Documentation
Request Syntax
client.describe_capacity_providers(
capacityProviders=[
'string',
],
include=[
'TAGS',
],
maxResults=123,
nextToken='string'
)
list
The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.
(string) --
list
Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
(string) --
integer
The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.
string
The nextToken value returned from a previous paginated DescribeCapacityProviders 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
{
'capacityProviders': [
{
'capacityProviderArn': 'string',
'name': 'string',
'status': 'ACTIVE',
'autoScalingGroupProvider': {
'autoScalingGroupArn': 'string',
'managedScaling': {
'status': 'ENABLED'|'DISABLED',
'targetCapacity': 123,
'minimumScalingStepSize': 123,
'maximumScalingStepSize': 123
},
'managedTerminationProtection': 'ENABLED'|'DISABLED'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
capacityProviders (list) --
The list of capacity providers.
(dict) --
The details of a capacity provider.
capacityProviderArn (string) --
The Amazon Resource Name (ARN) that identifies the capacity provider.
name (string) --
The name of the capacity provider.
status (string) --
The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster.
autoScalingGroupProvider (dict) --
The Auto Scaling group settings for the capacity provider.
autoScalingGroupArn (string) --
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
managedScaling (dict) --
The managed scaling settings for the Auto Scaling group capacity provider.
status (string) --
Whether or not to enable managed scaling for the capacity provider.
targetCapacity (integer) --
The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100 . A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
minimumScalingStepSize (integer) --
The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.
maximumScalingStepSize (integer) --
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.
managedTerminationProtection (string) --
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide .
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
tags (list) --
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
detail (string) --
The details of the failure.
nextToken (string) --
The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders 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.
{'capacityProviders': ['string'],
'defaultCapacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}
Response {'cluster': {'attachments': [{'details': [{'name': 'string',
'value': 'string'}],
'id': 'string',
'status': 'string',
'type': 'string'}],
'attachmentsStatus': 'string',
'capacityProviders': ['string'],
'defaultCapacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
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 Amazon ECS service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_cluster(
clusterName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
settings=[
{
'name': 'containerInsights',
'value': 'string'
},
],
capacityProviders=[
'string',
],
defaultCapacityProviderStrategy=[
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
]
)
string
The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default . Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
list
The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
list
The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
(string) --
list
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) -- [REQUIRED]
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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'
},
],
'settings': [
{
'name': 'containerInsights',
'value': 'string'
},
],
'capacityProviders': [
'string',
],
'defaultCapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attachmentsStatus': '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:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
settings (list) --
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
capacityProviders (list) --
The capacity providers associated with the cluster.
(string) --
defaultCapacityProviderStrategy (list) --
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
attachments (list) --
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
(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.
attachmentsStatus (string) --
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.
{'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}
Response {'service': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}],
'deployments': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]},
'taskSets': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}}
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount , Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see UpdateService .
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide .
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide .
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
See also: AWS API Documentation
Request Syntax
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',
capacityProviderStrategy=[
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
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'|'EXTERNAL'
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
enableECSManagedTags=True|False,
propagateTags='TASK_DEFINITION'|'SERVICE'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens 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.
string
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 task definition must be specified if the service is using the ECS deployment controller.
list
A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .
If the service is using the rolling update (ECS ) deployment controller and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .
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 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.
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.
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.
(dict) --
Details on the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
list
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 .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
integer
The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
string
The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
list
The capacity provider strategy to use for the service.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) -- [REQUIRED]
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
string
The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't 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 .
string
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 or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators 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 .
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 ) or EXTERNAL deployment types 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 ) or EXTERNAL deployment types 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.
list
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).
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
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.
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 .
list
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
(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.
dict
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 .
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) -- [REQUIRED]
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.
(string) --
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.
(string) --
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
integer
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
string
The scheduling strategy to use for the service. For more information, see Services .
There are two service scheduler strategies available:
REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
DAEMON -The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Note
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
dict
The deployment controller to use for the service.
type (string) -- [REQUIRED]
The deployment controller type to use.
There are three 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.
EXTERNAL
The external (EXTERNAL ) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
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. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
boolean
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
string
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'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),
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'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'|'EXTERNAL'
},
'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, and hyphens 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.
(dict) --
Details on the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this service. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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. If no value is specified, it will default to EC2 . Valid values include EC2 and FARGATE . For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the service.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
platformVersion (string) --
The platform version on which to run your service. 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 ) or EXTERNAL deployment types 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 ) or EXTERNAL deployment types 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 either an AWS CodeDeploy or an EXTERNAL 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 either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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 only when a service uses the ECS 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.
capacityProviderStrategy (list) --
The capacity provider strategy that the deployment is using.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
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.
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.
(string) --
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.
(string) --
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:
REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON -The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
type (string) --
The deployment controller type to use.
There are three 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.
EXTERNAL
The external (EXTERNAL ) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
{'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}
Response {'taskSet': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_task_set(
service='string',
cluster='string',
externalId='string',
taskDefinition='string',
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
loadBalancers=[
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
serviceRegistries=[
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
launchType='EC2'|'FARGATE',
capacityProviderStrategy=[
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
platformVersion='string',
scale={
'value': 123.0,
'unit': 'PERCENT'
},
clientToken='string'
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
string
An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
string
[REQUIRED]
The task definition for the tasks in the task set to use.
dict
An object representing the network configuration for a task or service.
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) -- [REQUIRED]
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.
(string) --
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.
(string) --
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
list
A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
(dict) --
Details on the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
list
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
string
The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
list
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) -- [REQUIRED]
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
string
The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
dict
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
unit (string) --
The unit of measure for the scale value.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
dict
Response Syntax
{
'taskSet': {
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
taskSet (dict) --
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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.
{'cluster': {'attachments': [{'details': [{'name': 'string',
'value': 'string'}],
'id': 'string',
'status': 'string',
'type': 'string'}],
'attachmentsStatus': 'string',
'capacityProviders': ['string'],
'defaultCapacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
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
client.delete_cluster(
cluster='string'
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster to delete.
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'
},
],
'settings': [
{
'name': 'containerInsights',
'value': 'string'
},
],
'capacityProviders': [
'string',
],
'defaultCapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attachmentsStatus': 'string'
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of the deleted 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:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
settings (list) --
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
capacityProviders (list) --
The capacity providers associated with the cluster.
(string) --
defaultCapacityProviderStrategy (list) --
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
attachments (list) --
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
(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.
attachmentsStatus (string) --
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.
{'service': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}],
'deployments': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]},
'taskSets': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}}
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 all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE . Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.
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
client.delete_service(
cluster='string',
service='string',
force=True|False
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The name of the service to delete.
boolean
If true , allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.
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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'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),
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'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'|'EXTERNAL'
},
'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, and hyphens 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.
(dict) --
Details on the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this service. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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. If no value is specified, it will default to EC2 . Valid values include EC2 and FARGATE . For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the service.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
platformVersion (string) --
The platform version on which to run your service. 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 ) or EXTERNAL deployment types 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 ) or EXTERNAL deployment types 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 either an AWS CodeDeploy or an EXTERNAL 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 either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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 only when a service uses the ECS 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.
capacityProviderStrategy (list) --
The capacity provider strategy that the deployment is using.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
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.
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.
(string) --
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.
(string) --
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:
REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON -The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
type (string) --
The deployment controller type to use.
There are three 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.
EXTERNAL
The external (EXTERNAL ) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
{'taskSet': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.delete_task_set(
cluster='string',
service='string',
taskSet='string',
force=True|False
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
string
[REQUIRED]
The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
boolean
If true , this allows you to delete a task set even if it hasn't been scaled down to zero.
dict
Response Syntax
{
'taskSet': {
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
taskSet (dict) --
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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.
{'containerInstance': {'capacityProviderName': 'string'}}
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
client.deregister_container_instance(
cluster='string',
containerInstance='string',
force=True|False
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
string
[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 .
boolean
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',
'capacityProviderName': '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',
'statusReason': '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.
capacityProviderName (string) --
The capacity provider associated with 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.
(string) --
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.
(string) --
status (string) --
The status of the container instance. The valid values are REGISTERING , REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING .
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The 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 .
statusReason (string) --
The reason that the container instance reached its current status.
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 resources attached to a container instance, such as elastic network interfaces.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
{'include': ['ATTACHMENTS', 'SETTINGS']}
Response {'clusters': {'attachments': [{'details': [{'name': 'string',
'value': 'string'}],
'id': 'string',
'status': 'string',
'type': 'string'}],
'attachmentsStatus': 'string',
'capacityProviders': ['string'],
'defaultCapacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Describes one or more of your clusters.
See also: AWS API Documentation
Request Syntax
client.describe_clusters(
clusters=[
'string',
],
include=[
'ATTACHMENTS'|'SETTINGS'|'STATISTICS'|'TAGS',
]
)
list
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.
(string) --
list
Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.
If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.
If SETTINGS is specified, the settings for the cluster are included.
If STATISTICS is specified, the following additional information, separated by launch type, is included:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
If TAGS is specified, the metadata tags associated with the cluster are included.
(string) --
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'
},
],
'settings': [
{
'name': 'containerInsights',
'value': 'string'
},
],
'capacityProviders': [
'string',
],
'defaultCapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attachmentsStatus': 'string'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': '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:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
settings (list) --
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
capacityProviders (list) --
The capacity providers associated with the cluster.
(string) --
defaultCapacityProviderStrategy (list) --
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
attachments (list) --
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
(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.
attachmentsStatus (string) --
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.
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.
detail (string) --
The details of the failure.
{'containerInstances': {'capacityProviderName': 'string'}}
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
client.describe_container_instances(
cluster='string',
containerInstances=[
'string',
],
include=[
'TAGS',
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
list
[REQUIRED]
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
(string) --
list
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.
(string) --
dict
Response Syntax
{
'containerInstances': [
{
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'capacityProviderName': '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',
'statusReason': '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',
'detail': '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.
capacityProviderName (string) --
The capacity provider associated with 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.
(string) --
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.
(string) --
status (string) --
The status of the container instance. The valid values are REGISTERING , REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING .
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The 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 .
statusReason (string) --
The reason that the container instance reached its current status.
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 resources attached to a container instance, such as elastic network interfaces.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
detail (string) --
The details of the failure.
{'services': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}],
'deployments': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]},
'taskSets': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}}
Describes the specified services running in your cluster.
See also: AWS API Documentation
Request Syntax
client.describe_services(
cluster='string',
services=[
'string',
],
include=[
'TAGS',
]
)
string
The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.
list
[REQUIRED]
A list of services to describe. You may specify up to 10 services to describe in a single operation.
(string) --
list
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.
(string) --
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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'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),
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'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'|'EXTERNAL'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'enableECSManagedTags': True|False,
'propagateTags': 'TASK_DEFINITION'|'SERVICE'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': '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, and hyphens 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.
(dict) --
Details on the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this service. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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. If no value is specified, it will default to EC2 . Valid values include EC2 and FARGATE . For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the service.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
platformVersion (string) --
The platform version on which to run your service. 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 ) or EXTERNAL deployment types 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 ) or EXTERNAL deployment types 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 either an AWS CodeDeploy or an EXTERNAL 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 either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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 only when a service uses the ECS 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.
capacityProviderStrategy (list) --
The capacity provider strategy that the deployment is using.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
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.
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.
(string) --
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.
(string) --
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:
REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON -The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
type (string) --
The deployment controller type to use.
There are three 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.
EXTERNAL
The external (EXTERNAL ) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
detail (string) --
The details of the failure.
{'taskSets': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.describe_task_sets(
cluster='string',
service='string',
taskSets=[
'string',
]
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
list
The ID or full Amazon Resource Name (ARN) of task sets to describe.
(string) --
dict
Response Syntax
{
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': 'string'
},
]
}
Response Structure
(dict) --
taskSets (list) --
The list of task sets described.
(dict) --
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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.
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.
detail (string) --
The details of the failure.
{'tasks': {'capacityProviderName': 'string'}}
Describes a specified task or tasks.
See also: AWS API Documentation
Request Syntax
client.describe_tasks(
cluster='string',
tasks=[
'string',
],
include=[
'TAGS',
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
list
[REQUIRED]
A list of up to 100 task IDs or full ARN entries.
(string) --
list
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.
(string) --
dict
Response Syntax
{
'tasks': [
{
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'availabilityZone': 'string',
'capacityProviderName': 'string',
'clusterArn': 'string',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'containerInstanceArn': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'image': 'string',
'imageDigest': 'string',
'runtimeId': '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',
]
},
],
'cpu': 'string',
'createdAt': datetime(2015, 1, 1),
'desiredStatus': 'string',
'executionStoppedAt': datetime(2015, 1, 1),
'group': 'string',
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'inferenceAccelerators': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'lastStatus': 'string',
'launchType': 'EC2'|'FARGATE',
'memory': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'|'InferenceAccelerator'
},
]
},
],
'cpu': 'string',
'inferenceAcceleratorOverrides': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'executionRoleArn': 'string',
'memory': 'string',
'taskRoleArn': 'string'
},
'platformVersion': 'string',
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'startedBy': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'stoppedAt': datetime(2015, 1, 1),
'stoppedReason': 'string',
'stoppingAt': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'taskArn': 'string',
'taskDefinitionArn': 'string',
'version': 123
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
The list of tasks.
(dict) --
Details on a task in a cluster.
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.
attributes (list) --
The attributes of the 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).
availabilityZone (string) --
The availability zone of the task.
capacityProviderName (string) --
The capacity provider associated with the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
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.
image (string) --
The image used for the container.
imageDigest (string) --
The container image manifest digest.
Note
The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
runtimeId (string) --
The ID of the Docker 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.
(string) --
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:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
group (string) --
The name of the task group associated with the task.
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.
inferenceAccelerators (list) --
The Elastic Inference accelerator associated with the task.
(dict) --
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement .
deviceType (string) --
The Elastic Inference accelerator type to use.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
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 .
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:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
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. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.
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.
(string) --
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 supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value (string) --
The value for the specified resource type.
If the GPU type is used, the value is 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.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
type (string) --
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator .
cpu (string) --
The cpu override for the task.
inferenceAcceleratorOverrides (list) --
The Elastic Inference accelerator override for the task.
(dict) --
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType (string) --
The Elastic Inference accelerator type to use.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
memory (string) --
The memory override for the task.
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.
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 .
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
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.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
stoppedReason (string) --
The reason that the task was stopped.
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
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 actions 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.
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.
detail (string) --
The details of the failure.
{'containerInstance': {'capacityProviderName': 'string'}}
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
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'
},
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
string
The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
string
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
list
The resources available on the instance.
(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.
(string) --
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.
string
The ARN of the container instance (if it was previously registered).
list
The container instance attributes that this container instance supports.
(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) -- [REQUIRED]
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).
list
The devices that are available on the container instance. The only supported device type is a GPU.
(dict) --
The devices that are available on the container instance. The only supported device type is a GPU.
id (string) -- [REQUIRED]
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.
type (string) -- [REQUIRED]
The type of device that is available on the container instance. The only supported value is GPU .
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
dict
Response Syntax
{
'containerInstance': {
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'capacityProviderName': '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',
'statusReason': '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.
capacityProviderName (string) --
The capacity provider associated with 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.
(string) --
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.
(string) --
status (string) --
The status of the container instance. The valid values are REGISTERING , REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING .
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The 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 .
statusReason (string) --
The reason that the container instance reached its current status.
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 resources attached to a container instance, such as elastic network interfaces.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
{'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}
Response {'tasks': {'capacityProviderName': 'string'}}
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide .
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
See also: AWS API Documentation
Request Syntax
client.run_task(
capacityProviderStrategy=[
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
cluster='string',
count=123,
enableECSManagedTags=True|False,
group='string',
launchType='EC2'|'FARGATE',
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'|'InferenceAccelerator'
},
]
},
],
'cpu': 'string',
'inferenceAcceleratorOverrides': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'executionRoleArn': 'string',
'memory': 'string',
'taskRoleArn': 'string'
},
placementConstraints=[
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
placementStrategy=[
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
platformVersion='string',
propagateTags='TASK_DEFINITION'|'SERVICE',
referenceId='string',
startedBy='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
taskDefinition='string'
)
list
The capacity provider strategy to use for the task.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) -- [REQUIRED]
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
string
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
integer
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
boolean
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
string
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
string
The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
dict
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 .
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) -- [REQUIRED]
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.
(string) --
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.
(string) --
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
dict
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.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.
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.
(string) --
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 supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value (string) -- [REQUIRED]
The value for the specified resource type.
If the GPU type is used, the value is 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.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
type (string) -- [REQUIRED]
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator .
cpu (string) --
The cpu override for the task.
inferenceAcceleratorOverrides (list) --
The Elastic Inference accelerator override for the task.
(dict) --
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType (string) --
The Elastic Inference accelerator type to use.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
memory (string) --
The memory override for the task.
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.
list
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).
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
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.
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 .
list
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
(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.
string
The platform version the task should run. 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 .
string
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.
string
The reference ID to use for the task.
string
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.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
string
[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.
dict
Response Syntax
{
'tasks': [
{
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'availabilityZone': 'string',
'capacityProviderName': 'string',
'clusterArn': 'string',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'containerInstanceArn': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'image': 'string',
'imageDigest': 'string',
'runtimeId': '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',
]
},
],
'cpu': 'string',
'createdAt': datetime(2015, 1, 1),
'desiredStatus': 'string',
'executionStoppedAt': datetime(2015, 1, 1),
'group': 'string',
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'inferenceAccelerators': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'lastStatus': 'string',
'launchType': 'EC2'|'FARGATE',
'memory': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'|'InferenceAccelerator'
},
]
},
],
'cpu': 'string',
'inferenceAcceleratorOverrides': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'executionRoleArn': 'string',
'memory': 'string',
'taskRoleArn': 'string'
},
'platformVersion': 'string',
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'startedBy': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'stoppedAt': datetime(2015, 1, 1),
'stoppedReason': 'string',
'stoppingAt': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'taskArn': 'string',
'taskDefinitionArn': 'string',
'version': 123
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': '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.
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.
attributes (list) --
The attributes of the 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).
availabilityZone (string) --
The availability zone of the task.
capacityProviderName (string) --
The capacity provider associated with the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
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.
image (string) --
The image used for the container.
imageDigest (string) --
The container image manifest digest.
Note
The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
runtimeId (string) --
The ID of the Docker 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.
(string) --
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:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
group (string) --
The name of the task group associated with the task.
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.
inferenceAccelerators (list) --
The Elastic Inference accelerator associated with the task.
(dict) --
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement .
deviceType (string) --
The Elastic Inference accelerator type to use.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
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 .
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:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
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. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.
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.
(string) --
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 supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value (string) --
The value for the specified resource type.
If the GPU type is used, the value is 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.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
type (string) --
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator .
cpu (string) --
The cpu override for the task.
inferenceAcceleratorOverrides (list) --
The Elastic Inference accelerator override for the task.
(dict) --
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType (string) --
The Elastic Inference accelerator type to use.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
memory (string) --
The memory override for the task.
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.
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 .
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
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.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
stoppedReason (string) --
The reason that the task was stopped.
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
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 actions 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.
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.
detail (string) --
The details of the failure.
{'tasks': {'capacityProviderName': 'string'}}
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
client.start_task(
cluster='string',
containerInstances=[
'string',
],
enableECSManagedTags=True|False,
group='string',
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'|'InferenceAccelerator'
},
]
},
],
'cpu': 'string',
'inferenceAcceleratorOverrides': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'executionRoleArn': 'string',
'memory': 'string',
'taskRoleArn': 'string'
},
propagateTags='TASK_DEFINITION'|'SERVICE',
referenceId='string',
startedBy='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
taskDefinition='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
list
[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.
(string) --
boolean
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
string
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
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) -- [REQUIRED]
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.
(string) --
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.
(string) --
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
dict
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.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.
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.
(string) --
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 supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value (string) -- [REQUIRED]
The value for the specified resource type.
If the GPU type is used, the value is 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.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
type (string) -- [REQUIRED]
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator .
cpu (string) --
The cpu override for the task.
inferenceAcceleratorOverrides (list) --
The Elastic Inference accelerator override for the task.
(dict) --
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType (string) --
The Elastic Inference accelerator type to use.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
memory (string) --
The memory override for the task.
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.
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.
string
The reference ID to use for the task.
string
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.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
string
[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.
dict
Response Syntax
{
'tasks': [
{
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'availabilityZone': 'string',
'capacityProviderName': 'string',
'clusterArn': 'string',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'containerInstanceArn': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'image': 'string',
'imageDigest': 'string',
'runtimeId': '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',
]
},
],
'cpu': 'string',
'createdAt': datetime(2015, 1, 1),
'desiredStatus': 'string',
'executionStoppedAt': datetime(2015, 1, 1),
'group': 'string',
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'inferenceAccelerators': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'lastStatus': 'string',
'launchType': 'EC2'|'FARGATE',
'memory': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'|'InferenceAccelerator'
},
]
},
],
'cpu': 'string',
'inferenceAcceleratorOverrides': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'executionRoleArn': 'string',
'memory': 'string',
'taskRoleArn': 'string'
},
'platformVersion': 'string',
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'startedBy': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'stoppedAt': datetime(2015, 1, 1),
'stoppedReason': 'string',
'stoppingAt': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'taskArn': 'string',
'taskDefinitionArn': 'string',
'version': 123
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': '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.
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.
attributes (list) --
The attributes of the 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).
availabilityZone (string) --
The availability zone of the task.
capacityProviderName (string) --
The capacity provider associated with the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
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.
image (string) --
The image used for the container.
imageDigest (string) --
The container image manifest digest.
Note
The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
runtimeId (string) --
The ID of the Docker 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.
(string) --
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:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
group (string) --
The name of the task group associated with the task.
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.
inferenceAccelerators (list) --
The Elastic Inference accelerator associated with the task.
(dict) --
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement .
deviceType (string) --
The Elastic Inference accelerator type to use.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
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 .
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:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
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. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.
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.
(string) --
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 supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value (string) --
The value for the specified resource type.
If the GPU type is used, the value is 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.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
type (string) --
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator .
cpu (string) --
The cpu override for the task.
inferenceAcceleratorOverrides (list) --
The Elastic Inference accelerator override for the task.
(dict) --
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType (string) --
The Elastic Inference accelerator type to use.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
memory (string) --
The memory override for the task.
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.
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 .
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
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.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
stoppedReason (string) --
The reason that the task was stopped.
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
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 actions 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.
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.
detail (string) --
The details of the failure.
{'task': {'capacityProviderName': 'string'}}
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
client.stop_task(
cluster='string',
task='string',
reason='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The task ID or full Amazon Resource Name (ARN) of the task to stop.
string
An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
dict
Response Syntax
{
'task': {
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attributes': [
{
'name': 'string',
'value': 'string',
'targetType': 'container-instance',
'targetId': 'string'
},
],
'availabilityZone': 'string',
'capacityProviderName': 'string',
'clusterArn': 'string',
'connectivity': 'CONNECTED'|'DISCONNECTED',
'connectivityAt': datetime(2015, 1, 1),
'containerInstanceArn': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'image': 'string',
'imageDigest': 'string',
'runtimeId': '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',
]
},
],
'cpu': 'string',
'createdAt': datetime(2015, 1, 1),
'desiredStatus': 'string',
'executionStoppedAt': datetime(2015, 1, 1),
'group': 'string',
'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'inferenceAccelerators': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'lastStatus': 'string',
'launchType': 'EC2'|'FARGATE',
'memory': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123,
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'|'InferenceAccelerator'
},
]
},
],
'cpu': 'string',
'inferenceAcceleratorOverrides': [
{
'deviceName': 'string',
'deviceType': 'string'
},
],
'executionRoleArn': 'string',
'memory': 'string',
'taskRoleArn': 'string'
},
'platformVersion': 'string',
'pullStartedAt': datetime(2015, 1, 1),
'pullStoppedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'startedBy': 'string',
'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated',
'stoppedAt': datetime(2015, 1, 1),
'stoppedReason': 'string',
'stoppingAt': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'taskArn': 'string',
'taskDefinitionArn': 'string',
'version': 123
}
}
Response Structure
(dict) --
task (dict) --
The task that was stopped.
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.
attributes (list) --
The attributes of the 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).
availabilityZone (string) --
The availability zone of the task.
capacityProviderName (string) --
The capacity provider associated with the task.
clusterArn (string) --
The ARN of the cluster that hosts the task.
connectivity (string) --
The connectivity status of a task.
connectivityAt (datetime) --
The Unix timestamp for when the task last went into CONNECTED status.
containerInstanceArn (string) --
The ARN of the container instances that host the task.
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.
image (string) --
The image used for the container.
imageDigest (string) --
The container image manifest digest.
Note
The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
runtimeId (string) --
The ID of the Docker 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.
(string) --
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:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
desiredStatus (string) --
The desired status of the task. For more information, see Task Lifecycle .
executionStoppedAt (datetime) --
The Unix timestamp for when the task execution stopped.
group (string) --
The name of the task group associated with the task.
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.
inferenceAccelerators (list) --
The Elastic Inference accelerator associated with the task.
(dict) --
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement .
deviceType (string) --
The Elastic Inference accelerator type to use.
lastStatus (string) --
The last known status of the task. For more information, see Task Lifecycle .
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 .
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:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
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. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.
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.
(string) --
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 supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value (string) --
The value for the specified resource type.
If the GPU type is used, the value is 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.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
type (string) --
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator .
cpu (string) --
The cpu override for the task.
inferenceAcceleratorOverrides (list) --
The Elastic Inference accelerator override for the task.
(dict) --
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName (string) --
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType (string) --
The Elastic Inference accelerator type to use.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
memory (string) --
The memory override for the task.
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.
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 .
pullStartedAt (datetime) --
The Unix timestamp for when the container image pull began.
pullStoppedAt (datetime) --
The Unix timestamp for when the container image pull completed.
startedAt (datetime) --
The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
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.
stopCode (string) --
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
stoppedReason (string) --
The reason that the task was stopped.
stoppingAt (datetime) --
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED ).
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
taskDefinitionArn (string) --
The ARN of the task definition that creates the task.
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 actions 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.
{'cluster': {'attachments': [{'details': [{'name': 'string',
'value': 'string'}],
'id': 'string',
'status': 'string',
'type': 'string'}],
'attachmentsStatus': 'string',
'capacityProviders': ['string'],
'defaultCapacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Modifies the settings to use for a cluster.
See also: AWS API Documentation
Request Syntax
client.update_cluster_settings(
cluster='string',
settings=[
{
'name': 'containerInsights',
'value': 'string'
},
]
)
string
[REQUIRED]
The name of the cluster to modify the settings for.
list
[REQUIRED]
The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
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'
},
],
'settings': [
{
'name': 'containerInsights',
'value': 'string'
},
],
'capacityProviders': [
'string',
],
'defaultCapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'attachments': [
{
'id': 'string',
'type': 'string',
'status': 'string',
'details': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'attachmentsStatus': 'string'
}
}
Response Structure
(dict) --
cluster (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:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
settings (list) --
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
(dict) --
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name (string) --
The name of the cluster setting. The only supported value is containerInsights .
value (string) --
The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .
capacityProviders (list) --
The capacity providers associated with the cluster.
(string) --
defaultCapacityProviderStrategy (list) --
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
attachments (list) --
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
(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.
attachmentsStatus (string) --
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.
{'containerInstance': {'capacityProviderName': 'string'}}
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
client.update_container_agent(
cluster='string',
containerInstance='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
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',
'capacityProviderName': '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',
'statusReason': '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.
capacityProviderName (string) --
The capacity provider associated with 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.
(string) --
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.
(string) --
status (string) --
The status of the container instance. The valid values are REGISTERING , REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING .
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The 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 .
statusReason (string) --
The reason that the container instance reached its current status.
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 resources attached to a container instance, such as elastic network interfaces.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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).
{'containerInstances': {'capacityProviderName': 'string'}}
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
Warning
A container instance cannot be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING , Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent . You can change the deployment configuration of your service using UpdateService .
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that 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 maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks .
When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
See also: AWS API Documentation
Request Syntax
client.update_container_instances_state(
cluster='string',
containerInstances=[
'string',
],
status='ACTIVE'|'DRAINING'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
list
[REQUIRED]
A list of container instance IDs or full ARN entries.
(string) --
string
[REQUIRED]
The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING . A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING , DEREGISTERING , or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.
dict
Response Syntax
{
'containerInstances': [
{
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'capacityProviderName': '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',
'statusReason': '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',
'detail': '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.
capacityProviderName (string) --
The capacity provider associated with 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.
(string) --
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.
(string) --
status (string) --
The status of the container instance. The valid values are REGISTERING , REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING .
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The 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 .
statusReason (string) --
The reason that the container instance reached its current status.
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 resources attached to a container instance, such as elastic network interfaces.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
detail (string) --
The details of the failure.
{'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}
Response {'service': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}],
'deployments': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]},
'taskSets': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}}
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 .
For services using an external deployment controller, you can update only the desired count and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet .
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
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.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that 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 maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
See also: AWS API Documentation
Request Syntax
client.update_service(
cluster='string',
service='string',
desiredCount=123,
taskDefinition='string',
capacityProviderStrategy=[
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
deploymentConfiguration={
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
networkConfiguration={
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
platformVersion='string',
forceNewDeployment=True|False,
healthCheckGracePeriodSeconds=123
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The name of the service to update.
integer
The number of instantiations of the task to place and keep running in your service.
string
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. If you modify the task definition with UpdateService , Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
list
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) -- [REQUIRED]
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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 ) or EXTERNAL deployment types 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 ) or EXTERNAL deployment types 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.
dict
An object representing the network configuration for a task or service.
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) -- [REQUIRED]
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.
(string) --
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.
(string) --
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED .
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 a platform version 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 .
boolean
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest ) or to roll Fargate tasks onto a newer platform version.
integer
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'taskDefinition': 'string',
'deploymentConfiguration': {
'maximumPercent': 123,
'minimumHealthyPercent': 123
},
'taskSets': [
{
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'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),
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'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'|'EXTERNAL'
},
'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, and hyphens 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.
(dict) --
Details on the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this service. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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. If no value is specified, it will default to EC2 . Valid values include EC2 and FARGATE . For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the service.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
platformVersion (string) --
The platform version on which to run your service. 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 ) or EXTERNAL deployment types 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 ) or EXTERNAL deployment types 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 either an AWS CodeDeploy or an EXTERNAL 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 either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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 only when a service uses the ECS 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.
capacityProviderStrategy (list) --
The capacity provider strategy that the deployment is using.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
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.
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.
(string) --
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.
(string) --
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:
REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON -The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Note
Fargate tasks do not support the DAEMON scheduling strategy.
deploymentController (dict) --
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
type (string) --
The deployment controller type to use.
There are three 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.
EXTERNAL
The external (EXTERNAL ) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
(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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
{'taskSet': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.update_service_primary_task_set(
cluster='string',
service='string',
primaryTaskSet='string'
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.
dict
Response Syntax
{
'taskSet': {
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
taskSet (dict) --
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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.
{'taskSet': {'capacityProviderStrategy': [{'base': 'integer',
'capacityProvider': 'string',
'weight': 'integer'}]}}
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.update_task_set(
cluster='string',
service='string',
taskSet='string',
scale={
'value': 123.0,
'unit': 'PERCENT'
}
)
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
string
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the task set to update.
dict
[REQUIRED]
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
unit (string) --
The unit of measure for the scale value.
dict
Response Syntax
{
'taskSet': {
'id': 'string',
'taskSetArn': 'string',
'serviceArn': 'string',
'clusterArn': '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',
'capacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'platformVersion': 'string',
'networkConfiguration': {
'awsvpcConfiguration': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': 'ENABLED'|'DISABLED'
}
},
'loadBalancers': [
{
'targetGroupArn': 'string',
'loadBalancerName': 'string',
'containerName': 'string',
'containerPort': 123
},
],
'serviceRegistries': [
{
'registryArn': 'string',
'port': 123,
'containerName': 'string',
'containerPort': 123
},
],
'scale': {
'value': 123.0,
'unit': 'PERCENT'
},
'stabilityStatus': 'STEADY_STATE'|'STABILIZING',
'stabilityStatusAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
taskSet (dict) --
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL 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.
serviceArn (string) --
The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy (string) --
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY . For a task set created for an external deployment, the startedBy field isn't used.
externalId (string) --
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
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. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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 .
capacityProviderStrategy (list) --
The capacity provider strategy associated with the task set.
(dict) --
The details of a capacity provider strategy.
capacityProvider (string) --
The short name or full Amazon Resource Name (ARN) of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
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.
(string) --
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.
(string) --
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 the load balancer or load balancers to use with a service or task set.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide .
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide .
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 , when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.
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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery .
(dict) --
Details of the service registry.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService .
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.
scale (dict) --
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value (float) --
The value, specified as a percent total of a service's desiredCount , to scale the task set. Accepted values are numbers between 0 and 100.
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 :
The task runningCount is equal to the computedDesiredCount .
The pendingCount is 0 .
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
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.