aws_sdk_grafana/client/update_workspace_authentication.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 [`UpdateWorkspaceAuthentication`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`workspace_id(impl Into<String>)`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace to update the authentication for.</p><br>
7 /// - [`authentication_providers(AuthenticationProviderTypes)`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::authentication_providers) / [`set_authentication_providers(Option<Vec::<AuthenticationProviderTypes>>)`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::set_authentication_providers):<br>required: **true**<br><p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in Amazon Managed Grafana</a>.</p><br>
8 /// - [`saml_configuration(SamlConfiguration)`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::saml_configuration) / [`set_saml_configuration(Option<SamlConfiguration>)`](crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::set_saml_configuration):<br>required: **false**<br><p>If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p><br>
9 /// - On success, responds with [`UpdateWorkspaceAuthenticationOutput`](crate::operation::update_workspace_authentication::UpdateWorkspaceAuthenticationOutput) with field(s):
10 /// - [`authentication(Option<AuthenticationDescription>)`](crate::operation::update_workspace_authentication::UpdateWorkspaceAuthenticationOutput::authentication): <p>A structure that describes the user authentication for this workspace after the update is made.</p>
11 /// - On failure, responds with [`SdkError<UpdateWorkspaceAuthenticationError>`](crate::operation::update_workspace_authentication::UpdateWorkspaceAuthenticationError)
12 pub fn update_workspace_authentication(
13 &self,
14 ) -> crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder {
15 crate::operation::update_workspace_authentication::builders::UpdateWorkspaceAuthenticationFluentBuilder::new(self.handle.clone())
16 }
17}