Skip to content

ECS  >  Operations  >  submit_task_state_change

submit_task_state_change

Operation

submit_task_state_change async 

submit_task_state_change(input: SubmitTaskStateChangeInput, plugins: list[Plugin] | None = None) -> SubmitTaskStateChangeOutput
Note

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

Parameters:

Name Type Description Default
input SubmitTaskStateChangeInput

An instance of SubmitTaskStateChangeInput.

 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
SubmitTaskStateChangeOutput

An instance of SubmitTaskStateChangeOutput.

Input

SubmitTaskStateChangeInput dataclass

Bases: _SerdeShape

Attributes

attachments class-attribute instance-attribute 
attachments: list[AttachmentStateChange] | None = ...

Any attachments associated with the state change request.

cluster class-attribute instance-attribute 
cluster: str | None = ...

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

containers class-attribute instance-attribute 
containers: list[ContainerStateChange] | None = ...

Any containers that's associated with the state change request.

execution_stopped_at class-attribute instance-attribute 
execution_stopped_at: datetime | None = ...

The Unix timestamp for the time when the task execution stopped.

managed_agents class-attribute instance-attribute 
managed_agents: list[ManagedAgentStateChange] | None = ...

The details for the managed agent that's associated with the task.

pull_started_at class-attribute instance-attribute 
pull_started_at: datetime | None = ...

The Unix timestamp for the time when the container image pull started.

pull_stopped_at class-attribute instance-attribute 
pull_stopped_at: datetime | None = ...

The Unix timestamp for the time when the container image pull completed.

reason class-attribute instance-attribute 
reason: str | None = ...

The reason for the state change request.

status class-attribute instance-attribute 
status: str | None = ...

The status of the state change request.

task class-attribute instance-attribute 
task: str | None = ...

The task ID or full ARN of the task in the state change request.

Output

SubmitTaskStateChangeOutput dataclass

Bases: _SerdeShape

Attributes

acknowledgment class-attribute instance-attribute 
acknowledgment: str | None = ...

Acknowledgement of the state change.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.