aws_sdk_ecs/client/

update_container_instances_state.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateContainerInstancesState`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster(impl Into<String>)`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::cluster) / [`set_cluster(Option<String>)`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::set_cluster):<br>required: **false**<br><p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.</p><br>
    ///   - [`container_instances(impl Into<String>)`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::container_instances) / [`set_container_instances(Option<Vec::<String>>)`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::set_container_instances):<br>required: **true**<br><p>A list of up to 10 container instance IDs or full ARN entries.</p><br>
    ///   - [`status(ContainerInstanceStatus)`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::status) / [`set_status(Option<ContainerInstanceStatus>)`](crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::set_status):<br>required: **true**<br><p>The container instance state to update the container instance with. The only valid values for this action are <code>ACTIVE</code> and <code>DRAINING</code>. A container instance can only be updated to <code>DRAINING</code> status once it has reached an <code>ACTIVE</code> state. If a container instance is in <code>REGISTERING</code>, <code>DEREGISTERING</code>, or <code>REGISTRATION_FAILED</code> state you can describe the container instance but can't update the container instance state.</p><br>
    /// - On success, responds with [`UpdateContainerInstancesStateOutput`](crate::operation::update_container_instances_state::UpdateContainerInstancesStateOutput) with field(s):
    ///   - [`container_instances(Option<Vec::<ContainerInstance>>)`](crate::operation::update_container_instances_state::UpdateContainerInstancesStateOutput::container_instances): <p>The list of container instances.</p>
    ///   - [`failures(Option<Vec::<Failure>>)`](crate::operation::update_container_instances_state::UpdateContainerInstancesStateOutput::failures): <p>Any failures associated with the call.</p>
    /// - On failure, responds with [`SdkError<UpdateContainerInstancesStateError>`](crate::operation::update_container_instances_state::UpdateContainerInstancesStateError)
    pub fn update_container_instances_state(
        &self,
    ) -> crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder {
        crate::operation::update_container_instances_state::builders::UpdateContainerInstancesStateFluentBuilder::new(self.handle.clone())
    }
}