submit_container_state_change¶
Operation¶
submit_container_state_change
async
¶
submit_container_state_change(input: SubmitContainerStateChangeInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
SubmitContainerStateChangeInput
|
An instance of |
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 |
|---|---|
SubmitContainerStateChangeOutput
|
An instance of |
Input¶
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.
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
¶
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.