aws_sdk_cloud9/client/
describe_environment_status.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeEnvironmentStatus`](crate::operation::describe_environment_status::builders::DescribeEnvironmentStatusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`environment_id(impl Into<String>)`](crate::operation::describe_environment_status::builders::DescribeEnvironmentStatusFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::describe_environment_status::builders::DescribeEnvironmentStatusFluentBuilder::set_environment_id):<br>required: **true**<br><p>The ID of the environment to get status information about.</p><br>
    /// - On success, responds with [`DescribeEnvironmentStatusOutput`](crate::operation::describe_environment_status::DescribeEnvironmentStatusOutput) with field(s):
    ///   - [`status(EnvironmentStatus)`](crate::operation::describe_environment_status::DescribeEnvironmentStatusOutput::status): <p>The status of the environment. Available values include:</p> <ul>  <li>   <p><code>connecting</code>: The environment is connecting.</p></li>  <li>   <p><code>creating</code>: The environment is being created.</p></li>  <li>   <p><code>deleting</code>: The environment is being deleted.</p></li>  <li>   <p><code>error</code>: The environment is in an error state.</p></li>  <li>   <p><code>ready</code>: The environment is ready.</p></li>  <li>   <p><code>stopped</code>: The environment is stopped.</p></li>  <li>   <p><code>stopping</code>: The environment is stopping.</p></li> </ul>
    ///   - [`message(String)`](crate::operation::describe_environment_status::DescribeEnvironmentStatusOutput::message): <p>Any informational message about the status of the environment.</p>
    /// - On failure, responds with [`SdkError<DescribeEnvironmentStatusError>`](crate::operation::describe_environment_status::DescribeEnvironmentStatusError)
    pub fn describe_environment_status(&self) -> crate::operation::describe_environment_status::builders::DescribeEnvironmentStatusFluentBuilder {
        crate::operation::describe_environment_status::builders::DescribeEnvironmentStatusFluentBuilder::new(self.handle.clone())
    }
}