aws_sdk_m2/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><p>The unique identifier of the runtime environment.</p><br>
7    /// - On success, responds with [`GetEnvironmentOutput`](crate::operation::get_environment::GetEnvironmentOutput) with field(s):
8    ///   - [`name(String)`](crate::operation::get_environment::GetEnvironmentOutput::name): <p>The name of the runtime environment. Must be unique within the account.</p>
9    ///   - [`description(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::description): <p>The description of the runtime environment.</p>
10    ///   - [`environment_arn(String)`](crate::operation::get_environment::GetEnvironmentOutput::environment_arn): <p>The Amazon Resource Name (ARN) of the runtime environment.</p>
11    ///   - [`environment_id(String)`](crate::operation::get_environment::GetEnvironmentOutput::environment_id): <p>The unique identifier of the runtime environment.</p>
12    ///   - [`instance_type(String)`](crate::operation::get_environment::GetEnvironmentOutput::instance_type): <p>The type of instance underlying the runtime environment.</p>
13    ///   - [`status(EnvironmentLifecycle)`](crate::operation::get_environment::GetEnvironmentOutput::status): <p>The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be <code>Unhealthy</code>.</p>
14    ///   - [`engine_type(EngineType)`](crate::operation::get_environment::GetEnvironmentOutput::engine_type): <p>The target platform for the runtime environment.</p>
15    ///   - [`engine_version(String)`](crate::operation::get_environment::GetEnvironmentOutput::engine_version): <p>The version of the runtime engine.</p>
16    ///   - [`vpc_id(String)`](crate::operation::get_environment::GetEnvironmentOutput::vpc_id): <p>The unique identifier for the VPC used with this runtime environment.</p>
17    ///   - [`subnet_ids(Vec::<String>)`](crate::operation::get_environment::GetEnvironmentOutput::subnet_ids): <p>The unique identifiers of the subnets assigned to this runtime environment.</p>
18    ///   - [`security_group_ids(Vec::<String>)`](crate::operation::get_environment::GetEnvironmentOutput::security_group_ids): <p>The unique identifiers of the security groups assigned to this runtime environment.</p>
19    ///   - [`creation_time(DateTime)`](crate::operation::get_environment::GetEnvironmentOutput::creation_time): <p>The timestamp when the runtime environment was created.</p>
20    ///   - [`storage_configurations(Option<Vec::<StorageConfiguration>>)`](crate::operation::get_environment::GetEnvironmentOutput::storage_configurations): <p>The storage configurations defined for the runtime environment.</p>
21    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_environment::GetEnvironmentOutput::tags): <p>The tags defined for this runtime environment.</p>
22    ///   - [`high_availability_config(Option<HighAvailabilityConfig>)`](crate::operation::get_environment::GetEnvironmentOutput::high_availability_config): <p>The desired capacity of the high availability configuration for the runtime environment.</p>
23    ///   - [`publicly_accessible(bool)`](crate::operation::get_environment::GetEnvironmentOutput::publicly_accessible): <p>Whether applications running in this runtime environment are publicly accessible.</p>
24    ///   - [`actual_capacity(Option<i32>)`](crate::operation::get_environment::GetEnvironmentOutput::actual_capacity): <p>The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.</p>
25    ///   - [`load_balancer_arn(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::load_balancer_arn): <p>The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.</p>
26    ///   - [`status_reason(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::status_reason): <p>The reason for the reported status.</p>
27    ///   - [`preferred_maintenance_window(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::preferred_maintenance_window): <p>The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.</p>
28    ///   - [`pending_maintenance(Option<PendingMaintenance>)`](crate::operation::get_environment::GetEnvironmentOutput::pending_maintenance): <p>Indicates the pending maintenance scheduled on this environment.</p>
29    ///   - [`kms_key_id(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::kms_key_id): <p>The identifier of a customer managed key.</p>
30    ///   - [`network_type(Option<NetworkType>)`](crate::operation::get_environment::GetEnvironmentOutput::network_type): <p>The network type supported by the runtime environment.</p>
31    /// - On failure, responds with [`SdkError<GetEnvironmentError>`](crate::operation::get_environment::GetEnvironmentError)
32    pub fn get_environment(&self) -> crate::operation::get_environment::builders::GetEnvironmentFluentBuilder {
33        crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::new(self.handle.clone())
34    }
35}
aws_sdk_m2/client/get_environment.rs

aws_sdk_m2/client/
get_environment.rs
