Skip to content

ECS  >  Operations  >  submit_container_state_change

submit_container_state_change

Operation

submit_container_state_change async

submit_container_state_change(request: SubmitContainerStateChangeInput | SubmitContainerStateChangeInputDict, /, *, plugins: list[Plugin] | None = None) -> SubmitContainerStateChangeOutput
submit_container_state_change(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[SubmitContainerStateChangeInputDict]) -> SubmitContainerStateChangeOutput
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 container changed states.

Parameters:

Name Type Description Default
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
SubmitContainerStateChangeOutput

An instance of SubmitContainerStateChangeOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

SubmitContainerStateChangeInput dataclass

Bases: _SerdeShape

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

The short name or full ARN of the cluster that hosts the container.

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

The name of the container.

exit_code class-attribute instance-attribute
exit_code: int | None = ...

The exit code that's returned for the state change request.

network_bindings class-attribute instance-attribute
network_bindings: list[NetworkBinding] | None = ...

The network bindings of the container.

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

The reason for the state change request.

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

The ID of the Docker container.

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 Amazon Resource Name (ARN) of the task that hosts the container.

Dictionaries

SubmitContainerStateChangeInputDict

Bases: TypedDict

Dictionary form of SubmitContainerStateChangeInput.

Attributes
cluster instance-attribute
cluster: str | None

The short name or full ARN of the cluster that hosts the container.

container_name instance-attribute
container_name: str | None

The name of the container.

exit_code instance-attribute
exit_code: int | None

The exit code that's returned for the state change request.

network_bindings instance-attribute
network_bindings: Sequence[NetworkBinding | NetworkBindingDict] | None

The network bindings of the container.

reason instance-attribute
reason: str | None

The reason for the state change request.

runtime_id instance-attribute
runtime_id: str | None

The ID of the Docker container.

status instance-attribute
status: str | None

The status of the state change request.

task instance-attribute
task: str | None

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

Output

SubmitContainerStateChangeOutput 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.