Skip to main content

aws_sdk_continuum/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    ///   - [`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>The unique identifier of the environment to retrieve.<br>
7    /// - On success, responds with [`GetEnvironmentOutput`](crate::operation::get_environment::GetEnvironmentOutput) with field(s):
8    ///   - [`environment_id(String)`](crate::operation::get_environment::GetEnvironmentOutput::environment_id): The unique identifier of the environment.
9    ///   - [`environment_arn(String)`](crate::operation::get_environment::GetEnvironmentOutput::environment_arn): The ARN of the environment.
10    ///   - [`name(String)`](crate::operation::get_environment::GetEnvironmentOutput::name): The customer-visible name of the environment.
11    ///   - [`status(EnvironmentStatus)`](crate::operation::get_environment::GetEnvironmentOutput::status): The current operational status of the environment.
12    ///   - [`status_message(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::status_message): Human-readable details about the current status. Present when the status requires additional context (e.g., failure reason).
13    ///   - [`status_updated_at(DateTime)`](crate::operation::get_environment::GetEnvironmentOutput::status_updated_at): The timestamp when the status last transitioned.
14    ///   - [`created_at(DateTime)`](crate::operation::get_environment::GetEnvironmentOutput::created_at): The timestamp when the environment was created.
15    ///   - [`updated_at(DateTime)`](crate::operation::get_environment::GetEnvironmentOutput::updated_at): The timestamp when the environment's properties were last updated.
16    ///   - [`configuration(Option<EnvironmentConfigurationDetails>)`](crate::operation::get_environment::GetEnvironmentOutput::configuration): Type-specific configuration and state, including code sources, operating policy, Collector details, and the latest scan.
17    /// - On failure, responds with [`SdkError<GetEnvironmentError>`](crate::operation::get_environment::GetEnvironmentError)
18    pub fn get_environment(&self) -> crate::operation::get_environment::builders::GetEnvironmentFluentBuilder {
19        crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::new(self.handle.clone())
20    }
21}