aws_sdk_codedeploy/client/
stop_deployment.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StopDeployment`](crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`deployment_id(impl Into<String>)`](crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder::deployment_id) / [`set_deployment_id(Option<String>)`](crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder::set_deployment_id):<br>required: **true**<br><p>The unique ID of a deployment.</p><br>
7    ///   - [`auto_rollback_enabled(bool)`](crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder::auto_rollback_enabled) / [`set_auto_rollback_enabled(Option<bool>)`](crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder::set_auto_rollback_enabled):<br>required: **false**<br><p>Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.</p><br>
8    /// - On success, responds with [`StopDeploymentOutput`](crate::operation::stop_deployment::StopDeploymentOutput) with field(s):
9    ///   - [`status(Option<StopStatus>)`](crate::operation::stop_deployment::StopDeploymentOutput::status): <p>The status of the stop deployment operation:</p> <ul>  <li>   <p>Pending: The stop operation is pending.</p></li>  <li>   <p>Succeeded: The stop operation was successful.</p></li> </ul>
10    ///   - [`status_message(Option<String>)`](crate::operation::stop_deployment::StopDeploymentOutput::status_message): <p>An accompanying status message.</p>
11    /// - On failure, responds with [`SdkError<StopDeploymentError>`](crate::operation::stop_deployment::StopDeploymentError)
12    pub fn stop_deployment(&self) -> crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder {
13        crate::operation::stop_deployment::builders::StopDeploymentFluentBuilder::new(self.handle.clone())
14    }
15}