2015/02/20 - Amazon EC2 Container Service - 1 new 3 updated api methods
Returns a list of task definition families that are registered to your account. You can filter the results with the familyPrefix parameter.
Request Syntax
client.list_task_definition_families(
familyPrefix='string',
nextToken='string',
maxResults=123
)
string
The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies . If you specify a familyPrefix , only task definition family names that begin with the familyPrefix string are returned.
string
The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
integer
The maximum number of task definition family results returned by ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
dict
Response Syntax
{
'families': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
families (list) --
The list of task definition family names that match the ListTaskDefinitionFamilies request.
(string) --
nextToken (string) --
The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'taskDefinition': {'containerDefinitions': {'mountPoints': [{'containerPath': 'string',
'readOnly': 'boolean',
'sourceVolume': 'string'}],
'volumesFrom': [{'readOnly': 'boolean',
'sourceContainer': 'string'}]},
'volumes': [{'host': {'sourcePath': 'string'},
'name': 'string'}]}}
NOT YET IMPLEMENTED.
Deregisters the specified task definition. You will no longer be able to run tasks from this definition after deregistration.
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.
dict
Response Syntax
{
'taskDefinition': {
'taskDefinitionArn': 'string',
'containerDefinitions': [
{
'name': 'string',
'image': 'string',
'cpu': 123,
'memory': 123,
'links': [
'string',
],
'portMappings': [
{
'containerPort': 123,
'hostPort': 123
},
],
'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'
}
},
]
}
}
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.
memory (integer) --
The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. 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 49153 to 65535 port range.
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 while specifying a containerPort and your container will automatically receive a port in the 49153 to 65535 port range. You should not attempt to specify a host port in the 49153 to 65535 port range, since these are reserved for automatic assignment.
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).
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.
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 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) --
name (string) --
The name of the key value pair.
value (string) --
The value of the key value pair.
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 task definition in the same family, the revision value increases by one.
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.
{'taskDefinition': {'containerDefinitions': {'mountPoints': [{'containerPath': 'string',
'readOnly': 'boolean',
'sourceVolume': 'string'}],
'volumesFrom': [{'readOnly': 'boolean',
'sourceContainer': 'string'}]},
'volumes': [{'host': {'sourcePath': 'string'},
'name': 'string'}]}}
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 revision in that family.
Request Syntax
client.describe_task_definition(
taskDefinition='string'
)
string
[REQUIRED]
The family for the latest 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
},
],
'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'
}
},
]
}
}
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.
memory (integer) --
The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. 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 49153 to 65535 port range.
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 while specifying a containerPort and your container will automatically receive a port in the 49153 to 65535 port range. You should not attempt to specify a host port in the 49153 to 65535 port range, since these are reserved for automatic assignment.
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).
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.
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 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) --
name (string) --
The name of the key value pair.
value (string) --
The value of the key value pair.
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 task definition in the same family, the revision value increases by one.
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.
{'containerDefinitions': {'mountPoints': [{'containerPath': 'string',
'readOnly': 'boolean',
'sourceVolume': 'string'}],
'volumesFrom': [{'readOnly': 'boolean',
'sourceContainer': 'string'}]},
'volumes': [{'host': {'sourcePath': 'string'}, 'name': 'string'}]}
Response {'taskDefinition': {'containerDefinitions': {'mountPoints': [{'containerPath': 'string',
'readOnly': 'boolean',
'sourceVolume': 'string'}],
'volumesFrom': [{'readOnly': 'boolean',
'sourceContainer': 'string'}]},
'volumes': [{'host': {'sourcePath': 'string'},
'name': 'string'}]}}
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
},
],
'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.
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.
memory (integer) --
The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. 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 49153 to 65535 port range.
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 while specifying a containerPort and your container will automatically receive a port in the 49153 to 65535 port range. You should not attempt to specify a host port in the 49153 to 65535 port range, since these are reserved for automatic assignment.
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).
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.
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 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) --
name (string) --
The name of the key value pair.
value (string) --
The value of the key value pair.
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
},
],
'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'
}
},
]
}
}
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.
memory (integer) --
The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
links (list) --
The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. 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 49153 to 65535 port range.
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 while specifying a containerPort and your container will automatically receive a port in the 49153 to 65535 port range. You should not attempt to specify a host port in the 49153 to 65535 port range, since these are reserved for automatic assignment.
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).
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.
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 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) --
name (string) --
The name of the key value pair.
value (string) --
The value of the key value pair.
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 task definition in the same family, the revision value increases by one.
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.