aws_sdk_workspacesweb/client/
update_portal.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdatePortal`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`portal_arn(impl Into<String>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::portal_arn) / [`set_portal_arn(Option<String>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::set_portal_arn):<br>required: **true**<br><p>The ARN of the web portal.</p><br>
    ///   - [`display_name(impl Into<String>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::set_display_name):<br>required: **false**<br><p>The name of the web portal. This is not visible to users who log into the web portal.</p><br>
    ///   - [`authentication_type(AuthenticationType)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::authentication_type) / [`set_authentication_type(Option<AuthenticationType>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::set_authentication_type):<br>required: **false**<br><p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p><code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p><code>IAM Identity Center</code> web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.</p><br>
    ///   - [`instance_type(InstanceType)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::instance_type) / [`set_instance_type(Option<InstanceType>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::set_instance_type):<br>required: **false**<br><p>The type and resources of the underlying instance.</p><br>
    ///   - [`max_concurrent_sessions(i32)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::max_concurrent_sessions) / [`set_max_concurrent_sessions(Option<i32>)`](crate::operation::update_portal::builders::UpdatePortalFluentBuilder::set_max_concurrent_sessions):<br>required: **false**<br><p>The maximum number of concurrent sessions for the portal.</p><br>
    /// - On success, responds with [`UpdatePortalOutput`](crate::operation::update_portal::UpdatePortalOutput) with field(s):
    ///   - [`portal(Option<Portal>)`](crate::operation::update_portal::UpdatePortalOutput::portal): <p>The web portal.</p>
    /// - On failure, responds with [`SdkError<UpdatePortalError>`](crate::operation::update_portal::UpdatePortalError)
    pub fn update_portal(&self) -> crate::operation::update_portal::builders::UpdatePortalFluentBuilder {
        crate::operation::update_portal::builders::UpdatePortalFluentBuilder::new(self.handle.clone())
    }
}