Skip to content

StopTaskRequest

Source code in docs_src/capo_ecs/types/stop_task_request.py 
13
14
15
16
17
18
19
class StopTaskRequest(TypedDict, closed=True):
    cluster: NotRequired["capo_ecs.types.string.String"]
    """<p>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.</p>"""
    task: "capo_ecs.types.string.String"
    """<p>Thefull Amazon Resource Name (ARN) of the task.</p>"""
    reason: NotRequired["capo_ecs.types.string.String"]
    """<p>An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html">DescribeTasks</a>&gt; API operations on this task.</p>"""

cluster instance-attribute 

cluster: NotRequired[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.

reason instance-attribute 

reason: NotRequired[String]

An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks> API operations on this task.

task instance-attribute 

task: String

Thefull Amazon Resource Name (ARN) of the task.