update_portal ¶

def update_portal(
    self,
    portal_arn: "capo_workspaces_web.types.arn.ARN",
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
    display_name: Optional[
        "capo_workspaces_web.types.display_name.DisplayName"
    ] = None,
    authentication_type: Optional[
        "capo_workspaces_web.types.authentication_type.AuthenticationType"
    ] = None,
    instance_type: Optional[
        "capo_workspaces_web.types.instance_type.InstanceType"
    ] = None,
    max_concurrent_sessions: Optional[
        "capo_workspaces_web.types.max_concurrent_sessions.MaxConcurrentSessions"
    ] = None,
    portal_custom_domain: Optional[
        "capo_workspaces_web.types.portal_custom_domain.PortalCustomDomain"
    ] = None,
) -> "capo_workspaces_web.types.update_portal_response.UpdatePortalResponse":
    """<p>Updates a web portal.</p>

    Args:
        portal_arn: <p>The ARN of the web portal.</p>
        display_name: <p>The name of the web portal. This is not visible to users who log into the web portal.</p>
        authentication_type: <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>
        instance_type: <p>The type and resources of the underlying instance.</p>
        max_concurrent_sessions: <p>The maximum number of concurrent sessions for the portal.</p>
        portal_custom_domain: <p>The custom domain of the web portal that users access in order to start streaming sessions. </p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.conflict_exception.ConflictException: <p>There is a conflict.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource cannot be found.</p>
        capo_workspaces_web.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota has been exceeded.</p>
        capo_workspaces_web.errors.throttling_exception.ThrottlingException: <p>There is a throttling error.</p>
        capo_workspaces_web.errors.validation_exception.ValidationException: <p>There is a validation error.</p>
        capo_workspaces_web.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_web.types.update_portal_request.UpdatePortalRequest]",
    ) -> OperationResponse[
        "capo_workspaces_web.types.update_portal_response.UpdatePortalResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.update_portal

        output, http_response = (
            capo_workspaces_web._operations.aws_ermine_control_plane_service.update_portal.update_portal(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workspaces_web.types.update_portal_request.UpdatePortalRequest",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.update_portal_request

        return capo_workspaces_web.types.update_portal_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_workspaces_web.types.update_portal_response.UpdatePortalResponse",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.update_portal_response

        return capo_workspaces_web.types.update_portal_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdatePortal", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_workspaces_web.types.update_portal_request.UpdatePortalRequest = {
        "portal_arn": portal_arn
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if authentication_type is not None:
        input_["authentication_type"] = authentication_type
    if instance_type is not None:
        input_["instance_type"] = instance_type
    if max_concurrent_sessions is not None:
        input_["max_concurrent_sessions"] = max_concurrent_sessions
    if portal_custom_domain is not None:
        input_["portal_custom_domain"] = portal_custom_domain

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output