update_user ¶

def update_user(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    user_id: "capo_qbusiness.types.string.String",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    user_aliases_to_update: Optional[
        "capo_qbusiness.types.user_aliases.UserAliases"
    ] = None,
    user_aliases_to_delete: Optional[
        "capo_qbusiness.types.user_aliases.UserAliases"
    ] = None,
) -> "capo_qbusiness.types.update_user_response.UpdateUserResponse":
    """<p>Updates a information associated with a user id.</p>

    Args:
        application_id: <p>The identifier of the application the user is attached to.</p>
        user_id: <p>The email id attached to the user.</p>
        user_aliases_to_update: <p>The user aliases attached to the user id that are to be updated.</p>
        user_aliases_to_delete: <p>The user aliases attached to the user id that are to be deleted.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded the set limits for your Amazon Q Business service. </p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.update_user_request.UpdateUserRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.update_user_response.UpdateUserResponse"
    ]:
        import capo_qbusiness._operations.expert_q.update_user

        output, http_response = (
            capo_qbusiness._operations.expert_q.update_user.update_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateUser")
    )
    input_: capo_qbusiness.types.update_user_request.UpdateUserRequest = {
        "application_id": application_id,
        "user_id": user_id,
    }
    if user_aliases_to_update is not None:
        input_["user_aliases_to_update"] = user_aliases_to_update
    if user_aliases_to_delete is not None:
        input_["user_aliases_to_delete"] = user_aliases_to_delete

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