get_task_protection¶
Operation¶
get_task_protection
¶
get_task_protection(request: GetTaskProtectionInput | GetTaskProtectionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTaskProtectionInputDict]) -> GetTaskProtectionOutput
Retrieves the protection status of tasks in an Amazon ECS service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetTaskProtectionInput | GetTaskProtectionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetTaskProtectionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetTaskProtectionOutput
|
An instance of |
get_task_protection
async
¶
get_task_protection(request: GetTaskProtectionInput | GetTaskProtectionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTaskProtectionInputDict]) -> GetTaskProtectionOutput
Retrieves the protection status of tasks in an Amazon ECS service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetTaskProtectionInput | GetTaskProtectionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetTaskProtectionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetTaskProtectionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetTaskProtectionInput
dataclass
¶
Output¶
GetTaskProtectionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetTaskProtectionOutput structure.
Attributes¶
failures
class-attribute
instance-attribute
¶
Any failures associated with the call.
protected_tasks
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.
response_metadata
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.