AWS API Changes

2017/11/14 - Amazon EC2 Container Service - 17 updated api methods

Changes Update ecs client to latest version

CreateService (updated)

Link ¶
Changes (request, response)
Request

{'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                  'subnets': ['string']}}}

Response

{'service': {'deployments': {'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                                              'subnets': ['string']}}},
             'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                              'subnets': ['string']}}}}

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.

The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler can 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 the container instance they are hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler can 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 maximumPercent is 200%.

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 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.

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
        },
    ],
    desiredCount=123,
    clientToken='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',
            ]
        }
    }
)

type cluster:

string

param cluster:

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.

type serviceName:

string

param serviceName:

[REQUIRED]

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

type taskDefinition:

string

param taskDefinition:

[REQUIRED]

The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

type loadBalancers:

list

param loadBalancers:

A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

(dict) --

Details on a load balancer that is used with a service.
- targetGroupArn (string) --
  
  The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
- loadBalancerName (string) --
  
  The name of a load balancer.
- containerName (string) --
  
  The name of the container (as it appears in a container definition) to associate with the load balancer.
- containerPort (integer) --
  
  The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

type desiredCount:

integer

param desiredCount:

[REQUIRED]

The number of instantiations of the specified task definition to place and keep running on your cluster.

type clientToken:

string

param clientToken:

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

type role:

string

param role:

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.

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.

type deploymentConfiguration:

dict

param deploymentConfiguration:

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

maximumPercent (integer) --

The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.
minimumHealthyPercent (integer) --

The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.

type placementConstraints:

list

param placementConstraints:

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 run time).

(dict) --

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
- type (string) --
  
  The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
- expression (string) --
  
  A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

type placementStrategy:

list

param placementStrategy:

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

(dict) --

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon EC2 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.

type networkConfiguration:

dict

param networkConfiguration:

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 EC2 Container Service Developer Guide.

awsvpcConfiguration (dict) --

The VPC subnets and security groups associated with a task.
- subnets (list) -- [REQUIRED]
  
  The subnets associated with the task or service.
  - (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.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'service': {
        'serviceArn': 'string',
        'serviceName': 'string',
        'clusterArn': 'string',
        'loadBalancers': [
            {
                'targetGroupArn': 'string',
                'loadBalancerName': 'string',
                'containerName': 'string',
                'containerPort': 123
            },
        ],
        'status': 'string',
        'desiredCount': 123,
        'runningCount': 123,
        'pendingCount': 123,
        'taskDefinition': 'string',
        'deploymentConfiguration': {
            'maximumPercent': 123,
            'minimumHealthyPercent': 123
        },
        'deployments': [
            {
                'id': 'string',
                'status': 'string',
                'taskDefinition': 'string',
                'desiredCount': 123,
                'pendingCount': 123,
                'runningCount': 123,
                'createdAt': datetime(2015, 1, 1),
                'updatedAt': datetime(2015, 1, 1),
                'networkConfiguration': {
                    'awsvpcConfiguration': {
                        'subnets': [
                            'string',
                        ],
                        'securityGroups': [
                            'string',
                        ]
                    }
                }
            },
        ],
        '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',
                ]
            }
        }
    }
}

Response Structure

(dict) --
- service (dict) --
  
  The full description of your service following the create call.
  - serviceArn (string) --
    
    The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region:012345678910:service/my-service ``.
  - serviceName (string) --
    
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
  - clusterArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster that hosts the service.
  - loadBalancers (list) --
    
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
    - (dict) --
      
      Details on a load balancer that is used with a service.
      - targetGroupArn (string) --
        
        The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
      - loadBalancerName (string) --
        
        The name of a load balancer.
      - containerName (string) --
        
        The name of the container (as it appears in a container definition) to associate with the load balancer.
      - containerPort (integer) --
        
        The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
  - 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.
  - 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) --
      
      The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.
    - minimumHealthyPercent (integer) --
      
      The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.
  - deployments (list) --
    
    The current state of deployments for the service.
    - (dict) --
      
      The details of an Amazon ECS service deployment.
      - id (string) --
        
        The ID of the deployment.
      - status (string) --
        
        The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).
      - taskDefinition (string) --
        
        The most recent task definition that was specified for 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 was created.
      - updatedAt (datetime) --
        
        The Unix timestamp for when the service was last updated.
      - 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.
        
        subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --
  - roleArn (string) --
    
    The Amazon Resource Name (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 EC2 Container Service Developer Guide.
      - type (string) --
        
        The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
      - expression (string) --
        
        A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 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 EC2 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.
      - subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --

DeleteService (updated)

Link ¶
Changes (response)

{'service': {'deployments': {'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                                              'subnets': ['string']}}},
             'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                              'subnets': ['string']}}}}

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.

See also: AWS API Documentation

Request Syntax

client.delete_service(
    cluster='string',
    service='string'
)

type cluster:

string

param cluster:

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.

type service:

string

param service:

[REQUIRED]

The name of the service to delete.

rtype:

dict

returns:

Response Syntax

{
    'service': {
        'serviceArn': 'string',
        'serviceName': 'string',
        'clusterArn': 'string',
        'loadBalancers': [
            {
                'targetGroupArn': 'string',
                'loadBalancerName': 'string',
                'containerName': 'string',
                'containerPort': 123
            },
        ],
        'status': 'string',
        'desiredCount': 123,
        'runningCount': 123,
        'pendingCount': 123,
        'taskDefinition': 'string',
        'deploymentConfiguration': {
            'maximumPercent': 123,
            'minimumHealthyPercent': 123
        },
        'deployments': [
            {
                'id': 'string',
                'status': 'string',
                'taskDefinition': 'string',
                'desiredCount': 123,
                'pendingCount': 123,
                'runningCount': 123,
                'createdAt': datetime(2015, 1, 1),
                'updatedAt': datetime(2015, 1, 1),
                'networkConfiguration': {
                    'awsvpcConfiguration': {
                        'subnets': [
                            'string',
                        ],
                        'securityGroups': [
                            'string',
                        ]
                    }
                }
            },
        ],
        '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',
                ]
            }
        }
    }
}

Response Structure

(dict) --
- service (dict) --
  
  The full description of the deleted service.
  - serviceArn (string) --
    
    The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region:012345678910:service/my-service ``.
  - serviceName (string) --
    
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
  - clusterArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster that hosts the service.
  - loadBalancers (list) --
    
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
    - (dict) --
      
      Details on a load balancer that is used with a service.
      - targetGroupArn (string) --
        
        The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
      - loadBalancerName (string) --
        
        The name of a load balancer.
      - containerName (string) --
        
        The name of the container (as it appears in a container definition) to associate with the load balancer.
      - containerPort (integer) --
        
        The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
  - 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.
  - 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) --
      
      The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.
    - minimumHealthyPercent (integer) --
      
      The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.
  - deployments (list) --
    
    The current state of deployments for the service.
    - (dict) --
      
      The details of an Amazon ECS service deployment.
      - id (string) --
        
        The ID of the deployment.
      - status (string) --
        
        The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).
      - taskDefinition (string) --
        
        The most recent task definition that was specified for 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 was created.
      - updatedAt (datetime) --
        
        The Unix timestamp for when the service was last updated.
      - 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.
        
        subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --
  - roleArn (string) --
    
    The Amazon Resource Name (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 EC2 Container Service Developer Guide.
      - type (string) --
        
        The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
      - expression (string) --
        
        A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 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 EC2 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.
      - subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --

DeregisterContainerInstance (updated)

Link ¶
Changes (response)

{'containerInstance': {'attachments': [{'details': [{'name': 'string',
                                                     'value': 'string'}],
                                        'id': 'string',
                                        'status': 'string',
                                        'type': '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 to avoid any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

See also: AWS API Documentation

Request Syntax

client.deregister_container_instance(
    cluster='string',
    containerInstance='string',
    force=True|False
)

type cluster:

string

param cluster:

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.

type containerInstance:

string

param containerInstance:

[REQUIRED]

The container instance ID or full Amazon Resource Name (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 ``.

type force:

boolean

param force:

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, and they will begin connection draining according to the settings on the load balancer or target group.

rtype:

dict

returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'version': 123,
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
        'attributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'registeredAt': datetime(2015, 1, 1),
        'attachments': [
            {
                'id': 'string',
                'type': 'string',
                'status': 'string',
                'details': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

(dict) --
- containerInstance (dict) --
  
  The container instance that was deregistered.
  - containerInstanceArn (string) --
    
    The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID ``.
  - ec2InstanceId (string) --
    
    The EC2 instance ID of the container instance.
  - version (integer) --
    
    The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
  - versionInfo (dict) --
    
    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
    - agentVersion (string) --
      
      The version number of the Amazon ECS container agent.
    - agentHash (string) --
      
      The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
    - dockerVersion (string) --
      
      The Docker version running on the container instance.
  - remainingResources (list) --
    
    For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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, 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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, 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 ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide.
  - agentConnected (boolean) --
    
    This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot 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 EC2 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 Amazon Resource Name (ARN).
      - targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
  - registeredAt (datetime) --
    
    The Unix timestamp for when the container instance was registered.
  - attachments (list) --
    
    The Elastic Network Interfaces associated with the container instance.
    - (dict) --
      
      An object representing a container instance or task attachment.
      - id (string) --
        
        The unique identifier for the attachment.
      - type (string) --
        
        The type of the attachment, such as an 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 and 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.

DeregisterTaskDefinition (updated)

Link ¶
Changes (response)

{'taskDefinition': {'networkMode': {'awsvpc'}}}

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).

See also: AWS API Documentation

Request Syntax

client.deregister_task_definition(
    taskDefinition='string'
)

type taskDefinition:

string

param taskDefinition:

[REQUIRED]

The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

rtype:

dict

returns:

Response Syntax

{
    'taskDefinition': {
        'taskDefinitionArn': 'string',
        'containerDefinitions': [
            {
                'name': 'string',
                'image': 'string',
                'cpu': 123,
                'memory': 123,
                'memoryReservation': 123,
                'links': [
                    'string',
                ],
                'portMappings': [
                    {
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'essential': True|False,
                'entryPoint': [
                    'string',
                ],
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'mountPoints': [
                    {
                        'sourceVolume': 'string',
                        'containerPath': 'string',
                        'readOnly': True|False
                    },
                ],
                'volumesFrom': [
                    {
                        'sourceContainer': 'string',
                        'readOnly': True|False
                    },
                ],
                'linuxParameters': {
                    'capabilities': {
                        'add': [
                            'string',
                        ],
                        'drop': [
                            'string',
                        ]
                    },
                    'devices': [
                        {
                            'hostPath': 'string',
                            'containerPath': 'string',
                            'permissions': [
                                'read'|'write'|'mknod',
                            ]
                        },
                    ],
                    'initProcessEnabled': True|False
                },
                'hostname': 'string',
                'user': 'string',
                'workingDirectory': 'string',
                'disableNetworking': True|False,
                'privileged': True|False,
                'readonlyRootFilesystem': True|False,
                'dnsServers': [
                    'string',
                ],
                'dnsSearchDomains': [
                    'string',
                ],
                'extraHosts': [
                    {
                        'hostname': 'string',
                        'ipAddress': 'string'
                    },
                ],
                'dockerSecurityOptions': [
                    'string',
                ],
                'dockerLabels': {
                    'string': 'string'
                },
                'ulimits': [
                    {
                        'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
                        'softLimit': 123,
                        'hardLimit': 123
                    },
                ],
                'logConfiguration': {
                    'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
                    'options': {
                        'string': 'string'
                    }
                }
            },
        ],
        'family': 'string',
        'taskRoleArn': 'string',
        'networkMode': 'bridge'|'host'|'awsvpc'|'none',
        'revision': 123,
        'volumes': [
            {
                'name': 'string',
                'host': {
                    'sourcePath': 'string'
                }
            },
        ],
        'status': 'ACTIVE'|'INACTIVE',
        'requiresAttributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'placementConstraints': [
            {
                'type': 'memberOf',
                'expression': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- taskDefinition (dict) --
  
  The full description of the deregistered task.
  - taskDefinitionArn (string) --
    
    The full Amazon Resource Name (ARN) of the task definition.
  - containerDefinitions (list) --
    
    A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - (dict) --
      
      Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
      - name (string) --
        
        The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
      - image (string) --
        
        The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
        
        Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
        
        Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
        
        Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
        
        Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
      - cpu (integer) --
        
        The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
        
        Note
        
        You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
        
        For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
        
        The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
        
        Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
        
        Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
      - memory (integer) --
        
        The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
        
        You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
        
        The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
      - memoryReservation (integer) --
        
        The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
        
        You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
        
        For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
      - links (list) --
        
        The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
        
        Warning
        
        Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
        
        (string) --
      - portMappings (list) --
        
        The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you cannot specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
        
        Note
        
        After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.
        
        (dict) --
        
        Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        containerPort (integer) --
        
        The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
        
        hostPort (integer) --
        
        The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
        
        The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range of 49153 to 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
        
        Note
        
        The default ephemeral port range of 49153 to 65535 will always be used for Docker versions prior to 1.6.0.
        
        The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
        
        protocol (string) --
        
        The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
      - essential (boolean) --
        
        If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
        
        All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
      - entryPoint (list) --
        
        Warning
        
        Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
        
        The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
        
        (string) --
      - command (list) --
        
        The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
        
        (string) --
      - environment (list) --
        
        The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
        
        Warning
        
        We do not recommend using plain text environment variables for sensitive information, such as credential data.
        
        (dict) --
        
        A key and value pair object.
        
        name (string) --
        
        The name of the key value pair. For environment variables, this is the name of the environment variable.
        
        value (string) --
        
        The value of the key value pair. For environment variables, this is the value of the environment variable.
      - mountPoints (list) --
        
        The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
        
        (dict) --
        
        Details on a volume mount point that is used in a container definition.
        
        sourceVolume (string) --
        
        The name of the volume to mount.
        
        containerPath (string) --
        
        The path on the container to mount the host volume at.
        
        readOnly (boolean) --
        
        If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
      - volumesFrom (list) --
        
        Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
        
        (dict) --
        
        Details on a data volume from another container in the same task definition.
        
        sourceContainer (string) --
        
        The name of another container within the same task definition to mount volumes from.
        
        readOnly (boolean) --
        
        If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
      - linuxParameters (dict) --
        
        Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.
        
        capabilities (dict) --
        
        The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
        
        add (list) --
        
        The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.
        
        Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
        
        (string) --
        
        drop (list) --
        
        The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.
        
        Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
        
        (string) --
        
        devices (list) --
        
        Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
        
        (dict) --
        
        An object representing a container instance host device.
        
        hostPath (string) --
        
        The path for the device on the host container instance.
        
        containerPath (string) --
        
        The path inside the container at which to expose the host device.
        
        permissions (list) --
        
        The explicit permissions to provide to the container for the device. By default, the container will be able to read, write, and mknod the device.
        
        (string) --
        
        initProcessEnabled (boolean) --
        
        Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
      - hostname (string) --
        
        The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
      - user (string) --
        
        The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
      - workingDirectory (string) --
        
        The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
      - disableNetworking (boolean) --
        
        When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
      - privileged (boolean) --
        
        When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
      - readonlyRootFilesystem (boolean) --
        
        When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
      - dnsServers (list) --
        
        A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
        
        (string) --
      - dnsSearchDomains (list) --
        
        A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
        
        (string) --
      - extraHosts (list) --
        
        A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
        
        (dict) --
        
        Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
        
        hostname (string) --
        
        The hostname to use in the /etc/hosts entry.
        
        ipAddress (string) --
        
        The IP address to use in the /etc/hosts entry.
      - dockerSecurityOptions (list) --
        
        A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
        
        Note
        
        The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
        
        (string) --
      - dockerLabels (dict) --
        
        A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (string) --
        
        (string) --
      - ulimits (list) --
        
        A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (dict) --
        
        The ulimit settings to pass to the container.
        
        name (string) --
        
        The type of the ulimit.
        
        softLimit (integer) --
        
        The soft limit for the ulimit type.
        
        hardLimit (integer) --
        
        The hard limit for the ulimit type.
      - logConfiguration (dict) --
        
        The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
        
        Note
        
        Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
        
        This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        Note
        
        The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
        
        logDriver (string) --
        
        The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
        
        Note
        
        If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.
        
        This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        options (dict) --
        
        The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (string) --
        
        (string) --
  - family (string) --
    
    The family of your task definition, used as the definition name.
  - 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.
  - networkMode (string) --
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.
    
    If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. If the network mode is awsvpc, the task is allocated an Elastic Network Interface. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    For more information, see Network settings in the Docker run reference.
  - revision (integer) --
    
    The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).
  - volumes (list) --
    
    The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - (dict) --
      
      A data volume used in a task definition.
      - name (string) --
        
        The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
      - host (dict) --
        
        The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
        
        sourcePath (string) --
        
        The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
  - status (string) --
    
    The status of the task definition.
  - requiresAttributes (list) --
    
    The container instance attributes required by your task.
    - (dict) --
      
      An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon EC2 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 Amazon Resource Name (ARN).
      - targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
  - placementConstraints (list) --
    
    An array of placement constraint objects to use for tasks.
    - (dict) --
      
      An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
      - type (string) --
        
        The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
      - expression (string) --
        
        A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

DescribeContainerInstances (updated)

Link ¶
Changes (response)

{'containerInstances': {'attachments': [{'details': [{'name': 'string',
                                                      'value': 'string'}],
                                         'id': 'string',
                                         'status': 'string',
                                         'type': 'string'}]}}

Describes Amazon EC2 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',
    ]
)

type cluster:

string

param cluster:

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.

type containerInstances:

list

param containerInstances:

[REQUIRED]

A list of container instance IDs or full Amazon Resource Name (ARN) entries.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'containerInstances': [
        {
            'containerInstanceArn': 'string',
            'ec2InstanceId': 'string',
            'version': 123,
            'versionInfo': {
                'agentVersion': 'string',
                'agentHash': 'string',
                'dockerVersion': 'string'
            },
            'remainingResources': [
                {
                    'name': 'string',
                    'type': 'string',
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'integerValue': 123,
                    'stringSetValue': [
                        'string',
                    ]
                },
            ],
            'registeredResources': [
                {
                    'name': 'string',
                    'type': 'string',
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'integerValue': 123,
                    'stringSetValue': [
                        'string',
                    ]
                },
            ],
            'status': 'string',
            'agentConnected': True|False,
            'runningTasksCount': 123,
            'pendingTasksCount': 123,
            'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string',
                    'targetType': 'container-instance',
                    'targetId': 'string'
                },
            ],
            'registeredAt': datetime(2015, 1, 1),
            'attachments': [
                {
                    'id': 'string',
                    'type': 'string',
                    'status': 'string',
                    'details': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- containerInstances (list) --
  
  The list of container instances.
  - (dict) --
    
    An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
    - containerInstanceArn (string) --
      
      The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID ``.
    - ec2InstanceId (string) --
      
      The EC2 instance ID of the container instance.
    - version (integer) --
      
      The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
    - versionInfo (dict) --
      
      The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
      - agentVersion (string) --
        
        The version number of the Amazon ECS container agent.
      - agentHash (string) --
        
        The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
      - dockerVersion (string) --
        
        The Docker version running on the container instance.
    - remainingResources (list) --
      
      For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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, 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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, 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 ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide.
    - agentConnected (boolean) --
      
      This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot 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 EC2 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 Amazon Resource Name (ARN).
        
        targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
    - registeredAt (datetime) --
      
      The Unix timestamp for when the container instance was registered.
    - attachments (list) --
      
      The Elastic Network Interfaces associated with the container instance.
      - (dict) --
        
        An object representing a container instance or task attachment.
        
        id (string) --
        
        The unique identifier for the attachment.
        
        type (string) --
        
        The type of the attachment, such as an 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 and 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.
- 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.

DescribeServices (updated)

Link ¶
Changes (response)

{'services': {'deployments': {'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                                               'subnets': ['string']}}},
              'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                               'subnets': ['string']}}}}

Describes the specified services running in your cluster.

See also: AWS API Documentation

Request Syntax

client.describe_services(
    cluster='string',
    services=[
        'string',
    ]
)

type cluster:

string

param cluster:

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.

type services:

list

param services:

[REQUIRED]

A list of services to describe. You may specify up to 10 services to describe in a single operation.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'services': [
        {
            'serviceArn': 'string',
            'serviceName': 'string',
            'clusterArn': 'string',
            'loadBalancers': [
                {
                    'targetGroupArn': 'string',
                    'loadBalancerName': 'string',
                    'containerName': 'string',
                    'containerPort': 123
                },
            ],
            'status': 'string',
            'desiredCount': 123,
            'runningCount': 123,
            'pendingCount': 123,
            'taskDefinition': 'string',
            'deploymentConfiguration': {
                'maximumPercent': 123,
                'minimumHealthyPercent': 123
            },
            'deployments': [
                {
                    'id': 'string',
                    'status': 'string',
                    'taskDefinition': 'string',
                    'desiredCount': 123,
                    'pendingCount': 123,
                    'runningCount': 123,
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'networkConfiguration': {
                        'awsvpcConfiguration': {
                            'subnets': [
                                'string',
                            ],
                            'securityGroups': [
                                'string',
                            ]
                        }
                    }
                },
            ],
            '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',
                    ]
                }
            }
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- services (list) --
  
  The list of services described.
  - (dict) --
    
    Details on a service within a cluster
    - serviceArn (string) --
      
      The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region:012345678910:service/my-service ``.
    - serviceName (string) --
      
      The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
    - clusterArn (string) --
      
      The Amazon Resource Name (ARN) of the cluster that hosts the service.
    - loadBalancers (list) --
      
      A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
      - (dict) --
        
        Details on a load balancer that is used with a service.
        
        targetGroupArn (string) --
        
        The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
        
        loadBalancerName (string) --
        
        The name of a load balancer.
        
        containerName (string) --
        
        The name of the container (as it appears in a container definition) to associate with the load balancer.
        
        containerPort (integer) --
        
        The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
    - 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.
    - 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) --
        
        The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.
      - minimumHealthyPercent (integer) --
        
        The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.
    - deployments (list) --
      
      The current state of deployments for the service.
      - (dict) --
        
        The details of an Amazon ECS service deployment.
        
        id (string) --
        
        The ID of the deployment.
        
        status (string) --
        
        The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).
        
        taskDefinition (string) --
        
        The most recent task definition that was specified for 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 was created.
        
        updatedAt (datetime) --
        
        The Unix timestamp for when the service was last updated.
        
        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.
        
        subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --
    - roleArn (string) --
      
      The Amazon Resource Name (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 EC2 Container Service Developer Guide.
        
        type (string) --
        
        The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
        
        expression (string) --
        
        A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 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 EC2 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.
        
        subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --
- 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.

DescribeTaskDefinition (updated)

Link ¶
Changes (response)

{'taskDefinition': {'networkMode': {'awsvpc'}}}

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

See also: AWS API Documentation

Request Syntax

client.describe_task_definition(
    taskDefinition='string'
)

type taskDefinition:

string

param taskDefinition:

[REQUIRED]

The family for the latest ACTIVE revision, family and revision ( family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

rtype:

dict

returns:

Response Syntax

{
    'taskDefinition': {
        'taskDefinitionArn': 'string',
        'containerDefinitions': [
            {
                'name': 'string',
                'image': 'string',
                'cpu': 123,
                'memory': 123,
                'memoryReservation': 123,
                'links': [
                    'string',
                ],
                'portMappings': [
                    {
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'essential': True|False,
                'entryPoint': [
                    'string',
                ],
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'mountPoints': [
                    {
                        'sourceVolume': 'string',
                        'containerPath': 'string',
                        'readOnly': True|False
                    },
                ],
                'volumesFrom': [
                    {
                        'sourceContainer': 'string',
                        'readOnly': True|False
                    },
                ],
                'linuxParameters': {
                    'capabilities': {
                        'add': [
                            'string',
                        ],
                        'drop': [
                            'string',
                        ]
                    },
                    'devices': [
                        {
                            'hostPath': 'string',
                            'containerPath': 'string',
                            'permissions': [
                                'read'|'write'|'mknod',
                            ]
                        },
                    ],
                    'initProcessEnabled': True|False
                },
                'hostname': 'string',
                'user': 'string',
                'workingDirectory': 'string',
                'disableNetworking': True|False,
                'privileged': True|False,
                'readonlyRootFilesystem': True|False,
                'dnsServers': [
                    'string',
                ],
                'dnsSearchDomains': [
                    'string',
                ],
                'extraHosts': [
                    {
                        'hostname': 'string',
                        'ipAddress': 'string'
                    },
                ],
                'dockerSecurityOptions': [
                    'string',
                ],
                'dockerLabels': {
                    'string': 'string'
                },
                'ulimits': [
                    {
                        'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
                        'softLimit': 123,
                        'hardLimit': 123
                    },
                ],
                'logConfiguration': {
                    'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
                    'options': {
                        'string': 'string'
                    }
                }
            },
        ],
        'family': 'string',
        'taskRoleArn': 'string',
        'networkMode': 'bridge'|'host'|'awsvpc'|'none',
        'revision': 123,
        'volumes': [
            {
                'name': 'string',
                'host': {
                    'sourcePath': 'string'
                }
            },
        ],
        'status': 'ACTIVE'|'INACTIVE',
        'requiresAttributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'placementConstraints': [
            {
                'type': 'memberOf',
                'expression': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- taskDefinition (dict) --
  
  The full task definition description.
  - taskDefinitionArn (string) --
    
    The full Amazon Resource Name (ARN) of the task definition.
  - containerDefinitions (list) --
    
    A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - (dict) --
      
      Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
      - name (string) --
        
        The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
      - image (string) --
        
        The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
        
        Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
        
        Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
        
        Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
        
        Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
      - cpu (integer) --
        
        The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
        
        Note
        
        You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
        
        For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
        
        The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
        
        Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
        
        Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
      - memory (integer) --
        
        The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
        
        You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
        
        The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
      - memoryReservation (integer) --
        
        The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
        
        You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
        
        For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
      - links (list) --
        
        The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
        
        Warning
        
        Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
        
        (string) --
      - portMappings (list) --
        
        The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you cannot specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
        
        Note
        
        After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.
        
        (dict) --
        
        Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        containerPort (integer) --
        
        The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
        
        hostPort (integer) --
        
        The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
        
        The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range of 49153 to 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
        
        Note
        
        The default ephemeral port range of 49153 to 65535 will always be used for Docker versions prior to 1.6.0.
        
        The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
        
        protocol (string) --
        
        The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
      - essential (boolean) --
        
        If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
        
        All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
      - entryPoint (list) --
        
        Warning
        
        Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
        
        The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
        
        (string) --
      - command (list) --
        
        The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
        
        (string) --
      - environment (list) --
        
        The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
        
        Warning
        
        We do not recommend using plain text environment variables for sensitive information, such as credential data.
        
        (dict) --
        
        A key and value pair object.
        
        name (string) --
        
        The name of the key value pair. For environment variables, this is the name of the environment variable.
        
        value (string) --
        
        The value of the key value pair. For environment variables, this is the value of the environment variable.
      - mountPoints (list) --
        
        The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
        
        (dict) --
        
        Details on a volume mount point that is used in a container definition.
        
        sourceVolume (string) --
        
        The name of the volume to mount.
        
        containerPath (string) --
        
        The path on the container to mount the host volume at.
        
        readOnly (boolean) --
        
        If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
      - volumesFrom (list) --
        
        Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
        
        (dict) --
        
        Details on a data volume from another container in the same task definition.
        
        sourceContainer (string) --
        
        The name of another container within the same task definition to mount volumes from.
        
        readOnly (boolean) --
        
        If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
      - linuxParameters (dict) --
        
        Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.
        
        capabilities (dict) --
        
        The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
        
        add (list) --
        
        The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.
        
        Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
        
        (string) --
        
        drop (list) --
        
        The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.
        
        Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
        
        (string) --
        
        devices (list) --
        
        Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
        
        (dict) --
        
        An object representing a container instance host device.
        
        hostPath (string) --
        
        The path for the device on the host container instance.
        
        containerPath (string) --
        
        The path inside the container at which to expose the host device.
        
        permissions (list) --
        
        The explicit permissions to provide to the container for the device. By default, the container will be able to read, write, and mknod the device.
        
        (string) --
        
        initProcessEnabled (boolean) --
        
        Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
      - hostname (string) --
        
        The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
      - user (string) --
        
        The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
      - workingDirectory (string) --
        
        The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
      - disableNetworking (boolean) --
        
        When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
      - privileged (boolean) --
        
        When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
      - readonlyRootFilesystem (boolean) --
        
        When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
      - dnsServers (list) --
        
        A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
        
        (string) --
      - dnsSearchDomains (list) --
        
        A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
        
        (string) --
      - extraHosts (list) --
        
        A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
        
        (dict) --
        
        Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
        
        hostname (string) --
        
        The hostname to use in the /etc/hosts entry.
        
        ipAddress (string) --
        
        The IP address to use in the /etc/hosts entry.
      - dockerSecurityOptions (list) --
        
        A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
        
        Note
        
        The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
        
        (string) --
      - dockerLabels (dict) --
        
        A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (string) --
        
        (string) --
      - ulimits (list) --
        
        A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (dict) --
        
        The ulimit settings to pass to the container.
        
        name (string) --
        
        The type of the ulimit.
        
        softLimit (integer) --
        
        The soft limit for the ulimit type.
        
        hardLimit (integer) --
        
        The hard limit for the ulimit type.
      - logConfiguration (dict) --
        
        The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
        
        Note
        
        Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
        
        This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        Note
        
        The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
        
        logDriver (string) --
        
        The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
        
        Note
        
        If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.
        
        This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        options (dict) --
        
        The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (string) --
        
        (string) --
  - family (string) --
    
    The family of your task definition, used as the definition name.
  - 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.
  - networkMode (string) --
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.
    
    If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. If the network mode is awsvpc, the task is allocated an Elastic Network Interface. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    For more information, see Network settings in the Docker run reference.
  - revision (integer) --
    
    The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).
  - volumes (list) --
    
    The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - (dict) --
      
      A data volume used in a task definition.
      - name (string) --
        
        The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
      - host (dict) --
        
        The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
        
        sourcePath (string) --
        
        The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
  - status (string) --
    
    The status of the task definition.
  - requiresAttributes (list) --
    
    The container instance attributes required by your task.
    - (dict) --
      
      An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon EC2 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 Amazon Resource Name (ARN).
      - targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
  - placementConstraints (list) --
    
    An array of placement constraint objects to use for tasks.
    - (dict) --
      
      An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
      - type (string) --
        
        The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
      - expression (string) --
        
        A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

DescribeTasks (updated)

Link ¶
Changes (response)

{'tasks': {'attachments': [{'details': [{'name': 'string', 'value': 'string'}],
                            'id': 'string',
                            'status': 'string',
                            'type': 'string'}],
           'containers': {'networkInterfaces': [{'attachmentId': 'string',
                                                 'ipv6Address': 'string',
                                                 'privateIpv4Address': 'string'}]}}}

Describes a specified task or tasks.

See also: AWS API Documentation

Request Syntax

client.describe_tasks(
    cluster='string',
    tasks=[
        'string',
    ]
)

type cluster:

string

param cluster:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.

type tasks:

list

param tasks:

[REQUIRED]

A list of up to 100 task IDs or full Amazon Resource Name (ARN) entries.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'tasks': [
        {
            'taskArn': 'string',
            'clusterArn': 'string',
            'taskDefinitionArn': 'string',
            'containerInstanceArn': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'cpu': 123,
                        'memory': 123,
                        'memoryReservation': 123
                    },
                ],
                'taskRoleArn': 'string'
            },
            'lastStatus': 'string',
            'desiredStatus': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp'
                        },
                    ],
                    'networkInterfaces': [
                        {
                            'attachmentId': 'string',
                            'privateIpv4Address': 'string',
                            'ipv6Address': 'string'
                        },
                    ]
                },
            ],
            'startedBy': 'string',
            'version': 123,
            'stoppedReason': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'group': 'string',
            'attachments': [
                {
                    'id': 'string',
                    'type': 'string',
                    'status': 'string',
                    'details': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- tasks (list) --
  
  The list of tasks.
  - (dict) --
    
    Details on a task in a cluster.
    - taskArn (string) --
      
      The Amazon Resource Name (ARN) of the task.
    - clusterArn (string) --
      
      The Amazon Resource Name (ARN) of the cluster that hosts the task.
    - taskDefinitionArn (string) --
      
      The Amazon Resource Name (ARN) of the task definition that creates the task.
    - containerInstanceArn (string) --
      
      The Amazon Resource Name (ARN) of the container instances that host the task.
    - overrides (dict) --
      
      One or more container overrides.
      - containerOverrides (list) --
        
        One or more container overrides sent to a task.
        
        (dict) --
        
        The overrides that should be sent to a container.
        
        name (string) --
        
        The name of the container that receives the override. This parameter is required if any override is specified.
        
        command (list) --
        
        The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
        
        (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 and 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.
      - 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.
    - lastStatus (string) --
      
      The last known status of the task.
    - desiredStatus (string) --
      
      The desired status of 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 Amazon Resource Name (ARN) of the task.
        
        name (string) --
        
        The name of the container.
        
        lastStatus (string) --
        
        The last known status of the container.
        
        exitCode (integer) --
        
        The exit code returned from the container.
        
        reason (string) --
        
        A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
        
        networkBindings (list) --
        
        The network bindings associated with the container.
        
        (dict) --
        
        Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        bindIP (string) --
        
        The IP address that the container is bound to on the container instance.
        
        containerPort (integer) --
        
        The port number on the container that is be 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.
    - startedBy (string) --
      
      The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
    - version (integer) --
      
      The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
    - stoppedReason (string) --
      
      The reason the task was stopped.
    - createdAt (datetime) --
      
      The Unix timestamp for when the task was created (the task entered the PENDING state).
    - startedAt (datetime) --
      
      The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
    - stoppedAt (datetime) --
      
      The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    - group (string) --
      
      The name of the task group associated with the task.
    - 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 an 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 and 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.
- 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.

RegisterContainerInstance (updated)

Link ¶
Changes (response)

{'containerInstance': {'attachments': [{'details': [{'name': 'string',
                                                     'value': 'string'}],
                                        'id': 'string',
                                        'status': 'string',
                                        'type': 'string'}]}}

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'
        },
    ]
)

type cluster:

string

param cluster:

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.

type instanceIdentityDocument:

string

param instanceIdentityDocument:

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/

type instanceIdentityDocumentSignature:

string

param instanceIdentityDocumentSignature:

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/

type totalResources:

list

param totalResources:

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, 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) --

type versionInfo:

dict

param versionInfo:

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.

type containerInstanceArn:

string

param containerInstanceArn:

The Amazon Resource Name (ARN) of the container instance (if it was previously registered).

type attributes:

list

param attributes:

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 EC2 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 Amazon Resource Name (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).

rtype:

dict

returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'version': 123,
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
        'attributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'registeredAt': datetime(2015, 1, 1),
        'attachments': [
            {
                'id': 'string',
                'type': 'string',
                'status': 'string',
                'details': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

(dict) --
- containerInstance (dict) --
  
  The container instance that was registered.
  - containerInstanceArn (string) --
    
    The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID ``.
  - ec2InstanceId (string) --
    
    The EC2 instance ID of the container instance.
  - version (integer) --
    
    The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
  - versionInfo (dict) --
    
    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
    - agentVersion (string) --
      
      The version number of the Amazon ECS container agent.
    - agentHash (string) --
      
      The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
    - dockerVersion (string) --
      
      The Docker version running on the container instance.
  - remainingResources (list) --
    
    For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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, 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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, 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 ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide.
  - agentConnected (boolean) --
    
    This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot 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 EC2 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 Amazon Resource Name (ARN).
      - targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
  - registeredAt (datetime) --
    
    The Unix timestamp for when the container instance was registered.
  - attachments (list) --
    
    The Elastic Network Interfaces associated with the container instance.
    - (dict) --
      
      An object representing a container instance or task attachment.
      - id (string) --
        
        The unique identifier for the attachment.
      - type (string) --
        
        The type of the attachment, such as an 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 and 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.

RegisterTaskDefinition (updated)

Link ¶
Changes (request, response)
Request

{'networkMode': {'awsvpc'}}

Response

{'taskDefinition': {'networkMode': {'awsvpc'}}}

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference.

See also: AWS API Documentation

Request Syntax

client.register_task_definition(
    family='string',
    taskRoleArn='string',
    networkMode='bridge'|'host'|'awsvpc'|'none',
    containerDefinitions=[
        {
            'name': 'string',
            'image': 'string',
            'cpu': 123,
            'memory': 123,
            'memoryReservation': 123,
            'links': [
                'string',
            ],
            'portMappings': [
                {
                    'containerPort': 123,
                    'hostPort': 123,
                    'protocol': 'tcp'|'udp'
                },
            ],
            'essential': True|False,
            'entryPoint': [
                'string',
            ],
            'command': [
                'string',
            ],
            'environment': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'mountPoints': [
                {
                    'sourceVolume': 'string',
                    'containerPath': 'string',
                    'readOnly': True|False
                },
            ],
            'volumesFrom': [
                {
                    'sourceContainer': 'string',
                    'readOnly': True|False
                },
            ],
            'linuxParameters': {
                'capabilities': {
                    'add': [
                        'string',
                    ],
                    'drop': [
                        'string',
                    ]
                },
                'devices': [
                    {
                        'hostPath': 'string',
                        'containerPath': 'string',
                        'permissions': [
                            'read'|'write'|'mknod',
                        ]
                    },
                ],
                'initProcessEnabled': True|False
            },
            'hostname': 'string',
            'user': 'string',
            'workingDirectory': 'string',
            'disableNetworking': True|False,
            'privileged': True|False,
            'readonlyRootFilesystem': True|False,
            'dnsServers': [
                'string',
            ],
            'dnsSearchDomains': [
                'string',
            ],
            'extraHosts': [
                {
                    'hostname': 'string',
                    'ipAddress': 'string'
                },
            ],
            'dockerSecurityOptions': [
                'string',
            ],
            'dockerLabels': {
                'string': 'string'
            },
            'ulimits': [
                {
                    'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
                    'softLimit': 123,
                    'hardLimit': 123
                },
            ],
            'logConfiguration': {
                'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
                'options': {
                    'string': 'string'
                }
            }
        },
    ],
    volumes=[
        {
            'name': 'string',
            'host': {
                'sourcePath': 'string'
            }
        },
    ],
    placementConstraints=[
        {
            'type': 'memberOf',
            'expression': 'string'
        },
    ]
)

type family:

string

param family:

[REQUIRED]

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

type taskRoleArn:

string

param taskRoleArn:

The short name or full 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. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

type networkMode:

string

param networkMode:

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

type containerDefinitions:

list

param containerDefinitions:

[REQUIRED]

A list of container definitions in JSON format that describe the different containers that make up your task.

(dict) --

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
- name (string) --
  
  The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
- image (string) --
  
  The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
  - Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
  - Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
  - Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
  - Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
- cpu (integer) --
  
  The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
  
  Note
  
  You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
  
  For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
  
  The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
  - Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
  - Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
- memory (integer) --
  
  The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
  
  You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
  
  The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
- memoryReservation (integer) --
  
  The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
  
  You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
  
  For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
- links (list) --
  
  The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
  
  Warning
  
  Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
  - (string) --
- portMappings (list) --
  
  The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you cannot specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
  
  Note
  
  After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.
  - (dict) --
    
    Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
    - containerPort (integer) --
      
      The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
    - hostPort (integer) --
      
      The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
      
      The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range of 49153 to 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
      
      Note
      
      The default ephemeral port range of 49153 to 65535 will always be used for Docker versions prior to 1.6.0.
      
      The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
    - protocol (string) --
      
      The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
- essential (boolean) --
  
  If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
  
  All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
- entryPoint (list) --
  
  Warning
  
  Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
  
  The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
  - (string) --
- command (list) --
  
  The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
  - (string) --
- environment (list) --
  
  The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
  
  Warning
  
  We do not recommend using plain text environment variables for sensitive information, such as credential data.
  - (dict) --
    
    A key and value pair object.
    - name (string) --
      
      The name of the key value pair. For environment variables, this is the name of the environment variable.
    - value (string) --
      
      The value of the key value pair. For environment variables, this is the value of the environment variable.
- mountPoints (list) --
  
  The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
  - (dict) --
    
    Details on a volume mount point that is used in a container definition.
    - sourceVolume (string) --
      
      The name of the volume to mount.
    - containerPath (string) --
      
      The path on the container to mount the host volume at.
    - readOnly (boolean) --
      
      If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
- volumesFrom (list) --
  
  Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
  - (dict) --
    
    Details on a data volume from another container in the same task definition.
    - sourceContainer (string) --
      
      The name of another container within the same task definition to mount volumes from.
    - readOnly (boolean) --
      
      If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
- linuxParameters (dict) --
  
  Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.
  - capabilities (dict) --
    
    The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
    - add (list) --
      
      The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.
      
      Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
      - (string) --
    - drop (list) --
      
      The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.
      
      Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
      - (string) --
  - devices (list) --
    
    Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
    - (dict) --
      
      An object representing a container instance host device.
      - hostPath (string) -- [REQUIRED]
        
        The path for the device on the host container instance.
      - containerPath (string) --
        
        The path inside the container at which to expose the host device.
      - permissions (list) --
        
        The explicit permissions to provide to the container for the device. By default, the container will be able to read, write, and mknod the device.
        
        (string) --
  - initProcessEnabled (boolean) --
    
    Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
- hostname (string) --
  
  The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
- user (string) --
  
  The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
- workingDirectory (string) --
  
  The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
- disableNetworking (boolean) --
  
  When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
- privileged (boolean) --
  
  When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
- readonlyRootFilesystem (boolean) --
  
  When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
- dnsServers (list) --
  
  A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
  - (string) --
- dnsSearchDomains (list) --
  
  A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
  - (string) --
- extraHosts (list) --
  
  A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
  - (dict) --
    
    Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
    - hostname (string) -- [REQUIRED]
      
      The hostname to use in the /etc/hosts entry.
    - ipAddress (string) -- [REQUIRED]
      
      The IP address to use in the /etc/hosts entry.
- dockerSecurityOptions (list) --
  
  A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
  
  Note
  
  The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
  - (string) --
- dockerLabels (dict) --
  
  A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
  - (string) --
    - (string) --
- ulimits (list) --
  
  A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
  - (dict) --
    
    The ulimit settings to pass to the container.
    - name (string) -- [REQUIRED]
      
      The type of the ulimit.
    - softLimit (integer) -- [REQUIRED]
      
      The soft limit for the ulimit type.
    - hardLimit (integer) -- [REQUIRED]
      
      The hard limit for the ulimit type.
- logConfiguration (dict) --
  
  The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
  
  Note
  
  Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
  
  This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
  
  Note
  
  The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
  - logDriver (string) -- [REQUIRED]
    
    The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
    
    Note
    
    If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.
    
    This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
  - options (dict) --
    
    The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
    - (string) --
      - (string) --

type volumes:

list

param volumes:

A list of volume definitions in JSON format that containers in your task may use.

(dict) --

A data volume used in a task definition.
- name (string) --
  
  The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
- host (dict) --
  
  The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
  - sourcePath (string) --
    
    The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

type placementConstraints:

list

param placementConstraints:

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

(dict) --

An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
- type (string) --
  
  The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
- expression (string) --
  
  A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

rtype:

dict

returns:

Response Syntax

{
    'taskDefinition': {
        'taskDefinitionArn': 'string',
        'containerDefinitions': [
            {
                'name': 'string',
                'image': 'string',
                'cpu': 123,
                'memory': 123,
                'memoryReservation': 123,
                'links': [
                    'string',
                ],
                'portMappings': [
                    {
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'essential': True|False,
                'entryPoint': [
                    'string',
                ],
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'mountPoints': [
                    {
                        'sourceVolume': 'string',
                        'containerPath': 'string',
                        'readOnly': True|False
                    },
                ],
                'volumesFrom': [
                    {
                        'sourceContainer': 'string',
                        'readOnly': True|False
                    },
                ],
                'linuxParameters': {
                    'capabilities': {
                        'add': [
                            'string',
                        ],
                        'drop': [
                            'string',
                        ]
                    },
                    'devices': [
                        {
                            'hostPath': 'string',
                            'containerPath': 'string',
                            'permissions': [
                                'read'|'write'|'mknod',
                            ]
                        },
                    ],
                    'initProcessEnabled': True|False
                },
                'hostname': 'string',
                'user': 'string',
                'workingDirectory': 'string',
                'disableNetworking': True|False,
                'privileged': True|False,
                'readonlyRootFilesystem': True|False,
                'dnsServers': [
                    'string',
                ],
                'dnsSearchDomains': [
                    'string',
                ],
                'extraHosts': [
                    {
                        'hostname': 'string',
                        'ipAddress': 'string'
                    },
                ],
                'dockerSecurityOptions': [
                    'string',
                ],
                'dockerLabels': {
                    'string': 'string'
                },
                'ulimits': [
                    {
                        'name': 'core'|'cpu'|'data'|'fsize'|'locks'|'memlock'|'msgqueue'|'nice'|'nofile'|'nproc'|'rss'|'rtprio'|'rttime'|'sigpending'|'stack',
                        'softLimit': 123,
                        'hardLimit': 123
                    },
                ],
                'logConfiguration': {
                    'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
                    'options': {
                        'string': 'string'
                    }
                }
            },
        ],
        'family': 'string',
        'taskRoleArn': 'string',
        'networkMode': 'bridge'|'host'|'awsvpc'|'none',
        'revision': 123,
        'volumes': [
            {
                'name': 'string',
                'host': {
                    'sourcePath': 'string'
                }
            },
        ],
        'status': 'ACTIVE'|'INACTIVE',
        'requiresAttributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'placementConstraints': [
            {
                'type': 'memberOf',
                'expression': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- taskDefinition (dict) --
  
  The full description of the registered task definition.
  - taskDefinitionArn (string) --
    
    The full Amazon Resource Name (ARN) of the task definition.
  - containerDefinitions (list) --
    
    A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - (dict) --
      
      Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
      - name (string) --
        
        The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
      - image (string) --
        
        The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
        
        Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
        
        Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
        
        Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
        
        Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
      - cpu (integer) --
        
        The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
        
        Note
        
        You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
        
        For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
        
        The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
        
        Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
        
        Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
      - memory (integer) --
        
        The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
        
        You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
        
        The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
      - memoryReservation (integer) --
        
        The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
        
        You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
        
        For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
      - links (list) --
        
        The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
        
        Warning
        
        Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
        
        (string) --
      - portMappings (list) --
        
        The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you cannot specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
        
        Note
        
        After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.
        
        (dict) --
        
        Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        containerPort (integer) --
        
        The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
        
        hostPort (integer) --
        
        The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
        
        The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range of 49153 to 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
        
        Note
        
        The default ephemeral port range of 49153 to 65535 will always be used for Docker versions prior to 1.6.0.
        
        The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
        
        protocol (string) --
        
        The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
      - essential (boolean) --
        
        If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
        
        All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
      - entryPoint (list) --
        
        Warning
        
        Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
        
        The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
        
        (string) --
      - command (list) --
        
        The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
        
        (string) --
      - environment (list) --
        
        The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
        
        Warning
        
        We do not recommend using plain text environment variables for sensitive information, such as credential data.
        
        (dict) --
        
        A key and value pair object.
        
        name (string) --
        
        The name of the key value pair. For environment variables, this is the name of the environment variable.
        
        value (string) --
        
        The value of the key value pair. For environment variables, this is the value of the environment variable.
      - mountPoints (list) --
        
        The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
        
        (dict) --
        
        Details on a volume mount point that is used in a container definition.
        
        sourceVolume (string) --
        
        The name of the volume to mount.
        
        containerPath (string) --
        
        The path on the container to mount the host volume at.
        
        readOnly (boolean) --
        
        If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
      - volumesFrom (list) --
        
        Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
        
        (dict) --
        
        Details on a data volume from another container in the same task definition.
        
        sourceContainer (string) --
        
        The name of another container within the same task definition to mount volumes from.
        
        readOnly (boolean) --
        
        If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
      - linuxParameters (dict) --
        
        Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.
        
        capabilities (dict) --
        
        The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
        
        add (list) --
        
        The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.
        
        Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
        
        (string) --
        
        drop (list) --
        
        The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.
        
        Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
        
        (string) --
        
        devices (list) --
        
        Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
        
        (dict) --
        
        An object representing a container instance host device.
        
        hostPath (string) --
        
        The path for the device on the host container instance.
        
        containerPath (string) --
        
        The path inside the container at which to expose the host device.
        
        permissions (list) --
        
        The explicit permissions to provide to the container for the device. By default, the container will be able to read, write, and mknod the device.
        
        (string) --
        
        initProcessEnabled (boolean) --
        
        Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
      - hostname (string) --
        
        The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
      - user (string) --
        
        The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
      - workingDirectory (string) --
        
        The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
      - disableNetworking (boolean) --
        
        When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
      - privileged (boolean) --
        
        When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
      - readonlyRootFilesystem (boolean) --
        
        When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
      - dnsServers (list) --
        
        A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
        
        (string) --
      - dnsSearchDomains (list) --
        
        A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
        
        (string) --
      - extraHosts (list) --
        
        A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
        
        (dict) --
        
        Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
        
        hostname (string) --
        
        The hostname to use in the /etc/hosts entry.
        
        ipAddress (string) --
        
        The IP address to use in the /etc/hosts entry.
      - dockerSecurityOptions (list) --
        
        A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
        
        Note
        
        The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
        
        (string) --
      - dockerLabels (dict) --
        
        A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (string) --
        
        (string) --
      - ulimits (list) --
        
        A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (dict) --
        
        The ulimit settings to pass to the container.
        
        name (string) --
        
        The type of the ulimit.
        
        softLimit (integer) --
        
        The soft limit for the ulimit type.
        
        hardLimit (integer) --
        
        The hard limit for the ulimit type.
      - logConfiguration (dict) --
        
        The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
        
        Note
        
        Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
        
        This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        Note
        
        The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
        
        logDriver (string) --
        
        The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
        
        Note
        
        If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.
        
        This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        options (dict) --
        
        The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
        
        (string) --
        
        (string) --
  - family (string) --
    
    The family of your task definition, used as the definition name.
  - 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.
  - networkMode (string) --
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.
    
    If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. If the network mode is awsvpc, the task is allocated an Elastic Network Interface. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    For more information, see Network settings in the Docker run reference.
  - revision (integer) --
    
    The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).
  - volumes (list) --
    
    The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - (dict) --
      
      A data volume used in a task definition.
      - name (string) --
        
        The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
      - host (dict) --
        
        The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
        
        sourcePath (string) --
        
        The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
  - status (string) --
    
    The status of the task definition.
  - requiresAttributes (list) --
    
    The container instance attributes required by your task.
    - (dict) --
      
      An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon EC2 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 Amazon Resource Name (ARN).
      - targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
  - placementConstraints (list) --
    
    An array of placement constraint objects to use for tasks.
    - (dict) --
      
      An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
      - type (string) --
        
        The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
      - expression (string) --
        
        A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

RunTask (updated)

Link ¶
Changes (request, response)
Request

{'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                  'subnets': ['string']}}}

Response

{'tasks': {'attachments': [{'details': [{'name': 'string', 'value': 'string'}],
                            'id': 'string',
                            'status': 'string',
                            'type': 'string'}],
           'containers': {'networkInterfaces': [{'attachmentId': 'string',
                                                 'ipv6Address': 'string',
                                                 'privateIpv4Address': '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 EC2 Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

See also: AWS API Documentation

Request Syntax

client.run_task(
    cluster='string',
    taskDefinition='string',
    overrides={
        'containerOverrides': [
            {
                'name': 'string',
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'cpu': 123,
                'memory': 123,
                'memoryReservation': 123
            },
        ],
        'taskRoleArn': 'string'
    },
    count=123,
    startedBy='string',
    group='string',
    placementConstraints=[
        {
            'type': 'distinctInstance'|'memberOf',
            'expression': 'string'
        },
    ],
    placementStrategy=[
        {
            'type': 'random'|'spread'|'binpack',
            'field': 'string'
        },
    ],
    networkConfiguration={
        'awsvpcConfiguration': {
            'subnets': [
                'string',
            ],
            'securityGroups': [
                'string',
            ]
        }
    }
)

type cluster:

string

param cluster:

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.

type taskDefinition:

string

param taskDefinition:

[REQUIRED]

The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

type overrides:

dict

param overrides:

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.

containerOverrides (list) --

One or more container overrides sent to a task.
- (dict) --
  
  The overrides that should be sent to a container.
  - name (string) --
    
    The name of the container that receives the override. This parameter is required if any override is specified.
  - command (list) --
    
    The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
    - (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 and 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.
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.

type count:

integer

param count:

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

type startedBy:

string

param startedBy:

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.

type group:

string

param group:

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).

type placementConstraints:

list

param placementConstraints:

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 run time).

(dict) --

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
- type (string) --
  
  The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
- expression (string) --
  
  A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

type placementStrategy:

list

param placementStrategy:

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

(dict) --

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon EC2 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.

type networkConfiguration:

dict

param networkConfiguration:

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 EC2 Container Service Developer Guide.

awsvpcConfiguration (dict) --

The VPC subnets and security groups associated with a task.
- subnets (list) -- [REQUIRED]
  
  The subnets associated with the task or service.
  - (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.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'tasks': [
        {
            'taskArn': 'string',
            'clusterArn': 'string',
            'taskDefinitionArn': 'string',
            'containerInstanceArn': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'cpu': 123,
                        'memory': 123,
                        'memoryReservation': 123
                    },
                ],
                'taskRoleArn': 'string'
            },
            'lastStatus': 'string',
            'desiredStatus': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp'
                        },
                    ],
                    'networkInterfaces': [
                        {
                            'attachmentId': 'string',
                            'privateIpv4Address': 'string',
                            'ipv6Address': 'string'
                        },
                    ]
                },
            ],
            'startedBy': 'string',
            'version': 123,
            'stoppedReason': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'group': 'string',
            'attachments': [
                {
                    'id': 'string',
                    'type': 'string',
                    'status': 'string',
                    'details': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- tasks (list) --
  
  A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
  - (dict) --
    
    Details on a task in a cluster.
    - taskArn (string) --
      
      The Amazon Resource Name (ARN) of the task.
    - clusterArn (string) --
      
      The Amazon Resource Name (ARN) of the cluster that hosts the task.
    - taskDefinitionArn (string) --
      
      The Amazon Resource Name (ARN) of the task definition that creates the task.
    - containerInstanceArn (string) --
      
      The Amazon Resource Name (ARN) of the container instances that host the task.
    - overrides (dict) --
      
      One or more container overrides.
      - containerOverrides (list) --
        
        One or more container overrides sent to a task.
        
        (dict) --
        
        The overrides that should be sent to a container.
        
        name (string) --
        
        The name of the container that receives the override. This parameter is required if any override is specified.
        
        command (list) --
        
        The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
        
        (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 and 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.
      - 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.
    - lastStatus (string) --
      
      The last known status of the task.
    - desiredStatus (string) --
      
      The desired status of 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 Amazon Resource Name (ARN) of the task.
        
        name (string) --
        
        The name of the container.
        
        lastStatus (string) --
        
        The last known status of the container.
        
        exitCode (integer) --
        
        The exit code returned from the container.
        
        reason (string) --
        
        A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
        
        networkBindings (list) --
        
        The network bindings associated with the container.
        
        (dict) --
        
        Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        bindIP (string) --
        
        The IP address that the container is bound to on the container instance.
        
        containerPort (integer) --
        
        The port number on the container that is be 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.
    - startedBy (string) --
      
      The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
    - version (integer) --
      
      The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
    - stoppedReason (string) --
      
      The reason the task was stopped.
    - createdAt (datetime) --
      
      The Unix timestamp for when the task was created (the task entered the PENDING state).
    - startedAt (datetime) --
      
      The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
    - stoppedAt (datetime) --
      
      The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    - group (string) --
      
      The name of the task group associated with the task.
    - 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 an 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 and 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.
- 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.

StartTask (updated)

Link ¶
Changes (request, response)
Request

{'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                  'subnets': ['string']}}}

Response

{'tasks': {'attachments': [{'details': [{'name': 'string', 'value': 'string'}],
                            'id': 'string',
                            'status': 'string',
                            'type': 'string'}],
           'containers': {'networkInterfaces': [{'attachmentId': 'string',
                                                 'ipv6Address': 'string',
                                                 'privateIpv4Address': '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 EC2 Container Service Developer Guide.

See also: AWS API Documentation

Request Syntax

client.start_task(
    cluster='string',
    taskDefinition='string',
    overrides={
        'containerOverrides': [
            {
                'name': 'string',
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'cpu': 123,
                'memory': 123,
                'memoryReservation': 123
            },
        ],
        'taskRoleArn': 'string'
    },
    containerInstances=[
        'string',
    ],
    startedBy='string',
    group='string',
    networkConfiguration={
        'awsvpcConfiguration': {
            'subnets': [
                'string',
            ],
            'securityGroups': [
                'string',
            ]
        }
    }
)

type cluster:

string

param cluster:

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.

type taskDefinition:

string

param taskDefinition:

[REQUIRED]

The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

type overrides:

dict

param overrides:

containerOverrides (list) --

One or more container overrides sent to a task.
- (dict) --
  
  The overrides that should be sent to a container.
  - name (string) --
    
    The name of the container that receives the override. This parameter is required if any override is specified.
  - command (list) --
    
    The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
    - (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 and 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.
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.

type containerInstances:

list

param containerInstances:

[REQUIRED]

The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

(string) --

type startedBy:

string

param startedBy:

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

type group:

string

param group:

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).

type networkConfiguration:

dict

param networkConfiguration:

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.
- subnets (list) -- [REQUIRED]
  
  The subnets associated with the task or service.
  - (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.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'tasks': [
        {
            'taskArn': 'string',
            'clusterArn': 'string',
            'taskDefinitionArn': 'string',
            'containerInstanceArn': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'cpu': 123,
                        'memory': 123,
                        'memoryReservation': 123
                    },
                ],
                'taskRoleArn': 'string'
            },
            'lastStatus': 'string',
            'desiredStatus': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp'
                        },
                    ],
                    'networkInterfaces': [
                        {
                            'attachmentId': 'string',
                            'privateIpv4Address': 'string',
                            'ipv6Address': 'string'
                        },
                    ]
                },
            ],
            'startedBy': 'string',
            'version': 123,
            'stoppedReason': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'group': 'string',
            'attachments': [
                {
                    'id': 'string',
                    'type': 'string',
                    'status': 'string',
                    'details': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- tasks (list) --
  
  A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
  - (dict) --
    
    Details on a task in a cluster.
    - taskArn (string) --
      
      The Amazon Resource Name (ARN) of the task.
    - clusterArn (string) --
      
      The Amazon Resource Name (ARN) of the cluster that hosts the task.
    - taskDefinitionArn (string) --
      
      The Amazon Resource Name (ARN) of the task definition that creates the task.
    - containerInstanceArn (string) --
      
      The Amazon Resource Name (ARN) of the container instances that host the task.
    - overrides (dict) --
      
      One or more container overrides.
      - containerOverrides (list) --
        
        One or more container overrides sent to a task.
        
        (dict) --
        
        The overrides that should be sent to a container.
        
        name (string) --
        
        The name of the container that receives the override. This parameter is required if any override is specified.
        
        command (list) --
        
        The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
        
        (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 and 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.
      - 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.
    - lastStatus (string) --
      
      The last known status of the task.
    - desiredStatus (string) --
      
      The desired status of 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 Amazon Resource Name (ARN) of the task.
        
        name (string) --
        
        The name of the container.
        
        lastStatus (string) --
        
        The last known status of the container.
        
        exitCode (integer) --
        
        The exit code returned from the container.
        
        reason (string) --
        
        A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
        
        networkBindings (list) --
        
        The network bindings associated with the container.
        
        (dict) --
        
        Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        bindIP (string) --
        
        The IP address that the container is bound to on the container instance.
        
        containerPort (integer) --
        
        The port number on the container that is be 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.
    - startedBy (string) --
      
      The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
    - version (integer) --
      
      The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
    - stoppedReason (string) --
      
      The reason the task was stopped.
    - createdAt (datetime) --
      
      The Unix timestamp for when the task was created (the task entered the PENDING state).
    - startedAt (datetime) --
      
      The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
    - stoppedAt (datetime) --
      
      The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    - group (string) --
      
      The name of the task group associated with the task.
    - 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 an 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 and 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.
- 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.

StopTask (updated)

Link ¶
Changes (response)

{'task': {'attachments': [{'details': [{'name': 'string', 'value': 'string'}],
                           'id': 'string',
                           'status': 'string',
                           'type': 'string'}],
          'containers': {'networkInterfaces': [{'attachmentId': 'string',
                                                'ipv6Address': 'string',
                                                'privateIpv4Address': 'string'}]}}}

Stops a running task.

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 and a default 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.

See also: AWS API Documentation

Request Syntax

client.stop_task(
    cluster='string',
    task='string',
    reason='string'
)

type cluster:

string

param cluster:

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.

type task:

string

param task:

[REQUIRED]

The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

type reason:

string

param reason:

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 will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

rtype:

dict

returns:

Response Syntax

{
    'task': {
        'taskArn': 'string',
        'clusterArn': 'string',
        'taskDefinitionArn': 'string',
        'containerInstanceArn': 'string',
        'overrides': {
            'containerOverrides': [
                {
                    'name': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'cpu': 123,
                    'memory': 123,
                    'memoryReservation': 123
                },
            ],
            'taskRoleArn': 'string'
        },
        'lastStatus': 'string',
        'desiredStatus': 'string',
        'containers': [
            {
                'containerArn': 'string',
                'taskArn': 'string',
                'name': 'string',
                'lastStatus': 'string',
                'exitCode': 123,
                'reason': 'string',
                'networkBindings': [
                    {
                        'bindIP': 'string',
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'networkInterfaces': [
                    {
                        'attachmentId': 'string',
                        'privateIpv4Address': 'string',
                        'ipv6Address': 'string'
                    },
                ]
            },
        ],
        'startedBy': 'string',
        'version': 123,
        'stoppedReason': 'string',
        'createdAt': datetime(2015, 1, 1),
        'startedAt': datetime(2015, 1, 1),
        'stoppedAt': datetime(2015, 1, 1),
        'group': 'string',
        'attachments': [
            {
                'id': 'string',
                'type': 'string',
                'status': 'string',
                'details': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

(dict) --
- task (dict) --
  
  The task that was stopped.
  - taskArn (string) --
    
    The Amazon Resource Name (ARN) of the task.
  - clusterArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster that hosts the task.
  - taskDefinitionArn (string) --
    
    The Amazon Resource Name (ARN) of the task definition that creates the task.
  - containerInstanceArn (string) --
    
    The Amazon Resource Name (ARN) of the container instances that host the task.
  - overrides (dict) --
    
    One or more container overrides.
    - containerOverrides (list) --
      
      One or more container overrides sent to a task.
      - (dict) --
        
        The overrides that should be sent to a container.
        
        name (string) --
        
        The name of the container that receives the override. This parameter is required if any override is specified.
        
        command (list) --
        
        The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
        
        (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 and 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.
    - 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.
  - lastStatus (string) --
    
    The last known status of the task.
  - desiredStatus (string) --
    
    The desired status of 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 Amazon Resource Name (ARN) of the task.
      - name (string) --
        
        The name of the container.
      - lastStatus (string) --
        
        The last known status of the container.
      - exitCode (integer) --
        
        The exit code returned from the container.
      - reason (string) --
        
        A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
      - networkBindings (list) --
        
        The network bindings associated with the container.
        
        (dict) --
        
        Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
        
        bindIP (string) --
        
        The IP address that the container is bound to on the container instance.
        
        containerPort (integer) --
        
        The port number on the container that is be 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.
  - startedBy (string) --
    
    The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
  - version (integer) --
    
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
  - stoppedReason (string) --
    
    The reason the task was stopped.
  - createdAt (datetime) --
    
    The Unix timestamp for when the task was created (the task entered the PENDING state).
  - startedAt (datetime) --
    
    The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
  - stoppedAt (datetime) --
    
    The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
  - group (string) --
    
    The name of the task group associated with the task.
  - 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 an 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 and 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.

SubmitTaskStateChange (updated)

Link ¶
Changes (request)

{'attachments': [{'attachmentArn': 'string', 'status': 'string'}],
 'containers': [{'containerName': 'string',
                 'exitCode': 'integer',
                 'networkBindings': [{'bindIP': 'string',
                                      'containerPort': 'integer',
                                      'hostPort': 'integer',
                                      'protocol': 'tcp | udp'}],
                 'reason': 'string',
                 'status': 'string'}]}

Sent to acknowledge that a task changed states.

See also: AWS API Documentation

Request Syntax

client.submit_task_state_change(
    cluster='string',
    task='string',
    status='string',
    reason='string',
    containers=[
        {
            'containerName': 'string',
            'exitCode': 123,
            'networkBindings': [
                {
                    'bindIP': 'string',
                    'containerPort': 123,
                    'hostPort': 123,
                    'protocol': 'tcp'|'udp'
                },
            ],
            'reason': 'string',
            'status': 'string'
        },
    ],
    attachments=[
        {
            'attachmentArn': 'string',
            'status': 'string'
        },
    ]
)

type cluster:

string

param cluster:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

type task:

string

param task:

The task ID or full Amazon Resource Name (ARN) of the task in the state change request.

type status:

string

param status:

The status of the state change request.

type reason:

string

param reason:

The reason for the state change request.

type containers:

list

param containers:

Any containers associated with the state change request.

(dict) --

An object representing a change in state for a container.
- containerName (string) --
  
  The name of the container.
- exitCode (integer) --
  
  The exit code for the container, if the state change is a result of the container exiting.
- networkBindings (list) --
  
  Any 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 be 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.
- reason (string) --
  
  The reason for the state change.
- status (string) --
  
  The status of the container.

type attachments:

list

param attachments:

Any attachments associated with the state change request.

(dict) --

An object representing a change in state for a task attachment.
- attachmentArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the attachment.
- status (string) -- [REQUIRED]
  
  The status of the attachment.

rtype:

dict

returns:

Response Syntax

{
    'acknowledgment': 'string'
}

Response Structure

(dict) --
- acknowledgment (string) --
  
  Acknowledgement of the state change.

UpdateContainerAgent (updated)

Link ¶
Changes (response)

{'containerInstance': {'attachments': [{'details': [{'name': 'string',
                                                     'value': 'string'}],
                                        'id': 'string',
                                        'status': 'string',
                                        'type': '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 EC2 Container Service Developer Guide.

See also: AWS API Documentation

Request Syntax

client.update_container_agent(
    cluster='string',
    containerInstance='string'
)

type cluster:

string

param cluster:

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.

type containerInstance:

string

param containerInstance:

[REQUIRED]

The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.

rtype:

dict

returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'version': 123,
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
        'attributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'registeredAt': datetime(2015, 1, 1),
        'attachments': [
            {
                'id': 'string',
                'type': 'string',
                'status': 'string',
                'details': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

(dict) --
- containerInstance (dict) --
  
  The container instance for which the container agent was updated.
  - containerInstanceArn (string) --
    
    The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID ``.
  - ec2InstanceId (string) --
    
    The EC2 instance ID of the container instance.
  - version (integer) --
    
    The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
  - versionInfo (dict) --
    
    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
    - agentVersion (string) --
      
      The version number of the Amazon ECS container agent.
    - agentHash (string) --
      
      The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
    - dockerVersion (string) --
      
      The Docker version running on the container instance.
  - remainingResources (list) --
    
    For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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, 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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, 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 ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide.
  - agentConnected (boolean) --
    
    This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot 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 EC2 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 Amazon Resource Name (ARN).
      - targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
  - registeredAt (datetime) --
    
    The Unix timestamp for when the container instance was registered.
  - attachments (list) --
    
    The Elastic Network Interfaces associated with the container instance.
    - (dict) --
      
      An object representing a container instance or task attachment.
      - id (string) --
        
        The unique identifier for the attachment.
      - type (string) --
        
        The type of the attachment, such as an 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 and 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.

UpdateContainerInstancesState (updated)

Link ¶
Changes (response)

{'containerInstances': {'attachments': [{'details': [{'name': 'string',
                                                      'value': 'string'}],
                                         'id': 'string',
                                         'status': 'string',
                                         'type': 'string'}]}}

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. Note that 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 of 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 you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

See also: AWS API Documentation

Request Syntax

client.update_container_instances_state(
    cluster='string',
    containerInstances=[
        'string',
    ],
    status='ACTIVE'|'DRAINING'
)

type cluster:

string

param cluster:

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.

type containerInstances:

list

param containerInstances:

[REQUIRED]

A list of container instance IDs or full Amazon Resource Name (ARN) entries.

(string) --

type status:

string

param status:

[REQUIRED]

The container instance state with which to update the container instance.

rtype:

dict

returns:

Response Syntax

{
    'containerInstances': [
        {
            'containerInstanceArn': 'string',
            'ec2InstanceId': 'string',
            'version': 123,
            'versionInfo': {
                'agentVersion': 'string',
                'agentHash': 'string',
                'dockerVersion': 'string'
            },
            'remainingResources': [
                {
                    'name': 'string',
                    'type': 'string',
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'integerValue': 123,
                    'stringSetValue': [
                        'string',
                    ]
                },
            ],
            'registeredResources': [
                {
                    'name': 'string',
                    'type': 'string',
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'integerValue': 123,
                    'stringSetValue': [
                        'string',
                    ]
                },
            ],
            'status': 'string',
            'agentConnected': True|False,
            'runningTasksCount': 123,
            'pendingTasksCount': 123,
            'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string',
                    'targetType': 'container-instance',
                    'targetId': 'string'
                },
            ],
            'registeredAt': datetime(2015, 1, 1),
            'attachments': [
                {
                    'id': 'string',
                    'type': 'string',
                    'status': 'string',
                    'details': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- containerInstances (list) --
  
  The list of container instances.
  - (dict) --
    
    An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
    - containerInstanceArn (string) --
      
      The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, ``arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID ``.
    - ec2InstanceId (string) --
      
      The EC2 instance ID of the container instance.
    - version (integer) --
      
      The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
    - versionInfo (dict) --
      
      The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
      - agentVersion (string) --
        
        The version number of the Amazon ECS container agent.
      - agentHash (string) --
        
        The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
      - dockerVersion (string) --
        
        The Docker version running on the container instance.
    - remainingResources (list) --
      
      For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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, 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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, 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 ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide.
    - agentConnected (boolean) --
      
      This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot 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 EC2 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 Amazon Resource Name (ARN).
        
        targetId (string) --
        
        The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
    - registeredAt (datetime) --
      
      The Unix timestamp for when the container instance was registered.
    - attachments (list) --
      
      The Elastic Network Interfaces associated with the container instance.
      - (dict) --
        
        An object representing a container instance or task attachment.
        
        id (string) --
        
        The unique identifier for the attachment.
        
        type (string) --
        
        The type of the attachment, such as an 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 and 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.
- 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.

UpdateService (updated)

Link ¶
Changes (request, response)
Request

{'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                  'subnets': ['string']}}}

Response

{'service': {'deployments': {'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                                              'subnets': ['string']}}},
             'networkConfiguration': {'awsvpcConfiguration': {'securityGroups': ['string'],
                                                              'subnets': ['string']}}}}

Modifies the desired count, deployment configuration, network configuration, or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, 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',
    deploymentConfiguration={
        'maximumPercent': 123,
        'minimumHealthyPercent': 123
    },
    networkConfiguration={
        'awsvpcConfiguration': {
            'subnets': [
                'string',
            ],
            'securityGroups': [
                'string',
            ]
        }
    }
)

type cluster:

string

param cluster:

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.

type service:

string

param service:

[REQUIRED]

The name of the service to update.

type desiredCount:

integer

param desiredCount:

The number of instantiations of the task to place and keep running in your service.

type taskDefinition:

string

param taskDefinition:

The family and revision ( family:revision) or full Amazon Resource Name (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.

type deploymentConfiguration:

dict

param deploymentConfiguration:

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

maximumPercent (integer) --

The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.
minimumHealthyPercent (integer) --

The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.

type networkConfiguration:

dict

param networkConfiguration:

awsvpcConfiguration (dict) --

The VPC subnets and security groups associated with a task.
- subnets (list) -- [REQUIRED]
  
  The subnets associated with the task or service.
  - (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.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'service': {
        'serviceArn': 'string',
        'serviceName': 'string',
        'clusterArn': 'string',
        'loadBalancers': [
            {
                'targetGroupArn': 'string',
                'loadBalancerName': 'string',
                'containerName': 'string',
                'containerPort': 123
            },
        ],
        'status': 'string',
        'desiredCount': 123,
        'runningCount': 123,
        'pendingCount': 123,
        'taskDefinition': 'string',
        'deploymentConfiguration': {
            'maximumPercent': 123,
            'minimumHealthyPercent': 123
        },
        'deployments': [
            {
                'id': 'string',
                'status': 'string',
                'taskDefinition': 'string',
                'desiredCount': 123,
                'pendingCount': 123,
                'runningCount': 123,
                'createdAt': datetime(2015, 1, 1),
                'updatedAt': datetime(2015, 1, 1),
                'networkConfiguration': {
                    'awsvpcConfiguration': {
                        'subnets': [
                            'string',
                        ],
                        'securityGroups': [
                            'string',
                        ]
                    }
                }
            },
        ],
        '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',
                ]
            }
        }
    }
}

Response Structure

(dict) --
- service (dict) --
  
  The full description of your service following the update call.
  - serviceArn (string) --
    
    The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, ``arn:aws:ecs:region:012345678910:service/my-service ``.
  - serviceName (string) --
    
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
  - clusterArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster that hosts the service.
  - loadBalancers (list) --
    
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
    - (dict) --
      
      Details on a load balancer that is used with a service.
      - targetGroupArn (string) --
        
        The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
      - loadBalancerName (string) --
        
        The name of a load balancer.
      - containerName (string) --
        
        The name of the container (as it appears in a container definition) to associate with the load balancer.
      - containerPort (integer) --
        
        The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
  - 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.
  - 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) --
      
      The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.
    - minimumHealthyPercent (integer) --
      
      The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.
  - deployments (list) --
    
    The current state of deployments for the service.
    - (dict) --
      
      The details of an Amazon ECS service deployment.
      - id (string) --
        
        The ID of the deployment.
      - status (string) --
        
        The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).
      - taskDefinition (string) --
        
        The most recent task definition that was specified for 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 was created.
      - updatedAt (datetime) --
        
        The Unix timestamp for when the service was last updated.
      - 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.
        
        subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --
  - roleArn (string) --
    
    The Amazon Resource Name (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 EC2 Container Service Developer Guide.
      - type (string) --
        
        The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
      - expression (string) --
        
        A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 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 EC2 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.
      - subnets (list) --
        
        The subnets associated with the task or service.
        
        (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.
        
        (string) --