aws_sdk_appconfig/client/
get_environment.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 [`GetEnvironment`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::set_application_id):<br>required: **true**<br><p>The ID of the application that includes the environment you want to get.</p><br>
7    ///   - [`environment_id(impl Into<String>)`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::set_environment_id):<br>required: **true**<br><p>The ID of the environment that you want to get.</p><br>
8    /// - On success, responds with [`GetEnvironmentOutput`](crate::operation::get_environment::GetEnvironmentOutput) with field(s):
9    ///   - [`application_id(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::application_id): <p>The application ID.</p>
10    ///   - [`id(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::id): <p>The environment ID.</p>
11    ///   - [`name(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::name): <p>The name of the environment.</p>
12    ///   - [`description(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::description): <p>The description of the environment.</p>
13    ///   - [`state(Option<EnvironmentState>)`](crate::operation::get_environment::GetEnvironmentOutput::state): <p>The state of the environment. An environment can be in one of the following states: <code>READY_FOR_DEPLOYMENT</code>, <code>DEPLOYING</code>, <code>ROLLING_BACK</code>, or <code>ROLLED_BACK</code></p>
14    ///   - [`monitors(Option<Vec::<Monitor>>)`](crate::operation::get_environment::GetEnvironmentOutput::monitors): <p>Amazon CloudWatch alarms monitored during the deployment.</p>
15    /// - On failure, responds with [`SdkError<GetEnvironmentError>`](crate::operation::get_environment::GetEnvironmentError)
16    pub fn get_environment(&self) -> crate::operation::get_environment::builders::GetEnvironmentFluentBuilder {
17        crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::new(self.handle.clone())
18    }
19}