update_kx_user ¶

def update_kx_user(
    self,
    environment_id: "capo_finspace.types.id_type.IdType",
    user_name: "capo_finspace.types.kx_user_name_string.KxUserNameString",
    iam_role: "capo_finspace.types.role_arn.RoleArn",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    client_token: Optional["capo_finspace.types.client_token.ClientToken"] = None,
) -> "capo_finspace.types.update_kx_user_response.UpdateKxUserResponse":
    """<p>Updates the user details. You can only update the IAM role associated with a user.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        user_name: <p>A unique identifier for the user.</p>
        iam_role: <p>The IAM role ARN that is associated with the user.</p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.conflict_exception.ConflictException: <p>There was a conflict with this action, and it could not be completed.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.limit_exceeded_exception.LimitExceededException: <p>A service limit or quota is exceeded.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.update_kx_user_request.UpdateKxUserRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.update_kx_user_response.UpdateKxUserResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_kx_user

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.update_kx_user.update_kx_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKxUser")
    )
    input_: capo_finspace.types.update_kx_user_request.UpdateKxUserRequest = {
        "environment_id": environment_id,
        "user_name": user_name,
        "iam_role": iam_role,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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