2017/06/15 - Amazon EC2 Container Service - 4 updated api methods
Changes Update ecs client to latest version
{'tasks': {'overrides': {'containerOverrides': {'cpu': 'integer',
'memory': 'integer',
'memoryReservation': 'integer'}}}}
Describes a specified task or tasks.
See also: AWS API Documentation
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 to describe. If you do not specify a cluster, the default cluster is assumed.
list
[REQUIRED]
A list of up to 100 task IDs 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'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123
},
],
'taskRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
The list of tasks.
(dict) --
Details on a task in a cluster.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the task definition that creates the task.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
(string) --
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key and value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
lastStatus (string) --
The last known status of the task.
desiredStatus (string) --
The desired status of the task.
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is be used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason the task was stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
{'overrides': {'containerOverrides': {'cpu': 'integer',
'memory': 'integer',
'memoryReservation': 'integer'}}}
Response {'tasks': {'overrides': {'containerOverrides': {'cpu': 'integer',
'memory': 'integer',
'memoryReservation': 'integer'}}}}
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
See also: AWS API Documentation
Request Syntax
client.run_task(
cluster='string',
taskDefinition='string',
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123
},
],
'taskRoleArn': 'string'
},
count=123,
startedBy='string',
group='string',
placementConstraints=[
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
placementStrategy=[
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
]
)
string
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
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 overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
(string) --
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key and value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
integer
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
string
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
string
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
list
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).
(dict) --
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
expression (string) --
A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
list
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
(dict) --
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon EC2 Container Service Developer Guide.
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123
},
],
'taskRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
(dict) --
Details on a task in a cluster.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the task definition that creates the task.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
(string) --
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key and value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
lastStatus (string) --
The last known status of the task.
desiredStatus (string) --
The desired status of the task.
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is be used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason the task was stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
{'overrides': {'containerOverrides': {'cpu': 'integer',
'memory': 'integer',
'memoryReservation': 'integer'}}}
Response {'tasks': {'overrides': {'containerOverrides': {'cpu': 'integer',
'memory': 'integer',
'memoryReservation': 'integer'}}}}
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.start_task(
cluster='string',
taskDefinition='string',
overrides={
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123
},
],
'taskRoleArn': 'string'
},
containerInstances=[
'string',
],
startedBy='string',
group='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
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 overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
(string) --
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key and value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
list
[REQUIRED]
The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
(string) --
string
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
string
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
dict
Response Syntax
{
'tasks': [
{
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123
},
],
'taskRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string'
},
],
'failures': [
{
'arn': 'string',
'reason': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
(dict) --
Details on a task in a cluster.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the task definition that creates the task.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
(string) --
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key and value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
lastStatus (string) --
The last known status of the task.
desiredStatus (string) --
The desired status of the task.
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is be used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason the task was stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
{'task': {'overrides': {'containerOverrides': {'cpu': 'integer',
'memory': 'integer',
'memoryReservation': 'integer'}}}}
Stops a running task.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a default 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
See also: AWS API Documentation
Request Syntax
client.stop_task(
cluster='string',
task='string',
reason='string'
)
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
string
[REQUIRED]
The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
string
An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
dict
Response Syntax
{
'task': {
'taskArn': 'string',
'clusterArn': 'string',
'taskDefinitionArn': 'string',
'containerInstanceArn': 'string',
'overrides': {
'containerOverrides': [
{
'name': 'string',
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'cpu': 123,
'memory': 123,
'memoryReservation': 123
},
],
'taskRoleArn': 'string'
},
'lastStatus': 'string',
'desiredStatus': 'string',
'containers': [
{
'containerArn': 'string',
'taskArn': 'string',
'name': 'string',
'lastStatus': 'string',
'exitCode': 123,
'reason': 'string',
'networkBindings': [
{
'bindIP': 'string',
'containerPort': 123,
'hostPort': 123,
'protocol': 'tcp'|'udp'
},
]
},
],
'startedBy': 'string',
'version': 123,
'stoppedReason': 'string',
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'group': 'string'
}
}
Response Structure
(dict) --
task (dict) --
The task that was stopped.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
clusterArn (string) --
The Amazon Resource Name (ARN) of the cluster that hosts the task.
taskDefinitionArn (string) --
The Amazon Resource Name (ARN) of the task definition that creates the task.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instances that host the task.
overrides (dict) --
One or more container overrides.
containerOverrides (list) --
One or more container overrides sent to a task.
(dict) --
The overrides that should be sent to a container.
name (string) --
The name of the container that receives the override. This parameter is required if any override is specified.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
(string) --
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
(dict) --
A key and value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
cpu (integer) --
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory (integer) --
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation (integer) --
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
taskRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
lastStatus (string) --
The last known status of the task.
desiredStatus (string) --
The desired status of the task.
containers (list) --
The containers associated with the task.
(dict) --
A Docker container that is part of a task.
containerArn (string) --
The Amazon Resource Name (ARN) of the container.
taskArn (string) --
The Amazon Resource Name (ARN) of the task.
name (string) --
The name of the container.
lastStatus (string) --
The last known status of the container.
exitCode (integer) --
The exit code returned from the container.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings (list) --
The network bindings associated with the container.
(dict) --
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
bindIP (string) --
The IP address that the container is bound to on the container instance.
containerPort (integer) --
The port number on the container that is be used with the network binding.
hostPort (integer) --
The port number on the host that is used with the network binding.
protocol (string) --
The protocol used for the network binding.
startedBy (string) --
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
version (integer) --
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
stoppedReason (string) --
The reason the task was stopped.
createdAt (datetime) --
The Unix timestamp for when the task was created (the task entered the PENDING state).
startedAt (datetime) --
The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
stoppedAt (datetime) --
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
group (string) --
The name of the task group associated with the task.