submit_container_state_change ¶

def submit_container_state_change(
    self,
    *,
    config_overrides: Optional[ECSClientConfig] = None,
    cluster: Optional["capo_ecs.types.string.String"] = None,
    task: Optional["capo_ecs.types.string.String"] = None,
    container_name: Optional["capo_ecs.types.string.String"] = None,
    runtime_id: Optional["capo_ecs.types.string.String"] = None,
    status: Optional["capo_ecs.types.string.String"] = None,
    exit_code: Optional["capo_ecs.types.boxed_integer.BoxedInteger"] = None,
    reason: Optional["capo_ecs.types.string.String"] = None,
    network_bindings: Optional[
        "capo_ecs.types.network_bindings.NetworkBindings"
    ] = None,
) -> "capo_ecs.types.submit_container_state_change_response.SubmitContainerStateChangeResponse":
    """<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a container changed states.</p>

    Args:
        cluster: <p>The short name or full ARN of the cluster that hosts the container.</p>
        task: <p>The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.</p>
        container_name: <p>The name of the container.</p>
        runtime_id: <p>The ID of the Docker container.</p>
        status: <p>The status of the state change request.</p>
        exit_code: <p>The exit code that's returned for the state change request.</p>
        reason: <p>The reason for the state change request.</p>
        network_bindings: <p>The network bindings of the container.</p>

    Raises:
        capo_ecs.errors.access_denied_exception.AccessDeniedException: <p>You don't have authorization to perform the requested action.</p>
        capo_ecs.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
        capo_ecs.errors.cluster_not_found_exception.ClusterNotFoundException: <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
        capo_ecs.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
        capo_ecs.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_ecs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ecs.types.submit_container_state_change_request.SubmitContainerStateChangeRequest]",
    ) -> OperationResponse[
        "capo_ecs.types.submit_container_state_change_response.SubmitContainerStateChangeResponse"
    ]:
        import capo_ecs._operations.amazon_ec2_container_service_v20141113.submit_container_state_change

        output, http_response = (
            capo_ecs._operations.amazon_ec2_container_service_v20141113.submit_container_state_change.submit_container_state_change(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SubmitContainerStateChange")
    )
    input_: capo_ecs.types.submit_container_state_change_request.SubmitContainerStateChangeRequest = {}
    if cluster is not None:
        input_["cluster"] = cluster
    if task is not None:
        input_["task"] = task
    if container_name is not None:
        input_["container_name"] = container_name
    if runtime_id is not None:
        input_["runtime_id"] = runtime_id
    if status is not None:
        input_["status"] = status
    if exit_code is not None:
        input_["exit_code"] = exit_code
    if reason is not None:
        input_["reason"] = reason
    if network_bindings is not None:
        input_["network_bindings"] = network_bindings

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output