update_task_protection¶
Operation¶
async
¶
update_task_protection(input: UpdateTaskProtectionInput, plugins: list[Plugin] | None = None) -> UpdateTaskProtectionOutput
Updates the protection status of a task. You can set protectionEnabled
to true to protect your task from termination during scale-in events
from Service
Autoscaling
or
deployments.
Task-protection, by default, expires after 2 hours at which point Amazon
ECS clears the protectionEnabled property making the task eligible for
termination by a subsequent scale-in event.
You can specify a custom expiration period for task protection from 1
minute to up to 2,880 minutes (48 hours). To specify the custom
expiration period, set the expiresInMinutes property. The
expiresInMinutes property is always reset when you invoke this
operation for a task that already has protectionEnabled set to true.
You can keep extending the protection expiration period of a task by
invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .
Note
This operation is only supported for tasks belonging to an Amazon ECS
service. Invoking this operation for a standalone task will result in an
TASK_NOT_VALID failure. For more information, see API failure
reasons.
Warning: If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateTaskProtectionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateTaskProtectionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateTaskProtectionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
cluster: str | None = ...
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
class-attribute
instance-attribute
¶
expires_in_minutes: int | None = ...
If you set protectionEnabled to true, you can specify the duration
for task protection in minutes. You can specify a value from 1 minute to
up to 2,880 minutes (48 hours). During this time, your task will not be
terminated by scale-in events from Service Auto Scaling or deployments.
After this time period lapses, protectionEnabled will be reset to
false.
If you don't specify the time, then the task is automatically protected for 120 minutes (2 hours).
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateTaskProtectionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
failures: list[Failure] | None = ...
Any failures associated with the call.
class-attribute
instance-attribute
¶
protected_tasks: list[ProtectedTask] | None = ...
A list of tasks with the following information.
-
taskArn: The task ARN. -
protectionEnabled: The protection status of the task. If scale-in protection is turned on for a task, the value istrue. Otherwise, it isfalse. -
expirationDate: The epoch time when protection for the task will expire.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.