Smaws_Client_ECS.UpdateTaskProtectionUpdates 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.
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.
If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `AccessDeniedException of Types.access_denied_exception
| `ClientException of Types.client_exception
| `ClusterNotFoundException of Types.cluster_not_found_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `ServerException of Types.server_exception
| `UnsupportedFeatureException of Types.unsupported_feature_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.update_task_protection_request ->
(Types.update_task_protection_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `AccessDeniedException of Types.access_denied_exception
| `ClientException of Types.client_exception
| `ClusterNotFoundException of Types.cluster_not_found_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `ServerException of Types.server_exception
| `UnsupportedFeatureException of Types.unsupported_feature_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.update_task_protection_request ->
(Types.update_task_protection_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `AccessDeniedException of Types.access_denied_exception
| `ClientException of Types.client_exception
| `ClusterNotFoundException of Types.cluster_not_found_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `ServerException of Types.server_exception
| `UnsupportedFeatureException of Types.unsupported_feature_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result