ECS / Client / get_task_protection
get_task_protection#
- ECS.Client.get_task_protection(**kwargs)#
Retrieves the protection status of tasks in an Amazon ECS service.
See also: AWS API Documentation
Request Syntax
response = client.get_task_protection( cluster='string', tasks=[ 'string', ] )
- Parameters:
cluster (string) –
[REQUIRED]
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
tasks (list) –
A list of up to 100 task IDs or full ARN entries.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'protectedTasks': [ { 'taskArn': 'string', 'protectionEnabled': True|False, 'expirationDate': datetime(2015, 1, 1) }, ], 'failures': [ { 'arn': 'string', 'reason': 'string', 'detail': 'string' }, ] }
Response Structure
(dict) –
protectedTasks (list) –
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.
(dict) –
An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.
taskArn (string) –
The task ARN.
protectionEnabled (boolean) –
The protection status of the task. If scale-in protection is on for a task, the value is
true
. Otherwise, it isfalse
.expirationDate (datetime) –
The epoch time when protection for the task will expire.
failures (list) –
Any failures associated with the call.
(dict) –
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
arn (string) –
The Amazon Resource Name (ARN) of the failed resource.
reason (string) –
The reason for the failure.
detail (string) –
The details of the failure.
Exceptions
ECS.Client.exceptions.AccessDeniedException
ECS.Client.exceptions.ClientException
ECS.Client.exceptions.ClusterNotFoundException
ECS.Client.exceptions.InvalidParameterException
ECS.Client.exceptions.ResourceNotFoundException
ECS.Client.exceptions.ServerException
ECS.Client.exceptions.UnsupportedFeatureException