aws_sdk_migrationhubrefactorspaces/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_identifier(impl Into<String>)`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::environment_identifier) / [`set_environment_identifier(Option<String>)`](crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::set_environment_identifier):<br>required: **true**<br><p>The ID of the environment.</p><br>
7    /// - On success, responds with [`GetEnvironmentOutput`](crate::operation::get_environment::GetEnvironmentOutput) with field(s):
8    ///   - [`name(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::name): <p>The name of the environment.</p>
9    ///   - [`arn(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::arn): <p>The Amazon Resource Name (ARN) of the environment.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::description): <p>The description of the environment.</p>
11    ///   - [`environment_id(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::environment_id): <p>The unique identifier of the environment.</p>
12    ///   - [`network_fabric_type(Option<NetworkFabricType>)`](crate::operation::get_environment::GetEnvironmentOutput::network_fabric_type): <p>The network fabric type of the environment.</p>
13    ///   - [`owner_account_id(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::owner_account_id): <p>The Amazon Web Services account ID of the environment owner.</p>
14    ///   - [`transit_gateway_id(Option<String>)`](crate::operation::get_environment::GetEnvironmentOutput::transit_gateway_id): <p>The ID of the Transit Gateway set up by the environment, if applicable.</p>
15    ///   - [`state(Option<EnvironmentState>)`](crate::operation::get_environment::GetEnvironmentOutput::state): <p>The current state of the environment.</p>
16    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_environment::GetEnvironmentOutput::tags): <p>The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.</p>
17    ///   - [`error(Option<ErrorResponse>)`](crate::operation::get_environment::GetEnvironmentOutput::error): <p>Any error associated with the environment resource.</p>
18    ///   - [`last_updated_time(Option<DateTime>)`](crate::operation::get_environment::GetEnvironmentOutput::last_updated_time): <p>A timestamp that indicates when the environment was last updated.</p>
19    ///   - [`created_time(Option<DateTime>)`](crate::operation::get_environment::GetEnvironmentOutput::created_time): <p>A timestamp that indicates when the environment is created.</p>
20    /// - On failure, responds with [`SdkError<GetEnvironmentError>`](crate::operation::get_environment::GetEnvironmentError)
21    pub fn get_environment(&self) -> crate::operation::get_environment::builders::GetEnvironmentFluentBuilder {
22        crate::operation::get_environment::builders::GetEnvironmentFluentBuilder::new(self.handle.clone())
23    }
24}