aws_sdk_finspace/client/
update_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 [`UpdateEnvironment`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`environment_id(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_environment_id):<br>required: **true**<br><p>The identifier of the FinSpace environment.</p><br>
7    ///   - [`name(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_name):<br>required: **false**<br><p>The name of the environment.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_description):<br>required: **false**<br><p>The description of the environment.</p><br>
9    ///   - [`federation_mode(FederationMode)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::federation_mode) / [`set_federation_mode(Option<FederationMode>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_federation_mode):<br>required: **false**<br><p>Authentication mode for the environment.</p> <ul>  <li>   <p><code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p></li>  <li>   <p><code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p></li> </ul><br>
10    ///   - [`federation_parameters(FederationParameters)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::federation_parameters) / [`set_federation_parameters(Option<FederationParameters>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_federation_parameters):<br>required: **false**<br><p>Configuration information when authentication mode is FEDERATED.</p><br>
11    /// - On success, responds with [`UpdateEnvironmentOutput`](crate::operation::update_environment::UpdateEnvironmentOutput) with field(s):
12    ///   - [`environment(Option<Environment>)`](crate::operation::update_environment::UpdateEnvironmentOutput::environment): <p>Returns the FinSpace environment object.</p>
13    /// - On failure, responds with [`SdkError<UpdateEnvironmentError>`](crate::operation::update_environment::UpdateEnvironmentError)
14    #[deprecated(note = "This method will be discontinued.")]
15    pub fn update_environment(&self) -> crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder {
16        crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_finspace/client/update_environment.rs

aws_sdk_finspace/client/
update_environment.rs
