2015/01/08 - Amazon EC2 Container Service - 20 new api methods
Note
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
Request Syntax
client.discover_poll_endpoint(
containerInstance='string'
)
string
The container instance UUID or full Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .
dict
Response Syntax
{
'endpoint': 'string'
}
Response Structure
(dict) --
endpoint (string) --
The endpoint for the Amazon ECS agent to poll.
Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.
Request Syntax
client.deregister_container_instance(
cluster='string',
containerInstance='string',
force=True|False
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .
boolean
Force the deregistration of the container instance. You can use the force parameter if you have several tasks running on a container instance and you don't want to run StopTask for each task before deregistering the container instance.
dict
Response Syntax
{
'containerInstance': {
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False
}
}
Response Structure
(dict) --
containerInstance (dict) --
An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .
ec2InstanceId (string) --
The Amazon EC2 instance ID of the container instance.
remainingResources (list) --
The remaining resources of the container instance that are available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
registeredResources (list) --
The registered resources on the container instance that are in use by current tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
status (string) --
The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.
agentConnected (boolean) --
This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.
Returns a list of existing clusters.
Request Syntax
client.list_clusters(
nextToken='string',
maxResults=123
)
string
The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
integer
The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters 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 ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
dict
Response Syntax
{
'clusterArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
clusterArns (list) --
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
(string) --
nextToken (string) --
The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Note
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
Request Syntax
client.submit_task_state_change(
cluster='string',
task='string',
status='string',
reason='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
string
The task UUID or full Amazon Resource Name (ARN) of the task in the state change request.
string
The status of the state change request.
string
The reason for the state change request.
dict
Response Syntax
{
'acknowledgment': 'string'
}
Response Structure
(dict) --
acknowledgment (string) --
Acknowledgement of the state change.
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
Request Syntax
client.delete_cluster(
cluster='string'
)
string
[REQUIRED]
The cluster you want to delete.
dict
Response Syntax
{
'cluster': {
'clusterArn': 'string',
'clusterName': 'string',
'status': 'string'
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of the deleted cluster.
clusterArn (string) --
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region :012345678910 :cluster/test .
clusterName (string) --
A user-generated string that you can use to identify your cluster.
status (string) --
The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
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',
]
},
]
},
count=123
)
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.
dict
containerOverrides (list) --
One or more container overrides to send when running a task.
(dict) --
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that receives the override.
(string) --
integer
The number of instances of the specified task that you would like to place on your cluster.
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'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
},
]
},
]
},
],
'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 to send when running a task.
(dict) --
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that receives the override.
(string) --
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 should be used with the network binding.
hostPort (integer) --
The port number on the host that should be used with the network binding.
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.
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',
]
},
]
},
'lastStatus': 'string',
'desiredStatus': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123
},
]
},
]
},
],
'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 to send when running a task.
(dict) --
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that receives the override.
(string) --
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 should be used with the network binding.
hostPort (integer) --
The port number on the host that should be used with the network binding.
failures (list) --
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Returns a list of container instances in a specified cluster.
Request Syntax
client.list_container_instances(
cluster='string',
nextToken='string',
maxResults=123
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to list. If you do not specify a cluster, the default cluster is assumed..
string
The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
integer
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances 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 ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
dict
Response Syntax
{
'containerInstanceArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
containerInstanceArns (list) --
The list of container instance full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.
(string) --
nextToken (string) --
The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Describes a task definition.
Request Syntax
client.describe_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 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'
},
]
},
],
'family': 'string',
'revision': 123
}
}
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.
(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 should be used with the port mapping.
hostPort (integer) --
The port number on the host that should be used with the port mapping.
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) --
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.
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.
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'
},
]
},
],
'family': 'string',
'revision': 123
}
}
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.
(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 should be used with the port mapping.
hostPort (integer) --
The port number on the host that should be used with the port mapping.
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) --
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.
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.
Returns a list of tasks for a specified cluster. You can filter the results by family name or by a particular container instance with the family and containerInstance parameters.
Request Syntax
client.list_tasks(
cluster='string',
containerInstance='string',
family='string',
nextToken='string',
maxResults=123
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..
string
The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.
string
The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.
string
The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
integer
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
dict
Response Syntax
{
'taskArns': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
taskArns (list) --
The list of task Amazon Resource Name (ARN) entries for the ListTasks request.
(string) --
nextToken (string) --
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Request Syntax
client.describe_container_instances(
cluster='string',
containerInstances=[
'string',
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to describe. If you do not specify a cluster, the default cluster is assumed.
list
[REQUIRED]
A space-separated list of container instance UUIDs or full Amazon Resource Name (ARN) entries.
(string) --
dict
Response Syntax
{
'containerInstances': [
{
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
containerInstances (list) --
The list of container instances.
(dict) --
An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .
ec2InstanceId (string) --
The Amazon EC2 instance ID of the container instance.
remainingResources (list) --
The remaining resources of the container instance that are available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
registeredResources (list) --
The registered resources on the container instance that are in use by current tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
status (string) --
The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.
agentConnected (boolean) --
This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.
failures (list) --
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
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',
]
},
]
},
containerInstances=[
'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.
dict
containerOverrides (list) --
One or more container overrides to send when running a task.
(dict) --
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that receives the override.
(string) --
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) --
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'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
},
]
},
]
},
],
'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 to send when running a task.
(dict) --
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that receives the override.
(string) --
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 should be used with the network binding.
hostPort (integer) --
The port number on the host that should be used with the network binding.
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.
Note
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
Request Syntax
client.submit_container_state_change(
cluster='string',
task='string',
containerName='string',
status='string',
exitCode=123,
reason='string',
networkBindings=[
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123
},
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
string
The task UUID or full Amazon Resource Name (ARN) of the task that hosts the container.
string
The name of the container.
string
The status of the state change request.
integer
The exit code returned for the state change request.
string
The reason for the state change request.
list
The network bindings of the container.
(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 should be used with the network binding.
hostPort (integer) --
The port number on the host that should be used with the network binding.
dict
Response Syntax
{
'acknowledgment': 'string'
}
Response Structure
(dict) --
acknowledgment (string) --
Acknowledgement of the state change.
Describes one or more of your clusters.
Request Syntax
client.describe_clusters(
clusters=[
'string',
]
)
list
A space-separated list of cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
(string) --
dict
Response Syntax
{
'clusters': [
{
'clusterArn': 'string',
'clusterName': 'string',
'status': 'string'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
clusters (list) --
The list of clusters.
(dict) --
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
Warning
During the preview, each account is limited to two clusters.
clusterArn (string) --
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region :012345678910 :cluster/test .
clusterName (string) --
A user-generated string that you can use to identify your cluster.
status (string) --
The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
failures (list) --
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter.
Request Syntax
client.list_task_definitions(
familyPrefix='string',
nextToken='string',
maxResults=123
)
string
The name of the family that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to definitions that belong to that family.
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.
Registers a new task definition from the supplied family and containerDefinitions .
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'
},
]
},
]
)
string
[REQUIRED]
You can 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 should be used with the port mapping.
hostPort (integer) --
The port number on the host that should be used with the port mapping.
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) --
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.
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'
},
]
},
],
'family': 'string',
'revision': 123
}
}
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.
(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 should be used with the port mapping.
hostPort (integer) --
The port number on the host that should be used with the port mapping.
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) --
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.
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.
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',
]
},
]
},
'lastStatus': 'string',
'desiredStatus': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123
},
]
},
]
}
}
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 to send when running a task.
(dict) --
name (string) --
The name of the container that receives the override.
command (list) --
The command to send to the container that receives the override.
(string) --
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 should be used with the network binding.
hostPort (integer) --
The port number on the host that should be used with the network binding.
Creates a new Amazon ECS cluster. By default, your account will receive a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
Warning
During the preview, each account is limited to two clusters.
Request Syntax
client.create_cluster(
clusterName='string'
)
string
The name of your cluster. If you do not specify a name for your cluster, you will create a cluster named default .
dict
Response Syntax
{
'cluster': {
'clusterArn': 'string',
'clusterName': 'string',
'status': 'string'
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your new cluster.
clusterArn (string) --
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region :012345678910 :cluster/test .
clusterName (string) --
A user-generated string that you can use to identify your cluster.
status (string) --
The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
Note
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.
Request Syntax
client.register_container_instance(
cluster='string',
instanceIdentityDocument='string',
instanceIdentityDocumentSignature='string',
totalResources=[
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..
string
string
list
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
dict
Response Syntax
{
'containerInstance': {
'containerInstanceArn': 'string',
'ec2InstanceId': 'string',
'remainingResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'registeredResources': [
{
'name': 'string',
'type': 'string',
'doubleValue': 123.0,
'longValue': 123,
'integerValue': 123,
'stringSetValue': [
'string',
]
},
],
'status': 'string',
'agentConnected': True|False
}
}
Response Structure
(dict) --
containerInstance (dict) --
An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .
ec2InstanceId (string) --
The Amazon EC2 instance ID of the container instance.
remainingResources (list) --
The remaining resources of the container instance that are available for new tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
registeredResources (list) --
The registered resources on the container instance that are in use by current tasks.
(dict) --
Describes the resources available for a container instance.
name (string) --
The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.
type (string) --
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
doubleValue (float) --
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
longValue (integer) --
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
integerValue (integer) --
When the integerValue type is set, the value of the resource must be an integer.
stringSetValue (list) --
When the stringSetValue type is set, the value of the resource must be a string type.
(string) --
status (string) --
The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.
agentConnected (boolean) --
This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.