2015/06/18 - Amazon EC2 Container Service - 8 updated api methods
{'taskDefinition': {'status': 'ACTIVE | INACTIVE'}}
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).
Request Syntax
client.deregister_task_definition(
taskDefinition='string'
)
string
[REQUIRED]
The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to deregister. You must specify a revision.
dict
Response Syntax
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'cpu': 123,
'memory': 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
},
]
},
],
'family': 'string',
'revision': 123,
'volumes': [
{
'name': 'string',
'host': {
'sourcePath': 'string'
}
},
],
'status': 'ACTIVE'|'INACTIVE'
}
}
Response Structure
(dict) --
taskDefinition (dict) --
The full description of the deregistered task.
taskDefinitionArn (string) --
The full Amazon Resource Name (ARN) of the 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 on 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.
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 repository-url/image:tag.
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.
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 will allow 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 number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
(string) --
portMappings (list) --
The list of port mappings for the container.
(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.
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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).
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 will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this 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, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
entryPoint (list) --
The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
(string) --
command (list) --
The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
(string) --
environment (list) --
The environment variables to pass to a container.
(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.
(dict) --
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.
(dict) --
sourceContainer (string) --
The name of the container 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.
family (string) --
The family of your task definition. You can think of the family as the name of your task definition.
revision (integer) --
The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and 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 on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
(dict) --
name (string) --
The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.
host (dict) --
The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.
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.
status (string) --
The status of the task definition.
{'taskDefinition': {'status': 'ACTIVE | INACTIVE'}}
Describes a task definition. You can specify a family and revision to find information on a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
Request Syntax
client.describe_task_definition(
taskDefinition='string'
)
string
[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 that you want to describe.
dict
Response Syntax
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'cpu': 123,
'memory': 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
},
]
},
],
'family': 'string',
'revision': 123,
'volumes': [
{
'name': 'string',
'host': {
'sourcePath': 'string'
}
},
],
'status': 'ACTIVE'|'INACTIVE'
}
}
Response Structure
(dict) --
taskDefinition (dict) --
The full task definition description.
taskDefinitionArn (string) --
The full Amazon Resource Name (ARN) of the 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 on 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.
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 repository-url/image:tag.
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.
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 will allow 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 number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
(string) --
portMappings (list) --
The list of port mappings for the container.
(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.
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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).
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 will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this 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, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
entryPoint (list) --
The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
(string) --
command (list) --
The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
(string) --
environment (list) --
The environment variables to pass to a container.
(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.
(dict) --
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.
(dict) --
sourceContainer (string) --
The name of the container 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.
family (string) --
The family of your task definition. You can think of the family as the name of your task definition.
revision (integer) --
The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and 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 on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
(dict) --
name (string) --
The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.
host (dict) --
The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.
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.
status (string) --
The status of the task definition.
{'tasks': {'overrides': {'containerOverrides': {'environment': [{'name': 'string',
'value': 'string'}]}}}}
Describes a specified task or tasks.
Request Syntax
client.describe_tasks(
cluster='string',
tasks=[
'string',
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.
list
[REQUIRED]
A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries.
(string) --
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': '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'
},
]
},
],
'startedBy': 'string'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
The list of tasks.
(dict) --
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the 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 name of a container in a task definition and the command it should run instead of its default.
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition.
(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.
(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.
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) --
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 detail about a running or stopped container.
networkBindings (list) --
(dict) --
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.
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.
failures (list) --
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
{'sort': 'ASC | DESC', 'status': 'ACTIVE | INACTIVE'}
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Request Syntax
client.list_task_definitions(
familyPrefix='string',
status='ACTIVE'|'INACTIVE',
sort='ASC'|'DESC',
nextToken='string',
maxResults=123
)
string
The full family name that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to task definition revisions that belong to that family.
string
The task definition status that you want to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
string
The order in which to sort the results. Valid values are ASC and DESC. By default ( ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
string
The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
integer
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
dict
Response Syntax
{
'taskDefinitionArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
taskDefinitionArns (list) --
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefintions request.
(string) --
nextToken (string) --
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'taskDefinition': {'status': 'ACTIVE | INACTIVE'}}
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 on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
Request Syntax
client.register_task_definition(
family='string',
containerDefinitions=[
{
'name': 'string',
'image': 'string',
'cpu': 123,
'memory': 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
},
]
},
],
volumes=[
{
'name': 'string',
'host': {
'sourcePath': 'string'
}
},
]
)
string
[REQUIRED]
You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
list
[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.
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 repository-url/image:tag.
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.
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 will allow 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 number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
(string) --
portMappings (list) --
The list of port mappings for the container.
(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.
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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).
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 will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this 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, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
entryPoint (list) --
The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
(string) --
command (list) --
The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
(string) --
environment (list) --
The environment variables to pass to a container.
(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.
(dict) --
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.
(dict) --
sourceContainer (string) --
The name of the container 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.
list
A list of volume definitions in JSON format that containers in your task may use.
(dict) --
name (string) --
The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.
host (dict) --
The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.
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.
dict
Response Syntax
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'cpu': 123,
'memory': 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
},
]
},
],
'family': 'string',
'revision': 123,
'volumes': [
{
'name': 'string',
'host': {
'sourcePath': 'string'
}
},
],
'status': 'ACTIVE'|'INACTIVE'
}
}
Response Structure
(dict) --
taskDefinition (dict) --
taskDefinitionArn (string) --
The full Amazon Resource Name (ARN) of the 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 on 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.
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 repository-url/image:tag.
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.
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 will allow 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 number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
(string) --
portMappings (list) --
The list of port mappings for the container.
(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.
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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).
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 will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this 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, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
entryPoint (list) --
The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
(string) --
command (list) --
The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
(string) --
environment (list) --
The environment variables to pass to a container.
(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.
(dict) --
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.
(dict) --
sourceContainer (string) --
The name of the container 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.
family (string) --
The family of your task definition. You can think of the family as the name of your task definition.
revision (integer) --
The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and 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 on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
(dict) --
name (string) --
The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.
host (dict) --
The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.
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.
status (string) --
The status of the task definition.
{'overrides': {'containerOverrides': {'environment': [{'name': 'string',
'value': 'string'}]}}}
Response {'tasks': {'overrides': {'containerOverrides': {'environment': [{'name': 'string',
'value': 'string'}]}}}}
Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.
Request Syntax
client.run_task(
cluster='string',
taskDefinition='string',
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
]
},
]
},
count=123,
startedBy='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..
string
[REQUIRED]
The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.
dict
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The name of a container in a task definition and the command it should run instead of its default.
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition.
(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.
(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.
integer
The number of instantiations of the specified task that you would like to place on your cluster.
string
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': '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'
},
]
},
],
'startedBy': '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 will be described here.
(dict) --
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the 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 name of a container in a task definition and the command it should run instead of its default.
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition.
(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.
(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.
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) --
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 detail about a running or stopped container.
networkBindings (list) --
(dict) --
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.
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.
failures (list) --
Any failed tasks from your RunTask action are listed here.
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
{'overrides': {'containerOverrides': {'environment': [{'name': 'string',
'value': 'string'}]}}}
Response {'tasks': {'overrides': {'containerOverrides': {'environment': [{'name': 'string',
'value': 'string'}]}}}}
Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.
Request Syntax
client.start_task(
cluster='string',
taskDefinition='string',
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
]
},
]
},
containerInstances=[
'string',
],
startedBy='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..
string
[REQUIRED]
The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start. If a revision is not specified, the latest ACTIVE revision is used.
dict
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The name of a container in a task definition and the command it should run instead of its default.
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition.
(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.
(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.
list
[REQUIRED]
The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
(string) --
string
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': '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'
},
]
},
],
'startedBy': '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 will be described here.
(dict) --
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the 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 name of a container in a task definition and the command it should run instead of its default.
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition.
(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.
(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.
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) --
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 detail about a running or stopped container.
networkBindings (list) --
(dict) --
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.
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.
failures (list) --
Any failed tasks from your StartTask action are listed here.
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
{'task': {'overrides': {'containerOverrides': {'environment': [{'name': 'string',
'value': 'string'}]}}}}
Stops a running task.
Request Syntax
client.stop_task(
cluster='string',
task='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to stop. If you do not specify a cluster, the default cluster is assumed..
string
[REQUIRED]
The task UUIDs or full Amazon Resource Name (ARN) entry of the task you would like to stop.
dict
Response Syntax
{
'task': {
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
]
},
]
},
'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'
},
]
},
],
'startedBy': 'string'
}
}
Response Structure
(dict) --
task (dict) --
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the 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 name of a container in a task definition and the command it should run instead of its default.
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition.
(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.
(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.
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) --
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 detail about a running or stopped container.
networkBindings (list) --
(dict) --
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.
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.